ImFusion SDK 4.3
SimilarityMeasureML Class Reference

#include <ImFusion/Reg/SimilarityMeasureML.h>

Machine Learning based similarity measure. More...

+ Inheritance diagram for SimilarityMeasureML:

Detailed Description

Machine Learning based similarity measure.

Public Member Functions

 SimilarityMeasureML (SharedImage *img1, SharedImage *img2)
 
void setPairingFunction (const std::function< bool(const SharedImage *drr, const SharedImage *fluoro, SharedImage *&imgOut)> &func)
 Set a function that computes the dual-channel single image containing fixed and moving image.
 
void setPredictionModelConfig (const std::string &filename)
 Set the filename of the prediction model configuration.
 
void configure (const Properties *p) override
 Set one or multiple properties.
 
void configuration (Properties *p) const override
 Retrieve the properties of this object.
 
double compute (const ImageTransformer *t, size_t *overlap=nullptr) override
 Computes and returns the similarity measure.
 
bool supportsWeights () const override
 Queries the capability whether this similarity measure supports pixel-wise weights.
 
- Public Member Functions inherited from SimilarityMeasureImpl
 SimilarityMeasureImpl (SharedImage *img1, SharedImage *img2)
 Sets the two images that should be compared. Does not transfer ownership.
 
virtual bool setImage1 (SharedImage *img1)
 Replaces the image1 that was set in the constructor with the given image.
 
virtual bool setImage2 (SharedImage *img2)
 Replaces the image2 that was set in the constructor with the given image.
 
virtual SharedImageimage1 () const
 
virtual SharedImageimage2 () const
 
void enableImage1Mask (bool enable)
 Specify whether a mask on the first image shall be used if available (true by default)
 
void enableImage2Mask (bool enable)
 Specify whether a mask on the second image shall be used if available (true by default)
 
virtual void setWeights (const SharedImage *weights1, const SharedImage *weights2)
 Sets the images to use as weights for the similarity metric.
 
bool image1MaskEnabled () const
 Return the flag for using the mask of the first image.
 
bool image2MaskEnabled () const
 Return the flag for using the mask of the second image.
 
- 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
 

Static Public Member Functions

static void defaultConfiguration (Properties *p)
 
static bool pairMriUs (const SharedImage *mri, const SharedImage *us, SharedImage *&imgOut)
 
- Static Public Member Functions inherited from SimilarityMeasureImpl
static void defaultConfiguration (Properties *p)
 Retrieve the default properties of this class.
 

Protected Attributes

GenerateSimMeasureLearningDataAlgorithm * m_smld
 Creating the dual-channel input for regression.
 
GlReductionm_reducer
 Reduction class for computing final similarity.
 
GL::Framebufferm_fbo
 Framebuffer for reduction.
 
std::unique_ptr< Algorithmm_predAlgo
 The prediction model.
 
DataList m_predAlgoInput
 
SharedImageSetm_imgDual
 Dual-channel image for regression.
 
std::string m_pwConfig
 
std::string m_pwLastConfig
 Config file for prediction model.
 
float m_gradientScaling
 
std::function< bool(const SharedImage *drr, const SharedImage *fluoro, SharedImage *&imgOut)> m_pairFunc
 Optional function to create paired image from fixed and moving.
 
- Protected Attributes inherited from SimilarityMeasureImpl
SharedImagem_img1
 
SharedImagem_img2
 
bool m_useImg1Mask
 
bool m_useImg2Mask
 
std::shared_ptr< GlMask::MultiIncludeTypem_maskImg1
 
std::shared_ptr< GlMask::MultiIncludeTypem_maskImg2
 
const SharedImagem_weights1
 
const SharedImagem_weights2
 
- Protected Attributes inherited from Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

Additional Inherited Members

- 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 SimilarityMeasureImpl
template<typename T>
double callTyped (T *obj, const MemImage &img1, const MemImage &img2, const ImageTransformer *t, size_t *overlap=nullptr)
 Helper method to transform the MemImages to TypedImages.
 
void setMaskIncludeArguments (GL::Program *program)
 Sets all uniforms for SimilarityMeasureMask.glh.
 
void initMaskInclude (GL::Program *program)
 Initializes the code for the SimilarityMeasureMask.glh code.
 
std::string glDefines (bool patchBased) const
 Return shared GL program defines for patch-based and weights, used in LNCC and LC2 OpenGL subclasses.
 

Member Function Documentation

◆ configure()

void configure ( const Properties * p)
overridevirtual

Set one or multiple properties.

The default implementation retrieves the mask mode (param names "maskModeImg1" and "maskModeImg2")

Reimplemented from SimilarityMeasureImpl.

◆ configuration()

void configuration ( Properties * p) const
overridevirtual

Retrieve the properties of this object.

The default implementation stores the mask mode (param names "maskModeImg1" and "maskModeImg2")

Reimplemented from SimilarityMeasureImpl.

◆ compute()

double compute ( const ImageTransformer * t,
size_t * overlap = nullptr )
overridevirtual

Computes and returns the similarity measure.

The higher the value the higher the similarity between the two images. The returned value does not need to be normalized, therefore values from different similarity measures should not be compared directly. The computation always iterates each pixel of img1 and compares it to the related pixel of img2. If no ImageTransformer is supplied, the image coordinates of a pixel in img1 are used directly to lookup the value in img2, no transformation is assumed. In this case it's usually advisable that img1 and img2 have the same dimensions, but this is not enforced. If an ImageTransformer is given, it will be used to transfer from img1 pixel coordinates to img2 pixel coordinates including any world transformations. In this case the dimensions of the two images can be unrelated. The optional argument overlap contains the overlap of the two images in pixels.

Implements SimilarityMeasureImpl.

◆ supportsWeights()

bool supportsWeights ( ) const
inlineoverridevirtual

Queries the capability whether this similarity measure supports pixel-wise weights.

Implements SimilarityMeasureImpl.


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