itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage > Class Template Reference
[Similarity Metrics of Registration Methods]

#include <itkNormalizedCorrelationPointSetToImageMetric.h>

Inheritance diagram for itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >:

[legend]Collaboration diagram for itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >:

[legend]List of all members.

---

Detailed Description

template<class TFixedPointSet, class TMovingImage>
class itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >

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

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

Definition at line 43 of file itkNormalizedCorrelationPointSetToImageMetric.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ParametersValueType	CoordinateRepresentationType
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::FixedPointSetConstPointer	FixedPointSetConstPointer
typedef Superclass::FixedPointSetType	FixedPointSetType
typedef GradientImageFilterType::Pointer	GradientImageFilterPointer
typedef GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType >	GradientImageFilterType
typedef SmartPointer< GradientImageType >	GradientImagePointer
typedef Image< GradientPixelType, itkGetStaticConstMacro(MovingImageDimension)	GradientImageType )
typedef Superclass::GradientPixelType	GradientPixelType
typedef TransformType::InputPointType	InputPointType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef InterpolateImageFunction< MovingImageType, CoordinateRepresentationType >	InterpolatorType
typedef Superclass::MeasureType	MeasureType
typedef Superclass::MovingImageConstPointer	MovingImageConstPointer
typedef TMovingImage::PixelType	MovingImagePixelType
typedef Superclass::MovingImageType	MovingImageType
typedef TransformType::OutputPointType	OutputPointType
typedef Superclass::ParametersType	ParametersType
typedef double	ParametersValueType
typedef Superclass::PointDataIterator	PointDataIterator
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointIterator	PointIterator
typedef Superclass::RealType	RealType
typedef NormalizedCorrelationPointSetToImageMetric	Self
typedef PointSetToImageMetric< TFixedPointSet, TMovingImage >	Superclass
typedef Superclass::TransformJacobianType	TransformJacobianType
typedef Superclass::TransformParametersType	TransformParametersType
typedef Superclass::TransformPointer	TransformPointer
typedef Superclass::TransformType	TransformType
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
virtual const bool &	GetComputeGradient ()
bool	GetDebug () const
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
void	GetDerivative (const TransformParametersType &parameters, DerivativeType &Derivative) const
virtual const FixedPointSetType *	GetFixedPointSet ()
virtual const GradientImageType *	GetGradientImage ()
virtual InterpolatorType *	GetInterpolator ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual const MovingImageType *	GetMovingImage ()
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
unsigned int	GetNumberOfParameters (void) const
virtual const unsigned long &	GetNumberOfPixelsCounted ()
virtual int	GetReferenceCount () const
virtual const bool &	GetSubtractMean ()
virtual TransformType *	GetTransform ()
virtual MeasureType	GetValue (const ParametersType &parameters) const =0
MeasureType	GetValue (const TransformParametersType &parameters) const
This method returns the value and derivative of the cost function corresponding *to the specified parameters *virtual void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
void	GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
bool	HasObserver (const EventObject &event) const
virtual void	Initialize (void) throw ( ExceptionObject )
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (FixedPointSetDimension, unsigned int, TFixedPointSet::PointDimension)
Constants for the image dimensions *	itkStaticConstMacro (MovingImageDimension, unsigned int, TMovingImage::ImageDimension)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
virtual void	SetFixedPointSet (const FixedPointSetType *_arg)
virtual void	SetInterpolator (InterpolatorType *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetMovingImage (const MovingImageType *_arg)
virtual void	SetReferenceCount (int)
Set Get SubtractMean boolean If the sample mean is subtracted *from the sample values in the cross correlation formula and *typically results in narrower valleys in the cost fucntion *Default value is false *virtual void	SetSubtractMean (bool _arg)
virtual void	SetTransform (TransformType *_arg)
void	SetTransformParameters (const ParametersType &parameters) const
virtual void	SubtractMeanOff ()
virtual void	SubtractMeanOn ()
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Set Get SubtractMean boolean If	true
Protected Member Functions
	NormalizedCorrelationPointSetToImageMetric ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~NormalizedCorrelationPointSetToImageMetric ()
Protected Attributes
bool	m_ComputeGradient
FixedPointSetConstPointer	m_FixedPointSet
GradientImagePointer	m_GradientImage
InterpolatorPointer	m_Interpolator
MovingImageConstPointer	m_MovingImage
unsigned long	m_NumberOfPixelsCounted
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
TransformPointer	m_Transform
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

template<class TFixedPointSet, class TMovingImage> typedef SmartPointer<const Self> itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::ConstPointer

Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 53 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::ParametersValueType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::CoordinateRepresentationType [inherited]

Type used for representing point components Definition at line 57 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::DerivativeType itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::DerivativeType

Type of the derivative. Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 71 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::FixedPointSetConstPointer itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::FixedPointSetConstPointer

Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 74 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::FixedPointSetType itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::FixedPointSetType

Type of the fixed Image. Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 72 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef GradientImageFilterType::Pointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientImageFilterPointer [inherited]

Definition at line 108 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType > itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientImageFilterType [inherited]

Definition at line 107 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef SmartPointer<GradientImageType> itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientImagePointer [inherited]

Definition at line 104 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Image<GradientPixelType, itkGetStaticConstMacro(MovingImageDimension) itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientImageType) [inherited]

