 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/Reg/PolyRigidDeformationAlgorithm.h>
Set up a poly-rigid deformation on a volume and multiple labels. More...
Inheritance diagram for PolyRigidDeformationAlgorithm:Set up a poly-rigid deformation on a volume and multiple labels.
A volume of arbitrary modality can be used, the label map can have a single or multiple images. If it has a single image, it is split into a multi-volume with smaller cropped label maps. A distance volume is computed from each individual label, which is used to define the rigid region. A poly-rigid deformation is defined on the image using the aforementioned scheme and as many control points as individual label values. As long as this algorithm is open, the matrices of the label map are linked to the control points of the actual deformation instance. If two label maps are provided, the first label map is registered to the second label map and this is used to set the initial parameters of the polyrigid deformation.
Public Member Functions | |
| PolyRigidDeformationAlgorithm (SharedImageSet &image, SharedImageSet &label, SharedImageSet *imageLabel=nullptr) | |
| Constructor with a single volume, as well as a label map with one or multiple volumes The (optional) label map imageLabel is used to calculate initial transformations of rigid sections. | |
| void | transformationChanged (const Data *data) |
| Update the deformation if label map transformations have changed. | |
| void | configure (const Properties *p) override |
| Configure this object instance by de-serializing the given Properties. | |
| Public Member Functions inherited from Algorithm | |
| Algorithm () | |
| Default constructor will registers a single "compute" action that calls compute() and returns status(). | |
| 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 | 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 |
| 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. | |
Public Attributes | |
| Parameter< bool > | p_sphereMode = {"sphereMode", false, this} |
| Use sphere approximation instead of distance volumes to crudely approximate the inverse displacement. | |
| Parameter< GlPolyRigidDeformation::Mode > | p_mode = {"mode", GlPolyRigidDeformation::Mode::BACKWARD, this} |
| Parameter< int > | p_inversionSteps = {"inversionSteps", 50, this} |
| 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. | |
Methods implementing the Algorithm interface | |
| void | compute () override |
| Process the input label map, and setup control points and deformation instance. | |
| OwningDataList | takeOutput () override |
| If a single label volume with multiple values was provided, a split multi-volume is output here. | |
| static bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
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. | |
| 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. | |
Factory method to create the algorithm
|
overridevirtual |
Process the input label map, and setup control points and deformation instance.
Implements Algorithm.
|
overridevirtual |
If a single label volume with multiple values was provided, a split multi-volume is output here.
Reimplemented from 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.
| Parameter<bool> p_sphereMode = {"sphereMode", false, this} |
Use sphere approximation instead of distance volumes to crudely approximate the inverse displacement.
The results of using the sphere mode should not be expected to be accurate.
