itk::SingleValuedCostFunction Class Reference
[Numerics, Optimizers]

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

#include <itkSingleValuedCostFunction.h>

Inheritance diagram for itk::SingleValuedCostFunction:

[legend]Collaboration diagram for itk::SingleValuedCostFunction:

[legend]List of all members.

Public Types
typedef SingleValuedCostFunction	Self
typedef CostFunction	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef double	MeasureType
typedef Array< double >	DerivativeType
typedef Superclass::ParametersType	ParametersType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual MeasureType	GetValue (const ParametersType &parameters) const=0
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const=0
virtual void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
Protected Member Functions
	SingleValuedCostFunction ()
virtual	~SingleValuedCostFunction ()

---

Detailed Description

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

Definition at line 35 of file itkSingleValuedCostFunction.h.

---

Member Typedef Documentation

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

Reimplemented from itk::CostFunction. Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >. Definition at line 43 of file itkSingleValuedCostFunction.h.

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

DerivativeType typedef. It defines a type used to return the cost function derivative. Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, and itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >. Definition at line 54 of file itkSingleValuedCostFunction.h. Referenced by GetValueAndDerivative().

typedef double itk::SingleValuedCostFunction::MeasureType

MeasureType typedef. It defines a type used to return the cost function value. Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >. Definition at line 50 of file itkSingleValuedCostFunction.h. Referenced by GetValueAndDerivative().

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::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, and itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >. Definition at line 58 of file itkSingleValuedCostFunction.h. Referenced by GetValueAndDerivative().

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

Reimplemented from itk::CostFunction. Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >. Definition at line 42 of file itkSingleValuedCostFunction.h.

typedef SingleValuedCostFunction itk::SingleValuedCostFunction::Self

Standard class typedefs. Reimplemented from itk::CostFunction. Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >. Definition at line 40 of file itkSingleValuedCostFunction.h. Referenced by ~SingleValuedCostFunction().

typedef CostFunction itk::SingleValuedCostFunction::Superclass

Reimplemented from itk::CostFunction. Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >. Definition at line 41 of file itkSingleValuedCostFunction.h.

---

Constructor & Destructor Documentation

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

Definition at line 81 of file itkSingleValuedCostFunction.h.

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

Definition at line 82 of file itkSingleValuedCostFunction.h. References Self.

---

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::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

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

Run-time type information (and related methods). Reimplemented from itk::CostFunction. Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

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::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

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::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >. Definition at line 71 of file itkSingleValuedCostFunction.h. References DerivativeType, MeasureType, and ParametersType.

---

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

• itkSingleValuedCostFunction.h

---