aruco::Dictionary Class Reference

#include <highlyreliablemarkers.h>

Inheritance diagram for aruco::Dictionary:

Public Member Functions
unsigned int	distance (const MarkerCode &m, unsigned int &minMarker, unsigned int &minRot)
unsigned int	distance (const MarkerCode &m)
bool	fromFile (std::string filename)
unsigned int	minimunDistance ()
bool	toFile (std::string filename)

Public Attributes
int	tau0

Static Private Member Functions
template<class T >
static std::string	toStr (T num)

Detailed Description

This class represent a marker dictionary as a vector of MarkerCodes

Definition at line 161 of file highlyreliablemarkers.h.

Member Function Documentation

unsigned int aruco::Dictionary::distance	(	const MarkerCode &	m,
		unsigned int &	minMarker,
		unsigned int &	minRot
	)

Return the distance of a marker to the dictionary, D(m,D) (Equation 7) Assign to minMarker the marker index in the dictionary with minimun distance to m Assign to minRot the rotation of minimun hamming distance. The rotation refers to the marker passed as parameter, m

Definition at line 239 of file highlyreliablemarkers.cpp.

unsigned int aruco::Dictionary::distance ( const MarkerCode &  m )

inline

Return the distance of a marker to the dictionary, D(m,D) (Equation 7) Same method as distance(MarkerCode m, uint &minMarker, uint &minRot), except this doesnt return minMarker and minRot values.

Definition at line 184 of file highlyreliablemarkers.h.

bool aruco::Dictionary::fromFile

(

std::string

filename

)

Read dictionary from a .yml opencv file

Definition at line 199 of file highlyreliablemarkers.cpp.

unsigned int aruco::Dictionary::minimunDistance

(

)

Calculate the minimun distance between the markers in the dictionary (Equation 9)

Definition at line 256 of file highlyreliablemarkers.cpp.

bool aruco::Dictionary::toFile

(

std::string

filename

)

Write dictionary to a .yml opencv file

Definition at line 222 of file highlyreliablemarkers.cpp.

template<class T >

static std::string aruco::Dictionary::toStr ( T  num )

inlinestaticprivate

Definition at line 198 of file highlyreliablemarkers.h.

Member Data Documentation

int aruco::Dictionary::tau0

Definition at line 194 of file highlyreliablemarkers.h.

---

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

• highlyreliablemarkers.h
• highlyreliablemarkers.cpp