 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/Navigation/TrackingToolCalibrationWizardAlgorithm.h>
Algorithm for stepwise pointer calibration of a TrackingInstrument. More...
Inheritance diagram for TrackingToolCalibrationWizardAlgorithm:Algorithm for stepwise pointer calibration of a TrackingInstrument.
Classes | |
| struct | CalibrationData |
| Internal struct to hold the current state of the calibration. More... | |
Public Member Functions | |
| TrackingToolCalibrationWizardAlgorithm (TrackingStream *stream) | |
| void | compute () override |
| Execute the ToolCalibrationAlgorithm with the current CalibrationData and apply instrument calibration to input TrackingStream. | |
| void | startRecording () |
Starts a recording of the selected instrument specified by setInstrument if not recording already. | |
| std::unique_ptr< TrackingSequence > | stopRecording () |
Stops the recording of the selected instrument specified by setInstrument and returns the recorded TrackingSequence. | |
| bool | isRecording () const |
| Returns whether the recording is currenlty in progress. | |
| TrackingStream * | trackingStream () |
| Returns the input TrackingStream. | |
| bool | setInstrument (std::string instrumentId) |
| Sets the selected instrument for calibration. | |
| std::string | instrument () const |
| Returns the selected instrument for calibration. | |
| bool | setPivoting (std::unique_ptr< TrackingSequence > ts) |
| Sets the TrackingSequence from the pivoting movement around the needle tip. | |
| bool | setRotation (std::unique_ptr< TrackingSequence > ts) |
| Sets the TrackingSequence from the rotation movement around the needle direction. | |
| void | setFlip (bool flip) |
| Sets the flip flag to rotate the needle direction by 180° degrees. | |
| void | accept () |
| Accepts the calibration and clears the initial calibration. The calibration matrix cannot be reset to the initial calibration after calling accept. | |
| void | reset () |
| Clears current calibration data and resets the calibration to the initial calibration. | |
| std::optional< vec3 > | upAxisWorld () |
| Returns an estimation of upwards direction (if already computed). | |
| std::optional< vec3 > | origin () |
| Returns coordinates of pointer tip during pivoting in world coordinates (if already computed). | |
| CalibrationData & | calibrationData () |
| Returns the CalibrationData. | |
| Public Member Functions inherited from Algorithm | |
| Algorithm () | |
| Default constructor will registers a single "compute" action that calls compute() and returns status(). | |
| virtual OwningDataList | takeOutput () |
| Return any new Data that was created by the Algorithm during the last call to compute(). | |
| virtual void | setProgress (Progress *progress) |
| Sets a Progress interface the algorithm can use to notify observers about its computing progress. | |
| Progress * | progress () const |
| Returns the progress interface if set. | |
| virtual int | status () const |
| Indicates the status of the last call to compute(). | |
| virtual bool | survivesDataDeletion (const Data *) const |
| Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list. | |
| const FactoryInfo & | factoryInfo () const |
| Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| void | setFactoryInfo (const FactoryInfo &value) |
| Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| Status | runAction (const std::string &id) |
Run the action with name id if it exists. | |
| const std::vector< Action > & | actions () |
| Get a mapping from Action id to Action as registered in this algorithm. | |
| Public Member Functions inherited from Configurable | |
| virtual void | configure (const Properties *p) |
| Configure this object instance by de-serializing the given Properties. | |
| virtual void | configuration (Properties *p) const |
| Serialize the current object configuration into the given Properties object. | |
| 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 |
Static Public Member Functions | |
| static bool | createCompatible (const DataList &data, Algorithm **a=0) |
| Factory method to check for applicability or to create the algorithm. | |
| Static Public Member Functions inherited from Algorithm | |
| static bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| Factory function to check algorithm compatibility with input data and optionally instantiate it. | |
Additional Inherited Members | |
| Public Types inherited from Algorithm | |
| enum | Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 } |
| Status codes. More... | |
| Public Attributes inherited from Algorithm | |
| Signal | signalOutputChanged |
| Signal should be emitted by Algorithms when their output/result has changed. | |
| Signal | signalParametersChanged |
| Signal should be emitted by Algorithms when their parameter configuration has changed. | |
| Public Attributes inherited from Configurable | |
| Signal | signalParametersChanged |
Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
| Protected Member Functions inherited from Algorithm | |
| void | loadDefaults () |
| void | registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action) |
| Register an action to be run via runAction. | |
| template<typename D> | |
| void | registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void)) |
| Template version of runAction that can be used with a pointer to a member function. | |
| void | registerAction (const Action &action) |
| Register an action. | |
| Protected Attributes inherited from Algorithm | |
| std::string | m_name |
| Algorithm name. | |
| Progress * | m_progress = nullptr |
| Non-owing pointer to a progress interface. May be a nullptr. | |
| FactoryInfo | m_factoryInfo = {} |
| Record describing how this algorithm was instantiated by the AlgorithmFactory. | |
| int | m_status = Status::Unknown |
| Algorithm status after last call to compute() | |
| std::vector< Action > | m_actions |
| Map of key given by the id of the action, of the available actions of this algorithm. | |
| Protected Attributes inherited from Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
|
overridevirtual |
Execute the ToolCalibrationAlgorithm with the current CalibrationData and apply instrument calibration to input TrackingStream.
Implements Algorithm.
| std::unique_ptr< TrackingSequence > stopRecording | ( | ) |
Stops the recording of the selected instrument specified by setInstrument and returns the recorded TrackingSequence.
Returns nullptr if recording was not started or failed.
