aruco::MarkerLabeler Class Reference

#include <markerlabeler.h>

Inheritance diagram for aruco::MarkerLabeler:

Public Member Functions
virtual bool	detect (const cv::Mat &in, int &marker_id, int &nRotations, std::string &additionalInfo)=0
virtual int	getBestInputSize ()
	getBestInputSize if desired, you can set the desired input size to the detect function More...
virtual std::string	getName () const =0
virtual int	getNSubdivisions () const
	getNSubdivisions returns the number of subdivisions in each axis that the iamge will be subject to. This is in dictionary based labelers, equals to the number of bits in each dimension plus the border bits. More...
virtual	~MarkerLabeler ()

Static Public Member Functions
static cv::Ptr< MarkerLabeler >	create (Dictionary::DICT_TYPES dict_type, float error_correction_rate=0)
static cv::Ptr< MarkerLabeler >	create (std::string detector, std::string params="")
	create Factory function that returns the desired detector More...

Detailed Description

Definition at line 32 of file markerlabeler.h.

Constructor & Destructor Documentation

~MarkerLabeler()

virtual aruco::MarkerLabeler::~MarkerLabeler ( )

inlinevirtual

Definition at line 93 of file markerlabeler.h.

Member Function Documentation

create() [1/2]

cv::Ptr< MarkerLabeler > aruco::MarkerLabeler::create ( Dictionary::DICT_TYPES  dict_type, float  error_correction_rate = 0  )

static

Factory function that returns a labeler for a given dictionary

Parameters

dict_type	type of dictionary
error_correction_rate	some dictionaries are subsceptible of error correction. This params specify the correction rate. 0 means no correction at all. 1 means full correction (maximum correction bits = (tau-1) /2, tau= predefined mimum intermarker distance).

If you want correction capabilities and not sure how much, use 0.5 in this parameter

Definition at line 20 of file markerlabeler.cpp.

create() [2/2]

cv::Ptr< MarkerLabeler > aruco::MarkerLabeler::create ( std::string  detector, std::string  params = ""  )

static

create Factory function that returns the desired detector

Factory function that returns the desired detector

Parameters

detector

Possible names implemented are: ARUCO,CHILITAGS....: original aruco markers (0-1024) http://www.sciencedirect.com/science/article/pii/S0031320314000235 SVM:

Returns

Definition at line 28 of file markerlabeler.cpp.

detect()

virtual bool aruco::MarkerLabeler::detect ( const cv::Mat &  in, int &  marker_id, int &  nRotations, std::string &  additionalInfo  )

pure virtual

function that identifies a marker.

Parameters

in	input image to analyze
marker_id	id of the marker (if valid)
nRotations	: output parameter nRotations must indicate how many times the marker must be rotated clockwise 90 deg to be in its ideal position. (The way you would see it when you print it). This is employed to know always which is the corner that acts as reference system.

Returns

true marker valid, false otherwise

Implemented in aruco::DictionaryBased, and aruco::FractalMarkerLabeler.

getBestInputSize()

virtual int aruco::MarkerLabeler::getBestInputSize ( )

inlinevirtual

getBestInputSize if desired, you can set the desired input size to the detect function

Returns

-1 if detect accept any type of input, or a size otherwise

Definition at line 75 of file markerlabeler.h.

getName()

virtual std::string aruco::MarkerLabeler::getName ( ) const

pure virtual

Implemented in aruco::DictionaryBased, and aruco::FractalMarkerLabeler.

getNSubdivisions()

virtual int aruco::MarkerLabeler::getNSubdivisions ( ) const

inlinevirtual

getNSubdivisions returns the number of subdivisions in each axis that the iamge will be subject to. This is in dictionary based labelers, equals to the number of bits in each dimension plus the border bits.

Returns

Reimplemented in aruco::DictionaryBased, and aruco::FractalMarkerLabeler.

Definition at line 86 of file markerlabeler.h.

---

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

• markerlabeler.h
• markerlabeler.cpp