ITK  4.4.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::CostFunction Class Referenceabstract

#include <itkCostFunction.h>

+ Inheritance diagram for itk::CostFunction:
+ Collaboration diagram for itk::CostFunction:

Detailed Description

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

Definition at line 36 of file itkCostFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< ParametersValueType
ParametersType
 
typedef double ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef CostFunction Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfParameters (void) const =0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 CostFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~CostFunction ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

 CostFunction (const Self &)
 
void operator= (const Self &)
 

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 flag)
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

Definition at line 43 of file itkCostFunction.h.

Definition at line 51 of file itkCostFunction.h.

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

Definition at line 46 of file itkCostFunction.h.

Definition at line 42 of file itkCostFunction.h.

Standard class typedefs.

Definition at line 40 of file itkCostFunction.h.

Definition at line 41 of file itkCostFunction.h.

Constructor & Destructor Documentation

itk::CostFunction::CostFunction ( )
inlineprotected

Definition at line 59 of file itkCostFunction.h.

virtual itk::CostFunction::~CostFunction ( )
inlineprotectedvirtual

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.

Reimplemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TMetricTraits >, itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage >, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage >, itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage >, itk::ObjectToObjectMetric< TPointSet::PointDimension, TPointSet::PointDimension >, itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::DemonsImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::LabeledPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >, itk::CumulativeGaussianCostFunction, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::JointHistogramMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ObjectToObjectMetricBase, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::SingleValuedCostFunctionv4, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::MeanSquaresImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TMetricTraits >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MultipleValuedCostFunction, and itk::SingleValuedCostFunction.

virtual unsigned int itk::CostFunction::GetNumberOfParameters ( void  ) const
pure virtual
void itk::CostFunction::operator= ( const Self )
private
void itk::CostFunction::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TMetricTraits >, itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage >, itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage >, itk::ObjectToObjectMetric< TPointSet::PointDimension, TPointSet::PointDimension >, itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::JointHistogramMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage >, itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::ObjectToObjectMetricBase, itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::DemonsImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::LabeledPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::EuclideanDistancePointMetric< TFixedPointSet, TMovingPointSet, TDistanceMap >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::CumulativeGaussianCostFunction, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TMetricTraits >, and itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >.


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