cv::mcc::CCheckerDetector Class Reference

A class to find the positions of the ColorCharts in the image. More...

#include <opencv2/objdetect/mcc_checker_detector.hpp>

Collaboration diagram for cv::mcc::CCheckerDetector:

Public Member Functions
virtual void	draw (std::vector< Ptr< CChecker > > &checkers, InputOutputArray img, const Scalar color=CV_RGB(0, 250, 0), const int thickness=2)=0
	Draws the checker to the given image.
virtual Ptr< mcc::CChecker >	getBestColorChecker ()=0
	Get the best color checker. By the best it means the one detected with the highest confidence.
virtual ColorChart	getColorChartType () const =0
virtual const DetectorParametersMCC &	getDetectionParams () const =0
virtual std::vector< Ptr< CChecker > >	getListColorChecker ()=0
	Get the list of all detected colorcheckers.
virtual Mat	getRefColors ()=0
	Gets the reference color for chart.
virtual bool	process (InputArray image, const int nc=1)=0
	Find the ColorCharts in the given image.
virtual bool	process (InputArray image, const std::vector< Rect > &regionsOfInterest, const int nc=1)=0
	Find the ColorCharts in the given image.
virtual void	setColorChartType (ColorChart chartType)=0
	Sets the color chart type for MCC detection.
virtual void	setDetectionParams (const DetectorParametersMCC &params)=0
	Sets the detection paramaters for mcc.
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

Static Public Member Functions
static Ptr< CCheckerDetector >	create ()
	Returns the implementation of the CCheckerDetector.
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.

Additional Inherited Members
Protected Member Functions inherited from cv::Algorithm
void	writeFormat (FileStorage &fs) const

Detailed Description

A class to find the positions of the ColorCharts in the image.

Member Function Documentation

create()

static Ptr< CCheckerDetector > cv::mcc::CCheckerDetector::create ( )

static

Python:
	cv.mcc.CCheckerDetector.create(		) ->	retval
	cv.mcc.CCheckerDetector.create(	net	) ->	retval
	cv.mcc.CCheckerDetector_create(		) ->	retval
	cv.mcc.CCheckerDetector_create(	net	) ->	retval

Returns the implementation of the CCheckerDetector.

draw()

virtual void cv::mcc::CCheckerDetector::draw ( std::vector< Ptr< CChecker > > & checkers, InputOutputArray img, const Scalar color = CV_RGB(0, 250, 0), const int thickness = 2 )

pure virtual

Python:
	cv.mcc.CCheckerDetector.draw(	checkers, img[, color[, thickness]]	) ->	img

Draws the checker to the given image.

Parameters

img	image in color space BGR
checkers	The checkers which will be drawn by this object.
color	The color by with which the squares of the checker will be drawn
thickness	The thickness with which the sqaures will be drawn

getBestColorChecker()

virtual Ptr< mcc::CChecker > cv::mcc::CCheckerDetector::getBestColorChecker ( )

pure virtual

Python:
	cv.mcc.CCheckerDetector.getBestColorChecker(		) ->	retval

Get the best color checker. By the best it means the one detected with the highest confidence.

Returns

checker A single colorchecker, if atleast one colorchecker was detected, 'nullptr' otherwise.

getColorChartType()

virtual ColorChart cv::mcc::CCheckerDetector::getColorChartType ( ) const

pure virtual

Python:
	cv.mcc.CCheckerDetector.getColorChartType(		) ->	retval

getDetectionParams()

virtual const DetectorParametersMCC & cv::mcc::CCheckerDetector::getDetectionParams ( ) const

pure virtual

Python:
	cv.mcc.CCheckerDetector.getDetectionParams(		) ->	retval

getListColorChecker()

virtual std::vector< Ptr< CChecker > > cv::mcc::CCheckerDetector::getListColorChecker ( )

pure virtual

Python:
	cv.mcc.CCheckerDetector.getListColorChecker(		) ->	retval

Get the list of all detected colorcheckers.

Returns

checkers vector of colorcheckers

getRefColors()

virtual Mat cv::mcc::CCheckerDetector::getRefColors ( )

pure virtual

Python:
	cv.mcc.CCheckerDetector.getRefColors(		) ->	retval

Gets the reference color for chart.

process() [1/2]

virtual bool cv::mcc::CCheckerDetector::process ( InputArray image, const int nc = 1 )

pure virtual

Python:
	cv.mcc.CCheckerDetector.process(	image[, nc]	) ->	retval
	cv.mcc.CCheckerDetector.processWithROI(	image, regionsOfInterest[, nc]	) ->	retval

Find the ColorCharts in the given image.

Differs from the above one only in the arguments.

This version searches for the chart in the full image.

The found charts are not returned but instead stored in the detector, these can be accessed later on using getBestColorChecker() and getListColorChecker()

Parameters

image	image in color space BGR
nc	number of charts in the image, if you don't know the exact then keeping this number high helps.

Returns

true if atleast one chart is detected otherwise false

process() [2/2]

virtual bool cv::mcc::CCheckerDetector::process ( InputArray image, const std::vector< Rect > & regionsOfInterest, const int nc = 1 )

pure virtual

Python:
	cv.mcc.CCheckerDetector.process(	image[, nc]	) ->	retval
	cv.mcc.CCheckerDetector.processWithROI(	image, regionsOfInterest[, nc]	) ->	retval

Find the ColorCharts in the given image.

The found charts are not returned but instead stored in the detector, these can be accessed later on using getBestColorChecker() and getListColorChecker()

Parameters

image	image in color space BGR
regionsOfInterest	regions of image to look for the chart, if it is empty, charts are looked for in the entire image
nc	number of charts in the image, if you don't know the exact then keeping this number high helps.

Returns

true if atleast one chart is detected otherwise false

setColorChartType()

virtual void cv::mcc::CCheckerDetector::setColorChartType ( ColorChart chartType )

pure virtual

Python:
	cv.mcc.CCheckerDetector.setColorChartType(	chartType	) ->	None

Sets the color chart type for MCC detection.

Parameters

chartType

ColorChart enum specifying the type of color chart to detect.

setDetectionParams()

virtual void cv::mcc::CCheckerDetector::setDetectionParams ( const DetectorParametersMCC & params )

pure virtual

Python:
	cv.mcc.CCheckerDetector.setDetectionParams(	params	) ->	None

Sets the detection paramaters for mcc.

Parameters

params

DetectorParametersMCC structure containing detection configuration parameters.

---

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

• opencv2/objdetect/mcc_checker_detector.hpp