Base class for cost functions intended to be used with Optimizers. More...

#include <itkCostFunction.h>

Inheritance diagram for itk::CostFunction:

Collaboration diagram for itk::CostFunction:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef OptimizerParameters < ParametersValueType >	ParametersType
typedef double	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef CostFunction	Self
typedef Object	Superclass
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfParameters (void) const =0
Protected Member Functions
	CostFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~CostFunction ()
Private Member Functions
	CostFunction (const Self &)
void	operator= (const Self &)

Detailed Description

Base class for cost functions intended to be used with Optimizers.

Definition at line 36 of file itkCostFunction.h.

Member Typedef Documentation

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

Reimplemented from itk::Object.

Definition at line 43 of file itkCostFunction.h.

typedef OptimizerParameters< ParametersValueType > itk::CostFunction::ParametersType

Reimplemented in itk::CumulativeGaussianCostFunction, itk::MultipleValuedCostFunction, itk::SingleValuedCostFunction, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ObjectToObjectMetric, itk::SingleValuedCostFunctionv4, itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::JointHistogramMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::PointSetToPointSetMetricv4< TPointSet, TPointSet >.

Definition at line 51 of file itkCostFunction.h.

typedef double itk::CostFunction::ParametersValueType

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

Reimplemented in itk::SingleValuedCostFunction, itk::ObjectToObjectMetric, itk::SingleValuedCostFunctionv4, itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, and itk::JointHistogramMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >.

Definition at line 46 of file itkCostFunction.h.

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

Reimplemented from itk::Object.

Definition at line 42 of file itkCostFunction.h.

typedef CostFunction itk::CostFunction::Self

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 40 of file itkCostFunction.h.

typedef Object itk::CostFunction::Superclass

Reimplemented from itk::Object.

Definition at line 41 of file itkCostFunction.h.

Constructor & Destructor Documentation

itk::CostFunction::CostFunction ( ) [inline, protected]

Definition at line 59 of file itkCostFunction.h.

virtual itk::CostFunction::~CostFunction ( ) [inline, protected, virtual]

Definition at line 60 of file itkCostFunction.h.

itk::CostFunction::CostFunction ( const Self & ) [private]

Member Function Documentation

virtual const char* itk::CostFunction::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Object.

virtual unsigned int itk::CostFunction::GetNumberOfParameters ( void ) 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::CumulativeGaussianCostFunction, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ObjectToObjectMetric, itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, and itk::PointSetToPointSetMetricv4< TPointSet, TPointSet >.

void itk::CostFunction::operator= ( const Self & ) [private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

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

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

itkCostFunction.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation