Public Member Functions | Public Attributes | Static Private Member Functions | List of all members
aruco::Dictionary Class Reference

#include <highlyreliablemarkers.h>

Inheritance diagram for aruco::Dictionary:
Inheritance graph
[legend]

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

◆ distance() [1/2]

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.

◆ distance() [2/2]

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.

◆ fromFile()

bool aruco::Dictionary::fromFile ( std::string  filename)

Read dictionary from a .yml opencv file

Definition at line 199 of file highlyreliablemarkers.cpp.

◆ minimunDistance()

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.

◆ toFile()

bool aruco::Dictionary::toFile ( std::string  filename)

Write dictionary to a .yml opencv file

Definition at line 222 of file highlyreliablemarkers.cpp.

◆ toStr()

template<class T >
static std::string aruco::Dictionary::toStr ( num)
inlinestaticprivate

Definition at line 198 of file highlyreliablemarkers.h.

Member Data Documentation

◆ tau0

int aruco::Dictionary::tau0

Definition at line 194 of file highlyreliablemarkers.h.


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


asr_aruco_marker_recognition
Author(s): Allgeyer Tobias, Meißner Pascal, Qattan Mohamad
autogenerated on Mon Feb 28 2022 21:41:30