mitk::MVModelFitCostFunction Class Reference

Base class for all model fit cost functions that return a vector of cost values. More...

#include <mitkMVModelFitCostFunction.h>

Inheritance diagram for mitk::MVModelFitCostFunction:

Collaboration diagram for mitk::MVModelFitCostFunction:

Public Types
typedef MVModelFitCostFunction	Self
typedef itk::MultipleValuedCostFunction	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 cost value vector for the given parameters. More...
void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const override
	Computes the Jacobian matrix numerically via finite differences. More...
unsigned int	GetNumberOfValues (void) const override
	Returns the number of values (residuals) returned by GetValue(). 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
	MVModelFitCostFunction ()
	~MVModelFitCostFunction () 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 vector of cost values.

Inherits from itk::MultipleValuedCostFunction and ModelFitCostFunctionInterface. This class provides a default numerical derivative computation. Subclasses only need to implement CalcMeasure() to define the specific cost metric.

See also

SVModelFitCostFunction, SquaredDifferencesFitCostFunction, MVConstrainedCostFunctionDecorator

Definition at line 36 of file mitkMVModelFitCostFunction.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 43 of file mitkMVModelFitCostFunction.h.

DerivativeType

typedef Superclass::DerivativeType mitk::MVModelFitCostFunction::DerivativeType

Definition at line 47 of file mitkMVModelFitCostFunction.h.

MeasureType

typedef Superclass::MeasureType mitk::MVModelFitCostFunction::MeasureType

Definition at line 46 of file mitkMVModelFitCostFunction.h.

Pointer

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

Definition at line 42 of file mitkMVModelFitCostFunction.h.

Self

typedef MVModelFitCostFunction mitk::MVModelFitCostFunction::Self

Definition at line 40 of file mitkMVModelFitCostFunction.h.

SignalType

typedef ModelFitCostFunctionInterface::SignalType mitk::MVModelFitCostFunction::SignalType

Definition at line 45 of file mitkMVModelFitCostFunction.h.

Superclass

typedef itk::MultipleValuedCostFunction mitk::MVModelFitCostFunction::Superclass

Definition at line 41 of file mitkMVModelFitCostFunction.h.

Constructor & Destructor Documentation

MVModelFitCostFunction()

mitk::MVModelFitCostFunction::MVModelFitCostFunction ( )

inlineprotected

Definition at line 91 of file mitkMVModelFitCostFunction.h.

~MVModelFitCostFunction()

mitk::MVModelFitCostFunction::~MVModelFitCostFunction ( )

inlineoverrideprotected

Definition at line 95 of file mitkMVModelFitCostFunction.h.

Member Function Documentation

CalcMeasure()

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

protectedpure virtual

Implemented in mitk::SquaredDifferencesFitCostFunction, and mitk::MVConstrainedCostFunctionDecorator.

GetDerivative()

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

override

Computes the Jacobian matrix numerically via finite differences.

Parameters

[in]	parameters	The parameters at which the derivative is evaluated.
[out]	derivative	The computed Jacobian matrix.

GetDerivativeStepLength()

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

virtual

GetNumberOfParameters()

unsigned int mitk::MVModelFitCostFunction::GetNumberOfParameters ( void  ) const

override

Returns the number of model parameters.

Returns

The number of parameters of the associated model.

GetNumberOfValues()

unsigned int mitk::MVModelFitCostFunction::GetNumberOfValues ( void  ) const

override

Returns the number of values (residuals) returned by GetValue().

Returns

The number of cost values (equals the sample signal size).

GetValue()

MeasureType mitk::MVModelFitCostFunction::GetValue ( const ParametersType &  parameter ) const

override

Computes the cost value vector for the given parameters.

Parameters

[in]

parameter

The model parameters to evaluate.

Returns

A vector of cost values (one per time point).

mitkOverrideGetConstObjectMacro()

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

mitkOverrideSetConstObjectMacro()

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

SetDerivativeStepLength()

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

virtual

SetSample()

void mitk::MVModelFitCostFunction::SetSample ( const SignalType &  sampleSet )

overridevirtual

Sets the observed sample signal.

Parameters

[in]

sampleSet

The sample signal array.

Implements mitk::ModelFitCostFunctionInterface.

Member Data Documentation

m_Sample

SignalType mitk::MVModelFitCostFunction::m_Sample

protected

Definition at line 97 of file mitkMVModelFitCostFunction.h.

---

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

• mitkMVModelFitCostFunction.h