StereoSGBM_create

stereofunctionOpenCV 5.0.0

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

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

ARGUMENTSminDisparity, numDisparities, blockSize, P1

FUNCTIONStereoSGBM_create

RETURN TYPEStereoSGBM | null

Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

Creates StereoSGBM object

StereoSGBM_create(minDisparity: number, numDisparities: number, blockSize: number, P1: number, P2: number, disp12MaxDiff: number, preFilterCap: number, uniquenessRatio: number, speckleWindowSize: number, speckleRange: number, mode: number): StereoSGBM | null;

12 available overloads

StereoSGBM_create(): StereoSGBM | null;

StereoSGBM_create(minDisparity: number): StereoSGBM | null;

StereoSGBM_create(minDisparity: number, numDisparities: number): StereoSGBM | null;

StereoSGBM_create(minDisparity: number, numDisparities: number, blockSize: number): StereoSGBM | null;

StereoSGBM_create(minDisparity: number, numDisparities: number, blockSize: number, P1: number): StereoSGBM | null;

StereoSGBM_create(minDisparity: number, numDisparities: number, blockSize: number, P1: number, P2: number): StereoSGBM | null;

StereoSGBM_create(minDisparity: number, numDisparities: number, blockSize: number, P1: number, P2: number, disp12MaxDiff: number): StereoSGBM | null;

StereoSGBM_create(minDisparity: number, numDisparities: number, blockSize: number, P1: number, P2: number, disp12MaxDiff: number, preFilterCap: number): StereoSGBM | null;

StereoSGBM_create(minDisparity: number, numDisparities: number, blockSize: number, P1: number, P2: number, disp12MaxDiff: number, preFilterCap: number, uniquenessRatio: number): StereoSGBM | null;

StereoSGBM_create(minDisparity: number, numDisparities: number, blockSize: number, P1: number, P2: number, disp12MaxDiff: number, preFilterCap: number, uniquenessRatio: number, speckleWindowSize: number): StereoSGBM | null;

StereoSGBM_create(minDisparity: number, numDisparities: number, blockSize: number, P1: number, P2: number, disp12MaxDiff: number, preFilterCap: number, uniquenessRatio: number, speckleWindowSize: number, speckleRange: number): StereoSGBM | null;

StereoSGBM_create(minDisparity: number, numDisparities: number, blockSize: number, P1: number, P2: number, disp12MaxDiff: number, preFilterCap: number, uniquenessRatio: number, speckleWindowSize: number, speckleRange: number, mode: number): StereoSGBM | null;

minDisparity: Minimum possible disparity value. Normally, it is zero but sometimes rectification algorithms can shift images, so this parameter needs to be adjusted accordingly.
numDisparities: Maximum disparity minus minimum disparity. The value is always greater than zero. In the current implementation, this parameter must be divisible by 16.
blockSize: Matched block size. It must be an odd number >=1 . Normally, it should be somewhere in the 3..11 range.
P1: The first parameter controlling the disparity smoothness. See below.
P2: The second parameter controlling the disparity smoothness. The larger the values are, the smoother the disparity is. P1 is the penalty on the disparity change by plus or minus 1 between neighbor pixels. P2 is the penalty on the disparity change by more than 1 between neighbor pixels. The algorithm requires P2 > P1 . See stereo_match.cpp sample where some reasonably good P1 and P2 values are shown (like 8*number_of_image_channels*blockSize*blockSize and 32*number_of_image_channels*blockSize*blockSize , respectively).
disp12MaxDiff: Maximum allowed difference (in integer pixel units) in the left-right disparity check. Set it to a non-positive value to disable the check.
preFilterCap: Truncation value for the prefiltered image pixels. The algorithm first computes x-derivative at each pixel and clips its value by [-preFilterCap, preFilterCap] interval. The result values are passed to the Birchfield-Tomasi pixel cost function.
uniquenessRatio: Margin in percentage by which the best (minimum) computed cost function value should "win" the second best value to consider the found match correct. Normally, a value within the 5-15 range is good enough.
speckleWindowSize: Maximum size of smooth disparity regions to consider their noise speckles and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the 50-200 range.
speckleRange: Maximum disparity variation within each connected component. If you do speckle filtering, set the parameter to a positive value, it will be implicitly multiplied by 16. Normally, 1 or 2 is good enough.
mode: Set it to StereoSGBM::MODE_HH to run the full-scale two-pass dynamic programming algorithm. It will consume O(W*H*numDisparities) bytes, which is large for 640x480 stereo and huge for HD-size pictures. By default, it is set to false .

The first constructor initializes StereoSGBM with all the default parameters. So, you only have to set StereoSGBM::numDisparities at minimum. The second constructor enables you to set each parameter to a custom value.

Returns

The StereoSGBM | 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.