ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference

#include <itkNormalizedCorrelationImageToImageMetric.h>

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

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 InputPointType = typename Superclass::InputPointType
 
using MeasureType = typename Superclass::MeasureType
 
using MovingImageConstPointer = typename Superclass::MovingImageConstPointer
 
using MovingImageType = typename Superclass::MovingImageType
 
using OutputPointType = typename Superclass::OutputPointType
 
using Pointer = SmartPointer< Self >
 
using RealType = typename Superclass::RealType
 
using Self = NormalizedCorrelationImageToImageMetric
 
using Superclass = ImageToImageMetric< 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::ImageToImageMetric< TFixedImage, TMovingImage >
using ConstPointer = SmartPointer< const Self >
 
using CoordinateRepresentationType = typename Superclass::ParametersValueType
 
using DerivativeType = typename Superclass::DerivativeType
 
using FixedImageConstPointer = typename FixedImageType::ConstPointer
 
using FixedImageIndexContainer = std::vector< FixedImageIndexType >
 
using FixedImageIndexType = typename FixedImageType::IndexType
 
using FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType
 
using FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer
 
using FixedImageMaskPointer = typename FixedImageMaskType::Pointer
 
using FixedImageMaskType = SpatialObject< Self::FixedImageDimension >
 
using FixedImagePixelType = typename TFixedImage::PixelType
 
using FixedImagePointType = typename TransformType::InputPointType
 
using FixedImageRegionType = typename FixedImageType::RegionType
 
using FixedImageType = TFixedImage
 
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 = typename Superclass::MeasureType
 
using MovingImageConstPointer = typename MovingImageType::ConstPointer
 
using MovingImageIndexType = typename MovingImageType::IndexType
 
using MovingImageMaskConstPointer = typename MovingImageMaskType::ConstPointer
 
using MovingImageMaskPointer = typename MovingImageMaskType::Pointer
 
using MovingImageMaskType = SpatialObject< Self::MovingImageDimension >
 
using MovingImagePixelType = typename TMovingImage::PixelType
 
using MovingImagePointType = typename TransformType::OutputPointType
 
using MovingImageType = TMovingImage
 
using OutputPointType = typename TransformType::OutputPointType
 
using ParametersType = typename Superclass::ParametersType
 
using Pointer = SmartPointer< Self >
 
using RealType = typename NumericTraits< MovingImagePixelType >::RealType
 
using Self = ImageToImageMetric
 
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::FixedImageDimension >
 
using MultiThreaderType = MultiThreaderBase
 
- 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
 
- Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void SetFixedImage (const FixedImageType *_arg)
 
virtual const FixedImageTypeGetFixedImage () const
 
virtual void SetMovingImage (const MovingImageType *_arg)
 
virtual const MovingImageTypeGetMovingImage () const
 
virtual void SetTransform (TransformType *_arg)
 
virtual TransformTypeGetModifiableTransform ()
 
virtual const TransformTypeGetTransform () const
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual const InterpolatorTypeGetInterpolator () const
 
SizeValueType GetNumberOfMovingImageSamples ()
 
virtual const SizeValueTypeGetNumberOfPixelsCounted () const
 
virtual void SetFixedImageRegion (const FixedImageRegionType reg)
 
virtual const FixedImageRegionTypeGetFixedImageRegion () const
 
virtual void SetMovingImageMask (MovingImageMaskType *_arg)
 
virtual void SetMovingImageMask (const MovingImageMaskType *_arg)
 
virtual const MovingImageMaskTypeGetMovingImageMask () const
 
virtual void SetFixedImageMask (FixedImageMaskType *_arg)
 
virtual void SetFixedImageMask (const FixedImageMaskType *_arg)
 
virtual const FixedImageMaskTypeGetFixedImageMask () const
 
void SetFixedImageIndexes (const FixedImageIndexContainer &indexes)
 
void SetUseFixedImageIndexes (bool useIndex)
 
virtual const bool & GetUseFixedImageIndexes () const
 
void SetNumberOfWorkUnits (ThreadIdType numberOfThreads)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
virtual void SetComputeGradient (bool _arg)
 
virtual const bool & GetComputeGradient () const
 
virtual void ComputeGradientOn ()
 
virtual void ComputeGradientOff ()
 
virtual void ComputeGradient ()
 
virtual GradientImageTypeGetModifiableGradientImage ()
 
virtual const GradientImageTypeGetGradientImage () const
 
void SetTransformParameters (const ParametersType &parameters) const
 
unsigned int GetNumberOfParameters () const override
 
virtual void Initialize ()
 
virtual void MultiThreadingInitialize ()
 
virtual void SetNumberOfFixedImageSamples (SizeValueType numSamples)
 
virtual const SizeValueTypeGetNumberOfFixedImageSamples () const
 
void SetNumberOfSpatialSamples (SizeValueType num)
 
SizeValueType GetNumberOfSpatialSamples ()
 
void SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh)
 
virtual const FixedImagePixelTypeGetFixedImageSamplesIntensityThreshold () const
 
void SetUseFixedImageSamplesIntensityThreshold (bool useThresh)
 
virtual const bool & GetUseFixedImageSamplesIntensityThreshold () const
 
void SetUseAllPixels (bool useAllPixels)
 
void UseAllPixelsOn ()
 
void UseAllPixelsOff ()
 
virtual const bool & GetUseAllPixels () const
 
void SetUseSequentialSampling (bool sequentialSampling)
 
virtual const bool & GetUseSequentialSampling () const
 
void ReinitializeSeed ()
 
void ReinitializeSeed (int seed)
 
virtual void SetUseCachingOfBSplineWeights (bool _arg)
 
virtual const bool & GetUseCachingOfBSplineWeights () const
 
virtual void UseCachingOfBSplineWeightsOn ()
 
virtual void UseCachingOfBSplineWeightsOff ()
 
virtual MultiThreaderTypeGetModifiableThreader ()
 
virtual const MultiThreaderTypeGetThreader () const
 
const TransformPointerGetThreaderTransform ()
 
- 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
 
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
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 ()
 
bool m_SubtractMean
 
virtual void SetSubtractMean (bool _arg)
 
virtual const bool & GetSubtractMean () const
 
virtual void SubtractMeanOn ()
 
virtual void SubtractMeanOff ()
 
 NormalizedCorrelationImageToImageMetric ()
 
 ~NormalizedCorrelationImageToImageMetric () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static constexpr unsigned int FixedImageDimension = TFixedImage::ImageDimension
 
static constexpr unsigned int MovingImageDimension = TMovingImage::ImageDimension
 
- Protected Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
using FixedImageSampleContainer = std::vector< FixedImageSamplePoint >
 
using BSplineTransformType = BSplineBaseTransform< CoordinateRepresentationType, FixedImageType ::ImageDimension, Self::DeformationSplineOrder >
 
using BSplineTransformWeightsType = typename BSplineTransformType::WeightsType
 
using WeightsValueType = typename BSplineTransformWeightsType::ValueType
 
using BSplineTransformWeightsArrayType = Array2D< WeightsValueType >
 
using BSplineTransformIndexArrayType = typename BSplineTransformType::ParameterIndexArrayType
 
using IndexValueType = typename BSplineTransformIndexArrayType::ValueType
 
using BSplineTransformIndicesArrayType = Array2D< IndexValueType >
 
using MovingImagePointArrayType = std::vector< MovingImagePointType >
 
using BooleanArrayType = std::vector< bool >
 
using BSplineParametersOffsetType = FixedArray< SizeValueType, FixedImageType ::ImageDimension >
 
using BSplineInterpolatorType = BSplineInterpolateImageFunction< MovingImageType, CoordinateRepresentationType >
 
using DerivativeFunctionType = CentralDifferenceImageFunction< MovingImageType, CoordinateRepresentationType >
 
using ImageDerivativesType = CovariantVector< double, Self::MovingImageDimension >
 
- Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
 ImageToImageMetric ()
 
 ~ImageToImageMetric () override
 
