aruco::DictionaryBased Class Reference

#include <dictionary_based.h>

Inheritance diagram for aruco::DictionaryBased:

Public Member Functions
bool	detect (const cv::Mat &in, int &marker_id, int &nRotations)
std::string	getName () const
void	setParams (const Dictionary &dic, float max_correction_rate)
virtual	~DictionaryBased ()
Public Member Functions inherited from aruco::MarkerLabeler
virtual int	getBestInputSize ()
	getBestInputSize if desired, you can set the desired input size to the detect function More...
virtual	~MarkerLabeler ()

Private Member Functions
bool	getInnerCode (const cv::Mat &thres_img, int total_nbits, vector< uint64_t > &ids)
cv::Mat	rotate (const cv::Mat &in)
void	toMat (uint64_t code, int nbits_sq, cv::Mat &out)
uint64_t	touulong (const cv::Mat &code)

Private Attributes
Dictionary	_dic
int	_maxCorrectionAllowed

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

Detailed Description

Labeler using a dictionary

Definition at line 40 of file dictionary_based.h.

Constructor & Destructor Documentation

~DictionaryBased()

virtual aruco::DictionaryBased::~DictionaryBased ( )

inlinevirtual

Definition at line 43 of file dictionary_based.h.

Member Function Documentation

detect()

bool aruco::DictionaryBased::detect ( const cv::Mat &  in, int &  marker_id, int &  nRotations  )

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

Implements aruco::MarkerLabeler.

Definition at line 43 of file dictionary_based.cpp.

getInnerCode()

bool aruco::DictionaryBased::getInnerCode ( const cv::Mat &  thres_img, int  total_nbits, vector< uint64_t > &  ids  )

private

Definition at line 82 of file dictionary_based.cpp.

getName()

std::string aruco::DictionaryBased::getName ( ) const

virtual

Implements aruco::MarkerLabeler.

Definition at line 15 of file dictionary_based.cpp.

rotate()

cv::Mat aruco::DictionaryBased::rotate ( const cv::Mat &  in )

private

Definition at line 140 of file dictionary_based.cpp.

setParams()

void aruco::DictionaryBased::setParams	(	const Dictionary &	dic,
		float	max_correction_rate
	)

Definition at line 8 of file dictionary_based.cpp.

toMat()

void aruco::DictionaryBased::toMat ( uint64_t  code, int  nbits_sq, cv::Mat &  out  )

private

Definition at line 19 of file dictionary_based.cpp.

touulong()

uint64_t aruco::DictionaryBased::touulong ( const cv::Mat &  code )

private

Definition at line 130 of file dictionary_based.cpp.

Member Data Documentation

_dic

Dictionary aruco::DictionaryBased::_dic

private

Definition at line 57 of file dictionary_based.h.

_maxCorrectionAllowed

int aruco::DictionaryBased::_maxCorrectionAllowed

private

Definition at line 58 of file dictionary_based.h.

---

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

• dictionary_based.h
• dictionary_based.cpp