ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage > Class Template Reference

#include <itkNormalizedCorrelationPointSetToImageMetric.h>

Detailed Description

template<typename TFixedPointSet, typename TMovingImage>
class itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >

Computes similarity between pixel values of a point set and intensity values of an image.

This metric computes the correlation between point values in the fixed point-set and pixel values in the moving image. The correlation is normalized by the autocorrelation values of both the point-set and the moving image. The spatial correspondence between the point-set and the image is established through a Transform. Pixel values are taken from the fixed point-set. Their positions are mapped to the moving image and result in general in non-grid position on it. Values at these non-grid position of the moving image are interpolated using a user-selected Interpolator.

Examples
Examples/RegistrationITKv4/ModelToImageRegistration2.cxx.

Definition at line 44 of file itkNormalizedCorrelationPointSetToImageMetric.h.

+ Inheritance diagram for itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >:
+ Collaboration diagram for itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = NormalizedCorrelationPointSetToImageMetric
 
using Superclass = PointSetToImageMetric< TFixedPointSet, TMovingImage >
 
- Public Types inherited from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >
using ConstPointer = SmartPointer< const Self >
 
using CoordinateRepresentationType = Superclass::ParametersValueType
 
using DerivativeType = Superclass::DerivativeType
 
using FixedPointSetConstPointer = typename FixedPointSetType::ConstPointer
 
using FixedPointSetType = TFixedPointSet
 
using GradientImageFilterPointer = typename GradientImageFilterType::Pointer
 
using GradientImageFilterType = GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType >
 
using GradientImagePointer = SmartPointer< GradientImageType >
 
using GradientImageType = Image< GradientPixelType, Self::MovingImageDimension >
 
using GradientPixelType = CovariantVector< RealType, Self::MovingImageDimension >
 
using InputPointType = typename TransformType::InputPointType
 
using InterpolatorPointer = typename InterpolatorType::Pointer
 
using InterpolatorType = InterpolateImageFunction< MovingImageType, CoordinateRepresentationType >
 
using MeasureType = Superclass::MeasureType
 
using MovingImageConstPointer = typename MovingImageType::ConstPointer
 
using MovingImagePixelType = typename TMovingImage::PixelType
 
using MovingImageType = TMovingImage
 
using OutputPointType = typename TransformType::OutputPointType
 
using ParametersType = Superclass::ParametersType
 
using PointDataIterator = typename FixedPointSetType::PointDataContainer::ConstIterator
 
using Pointer = SmartPointer< Self >
 
using PointIterator = typename FixedPointSetType::PointsContainer::ConstIterator
 
using RealType = typename NumericTraits< MovingImagePixelType >::RealType
 
using Self = PointSetToImageMetric
 
using Superclass = SingleValuedCostFunction
 
using TransformJacobianType = typename TransformType::JacobianType
 
using TransformParametersType = typename TransformType::ParametersType
 
using TransformPointer = typename TransformType::Pointer
 
using TransformType = Transform< CoordinateRepresentationType, Self::MovingImageDimension, Self::FixedPointSetDimension >
 
- Public Types inherited from itk::SingleValuedCostFunction
using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = Array< ParametersValueType >
 
using MeasureType = double
 
using ParametersType = Superclass::ParametersType
 
using ParametersValueType = Superclass::ParametersValueType
 
using Pointer = SmartPointer< Self >
 
using Self = SingleValuedCostFunction
 
using Superclass = CostFunction
 
- Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using ParametersType = OptimizerParameters< TInternalComputationValueType >
 
using ParametersValueType = TInternalComputationValueType
 
using Pointer = SmartPointer< Self >
 
using Self = CostFunctionTemplate
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

void GetDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const override
 
const char * GetNameOfClass () const override
 
MeasureType GetValue (const TransformParametersType &parameters) const override
 
void GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &value, DerivativeType &derivative) const override
 
virtual void SetSubtractMean (bool _arg)
 
virtual const bool & GetSubtractMean () const
 
virtual void SubtractMeanOn ()
 
- Public Member Functions inherited from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >
virtual GradientImageTypeGetModifiableGradientImage ()
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual TransformTypeGetModifiableTransform ()
 
const char * GetNameOfClass () const override
 
unsigned int GetNumberOfParameters () const override
 
virtual const SizeValueTypeGetNumberOfPixelsCounted () const
 
virtual void Initialize ()
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
virtual void SetTransform (TransformType *_arg)
 
void SetTransformParameters (const ParametersType &parameters) const
 
virtual void SetFixedPointSet (const FixedPointSetType *_arg)
 
virtual const FixedPointSetTypeGetFixedPointSet () const
 
virtual void SetMovingImage (const MovingImageType *_arg)
 
virtual const MovingImageTypeGetMovingImage () const
 
virtual void SetComputeGradient (bool _arg)
 
