ImFusion SDK 4.3
DescriptorsRegistrationAlgorithm Class Reference

#include <ImFusion/Reg/DescriptorsRegistrationAlgorithm.h>

Class for performing image registration using local feature descriptors. More...

+ Inheritance diagram for DescriptorsRegistrationAlgorithm:

Detailed Description

Class for performing image registration using local feature descriptors.

This algorithm performs the following steps: 1) Preprocess the fixed and moving images to prepare them for feature extraction. This consists of resampling to p_spacing and baking-in the rotation. 2) Extract feature descriptors using either DISAFeaturesAlgorithm or MINDDescriptorAlgorithm depending on p_descriptorType 3) Computes the weight for the moving image features according to p_weightType. See WeightType. 4) Instantiates and uses FeatureMapsRegistrationAlgorithm to register the feature descriptors images. The computed registration is then applied to the moving image.

Classes

struct  GlobalRegistrationConfig
 

Public Types

enum class  DescriptorType { DISA , MIND }
 
enum class  WeightType { None , ImageVariance , FeatureImportance }
 
enum class  Transformation { Rigid = 0 , Affine = 1 }
 
- 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 Member Functions

 DescriptorsRegistrationAlgorithm (SharedImageSet &fixed, SharedImageSet &moving, SharedImageSet *movingWeight=nullptr)
 Constructor for DescriptorsRegistrationAlgorithm.
 
void compute () override
 Computes the feature descriptors and instantiates the feature registration algorithm.
 
void initializePose ()
 Centers the pose of the moving image wrt the fixed image.
 
void localRegistration ()
 High level method that performs local registration. Make use of registrationAlgorithm() to get low level controls on the registration.
 
void globalRegistration ()
 High level method that performs global registration. Make use of registrationAlgorithm() to get low level controls on the registration.
 
bool setMovingVolume (SharedImageSet &moving, SharedImageSet *movingWeight=nullptr)
 Set a different moving volume and recomputes its feature descriptors.
 
OwningDataList takeDescriptors ()
 
std::unique_ptr< ImageRegistrationimageRegistration (bool swapMoving=false)
 
SharedImageSetmoving ()
 The moving unprocessed moving image.
 
SharedImageSetfixed ()
 The moving unprocessed fixed image.
 
SharedImageSetweight () const
 The weight assigned to the moving image.
 
std::shared_ptr< FeatureMapsRegistrationAlgorithmregistrationAlgorithm ()
 Returns a shared pointer to the algorithm used for feature maps registration.
 
SharedImageSetprocessedMoving () const
 Returns the processed (rotation baked-in, resampled, normalized) moving image.
 
SharedImageSetprocessedFixed () const
 Returns the processed (rotation baked-in, resampled, normalized) fixed image.
 
const SharedImageSetfeaturesMoving () const
 Returns a pointer to the feature descriptors extracted from the moving image.
 
const SharedImageSetfeaturesFixed () const
 Returns a pointer to the feature descriptors extracted from the fixed image.
 
std::unique_ptr< SharedImageSetheatmap (const vec3 &pointWorld)
 Heatmap describing how similar the point pointWorld on the moving image is to every point on the fixed image.
 
Algorithmdisa ()
 Algorithm used to compute DISA features.
 
void setModelPaths (std::string fixedVolumeModelPath, std::string movingVolumeModelPath="")
 Sets custom ML models for extracting descriptors.
 
PoseHistoryposeHistory ()
 
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.
 
- 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.
 
Progressprogress () 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 FactoryInfofactoryInfo () 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
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (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.
 
SignalReceiveroperator= (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.
 

Static Public Member Functions

static bool createCompatible (const DataList &data, Algorithm **a=nullptr)
 
static double recommendedSpacing (SharedImageSet &fixed, SharedImageSet &moving)
 
- 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

Parameter< double > p_spacing = {"spacing", 1.0, this}
 
Parameter< DescriptorTypep_descriptorType = {"descriptorType", DescriptorType::DISA, this}
 
Parameter< Transformation > p_transformation = {"transformation", Transformation::Rigid, this}
 
Parameter< WeightType > p_weightType = {"weightType", WeightType::ImageVariance, this}
 
Parameter< bool > p_customWeightPremultiplied = {"customWeightPremultiplied", true, this}
 Whether the custom weight is pre-multiplied by the variance of the moving image.
 
SubProperty< GlobalRegistrationConfigp_globalRegistration = {"globalRegistration", GlobalRegistrationConfig(), 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.
 

Protected Member Functions

void setSimplifiedMode (bool simplified)
 
- 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.
 

Additional Inherited Members

- Protected Attributes inherited from Algorithm
std::string m_name
 Algorithm name.
 
Progressm_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< Actionm_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< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

Member Enumeration Documentation

◆ DescriptorType

enum class DescriptorType
strong
Enumerator
DISA 

DISA (DIfferentiable Similarity Approximation)

MIND 

MIND (Modality Independent Neighbourhood Descriptor)

Constructor & Destructor Documentation

◆ DescriptorsRegistrationAlgorithm()

DescriptorsRegistrationAlgorithm ( SharedImageSet & fixed,
SharedImageSet & moving,
SharedImageSet * movingWeight = nullptr )

Constructor for DescriptorsRegistrationAlgorithm.

Parameters
fixedThe fixed image
movingThe moving image
movingWeight(Optional) The weight for the moving image, defining the importance of local descriptors at every voxel.

Member Function Documentation

◆ compute()

void compute ( )
overridevirtual

Computes the feature descriptors and instantiates the feature registration algorithm.

Warning
This doesn't compute the registration, use localRegistration() or globalRegistration() to do the registration

Implements Algorithm.

◆ setMovingVolume()

bool setMovingVolume ( SharedImageSet & moving,
SharedImageSet * movingWeight = nullptr )

Set a different moving volume and recomputes its feature descriptors.

Parameters
movingThe new moving image.
movingWeight(Optional) The weight for the new moving image.
Returns
True if successful, false otherwise.

◆ heatmap()

std::unique_ptr< SharedImageSet > heatmap ( const vec3 & pointWorld)

Heatmap describing how similar the point pointWorld on the moving image is to every point on the fixed image.

Parameters
pointWorldThe world coordinates of the point on the moving image.
Returns
Heatmap image having same size (in mm) and pose as the fixed image. The dimensions in voxel matches the dimension of the feature descriptor volume.

◆ configure()

void configure ( const Properties * p)
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.

See also
configuration() for the inverse functionality

Reimplemented from Configurable.

◆ configuration()

void configuration ( Properties * p) const
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.

See also
configure() for the inverse functionality

Reimplemented from Configurable.


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