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

#include <itkSingleValuedCostFunction.h>

+ Inheritance diagram for itk::SingleValuedCostFunction:
+ Collaboration diagram for itk::SingleValuedCostFunction:

Detailed Description

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

Definition at line 34 of file itkSingleValuedCostFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef Array
< ParametersValueType
typedef double MeasureType
typedef Superclass::ParametersType ParametersType
typedef SmartPointer< SelfPointer
typedef SingleValuedCostFunction Self
typedef CostFunction Superclass
- Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
typedef OptimizerParameters
< TInternalComputationValueType > 
typedef SmartPointer< SelfPointer
typedef CostFunctionTemplate 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 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
- Public Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
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 override
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary ()
const MetaDataDictionaryGetMetaDataDictionary () 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 override
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int) override
virtual void UnRegister () const noexceptoverride
virtual void SetObjectName (std::string _arg)
virtual const std::string & GetObjectName () 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

 SingleValuedCostFunction ()
virtual ~SingleValuedCostFunction () override
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 CostFunctionTemplate ()
virtual void PrintSelf (std::ostream &os, Indent indent) const override
virtual ~CostFunctionTemplate () override
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object () override
- 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 ()

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)
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
static Pointer New ()
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount

Member Typedef Documentation

Definition at line 42 of file itkSingleValuedCostFunction.h.

DerivativeType typedef. It defines a type used to return the cost function derivative.

Definition at line 58 of file itkSingleValuedCostFunction.h.

MeasureType typedef. It defines a type used to return the cost function value.

Definition at line 45 of file itkSingleValuedCostFunction.h.

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

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

Definition at line 53 of file itkSingleValuedCostFunction.h.

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

Definition at line 54 of file itkSingleValuedCostFunction.h.

Definition at line 41 of file itkSingleValuedCostFunction.h.

Standard class typedefs.

Definition at line 39 of file itkSingleValuedCostFunction.h.

Definition at line 40 of file itkSingleValuedCostFunction.h.

Constructor & Destructor Documentation

itk::SingleValuedCostFunction::SingleValuedCostFunction ( )

Definition at line 76 of file itkSingleValuedCostFunction.h.

virtual itk::SingleValuedCostFunction::~SingleValuedCostFunction ( )

Member Function Documentation

virtual void itk::SingleValuedCostFunction::GetDerivative ( const ParametersType parameters,
DerivativeType derivative 
) const
pure virtual
virtual const char* itk::SingleValuedCostFunction::GetNameOfClass ( ) const

Run-time type information (and related methods).

Reimplemented from itk::CostFunctionTemplate< TInternalComputationValueType >.

Reimplemented in itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::SingleImageCostFunction< TImage >, itk::TwoImageToOneImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::NormalizedCorrelationTwoImageToOneImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, and itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >.

virtual MeasureType itk::SingleValuedCostFunction::GetValue ( const ParametersType parameters) const
pure virtual
virtual void itk::SingleValuedCostFunction::GetValueAndDerivative ( const ParametersType parameters,
MeasureType value,
DerivativeType derivative 
) const

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