ITK 6.0.0
Insight Toolkit
 
Loading...
Searching...
No Matches
itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference

#include <itkGradientDifferenceImageToImageMetric.h>

Detailed Description

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

Computes similarity between two objects to be registered.

This Class is templated over the type of the Images to be compared and over the type of transformation and Interpolator to be used.

This metric computes the sum of squared differences between pixels in the derivatives of the moving and fixed images after passing the squared difference through a function of type \( \frac{1}{1+x} \).

Warning
THIS IMAGE METRIC IS CURRENTLY UNDER DEBUGGING. USE AT YOUR OWN RISK.

Spatial correspondence between both images is established through a Transform. Pixel values are taken from the Moving image. Their positions are mapped to the Fixed image and result in general in non-grid position on it. Values at these non-grid position of the Fixed image are interpolated using a user-selected Interpolator.

Implementation of this class is based on [49].

Examples
Examples/RegistrationITKv4/ImageRegistration18.cxx.

Definition at line 55 of file itkGradientDifferenceImageToImageMetric.h.

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

Public Types

using CastFixedImageFilterPointer = typename CastFixedImageFilterType::Pointer
 
using CastFixedImageFilterType = itk::CastImageFilter<FixedImageType, FixedGradientImageType>
 
using CastMovedImageFilterPointer = typename CastMovedImageFilterType::Pointer
 
using CastMovedImageFilterType = itk::CastImageFilter<TransformedMovingImageType, MovedGradientImageType>
 
using ConstPointer = SmartPointer<const Self>
 
using FixedGradientImageType = itk::Image<RealType, Self::FixedImageDimension>
 
using FixedGradientPixelType = typename FixedGradientImageType::PixelType
 
using FixedImageConstPointer
 
using FixedImagePixelType = typename TFixedImage::PixelType
 
using FixedImageType
 
using MovedGradientImageType = itk::Image<RealType, Self::MovedImageDimension>
 
using MovedGradientPixelType = typename MovedGradientImageType::PixelType
 
using MovedImagePixelType = typename TMovingImage::PixelType
 
using MovingImageConstPointer
 
using MovingImageType
 
using Pointer = SmartPointer<Self>
 
using RealType
 
using Self = GradientDifferenceImageToImageMetric
 
using Superclass = ImageToImageMetric<TFixedImage, TMovingImage>
 
using TransformedMovingImageType = itk::Image<FixedImagePixelType, Self::FixedImageDimension>
 
using TransformJacobianType
 
using TransformMovingImageFilterType = itk::ResampleImageFilter<MovingImageType, TransformedMovingImageType>
 
using TransformParametersType
 
using TransformPointer
 
using TransformType
 
- Public Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
using ConstPointer = SmartPointer<const Self>
 
using CoordinateRepresentationType = typename Superclass::ParametersValueType
 
using 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
 
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 MultiThreaderType = MultiThreaderBase
 
using OutputPointType = typename TransformType::OutputPointType
 
using 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>
 
- 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< double >
using ConstPointer
 
using ParametersType
 
using ParametersValueType
 
using Pointer
 
using Self
 
using Superclass
 
- 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
 
const char * GetNameOfClass () const override
 
MeasureType GetValue (const TransformParametersType &parameters) const override
 
void GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const override
 
void Initialize () override
 
virtual void SetDerivativeDelta (double _arg)
 
virtual const double & GetDerivativeDelta () const
 
- Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void ComputeGradient ()
 
virtual const FixedImageRegionTypeGetFixedImageRegion () const
 
virtual const FixedImagePixelTypeGetFixedImageSamplesIntensityThreshold () const
 
virtual const GradientImageTypeGetGradientImage () const
 
virtual const InterpolatorTypeGetInterpolator () const
 
virtual GradientImageTypeGetModifiableGradientImage ()
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual TransformTypeGetModifiableTransform ()
 
const char * GetNameOfClass () const override
 
SizeValueType GetNumberOfMovingImageSamples ()
 
unsigned int GetNumberOfParameters () const override
 
virtual const SizeValueTypeGetNumberOfPixelsCounted () const
 
SizeValueType GetNumberOfSpatialSamples ()
 
virtual const TransformTypeGetTransform () const
 
virtual const bool & GetUseAllPixels () const
 
virtual const bool & GetUseFixedImageIndexes () const
 
virtual const bool & GetUseFixedImageSamplesIntensityThreshold () const
 
virtual const bool & GetUseSequentialSampling () const
 
