ImFusion C++ SDK 4.4.0
ImFusion::MarkerConfiguration Class Reference

#include <ImFusion/Vision/MarkerConfiguration.h>

Describes the configuration of a marker calibration target. More...

Inheritance diagram for ImFusion::MarkerConfiguration:

Detailed Description

Describes the configuration of a marker calibration target.

Classes

struct  DetectorParameters
 Detector parameters for Aruco markers, boards and Charuco boards. More...
struct  CircleBoardDetectorParameters
 Detector parameters for Circle Board markers. More...
struct  ArucoMarkerInfo
 Information about a single Aruco marker. More...
struct  ArucoBoardInfo
 Information about a board of Aruco markers. More...
struct  CharucoBoardInfo
 Information about a Charuco board. More...
struct  ChessboardInfo
 Information about a chessboard. More...
struct  CircleBoardInfo
 Information about a circle board. More...
struct  AprilTagInfo
 Information about a single AprilTag. More...
struct  AprilTagBoardInfo
 Information about a board of AprilTags. More...
struct  STagInfo
 Information about a single STag. More...

Public Types

enum  MarkerType {
  ArucoMarker , CharucoBoard , Chessboard , ArucoBoard ,
  CircleBoard , AprilTag , AprilTagBoard , STag
}
enum class  AprilTagFamily {
  Tag16h5 = 0 , Tag25h9 , Tag36h10 , Tag36h11 ,
  TagCircle21h7 , TagCircle49h12 , TagCustom48h12 , TagStandard41h12 ,
  TagStandard52h13
}
 AprilTag families.

Public Member Functions

bool valid (std::string *error=nullptr) const
void setMarkerType (MarkerType type)
 Set Marker type.
MarkerType markerType () const
 Get Marker type.
void setChessboardParameters (const ChessboardInfo &params)
 Set Chesssboard parameters.
ChessboardInfo chessboardParameters () const
 Get Chesssboard parameters.
void setCharucoBoardParameters (const CharucoBoardInfo &params)
 Set Charuco parameters.
CharucoBoardInfo CharucoBoardParameters () const
 Get Charuco parameters.
void addArucoMarker (const ArucoMarkerInfo &params)
 Add Aruco marker with specified parameters.
void setArucoMarker (const ArucoMarkerInfo &params)
 Set Aruco marker with specified parameters (erases all previous Aruco markers).
std::vector< ArucoMarkerInfoArucoMarkers () const
 Get Aruco markers.
void setArucoBoardParameters (const ArucoBoardInfo &params)
 Set Aruco parameters.
ArucoBoardInfo ArucoBoardParameters () const
 Get Aruco parameters.
void setCircleBoardParameters (const CircleBoardInfo &params)
 Set Circle Board parameters.
CircleBoardInfo circleBoardParameters () const
 Get Circle Board parameters.
void addAprilTag (const AprilTagInfo &params)
 Add AprilTag with specified parameters.
void setAprilTag (const AprilTagInfo &params)
 Set AprilTag with specified parameters (erases all previous AprilTags).
std::vector< AprilTagInfoAprilTags () const
 Get AprilTags.
void setAprilTagBoardParameters (const AprilTagBoardInfo &params)
 Set AprilTag Board parameters.
AprilTagBoardInfo AprilTagBoardParameters () const
 Get AprilTag Board parameters.
void addSTag (const STagInfo &params)
 Add STag with specified parameters.
void setSTag (const STagInfo &params)
 Set STag with specified parameters (erases all previous STags).
std::vector< STagInfoSTags () const
 Get STags.
std::vector< vec3 > markerPoints () const
void clear (bool switchToChessboard=true)
 Clears the configuration and sets it to default.
void configure (const Properties *p) override
 Load configuration from properties.
void configuration (Properties *p) const override
 Store configuration to properties.
void configure (const Properties *p, DetectorParameters &params)
 Load detector parameters from properties.
void configuration (Properties *p, const DetectorParameters &params) const
 Store detector parameters to properties.
void configure (const Properties *p, CircleBoardDetectorParameters &params)
 Load detector parameters from properties.
void configuration (Properties *p, const CircleBoardDetectorParameters &params) const
 Store detector parameters to properties.
Public Member Functions inherited from ImFusion::Configurable
virtual void configureDefaults ()
 Retrieve the properties of this object, replaces values with their defaults and sets it again.
void registerParameter (ParameterBase *param)
 Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void unregisterParameter (const ParameterBase *param)
 Remove the given Parameter or SubProperty from the list of registered parameters.
 Configurable (const Configurable &rhs)
 Configurable (Configurable &&rhs) noexcept
Configurable & operator= (const Configurable &)
Configurable & operator= (Configurable &&) noexcept

Public Attributes

Signal< MarkerConfiguration::MarkerType > signalMarkerTypeChanged
 Signal emitted when the board type changes.
Signal signalMarkerConfigurationChanged
 Signal emitted when marker configuration changes (not the marker type - for the marker type use signalMarkerTypeChanged).
Public Attributes inherited from ImFusion::Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members

Protected Attributes inherited from ImFusion::Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.

Member Function Documentation

◆ configure()

void ImFusion::MarkerConfiguration::configure ( const Properties * p)
overridevirtual

Load configuration from properties.

Reimplemented from ImFusion::Configurable.

◆ configuration()

void ImFusion::MarkerConfiguration::configuration ( Properties * p) const
overridevirtual

Store configuration to properties.

Reimplemented from ImFusion::Configurable.


The documentation for this class was generated from the following file:
  • ImFusion/Vision/MarkerConfiguration.h
Search Tab / S to search, Esc to close