A no-op model fit functor that returns initial parameters without optimization. More...

#include <mitkDummyModelFitFunctor.h>

Inheritance diagram for mitk::DummyModelFitFunctor:

Collaboration diagram for mitk::DummyModelFitFunctor:

Public Types
typedef DummyModelFitFunctor	Self

typedef ModelFitFunctorBase	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef Superclass::InputPixelArrayType	InputPixelArrayType

typedef Superclass::OutputPixelArrayType	OutputPixelArrayType

Public Types inherited from mitk::ModelFitFunctorBase
typedef ModelFitFunctorBase	Self

typedef itk::Object	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef ScalarType	ParameterImagePixelType

typedef std::vector< ParameterImagePixelType >	InputPixelArrayType

typedef std::vector< ParameterImagePixelType >	OutputPixelArrayType

typedef ModelBase::ParameterNamesType	ParameterNamesType

Public Member Functions
virtual const char *	GetClassName () const

virtual void	SetDerivativeStepLength (double _arg)

virtual double	GetDerivativeStepLength ()

ParameterNamesType	GetCriterionNames () const override
	Returns names of the criteria used to fit the model. More...

Public Member Functions inherited from mitk::ModelFitFunctorBase
OutputPixelArrayType	Compute (const InputPixelArrayType &value, const ModelBase *model, const ModelBase::ParametersType &initialParameters) const
	Performs model fitting and returns the results. More...

unsigned int	GetNumberOfOutputs (const ModelBase *model) const
	Returns the number of outputs the fit functor will produce. More...

ParameterNamesType	GetEvaluationParameterNames () const
	Returns names of all evaluation parameters defined by the user. More...

void	ResetEvaluationParameters ()
	Removes all registered evaluation parameters. More...

void	RegisterEvaluationParameter (const std::string &parameterName, SVModelFitCostFunction *evaluationCostFunction)
	Registers an evaluation parameter with its cost function. More...

const SVModelFitCostFunction *	GetEvaluationParameterCostFunction (const std::string &parameterName) const
	Returns the cost function associated with the given evaluation parameter. More...

ParameterNamesType	GetDebugParameterNames () const
	Returns names of the debug parameters generated by the functor. More...

virtual void	DebugParameterMapsOn ()

virtual void	DebugParameterMapsOff ()

virtual void	SetDebugParameterMaps (bool _arg)

virtual bool	GetDebugParameterMaps () const

Static Public Member Functions
static Pointer	New ()

Protected Types
typedef Superclass::ParametersType	ParametersType

typedef Superclass::SignalType	SignalType

Protected Types inherited from mitk::ModelFitFunctorBase
typedef ModelBase::ParametersType	ParametersType

typedef ModelFitCostFunctionInterface::SignalType	SignalType

typedef std::map< std::string, ParameterImagePixelType >	DebugParameterMapType

Protected Member Functions
	DummyModelFitFunctor ()

	~DummyModelFitFunctor () override

ParametersType	DoModelFit (const SignalType &value, const ModelBase *model, const ModelBase::ParametersType &initialParameters, DebugParameterMapType &debugParameters) const override
	Internal method that performs the actual model fitting. More...

OutputPixelArrayType	GetCriteria (const ModelBase *model, const ParametersType &parameters, const SignalType &sample) const override
	Internal method called by Compute() to get the final criterion values that drove the fit. More...

virtual MVModelFitCostFunction::Pointer	GenerateCostFunction (const SignalType &value, const ModelBase *model) const

ParameterNamesType	DefineDebugParameterNames () const override
	Returns names of the debug parameters generated by the functor. More...

Protected Member Functions inherited from mitk::ModelFitFunctorBase
	ModelFitFunctorBase ()

	~ModelFitFunctorBase () override

OutputPixelArrayType	GetDerivedParameters (const ModelBase *model, const ParametersType &parameters) const
	Internal method called by Compute() to get derived parameters with the final fit parameters. More...

OutputPixelArrayType	GetEvaluationParameters (const ModelBase *model, const ParametersType &parameters, const SignalType &sample) const
	Internal method called by Compute() to get evaluation parameters from user-defined cost functions. More...

Detailed Description

A no-op model fit functor that returns initial parameters without optimization.

This functor does not perform any actual fitting. It simply returns the initial parameters as the "fitted" result. It is useful for testing the model fitting pipeline infrastructure or for generating model signals from known parameters.

See also: ModelFitFunctorBase, LevenbergMarquardtModelFitFunctor

Definition at line 37 of file mitkDummyModelFitFunctor.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 43 of file mitkDummyModelFitFunctor.h.

◆ InputPixelArrayType

typedef Superclass::InputPixelArrayType mitk::DummyModelFitFunctor::InputPixelArrayType

