Skip to content

ximgproc_guidedFilter

Extended image processingfunctionOpenCV 5.0.0
import { ximgproc_guidedFilter } from '@banou/opencv-wasm'

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

Simple one-line (Fast) Guided Filter call.

If you have multiple images to filter with the same guided image then use GuidedFilter interface to avoid extra computations on initialization stage.

See: bilateralFilter, dtFilter, amFilter

ximgproc_guidedFilter(guide: Mat, src: Mat, dst: Mat, radius: number, eps: number, dDepth: number, scale: number): void;
3 available overloads
ximgproc_guidedFilter(guide: Mat, src: Mat, dst: Mat, radius: number, eps: number): void;
ximgproc_guidedFilter(guide: Mat, src: Mat, dst: Mat, radius: number, eps: number, dDepth: number): void;
ximgproc_guidedFilter(guide: Mat, src: Mat, dst: Mat, radius: number, eps: number, dDepth: number, scale: number): void;
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.

src

filtering image with any numbers of channels.

dst

Output destination, filled by the native operation. output image.

radius

radius of Guided Filter.

eps

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

dDepth

optional depth of the output image.

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)

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.