itk::MultipleValuedCostFunction Class Reference

#include <itkMultipleValuedCostFunction.h>

Inheritance diagram for itk::MultipleValuedCostFunction:

Collaboration diagram for itk::MultipleValuedCostFunction:

Detailed Description

This class is a base for the CostFunctions returning a multiple values.

Definition at line 35 of file itkMultipleValuedCostFunction.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	DerivativeType = Array2D< double >
using	MeasureType = Array< double >
using	ParametersType = Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	Self = MultipleValuedCostFunction
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 void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfValues () const =0
virtual MeasureType	GetValue (const ParametersType &parameters) const =0
Public Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
virtual unsigned int	GetNumberOfParameters () const =0
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
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
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
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

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

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
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

using itk::MultipleValuedCostFunction::ConstPointer = SmartPointer< const Self >

Definition at line 45 of file itkMultipleValuedCostFunction.h.

using itk::MultipleValuedCostFunction::DerivativeType = Array2D< double >

GradientType type alias. It defines a type used to return the cost function derivative.

Definition at line 60 of file itkMultipleValuedCostFunction.h.

using itk::MultipleValuedCostFunction::MeasureType = Array< double >

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

Definition at line 56 of file itkMultipleValuedCostFunction.h.

using itk::MultipleValuedCostFunction::ParametersType = Superclass::ParametersType

ParametersType type alias. It defines a position in the optimization search space.

Definition at line 52 of file itkMultipleValuedCostFunction.h.

using itk::MultipleValuedCostFunction::Pointer = SmartPointer< Self >

Definition at line 44 of file itkMultipleValuedCostFunction.h.

using itk::MultipleValuedCostFunction::Self = MultipleValuedCostFunction

Standard class type aliases.

Definition at line 42 of file itkMultipleValuedCostFunction.h.

using itk::MultipleValuedCostFunction::Superclass = CostFunction

Definition at line 43 of file itkMultipleValuedCostFunction.h.

Constructor & Destructor Documentation

itk::MultipleValuedCostFunction::MultipleValuedCostFunction ( )

protecteddefault

itk::MultipleValuedCostFunction::~MultipleValuedCostFunction ( )

overrideprotected

Member Function Documentation

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

pure virtual

This method returns the derivative of the cost function corresponding to the specified parameters This method MUST be overloaded by derived classes

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::CostFunctionTemplate< TInternalComputationValueType >.

Reimplemented in itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >, itk::CumulativeGaussianCostFunction, and itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >.

virtual unsigned int itk::MultipleValuedCostFunction::GetNumberOfValues ( ) const

pure virtual

Return the number of values that are computed by the multivalued cost function. This method MUST be overloaded by derived classes

Implemented in itk::CumulativeGaussianCostFunction, and itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >.

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

pure virtual

This method returns the value of the cost function corresponding to the specified parameters. This method MUST be overloaded by derived classes

Implemented in itk::CumulativeGaussianCostFunction.

---

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

• itkMultipleValuedCostFunction.h