 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/US/SweepMotion.h>
Analyse and edit motion of a freehand ultrasound sweep. More...
Inheritance diagram for SweepMotion:Analyse and edit motion of a freehand ultrasound sweep.
Public Member Functions | |
| SweepMotion (UltrasoundSweep &us) | |
| Constructor with ultrasound sweep to manipulate. | |
| void | acceptMotionAndAddNew () |
| Accepts the current motion, stores it as permanent tracking sequence, and adds a new one. | |
| std::vector< std::string > | supportedModels () const |
| Returns list of supported motion trajectory models. | |
| void | setReplace (double trans, double rot) |
| Define how much of the original sweep motion to replace (0..1) | |
| void | setTopShift (bool flag) |
| If enabled, the motion is defined at the top of the ultrasound images (on by default) | |
| void | setAddMotion (bool flag) |
| Set whether the motion model should be added to the existing motion. | |
| void | setSweepMotion (double shift, double rotate, bool symmetric) |
| Define a sweeping motion to replace the original motion with. | |
| void | setRigidMotion (bool symmetric) |
| Interpolate the rigid motion between first and last frames. | |
| void | setParametricMotionModel (int numPoints, bool optimize) |
| Use a parametric motion model with given number of inner control points. | |
| void | setPiecewiseModel (int slabsize) |
| Use a piecewise approach to consecutively add new control points. | |
| void | setEveryFrameModel (EveryFrameModel::CoordinateMode mode, int averagingWindow=1) |
Register every frame individually to volume Parameter averagingWindow specifies the smoothing of the trajectory (only relevant for CoordinateMode Trajectory) | |
| void | setMotionModel (std::shared_ptr< MotionTrajectoryModel > model) |
| Set a custom motion trajectory model instance. | |
| bool | addNewPiece (const Selection &totalSelection, int newPieceSize) |
Adds another piece if in piece-wise mode, and not beyond the bounds of totalSelection. | |
| void | clearPiecewiseModelControlPoints () |
| Clears all obtained control points. | |
| void | setOtherMotion (int stream) |
| Use motion from another tracking sequence. | |
| void | setUseTracking (int which, bool firstForError) |
| Specify which tracking sequence to use as reference. | |
| void | setErrorParameter (int val) |
| Set a pose parameter to compute error values from. | |
| void | registerFocus () |
| Register all tracking sequences at the focus frame. | |
| void | setParameters (const std::vector< double > &pars) |
| Set and apply the parameters of the trajectory. | |
| void | parameters (std::vector< double > &parsOut) const |
| Retrieve the current trajectory parameters. | |
| int | mode () const |
| Return the current parameterization mode. | |
| int | referenceTrackingUsed () const |
| Return which tracking sequence to use as reference. | |
| double | replace () const |
| Return the replace parameter. | |
| bool | topShift () const |
| Return the top shift flag. | |
| bool | addMotion () const |
| Return the add flag. | |
| double | maxError () const |
| Return the maximum occurring error in the sweep center in mm. | |
| double | meanError () const |
| Return the average error in the sweep center in mm. | |
| bool | hasError () const |
| Return whether error values are available. | |
| const std::vector< double > & | error () const |
| Return the vector of error values. | |
| UltrasoundSweep & | sweep () const |
| Access to the ultrasound sweep. | |
| bool | gatingMode () const |
| Return if gating mode is active. | |
| int | numberOfParameters () const |
| Return the number of parameters needed for optimization. | |
| std::shared_ptr< MotionTrajectoryModel > | motionModel () |
| Returns the currently used motion model. | |
| 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 | 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 Member Functions inherited from SignalReceiver | |
| SignalReceiver ()=default | |
| Default constructor. | |
| SignalReceiver (const SignalReceiver &other) | |
| Copy constructor, does not copy any existing signal connections from other. | |
| SignalReceiver & | operator= (SignalReceiver rhs) |
| Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs. | |
| virtual | ~SignalReceiver () |
| Virtual destructor disconnects from all connected signals. | |
Algorithm interface methods | |
| void | compute () override |
| Execute the algorithm. | |
| static bool | createCompatible (const DataList &data, Algorithm **a=0) |
Configurable interface methods | |
| void | configure (const Properties *p) override |
| Configure this object instance by de-serializing the given Properties. | |
| void | configuration (Properties *p) const override |
| Serialize the current object configuration into the given Properties object. | |
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... | |
| 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. | |
| 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 Member Functions inherited from SignalReceiver | |
| void | disconnectAll () |
| Disconnects all existing connections. | |
| 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. | |
| bool addNewPiece | ( | const Selection & | totalSelection, |
| int | newPieceSize ) |
Adds another piece if in piece-wise mode, and not beyond the bounds of totalSelection.
newPieceSize is signed. Returns true if new piece could be added.
| void setUseTracking | ( | int | which, |
| bool | firstForError ) |
Specify which tracking sequence to use as reference.
If the second flag is set true, the error is always evaluated with respect to the first tracking sequence, regardless of the chosen one.
|
overridevirtual |
Execute the algorithm.
Implements Algorithm.
|
overridevirtual |
Configure this object instance by de-serializing the given Properties.
The default implementation will do so automatically for all registered Parameter and SubProperty instances.
Reimplemented from Configurable.
|
overridevirtual |
Serialize the current object configuration into the given Properties object.
The default implementation will do so automatically for all registered Parameter and SubProperty instances.
Reimplemented from Configurable.