virtual void MultiThreadingInitialize ()
 
void SetFixedImageIndexes (const FixedImageIndexContainer &indexes)
 
virtual void SetFixedImageRegion (const FixedImageRegionType reg)
 
void SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh)
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
void SetNumberOfSpatialSamples (SizeValueType num)
 
virtual void SetTransform (TransformType *_arg)
 
void SetTransformParameters (const ParametersType &parameters) const
 
void SetUseAllPixels (bool useAllPixels)
 
void SetUseFixedImageIndexes (bool useIndexes)
 
void SetUseFixedImageSamplesIntensityThreshold (bool useThresh)
 
void SetUseSequentialSampling (bool useSequential)
 
void UseAllPixelsOff ()
 
void UseAllPixelsOn ()
 
virtual void SetFixedImage (const FixedImageType *_arg)
 
virtual const FixedImageTypeGetFixedImage () const
 
virtual void SetMovingImage (const MovingImageType *_arg)
 
virtual const MovingImageTypeGetMovingImage () const
 
virtual void SetMovingImageMask (const MovingImageMaskType *_arg)
 
virtual const MovingImageMaskTypeGetMovingImageMask () const
 
virtual void SetFixedImageMask (const FixedImageMaskType *_arg)
 
virtual const FixedImageMaskTypeGetFixedImageMask () const
 
void SetNumberOfWorkUnits (ThreadIdType numberOfWorkUnits)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
virtual void SetComputeGradient (bool _arg)
 
virtual const bool & GetComputeGradient () const
 
virtual void ComputeGradientOn ()
 
virtual void ComputeGradientOff ()
 
virtual void SetNumberOfFixedImageSamples (SizeValueType numSamples)
 
virtual const SizeValueTypeGetNumberOfFixedImageSamples () 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
 
const char * GetNameOfClass () const override
 
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 *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

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

Static Public Attributes

static constexpr unsigned int FixedImageDimension = TFixedImage::ImageDimension
 
static constexpr unsigned int MovedImageDimension = MovingImageType::ImageDimension
 
- 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

using FixedSobelFilter = NeighborhoodOperatorImageFilter<FixedGradientImageType, FixedGradientImageType>
 
using MovedSobelFilter = NeighborhoodOperatorImageFilter<MovedGradientImageType, MovedGradientImageType>
 
- Protected Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
using BooleanArrayType = std::vector<bool>
 
using BSplineInterpolatorType = BSplineInterpolateImageFunction<MovingImageType, CoordinateRepresentationType>
 
using BSplineParametersOffsetType = FixedArray<SizeValueType, FixedImageType::ImageDimension>
 
using BSplineTransformIndexArrayType = typename BSplineTransformType::ParameterIndexArrayType
 
using BSplineTransformIndicesArrayType = Array2D<IndexValueType>
 
using BSplineTransformType
 
using BSplineTransformWeightsArrayType = Array2D<WeightsValueType>
 
using BSplineTransformWeightsType = typename BSplineTransformType::WeightsType
 
using DerivativeFunctionType = CentralDifferenceImageFunction<MovingImageType, CoordinateRepresentationType>
 
using FixedImageSampleContainer = std::vector<FixedImageSamplePoint>
 
using ImageDerivativesType = CovariantVector<double, Self::MovingImageDimension>
 
using IndexValueType = typename BSplineTransformIndexArrayType::ValueType
 
using MovingImagePointArrayType = std::vector<MovingImagePointType>
 
using WeightsValueType = typename BSplineTransformWeightsType::ValueType
 

Protected Member Functions

MeasureType ComputeMeasure (const TransformParametersType &parameters, const double *subtractionFactor) const
 
void ComputeMovedGradientRange () const
 
void ComputeVariance () const
 
 GradientDifferenceImageToImageMetric ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GradientDifferenceImageToImageMetric () override=default
 
- Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual void ComputeImageDerivatives (const MovingImagePointType &mappedPoint, ImageDerivativesType &gradient, ThreadIdType threadId) const
 
void GetValueAndDerivativeMultiThreadedInitiate () const
 
void GetValueAndDerivativeMultiThreadedPostProcessInitiate () const
 
virtual void GetValueAndDerivativeThread (ThreadIdType threadId) const
 
virtual void GetValueAndDerivativeThreadPostProcess (ThreadIdType threadId, bool withinSampleThread) const
 
virtual void GetValueAndDerivativeThreadPreProcess (ThreadIdType threadId, bool withinSampleThread) const
 
virtual bool GetValueAndDerivativeThreadProcessSample (ThreadIdType threadId, SizeValueType fixedImageSample, const MovingImagePointType &mappedPoint, double movingImageValue, const ImageDerivativesType &movingImageGradientValue) const
 
 ImageToImageMetric ()
 
virtual void PreComputeTransformValues ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SampleFixedImageIndexes (FixedImageSampleContainer &samples) const
 
virtual void SampleFixedImageRegion (FixedImageSampleContainer &samples) const
 
virtual void SampleFullFixedImageRegion (FixedImageSampleContainer &samples) const
 
virtual void SynchronizeTransforms () const
 
virtual void TransformPoint (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleOk, double &movingImageValue, ThreadIdType threadId) const
 
virtual void TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleOk, double &movingImageValue, ImageDerivativesType &movingImageGradient, ThreadIdType threadId) const
 
 ~ImageToImageMetric () override=default
 
void GetValueMultiThreadedInitiate () const
 
void GetValueMultiThreadedPostProcessInitiate () const
 
virtual void GetValueThread (ThreadIdType threadId) const
 
virtual void GetValueThreadPreProcess (ThreadIdType threadId, bool withinSampleThread) const
 
virtual bool GetValueThreadProcessSample (ThreadIdType threadId, SizeValueType fixedImageSample, const MovingImagePointType &mappedPoint, double movingImageValue) const
 
virtual void GetValueThreadPostProcess (ThreadIdType threadId, bool withinSampleThread) const
 
- Protected Member Functions inherited from itk::SingleValuedCostFunction
 SingleValuedCostFunction ()=default
 
 ~SingleValuedCostFunction () override
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< double >
 CostFunctionTemplate ()=default
 
 CostFunctionTemplate ()=default
 
 ~CostFunctionTemplate () override=default
 
 ~CostFunctionTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

CastFixedImageFilterPointer m_CastFixedImageFilter {}
 
CastMovedImageFilterPointer m_CastMovedImageFilter {}
 
double m_DerivativeDelta {}
 
ZeroFluxNeumannBoundaryCondition< FixedGradientImageTypem_FixedBoundCond {}
 
FixedSobelFilter::Pointer m_FixedSobelFilters [Self::FixedImageDimension] {}
 
SobelOperator< FixedGradientPixelType, Self::FixedImageDimensionm_FixedSobelOperators [FixedImageDimension] {}
 
FixedGradientPixelType m_MaxFixedGradient [FixedImageDimension] {}
 
MovedGradientPixelType m_MaxMovedGradient [MovedImageDimension] {}
 
FixedGradientPixelType m_MinFixedGradient [FixedImageDimension] {}
 
MovedGradientPixelType m_MinMovedGradient [MovedImageDimension] {}
 
ZeroFluxNeumannBoundaryCondition< MovedGradientImageTypem_MovedBoundCond {}
 
MovedSobelFilter::Pointer m_MovedSobelFilters [Self::MovedImageDimension] {}
 
SobelOperator< MovedGradientPixelType, Self::MovedImageDimensionm_MovedSobelOperators [MovedImageDimension] {}
 
TransformMovingImageFilterType::Pointer m_TransformMovingImageFilter {}
 
MovedGradientPixelType m_Variance [FixedImageDimension] {}
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueAndDerivativeMultiThreaded (void *workunitInfoAsVoid)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueAndDerivativeMultiThreadedPostProcess (void *workunitInfoAsVoid)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueMultiThreaded (void *workunitInfoAsVoid)
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueMultiThreadedPostProcess (void *workunitInfoAsVoid)
 
- Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
BSplineInterpolatorType::Pointer m_BSplineInterpolator {}
 
BSplineParametersOffsetType m_BSplineParametersOffset {}
 
MovingImagePointArrayType m_BSplinePreTransformPointsArray {}
 
BSplineTransformType::Pointer m_BSplineTransform {}
 
BSplineTransformIndexArrayType m_BSplineTransformIndices {}
 
BSplineTransformIndicesArrayType m_BSplineTransformIndicesArray {}
 
BSplineTransformWeightsType m_BSplineTransformWeights {}
 
BSplineTransformWeightsArrayType m_BSplineTransformWeightsArray {}
 
bool m_ComputeGradient { true }
 
DerivativeFunctionType::Pointer m_DerivativeCalculator {}
 
