Image Component Library (ICL)
Public Member Functions | Private Attributes | List of all members
icl::markers::AdvancedMarkerGridDetector::AdvancedGridDefinition Class Reference

#include <AdvancedMarkerGridDetector.h>

Inheritance diagram for icl::markers::AdvancedMarkerGridDetector::AdvancedGridDefinition:
icl::markers::MarkerGridDetector::GridDefinition

Public Member Functions

 AdvancedGridDefinition ()
 
 AdvancedGridDefinition (const utils::Size &numCells, const utils::Size32f &markerBounds, const utils::Size32f &gridBounds, const std::vector< int > &markerIDs=std::vector< int >(), const std::string &markerType="bch")
 constructor with given parameters More...
 
const utils::Size32fgetMarkerBounds () const
 returns internal marker-bounds value More...
 
const utils::Size32fgetGridBounds () const
 returns internal grid-bounds value More...
 
utils::Rect32f getBounds (int x, int y) const
 computes the bounds of the given cell More...
 
- Public Member Functions inherited from icl::markers::MarkerGridDetector::GridDefinition
 GridDefinition ()
 
 GridDefinition (const utils::Size &numCells, const std::vector< int > &markerIDs=std::vector< int >(), const std::string &markerType="bch")
 constructor with given parameters More...
 
utils::Point getPos (int id) const
 returns the grid x/y index for a given marker ID More...
 
int getIndex (int id) const
 returns linear grid position (row-major order!) More...
 
int getWidth () const
 returns the number of grid x-cells More...
 
int getHeight () const
 returns the number of grid y-cells More...
 
int getDim () const
 returns the number of grid cells (WxH) More...
 
const utils::SizegetSize () const
 returns the grid dimension in cells More...
 
const std::string & getMarkerType () const
 returns the marker type (bch is most common!) More...
 
const std::vector< int > & getMarkerIDs () const
 returns the internal list of marker IDs More...
 

Private Attributes

utils::Size32f markerBounds
 size of a single marker in mm More...
 
utils::Size32f gridBounds
 size of the whole grid More...
 

Constructor & Destructor Documentation

◆ AdvancedGridDefinition() [1/2]

icl::markers::AdvancedMarkerGridDetector::AdvancedGridDefinition::AdvancedGridDefinition ( )
inline

◆ AdvancedGridDefinition() [2/2]

icl::markers::AdvancedMarkerGridDetector::AdvancedGridDefinition::AdvancedGridDefinition ( const utils::Size numCells,
const utils::Size32f markerBounds,
const utils::Size32f gridBounds,
const std::vector< int > &  markerIDs = std::vector< int >(),
const std::string &  markerType = "bch" 
)

constructor with given parameters

Member Function Documentation

◆ getBounds()

utils::Rect32f icl::markers::AdvancedMarkerGridDetector::AdvancedGridDefinition::getBounds ( int  x,
int  y 
) const

computes the bounds of the given cell

◆ getGridBounds()

const utils::Size32f& icl::markers::AdvancedMarkerGridDetector::AdvancedGridDefinition::getGridBounds ( ) const
inline

returns internal grid-bounds value

◆ getMarkerBounds()

const utils::Size32f& icl::markers::AdvancedMarkerGridDetector::AdvancedGridDefinition::getMarkerBounds ( ) const
inline

returns internal marker-bounds value

Member Data Documentation

◆ gridBounds

utils::Size32f icl::markers::AdvancedMarkerGridDetector::AdvancedGridDefinition::gridBounds
private

size of the whole grid

The size is measured from the left-edge of the left-most marker to the right-edge of the right-most marker and vertically analogously

◆ markerBounds

utils::Size32f icl::markers::AdvancedMarkerGridDetector::AdvancedGridDefinition::markerBounds
private

size of a single marker in mm


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