Skip to content

ximgproc_fastBilateralSolverFilter

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

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

ARGUMENTSguide, src, confidence, dst
FUNCTIONximgproc_fastBilateralSolverFilter
RETURN TYPEvoid
Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

Simple one-line Fast Bilateral Solver filter call. If you have multiple images to filter with the same guide then use FastBilateralSolverFilter interface to avoid extra computations.

Note: Confidence images with CV_8U depth are expected to in [0, 255] and CV_32F in [0, 1] range.

ximgproc_fastBilateralSolverFilter(guide: Mat, src: Mat, confidence: Mat, dst: Mat, sigma_spatial: number, sigma_luma: number, sigma_chroma: number, lambda: number, num_iter: number, max_tol: number): void;
7 available overloads
ximgproc_fastBilateralSolverFilter(guide: Mat, src: Mat, confidence: Mat, dst: Mat): void;
ximgproc_fastBilateralSolverFilter(guide: Mat, src: Mat, confidence: Mat, dst: Mat, sigma_spatial: number): void;
ximgproc_fastBilateralSolverFilter(guide: Mat, src: Mat, confidence: Mat, dst: Mat, sigma_spatial: number, sigma_luma: number): void;
ximgproc_fastBilateralSolverFilter(guide: Mat, src: Mat, confidence: Mat, dst: Mat, sigma_spatial: number, sigma_luma: number, sigma_chroma: number): void;
ximgproc_fastBilateralSolverFilter(guide: Mat, src: Mat, confidence: Mat, dst: Mat, sigma_spatial: number, sigma_luma: number, sigma_chroma: number, lambda: number): void;
ximgproc_fastBilateralSolverFilter(guide: Mat, src: Mat, confidence: Mat, dst: Mat, sigma_spatial: number, sigma_luma: number, sigma_chroma: number, lambda: number, num_iter: number): void;
ximgproc_fastBilateralSolverFilter(guide: Mat, src: Mat, confidence: Mat, dst: Mat, sigma_spatial: number, sigma_luma: number, sigma_chroma: number, lambda: number, num_iter: number, max_tol: number): void;
guide

image serving as guide for filtering. It should have 8-bit depth and either 1 or 3 channels.

src

source image for filtering with unsigned 8-bit or signed 16-bit or floating-point 32-bit depth and up to 4 channels.

confidence

confidence image with unsigned 8-bit or floating-point 32-bit confidence and 1 channel.

dst

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

sigma_spatial

parameter, that is similar to spatial space sigma (bandwidth) in bilateralFilter.

sigma_luma

parameter, that is similar to luma space sigma (bandwidth) in bilateralFilter.

sigma_chroma

parameter, that is similar to chroma space sigma (bandwidth) in bilateralFilter.

lambda

smoothness strength parameter for solver.

num_iter

number of iterations used for solver, 25 is usually enough.

max_tol

convergence tolerance used for solver.

For more details about the Fast Bilateral Solver parameters, see the original paper [BarronPoole2016].

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.