FixedImageConstPointer m_FixedImage {}
 
FixedImageIndexContainer m_FixedImageIndexes {}
 
FixedImageMaskConstPointer m_FixedImageMask {}
 
FixedImageSampleContainer m_FixedImageSamples {}
 
FixedImagePixelType m_FixedImageSamplesIntensityThreshold {}
 
GradientImagePointer m_GradientImage {}
 
InterpolatorPointer m_Interpolator {}
 
MovingImageConstPointer m_MovingImage {}
 
MovingImageMaskConstPointer m_MovingImageMask {}
 
SizeValueType m_NumberOfFixedImageSamples { 50000 }
 
SizeValueType m_NumberOfParameters { 0 }
 
SizeValueType m_NumberOfPixelsCounted { 0 }
 
ThreadIdType m_NumberOfWorkUnits { 1 }
 
SizeValueType m_NumBSplineWeights { 0 }
 
int m_RandomSeed {}
 
bool m_ReseedIterator { false }
 
std::unique_ptr< BSplineTransformIndexArrayType[]> m_ThreaderBSplineTransformIndices
 
std::unique_ptr< BSplineTransformWeightsType[]> m_ThreaderBSplineTransformWeights
 
std::unique_ptr< TransformPointer[]> m_ThreaderTransform
 
TransformPointer m_Transform {}
 
bool m_UseAllPixels { false }
 
bool m_UseCachingOfBSplineWeights { true }
 
bool m_UseFixedImageIndexes { false }
 
bool m_UseFixedImageSamplesIntensityThreshold { false }
 
bool m_UseSequentialSampling { false }
 
BooleanArrayType m_WithinBSplineSupportRegionArray {}
 
MultiThreaderType::Pointer m_Threader {}
 
std::unique_ptr< ConstantPointerWrapperm_ConstSelfWrapper
 
std::unique_ptr< unsigned int[]> m_ThreaderNumberOfMovingImageSamples
 
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
 

Member Typedef Documentation

◆ CastFixedImageFilterPointer

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::CastFixedImageFilterPointer = typename CastFixedImageFilterType::Pointer

Definition at line 101 of file itkGradientDifferenceImageToImageMetric.h.

◆ CastFixedImageFilterType

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::CastFixedImageFilterType = itk::CastImageFilter<FixedImageType, FixedGradientImageType>

Definition at line 100 of file itkGradientDifferenceImageToImageMetric.h.

◆ CastMovedImageFilterPointer

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::CastMovedImageFilterPointer = typename CastMovedImageFilterType::Pointer

Definition at line 112 of file itkGradientDifferenceImageToImageMetric.h.

◆ CastMovedImageFilterType

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::CastMovedImageFilterType = itk::CastImageFilter<TransformedMovingImageType, MovedGradientImageType>

Definition at line 111 of file itkGradientDifferenceImageToImageMetric.h.

◆ ConstPointer

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

Definition at line 65 of file itkGradientDifferenceImageToImageMetric.h.

◆ FixedGradientImageType

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::FixedGradientImageType = itk::Image<RealType, Self::FixedImageDimension>

Sobel filters to compute the gradients of the Fixed Image

Definition at line 98 of file itkGradientDifferenceImageToImageMetric.h.

◆ FixedGradientPixelType

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::FixedGradientPixelType = typename FixedGradientImageType::PixelType

Definition at line 103 of file itkGradientDifferenceImageToImageMetric.h.

◆ FixedImageConstPointer

template<typename TFixedImage, typename TMovingImage>
using itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer

Definition at line 79 of file itkImageToImageMetric.h.

◆ FixedImagePixelType

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePixelType = typename TFixedImage::PixelType

Definition at line 87 of file itkGradientDifferenceImageToImageMetric.h.

◆ FixedImageType

template<typename TFixedImage, typename TMovingImage>
using itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType

Type of the fixed Image.

Definition at line 77 of file itkImageToImageMetric.h.

◆ FixedSobelFilter

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::FixedSobelFilter = NeighborhoodOperatorImageFilter<FixedGradientImageType, FixedGradientImageType>
protected

Definition at line 158 of file itkGradientDifferenceImageToImageMetric.h.

◆ MovedGradientImageType

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::MovedGradientImageType = itk::Image<RealType, Self::MovedImageDimension>

Definition at line 109 of file itkGradientDifferenceImageToImageMetric.h.

◆ MovedGradientPixelType

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::MovedGradientPixelType = typename MovedGradientImageType::PixelType

