ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage > Class Template Reference

#include <itkNormalizedCorrelationTwoImageToOneImageMetric.h>

+ Inheritance diagram for itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >:
+ Collaboration diagram for itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >:

Detailed Description

template<typename TFixedImage, typename TMovingImage>
class itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >

Computes similarity between two fixed images and one moving image.

This metric computes the correlation between pixels in the two fixed images and pixels in the moving image. The spatial correspondance between two fixed images and the moving image is established through a Transform. Pixel values are taken from the fixed images, 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 user-selected Interpolators. The correlation is normalized by the autocorrelations of both the fixed and moving images.

Definition at line 44 of file itkNormalizedCorrelationTwoImageToOneImageMetric.h.

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = typename Superclass::DerivativeType
 
using FixedImageConstPointer = typename Superclass::FixedImageConstPointer
 
using FixedImageType = typename Superclass::FixedImageType
 
using GradientPixelType = typename Superclass::GradientPixelType
 
using MeasureType = typename Superclass::MeasureType
 
using MovingImageConstPointer = typename Superclass::MovingImageConstPointer
 
using MovingImageType = typename Superclass::MovingImageType
 
using Pointer = SmartPointer< Self >
 
using RealType = typename Superclass::RealType
 
using Self = NormalizedCorrelationTwoImageToOneImageMetric
 
using Superclass = TwoImageToOneImageMetric< TFixedImage, TMovingImage >
 
using TransformJacobianType = typename Superclass::TransformJacobianType
 
using TransformParametersType = typename Superclass::TransformParametersType
 
using TransformPointer = typename Superclass::TransformPointer
 
using TransformType = typename Superclass::TransformType
 
- Public Types inherited from itk::TwoImageToOneImageMetric< TFixedImage, TMovingImage >
using ConstPointer = SmartPointer< const Self >
 
using CoordinateRepresentationType = Superclass::ParametersValueType
 
using DerivativeType = Superclass::DerivativeType
 
using FixedImageConstPointer = typename FixedImageType::ConstPointer
 
using FixedImageMaskPointer = typename FixedImageMaskType::Pointer
 
typedef SpatialObject
< itkGetStaticConstMacro(FixedImageDimension) > 
FixedImageMaskType
 
using FixedImageRegionType = typename FixedImageType::RegionType
 
using FixedImageType = TFixedImage
 
using InputPointType = typename TransformType::InputPointType
 
using InterpolatorType = InterpolateImageFunction< MovingImageType, CoordinateRepresentationType >
 
using MeasureType = Superclass::MeasureType
 
using MovingImageConstPointer = typename MovingImageType::ConstPointer
 
using MovingImageMaskPointer = typename MovingImageMaskType::Pointer
 
typedef SpatialObject
< itkGetStaticConstMacro(MovingImageDimension) > 
MovingImageMaskType
 
using MovingImagePixelType = typename TMovingImage::PixelType
 
using MovingImageType = TMovingImage
 
using OutputPointType = typename TransformType::OutputPointType
 
using ParametersType = Superclass::ParametersType
 
using Pointer = SmartPointer< Self >
 
using Self = TwoImageToOneImageMetric
 
using Superclass = SingleValuedCostFunction
 
using TransformJacobianType = typename TransformType::JacobianType
 
using TransformParametersType = typename TransformType::ParametersType
 
using TransformPointer = typename TransformType::Pointer
 
using TransformType = Transform< CoordinateRepresentationType, itkGetStaticConstMacro(MovingImageDimension), itkGetStaticConstMacro(FixedImageDimension)>
 
using RealType = typename NumericTraits< MovingImagePixelType >::RealType
 
using GradientPixelType = CovariantVector< RealType, itkGetStaticConstMacro(MovingImageDimension)>
 
using GradientImageType = Image< GradientPixelType, itkGetStaticConstMacro(MovingImageDimension)>
 
using GradientImagePointer = SmartPointer< GradientImageType >
 
using GradientImageFilterType = GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType >
 
using GradientImageFilterPointer = typename GradientImageFilterType::Pointer
 
using InterpolatorPointer = typename InterpolatorType::Pointer
 
- 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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
void GetDerivative (const TransformParametersType &parameters, DerivativeType &Derivative) const override
 
virtual const char * GetNameOfClass () const
 
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 ()
 
virtual void SubtractMeanOff ()
 
- Public Member Functions inherited from itk::TwoImageToOneImageMetric< TFixedImage, TMovingImage >
virtual const FixedImageTypeGetFixedImage1 () const
 
virtual const FixedImageTypeGetFixedImage2 () const
 
virtual const
FixedImageRegionType
GetFixedImageRegion1 () const
 
virtual const
FixedImageRegionType
GetFixedImageRegion2 () const
 
virtual const GradientImageTypeGetGradientImage () const
 
virtual const InterpolatorTypeGetInterpolator1 () const
 
virtual const InterpolatorTypeGetInterpolator2 () const
 
virtual const MovingImageTypeGetMovingImage () const
 
unsigned int GetNumberOfParameters () const override
 
virtual const unsigned long & GetNumberOfPixelsCounted () const
 
virtual const TransformTypeGetTransform () const
 
virtual void Initialize ()
 
virtual void SetFixedImage1 (const FixedImageType *_arg)
 
virtual void SetFixedImage2 (const FixedImageType *_arg)
 