Definition at line 103 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::GradientPixelType itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::GradientPixelType

Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 68 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef TransformType::InputPointType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::InputPointType [inherited]

Definition at line 87 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef InterpolatorType::Pointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::InterpolatorPointer [inherited]

Definition at line 112 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef InterpolateImageFunction< MovingImageType, CoordinateRepresentationType > itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::InterpolatorType [inherited]

Type of the Interpolator Base class Definition at line 95 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::MeasureType itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::MeasureType

Type of the measure. Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 70 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::MovingImageConstPointer itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::MovingImageConstPointer

Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 75 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef TMovingImage::PixelType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::MovingImagePixelType [inherited]

Definition at line 64 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::MovingImageType itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::MovingImageType

Type of the moving Image. Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 73 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef TransformType::OutputPointType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::OutputPointType [inherited]

Definition at line 88 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::ParametersType itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::ParametersType [inherited]

Type of the parameters. Reimplemented from itk::SingleValuedCostFunction. Definition at line 121 of file itkPointSetToImageMetric.h.

typedef double itk::CostFunction::ParametersValueType [inherited]

ParametersType typedef. It defines a position in the optimization search space. Definition at line 46 of file itkCostFunction.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::PointDataIterator itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::PointDataIterator

Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 78 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef SmartPointer<Self> itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::Pointer

Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 52 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::PointIterator itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::PointIterator

Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 77 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::RealType itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::RealType

Types transferred from the base class Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 59 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef NormalizedCorrelationPointSetToImageMetric itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::Self

Standard class typedefs. Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 49 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef PointSetToImageMetric<TFixedPointSet, TMovingImage > itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::Superclass

Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 50 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::TransformJacobianType itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformJacobianType

Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 67 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::TransformParametersType itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformParametersType

Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 66 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::TransformPointer itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformPointer

Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 65 of file itkNormalizedCorrelationPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> typedef Superclass::TransformType itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::TransformType

Type of the Transform Base class Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >. Definition at line 64 of file itkNormalizedCorrelationPointSetToImageMetric.h.

---

Constructor & Destructor Documentation

template<class TFixedPointSet, class TMovingImage> itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::NormalizedCorrelationPointSetToImageMetric (   )  [protected]

template<class TFixedPointSet, class TMovingImage> virtual itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::~NormalizedCorrelationPointSetToImageMetric (   )  [inline, protected, virtual]

Definition at line 103 of file itkNormalizedCorrelationPointSetToImageMetric.h.

---

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

template<class TFixedPointSet, class TMovingImage> virtual const bool& itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetComputeGradient (   )  [virtual, inherited]

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

virtual void itk::SingleValuedCostFunction::GetDerivative (  const ParametersType &  parameters, DerivativeType &  derivative )  const [pure virtual, inherited]

This method returns the derivative of the cost function corresponding to the specified parameters. Implemented in itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

template<class TFixedPointSet, class TMovingImage> void itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::GetDerivative (  const TransformParametersType &  parameters, DerivativeType &  Derivative )  const

Get the derivatives of the match measure.

template<class TFixedPointSet, class TMovingImage> virtual const FixedPointSetType* itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetFixedPointSet (   )  [virtual, inherited]

Get the Fixed Image.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

template<class TFixedPointSet, class TMovingImage> virtual const GradientImageType* itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetGradientImage (   )  [virtual, inherited]

Get Gradient Image.

template<class TFixedPointSet, class TMovingImage> virtual InterpolatorType* itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetInterpolator (   )  [virtual, inherited]

Get a pointer to the Interpolator.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

template<class TFixedPointSet, class TMovingImage> virtual const MovingImageType* itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetMovingImage (   )  [virtual, inherited]

Get the Moving Image.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class TFixedPointSet, class TMovingImage> virtual const char* itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >.

template<class TFixedPointSet, class TMovingImage> unsigned int itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetNumberOfParameters (  void   )  const [inline, virtual, inherited]

Return the number of parameters required by the Transform Implements itk::CostFunction. Definition at line 168 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> virtual const unsigned long& itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetNumberOfPixelsCounted (   )  [virtual, inherited]