Definition at line 114 of file itkGradientDifferenceImageToImageMetric.h.

◆ MovedImagePixelType

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::MovedImagePixelType = typename TMovingImage::PixelType

Definition at line 88 of file itkGradientDifferenceImageToImageMetric.h.

◆ MovedSobelFilter

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::MovedSobelFilter = NeighborhoodOperatorImageFilter<MovedGradientImageType, MovedGradientImageType>
protected

Definition at line 160 of file itkGradientDifferenceImageToImageMetric.h.

◆ MovingImageConstPointer

template<typename TFixedImage, typename TMovingImage>
using itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointer

Definition at line 74 of file itkImageToImageMetric.h.

◆ MovingImageType

template<typename TFixedImage, typename TMovingImage>
using itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType

Type of the moving Image.

Definition at line 72 of file itkImageToImageMetric.h.

◆ Pointer

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

Definition at line 64 of file itkGradientDifferenceImageToImageMetric.h.

◆ RealType

template<typename TFixedImage, typename TMovingImage>
using itk::ImageToImageMetric< TFixedImage, TMovingImage >::RealType

Gaussian filter to compute the gradient of the Moving Image

Definition at line 108 of file itkImageToImageMetric.h.

◆ Self

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

Standard class type aliases.

Definition at line 61 of file itkGradientDifferenceImageToImageMetric.h.

◆ Superclass

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

Definition at line 62 of file itkGradientDifferenceImageToImageMetric.h.

◆ TransformedMovingImageType

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::TransformedMovingImageType = itk::Image<FixedImagePixelType, Self::FixedImageDimension>

Types for transforming the moving image

Definition at line 92 of file itkGradientDifferenceImageToImageMetric.h.

◆ TransformJacobianType

template<typename TFixedImage, typename TMovingImage>
using itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType

Definition at line 93 of file itkImageToImageMetric.h.

◆ TransformMovingImageFilterType

template<typename TFixedImage, typename TMovingImage>
using itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::TransformMovingImageFilterType = itk::ResampleImageFilter<MovingImageType, TransformedMovingImageType>

Definition at line 94 of file itkGradientDifferenceImageToImageMetric.h.

◆ TransformParametersType

template<typename TFixedImage, typename TMovingImage>
using itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformParametersType

Definition at line 92 of file itkImageToImageMetric.h.

◆ TransformPointer

template<typename TFixedImage, typename TMovingImage>
using itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer

Definition at line 89 of file itkImageToImageMetric.h.

◆ TransformType

template<typename TFixedImage, typename TMovingImage>
using itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Type of the Transform Base class

Definition at line 87 of file itkImageToImageMetric.h.

Constructor & Destructor Documentation

◆ GradientDifferenceImageToImageMetric()

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

Referenced by GetNameOfClass().

◆ ~GradientDifferenceImageToImageMetric()

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

Member Function Documentation

◆ ComputeMeasure()

template<typename TFixedImage, typename TMovingImage>
MeasureType itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::ComputeMeasure ( const TransformParametersType & parameters,
const double * subtractionFactor ) const
protected

Compute the similarity measure using a specified subtraction factor.

◆ ComputeMovedGradientRange()

template<typename TFixedImage, typename TMovingImage>
void itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::ComputeMovedGradientRange ( ) const
protected

Compute the range of the moved image gradients.

◆ ComputeVariance()

template<typename TFixedImage, typename TMovingImage>
void itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::ComputeVariance ( ) const
protected

Compute the variance and range of the moving image gradients.

◆ CreateAnother()

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

◆ GetDerivative()

template<typename TFixedImage, typename TMovingImage>
void itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative ( const TransformParametersType & parameters,
DerivativeType & derivative ) const
override

Get the derivatives of the similarity measure.

◆ GetDerivativeDelta()

template<typename TFixedImage, typename TMovingImage>
virtual const double & itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::GetDerivativeDelta ( ) const
virtual

Set/Get the value of Delta used for computing derivatives by finite differences in the GetDerivative() method

◆ GetNameOfClass()

template<typename TFixedImage, typename TMovingImage>
const char * itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::GetNameOfClass ( ) const
overridevirtual

◆ GetValue()

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

Get the value of the similarity measure for single valued optimizers.

◆ GetValueAndDerivative()

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

Get value and derivatives of the similarity measure for multiple valued optimizers.

◆ Initialize()

