| OpenCV 4.3.0 Open Source Computer Vision

Public Types | Public Member Functions | List of all members
cv::stereo::StereoMatcher Class Referenceabstract
Stereo Correspondance Algorithms

Filters off small noise blobs (speckles) in the disparity map. More...

`#include <opencv2/stereo.hpp>`

Inheritance diagram for cv::stereo::StereoMatcher:

## Public Types
enum | { DISP_SHIFT = 4, DISP_SCALE = (1 << DISP_SHIFT) }

## Public Member Functions
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 (const Ptr< FileStorage > &fs, const String &name=String()) const
| simplified API for language bindings This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

## Additional Inherited Members
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...
Protected Member Functions inherited from cv::Algorithm
void | writeFormat (FileStorage &fs) const

## Detailed Description

Filters off small noise blobs (speckles) in the disparity map.

Parameters

  img | The input 16-bit signed disparity image
  newVal | The disparity value used to paint-off the speckles
  maxSpeckleSize | The maximum speckle size to consider it a speckle. Larger blobs are not affected by the algorithm
  maxDiff | Maximum difference between neighbor disparity pixels to put them into the same blob. Note that since StereoBM, StereoSGBM and may be other algorithms return a fixed-point disparity map, where disparity values are multiplied by 16, this scale factor should be taken into account when specifying this parameter value.
  buf | The optional temporary buffer to avoid memory allocation within the function.The base class for stereo correspondence algorithms.

## Member Enumeration Documentation

## ◆ anonymous enum

anonymous enum

Enumerator
DISP_SHIFT |
DISP_SCALE |

## Member Function Documentation

## ◆ compute()

virtual void cv::stereo::StereoMatcher::compute | ( | InputArray | left,
|  | InputArray | right,
|  | OutputArray | disparity
| ) |  |
| pure virtual

Computes disparity map for the specified stereo pair.

Parameters

  left | Left 8-bit single-channel image.
  right | Right image of the same size and the same type as the left one.
  disparity | Output disparity map. It has the same size as the input images. Some algorithms, like StereoBM or StereoSGBM compute 16-bit fixed-point disparity map (where each disparity value has 4 fractional bits), whereas other algorithms output 32-bit floating-point disparity map.

## ◆ getBlockSize()

virtual int cv::stereo::StereoMatcher::getBlockSize | ( |  | ) | const
| pure virtual

## ◆ getDisp12MaxDiff()

virtual int cv::stereo::StereoMatcher::getDisp12MaxDiff | ( |  | ) | const
| pure virtual

## ◆ getMinDisparity()

virtual int cv::stereo::StereoMatcher::getMinDisparity | ( |  | ) | const
| pure virtual

## ◆ getNumDisparities()

virtual int cv::stereo::StereoMatcher::getNumDisparities | ( |  | ) | const
| pure virtual

## ◆ getSpeckleRange()

virtual int cv::stereo::StereoMatcher::getSpeckleRange | ( |  | ) | const
| pure virtual

## ◆ getSpeckleWindowSize()

virtual int cv::stereo::StereoMatcher::getSpeckleWindowSize | ( |  | ) | const
| pure virtual

## ◆ setBlockSize()

virtual void cv::stereo::StereoMatcher::setBlockSize | ( | int | blockSize | ) |
| pure virtual

## ◆ setDisp12MaxDiff()

virtual void cv::stereo::StereoMatcher::setDisp12MaxDiff | ( | int | disp12MaxDiff | ) |
| pure virtual

## ◆ setMinDisparity()

virtual void cv::stereo::StereoMatcher::setMinDisparity | ( | int | minDisparity | ) |
| pure virtual

## ◆ setNumDisparities()

virtual void cv::stereo::StereoMatcher::setNumDisparities | ( | int | numDisparities | ) |
| pure virtual

## ◆ setSpeckleRange()

virtual void cv::stereo::StereoMatcher::setSpeckleRange | ( | int | speckleRange | ) |
| pure virtual

## ◆ setSpeckleWindowSize()

virtual void cv::stereo::StereoMatcher::setSpeckleWindowSize | ( | int | speckleWindowSize | ) |
| pure virtual

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

- opencv2/stereo.hpp