Loading [MathJax]/extensions/tex2jax.js
ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members

#include <itkSingleValuedCostFunction.h>

Detailed Description

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

Definition at line 34 of file itkSingleValuedCostFunction.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = Array< ParametersValueType >
 
using MeasureType = double
 
using ParametersType = Superclass::ParametersType
 
using ParametersValueType = Superclass::ParametersValueType
 
using Pointer = SmartPointer< Self >
 
using Self = SingleValuedCostFunction
 
using Superclass = CostFunction
 
- Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using ParametersType = OptimizerParameters< TInternalComputationValueType >
 
using ParametersValueType = TInternalComputationValueType
 
using Pointer = SmartPointer< Self >
 
using Self = CostFunctionTemplate
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
 
const char * GetNameOfClass () const override
 
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 () const =0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 SingleValuedCostFunction ()=default
 
 ~SingleValuedCostFunction () override
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 CostFunctionTemplate ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~CostFunctionTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

Definition at line 43 of file itkSingleValuedCostFunction.h.

◆ DerivativeType

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

Examples
Examples/RegistrationITKv4/ModelToImageRegistration1.cxx.

Definition at line 59 of file itkSingleValuedCostFunction.h.

◆ MeasureType

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

Examples
Examples/RegistrationITKv4/ModelToImageRegistration1.cxx.

Definition at line 50 of file itkSingleValuedCostFunction.h.

◆ ParametersType

using itk::SingleValuedCostFunction::ParametersType = Superclass::ParametersType

ParametersType type alias. It defines a position in the optimization search space.

Examples
Examples/RegistrationITKv4/ModelToImageRegistration1.cxx.

Definition at line 54 of file itkSingleValuedCostFunction.h.

◆ ParametersValueType

using itk::SingleValuedCostFunction::ParametersValueType = Superclass::ParametersValueType

Definition at line 55 of file itkSingleValuedCostFunction.h.

◆ Pointer

Definition at line 42 of file itkSingleValuedCostFunction.h.

◆ Self

Standard class type aliases.

Definition at line 40 of file itkSingleValuedCostFunction.h.

◆ Superclass

Definition at line 41 of file itkSingleValuedCostFunction.h.

Constructor & Destructor Documentation

◆ SingleValuedCostFunction()

itk::SingleValuedCostFunction::SingleValuedCostFunction ( )
protecteddefault

◆ ~SingleValuedCostFunction()

itk::SingleValuedCostFunction::~SingleValuedCostFunction ( )
overrideprotected

Member Function Documentation

◆ GetDerivative()

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

◆ GetNameOfClass()

const char* itk::SingleValuedCostFunction::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::CostFunctionTemplate< TInternalComputationValueType >.

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

◆ GetValue()

virtual MeasureType itk::SingleValuedCostFunction::GetValue ( const ParametersType parameters) const
pure virtual

◆ GetValueAndDerivative()

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

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