template<typename TFixedImage, typename TMovingImage>
void itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::Initialize ( )
overridevirtual

Initialize the Metric by making sure that all the components are present and plugged together correctly.

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

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

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

Reimplemented from itk::CostFunctionTemplate< double >.

◆ SetDerivativeDelta()

template<typename TFixedImage, typename TMovingImage>
virtual void itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::SetDerivativeDelta ( double _arg)
virtual

Set/Get the value of Delta used for computing derivatives by finite differences in the GetDerivative() method

Member Data Documentation

◆ FixedImageDimension

template<typename TFixedImage, typename TMovingImage>
unsigned int itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::FixedImageDimension = TFixedImage::ImageDimension
staticconstexpr

Definition at line 90 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_CastFixedImageFilter

template<typename TFixedImage, typename TMovingImage>
CastFixedImageFilterPointer itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_CastFixedImageFilter {}
private

The Sobel gradients of the fixed image

Definition at line 178 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_CastMovedImageFilter

template<typename TFixedImage, typename TMovingImage>
CastMovedImageFilterPointer itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_CastMovedImageFilter {}
private

The Sobel gradients of the moving image

Definition at line 188 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_DerivativeDelta

template<typename TFixedImage, typename TMovingImage>
double itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_DerivativeDelta {}
private

Definition at line 194 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_FixedBoundCond

template<typename TFixedImage, typename TMovingImage>
ZeroFluxNeumannBoundaryCondition<FixedGradientImageType> itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_FixedBoundCond {}
private

Definition at line 185 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_FixedSobelFilters

template<typename TFixedImage, typename TMovingImage>
FixedSobelFilter::Pointer itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_FixedSobelFilters[Self::FixedImageDimension] {}
private

Definition at line 182 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_FixedSobelOperators

template<typename TFixedImage, typename TMovingImage>
SobelOperator<FixedGradientPixelType, Self::FixedImageDimension> itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_FixedSobelOperators[FixedImageDimension] {}
private

Definition at line 180 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_MaxFixedGradient

template<typename TFixedImage, typename TMovingImage>
FixedGradientPixelType itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_MaxFixedGradient[FixedImageDimension] {}
mutableprivate

Definition at line 172 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_MaxMovedGradient

template<typename TFixedImage, typename TMovingImage>
MovedGradientPixelType itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_MaxMovedGradient[MovedImageDimension] {}
mutableprivate

Definition at line 168 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_MinFixedGradient

template<typename TFixedImage, typename TMovingImage>
FixedGradientPixelType itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_MinFixedGradient[FixedImageDimension] {}
mutableprivate

The range of the fixed image gradients.

Definition at line 171 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_MinMovedGradient

template<typename TFixedImage, typename TMovingImage>
MovedGradientPixelType itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_MinMovedGradient[MovedImageDimension] {}
mutableprivate

The range of the moving image gradients.

Definition at line 167 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_MovedBoundCond

template<typename TFixedImage, typename TMovingImage>
ZeroFluxNeumannBoundaryCondition<MovedGradientImageType> itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_MovedBoundCond {}
private

Definition at line 184 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_MovedSobelFilters

template<typename TFixedImage, typename TMovingImage>
MovedSobelFilter::Pointer itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_MovedSobelFilters[Self::MovedImageDimension] {}
private

Definition at line 192 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_MovedSobelOperators

template<typename TFixedImage, typename TMovingImage>
SobelOperator<MovedGradientPixelType, Self::MovedImageDimension> itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_MovedSobelOperators[MovedImageDimension] {}
private

Definition at line 190 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_TransformMovingImageFilter

template<typename TFixedImage, typename TMovingImage>
TransformMovingImageFilterType::Pointer itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_TransformMovingImageFilter {}
private

The filter for transforming the moving image.

Definition at line 175 of file itkGradientDifferenceImageToImageMetric.h.

◆ m_Variance

template<typename TFixedImage, typename TMovingImage>
MovedGradientPixelType itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::m_Variance[FixedImageDimension] {}
mutableprivate

The variance of the moving image gradients.

Definition at line 164 of file itkGradientDifferenceImageToImageMetric.h.

◆ MovedImageDimension

template<typename TFixedImage, typename TMovingImage>
unsigned int itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >::MovedImageDimension = MovingImageType::ImageDimension
staticconstexpr

Sobel filters to compute the gradients of the Moved Image

Definition at line 107 of file itkGradientDifferenceImageToImageMetric.h.


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