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

Utility class that allows a regular grid of fiducial markers to be tracked. More...

#include <MarkerGridDetector.h>

Inheritance diagram for icl::markers::MarkerGridDetector:
icl::utils::Configurable icl::markers::AdvancedMarkerGridDetector

Classes

class  GridDefinition
 Marker Grid geometry definition type. More...
 

Public Types

typedef utils::Array2D< FiducialResult
 result data type More...
 
- Public Types inherited from icl::utils::Configurable
typedef Function< void, const Property & > Callback
 Function type for changed properties. More...
 

Public Member Functions

 MarkerGridDetector ()
 Empty constructor (results in a null instance that must be initialized using init(..)". More...
 
 MarkerGridDetector (const GridDefinition &gridDef, const utils::ParamList &extraParams=utils::ParamList("size","1x1"))
 Well defined constructor. More...
 
 ~MarkerGridDetector ()
 Destructor. More...
 
void init (const GridDefinition &gridDef, const utils::ParamList &extraParams=utils::ParamList("size","1x1"))
 Initialization function (equivalent to the well defined constructor) More...
 
const GridDefinitiongetGridDefinition () const
 returns the internal grid definition More...
 
const Resultdetect (const core::ImgBase *image)
 actual detection function More...
 
bool isNull () const
 returns whether the instance has already been already initialized More...
 
FiducialDetectorgetFiducialDetector ()
 returns internal fiducial detector instance More...
 
- Public Member Functions inherited from icl::utils::Configurable
virtual ~Configurable ()
 virtual destructor More...
 
 Configurable (const Configurable &other)
 Copy constructor. More...
 
Configurableoperator= (const Configurable &other)
 Assignment operator. More...
 
void setConfigurableID (const std::string &ID)
 sets the ID of this configurable More...
 
const std::string & getConfigurableID () const
 returns the configurables static ID More...
 
bool isOrderedFlagSet () const
 returns whether the ordered flag is set More...
 
void deactivateProperty (const std::string &pattern)
 adds an additional deativation pattern More...
 
void deleteDeactivationPattern (const std::string &pattern)
 removed a formerly added deactivation pattern More...
 
std::vector< std::string > getPropertyListWithoutDeactivated () const
 this returns a filtered list of properties (using all filters added by deactivateProperty) More...
 
virtual void adaptProperty (const std::string &name, const std::string &newType, const std::string &newInfo, const std::string &newToolTip)
 this function can be used to adapt a specific property afterwards More...
 
void registerCallback (const Callback &cb)
 add a callback for changed properties More...
 
void removedCallback (const Callback &cb)
 removes a callback that was registered before More...
 
void syncChangesTo (Configurable *others, int num=1)
 this can be used to let this instance also apply property changes to others More...
 
virtual void setPropertyValue (const std::string &propertyName, const Any &value)
 sets a property value More...
 
virtual std::vector< std::string > getPropertyList () const
 returns a list of All properties, that can be set using setProperty More...
 
virtual bool supportsProperty (const std::string &propertyName) const
 base implementation for property check (seaches in the property list) More...
 
virtual void saveProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=EMPTY_VEC) const
 writes all available properties into a file More...
 
virtual void loadProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=EMPTY_VEC)
 reads a camera config file from disc More...
 
virtual std::string getPropertyType (const std::string &propertyName) const
 get type of property More...
 
virtual std::string getPropertyInfo (const std::string &propertyName) const
 get information of a properties valid values More...
 
virtual Any getPropertyValue (const std::string &propertyName) const
 returns the current value of a property or a parameter More...
 
virtual std::string getPropertyToolTip (const std::string &propertyName) const
 returns the tooltip description for a given property More...
 
virtual int getPropertyVolatileness (const std::string &propertyName) const
 Returns whether this property may be changed internally. More...
 

Private Member Functions

int getPos (int id)
 utility method More...
 

Private Attributes

Data * m_data
 internal data type More...
 

Additional Inherited Members