Get the number of pixels considered in the computation.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<class TFixedPointSet, class TMovingImage> virtual const bool& itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::GetSubtractMean (   )  [virtual]

template<class TFixedPointSet, class TMovingImage> virtual TransformType* itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::GetTransform (   )  [virtual, inherited]

Get a pointer to the Transform.

virtual MeasureType itk::SingleValuedCostFunction::GetValue (  const ParametersType &  parameters  )  const [pure virtual, inherited]

This method returns the value of the cost function corresponding to the specified parameters. Implemented in itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

template<class TFixedPointSet, class TMovingImage> MeasureType itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::GetValue (  const TransformParametersType &  parameters  )  const

Get the value for single valued optimizers.

This method returns the value and derivative of the cost function corresponding* to the specified parameters* virtual void itk::SingleValuedCostFunction::GetValueAndDerivative (  const ParametersType &  parameters, MeasureType &  value, DerivativeType &  derivative )  const [inline, virtual, inherited]

Reimplemented in itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 71 of file itkSingleValuedCostFunction.h.

template<class TFixedPointSet, class TMovingImage> void itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::GetValueAndDerivative (  const TransformParametersType &  parameters, MeasureType &  Value, DerivativeType &  Derivative )  const

Get value and derivatives for multiple valued optimizers.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

template<class TFixedPointSet, class TMovingImage> virtual void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::Initialize (  void   )  throw ( ExceptionObject ) [virtual, inherited]

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

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

template<class TFixedPointSet, class TMovingImage> itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::itkStaticConstMacro (  FixedPointSetDimension  , unsigned  int, TFixedPointSet::PointDimension  )  [inherited]

template<class TFixedPointSet, class TMovingImage> Constants for the image dimensions* itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::itkStaticConstMacro (  MovingImageDimension  , unsigned  int, TMovingImage::ImageDimension  )  [inherited]

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TFixedPointSet, class TMovingImage> static Pointer itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

template<class TFixedPointSet, class TMovingImage> void itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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::PointSetToImageMetric< TFixedPointSet, TMovingImage >.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<class TFixedPointSet, class TMovingImage> virtual void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::SetFixedPointSet (  const FixedPointSetType *  _arg  )  [virtual, inherited]

Connect the Fixed Image.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TFixedPointSet, class TMovingImage> virtual void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::SetInterpolator (  InterpolatorType *  _arg  )  [virtual, inherited]

Connect the Interpolator.

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

template<class TFixedPointSet, class TMovingImage> virtual void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::SetMovingImage (  const MovingImageType *  _arg  )  [virtual, inherited]

Connect the Moving Image.

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

template<class TFixedPointSet, class TMovingImage> Set Get SubtractMean boolean If the sample mean is subtracted* from the sample values in the cross correlation formula and* typically results in narrower valleys in the cost fucntion* Default value is false* virtual void itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::SetSubtractMean (  bool  _arg  )  [virtual]

template<class TFixedPointSet, class TMovingImage> virtual void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::SetTransform (  TransformType *  _arg  )  [virtual, inherited]

Connect the Transform.

template<class TFixedPointSet, class TMovingImage> void itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::SetTransformParameters (  const ParametersType &  parameters  )  const [inherited]

Set the parameters defining the Transform.

template<class TFixedPointSet, class TMovingImage> virtual void itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::SubtractMeanOff (   )  [virtual]

template<class TFixedPointSet, class TMovingImage> virtual void itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::SubtractMeanOn (   )  [virtual]

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

template<class TFixedPointSet, class TMovingImage> bool itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_ComputeGradient [protected, inherited]

Definition at line 188 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> FixedPointSetConstPointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_FixedPointSet [protected, inherited]

Definition at line 182 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> GradientImagePointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_GradientImage [protected, inherited]

Definition at line 189 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> InterpolatorPointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_Interpolator [protected, inherited]

Definition at line 186 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> MovingImageConstPointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_MovingImage [protected, inherited]

Definition at line 183 of file itkPointSetToImageMetric.h.

template<class TFixedPointSet, class TMovingImage> unsigned long itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_NumberOfPixelsCounted [mutable, protected, inherited]

Definition at line 180 of file itkPointSetToImageMetric.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

template<class TFixedPointSet, class TMovingImage> TransformPointer itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >::m_Transform [mutable, protected, inherited]

Definition at line 185 of file itkPointSetToImageMetric.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

template<class TFixedPointSet, class TMovingImage> Set Get SubtractMean boolean If itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >::true

Definition at line 92 of file itkNormalizedCorrelationPointSetToImageMetric.h.

---

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

• itkNormalizedCorrelationPointSetToImageMetric.h

---