virtual void SampleFixedImageRegion (FixedImageSampleContainer &samples) const
 
virtual void SampleFixedImageIndexes (FixedImageSampleContainer &samples) const
 
virtual void SampleFullFixedImageRegion (FixedImageSampleContainer &samples) const
 
virtual void PreComputeTransformValues ()
 
virtual void TransformPoint (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ThreadIdType threadId) const
 
virtual void TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleWithinSupportRegion, double &movingImageValue, ImageDerivativesType &gradient, ThreadIdType threadId) const
 
virtual void ComputeImageDerivatives (const MovingImagePointType &mappedPoint, ImageDerivativesType &gradient, ThreadIdType threadId) const
 
void GetValueMultiThreadedInitiate () const
 
void GetValueMultiThreadedPostProcessInitiate () const
 
virtual void GetValueThread (ThreadIdType threadId) const
 
virtual void GetValueThreadPreProcess (ThreadIdType, bool) const
 
virtual bool GetValueThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double) const
 
virtual void GetValueThreadPostProcess (ThreadIdType, bool) const
 
void GetValueAndDerivativeMultiThreadedInitiate () const
 
void GetValueAndDerivativeMultiThreadedPostProcessInitiate () const
 
virtual void GetValueAndDerivativeThread (ThreadIdType threadId) const
 
virtual void GetValueAndDerivativeThreadPreProcess (ThreadIdType, bool) const
 
virtual bool GetValueAndDerivativeThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double, const ImageDerivativesType &) const
 
virtual void GetValueAndDerivativeThreadPostProcess (ThreadIdType, bool) const
 
virtual void SynchronizeTransforms () const
 
- 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 ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueMultiThreaded (void *arg)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueMultiThreadedPostProcess (void *arg)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueAndDerivativeMultiThreaded (void *arg)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueAndDerivativeMultiThreadedPostProcess (void *arg)
 
- Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
bool m_UseFixedImageIndexes { false }
 
FixedImageIndexContainer m_FixedImageIndexes
 
bool m_UseFixedImageSamplesIntensityThreshold { false }
 
FixedImagePixelType m_FixedImageSamplesIntensityThreshold
 
FixedImageSampleContainer m_FixedImageSamples
 
SizeValueType m_NumberOfParameters { 0 }
 
SizeValueType m_NumberOfFixedImageSamples { 50000 }
 
SizeValueType m_NumberOfPixelsCounted { 0 }
 
FixedImageConstPointer m_FixedImage
 
MovingImageConstPointer m_MovingImage
 
TransformPointer m_Transform
 
TransformPointerm_ThreaderTransform
 
InterpolatorPointer m_Interpolator
 
bool m_ComputeGradient { true }
 
GradientImagePointer m_GradientImage
 
FixedImageMaskConstPointer m_FixedImageMask
 
MovingImageMaskConstPointer m_MovingImageMask
 
ThreadIdType m_NumberOfWorkUnits { 1 }
 
bool m_UseAllPixels { false }
 
bool m_UseSequentialSampling { false }
 
bool m_ReseedIterator { false }
 
int m_RandomSeed
 
bool m_TransformIsBSpline { false }
 
SizeValueType m_NumBSplineWeights { 0 }
 
BSplineTransformType::Pointer m_BSplineTransform
 
BSplineTransformWeightsArrayType m_BSplineTransformWeightsArray
 
BSplineTransformIndicesArrayType m_BSplineTransformIndicesArray
 
MovingImagePointArrayType m_BSplinePreTransformPointsArray
 
BooleanArrayType m_WithinBSplineSupportRegionArray
 
BSplineParametersOffsetType m_BSplineParametersOffset
 
bool m_UseCachingOfBSplineWeights { true }
 
BSplineTransformWeightsType m_BSplineTransformWeights
 
BSplineTransformIndexArrayType m_BSplineTransformIndices
 
BSplineTransformWeightsTypem_ThreaderBSplineTransformWeights
 
