ImFusion SDK 4.3
SweepCalibrationData Class Reference

#include <ImFusion/US/SweepCalibrationData.h>

This class maintains a database of calibration matrices between the image FrameGeometry offset and the (possibly multiple) TrackingInstrument frames. More...

+ Inheritance diagram for SweepCalibrationData:

Detailed Description

This class maintains a database of calibration matrices between the image FrameGeometry offset and the (possibly multiple) TrackingInstrument frames.

Each calibration is identified by a ProbeTrackerPair.

See also
SweepCalibrator, SweepCalibrationDataIO

Public Member Functions

bool operator== (SweepCalibrationData const &other) const
 
void append (SweepCalibrationData &data)
 Appends the calibrations from another sweep calibration data.
 
void addTipOfProbeCalibration (mat4 mat, const ProbeTrackerPair &name)
 Add a calibration matrix expressed w.r.t.
 
std::optional< mat4 > tipOfProbeCalibration (const ProbeTrackerPair &name) const
 Returns, if available for the given probe name, a calibration matrix expressed w.r.t.
 
void removeCalibrationData (const ProbeTrackerPair &name)
 Remove an existing calibration.
 
void renameCalibrationData (const ProbeTrackerPair &oldName, const ProbeTrackerPair &newName)
 Rename an existing calibration.
 
std::vector< ProbeTrackerPairknownProbeTrackerPairs ()
 Returns list of known probe names.
 
int calibrationDataCount (const ProbeTrackerPair &name) const
 Returns number of known calibration data.
 
void configure (const Properties *p)
 Set the calibration data from Properties.
 
void configuration (Properties *p) const
 Retrieve the calibration data.
 
- Public Member Functions inherited from 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
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 

Public Attributes

Signal signalCalibrationDataChanged
 Emitted when the calibration data has changed.
 
- Public Attributes inherited from Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
 

Additional Inherited Members

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

Member Function Documentation

◆ addTipOfProbeCalibration()

void addTipOfProbeCalibration ( mat4 mat,
const ProbeTrackerPair & name )

Add a calibration matrix expressed w.r.t.

the tip of the US probe (i.e. NOT the image center). An already existing matrix is replaced.

◆ tipOfProbeCalibration()

std::optional< mat4 > tipOfProbeCalibration ( const ProbeTrackerPair & name) const

Returns, if available for the given probe name, a calibration matrix expressed w.r.t.

the tip of the US probe (i.e. NOT the image center).

◆ configure()

void configure ( const Properties * p)
virtual

Set the calibration data from Properties.

Reimplemented from Configurable.

◆ configuration()

void configuration ( Properties * p) const
virtual

Retrieve the calibration data.

Reimplemented from Configurable.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close