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

Utility class wrapping OpenCV's cvFindChessboardCorners. More...

#include <CheckerboardDetector.h>

Inheritance diagram for icl::cv::CheckerboardDetector:
icl::utils::Configurable icl::utils::Uncopyable

Classes

struct  Checkerboard
 Internally used and returned result structure. More...
 

Public Member Functions

 CheckerboardDetector ()
 Default constructor (creates a null instance) More...
 
 CheckerboardDetector (const utils::Size &size)
 Constructor with given checkerboard size. More...
 
 ~CheckerboardDetector ()
 Destructor. More...
 
void init (const utils::Size &size)
 for deferred initialization More...
 
bool isNull () const
 returns whether this instance has been initilialized yet More...
 
const Checkerboarddetect (const core::Img8u &image)
 detects the defined checkerboard in the given image More...
 
const Checkerboarddetect (const core::ImgBase *image)
 convenience method that automatically scales the source images range to 0,255 if it is not already of type Img8u 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

void init_properties ()
 intializes configurable properties internally More...
 

Private Attributes

Data * m_data
 internal data data More...
 

Additional Inherited Members

- Public Types inherited from icl::utils::Configurable
typedef Function< void, const Property & > Callback
 Function type for changed properties. More...
 
- 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 Member Functions inherited from icl::utils::Uncopyable
 Uncopyable ()
 Empty base constructor. More...
 
- Protected Attributes inherited from icl::utils::Configurable
std::vector< Callbackcallbacks
 internally managed list of callbacks More...
 

Detailed Description

Utility class wrapping OpenCV's cvFindChessboardCorners.

The CheckerboardDetector wrappes OpenCV's cvFindChessboardCorners and provides a flag to optionally optimize the detected corners using cvFindCornerSubPix

Constructor & Destructor Documentation

◆ CheckerboardDetector() [1/2]

icl::cv::CheckerboardDetector::CheckerboardDetector ( )

Default constructor (creates a null instance)

◆ CheckerboardDetector() [2/2]

icl::cv::CheckerboardDetector::CheckerboardDetector ( const utils::Size size)

Constructor with given checkerboard size.

Please note: the checkerboard size given relates to the inner checkerboard corners that are expected. So if the checkerboard has 5 by 5 fields, i.e. the first row is like BWBWB (Black/White), then you have to pass a size of 4x4

◆ ~CheckerboardDetector()

icl::cv::CheckerboardDetector::~CheckerboardDetector ( )

Destructor.

Member Function Documentation

◆ detect() [1/2]

const Checkerboard& icl::cv::CheckerboardDetector::detect ( const core::Img8u image)

detects the defined checkerboard in the given image

The image can have any format, but internally is is always converted to gray (if it is not of formatGray). If optSubPix was set in either the constructor or in init, the returned corners are automatically optimized using cvFindCornerSubPix

◆ detect() [2/2]

const Checkerboard& icl::cv::CheckerboardDetector::detect ( const core::ImgBase image)

convenience method that automatically scales the source images range to 0,255 if it is not already of type Img8u

◆ init()

void icl::cv::CheckerboardDetector::init ( const utils::Size size)

for deferred initialization

Please note: the checkerboard size given relates to the inner checkerboard corners that are expected. So if the checkerboard has 5 by 5 fields, i.e. the first row is like BWBWB (Black/White), then you have to pass a size of 4x4

◆ init_properties()

void icl::cv::CheckerboardDetector::init_properties ( )
private

intializes configurable properties internally

◆ isNull()

bool icl::cv::CheckerboardDetector::isNull ( ) const

returns whether this instance has been initilialized yet

Member Data Documentation

◆ m_data

Data* icl::cv::CheckerboardDetector::m_data
private

internal data data

internal data pointer


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