cv::StereoBM Class Reference

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

#include <calib3d.hpp>

Inheritance diagram for cv::StereoBM:

Public Types
enum	{ PREFILTER_NORMALIZED_RESPONSE = 0 , PREFILTER_XSOBEL = 1 }
Public Types inherited from cv::StereoMatcher
enum	{ DISP_SHIFT = 4 , DISP_SCALE = (1 << DISP_SHIFT) }

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

Static Public Member Functions
static CV_WRAP Ptr< StereoBM >	create (int numDisparities=0, int blockSize=21)
	Creates StereoBM object. More...
Static Public Member Functions inherited from cv::Algorithm
template<typename _Tp >
static Ptr< _Tp >	read (const FileNode &fn)
	Reads algorithm from the file node. More...
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...

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

Enumerator
PREFILTER_NORMALIZED_RESPONSE
PREFILTER_XSOBEL

Member Function Documentation

create()

static CV_WRAP Ptr<StereoBM> cv::StereoBM::create ( int  numDisparities = 0, int  blockSize = 21  )

static

Creates StereoBM object.

Parameters

numDisparities	the 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.
blockSize	the 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 CV_WRAP int cv::StereoBM::getPreFilterCap ( ) const

pure virtual

getPreFilterSize()

virtual CV_WRAP int cv::StereoBM::getPreFilterSize ( ) const

pure virtual

getPreFilterType()

virtual CV_WRAP int cv::StereoBM::getPreFilterType ( ) const

pure virtual

getROI1()

virtual CV_WRAP Rect cv::StereoBM::getROI1 ( ) const

pure virtual

getROI2()

virtual CV_WRAP Rect cv::StereoBM::getROI2 ( ) const

pure virtual

getSmallerBlockSize()

virtual CV_WRAP int cv::StereoBM::getSmallerBlockSize ( ) const

pure virtual

getTextureThreshold()

virtual CV_WRAP int cv::StereoBM::getTextureThreshold ( ) const

pure virtual

getUniquenessRatio()

virtual CV_WRAP int cv::StereoBM::getUniquenessRatio ( ) const

pure virtual

setPreFilterCap()

virtual CV_WRAP void cv::StereoBM::setPreFilterCap ( int  preFilterCap )

pure virtual

setPreFilterSize()

virtual CV_WRAP void cv::StereoBM::setPreFilterSize ( int  preFilterSize )

pure virtual

setPreFilterType()

virtual CV_WRAP void cv::StereoBM::setPreFilterType ( int  preFilterType )

pure virtual

setROI1()

virtual CV_WRAP void cv::StereoBM::setROI1 ( Rect  roi1 )

pure virtual

setROI2()

virtual CV_WRAP void cv::StereoBM::setROI2 ( Rect  roi2 )

pure virtual

setSmallerBlockSize()

virtual CV_WRAP void cv::StereoBM::setSmallerBlockSize ( int  blockSize )

pure virtual

setTextureThreshold()

virtual CV_WRAP void cv::StereoBM::setTextureThreshold ( int  textureThreshold )

pure virtual

setUniquenessRatio()

virtual CV_WRAP void cv::StereoBM::setUniquenessRatio ( int  uniquenessRatio )

pure virtual

---

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

• build/release/_deps/opencv-src/include/opencv4/opencv2/calib3d.hpp