BSplineTransformIndexArrayTypem_ThreaderBSplineTransformIndices
 
bool m_InterpolatorIsBSpline { false }
 
BSplineInterpolatorType::Pointer m_BSplineInterpolator
 
DerivativeFunctionType::Pointer m_DerivativeCalculator
 
MultiThreaderType::Pointer m_Threader
 
ConstantPointerWrapperm_ConstSelfWrapper
 
unsigned int * m_ThreaderNumberOfMovingImageSamples { nullptr }
 
bool m_WithinThreadPreProcess { false }
 
bool m_WithinThreadPostProcess { false }
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 
- Static Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static constexpr unsigned int DeformationSplineOrder = 3
 

Detailed Description

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

Computes similarity between two images to be registered.

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.

A more negative metric value indicates a greater degree of correlation between the fixed and moving image. This makes the metric simpler to use with optimizers that strive to minimize their cost function by default.

Definition at line 46 of file itkNormalizedCorrelationImageToImageMetric.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer = SmartPointer<const Self>

Definition at line 55 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ DerivativeType

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::DerivativeType = typename Superclass::DerivativeType

Definition at line 74 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ FixedImageConstPointer

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer = typename Superclass::FixedImageConstPointer

Definition at line 77 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ FixedImageType

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType = typename Superclass::FixedImageType

Definition at line 75 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ GradientPixelType

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::GradientPixelType = typename Superclass::GradientPixelType

Definition at line 69 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ InputPointType

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::InputPointType = typename Superclass::InputPointType

Definition at line 71 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ MeasureType

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MeasureType = typename Superclass::MeasureType

Definition at line 73 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ MovingImageConstPointer

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointer = typename Superclass::MovingImageConstPointer

Definition at line 78 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ MovingImageType

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType = typename Superclass::MovingImageType

Definition at line 76 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ OutputPointType

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::OutputPointType = typename Superclass::OutputPointType

Definition at line 70 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ Pointer

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::Pointer = SmartPointer<Self>

Definition at line 54 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ RealType

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::RealType = typename Superclass::RealType

Types transferred from the base class

Definition at line 64 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ Self

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

Standard class type aliases.

Definition at line 52 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ Superclass

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::Superclass = ImageToImageMetric<TFixedImage, TMovingImage>

Definition at line 53 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ TransformJacobianType

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType = typename Superclass::TransformJacobianType

Definition at line 68 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ TransformParametersType

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::TransformParametersType = typename Superclass::TransformParametersType

Definition at line 67 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ TransformPointer

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer = typename Superclass::TransformPointer

Definition at line 66 of file itkNormalizedCorrelationImageToImageMetric.h.

◆ TransformType

template<typename TFixedImage , typename TMovingImage >
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::TransformType = typename Superclass::TransformType

Definition at line 65 of file itkNormalizedCorrelationImageToImageMetric.h.

Constructor & Destructor Documentation

◆ NormalizedCorrelationImageToImageMetric()

template<typename TFixedImage , typename TMovingImage >
itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::NormalizedCorrelationImageToImageMetric ( )
protected

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.

◆ ~NormalizedCorrelationImageToImageMetric()

template<typename TFixedImage , typename TMovingImage >
itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::~NormalizedCorrelationImageToImageMetric ( )
overrideprotecteddefault

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 Function Documentation

◆ CreateAnother()

template<typename TFixedImage , typename TMovingImage >
virtual::itk::LightObject::Pointer itk::NormalizedCorrelationImageToImageMetric< 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.

◆ GetDerivative()

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

Get the derivatives of the match measure.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

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

◆ GetSubtractMean()

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

◆ GetValue()

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

Get the value for single valued optimizers.

◆ GetValueAndDerivative()

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

Get value and derivatives for multiple valued optimizers.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

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.

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

◆ SetSubtractMean()

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

◆ SubtractMeanOff()

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

◆ SubtractMeanOn()

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

Member Data Documentation

◆ m_SubtractMean

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

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.

Definition at line 110 of file itkNormalizedCorrelationImageToImageMetric.h.


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