Definition at line 48 of file mitkDummyModelFitFunctor.h.

◆ OutputPixelArrayType

typedef Superclass::OutputPixelArrayType mitk::DummyModelFitFunctor::OutputPixelArrayType

Definition at line 49 of file mitkDummyModelFitFunctor.h.

◆ ParametersType

typedef Superclass::ParametersType mitk::DummyModelFitFunctor::ParametersType

protected

Definition at line 58 of file mitkDummyModelFitFunctor.h.

◆ Pointer

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

Definition at line 42 of file mitkDummyModelFitFunctor.h.

◆ Self

typedef DummyModelFitFunctor mitk::DummyModelFitFunctor::Self

Definition at line 40 of file mitkDummyModelFitFunctor.h.

◆ SignalType

typedef Superclass::SignalType mitk::DummyModelFitFunctor::SignalType

protected

Definition at line 59 of file mitkDummyModelFitFunctor.h.

◆ Superclass

typedef ModelFitFunctorBase mitk::DummyModelFitFunctor::Superclass

Definition at line 41 of file mitkDummyModelFitFunctor.h.

Constructor & Destructor Documentation

◆ DummyModelFitFunctor()

mitk::DummyModelFitFunctor::DummyModelFitFunctor ( )

protected

◆ ~DummyModelFitFunctor()

mitk::DummyModelFitFunctor::~DummyModelFitFunctor ( )

overrideprotected

Member Function Documentation

◆ DefineDebugParameterNames()

ParameterNamesType mitk::DummyModelFitFunctor::DefineDebugParameterNames ( ) const

overrideprotectedvirtual

Returns names of the debug parameters generated by the functor.

Will be called by GetDebugParameterNames() if debug is activated.

Implements mitk::ModelFitFunctorBase.

◆ DoModelFit()

ParametersType mitk::DummyModelFitFunctor::DoModelFit	(	const SignalType &	value,
		const ModelBase *	model,
		const ModelBase::ParametersType &	initialParameters,
		DebugParameterMapType &	debugParameters
	)		const

overrideprotectedvirtual

Internal method that performs the actual model fitting.

Must be implemented by derived classes. Returns the found parameters and optionally populates the debug parameter map.

Parameters

	value	Signal the model should be fitted against.
	model	Pointer to the model that should be fitted.
	initialParameters	Initial model parameters for the fit.
[out]	debugParameters	Map containing all debug parameters (only valid if m_DebugParameterMaps is true).

Returns: The optimized parameter values.

Postcondition: If m_DebugParameterMaps is true, all debug parameters defined by DefineDebugParameterNames() must be returned via debugParameters.

Implements mitk::ModelFitFunctorBase.

◆ GenerateCostFunction()

virtual MVModelFitCostFunction::Pointer mitk::DummyModelFitFunctor::GenerateCostFunction	(	const SignalType &	value,
		const ModelBase *	model
	)		const

protectedvirtual

Generator function that instantiates and parameterizes the cost function that should be used by the fit functor

◆ GetClassName()

virtual const char* mitk::DummyModelFitFunctor::GetClassName ( ) const

virtual

Reimplemented from mitk::ModelFitFunctorBase.

◆ GetCriteria()

OutputPixelArrayType mitk::DummyModelFitFunctor::GetCriteria	(	const ModelBase *	model,
		const ParametersType &	parameters,
		const SignalType &	sample
	)		const

overrideprotectedvirtual

Internal method called by Compute() to get the final criterion values that drove the fit.

Must be implemented by concrete functor classes.

Implements mitk::ModelFitFunctorBase.

◆ GetCriterionNames()

ParameterNamesType mitk::DummyModelFitFunctor::GetCriterionNames ( ) const

overridevirtual

Returns names of the criteria used to fit the model.

Implements mitk::ModelFitFunctorBase.

◆ GetDerivativeStepLength()

virtual double mitk::DummyModelFitFunctor::GetDerivativeStepLength ( )

virtual

◆ New()

static Pointer mitk::DummyModelFitFunctor::New ( )

static

◆ SetDerivativeStepLength()

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

virtual

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

mitkDummyModelFitFunctor.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ InputPixelArrayType

◆ OutputPixelArrayType

◆ ParametersType

◆ Pointer

◆ Self

◆ SignalType

◆ Superclass

Constructor & Destructor Documentation

◆ DummyModelFitFunctor()

◆ ~DummyModelFitFunctor()

Member Function Documentation

◆ DefineDebugParameterNames()

◆ DoModelFit()

◆ GenerateCostFunction()

◆ GetClassName()

◆ GetCriteria()

◆ GetCriterionNames()

◆ GetDerivativeStepLength()

◆ New()

◆ SetDerivativeStepLength()