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

#include <itkMeanReciprocalSquareDifferencePointSetToImageMetric.h>

+ Inheritance diagram for itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >:
+ Collaboration diagram for itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = typename Superclass::DerivativeType
 
using FixedPointSetConstPointer = typename Superclass::FixedPointSetConstPointer
 
using FixedPointSetType = typename Superclass::FixedPointSetType
 
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 PointDataIterator = typename Superclass::PointDataIterator
 
using Pointer = SmartPointer< Self >
 
using PointIterator = typename Superclass::PointIterator
 
using RealType = typename Superclass::RealType
 
using Self = MeanReciprocalSquareDifferencePointSetToImageMetric
 
using Superclass = PointSetToImageMetric< TFixedPointSet, 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::PointSetToImageMetric< TFixedPointSet, TMovingImage >
using ConstPointer = SmartPointer< const Self >
 
using CoordinateRepresentationType = Superclass::ParametersValueType
 
using DerivativeType = Superclass::DerivativeType
 
using FixedPointSetConstPointer = typename FixedPointSetType::ConstPointer
 
using FixedPointSetType = TFixedPointSet
 
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 = Superclass::MeasureType
 
using MovingImageConstPointer = typename MovingImageType::ConstPointer
 
using MovingImagePixelType = typename TMovingImage::PixelType
 
using MovingImageType = TMovingImage
 
using OutputPointType = typename TransformType::OutputPointType
 
using ParametersType = Superclass::ParametersType
 
using PointDataIterator = typename FixedPointSetType::PointDataContainer::ConstIterator
 
using Pointer = SmartPointer< Self >
 
using PointIterator = typename FixedPointSetType::PointsContainer::ConstIterator
 
using RealType = typename NumericTraits< MovingImagePixelType >::RealType
 
using Self = PointSetToImageMetric
 
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::FixedPointSetDimension >
 
- 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::PointSetToImageMetric< TFixedPointSet, TMovingImage >
virtual void SetFixedPointSet (const FixedPointSetType *_arg)
 
virtual const FixedPointSetTypeGetFixedPointSet () 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
 
virtual GradientImageTypeGetModifiableGradientImage ()
 
virtual const GradientImageTypeGetGradientImage () const
 
virtual const SizeValueTypeGetNumberOfPixelsCounted () const
 
void SetTransformParameters (const ParametersType &parameters) const
 
virtual void SetComputeGradient (bool _arg)
 
virtual const bool & GetComputeGradient () const
 
unsigned int GetNumberOfParameters () const override
 
virtual void Initialize ()
 
- Public Member Functions inherited from itk::SingleValuedCostFunction
virtual void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
 
virtual MeasureType GetValue (const ParametersType &parameters) const =0
 
virtual void GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const 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 ()
 
double m_Lambda
 
virtual void SetLambda (double _arg)
 
virtual double GetLambda () const
 
 MeanReciprocalSquareDifferencePointSetToImageMetric ()
 
 ~MeanReciprocalSquareDifferencePointSetToImageMetric () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Static Public Attributes inherited from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >
static constexpr unsigned int FixedPointSetDimension = TFixedPointSet::PointDimension
 
static constexpr unsigned int MovingImageDimension = TMovingImage::ImageDimension
 
- Protected Member Functions inherited from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >
 PointSetToImageMetric ()
 
 ~PointSetToImageMetric () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::SingleValuedCostFunction
 SingleValuedCostFunction ()=default
 
 ~SingleValuedCostFunction () override
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 CostFunctionTemplate ()=default
 
 ~CostFunctionTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~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 ()
 
- Protected Attributes inherited from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >
SizeValueType m_NumberOfPixelsCounted
 
FixedPointSetConstPointer m_FixedPointSet
 
MovingImageConstPointer m_MovingImage
 
TransformPointer m_Transform
 
InterpolatorPointer m_Interpolator
 
bool m_ComputeGradient
 
GradientImagePointer m_GradientImage
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TFixedPointSet, typename TMovingImage>
class itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >

Computes similarity between pixel values of a point set and intensity values in an image.

This metric computes the average squared difference between pixels in the point set and transformed point set pixels in the moving image after passing the difference through a function of type $ \frac{1}{1+ \frac{ difference^2 }{ \lambda^2 } }$. $\lambda$ controls the capture radius of the metric. The term capture radius used here is in terms of intensity domain and not in the spatial domain.

