itk::CostFunctionTemplate< TInternalComputationValueType > Class Template Reference

#include <itkCostFunction.h>

Detailed Description

template<typename TInternalComputationValueType>
class itk::CostFunctionTemplate< TInternalComputationValueType >

Definition at line 36 of file itkCostFunction.h.

Inheritance diagram for itk::CostFunctionTemplate< TInternalComputationValueType >:

Collaboration diagram for itk::CostFunctionTemplate< TInternalComputationValueType >:

Public Types
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
const char *	GetNameOfClass () const override
virtual unsigned int	GetNumberOfParameters () const =0
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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
const char *	GetNameOfClass () const override
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) 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 Pointer	CreateAnother () const
virtual void	Delete ()
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const noexcept

Protected Member Functions
	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
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	PrintSelf (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 val)
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

ConstPointer

template<typename TInternalComputationValueType >

using itk::CostFunctionTemplate< TInternalComputationValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 45 of file itkCostFunction.h.

ParametersType

template<typename TInternalComputationValueType >

using itk::CostFunctionTemplate< TInternalComputationValueType >::ParametersType = OptimizerParameters<TInternalComputationValueType>

Definition at line 53 of file itkCostFunction.h.

ParametersValueType

template<typename TInternalComputationValueType >

using itk::CostFunctionTemplate< TInternalComputationValueType >::ParametersValueType = TInternalComputationValueType

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

Definition at line 52 of file itkCostFunction.h.

Pointer

template<typename TInternalComputationValueType >

using itk::CostFunctionTemplate< TInternalComputationValueType >::Pointer = SmartPointer<Self>

Definition at line 44 of file itkCostFunction.h.

Self

template<typename TInternalComputationValueType >

using itk::CostFunctionTemplate< TInternalComputationValueType >::Self = CostFunctionTemplate

Standard class type aliases.

Definition at line 42 of file itkCostFunction.h.

Superclass

template<typename TInternalComputationValueType >

using itk::CostFunctionTemplate< TInternalComputationValueType >::Superclass = Object

Definition at line 43 of file itkCostFunction.h.

Constructor & Destructor Documentation

CostFunctionTemplate()

template<typename TInternalComputationValueType >

itk::CostFunctionTemplate< TInternalComputationValueType >::CostFunctionTemplate ( )

protecteddefault

~CostFunctionTemplate()

template<typename TInternalComputationValueType >

itk::CostFunctionTemplate< TInternalComputationValueType >::~CostFunctionTemplate ( )

overrideprotecteddefault

Member Function Documentation

GetNameOfClass()

template<typename TInternalComputationValueType >

const char * itk::CostFunctionTemplate< TInternalComputationValueType >::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::Object.

Reimplemented in itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TFixedImage, double >, itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, Image< double, TFixedDimension >, double >, itk::ObjectToObjectMetricBaseTemplate< double >, itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >, itk::SingleValuedCostFunctionv4Template< double >, itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TFixedPointSet, double >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, double >, itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >, and itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, double >.

GetNumberOfParameters()

template<typename TInternalComputationValueType >

virtual unsigned int itk::CostFunctionTemplate< TInternalComputationValueType >::GetNumberOfParameters ( ) const

pure virtual

Return the number of parameters required to compute this cost function. This method MUST be overloaded by derived classes.

Implemented in itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::CumulativeGaussianCostFunction, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >, itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TFixedImage, double >, itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, Image< double, TFixedDimension >, double >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >, and itk::ObjectToObjectMetricBaseTemplate< double >.

PrintSelf()

template<typename TInternalComputationValueType >

void itk::CostFunctionTemplate< TInternalComputationValueType >::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::Object.

Reimplemented in itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TFixedImage, double >, itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, Image< double, TFixedDimension >, double >, itk::ObjectToObjectMetricBaseTemplate< double >, itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >, itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >, and itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, double >.

---

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

• itkCostFunction.h