OpenCVForUnity.Calib3dModule.StereoBM Class Reference

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

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

Static Public Member Functions
static new StereoBM	__fromPtr__ (IntPtr addr)
static StereoBM	create ()
	Creates StereoBM object.
static StereoBM	create (int numDisparities)
	Creates StereoBM object.
static StereoBM	create (int numDisparities, int blockSize)
	Creates StereoBM object.
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
int int int	width
int	x
int int	y

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

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
Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
	DisposableOpenCVObject ()
	DisposableOpenCVObject (bool isEnabledDispose)
	DisposableOpenCVObject (IntPtr ptr)
	DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
Protected Member Functions inherited from OpenCVForUnity.DisposableObject
	DisposableObject ()
	DisposableObject (bool isEnabledDispose)

Additional Inherited Members
Package Functions inherited from OpenCVForUnity.Calib3dModule.StereoMatcher
Package Functions inherited from OpenCVForUnity.CoreModule.Algorithm
Package Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
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 ( )

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.

create() [2/3]

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

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.

create() [3/3]

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

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.

Dispose()

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

protectedvirtual

Reimplemented from OpenCVForUnity.CoreModule.Algorithm.

getPreFilterCap()

int OpenCVForUnity.Calib3dModule.StereoBM.getPreFilterCap

(

)

getPreFilterSize()

int OpenCVForUnity.Calib3dModule.StereoBM.getPreFilterSize

(

)

getPreFilterType()

int OpenCVForUnity.Calib3dModule.StereoBM.getPreFilterType

(

)

getROI1()

Rect OpenCVForUnity.Calib3dModule.StereoBM.getROI1

(

)

getROI1AsValueTuple()

int int int int height OpenCVForUnity.Calib3dModule.StereoBM.getROI1AsValueTuple

(

)

getROI1AsVec4i()

Vec4i OpenCVForUnity.Calib3dModule.StereoBM.getROI1AsVec4i

(

)

getROI2()

Rect OpenCVForUnity.Calib3dModule.StereoBM.getROI2

(

)

getROI2AsValueTuple()

int int int int height OpenCVForUnity.Calib3dModule.StereoBM.getROI2AsValueTuple

(

)

getROI2AsVec4i()

Vec4i OpenCVForUnity.Calib3dModule.StereoBM.getROI2AsVec4i

(

)

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() [1/3]

void OpenCVForUnity.Calib3dModule.StereoBM.setROI1

(

in Vec4i

roi1

)

setROI1() [2/3]

void OpenCVForUnity.Calib3dModule.StereoBM.setROI1

(

in(int x, int y, int width, int height)

roi1

)

setROI1() [3/3]

void OpenCVForUnity.Calib3dModule.StereoBM.setROI1

(

Rect

roi1

)

setROI2() [1/3]

void OpenCVForUnity.Calib3dModule.StereoBM.setROI2

(

in Vec4i

roi2

)

setROI2() [2/3]

void OpenCVForUnity.Calib3dModule.StereoBM.setROI2

(

in(int x, int y, int width, int height)

roi2

)

setROI2() [3/3]

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

static

PREFILTER_XSOBEL

const int OpenCVForUnity.Calib3dModule.StereoBM.PREFILTER_XSOBEL = 1

static

width

int int int OpenCVForUnity.Calib3dModule.StereoBM.width

x

int OpenCVForUnity.Calib3dModule.StereoBM.x

y

int int OpenCVForUnity.Calib3dModule.StereoBM.y

---

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

• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/calib3d/StereoBM.cs
• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/calib3d/StereoBM_Struct.cs
• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/calib3d/StereoBM_ValueTuple.cs