Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::CostFunction Class Reference
[NumericsOptimizers]

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

#include <itkCostFunction.h>

Inheritance diagram for itk::CostFunction:

Inheritance graph
[legend]
Collaboration diagram for itk::CostFunction:

Collaboration graph
[legend]
List of all members.

Public Types

typedef CostFunction Self
typedef Object Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef double ParametersValueType
typedef Array< ParametersValueTypeParametersType

Public Member Functions

virtual const char * GetNameOfClass () const
virtual unsigned int GetNumberOfParameters (void) const=0

Protected Member Functions

 CostFunction ()
virtual ~CostFunction ()
void PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

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

Definition at line 35 of file itkCostFunction.h.


Member Typedef Documentation

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

Reimplemented from itk::Object.

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >, 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::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::CumulativeGaussianCostFunction, itk::MultipleValuedCostFunction, itk::SingleValuedCostFunction, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

Definition at line 42 of file itkCostFunction.h.

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

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::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::CumulativeGaussianCostFunction, itk::MultipleValuedCostFunction, and itk::SingleValuedCostFunction.

Definition at line 51 of file itkCostFunction.h.

typedef double itk::CostFunction::ParametersValueType
 

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

Definition at line 50 of file itkCostFunction.h.

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

Reimplemented from itk::Object.

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >, 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::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::CumulativeGaussianCostFunction, itk::MultipleValuedCostFunction, itk::SingleValuedCostFunction, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

Definition at line 41 of file itkCostFunction.h.

typedef CostFunction itk::CostFunction::Self
 

Standard class typedefs.

Reimplemented from itk::Object.

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >, 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::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::CumulativeGaussianCostFunction, itk::MultipleValuedCostFunction, itk::SingleValuedCostFunction, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

Definition at line 39 of file itkCostFunction.h.

typedef Object itk::CostFunction::Superclass
 

Reimplemented from itk::Object.

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >, 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::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::CumulativeGaussianCostFunction, itk::MultipleValuedCostFunction, itk::SingleValuedCostFunction, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

Definition at line 40 of file itkCostFunction.h.


Constructor & Destructor Documentation

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

Definition at line 61 of file itkCostFunction.h.

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

Definition at line 62 of file itkCostFunction.h.


Member Function Documentation

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >, 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::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::MultipleValuedCostFunction, itk::SingleValuedCostFunction, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

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::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::CumulativeGaussianCostFunction, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.

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.

Reimplemented in itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >, 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::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::CumulativeGaussianCostFunction, and itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >.


The documentation for this class was generated from the following file:
Generated at Thu May 25 00:42:36 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000