virtual const bool & GetComputeGradient () const
 
- Public Member Functions inherited from itk::SingleValuedCostFunction
virtual void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
 
virtual MeasureType GetValue (const ParametersType &parameters) const =0
 
virtual void GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 NormalizedCorrelationPointSetToImageMetric ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~NormalizedCorrelationPointSetToImageMetric () override=default
 
- Protected Member Functions inherited from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >
 PointSetToImageMetric ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~PointSetToImageMetric () override=default
 
- Protected Member Functions inherited from itk::SingleValuedCostFunction
 SingleValuedCostFunction ()=default
 
 ~SingleValuedCostFunction () override
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 CostFunctionTemplate ()=default
 
 ~CostFunctionTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

bool m_SubtractMean {}
 

Additional Inherited Members

- Static Public Attributes inherited from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >
static constexpr unsigned int FixedPointSetDimension = TFixedPointSet::PointDimension
 
static constexpr unsigned int MovingImageDimension = TMovingImage::ImageDimension
 
- Protected Attributes inherited from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >
bool m_ComputeGradient {}
 
FixedPointSetConstPointer m_FixedPointSet {}
 
GradientImagePointer m_GradientImage {}
 
InterpolatorPointer m_Interpolator {}
 
MovingImageConstPointer m_MovingImage {}
 
SizeValueType m_NumberOfPixelsCounted {}
 
TransformPointer m_Transform {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedPointSet , typename TMovingImage >
using itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::ConstPointer = SmartPointer<const Self>

◆ Pointer

template<typename TFixedPointSet , typename TMovingImage >
using itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::Pointer = SmartPointer<Self>

◆ Self

template<typename TFixedPointSet , typename TMovingImage >
using itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::Self = NormalizedCorrelationPointSetToImageMetric

Standard class type aliases.

Definition at line 51 of file itkNormalizedCorrelationPointSetToImageMetric.h.

◆ Superclass

template<typename TFixedPointSet , typename TMovingImage >
using itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::Superclass = PointSetToImageMetric<TFixedPointSet, TMovingImage>

Constructor & Destructor Documentation

◆ NormalizedCorrelationPointSetToImageMetric()

template<typename TFixedPointSet , typename TMovingImage >
itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::NormalizedCorrelationPointSetToImageMetric ( )
protected

◆ ~NormalizedCorrelationPointSetToImageMetric()

template<typename TFixedPointSet , typename TMovingImage >
itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::~NormalizedCorrelationPointSetToImageMetric ( )
overrideprotecteddefault

Member Function Documentation

◆ GetDerivative()

template<typename TFixedPointSet , typename TMovingImage >
void itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::GetDerivative ( const TransformParametersType parameters,
DerivativeType derivative 
) const
override

Get the derivatives of the match measure.

◆ GetNameOfClass()

template<typename TFixedPointSet , typename TMovingImage >
const char* itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::GetNameOfClass ( ) const
overridevirtual

◆ GetSubtractMean()

template<typename TFixedPointSet , typename TMovingImage >
virtual const bool& itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::GetSubtractMean ( ) const
virtual

Set/Get SubtractMean boolean. If true, the sample mean is subtracted from the sample values in the cross-correlation formula and typically results in narrower valleys in the cost function. Default value is false.

◆ GetValue()

template<typename TFixedPointSet , typename TMovingImage >
MeasureType itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::GetValue ( const TransformParametersType parameters) const
override

Get the value for single valued optimizers.

◆ GetValueAndDerivative()

template<typename TFixedPointSet , typename TMovingImage >
void itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::GetValueAndDerivative ( const TransformParametersType parameters,
MeasureType value,
DerivativeType derivative 
) const
override

Get value and derivatives for multiple valued optimizers.

◆ New()

template<typename TFixedPointSet , typename TMovingImage >
static Pointer itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedPointSet , typename TMovingImage >
void itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::CostFunctionTemplate< TInternalComputationValueType >.

◆ SetSubtractMean()

template<typename TFixedPointSet , typename TMovingImage >
virtual void itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::SetSubtractMean ( bool  _arg)
virtual

Set/Get SubtractMean boolean. If true, the sample mean is subtracted from the sample values in the cross-correlation formula and typically results in narrower valleys in the cost function. Default value is false.

◆ SubtractMeanOn()

template<typename TFixedPointSet , typename TMovingImage >
virtual void itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::SubtractMeanOn ( )
virtual

Set/Get SubtractMean boolean. If true, the sample mean is subtracted from the sample values in the cross-correlation formula and typically results in narrower valleys in the cost function. Default value is false.

Member Data Documentation

◆ m_SubtractMean

template<typename TFixedPointSet , typename TMovingImage >
bool itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::m_SubtractMean {}
private

The documentation for this class was generated from the following file: