go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Private Types | Private Member Functions | Private Attributes
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference

#include <itkAdvancedNormalizedCorrelationImageToImageMetric.h>

Detailed Description

template<class TFixedImage, class TMovingImage>
class itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >

Computes normalized correlation between two images, based on AdvancedImageToImageMetric...

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

This implementation of the NormalizedCorrelation is based on the AdvancedImageToImageMetric, which means that:

The normalized correlation NC is defined as:

\[ \mathrm{NC} = \frac{\sum_x f(x) * m(x+u(x,p))}{\sqrt{ \sum_x f(x)^2 * \sum_x m(x+u(x,p))^2}} = \frac{\mathtt{sfm}}{\sqrt{\mathtt{sff} * \mathtt{smm}}} \]

where x a voxel in the fixed image f, m the moving image, u(x,p) the deformation of x depending on the transform parameters p. sfm, sff and smm is notation used in the source code. The derivative of NC to p equals:

\[ \frac{\partial \mathrm{NC}}{\partial p} = \frac{\partial \mathrm{NC}}{\partial m} \frac{\partial m}{\partial x} \frac{\partial x}{\partial p} = \frac{\partial \mathrm{NC}}{\partial m} * \mathtt{gradient} * \mathtt{jacobian}, \]

where gradient is the derivative of the moving image m to x, and where Jacobian is the derivative of the transformation to its parameters. gradient * Jacobian is called the differential. This yields for the derivative:

\[ \frac{\partial \mathrm{NC}}{\partial p} = \frac{\sum_x[ f(x) * \mathtt{differential} ] - ( \mathtt{sfm} / \mathtt{smm} ) * \sum_x[ m(x+u(x,p)) * \mathtt{differential} ]}{\sqrt{\mathtt{sff} * \mathtt{smm}}} \]

This class has an option to subtract the sample mean from the sample values in the cross correlation formula. This typically results in narrower valleys in the cost function NC. The default value is false. If SubtractMean is true, the NC is defined as:

\[ \mathrm{NC} = \frac{\sum_x ( f(x) - \mathtt{Af} ) * ( m(x+u(x,p)) - \mathtt{Am})} {\sqrt{\sum_x (f(x) - \mathtt{Af})^2 * \sum_x (m(x+u(x,p)) - \mathtt{Am})^2}} = \frac{\mathtt{sfm} - \mathtt{sf} * \mathtt{sm} / N} {\sqrt{(\mathtt{sff} - \mathtt{sf} * \mathtt{sf} / N) * (\mathtt{smm} - \mathtt{sm} *\mathtt{sm} / N)}}, \]

where Af and Am are the average of f and m, respectively.

Definition at line 90 of file itkAdvancedNormalizedCorrelationImageToImageMetric.h.

Inheritance diagram for itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >:
Inheritance graph
[legend]

Data Structures

struct  CorrelationGetValueAndDerivativePerThreadStruct
 
struct  MultiThreaderAccumulateDerivativeType
 

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::CoordinateRepresentationType CoordinateRepresentationType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef Superclass::DerivativeValueType DerivativeValueType
 
typedef Superclass::FixedImageConstPointer FixedImageConstPointer
 
typedef Superclass::FixedImageLimiterOutputType FixedImageLimiterOutputType
 
typedef Superclass::FixedImageLimiterType FixedImageLimiterType
 
typedef Superclass::FixedImageMaskPointer FixedImageMaskPointer
 
typedef Superclass::FixedImageMaskType FixedImageMaskType
 
typedef Superclass::FixedImagePixelType FixedImagePixelType
 
typedef Superclass::FixedImageRegionType FixedImageRegionType
 
typedef Superclass::FixedImageType FixedImageType
 
typedef Superclass::GradientImageFilterPointer GradientImageFilterPointer
 
typedef Superclass::GradientImageFilterType GradientImageFilterType
 
typedef Superclass::GradientImagePointer GradientImagePointer
 
typedef Superclass::GradientImageType GradientImageType
 
typedef Superclass::GradientPixelType GradientPixelType
 
typedef Superclass::ImageSampleContainerPointer ImageSampleContainerPointer
 
typedef Superclass::ImageSampleContainerType ImageSampleContainerType
 
typedef Superclass::ImageSamplerPointer ImageSamplerPointer
 
typedef Superclass::ImageSamplerType ImageSamplerType
 
typedef Superclass::InputPointType InputPointType
 
typedef Superclass::InterpolatorPointer InterpolatorPointer
 
typedef Superclass::InterpolatorType InterpolatorType
 
typedef Superclass::MeasureType MeasureType
 
typedef Superclass::MovingImageConstPointer MovingImageConstPointer
 
typedef Superclass::MovingImageDerivativeScalesType MovingImageDerivativeScalesType
 
typedef Superclass::MovingImageLimiterOutputType MovingImageLimiterOutputType
 
typedef Superclass::MovingImageLimiterType MovingImageLimiterType
 
typedef Superclass::MovingImageMaskPointer MovingImageMaskPointer
 
typedef Superclass::MovingImageMaskType MovingImageMaskType
 
typedef Superclass::MovingImagePixelType MovingImagePixelType
 
typedef Superclass::MovingImageRegionType MovingImageRegionType
 
typedef Superclass::MovingImageType MovingImageType
 
typedef Superclass::NumberOfParametersType NumberOfParametersType
 
typedef Superclass::OutputPointType OutputPointType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RealType RealType
 
typedef AdvancedNormalizedCorrelationImageToImageMetric Self
 
typedef AdvancedImageToImageMetric< TFixedImage, TMovingImage > Superclass
 
typedef Superclass::ThreaderType ThreaderType
 
typedef Superclass::ThreadInfoType ThreadInfoType
 
typedef Superclass::TransformJacobianType TransformJacobianType
 
typedef Superclass::TransformParametersType TransformParametersType
 
typedef Superclass::TransformPointer TransformPointer
 
typedef Superclass::TransformType TransformType
 
- Public Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
typedef AdvancedTransform< ScalarType, FixedImageDimension, MovingImageDimension > AdvancedTransformType
 
typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 1 > BSplineOrder1TransformType
 
typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 2 > BSplineOrder2TransformType
 
typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 3 > BSplineOrder3TransformType
 
typedef AdvancedCombinationTransform< ScalarType, FixedImageDimension > CombinationTransformType
 
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::CoordinateRepresentationType CoordinateRepresentationType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef DerivativeType::ValueType DerivativeValueType
 
typedef Superclass::FixedImageConstPointer FixedImageConstPointer
 
typedef FixedImageLimiterType::OutputType FixedImageLimiterOutputType
 
typedef FixedImageLimiterType::Pointer FixedImageLimiterPointer
 
typedef LimiterFunctionBase< RealType, FixedImageDimension > FixedImageLimiterType
 
typedef Superclass::FixedImageMaskPointer FixedImageMaskPointer
 
typedef Superclass::FixedImageMaskType FixedImageMaskType
 
typedef FixedImageType::PixelType FixedImagePixelType
 
typedef FixedImageType::Pointer FixedImagePointer
 
typedef Superclass::FixedImageRegionType FixedImageRegionType
 
typedef Superclass::FixedImageType FixedImageType
 
typedef Superclass::GradientImageFilterPointer GradientImageFilterPointer
 
typedef Superclass::GradientImageFilterType GradientImageFilterType
 
typedef Superclass::GradientImagePointer GradientImagePointer
 
typedef Superclass::GradientImageType GradientImageType
 
typedef Superclass::GradientPixelType GradientPixelType
 
typedef vnl_sparse_matrix< HessianValueTypeHessianType
 
typedef DerivativeType::ValueType HessianValueType
 
typedef ImageSamplerType::OutputVectorContainerPointer ImageSampleContainerPointer
 
typedef ImageSamplerType::OutputVectorContainerType ImageSampleContainerType
 
typedef ImageSamplerType::Pointer ImageSamplerPointer
 
typedef ImageSamplerBase< FixedImageTypeImageSamplerType
 
typedef Superclass::InputPointType InputPointType
 
typedef Superclass::InterpolatorPointer InterpolatorPointer
 
typedef Superclass::InterpolatorType InterpolatorType
 
typedef Superclass::MeasureType MeasureType
 
typedef Superclass::MovingImageConstPointer MovingImageConstPointer
 
typedef FixedArray< double, Self::MovingImageDimension > MovingImageDerivativeScalesType
 
typedef MovingImageLimiterType::OutputType MovingImageLimiterOutputType
 
typedef MovingImageLimiterType::Pointer MovingImageLimiterPointer
 
typedef LimiterFunctionBase< RealType, MovingImageDimension > MovingImageLimiterType
 
typedef Superclass::MovingImageMaskPointer MovingImageMaskPointer
 
typedef Superclass::MovingImageMaskType MovingImageMaskType
 
typedef Superclass::MovingImagePixelType MovingImagePixelType
 
typedef MovingImageType::Pointer MovingImagePointer
 
typedef MovingImageType::RegionType MovingImageRegionType
 
typedef Superclass::MovingImageType MovingImageType
 
typedef AdvancedTransformType::NumberOfParametersType NumberOfParametersType
 
typedef Superclass::OutputPointType OutputPointType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RealType RealType
 
typedef TransformType::ScalarType ScalarType
 
typedef AdvancedImageToImageMetric Self
 
typedef ImageToImageMetric< TFixedImage, TMovingImage > Superclass
 
typedef itk::MultiThreader ThreaderType
 
typedef ThreaderType::ThreadInfoStruct ThreadInfoType
 
typedef Superclass::TransformJacobianType TransformJacobianType
 
typedef Superclass::TransformParametersType TransformParametersType
 
typedef Superclass::TransformPointer TransformPointer
 
typedef Superclass::TransformType TransformType
 

Public Member Functions

virtual const char * GetClassName () const
 
void GetDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const
 
virtual const boolGetSubtractMean ()
 
MeasureType GetValue (const TransformParametersType &parameters) const
 
void GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
 
void GetValueAndDerivativeSingleThreaded (const TransformParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
 
 itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)
 
 itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)
 
virtual void SetSubtractMean (bool _arg)
 
virtual void SubtractMeanOff ()
 
virtual void SubtractMeanOn ()
 
- Public Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
virtual void BeforeThreadedGetValueAndDerivative (const TransformParametersType &parameters) const
 
virtual const FixedImageLimiterTypeGetFixedImageLimiter ()
 
virtual double GetFixedLimitRangeRatio () const
 
virtual ImageSamplerTypeGetImageSampler (void) const
 
virtual const MovingImageDerivativeScalesTypeGetMovingImageDerivativeScales ()
 
virtual const MovingImageLimiterTypeGetMovingImageLimiter ()
 
virtual double GetMovingLimitRangeRatio () const
 
virtual double GetRequiredRatioOfValidSamples () const
 
virtual bool GetScaleGradientWithRespectToMovingImageOrientation () const
 
virtual void GetSelfHessian (const TransformParametersType &parameters, HessianType &H) const
 
const AdvancedTransformTypeGetTransform (void) const
 
virtual bool GetUseFixedImageLimiter () const
 
virtual bool GetUseImageSampler () const
 
virtual const boolGetUseMetricSingleThreaded ()
 
virtual bool GetUseMovingImageDerivativeScales () const
 
virtual bool GetUseMovingImageLimiter () const
 
virtual const boolGetUseMultiThread ()
 
virtual void Initialize (void) throw ( ExceptionObject )
 
 itkStaticConstMacro (MovingImageDimension, unsigned int, TMovingImage::ImageDimension)
 
 itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)
 
virtual void SetFixedImageLimiter (FixedImageLimiterType *_arg)
 
virtual void SetFixedLimitRangeRatio (double _arg)
 
virtual void SetImageSampler (ImageSamplerType *_arg)
 
virtual void SetMovingImageDerivativeScales (MovingImageDerivativeScalesType _arg)
 
virtual void SetMovingImageLimiter (MovingImageLimiterType *_arg)
 
virtual void SetMovingLimitRangeRatio (double _arg)
 
virtual void SetNumberOfThreads (ThreadIdType numberOfThreads)
 
virtual void SetRequiredRatioOfValidSamples (double _arg)
 
virtual void SetScaleGradientWithRespectToMovingImageOrientation (bool _arg)
 
virtual void SetTransform (AdvancedTransformType *arg)
 
virtual void SetUseMetricSingleThreaded (bool _arg)
 
virtual void SetUseMovingImageDerivativeScales (bool _arg)
 
virtual void SetUseMultiThread (bool _arg)
 
virtual void UseMetricSingleThreadedOff ()
 
virtual void UseMetricSingleThreadedOn ()
 
virtual void UseMultiThreadOff ()
 
virtual void UseMultiThreadOn ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Types

typedef Superclass::BSplineInterpolatorType BSplineInterpolatorType
 
typedef Superclass::CentralDifferenceGradientFilterType CentralDifferenceGradientFilterType
 
typedef Superclass::FixedImageIndexType FixedImageIndexType
 
typedef Superclass::FixedImageIndexValueType FixedImageIndexValueType
 
typedef Superclass::FixedImagePointType FixedImagePointType
 
typedef Superclass::MovingImageContinuousIndexType MovingImageContinuousIndexType
 
typedef Superclass::MovingImageDerivativeType MovingImageDerivativeType
 
typedef Superclass::MovingImageIndexType MovingImageIndexType
 
typedef Superclass::MovingImagePointType MovingImagePointType
 
typedef Superclass::NonZeroJacobianIndicesType NonZeroJacobianIndicesType
 
- Protected Types inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
typedef BSplineInterpolatorFloatType::Pointer BSplineInterpolatorFloatPointer
 
typedef BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, floatBSplineInterpolatorFloatType
 
typedef BSplineInterpolatorType::Pointer BSplineInterpolatorPointer
 
typedef BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, doubleBSplineInterpolatorType
 
typedef CentralDifferenceGradientFilterType::Pointer CentralDifferenceGradientFilterPointer
 
typedef GradientImageFilter< MovingImageType, RealType, RealTypeCentralDifferenceGradientFilterType
 
typedef FixedImageType::IndexType FixedImageIndexType
 
typedef FixedImageIndexType::IndexValueType FixedImageIndexValueType
 
typedef TransformType::InputPointType FixedImagePointType
 
typedef LinearInterpolatorType::Pointer LinearInterpolatorPointer
 
typedef AdvancedLinearInterpolateImageFunction< MovingImageType, CoordinateRepresentationTypeLinearInterpolatorType
 
typedef InterpolatorType::ContinuousIndexType MovingImageContinuousIndexType
 
typedef BSplineInterpolatorType::CovariantVectorType MovingImageDerivativeType
 
typedef MovingImageType::IndexType MovingImageIndexType
 
typedef TransformType::OutputPointType MovingImagePointType
 
typedef AdvancedTransformType::NonZeroJacobianIndicesType NonZeroJacobianIndicesType
 
typedef ReducedBSplineInterpolatorType::Pointer ReducedBSplineInterpolatorPointer
 
typedef ReducedDimensionBSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType, doubleReducedBSplineInterpolatorType
 

Protected Member Functions

 AdvancedNormalizedCorrelationImageToImageMetric ()
 
void AfterThreadedGetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const
 
virtual void InitializeThreadingParameters (void) const
 
void PrintSelf (std::ostream &os, Indent indent) const
 
void ThreadedGetValueAndDerivative (ThreadIdType threadID)
 
void UpdateDerivativeTerms (const RealType &fixedImageValue, const RealType &movingImageValue, const DerivativeType &imageJacobian, const NonZeroJacobianIndicesType &nzji, DerivativeType &derivativeF, DerivativeType &derivativeM, DerivativeType &differential) const
 
virtual ~AdvancedNormalizedCorrelationImageToImageMetric ()
 
- Protected Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
 AdvancedImageToImageMetric ()
 
virtual void CheckForAdvancedTransform (void)
 
virtual void CheckForBSplineInterpolator (void)
 
virtual void CheckForBSplineTransform (void)
 
virtual void CheckNumberOfSamples (unsigned long wanted, unsigned long found) const
 
virtual void ComputeFixedImageExtrema (const FixedImageType *image, const FixedImageRegionType &region)
 
virtual void ComputeMovingImageExtrema (const MovingImageType *image, const MovingImageRegionType &region)
 
virtual bool EvaluateMovingImageValueAndDerivative (const MovingImagePointType &mappedPoint, RealType &movingImageValue, MovingImageDerivativeType *gradient) const
 
virtual bool EvaluateTransformJacobian (const FixedImagePointType &fixedImagePoint, TransformJacobianType &jacobian, NonZeroJacobianIndicesType &nzji) const
 
virtual void EvaluateTransformJacobianInnerProduct (const TransformJacobianType &jacobian, const MovingImageDerivativeType &movingImageDerivative, DerivativeType &imageJacobian) const
 
virtual void InitializeImageSampler (void) throw ( ExceptionObject )
 
virtual void InitializeLimiters (void)
 
virtual bool IsInsideMovingMask (const MovingImagePointType &point) const
 
 itkAlignedTypedef (ITK_CACHE_LINE_ALIGNMENT, PaddedGetValueAndDerivativePerThreadStruct, AlignedGetValueAndDerivativePerThreadStruct)
 
 itkPadStruct (ITK_CACHE_LINE_ALIGNMENT, GetValueAndDerivativePerThreadStruct, PaddedGetValueAndDerivativePerThreadStruct)
 
void LaunchGetValueAndDerivativeThreaderCallback (void) const
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void SetUseFixedImageLimiter (bool _arg)
 
virtual void SetUseImageSampler (bool _arg)
 
virtual void SetUseMovingImageLimiter (bool _arg)
 
virtual bool TransformPoint (const FixedImagePointType &fixedImagePoint, MovingImagePointType &mappedPoint) const
 
virtual ~AdvancedImageToImageMetric ()
 

Static Protected Member Functions

static ITK_THREAD_RETURN_TYPE AccumulateDerivativesThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_TYPE AccumulateDerivativesThreaderCallback (void *arg)
 
static ITK_THREAD_RETURN_TYPE GetValueAndDerivativeThreaderCallback (void *arg)
 

Private Types

typedef NumericTraits< MeasureType >::AccumulateType AccumulateType
 

Private Member Functions

 AdvancedNormalizedCorrelationImageToImageMetric (const Self &)
 
 itkAlignedTypedef (ITK_CACHE_LINE_ALIGNMENT, PaddedCorrelationGetValueAndDerivativePerThreadStruct, AlignedCorrelationGetValueAndDerivativePerThreadStruct)
 
 itkPadStruct (ITK_CACHE_LINE_ALIGNMENT, CorrelationGetValueAndDerivativePerThreadStruct, PaddedCorrelationGetValueAndDerivativePerThreadStruct)
 
void operator= (const Self &)
 

Private Attributes

AlignedCorrelationGetValueAndDerivativePerThreadStruct * m_CorrelationGetValueAndDerivativePerThreadVariables
 
ThreadIdType m_CorrelationGetValueAndDerivativePerThreadVariablesSize
 
bool m_SubtractMean
 

Additional Inherited Members

- Protected Attributes inherited from itk::AdvancedImageToImageMetric< TFixedImage, TMovingImage >
AdvancedTransformType::Pointer m_AdvancedTransform
 
BSplineInterpolatorPointer m_BSplineInterpolator
 
BSplineInterpolatorFloatPointer m_BSplineInterpolatorFloat
 
CentralDifferenceGradientFilterPointer m_CentralDifferenceGradientFilter
 
FixedImageLimiterPointer m_FixedImageLimiter
 
FixedImageLimiterOutputType m_FixedImageMaxLimit
 
FixedImageLimiterOutputType m_FixedImageMinLimit
 
FixedImagePixelType m_FixedImageTrueMax
 
FixedImagePixelType m_FixedImageTrueMin
 
AlignedGetValueAndDerivativePerThreadStruct * m_GetValueAndDerivativePerThreadVariables
 
ThreadIdType m_GetValueAndDerivativePerThreadVariablesSize
 
ImageSamplerPointer m_ImageSampler
 
bool m_InterpolatorIsBSpline
 
bool m_InterpolatorIsBSplineFloat
 
bool m_InterpolatorIsLinear
 
bool m_InterpolatorIsReducedBSpline
 
LinearInterpolatorPointer m_LinearInterpolator
 
MovingImageLimiterPointer m_MovingImageLimiter
 
MovingImageLimiterOutputType m_MovingImageMaxLimit
 
MovingImageLimiterOutputType m_MovingImageMinLimit
 
MovingImagePixelType m_MovingImageTrueMax
 
MovingImagePixelType m_MovingImageTrueMin
 
ReducedBSplineInterpolatorPointer m_ReducedBSplineInterpolator
 
MultiThreaderParameterType m_ThreaderMetricParameters
 
bool m_TransformIsAdvanced
 
bool m_TransformIsBSpline
 
bool m_UseMetricSingleThreaded
 
bool m_UseMultiThread
 
bool m_UseOpenMP
 

Member Typedef Documentation

template<class TFixedImage, class TMovingImage>
typedef NumericTraits< MeasureType >::AccumulateType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::AccumulateType
private
template<class TFixedImage, class TMovingImage>
typedef Superclass::BSplineInterpolatorType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::BSplineInterpolatorType
protected
template<class TFixedImage, class TMovingImage>
typedef Superclass::CentralDifferenceGradientFilterType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::CentralDifferenceGradientFilterType
protected
template<class TFixedImage, class TMovingImage>
typedef SmartPointer< const Self > itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer
template<class TFixedImage, class TMovingImage>
typedef Superclass::CoordinateRepresentationType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::CoordinateRepresentationType

Typedefs from the superclass.

Definition at line 106 of file itkAdvancedNormalizedCorrelationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage>
typedef Superclass::DerivativeType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::DerivativeType
template<class TFixedImage, class TMovingImage>
typedef Superclass::DerivativeValueType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::DerivativeValueType
template<class TFixedImage, class TMovingImage>
typedef Superclass::FixedImageConstPointer itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer
template<class TFixedImage, class TMovingImage>
typedef Superclass::FixedImageIndexType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageIndexType
protected

Protected Typedefs Typedefs inherited from superclass