Spatial correspondence between both images is established through a Transform.

Definition at line 46 of file itkMeanReciprocalSquareDifferencePointSetToImageMetric.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::ConstPointer = SmartPointer<const Self>

◆ DerivativeType

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::DerivativeType = typename Superclass::DerivativeType

◆ FixedPointSetConstPointer

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::FixedPointSetConstPointer = typename Superclass::FixedPointSetConstPointer

◆ FixedPointSetType

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::FixedPointSetType = typename Superclass::FixedPointSetType

◆ GradientPixelType

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientPixelType = typename Superclass::GradientPixelType

◆ InputPointType

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::InputPointType = typename Superclass::InputPointType

◆ MeasureType

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::MeasureType = typename Superclass::MeasureType

◆ MovingImageConstPointer

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::MovingImageConstPointer = typename Superclass::MovingImageConstPointer

◆ MovingImageType

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::MovingImageType = typename Superclass::MovingImageType

◆ OutputPointType

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::OutputPointType = typename Superclass::OutputPointType

◆ PointDataIterator

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::PointDataIterator = typename Superclass::PointDataIterator

◆ Pointer

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::Pointer = SmartPointer<Self>

◆ PointIterator

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::PointIterator = typename Superclass::PointIterator

◆ RealType

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::RealType = typename Superclass::RealType

Types transferred from the base class

Definition at line 65 of file itkMeanReciprocalSquareDifferencePointSetToImageMetric.h.

◆ Self

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::Self = MeanReciprocalSquareDifferencePointSetToImageMetric

Standard class type aliases.

Definition at line 53 of file itkMeanReciprocalSquareDifferencePointSetToImageMetric.h.

◆ Superclass

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::Superclass = PointSetToImageMetric<TFixedPointSet, TMovingImage>

◆ TransformJacobianType

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformJacobianType = typename Superclass::TransformJacobianType

◆ TransformParametersType

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformParametersType = typename Superclass::TransformParametersType

◆ TransformPointer

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformPointer = typename Superclass::TransformPointer

◆ TransformType

template<typename TFixedPointSet , typename TMovingImage >
using itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformType = typename Superclass::TransformType

Constructor & Destructor Documentation

◆ MeanReciprocalSquareDifferencePointSetToImageMetric()

template<typename TFixedPointSet , typename TMovingImage >
itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::MeanReciprocalSquareDifferencePointSetToImageMetric ( )
protected

Set/Get the lambda distance. (controls the capture radius of the metric).

◆ ~MeanReciprocalSquareDifferencePointSetToImageMetric()

template<typename TFixedPointSet , typename TMovingImage >
itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::~MeanReciprocalSquareDifferencePointSetToImageMetric ( )
overrideprotecteddefault

Set/Get the lambda distance. (controls the capture radius of the metric).

Member Function Documentation

◆ CreateAnother()

template<typename TFixedPointSet , typename TMovingImage >
virtual::itk::LightObject::Pointer itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, 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 TFixedPointSet , typename TMovingImage >
void itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::GetDerivative ( const TransformParametersType parameters,
DerivativeType Derivative 
) const
override

Get the derivatives of the match measure.

◆ GetLambda()

template<typename TFixedPointSet , typename TMovingImage >
virtual double itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::GetLambda ( ) const
virtual

Set/Get the lambda distance. (controls the capture radius of the metric).

◆ GetNameOfClass()

template<typename TFixedPointSet , typename TMovingImage >
virtual const char* itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >.

◆ GetValue()

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

Get the value for single valued optimizers.

◆ GetValueAndDerivative()

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

Get value and derivatives for multiple valued optimizers.

◆ New()

template<typename TFixedPointSet , typename TMovingImage >
static Pointer itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

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

Set/Get the lambda distance. (controls the capture radius of the metric).

Reimplemented from itk::CostFunctionTemplate< TInternalComputationValueType >.

◆ SetLambda()

template<typename TFixedPointSet , typename TMovingImage >
virtual void itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::SetLambda ( double  _arg)
virtual

Set/Get the lambda distance. (controls the capture radius of the metric).

Member Data Documentation

◆ m_Lambda

template<typename TFixedPointSet , typename TMovingImage >
double itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >::m_Lambda
private

Set/Get the lambda distance. (controls the capture radius of the metric).

Definition at line 111 of file itkMeanReciprocalSquareDifferencePointSetToImageMetric.h.


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