#include <itkSingleValuedCostFunction.h>

Inheritance diagram for itk::SingleValuedCostFunction:

Collaboration diagram for itk::SingleValuedCostFunction:

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 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
Protected Member Functions
	SingleValuedCostFunction ()
virtual	~SingleValuedCostFunction ()
Private Member Functions
void	operator= (const Self &)
	SingleValuedCostFunction (const Self &)

Detailed Description

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

Definition at line 33 of file itkSingleValuedCostFunction.h.

Member Typedef Documentation

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

Reimplemented from itk::CostFunction.

Definition at line 41 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 57 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 44 of file itkSingleValuedCostFunction.h.

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

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

Reimplemented from itk::CostFunction.

Reimplemented in itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, and itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 52 of file itkSingleValuedCostFunction.h.

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

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

Reimplemented from itk::CostFunction.

Definition at line 53 of file itkSingleValuedCostFunction.h.

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

Reimplemented from itk::CostFunction.

Definition at line 40 of file itkSingleValuedCostFunction.h.

typedef SingleValuedCostFunction itk::SingleValuedCostFunction::Self

Standard class typedefs.

Reimplemented from itk::CostFunction.

Definition at line 38 of file itkSingleValuedCostFunction.h.

typedef CostFunction itk::SingleValuedCostFunction::Superclass

Reimplemented from itk::CostFunction.

Definition at line 39 of file itkSingleValuedCostFunction.h.

Constructor & Destructor Documentation

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

Definition at line 80 of file itkSingleValuedCostFunction.h.

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

Definition at line 81 of file itkSingleValuedCostFunction.h.

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 >.

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

Run-time type information (and related methods).

Reimplemented from itk::CostFunction.

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 >.

virtual void itk::SingleValuedCostFunction::GetValueAndDerivative	(	const ParametersType &	parameters,
		MeasureType &	value,
		DerivativeType &	derivative
	)		const `[inline, 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 >, and itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 70 of file itkSingleValuedCostFunction.h.

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

Mutex lock to protect modification to the reference count

Reimplemented from itk::CostFunction.

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

itkSingleValuedCostFunction.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation