ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private 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

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
Superclass::FixedImageConstPointer 
FixedImageConstPointer
 
typedef Superclass::FixedImageType FixedImageType
 
typedef
Superclass::GradientPixelType 
GradientPixelType
 
typedef Superclass::MeasureType MeasureType
 
typedef
Superclass::MovingImageConstPointer 
MovingImageConstPointer
 
typedef Superclass::MovingImageType MovingImageType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RealType RealType
 
typedef
NormalizedCorrelationTwoImageToOneImageMetric 
Self
 
typedef
TwoImageToOneImageMetric
< TFixedImage, TMovingImage > 
Superclass
 
typedef
Superclass::TransformJacobianType 
TransformJacobianType
 
typedef
Superclass::TransformParametersType 
TransformParametersType
 
typedef
Superclass::TransformPointer 
TransformPointer
 
typedef Superclass::TransformType TransformType
 
- Public Types inherited from itk::TwoImageToOneImageMetric< TFixedImage, TMovingImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ParametersValueType 
CoordinateRepresentationType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
FixedImageType::ConstPointer 
FixedImageConstPointer
 
typedef FixedImageMaskType::Pointer FixedImageMaskPointer
 
typedef SpatialObject
< itkGetStaticConstMacro(FixedImageDimension) > 
FixedImageMaskType
 
typedef FixedImageType::RegionType FixedImageRegionType
 
typedef TFixedImage FixedImageType
 
typedef
TransformType::InputPointType 
InputPointType
 
typedef
InterpolateImageFunction
< MovingImageType,
CoordinateRepresentationType
InterpolatorType
 
typedef Superclass::MeasureType MeasureType
 
typedef
MovingImageType::ConstPointer 
MovingImageConstPointer
 
typedef
MovingImageMaskType::Pointer 
MovingImageMaskPointer
 
typedef SpatialObject
< itkGetStaticConstMacro(MovingImageDimension) > 
MovingImageMaskType
 
typedef TMovingImage::PixelType MovingImagePixelType
 
typedef TMovingImage MovingImageType
 
typedef
TransformType::OutputPointType 
OutputPointType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef TwoImageToOneImageMetric Self
 
typedef SingleValuedCostFunction Superclass
 
typedef TransformType::JacobianType TransformJacobianType
 
typedef
TransformType::ParametersType 
TransformParametersType
 
typedef TransformType::Pointer TransformPointer
 
typedef Transform
< CoordinateRepresentationType,
itkGetStaticConstMacro(MovingImageDimension),
itkGetStaticConstMacro(FixedImageDimension)> 
TransformType
 
typedef NumericTraits
< MovingImagePixelType >
::RealType 
RealType
 
typedef CovariantVector
< RealType,
itkGetStaticConstMacro(MovingImageDimension)> 
GradientPixelType
 
typedef Image
< GradientPixelType,
itkGetStaticConstMacro(MovingImageDimension)> 
GradientImageType
 
typedef SmartPointer
< GradientImageType
GradientImagePointer
 
typedef
GradientRecursiveGaussianImageFilter
< MovingImageType,
GradientImageType
GradientImageFilterType
 
typedef
GradientImageFilterType::Pointer 
GradientImageFilterPointer
 
typedef InterpolatorType::Pointer InterpolatorPointer
 
- Public Types inherited from itk::SingleValuedCostFunction
typedef SmartPointer< const SelfConstPointer
 
typedef Array
< ParametersValueType
DerivativeType
 
typedef double MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef SingleValuedCostFunction Self
 
typedef CostFunction Superclass
 
- Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< TInternalComputationValueType > 
ParametersType
 
typedef
TInternalComputationValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef CostFunctionTemplate Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
void GetDerivative (const TransformParametersType &parameters, DerivativeType &Derivative) const
 
virtual const char * GetNameOfClass () const
 
MeasureType GetValue (const TransformParametersType &parameters) const
 
void GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
 
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
 
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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~NormalizedCorrelationTwoImageToOneImageMetric ()
 
- Protected Member Functions inherited from itk::TwoImageToOneImageMetric< TFixedImage, TMovingImage >
 TwoImageToOneImageMetric ()
 
virtual ~TwoImageToOneImageMetric ()
 
- Protected Member Functions inherited from itk::SingleValuedCostFunction
 SingleValuedCostFunction ()
 
virtual ~SingleValuedCostFunction () override
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 CostFunctionTemplate ()
 
virtual ~CostFunctionTemplate () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~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 Member Functions

 NormalizedCorrelationTwoImageToOneImageMetric (const Self &)
 
void operator= (const Self &)
 

Private Attributes

bool m_SubtractMean
 

Additional Inherited Members

- Static Public Attributes inherited from itk::TwoImageToOneImageMetric< TFixedImage, TMovingImage >
static const unsigned int MovingImageDimension = TMovingImage::ImageDimension
 
static const unsigned int FixedImageDimension = TFixedImage::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
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Types transferred from the base class

Definition at line 59 of file itkNormalizedCorrelationTwoImageToOneImageMetric.h.

template<typename TFixedImage , typename TMovingImage >
typedef NormalizedCorrelationTwoImageToOneImageMetric itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::Self

Standard class typedefs.

Definition at line 49 of file itkNormalizedCorrelationTwoImageToOneImageMetric.h.

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

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage >
itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::NormalizedCorrelationTwoImageToOneImageMetric ( )
protected
template<typename TFixedImage , typename TMovingImage >
virtual itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::~NormalizedCorrelationTwoImageToOneImageMetric ( )
inlineprotectedvirtual
template<typename TFixedImage , typename TMovingImage >
itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::NormalizedCorrelationTwoImageToOneImageMetric ( const Self )
private

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

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

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

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 >::operator= ( const Self )
private
template<typename TFixedImage , typename TMovingImage >
virtual void itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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::TwoImageToOneImageMetric< TFixedImage, TMovingImage >.

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: