Stores the result returned by a detectMarkers(const Frame &frame, const std::vector<int> &markerIds, const MarkerDictionary &markerDictionary) call. More...

#include <Zivid/Calibration/DetectionResultFiducialMarkers.h>

Public Member Functions
ZIVID_CORE_EXPORT bool	valid () const
	Test if the detection result is valid.

ZIVID_CORE_EXPORT	operator bool () const
	Test if the detection result is valid.

ZIVID_CORE_EXPORT const std::vector< MarkerShape > &	detectedMarkers () const
	Get the ids of the detected fiducial markers.

ZIVID_CORE_EXPORT const std::vector< int > &	allowedMarkerIds () const
	Fetch the allowed marker ids this detection result was made with.

ZIVID_CORE_EXPORT std::string	toString () const
	Get string representation of the detection result.

Detailed Description

Stores the result returned by a detectMarkers(const Frame &frame, const std::vector<int> &markerIds, const MarkerDictionary &markerDictionary) call.

Member Function Documentation

◆ allowedMarkerIds()

ZIVID_CORE_EXPORT const std::vector< int > & Zivid::Calibration::DetectionResultFiducialMarkers::allowedMarkerIds ( ) const

Fetch the allowed marker ids this detection result was made with.

Returns: Allowed marker ids this detection result was made with.

◆ detectedMarkers()

ZIVID_CORE_EXPORT const std::vector< MarkerShape > & Zivid::Calibration::DetectionResultFiducialMarkers::detectedMarkers ( ) const

Get the ids of the detected fiducial markers.

Only markers belonging to the dictionary that was used at detection are reported. Furthermore markers are filtered to only include the ones with allowed ids, specified at detection. Markers can be detected multiple times if they are present on the scene multiple times. Note that even though the detection result is valid, other functions such as hand eye calibration might fail because of duplicates.

Returns: An array of marker shapes describing the geometry of each detected marker.

◆ operator bool()

ZIVID_CORE_EXPORT Zivid::Calibration::DetectionResultFiducialMarkers::operator bool ( ) const

explicit

Test if the detection result is valid.

The detection result is valid if at least one of the specified markers were detected.

Returns: True if the detection result is valid.

◆ toString()

ZIVID_CORE_EXPORT std::string Zivid::Calibration::DetectionResultFiducialMarkers::toString ( ) const

Get string representation of the detection result.

Returns: The detection result as string

◆ valid()

ZIVID_CORE_EXPORT bool Zivid::Calibration::DetectionResultFiducialMarkers::valid ( ) const