Zivid C++ API 2.13.1+18e79e79-1
Zivid::Experimental::Calibration::AccuracyEstimate Class Reference

A dimension accuracy estimate for a specific working volume. More...

#include <Zivid/Experimental/Calibration/InfieldCorrection.h>

Public Member Functions

ZIVID_CORE_EXPORT float dimensionAccuracy () const
 The estimated dimension accuracy error obtained if the correction is applied.
 
ZIVID_CORE_EXPORT float zMin () const
 The range of validity of the accuracy estimate (lower end)
 
ZIVID_CORE_EXPORT float zMax () const
 The range of validity of the accuracy estimate (upper end)
 
ZIVID_CORE_EXPORT std::string toString () const
 Get string representation of the accuracy estimate.
 

Detailed Description

A dimension accuracy estimate for a specific working volume.

Member Function Documentation

◆ dimensionAccuracy()

ZIVID_CORE_EXPORT float Zivid::Experimental::Calibration::AccuracyEstimate::dimensionAccuracy ( ) const

The estimated dimension accuracy error obtained if the correction is applied.

This number represents a 1-sigma (68% confidence) upper bound for dimension trueness error in the working volume (z=zMin() to z=zMax(), across the entire field of view). In other words, it represents the expected distribution of local dimension trueness measurements (see CameraVerification) that can be expected if measuring throughout the working volume.

The returned value is a fraction (relative trueness error). Multiply by 100 to get trueness in percent.

Note that the accuracy close to where the original data was captured is likely much better than what is implied by this number. This number is rather an accuracy estimate for the entire extrapolated working volume.

Returns
A 1-sigma (68% confidence) upper bound for trueness error in the working volume

◆ toString()

ZIVID_CORE_EXPORT std::string Zivid::Experimental::Calibration::AccuracyEstimate::toString ( ) const

Get string representation of the accuracy estimate.

Returns
Accuracy estimate as string

◆ zMax()

ZIVID_CORE_EXPORT float Zivid::Experimental::Calibration::AccuracyEstimate::zMax ( ) const

The range of validity of the accuracy estimate (upper end)

Returns
Maximum z-value of working volume in millimeters

◆ zMin()

ZIVID_CORE_EXPORT float Zivid::Experimental::Calibration::AccuracyEstimate::zMin ( ) const

The range of validity of the accuracy estimate (lower end)

Returns
Minimum z-value of working volume in millimeters

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