itk::SingleValuedCostFunction Class Reference

#include <itkSingleValuedCostFunction.h>

Inheritance diagram for itk::SingleValuedCostFunction:

Collaboration diagram for itk::SingleValuedCostFunction:

Detailed Description

This class is a base for the CostFunctions returning a single value.

Definition at line 34 of file itkSingleValuedCostFunction.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Array < ParametersValueType >	DerivativeType
typedef double	MeasureType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::ParametersValueType	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef SingleValuedCostFunction	Self
typedef CostFunction	Superclass
Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
typedef SmartPointer< const Self >	ConstPointer
typedef OptimizerParameters < TInternalComputationValueType >	ParametersType
typedef TInternalComputationValueType	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef CostFunctionTemplate	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
virtual const char *	GetNameOfClass () const
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::CostFunctionTemplate< TInternalComputationValueType >
virtual unsigned int	GetNumberOfParameters (void) const =0
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual LightObject::Pointer	CreateAnother () const override
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
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

Protected Member Functions
	SingleValuedCostFunction ()
virtual	~SingleValuedCostFunction ()
Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
	CostFunctionTemplate ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
virtual	~CostFunctionTemplate ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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 Member Functions
void	operator= (const Self &)
	SingleValuedCostFunction (const Self &)

Additional Inherited Members
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 ()
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

typedef SmartPointer< const Self > itk::SingleValuedCostFunction::ConstPointer

Definition at line 42 of file itkSingleValuedCostFunction.h.

typedef Array< ParametersValueType > itk::SingleValuedCostFunction::DerivativeType

DerivativeType typedef. It defines a type used to return the cost function derivative.

Definition at line 58 of file itkSingleValuedCostFunction.h.

typedef double itk::SingleValuedCostFunction::MeasureType

MeasureType typedef. It defines a type used to return the cost function value.

Definition at line 45 of file itkSingleValuedCostFunction.h.

typedef Superclass::ParametersType itk::SingleValuedCostFunction::ParametersType

ParametersType typedef. It defines a position in the optimization search space.

Definition at line 53 of file itkSingleValuedCostFunction.h.

typedef Superclass::ParametersValueType itk::SingleValuedCostFunction::ParametersValueType

Definition at line 54 of file itkSingleValuedCostFunction.h.

typedef SmartPointer< Self > itk::SingleValuedCostFunction::Pointer

Definition at line 41 of file itkSingleValuedCostFunction.h.

typedef SingleValuedCostFunction itk::SingleValuedCostFunction::Self

Standard class typedefs.

Definition at line 39 of file itkSingleValuedCostFunction.h.

typedef CostFunction itk::SingleValuedCostFunction::Superclass

Definition at line 40 of file itkSingleValuedCostFunction.h.

Constructor & Destructor Documentation

itk::SingleValuedCostFunction::SingleValuedCostFunction ( )

inlineprotected

Definition at line 76 of file itkSingleValuedCostFunction.h.

virtual itk::SingleValuedCostFunction::~SingleValuedCostFunction ( )

protectedvirtual

itk::SingleValuedCostFunction::SingleValuedCostFunction ( const Self &  )

private

Member Function Documentation

virtual void itk::SingleValuedCostFunction::GetDerivative ( const ParametersType &  parameters, DerivativeType &  derivative  ) const

pure virtual

This method returns the derivative of the cost function corresponding to the specified parameters.

Implemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >.

Examples:

Examples/RegistrationITKv3/ModelToImageRegistration1.cxx, and Examples/RegistrationITKv4/ModelToImageRegistration1.cxx.

virtual const char* itk::SingleValuedCostFunction::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::CostFunctionTemplate< TInternalComputationValueType >.

Reimplemented in itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >.

virtual MeasureType itk::SingleValuedCostFunction::GetValue ( const ParametersType &  parameters ) const

pure virtual

This method returns the value of the cost function corresponding to the specified parameters.

Implemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >.

Examples:

Examples/RegistrationITKv3/ModelToImageRegistration1.cxx, and Examples/RegistrationITKv4/ModelToImageRegistration1.cxx.

virtual void itk::SingleValuedCostFunction::GetValueAndDerivative ( const ParametersType &  parameters, MeasureType &  value, DerivativeType &  derivative  ) const

virtual

This method returns the value and derivative of the cost function corresponding to the specified parameters

Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, and itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >.

void itk::SingleValuedCostFunction::operator= ( const Self &  )

private

---

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

• itkSingleValuedCostFunction.h