StereoSGBM

Objective-C

@interface StereoSGBM : StereoMatcher

Swift

class StereoSGBM : StereoMatcher

The class implements the modified H. Hirschmuller algorithm CITE: HH08 that differs from the original one as follows:

  • By default, the algorithm is single-pass, which means that you consider only 5 directions instead of 8. Set mode=StereoSGBM::MODE_HH in createStereoSGBM to run the full variant of the algorithm but beware that it may consume a lot of memory.
  • The algorithm matches blocks, not individual pixels. Though, setting blockSize=1 reduces the blocks to single pixels.
  • Mutual information cost function is not implemented. Instead, a simpler Birchfield-Tomasi sub-pixel metric from CITE: BT98 is used. Though, the color images are supported as well.
  • Some pre- and post- processing steps from K. Konolige algorithm StereoBM are included, for example: pre-filtering (StereoBM::PREFILTER_XSOBEL type) and post-filtering (uniqueness check, quadratic interpolation and speckle filtering).

@note - (Python) An example illustrating the use of the StereoSGBM matching algorithm can be found at opencv_source_code/samples/python/stereo_match.py

Member of Calib3d

Class Constants

  • Declaration

    Objective-C

    @property (class, readonly) int MODE_SGBM

    Swift

    class var MODE_SGBM: Int32 { get }
  • Declaration

    Objective-C

    @property (class, readonly) int MODE_HH

    Swift

    class var MODE_HH: Int32 { get }
  • Declaration

    Objective-C

    @property (class, readonly) int MODE_SGBM_3WAY

    Swift

    class var MODE_SGBM_3WAY: Int32 { get }
  • Declaration

    Objective-C

    @property (class, readonly) int MODE_HH4

    Swift

    class var MODE_HH4: Int32 { get }

