ximgproc_createGuidedFilter

Extended image processingfunctionOpenCV 5.0.0

import { ximgproc_createGuidedFilter } from '@banou/opencv-wasm'

Use after await initOpenCV(). See the initialization and named imports guide.

Explore visually: Guided filtering →

Use a guidance image to decide how a local linear model should smooth another image.

VISUAL WALKTHROUGHFiltering

REFERENCE INPUTNoisy or uneven image

The same scene stays here while the working view changes.

→

RESULTApply the rule at every pixel

The whole image has now been processed. The highlighted input value 156 becomes 159.6.

Computed teaching example on a 24 × 16 image. Small kernels and simplified settings keep each change visible; use the image laboratory for native OpenCV.

Factory method, create instance of GuidedFilter and produce initialization routines.

ximgproc_createGuidedFilter(guide: Mat, radius: number, eps: number, scale: number): ximgproc_GuidedFilter | null;

2 available overloads

ximgproc_createGuidedFilter(guide: Mat, radius: number, eps: number): ximgproc_GuidedFilter | null;

ximgproc_createGuidedFilter(guide: Mat, radius: number, eps: number, scale: number): ximgproc_GuidedFilter | null;

guide

guided image (or array of images) with up to 3 channels, if it have more then 3 channels then only first 3 channels will be used.

radius

radius of Guided Filter.

eps

regularization term of Guided Filter. {eps}^2 is similar to the sigma in the color space into bilateralFilter.

scale

subsample factor of Fast Guided Filter, use a scale less than 1 to speeds up computation with almost no visible degradation. (e.g. scale==0.5 shrinks the image by 2x inside the filter)

For more details about (Fast) Guided Filter parameters, see the original articles [Kaiming10] [Kaiming15] .

Returns

The ximgproc_GuidedFilter | null result.

Upstream declaration ↗

These signatures describe this package. Upstream documentation can mention optional backends that are absent from this build. Check runtime compatibility before choosing a backend or file format.