virtual void SetFixedImageRegion1 (FixedImageRegionType _arg)
 
virtual void SetFixedImageRegion2 (FixedImageRegionType _arg)
 
virtual void SetInterpolator1 (InterpolatorType *_arg)
 
virtual void SetInterpolator2 (InterpolatorType *_arg)
 
virtual void SetMovingImage (const MovingImageType *_arg)
 
virtual void SetTransform (TransformType *_arg)
 
void SetTransformParameters (const ParametersType &parameters) const
 
virtual void SetMovingImageMask (MovingImageMaskType *_arg)
 
virtual const MovingImageMaskTypeGetMovingImageMask () const
 
virtual void SetFixedImageMask1 (FixedImageMaskType *_arg)
 
virtual void SetFixedImageMask2 (FixedImageMaskType *_arg)
 
virtual const FixedImageMaskTypeGetFixedImageMask1 () const
 
virtual const FixedImageMaskTypeGetFixedImageMask2 () const
 
virtual void SetComputeGradient (bool _arg)
 
virtual const bool & GetComputeGradient () const
 
virtual void ComputeGradientOn ()
 
virtual void ComputeGradientOff ()
 
- 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
 
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 noexceptoverride
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 NormalizedCorrelationTwoImageToOneImageMetric ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~NormalizedCorrelationTwoImageToOneImageMetric () override
 
- Protected Member Functions inherited from itk::TwoImageToOneImageMetric< TFixedImage, TMovingImage >
void PrintSelf (std::ostream &os, Indent indent) const override
 
 TwoImageToOneImageMetric ()
 
 ~TwoImageToOneImageMetric () override
 
- 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 &time)
 
 ~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::TwoImageToOneImageMetric< TFixedImage, TMovingImage >
static constexpr unsigned int FixedImageDimension = TFixedImage::ImageDimension
 
static constexpr unsigned int MovingImageDimension = TMovingImage::ImageDimension
 
- Protected Attributes inherited from itk::TwoImageToOneImageMetric< TFixedImage, TMovingImage >
bool m_ComputeGradient
 
FixedImageConstPointer m_FixedImage1
 
FixedImageConstPointer m_FixedImage2
 
FixedImageMaskPointer m_FixedImageMask1
 
FixedImageMaskPointer m_FixedImageMask2
 
GradientImagePointer m_GradientImage
 
InterpolatorPointer m_Interpolator1
 
InterpolatorPointer m_Interpolator2
 
MovingImageConstPointer m_MovingImage
 
MovingImageMaskPointer m_MovingImageMask
 
unsigned long m_NumberOfPixelsCounted
 
TransformPointer m_Transform
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::ConstPointer = SmartPointer<const Self>
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::DerivativeType = typename Superclass::DerivativeType
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer = typename Superclass::FixedImageConstPointer
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::FixedImageType = typename Superclass::FixedImageType
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::GradientPixelType = typename Superclass::GradientPixelType
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::MeasureType = typename Superclass::MeasureType
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointer = typename Superclass::MovingImageConstPointer
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::MovingImageType = typename Superclass::MovingImageType
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::Pointer = SmartPointer<Self>
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::RealType = typename Superclass::RealType

Types transferred from the base class

Definition at line 65 of file itkNormalizedCorrelationTwoImageToOneImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::Self = NormalizedCorrelationTwoImageToOneImageMetric

Standard class type alias.

Definition at line 51 of file itkNormalizedCorrelationTwoImageToOneImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::Superclass = TwoImageToOneImageMetric<TFixedImage, TMovingImage >
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::TransformJacobianType = typename Superclass::TransformJacobianType
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::TransformParametersType = typename Superclass::TransformParametersType
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::TransformPointer = typename Superclass::TransformPointer
template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::TransformType = typename Superclass::TransformType

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage >
itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::NormalizedCorrelationTwoImageToOneImageMetric ( )
protected
template<typename TFixedImage , typename TMovingImage >
itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::~NormalizedCorrelationTwoImageToOneImageMetric ( )
inlineoverrideprotected

Member Function Documentation

template<typename TFixedImage , typename TMovingImage >
virtual::itk::LightObject::Pointer itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TFixedImage , typename TMovingImage >
void itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::GetDerivative ( const TransformParametersType parameters,
DerivativeType Derivative 
) const
override

Get the derivatives of the match measure.

template<typename TFixedImage , typename TMovingImage >
virtual const char* itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::TwoImageToOneImageMetric< TFixedImage, TMovingImage >.

template<typename TFixedImage , typename TMovingImage >
virtual const bool& itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, 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 fucntion. Default value is false.

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

Get the value for single valued optimizers.

template<typename TFixedImage , typename TMovingImage >
void itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivative ( const TransformParametersType parameters,
MeasureType Value,
DerivativeType Derivative 
) const
override

Get value and derivatives for multiple valued optimizers.

template<typename TFixedImage , typename TMovingImage >
static Pointer itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::New ( )
static

Method for creation through the object factory.

template<typename TFixedImage , typename TMovingImage >
void itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, 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 >.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, 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 fucntion. Default value is false.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::SubtractMeanOff ( )
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 fucntion. Default value is false.

template<typename TFixedImage , typename TMovingImage >
virtual void itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, 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 fucntion. Default value is false.

Member Data Documentation

template<typename TFixedImage , typename TMovingImage >
bool itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::m_SubtractMean
private

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