Public Types | Public Member Functions | Public Attributes | Private Member Functions | Friends | List of all members
aruco::BoardConfiguration Class Reference

This class defines a board with several markers. A Board contains several markers so that they are more robustly detected. More...

#include <board.h>

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

Public Types

enum  MarkerInfoType {
  NONE =-1, PIX =0, METERS =1, NONE =-1,
  PIX =0, METERS =1
}
 
enum  MarkerInfoType {
  NONE =-1, PIX =0, METERS =1, NONE =-1,
  PIX =0, METERS =1
}
 

Public Member Functions

 BoardConfiguration ()
 
 BoardConfiguration ()
 
 BoardConfiguration (const BoardConfiguration &T)
 
 BoardConfiguration (const BoardConfiguration &T)
 
void getIdList (vector< int > &ids, bool append=true) const
 
void getIdList (vector< int > &ids, bool append=true) const
 
int getIndexOfMarkerId (int id) const
 
int getIndexOfMarkerId (int id) const
 
const MarkerInfogetMarkerInfo (int id) const throw (cv::Exception)
 
const MarkerInfogetMarkerInfo (int id) const throw (cv::Exception)
 
bool isExpressedInMeters () const
 
bool isExpressedInMeters () const
 
bool isExpressedInPixels () const
 
bool isExpressedInPixels () const
 
BoardConfigurationoperator= (const BoardConfiguration &T)
 
BoardConfigurationoperator= (const BoardConfiguration &T)
 
void readFromFile (string sfile) throw (cv::Exception)
 
void readFromFile (string sfile) throw (cv::Exception)
 
void saveToFile (string sfile) throw (cv::Exception)
 
void saveToFile (string sfile) throw (cv::Exception)
 

Public Attributes

int mInfoType
 

Private Member Functions

void readFromFile (cv::FileStorage &fs) throw (cv::Exception)
 
void readFromFile (cv::FileStorage &fs) throw (cv::Exception)
 
void saveToFile (cv::FileStorage &fs) throw (cv::Exception)
 
void saveToFile (cv::FileStorage &fs) throw (cv::Exception)
 

Friends

class Board
 

Detailed Description

This class defines a board with several markers. A Board contains several markers so that they are more robustly detected.

In general, a board is a set of markers. So BoardConfiguration is only a list of the id of the markers along with the position of their corners.

The position of the corners can be specified either in pixels (in a non-specific size) or in meters. The first is the typical case in which you generate the image of board and the print it. Since you do not know in advance the real size of the markers, their corners are specified in pixels, and then, the translation to meters can be made once you know the real size.

On the other hand, you may want to have the information of your boards in meters. The BoardConfiguration allows you to do so.

The point is in the mInfoType variable. It can be either PIX or METERS according to your needs.

Definition at line 69 of file aruco/include/aruco/board.h.

Member Enumeration Documentation

Enumerator
NONE 
PIX 
METERS 
NONE 
PIX 
METERS 

Definition at line 73 of file aruco/include/aruco/board.h.

Enumerator
NONE 
PIX 
METERS 
NONE 
PIX 
METERS 

Definition at line 73 of file old/aruco/include/aruco/board.h.

Constructor & Destructor Documentation

aruco::BoardConfiguration::BoardConfiguration ( )

Definition at line 39 of file aruco/src/aruco/board.cpp.

aruco::BoardConfiguration::BoardConfiguration ( const BoardConfiguration T)

Definition at line 47 of file aruco/src/aruco/board.cpp.

aruco::BoardConfiguration::BoardConfiguration ( )
aruco::BoardConfiguration::BoardConfiguration ( const BoardConfiguration T)

Member Function Documentation

void aruco::BoardConfiguration::getIdList ( std::vector< int > &  ids,
bool  append = true 
) const

Set in the list passed the set of the ids

Definition at line 372 of file aruco/src/aruco/board.cpp.

void aruco::BoardConfiguration::getIdList ( vector< int > &  ids,
bool  append = true 
) const

Set in the list passed the set of the ids

int aruco::BoardConfiguration::getIndexOfMarkerId ( int  id) const

Returns the index of the marker with id indicated, if is in the list

Definition at line 134 of file aruco/src/aruco/board.cpp.

int aruco::BoardConfiguration::getIndexOfMarkerId ( int  id) const

Returns the index of the marker with id indicated, if is in the list

const MarkerInfo& aruco::BoardConfiguration::getMarkerInfo ( int  id) const
throw (cv::Exception
)

Returns the Info of the marker with id specified. If not in the set, throws exception

const MarkerInfo & aruco::BoardConfiguration::getMarkerInfo ( int  id) const
throw (cv::Exception
)

Returns the Info of the marker with id specified. If not in the set, throws exception

Definition at line 144 of file aruco/src/aruco/board.cpp.

bool aruco::BoardConfiguration::isExpressedInMeters ( ) const
inline

Indicates if the corners are expressed in meters

Definition at line 95 of file aruco/include/aruco/board.h.

bool aruco::BoardConfiguration::isExpressedInMeters ( ) const
inline

Indicates if the corners are expressed in meters

Definition at line 95 of file old/aruco/include/aruco/board.h.

bool aruco::BoardConfiguration::isExpressedInPixels ( ) const
inline

Indicates if the corners are expressed in meters

Definition at line 100 of file aruco/include/aruco/board.h.

bool aruco::BoardConfiguration::isExpressedInPixels ( ) const
inline

Indicates if the corners are expressed in meters

Definition at line 100 of file old/aruco/include/aruco/board.h.

BoardConfiguration & aruco::BoardConfiguration::operator= ( const BoardConfiguration T)

Definition at line 57 of file aruco/src/aruco/board.cpp.

BoardConfiguration& aruco::BoardConfiguration::operator= ( const BoardConfiguration T)
void aruco::BoardConfiguration::readFromFile ( string  sfile)
throw (cv::Exception
)

Reads board info from a file

void aruco::BoardConfiguration::readFromFile ( string  sfile)
throw (cv::Exception
)

Reads board info from a file

Definition at line 97 of file aruco/src/aruco/board.cpp.

void aruco::BoardConfiguration::readFromFile ( cv::FileStorage &  fs)
throw (cv::Exception
)
private

Reads board info from a file

void aruco::BoardConfiguration::readFromFile ( cv::FileStorage &  fs)
throw (cv::Exception
)
private

Reads board info from a file

Definition at line 107 of file aruco/src/aruco/board.cpp.

void aruco::BoardConfiguration::saveToFile ( string  sfile)
throw (cv::Exception
)

Saves the board info to a file

Definition at line 67 of file aruco/src/aruco/board.cpp.

void aruco::BoardConfiguration::saveToFile ( string  sfile)
throw (cv::Exception
)

Saves the board info to a file

void aruco::BoardConfiguration::saveToFile ( cv::FileStorage &  fs)
throw (cv::Exception
)
private

Saves the board info to a file

void aruco::BoardConfiguration::saveToFile ( cv::FileStorage &  fs)
throw (cv::Exception
)
private

Saves the board info to a file

Definition at line 76 of file aruco/src/aruco/board.cpp.

Friends And Related Function Documentation

Board
friend

Definition at line 71 of file aruco/include/aruco/board.h.

Member Data Documentation

int aruco::BoardConfiguration::mInfoType

Definition at line 75 of file aruco/include/aruco/board.h.


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


lidar_camera_calibration
Author(s):
autogenerated on Sat Feb 6 2021 03:39:37