OpenCV for Unity  2.6.0
Enox Software / Please refer to OpenCV official document ( http://docs.opencv.org/4.9.0/index.html ) for the details of the argument of the method.
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
OpenCVForUnity.Calib3dModule.StereoBM Class Reference

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

Inheritance diagram for OpenCVForUnity.Calib3dModule.StereoBM:
OpenCVForUnity.Calib3dModule.StereoMatcher OpenCVForUnity.CoreModule.Algorithm OpenCVForUnity.DisposableOpenCVObject OpenCVForUnity.DisposableObject

Public Member Functions

int getPreFilterType ()
 
void setPreFilterType (int preFilterType)
 
int getPreFilterSize ()
 
void setPreFilterSize (int preFilterSize)
 
int getPreFilterCap ()
 
void setPreFilterCap (int preFilterCap)
 
int getTextureThreshold ()
 
void setTextureThreshold (int textureThreshold)
 
int getUniquenessRatio ()
 
void setUniquenessRatio (int uniquenessRatio)
 
int getSmallerBlockSize ()
 
void setSmallerBlockSize (int blockSize)
 
Rect getROI1 ()
 
void setROI1 (Rect roi1)
 
Rect getROI2 ()
 
void setROI2 (Rect roi2)
 
- Public Member Functions inherited from OpenCVForUnity.Calib3dModule.StereoMatcher
void compute (Mat left, Mat right, Mat disparity)
 Computes disparity map for the specified stereo pair. More...
 
int getMinDisparity ()
 
void setMinDisparity (int minDisparity)
 
int getNumDisparities ()
 
void setNumDisparities (int numDisparities)
 
int getBlockSize ()
 
void setBlockSize (int blockSize)
 
int getSpeckleWindowSize ()
 
void setSpeckleWindowSize (int speckleWindowSize)
 
int getSpeckleRange ()
 
void setSpeckleRange (int speckleRange)
 
int getDisp12MaxDiff ()
 
void setDisp12MaxDiff (int disp12MaxDiff)
 
- Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
IntPtr getNativeObjAddr ()
 
virtual void clear ()
 Clears the algorithm state. More...
 
virtual bool empty ()
 Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read. More...
 
void save (string filename)
 
virtual string getDefaultName ()
 
- Public Member Functions inherited from OpenCVForUnity.DisposableObject
void Dispose ()
 
void ThrowIfDisposed ()
 

Static Public Member Functions

static new StereoBM __fromPtr__ (IntPtr addr)
 
static StereoBM create (int numDisparities, int blockSize)
 Creates StereoBM object. More...
 
static StereoBM create (int numDisparities)
 Creates StereoBM object. More...
 
static StereoBM create ()
 Creates StereoBM object. More...
 
- Static Public Member Functions inherited from OpenCVForUnity.Calib3dModule.StereoMatcher
static new StereoMatcher __fromPtr__ (IntPtr addr)
 
- Static Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
static Algorithm __fromPtr__ (IntPtr addr)
 
- Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr ThrowIfNullIntPtr (IntPtr ptr)
 

Public Attributes

const int PREFILTER_NORMALIZED_RESPONSE = 0
 
const int PREFILTER_XSOBEL = 1
 
- Public Attributes inherited from OpenCVForUnity.Calib3dModule.StereoMatcher
const int DISP_SHIFT = 4
 
const int DISP_SCALE = (1 << DISP_SHIFT)
 

Protected Member Functions

override void Dispose (bool disposing)
 
- Protected Member Functions inherited from OpenCVForUnity.Calib3dModule.StereoMatcher
override void Dispose (bool disposing)
 
- Protected Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
override void Dispose (bool disposing)
 
- Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
 DisposableOpenCVObject ()
 
 DisposableOpenCVObject (IntPtr ptr)
 
 DisposableOpenCVObject (bool isEnabledDispose)
 
 DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
 
override void Dispose (bool disposing)
 
- Protected Member Functions inherited from OpenCVForUnity.DisposableObject
 DisposableObject ()
 
 DisposableObject (bool isEnabledDispose)
 

Additional Inherited Members

- Properties inherited from OpenCVForUnity.DisposableObject
bool IsDisposed [get, protected set]
 
bool IsEnabledDispose [get, set]
 

Detailed Description

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

Member Function Documentation

◆ __fromPtr__()

static new StereoBM OpenCVForUnity.Calib3dModule.StereoBM.__fromPtr__ ( IntPtr  addr)
static

◆ create() [1/3]

static StereoBM OpenCVForUnity.Calib3dModule.StereoBM.create ( int  numDisparities,
int  blockSize 
)
static

Creates StereoBM object.

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

◆ create() [2/3]

static StereoBM OpenCVForUnity.Calib3dModule.StereoBM.create ( int  numDisparities)
static

Creates StereoBM object.

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

◆ create() [3/3]

static StereoBM OpenCVForUnity.Calib3dModule.StereoBM.create ( )
static

Creates StereoBM object.

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

◆ Dispose()

override void OpenCVForUnity.Calib3dModule.StereoBM.Dispose ( bool  disposing)
protectedvirtual

Reimplemented from OpenCVForUnity.DisposableObject.

◆ getPreFilterCap()

int OpenCVForUnity.Calib3dModule.StereoBM.getPreFilterCap ( )

◆ getPreFilterSize()

int OpenCVForUnity.Calib3dModule.StereoBM.getPreFilterSize ( )

◆ getPreFilterType()

int OpenCVForUnity.Calib3dModule.StereoBM.getPreFilterType ( )

◆ getROI1()

Rect OpenCVForUnity.Calib3dModule.StereoBM.getROI1 ( )

◆ getROI2()

Rect OpenCVForUnity.Calib3dModule.StereoBM.getROI2 ( )

◆ getSmallerBlockSize()

int OpenCVForUnity.Calib3dModule.StereoBM.getSmallerBlockSize ( )

◆ getTextureThreshold()

int OpenCVForUnity.Calib3dModule.StereoBM.getTextureThreshold ( )

◆ getUniquenessRatio()

int OpenCVForUnity.Calib3dModule.StereoBM.getUniquenessRatio ( )

◆ setPreFilterCap()

void OpenCVForUnity.Calib3dModule.StereoBM.setPreFilterCap ( int  preFilterCap)

◆ setPreFilterSize()

void OpenCVForUnity.Calib3dModule.StereoBM.setPreFilterSize ( int  preFilterSize)

◆ setPreFilterType()

void OpenCVForUnity.Calib3dModule.StereoBM.setPreFilterType ( int  preFilterType)

◆ setROI1()

void OpenCVForUnity.Calib3dModule.StereoBM.setROI1 ( Rect  roi1)

◆ setROI2()

void OpenCVForUnity.Calib3dModule.StereoBM.setROI2 ( Rect  roi2)

◆ setSmallerBlockSize()

void OpenCVForUnity.Calib3dModule.StereoBM.setSmallerBlockSize ( int  blockSize)

◆ setTextureThreshold()

void OpenCVForUnity.Calib3dModule.StereoBM.setTextureThreshold ( int  textureThreshold)

◆ setUniquenessRatio()

void OpenCVForUnity.Calib3dModule.StereoBM.setUniquenessRatio ( int  uniquenessRatio)

Member Data Documentation

◆ PREFILTER_NORMALIZED_RESPONSE

const int OpenCVForUnity.Calib3dModule.StereoBM.PREFILTER_NORMALIZED_RESPONSE = 0

◆ PREFILTER_XSOBEL

const int OpenCVForUnity.Calib3dModule.StereoBM.PREFILTER_XSOBEL = 1

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