Skip to content

ximgproc_createDTFilter

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

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

ARGUMENTSguide, sigmaSpatial, sigmaColor, mode
FUNCTIONximgproc_createDTFilter
RETURN TYPEximgproc_DTFilter | null
Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

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

ximgproc_createDTFilter(guide: Mat, sigmaSpatial: number, sigmaColor: number, mode: number, numIters: number): ximgproc_DTFilter | null;
3 available overloads
ximgproc_createDTFilter(guide: Mat, sigmaSpatial: number, sigmaColor: number): ximgproc_DTFilter | null;
ximgproc_createDTFilter(guide: Mat, sigmaSpatial: number, sigmaColor: number, mode: number): ximgproc_DTFilter | null;
ximgproc_createDTFilter(guide: Mat, sigmaSpatial: number, sigmaColor: number, mode: number, numIters: number): ximgproc_DTFilter | null;
guide

guided image (used to build transformed distance, which describes edge structure of guided image).

sigmaSpatial

{\sigma}_H parameter in the original article, it's similar to the sigma in the coordinate space into bilateralFilter.

sigmaColor

{\sigma}_r parameter in the original article, it's similar to the sigma in the color space into bilateralFilter.

mode

one form three modes DTF_NC, DTF_RF and DTF_IC which corresponds to three modes for filtering 2D signals in the article.

numIters

optional number of iterations used for filtering, 3 is quite enough.

For more details about Domain Transform filter parameters, see the original article [Gastal11] and Domain Transform filter homepage.

Returns

The ximgproc_DTFilter | null result.

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.