Methods

  • Creates StereoSGBM object

    Declaration

    Objective-C

    + (nonnull StereoSGBM *)create:(int)minDisparity
                    numDisparities:(int)numDisparities
                         blockSize:(int)blockSize
                                P1:(int)P1
                                P2:(int)P2
                     disp12MaxDiff:(int)disp12MaxDiff
                      preFilterCap:(int)preFilterCap
                   uniquenessRatio:(int)uniquenessRatio
                 speckleWindowSize:(int)speckleWindowSize
                      speckleRange:(int)speckleRange
                              mode:(int)mode;

    Swift

    class func create(minDisparity: Int32, numDisparities: Int32, blockSize: Int32, P1: Int32, P2: Int32, disp12MaxDiff: Int32, preFilterCap: Int32, uniquenessRatio: Int32, speckleWindowSize: Int32, speckleRange: Int32, mode: Int32) -> StereoSGBM

    Parameters

    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.

  • Creates StereoSGBM object

    Declaration

    Objective-C

    + (nonnull StereoSGBM *)create:(int)minDisparity
                    numDisparities:(int)numDisparities
                         blockSize:(int)blockSize
                                P1:(int)P1
                                P2:(int)P2
                     disp12MaxDiff:(int)disp12MaxDiff
                      preFilterCap:(int)preFilterCap
                   uniquenessRatio:(int)uniquenessRatio
                 speckleWindowSize:(int)speckleWindowSize
                      speckleRange:(int)speckleRange;

    Swift

    class func create(minDisparity: Int32, numDisparities: Int32, blockSize: Int32, P1: Int32, P2: Int32, disp12MaxDiff: Int32, preFilterCap: Int32, uniquenessRatio: Int32, speckleWindowSize: Int32, speckleRange: Int32) -> StereoSGBM

    Parameters

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

  • Creates StereoSGBM object

    Declaration

    Objective-C

    + (nonnull StereoSGBM *)create:(int)minDisparity
                    numDisparities:(int)numDisparities
                         blockSize:(int)blockSize
                                P1:(int)P1
                                P2:(int)P2
                     disp12MaxDiff:(int)disp12MaxDiff
                      preFilterCap:(int)preFilterCap
                   uniquenessRatio:(int)uniquenessRatio
                 speckleWindowSize:(int)speckleWindowSize;

    Swift

    class func create(minDisparity: Int32, numDisparities: Int32, blockSize: Int32, P1: Int32, P2: Int32, disp12MaxDiff: Int32, preFilterCap: Int32, uniquenessRatio: Int32, speckleWindowSize: Int32) -> StereoSGBM

    Parameters

    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. filtering, set the parameter to a positive value, it will be implicitly multiplied by 16. Normally, 1 or 2 is good enough. 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.

  • Creates StereoSGBM object

    Declaration

    Objective-C

    + (nonnull StereoSGBM *)create:(int)minDisparity
                    numDisparities:(int)numDisparities
                         blockSize:(int)blockSize
                                P1:(int)P1
                                P2:(int)P2
                     disp12MaxDiff:(int)disp12MaxDiff
                      preFilterCap:(int)preFilterCap
                   uniquenessRatio:(int)uniquenessRatio;

    Swift

    class func create(minDisparity: Int32, numDisparities: Int32, blockSize: Int32, P1: Int32, P2: Int32, disp12MaxDiff: Int32, preFilterCap: Int32, uniquenessRatio: Int32) -> StereoSGBM

    Parameters

    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. and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the 50-200 range. filtering, set the parameter to a positive value, it will be implicitly multiplied by 16. Normally, 1 or 2 is good enough. 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.

  • Creates StereoSGBM object

    Declaration

    Objective-C

    + (nonnull StereoSGBM *)create:(int)minDisparity
                    numDisparities:(int)numDisparities
                         blockSize:(int)blockSize
                                P1:(int)P1
                                P2:(int)P2
                     disp12MaxDiff:(int)disp12MaxDiff
                      preFilterCap:(int)preFilterCap;

    Swift

    class func create(minDisparity: Int32, numDisparities: Int32, blockSize: Int32, P1: Int32, P2: Int32, disp12MaxDiff: Int32, preFilterCap: Int32) -> StereoSGBM

    Parameters

    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. value should “win” the second best value to consider the found match correct. Normally, a value within the 5-15 range is good enough. and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the 50-200 range. filtering, set the parameter to a positive value, it will be implicitly multiplied by 16. Normally, 1 or 2 is good enough. 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.

  • Creates StereoSGBM object

    Declaration

    Objective-C

    + (nonnull StereoSGBM *)create:(int)minDisparity
                    numDisparities:(int)numDisparities
                         blockSize:(int)blockSize
                                P1:(int)P1
                                P2:(int)P2
                     disp12MaxDiff:(int)disp12MaxDiff;

    Swift

    class func create(minDisparity: Int32, numDisparities: Int32, blockSize: Int32, P1: Int32, P2: Int32, disp12MaxDiff: Int32) -> StereoSGBM

    Parameters

    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. 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. value should “win” the second best value to consider the found match correct. Normally, a value within the 5-15 range is good enough. and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the 50-200 range. filtering, set the parameter to a positive value, it will be implicitly multiplied by 16. Normally, 1 or 2 is good enough. 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.

  • Creates StereoSGBM object

    Declaration

    Objective-C

    + (nonnull StereoSGBM *)create:(int)minDisparity
                    numDisparities:(int)numDisparities
                         blockSize:(int)blockSize
                                P1:(int)P1
                                P2:(int)P2;

    Swift

    class func create(minDisparity: Int32, numDisparities: Int32, blockSize: Int32, P1: Int32, P2: Int32) -> StereoSGBM

    Parameters

    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). disparity check. Set it to a non-positive value to disable the check. 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. value should “win” the second best value to consider the found match correct. Normally, a value within the 5-15 range is good enough. and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the 50-200 range. filtering, set the parameter to a positive value, it will be implicitly multiplied by 16. Normally, 1 or 2 is good enough. 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.

  • Creates StereoSGBM object

    Declaration

    Objective-C

    + (nonnull StereoSGBM *)create:(int)minDisparity
                    numDisparities:(int)numDisparities
                         blockSize:(int)blockSize
                                P1:(int)P1;

    Swift

    class func create(minDisparity: Int32, numDisparities: Int32, blockSize: Int32, P1: Int32) -> StereoSGBM

    Parameters

    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. 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). disparity check. Set it to a non-positive value to disable the check. 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. value should “win” the second best value to consider the found match correct. Normally, a value within the 5-15 range is good enough. and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the 50-200 range. filtering, set the parameter to a positive value, it will be implicitly multiplied by 16. Normally, 1 or 2 is good enough. 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.

  • Creates StereoSGBM object

    Declaration

    Objective-C

    + (nonnull StereoSGBM *)create:(int)minDisparity
                    numDisparities:(int)numDisparities
                         blockSize:(int)blockSize;

    Swift

    class func create(minDisparity: Int32, numDisparities: Int32, blockSize: Int32) -> StereoSGBM

    Parameters

    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. 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). disparity check. Set it to a non-positive value to disable the check. 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. value should “win” the second best value to consider the found match correct. Normally, a value within the 5-15 range is good enough. and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the 50-200 range. filtering, set the parameter to a positive value, it will be implicitly multiplied by 16. Normally, 1 or 2 is good enough. 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.

  • Creates StereoSGBM object

    Declaration

    Objective-C

    + (nonnull StereoSGBM *)create:(int)minDisparity
                    numDisparities:(int)numDisparities;

    Swift

    class func create(minDisparity: Int32, numDisparities: Int32) -> StereoSGBM

    Parameters

    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. somewhere in the 3..11 range. 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). disparity check. Set it to a non-positive value to disable the check. 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. value should “win” the second best value to consider the found match correct. Normally, a value within the 5-15 range is good enough. and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the 50-200 range. filtering, set the parameter to a positive value, it will be implicitly multiplied by 16. Normally, 1 or 2 is good enough. 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.

  • Creates StereoSGBM object

    Declaration

    Objective-C

    + (nonnull StereoSGBM *)create:(int)minDisparity;

    Swift

    class func create(minDisparity: Int32) -> StereoSGBM

    Parameters

    minDisparity

    Minimum possible disparity value. Normally, it is zero but sometimes rectification algorithms can shift images, so this parameter needs to be adjusted accordingly. zero. In the current implementation, this parameter must be divisible by 16. somewhere in the 3..11 range. 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). disparity check. Set it to a non-positive value to disable the check. 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. value should “win” the second best value to consider the found match correct. Normally, a value within the 5-15 range is good enough. and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the 50-200 range. filtering, set the parameter to a positive value, it will be implicitly multiplied by 16. Normally, 1 or 2 is good enough. 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.

  • Creates StereoSGBM object

     rectification algorithms can shift images, so this parameter needs to be adjusted accordingly.
     zero. In the current implementation, this parameter must be divisible by 16.
     somewhere in the 3..11 range.
     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).
     disparity check. Set it to a non-positive value to disable the check.
     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.
     value should "win" the second best value to consider the found match correct. Normally, a value
     within the 5-15 range is good enough.
     and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the
     50-200 range.
     filtering, set the parameter to a positive value, it will be implicitly multiplied by 16.
     Normally, 1 or 2 is good enough.
     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.
    

    Declaration

    Objective-C

    + (nonnull StereoSGBM *)create;

    Swift

    class func create() -> StereoSGBM
  • Declaration

    Objective-C

    - (int)getMode NS_SWIFT_NAME(getMode());

    Swift

    func getMode() -> Int32
  • Declaration

    Objective-C

    - (int)getP1 NS_SWIFT_NAME(getP1());

    Swift

    func getP1() -> Int32
  • Declaration

    Objective-C

    - (int)getP2 NS_SWIFT_NAME(getP2());

    Swift

    func getP2() -> Int32
  • Declaration

    Objective-C

    - (int)getPreFilterCap NS_SWIFT_NAME(getPreFilterCap());

    Swift

    func getPreFilterCap() -> Int32
  • Declaration

    Objective-C

    - (int)getUniquenessRatio NS_SWIFT_NAME(getUniquenessRatio());

    Swift

    func getUniquenessRatio() -> Int32
  • Declaration

    Objective-C

    - (void)setMode:(int)mode NS_SWIFT_NAME(setMode(mode:));

    Swift

    func setMode(mode: Int32)
  • Declaration

    Objective-C

    - (void)setP1:(int)P1 NS_SWIFT_NAME(setP1(P1:));

    Swift

    func setP1(P1: Int32)
  • Declaration

    Objective-C

    - (void)setP2:(int)P2 NS_SWIFT_NAME(setP2(P2:));

    Swift

    func setP2(P2: Int32)
  • Declaration

    Objective-C

    - (void)setPreFilterCap:(int)preFilterCap NS_SWIFT_NAME(setPreFilterCap(preFilterCap:));

    Swift

    func setPreFilterCap(preFilterCap: Int32)
  • Declaration

    Objective-C

    - (void)setUniquenessRatio:(int)uniquenessRatio NS_SWIFT_NAME(setUniquenessRatio(uniquenessRatio:));

    Swift

    func setUniquenessRatio(uniquenessRatio: Int32)