Skip to content

ximgproc_rollingGuidanceFilter

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

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

ARGUMENTSsrc, dst, d, sigmaColor
FUNCTIONximgproc_rollingGuidanceFilter
RETURN TYPEvoid
Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

Applies the rolling guidance filter to an image.

For more details, please see [zhang2014rolling]

See: jointBilateralFilter, bilateralFilter, amFilter

ximgproc_rollingGuidanceFilter(src: Mat, dst: Mat, d: number, sigmaColor: number, sigmaSpace: number, numOfIter: number, borderType: number): void;
6 available overloads
ximgproc_rollingGuidanceFilter(src: Mat, dst: Mat): void;
ximgproc_rollingGuidanceFilter(src: Mat, dst: Mat, d: number): void;
ximgproc_rollingGuidanceFilter(src: Mat, dst: Mat, d: number, sigmaColor: number): void;
ximgproc_rollingGuidanceFilter(src: Mat, dst: Mat, d: number, sigmaColor: number, sigmaSpace: number): void;
ximgproc_rollingGuidanceFilter(src: Mat, dst: Mat, d: number, sigmaColor: number, sigmaSpace: number, numOfIter: number): void;
ximgproc_rollingGuidanceFilter(src: Mat, dst: Mat, d: number, sigmaColor: number, sigmaSpace: number, numOfIter: number, borderType: number): void;
src

Source 8-bit or floating-point, 1-channel or 3-channel image.

dst

Output destination, filled by the native operation. Destination image of the same size and type as src.

d

Diameter of each pixel neighborhood that is used during filtering. If it is non-positive, it is computed from sigmaSpace .

sigmaColor

Filter sigma in the color space. A larger value of the parameter means that farther colors within the pixel neighborhood (see sigmaSpace ) will be mixed together, resulting in larger areas of semi-equal color.

sigmaSpace

Filter sigma in the coordinate space. A larger value of the parameter means that farther pixels will influence each other as long as their colors are close enough (see sigmaColor ). When d>0 , it specifies the neighborhood size regardless of sigmaSpace . Otherwise, d is proportional to sigmaSpace .

numOfIter

Number of iterations of joint edge-preserving filtering applied on the source image.

borderType

Note: rollingGuidanceFilter uses jointBilateralFilter as the edge-preserving 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.