OpenCV  3.4.20-dev
Open Source Computer Vision
Public Types | Public Member Functions | Static Public Member Functions | List of all members
cv::StereoBM Class Referenceabstract

Class for computing stereo correspondence using the block matching algorithm, introduced and contributed to OpenCV by K. Konolige. More...

#include <opencv2/calib3d.hpp>

Inheritance diagram for cv::StereoBM:
cv::StereoMatcher cv::Algorithm cv::cuda::StereoBM

Public Types

enum  {
- Public Types inherited from cv::StereoMatcher
enum  {

Public Member Functions

virtual int getPreFilterCap () const =0
virtual int getPreFilterSize () const =0
virtual int getPreFilterType () const =0
virtual Rect getROI1 () const =0
virtual Rect getROI2 () const =0
virtual int getSmallerBlockSize () const =0
virtual int getTextureThreshold () const =0
virtual int getUniquenessRatio () const =0
virtual void setPreFilterCap (int preFilterCap)=0
virtual void setPreFilterSize (int preFilterSize)=0
virtual void setPreFilterType (int preFilterType)=0
virtual void setROI1 (Rect roi1)=0
virtual void setROI2 (Rect roi2)=0
virtual void setSmallerBlockSize (int blockSize)=0
virtual void setTextureThreshold (int textureThreshold)=0
virtual void setUniquenessRatio (int uniquenessRatio)=0
- Public Member Functions inherited from cv::StereoMatcher
virtual void compute (InputArray left, InputArray right, OutputArray disparity)=0
 Computes disparity map for the specified stereo pair. More...
virtual int getBlockSize () const =0
virtual int getDisp12MaxDiff () const =0
virtual int getMinDisparity () const =0
virtual int getNumDisparities () const =0
virtual int getSpeckleRange () const =0
virtual int getSpeckleWindowSize () const =0
virtual void setBlockSize (int blockSize)=0
virtual void setDisp12MaxDiff (int disp12MaxDiff)=0
virtual void setMinDisparity (int minDisparity)=0
virtual void setNumDisparities (int numDisparities)=0
virtual void setSpeckleRange (int speckleRange)=0
virtual void setSpeckleWindowSize (int speckleWindowSize)=0
- Public Member Functions inherited from cv::Algorithm
 Algorithm ()
virtual ~Algorithm ()
virtual void clear ()
 Clears the algorithm state. More...
virtual bool empty () const
 Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read. More...
virtual String getDefaultName () const
virtual void read (const FileNode &fn)
 Reads algorithm parameters from a file storage. More...
virtual void save (const String &filename) const
virtual void write (FileStorage &fs) const
 Stores algorithm parameters in a file storage. More...
void write (FileStorage &fs, const String &name) const
void write (const Ptr< FileStorage > &fs, const String &name=String()) const

Static Public Member Functions

static Ptr< StereoBMcreate (int numDisparities=0, int blockSize=21)
 Creates StereoBM object. More...
- Static Public Member Functions inherited from cv::Algorithm
template<typename _Tp >
static Ptr< _Tp > load (const String &filename, const String &objname=String())
 Loads algorithm from the file. More...
template<typename _Tp >
static Ptr< _Tp > loadFromString (const String &strModel, const String &objname=String())
 Loads algorithm from a String. More...
template<typename _Tp >
static Ptr< _Tp > read (const FileNode &fn)
 Reads algorithm from the file node. More...

Additional Inherited Members

- Protected Member Functions inherited from cv::Algorithm
void writeFormat (FileStorage &fs) const

Detailed Description

Class for computing stereo correspondence using the block matching algorithm, introduced and contributed to OpenCV by K. Konolige.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Member Function Documentation

◆ create()

static Ptr<StereoBM> cv::StereoBM::create ( int  numDisparities = 0,
int  blockSize = 21 
cv.StereoBM.create([, numDisparities[, blockSize]]) -> retval
cv.StereoBM_create([, numDisparities[, blockSize]]) -> retval

Creates StereoBM object.

numDisparitiesthe disparity search range. For each pixel algorithm will find the best disparity from 0 (default minimum disparity) to numDisparities. The search range can then be shifted by changing the minimum disparity.
blockSizethe linear size of the blocks compared by the algorithm. The size should be odd (as the block is centered at the current pixel). Larger block size implies smoother, though less accurate disparity map. Smaller block size gives more detailed disparity map, but there is higher chance for algorithm to find a wrong correspondence.

The function create StereoBM object. You can then call StereoBM::compute() to compute disparity for a specific stereo pair.

◆ getPreFilterCap()

virtual int cv::StereoBM::getPreFilterCap ( ) const
pure virtual
cv.StereoBM.getPreFilterCap() -> retval

◆ getPreFilterSize()

virtual int cv::StereoBM::getPreFilterSize ( ) const
pure virtual
cv.StereoBM.getPreFilterSize() -> retval

◆ getPreFilterType()

virtual int cv::StereoBM::getPreFilterType ( ) const
pure virtual
cv.StereoBM.getPreFilterType() -> retval

◆ getROI1()

virtual Rect cv::StereoBM::getROI1 ( ) const
pure virtual
cv.StereoBM.getROI1() -> retval

◆ getROI2()

virtual Rect cv::StereoBM::getROI2 ( ) const
pure virtual
cv.StereoBM.getROI2() -> retval

◆ getSmallerBlockSize()

virtual int cv::StereoBM::getSmallerBlockSize ( ) const
pure virtual
cv.StereoBM.getSmallerBlockSize() -> retval

◆ getTextureThreshold()

virtual int cv::StereoBM::getTextureThreshold ( ) const
pure virtual
cv.StereoBM.getTextureThreshold() -> retval

◆ getUniquenessRatio()

virtual int cv::StereoBM::getUniquenessRatio ( ) const
pure virtual
cv.StereoBM.getUniquenessRatio() -> retval

◆ setPreFilterCap()

virtual void cv::StereoBM::setPreFilterCap ( int  preFilterCap)
pure virtual
cv.StereoBM.setPreFilterCap(preFilterCap) -> None

◆ setPreFilterSize()

virtual void cv::StereoBM::setPreFilterSize ( int  preFilterSize)
pure virtual
cv.StereoBM.setPreFilterSize(preFilterSize) -> None

◆ setPreFilterType()

virtual void cv::StereoBM::setPreFilterType ( int  preFilterType)
pure virtual
cv.StereoBM.setPreFilterType(preFilterType) -> None

◆ setROI1()

virtual void cv::StereoBM::setROI1 ( Rect  roi1)
pure virtual
cv.StereoBM.setROI1(roi1) -> None

◆ setROI2()

virtual void cv::StereoBM::setROI2 ( Rect  roi2)
pure virtual
cv.StereoBM.setROI2(roi2) -> None

◆ setSmallerBlockSize()

virtual void cv::StereoBM::setSmallerBlockSize ( int  blockSize)
pure virtual
cv.StereoBM.setSmallerBlockSize(blockSize) -> None

◆ setTextureThreshold()

virtual void cv::StereoBM::setTextureThreshold ( int  textureThreshold)
pure virtual
cv.StereoBM.setTextureThreshold(textureThreshold) -> None

◆ setUniquenessRatio()

virtual void cv::StereoBM::setUniquenessRatio ( int  uniquenessRatio)
pure virtual
cv.StereoBM.setUniquenessRatio(uniquenessRatio) -> None

The documentation for this class was generated from the following file: