cv::structured_light::StructuredLightPattern Class Reference

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

#include <opencv2/structured_light/structured_light.hpp>

Collaboration 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.
virtual bool	generate (OutputArrayOfArrays patternImages)=0
	Generates the structured light pattern to project.
Public Member Functions inherited from cv::Algorithm
	Algorithm ()
virtual	~Algorithm ()
virtual void	clear ()
	Clears the algorithm state.
virtual bool	empty () const
	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
virtual String	getDefaultName () const
virtual void	read (const FileNode &fn)
	Reads algorithm parameters from a file storage.
virtual void	save (const String &filename) const
virtual void	write (FileStorage &fs) const
	Stores algorithm parameters in a file storage.
void	write (FileStorage &fs, const String &name) const

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.
template<typename _Tp >
static Ptr< _Tp >	loadFromString (const String &strModel, const String &objname=String())
	Loads algorithm from a String.
template<typename _Tp >
static Ptr< _Tp >	read (const FileNode &fn)
	Reads algorithm from the file node.
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:
	cv.structured_light.StructuredLightPattern.decode(	patternImages[, disparityMap[, blackImages[, whiteImages[, flags]]]]	) ->	retval, disparityMap

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.

Here is the call graph for this function:

generate()

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

pure virtual

Python:
	cv.structured_light.StructuredLightPattern.generate(	[, patternImages]	) ->	retval, 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