Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mitk::SVModelFitCostFunction Class Referenceabstract

Base class for all model fit cost functions that return a single scalar cost value. More...

#include <mitkSVModelFitCostFunction.h>

Inheritance diagram for mitk::SVModelFitCostFunction:
Inheritance graph
[legend]
Collaboration diagram for mitk::SVModelFitCostFunction:
Collaboration graph
[legend]

Public Types

typedef SVModelFitCostFunction Self
 
typedef itk::SingleValuedCostFunction Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef ModelFitCostFunctionInterface::SignalType SignalType
 
typedef Superclass::MeasureType MeasureType
 
typedef Superclass::DerivativeType DerivativeType
 
- Public Types inherited from mitk::ModelFitCostFunctionInterface
typedef ModelFitCostFunctionInterface Self
 
typedef itk::Array< double > SignalType
 Type representing the observed signal values. More...
 

Public Member Functions

void SetSample (const SignalType &sampleSet) override
 Sets the observed sample signal. More...
 
MeasureType GetValue (const ParametersType &parameter) const override
 Computes the scalar cost value for the given parameters. More...
 
void GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const override
 Computes the derivative of the cost function numerically via finite differences. More...
 
unsigned int GetNumberOfParameters (void) const override
 Returns the number of model parameters. More...
 
 mitkOverrideSetConstObjectMacro (Model, ModelBase)
 
 mitkOverrideGetConstObjectMacro (Model, ModelBase)
 
virtual void SetDerivativeStepLength (double _arg)
 
virtual double GetDerivativeStepLength () const
 
- Public Member Functions inherited from mitk::ModelFitCostFunctionInterface
virtual void SetModel (const ModelBase *model)=0
 Sets the model instance to be used for cost evaluation. More...
 
virtual const ModelBase * GetModel () const =0
 Returns the model instance currently used for cost evaluation. More...
 

Protected Member Functions

virtual MeasureType CalcMeasure (const ParametersType &parameters, const SignalType &signal) const =0
 
 SVModelFitCostFunction ()
 
 ~SVModelFitCostFunction () override
 
- Protected Member Functions inherited from mitk::ModelFitCostFunctionInterface
 ModelFitCostFunctionInterface ()
 
virtual ~ModelFitCostFunctionInterface ()
 

Protected Attributes

SignalType m_Sample
 

Detailed Description

Base class for all model fit cost functions that return a single scalar cost value.

Inherits from itk::SingleValuedCostFunction and ModelFitCostFunctionInterface. Subclasses must implement CalcMeasure() to define the specific cost metric. Provides a default numerical derivative computation via finite differences.

See also
MVModelFitCostFunction, ModelFitCostFunctionInterface, SumOfSquaredDifferencesFitCostFunction

Definition at line 36 of file mitkSVModelFitCostFunction.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer< const Self > mitk::SVModelFitCostFunction::ConstPointer

Definition at line 43 of file mitkSVModelFitCostFunction.h.

◆ DerivativeType

typedef Superclass::DerivativeType mitk::SVModelFitCostFunction::DerivativeType

Definition at line 47 of file mitkSVModelFitCostFunction.h.

◆ MeasureType

typedef Superclass::MeasureType mitk::SVModelFitCostFunction::MeasureType

Definition at line 46 of file mitkSVModelFitCostFunction.h.

◆ Pointer

typedef itk::SmartPointer< Self > mitk::SVModelFitCostFunction::Pointer

Definition at line 42 of file mitkSVModelFitCostFunction.h.

◆ Self

typedef SVModelFitCostFunction mitk::SVModelFitCostFunction::Self

Definition at line 40 of file mitkSVModelFitCostFunction.h.

◆ SignalType

typedef ModelFitCostFunctionInterface::SignalType mitk::SVModelFitCostFunction::SignalType

Definition at line 45 of file mitkSVModelFitCostFunction.h.

◆ Superclass

typedef itk::SingleValuedCostFunction mitk::SVModelFitCostFunction::Superclass

Definition at line 41 of file mitkSVModelFitCostFunction.h.

Constructor & Destructor Documentation

◆ SVModelFitCostFunction()

mitk::SVModelFitCostFunction::SVModelFitCostFunction ( )
inlineprotected

Definition at line 85 of file mitkSVModelFitCostFunction.h.

◆ ~SVModelFitCostFunction()

mitk::SVModelFitCostFunction::~SVModelFitCostFunction ( )
inlineoverrideprotected

Definition at line 89 of file mitkSVModelFitCostFunction.h.

Member Function Documentation

◆ CalcMeasure()

virtual MeasureType mitk::SVModelFitCostFunction::CalcMeasure ( const ParametersType &  parameters,
const SignalType &  signal 
) const
protectedpure virtual

Implemented in mitk::SumOfSquaredDifferencesFitCostFunction, mitk::ReducedChiSquareFitCostFunction, mitk::NormalizedSumOfSquaredDifferencesFitCostFunction, and mitk::ChiSquareFitCostFunction.

◆ GetDerivative()

void mitk::SVModelFitCostFunction::GetDerivative ( const ParametersType &  parameters,
DerivativeType &  derivative 
) const
override

Computes the derivative of the cost function numerically via finite differences.

Parameters
[in]parametersThe parameters at which the derivative is evaluated.
[out]derivativeThe computed derivative vector.

◆ GetDerivativeStepLength()

virtual double mitk::SVModelFitCostFunction::GetDerivativeStepLength ( ) const
virtual

◆ GetNumberOfParameters()

unsigned int mitk::SVModelFitCostFunction::GetNumberOfParameters ( void  ) const
override

Returns the number of model parameters.

Returns
The number of parameters of the associated model.

◆ GetValue()

MeasureType mitk::SVModelFitCostFunction::GetValue ( const ParametersType &  parameter) const
override

Computes the scalar cost value for the given parameters.

Parameters
[in]parameterThe model parameters to evaluate.
Returns
The scalar cost measure value.

◆ mitkOverrideGetConstObjectMacro()

mitk::SVModelFitCostFunction::mitkOverrideGetConstObjectMacro ( Model  ,
ModelBase   
)

◆ mitkOverrideSetConstObjectMacro()

mitk::SVModelFitCostFunction::mitkOverrideSetConstObjectMacro ( Model  ,
ModelBase   
)

◆ SetDerivativeStepLength()

virtual void mitk::SVModelFitCostFunction::SetDerivativeStepLength ( double  _arg)
virtual

◆ SetSample()

void mitk::SVModelFitCostFunction::SetSample ( const SignalType &  sampleSet)
overridevirtual

Sets the observed sample signal.

Parameters
[in]sampleSetThe sample signal array.

Implements mitk::ModelFitCostFunctionInterface.

Member Data Documentation

◆ m_Sample

SignalType mitk::SVModelFitCostFunction::m_Sample
protected

Definition at line 91 of file mitkSVModelFitCostFunction.h.

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