Definition at line 202 of file itkAdvancedNormalizedCorrelationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage>
typedef Superclass::FixedImageIndexValueType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageIndexValueType
protected
template<class TFixedImage, class TMovingImage>
typedef Superclass::FixedImageLimiterOutputType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageLimiterOutputType
template<class TFixedImage, class TMovingImage>
typedef Superclass::FixedImageLimiterType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageLimiterType
template<class TFixedImage, class TMovingImage>
typedef Superclass::FixedImageMaskPointer itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskPointer
template<class TFixedImage, class TMovingImage>
typedef Superclass::FixedImageMaskType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageMaskType
template<class TFixedImage, class TMovingImage>
typedef Superclass::FixedImagePixelType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePixelType
template<class TFixedImage, class TMovingImage>
typedef Superclass::FixedImagePointType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePointType
protected
template<class TFixedImage, class TMovingImage>
typedef Superclass::FixedImageRegionType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageRegionType
template<class TFixedImage, class TMovingImage>
typedef Superclass::FixedImageType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType
template<class TFixedImage, class TMovingImage>
typedef Superclass::GradientImageFilterPointer itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GradientImageFilterPointer
template<class TFixedImage, class TMovingImage>
typedef Superclass::GradientImageFilterType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GradientImageFilterType
template<class TFixedImage, class TMovingImage>
typedef Superclass::GradientImagePointer itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GradientImagePointer
template<class TFixedImage, class TMovingImage>
typedef Superclass::GradientImageType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GradientImageType
template<class TFixedImage, class TMovingImage>
typedef Superclass::GradientPixelType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GradientPixelType
template<class TFixedImage, class TMovingImage>
typedef Superclass::ImageSampleContainerPointer itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ImageSampleContainerPointer
template<class TFixedImage, class TMovingImage>
typedef Superclass::ImageSampleContainerType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ImageSampleContainerType
template<class TFixedImage, class TMovingImage>
typedef Superclass::ImageSamplerPointer itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ImageSamplerPointer
template<class TFixedImage, class TMovingImage>
typedef Superclass::ImageSamplerType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ImageSamplerType
template<class TFixedImage, class TMovingImage>
typedef Superclass::InputPointType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::InputPointType
template<class TFixedImage, class TMovingImage>
typedef Superclass::InterpolatorPointer itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorPointer
template<class TFixedImage, class TMovingImage>
typedef Superclass::InterpolatorType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorType
template<class TFixedImage, class TMovingImage>
typedef Superclass::MeasureType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MeasureType
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImageConstPointer itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointer
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImageContinuousIndexType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageContinuousIndexType
protected
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImageDerivativeScalesType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageDerivativeScalesType
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImageDerivativeType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageDerivativeType
protected
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImageIndexType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageIndexType
protected
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImageLimiterOutputType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageLimiterOutputType
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImageLimiterType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageLimiterType
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImageMaskPointer itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskPointer
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImageMaskType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageMaskType
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImagePixelType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePixelType
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImagePointType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePointType
protected
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImageRegionType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageRegionType
template<class TFixedImage, class TMovingImage>
typedef Superclass::MovingImageType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType
template<class TFixedImage, class TMovingImage>
typedef Superclass::NonZeroJacobianIndicesType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::NonZeroJacobianIndicesType
protected
template<class TFixedImage, class TMovingImage>
typedef Superclass::NumberOfParametersType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::NumberOfParametersType
template<class TFixedImage, class TMovingImage>
typedef Superclass::OutputPointType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::OutputPointType
template<class TFixedImage, class TMovingImage>
typedef Superclass::ParametersType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ParametersType
template<class TFixedImage, class TMovingImage>
typedef SmartPointer< Self > itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::Pointer
template<class TFixedImage, class TMovingImage>
typedef Superclass::RealType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::RealType
template<class TFixedImage, class TMovingImage>
typedef AdvancedNormalizedCorrelationImageToImageMetric itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::Self

Standard class typedefs.

Definition at line 96 of file itkAdvancedNormalizedCorrelationImageToImageMetric.h.

template<class TFixedImage, class TMovingImage>
typedef AdvancedImageToImageMetric< TFixedImage, TMovingImage > itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::Superclass
template<class TFixedImage, class TMovingImage>
typedef Superclass::ThreaderType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ThreaderType
template<class TFixedImage, class TMovingImage>
typedef Superclass::ThreadInfoType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ThreadInfoType
template<class TFixedImage, class TMovingImage>
typedef Superclass::TransformJacobianType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType
template<class TFixedImage, class TMovingImage>
typedef Superclass::TransformParametersType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::TransformParametersType
template<class TFixedImage, class TMovingImage>
typedef Superclass::TransformPointer itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer
template<class TFixedImage, class TMovingImage>
typedef Superclass::TransformType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Constructor & Destructor Documentation

template<class TFixedImage, class TMovingImage>
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::AdvancedNormalizedCorrelationImageToImageMetric ( )
protected
template<class TFixedImage, class TMovingImage>
virtual itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::~AdvancedNormalizedCorrelationImageToImageMetric ( )
protectedvirtual
template<class TFixedImage, class TMovingImage>
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::AdvancedNormalizedCorrelationImageToImageMetric ( const Self )
private

Member Function Documentation

template<class TFixedImage, class TMovingImage>
static ITK_THREAD_RETURN_TYPE itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::AccumulateDerivativesThreaderCallback ( void *  arg)
staticprotected

AccumulateDerivatives threader callback function

template<class TFixedImage, class TMovingImage>
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::AfterThreadedGetValueAndDerivative ( MeasureType value,
DerivativeType derivative 
) const
inlineprotectedvirtual

Gather the values and derivatives from all threads

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

template<class TFixedImage, class TMovingImage>
virtual const char* itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

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

Reimplemented in elastix::AdvancedNormalizedCorrelationMetric< TElastix >.

template<class TFixedImage, class TMovingImage>
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative ( const TransformParametersType parameters,
DerivativeType derivative 
) const

Get the derivatives of the match measure.

template<class TFixedImage, class TMovingImage>
virtual const bool& itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GetSubtractMean ( )
virtual
template<class TFixedImage, class TMovingImage>
MeasureType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GetValue ( const TransformParametersType parameters) const

Get the value for single valued optimizers.

template<class TFixedImage, class TMovingImage>
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivative ( const TransformParametersType parameters,
MeasureType value,
DerivativeType derivative 
) const
template<class TFixedImage, class TMovingImage>
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivativeSingleThreaded ( const TransformParametersType parameters,
MeasureType value,
DerivativeType derivative 
) const

Get value and derivatives for multiple valued optimizers.

template<class TFixedImage, class TMovingImage>
virtual void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::InitializeThreadingParameters ( void  ) const
protectedvirtual

Initialize some multi-threading related parameters. Overrides function in AdvancedImageToImageMetric, because here we use other parameters.

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

template<class TFixedImage, class TMovingImage>
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::itkAlignedTypedef ( ITK_CACHE_LINE_ALIGNMENT  ,
PaddedCorrelationGetValueAndDerivativePerThreadStruct  ,
AlignedCorrelationGetValueAndDerivativePerThreadStruct   
)
private
template<class TFixedImage, class TMovingImage>
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::itkPadStruct ( ITK_CACHE_LINE_ALIGNMENT  ,
CorrelationGetValueAndDerivativePerThreadStruct  ,
PaddedCorrelationGetValueAndDerivativePerThreadStruct   
)
private
template<class TFixedImage, class TMovingImage>
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro ( FixedImageDimension  ,
unsigned  int,
FixedImageType::ImageDimension   
)

The fixed image dimension.

template<class TFixedImage, class TMovingImage>
itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::itkStaticConstMacro ( MovingImageDimension  ,
unsigned  int,
MovingImageType::ImageDimension   
)

The moving image dimension.

template<class TFixedImage, class TMovingImage>
static Pointer itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::New ( )
static

Method for creation through the object factory.

template<class TFixedImage, class TMovingImage>
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::operator= ( const Self )
private
template<class TFixedImage, class TMovingImage>
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protected
template<class TFixedImage, class TMovingImage>
virtual void itk::AdvancedNormalizedCorrelationImageToImageMetric< 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 function. Default value is false.

template<class TFixedImage, class TMovingImage>
virtual void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::SubtractMeanOff ( )
virtual
template<class TFixedImage, class TMovingImage>
virtual void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::SubtractMeanOn ( )
virtual
template<class TFixedImage, class TMovingImage>
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ThreadedGetValueAndDerivative ( ThreadIdType  threadID)
inlineprotectedvirtual

Get value and derivatives for each thread.

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

template<class TFixedImage, class TMovingImage>
void itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::UpdateDerivativeTerms ( const RealType fixedImageValue,
const RealType movingImageValue,
const DerivativeType imageJacobian,
const NonZeroJacobianIndicesType nzji,
DerivativeType derivativeF,
DerivativeType derivativeM,
DerivativeType differential 
) const
protected

Compute a pixel's contribution to the derivative terms; Called by GetValueAndDerivative().

Field Documentation

template<class TFixedImage, class TMovingImage>
AlignedCorrelationGetValueAndDerivativePerThreadStruct* itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::m_CorrelationGetValueAndDerivativePerThreadVariables
mutableprivate
template<class TFixedImage, class TMovingImage>
ThreadIdType itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::m_CorrelationGetValueAndDerivativePerThreadVariablesSize
mutableprivate
template<class TFixedImage, class TMovingImage>
bool itk::AdvancedNormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::m_SubtractMean
mutableprivate


Generated on 04-09-2015 for elastix by doxygen 1.8.9.1 elastix logo