| OpenCV 4.3.0 Open Source Computer Vision

Public Member Functions | List of all members
cv::structured_light::StructuredLightPattern Class Referenceabstract
Structured Light API

Abstract base class for generating and decoding structured light patterns. More...

`#include <opencv2/structured_light/structured_light.hpp>`

Inheritance diagram for cv::structured_light::StructuredLightPattern:

## Public Member Functions
virtual bool | decode (const std::vector< std::vector< Mat > > &patternImages, OutputArray disparityMap, InputArrayOfArrays blackImages=noArray(), InputArrayOfArrays whiteImages=noArray(), int flags=DECODE_3D_UNDERWORLD) const =0
| Decodes the structured light pattern, generating a disparity map. More...
virtual bool | generate (OutputArrayOfArrays patternImages)=0
| Generates the structured light pattern to project. More...
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

Abstract base class for generating and decoding structured light patterns.

## Member Function Documentation

## ◆ decode()

virtual bool cv::structured_light::StructuredLightPattern::decode | ( | const std::vector< std::vector< Mat > > & | patternImages,
|  | OutputArray | disparityMap,
|  | InputArrayOfArrays | blackImages = `noArray()`,
|  | InputArrayOfArrays | whiteImages = `noArray()`,
|  | int | flags = `DECODE_3D_UNDERWORLD`
| ) |  | const
| pure virtual

Python:
| retval, disparityMap | = | cv.structured_light_StructuredLightPattern.decode( | patternImages[, disparityMap[, blackImages[, whiteImages[, flags]]]] | )

Decodes the structured light pattern, generating a disparity map.

Parameters

  patternImages | The acquired pattern images to decode (vector<vector<Mat>>), loaded as grayscale and previously rectified.
  disparityMap | The decoding result: a CV_64F Mat at image resolution, storing the computed disparity map.
  blackImages | The all-black images needed for shadowMasks computation.
  whiteImages | The all-white images needed for shadowMasks computation.
  flags | Flags setting decoding algorithms. Default: DECODE_3D_UNDERWORLD.

Note
  All the images must be at the same resolution.

## ◆ generate()

virtual bool cv::structured_light::StructuredLightPattern::generate | ( | OutputArrayOfArrays | patternImages | ) |
| pure virtual

Python:
| retval, patternImages | = | cv.structured_light_StructuredLightPattern.generate( | [, patternImages] | )

Generates the structured light pattern to project.

Parameters

  patternImages | The generated pattern: a vector<Mat>, in which each image is a CV_8U Mat at projector's resolution.

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

- opencv2/structured_light/structured_light.hpp