- Static Public Member Functions inherited from icl::utils::Configurable
static std::string create_default_ID (const std::string &prefix)
 this function can be used in subclasses to create a default ID More...
 
static Configurableget (const std::string &id)
 returns configurable by given ID More...
 
static void register_configurable_type (const std::string &classname, Function< Configurable * > creator)
 registers a configurable type More...
 
static std::vector< std::string > get_registered_configurables ()
 returns a list of all registered configurable classnames More...
 
static Configurablecreate_configurable (const std::string &classname)
 creates a configurable by given name More...
 
- Static Public Attributes inherited from icl::utils::Configurable
static const std::vector< std::string > EMPTY_VEC
 used as shortcut – just an empty vector of std::strings More...
 
- Protected Member Functions inherited from icl::utils::Configurable
void addProperty (const std::string &name, const std::string &type, const std::string &info, const Any &value=Any(), const int volatileness=0, const std::string &tooltip=std::string())
 This can be used by derived classes to store supported properties in the internal list. More...
 
void addChildConfigurable (Configurable *configurable, const std::string &childPrefix="")
 This adds another configurable as child. More...
 
void removeChildConfigurable (Configurable *configurable)
 removes the given child configurable More...
 
Propertyprop (const std::string &propertyName)
 this CAN be used e.g. to store a property value in internal property-list More...
 
const Propertyprop (const std::string &propertyName) const
 this CAN be used e.g. to store a property value in internal property-list More...
 
 Configurable (const std::string &ID="", bool ordered=true)
 create this configurable with given ID More...
 
void call_callbacks (const std::string &propertyName, const Configurable *caller) const
 calls all registered callbacks More...
 
- Protected Attributes inherited from icl::utils::Configurable
std::vector< Callbackcallbacks
 internally managed list of callbacks More...
 

Detailed Description

Utility class that allows a regular grid of fiducial markers to be tracked.

The MarkerGridDetector is initialized with a definition of a regular marker grid.

Member Typedef Documentation

◆ Result

result data type

Constructor & Destructor Documentation

◆ MarkerGridDetector() [1/2]

icl::markers::MarkerGridDetector::MarkerGridDetector ( )

Empty constructor (results in a null instance that must be initialized using init(..)".

◆ MarkerGridDetector() [2/2]

icl::markers::MarkerGridDetector::MarkerGridDetector ( const GridDefinition gridDef,
const utils::ParamList extraParams = utils::ParamList("size","1x1") 
)

Well defined constructor.

Equivalent to calling the empty constructor followed by calling init(...)

◆ ~MarkerGridDetector()

icl::markers::MarkerGridDetector::~MarkerGridDetector ( )

Destructor.

Member Function Documentation

◆ detect()

const Result& icl::markers::MarkerGridDetector::detect ( const core::ImgBase image)

actual detection function

◆ getFiducialDetector()

FiducialDetector* icl::markers::MarkerGridDetector::getFiducialDetector ( )

returns internal fiducial detector instance

◆ getGridDefinition()

const GridDefinition& icl::markers::MarkerGridDetector::getGridDefinition ( ) const

returns the internal grid definition

◆ getPos()

int icl::markers::MarkerGridDetector::getPos ( int  id)
private

utility method

◆ init()

void icl::markers::MarkerGridDetector::init ( const GridDefinition gridDef,
const utils::ParamList extraParams = utils::ParamList("size","1x1") 
)

Initialization function (equivalent to the well defined constructor)

Initializes the underlying marker grid with a numCells marker cells. If the marker ID vector is empty, the trival id set {0, ..., n-1} is used. If a non-zero number m of IDs is given, m must be eqaul to numCells.getDim(). The extraParams list is directly passed to the internal FiducialDetector instance

◆ isNull()

bool icl::markers::MarkerGridDetector::isNull ( ) const

returns whether the instance has already been already initialized

Member Data Documentation

◆ m_data

Data* icl::markers::MarkerGridDetector::m_data
private

internal data type

hidden data pointer


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