Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::ConcreteModelParameterizerBase< TModel > Class Template Reference

Template base class for parameterizers operating on a specific model type. More...

#include <mitkConcreteModelParameterizerBase.h>

Inheritance diagram for mitk::ConcreteModelParameterizerBase< TModel >:
Collaboration diagram for mitk::ConcreteModelParameterizerBase< TModel >:

Public Types

typedef ConcreteModelParameterizerBase< TModel > Self
 
typedef ModelParameterizerBase Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef Superclass::ModelBaseType ModelBaseType
 
typedef Superclass::ModelBasePointer ModelBasePointer
 
typedef TModel ModelType
 
typedef ModelType::Pointer ModelPointer
 
typedef Superclass::StaticParameterValueType StaticParameterValueType
 
typedef Superclass::StaticParameterValuesType StaticParameterValuesType
 
typedef Superclass::StaticParameterMapType StaticParameterMapType
 
typedef Superclass::IndexType IndexType
 
- Public Types inherited from mitk::ModelParameterizerBase
typedef ModelParameterizerBase Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef ModelBase ModelBaseType
 
typedef ModelBaseType::Pointer ModelBasePointer
 
typedef ModelBaseType::ParametersType ParametersType
 
typedef ModelBaseType::StaticParameterValueType StaticParameterValueType
 
typedef ModelBaseType::StaticParameterValuesType StaticParameterValuesType
 
typedef ModelBaseType::StaticParameterMapType StaticParameterMapType
 
typedef ModelBaseType::TimeGridType TimeGridType
 
typedef ::itk::Index< 3 > IndexType
 
- Public Types inherited from mitk::ModelTraitsInterface
typedef itk::Array< double > ModelResultType
 Type representing the model output signal as an array of doubles. More...
 
using ParameterValueType = double
 Type of a single parameter value. More...
 
typedef itk::Array< ParameterValueType > ParametersType
 Type representing a vector of parameter values. More...
 
typedef std::string ParameterNameType
 Type used for parameter names. More...
 
typedef std::vector< ParameterNameType > ParameterNamesType
 Type for a list of parameter names. More...
 
typedef ParametersType::SizeValueType ParametersSizeType
 Type for the count of parameters. More...
 
typedef ParameterNamesType DerivedParameterNamesType
 Type for a list of derived parameter names. More...
 
typedef ParametersSizeType DerivedParametersSizeType
 Type for the count of derived parameters. More...
 
typedef std::map< ParameterNameType, double > ParamterScaleMapType
 Map type associating parameter names to their scaling factors. More...
 
typedef std::map< ParameterNameType, std::string > ParamterUnitMapType
 Map type associating parameter names to their unit strings. More...
 
typedef std::map< ParameterNameType, double > DerivedParamterScaleMapType
 Map type associating derived parameter names to their scaling factors. More...
 
typedef std::map< ParameterNameType, std::string > DerivedParamterUnitMapType
 Map type associating derived parameter names to their unit strings. More...
 
typedef std::string FunctionStringType
 Type for the function string representation of the model. More...
 
typedef std::string ModellClassIDType
 Type for the unique class identifier of the model. More...
 

Public Member Functions

virtual const char * GetClassName () const
 
StaticParameterMapType GetGlobalStaticParameters () const override
 Returns the global static parameters that are the same for all positions. More...
 
StaticParameterMapType GetLocalStaticParameters (const IndexType &) const override
 Returns the local static parameters specific to the given image position. More...
 
ModelBasePointer GenerateParameterizedModel (const IndexType &currentPosition) const override
 Generates a fully parameterized model instance for the given position. More...
 
ModelBasePointer GenerateParameterizedModel () const override
 Generates a model instance with only global static parameterization. More...
 
ParametersType GetDefaultInitialParameterization () const override
 Returns the default initial parameterization defined by the model developer. More...
 
ParameterNamesType GetParameterNames () const override
 Returns the names of parameters that must be defined when using the model to compute the signal (GetSignal()). More...
 
ParametersSizeType GetNumberOfParameters () const override
 Returns the number of parameters that must be defined when using the model to compute the signal (GetSignal()). More...
 
ParamterScaleMapType GetParameterScales () const override
 Returns the scaling factors for all model parameters. More...
 
ParamterUnitMapType GetParameterUnits () const override
 Returns the unit strings for all model parameters. More...
 
ParameterNamesType GetDerivedParameterNames () const override
 Returns the names of derived parameters that can be computed by the model. More...
 
ParametersSizeType GetNumberOfDerivedParameters () const override
 Returns the number of derived parameters that can be computed by the model. More...
 
DerivedParamterScaleMapType GetDerivedParameterScales () const override
 Returns the scaling factors for all derived parameters. More...
 
DerivedParamterUnitMapType GetDerivedParameterUnits () const override
 Returns the unit strings for all derived parameters. More...
 
std::string GetModelDisplayName () const override
 Returns the human-readable display name of the model. More...
 
std::string GetModelType () const override
 Returns the type/category string of the model (e.g. "Linear", "Pharmacokinetic"). More...
 
FunctionStringType GetFunctionString () const override
 Returns a parsable function string representing the model equation. More...
 
ModellClassIDType GetClassID () const override
 Returns the unique class identifier for this model type. More...
 
std::string GetXName () const override
 Returns the name of the independent variable used by the model (e.g. "x"). More...
 
std::string GetXAxisName () const override
 Returns the display name of the x-axis (e.g. "Time"). More...
 
std::string GetXAxisUnit () const override
 Returns the unit of the x-axis (e.g. "s", "ms"). More...
 
std::string GetYAxisName () const override
 Returns the display name of the y-axis (e.g. "Signal Intensity"). More...
 
std::string GetYAxisUnit () const override
 Returns the unit of the y-axis. More...
 
- Public Member Functions inherited from mitk::ModelParameterizerBase
ParametersType GetInitialParameterization () const
 Returns the initial parameterization for fitting. More...
 
ParametersType GetInitialParameterization (const IndexType &currentPosition) const
 Returns the initial parameterization for a specific image position. More...
 
void SetInitialParameterizationDelegate (const InitialParameterizationDelegateBase *delegate)
 Sets a custom strategy for defining the initial parameterization. More...
 
virtual void SetDefaultTimeGrid (TimeGridType _arg)
 
virtual const TimeGridType & GetDefaultTimeGrid ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 ConcreteModelParameterizerBase ()
 
 ~ConcreteModelParameterizerBase () override
 
- Protected Member Functions inherited from mitk::ModelParameterizerBase
 ModelParameterizerBase ()
 
 ~ModelParameterizerBase () override
 
- Protected Member Functions inherited from mitk::ModelTraitsInterface
 ModelTraitsInterface ()
 
virtual ~ModelTraitsInterface ()
 

Additional Inherited Members

- Protected Attributes inherited from mitk::ModelParameterizerBase
InitialParameterizationDelegateBase::ConstPointer m_InitialDelegate
 
TimeGridType m_DefaultTimeGrid
 

Detailed Description

template<class TModel>
class mitk::ConcreteModelParameterizerBase< TModel >

Template base class for parameterizers operating on a specific model type.

Provides default implementations for generating parameterized model instances and retrieving model traits by delegating to newly created model instances. Default implementations assume no static parameters and zero initial values.

Template Parameters
TModelThe concrete model type this parameterizer configures.
See also
ModelParameterizerBase, ModelBase

Definition at line 33 of file mitkConcreteModelParameterizerBase.h.

Member Typedef Documentation

◆ ConstPointer

template<class TModel >
typedef itk::SmartPointer< const Self > mitk::ConcreteModelParameterizerBase< TModel >::ConstPointer

Definition at line 39 of file mitkConcreteModelParameterizerBase.h.

◆ IndexType

template<class TModel >
typedef Superclass::IndexType mitk::ConcreteModelParameterizerBase< TModel >::IndexType

Definition at line 54 of file mitkConcreteModelParameterizerBase.h.

◆ ModelBasePointer

◆ ModelBaseType

Definition at line 44 of file mitkConcreteModelParameterizerBase.h.

◆ ModelPointer

template<class TModel >
typedef ModelType::Pointer mitk::ConcreteModelParameterizerBase< TModel >::ModelPointer

Definition at line 48 of file mitkConcreteModelParameterizerBase.h.

◆ ModelType

template<class TModel >
typedef TModel mitk::ConcreteModelParameterizerBase< TModel >::ModelType

Definition at line 47 of file mitkConcreteModelParameterizerBase.h.

◆ Pointer

template<class TModel >
typedef itk::SmartPointer< Self > mitk::ConcreteModelParameterizerBase< TModel >::Pointer

Definition at line 38 of file mitkConcreteModelParameterizerBase.h.

◆ Self

template<class TModel >
typedef ConcreteModelParameterizerBase<TModel> mitk::ConcreteModelParameterizerBase< TModel >::Self

Definition at line 36 of file mitkConcreteModelParameterizerBase.h.

◆ StaticParameterMapType

◆ StaticParameterValuesType

◆ StaticParameterValueType

◆ Superclass

template<class TModel >
typedef ModelParameterizerBase mitk::ConcreteModelParameterizerBase< TModel >::Superclass

Definition at line 37 of file mitkConcreteModelParameterizerBase.h.

Constructor & Destructor Documentation

◆ ConcreteModelParameterizerBase()

template<class TModel >
mitk::ConcreteModelParameterizerBase< TModel >::ConcreteModelParameterizerBase ( )
inlineprotected

Definition at line 201 of file mitkConcreteModelParameterizerBase.h.

◆ ~ConcreteModelParameterizerBase()

template<class TModel >
mitk::ConcreteModelParameterizerBase< TModel >::~ConcreteModelParameterizerBase ( )
inlineoverrideprotected

Definition at line 205 of file mitkConcreteModelParameterizerBase.h.

Member Function Documentation

◆ GenerateParameterizedModel() [1/2]

template<class TModel >
ModelBasePointer mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel ( ) const
inlineoverridevirtual

Generates a model instance with only global static parameterization.

Local static parameters remain at their default values.

Returns
Smart pointer to the globally parameterized model.

Implements mitk::ModelParameterizerBase.

Definition at line 91 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GetGlobalStaticParameters(), and mitk::ModelParameterizerBase::m_DefaultTimeGrid.

Referenced by mitk::ConcreteModelParameterizerBase< TModel >::GetClassID(), mitk::ConcreteModelParameterizerBase< TModel >::GetDerivedParameterNames(), mitk::ConcreteModelParameterizerBase< TModel >::GetDerivedParameterScales(), mitk::ConcreteModelParameterizerBase< TModel >::GetDerivedParameterUnits(), mitk::ConcreteModelParameterizerBase< TModel >::GetFunctionString(), mitk::ConcreteModelParameterizerBase< TModel >::GetModelDisplayName(), mitk::ConcreteModelParameterizerBase< TModel >::GetModelType(), mitk::ConcreteModelParameterizerBase< TModel >::GetNumberOfDerivedParameters(), mitk::ConcreteModelParameterizerBase< TModel >::GetNumberOfParameters(), mitk::ConcreteModelParameterizerBase< TModel >::GetParameterNames(), mitk::ConcreteModelParameterizerBase< TModel >::GetParameterScales(), mitk::ConcreteModelParameterizerBase< TModel >::GetParameterUnits(), mitk::ConcreteModelParameterizerBase< TModel >::GetXAxisName(), mitk::ConcreteModelParameterizerBase< TModel >::GetXAxisUnit(), mitk::ConcreteModelParameterizerBase< TModel >::GetXName(), mitk::ConcreteModelParameterizerBase< TModel >::GetYAxisName(), and mitk::ConcreteModelParameterizerBase< TModel >::GetYAxisUnit().

◆ GenerateParameterizedModel() [2/2]

template<class TModel >
ModelBasePointer mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel ( const IndexType &  currentPosition) const
inlineoverridevirtual

Generates a fully parameterized model instance for the given position.

The model is configured with both global and local static parameters, and the default time grid.

Parameters
[in]currentPositionThe 3D index position in image space.
Returns
Smart pointer to the fully parameterized model.

Implements mitk::ModelParameterizerBase.

Definition at line 78 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GetGlobalStaticParameters(), mitk::ConcreteModelParameterizerBase< TModel >::GetLocalStaticParameters(), and mitk::ModelParameterizerBase::m_DefaultTimeGrid.

◆ GetClassID()

template<class TModel >
ModellClassIDType mitk::ConcreteModelParameterizerBase< TModel >::GetClassID ( ) const
inlineoverridevirtual

Returns the unique class identifier for this model type.

Returns
The model class ID string.

Implements mitk::ModelTraitsInterface.

Definition at line 170 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetClassName()

◆ GetDefaultInitialParameterization()

template<class TModel >
ParametersType mitk::ConcreteModelParameterizerBase< TModel >::GetDefaultInitialParameterization ( ) const
inlineoverridevirtual

◆ GetDerivedParameterNames()

template<class TModel >
ParameterNamesType mitk::ConcreteModelParameterizerBase< TModel >::GetDerivedParameterNames ( ) const
inlineoverridevirtual

Returns the names of derived parameters that can be computed by the model.

Returns
A vector of derived parameter name strings.

Implements mitk::ModelTraitsInterface.

Definition at line 135 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetDerivedParameterScales()

template<class TModel >
DerivedParamterScaleMapType mitk::ConcreteModelParameterizerBase< TModel >::GetDerivedParameterScales ( ) const
inlineoverridevirtual

Returns the scaling factors for all derived parameters.

Returns
A map from derived parameter name to its scale factor.

Implements mitk::ModelTraitsInterface.

Definition at line 145 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetDerivedParameterUnits()

template<class TModel >
DerivedParamterUnitMapType mitk::ConcreteModelParameterizerBase< TModel >::GetDerivedParameterUnits ( ) const
inlineoverridevirtual

Returns the unit strings for all derived parameters.

Returns
A map from derived parameter name to its unit string.

Implements mitk::ModelTraitsInterface.

Definition at line 150 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetFunctionString()

template<class TModel >
FunctionStringType mitk::ConcreteModelParameterizerBase< TModel >::GetFunctionString ( ) const
inlineoverridevirtual

Returns a parsable function string representing the model equation.

Returns
The function string (e.g. "a*x+b").

Implements mitk::ModelTraitsInterface.

Definition at line 165 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetGlobalStaticParameters()

◆ GetLocalStaticParameters()

template<class TModel >
StaticParameterMapType mitk::ConcreteModelParameterizerBase< TModel >::GetLocalStaticParameters ( const IndexType &  currentPosition) const
inlineoverridevirtual

Returns the local static parameters specific to the given image position.

Parameters
[in]currentPositionThe 3D index position in image space.
Returns
A map of local static parameter names to their values.

Implements mitk::ModelParameterizerBase.

Definition at line 68 of file mitkConcreteModelParameterizerBase.h.

Referenced by mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetModelDisplayName()

template<class TModel >
std::string mitk::ConcreteModelParameterizerBase< TModel >::GetModelDisplayName ( ) const
inlineoverridevirtual

Returns the human-readable display name of the model.

Returns
The model display name.

Implements mitk::ModelTraitsInterface.

Definition at line 155 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetModelType()

template<class TModel >
std::string mitk::ConcreteModelParameterizerBase< TModel >::GetModelType ( ) const
inlineoverridevirtual

Returns the type/category string of the model (e.g. "Linear", "Pharmacokinetic").

Returns
The model type string.

Implements mitk::ModelTraitsInterface.

Definition at line 160 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetNumberOfDerivedParameters()

template<class TModel >
ParametersSizeType mitk::ConcreteModelParameterizerBase< TModel >::GetNumberOfDerivedParameters ( ) const
inlineoverridevirtual

Returns the number of derived parameters that can be computed by the model.

Returns
The number of derived parameters.

Implements mitk::ModelTraitsInterface.

Definition at line 140 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetNumberOfParameters()

template<class TModel >
ParametersSizeType mitk::ConcreteModelParameterizerBase< TModel >::GetNumberOfParameters ( ) const
inlineoverridevirtual

Returns the number of parameters that must be defined when using the model to compute the signal (GetSignal()).

Returns
The number of model parameters.

Implements mitk::ModelTraitsInterface.

Definition at line 120 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetParameterNames()

template<class TModel >
ParameterNamesType mitk::ConcreteModelParameterizerBase< TModel >::GetParameterNames ( ) const
inlineoverridevirtual

Returns the names of parameters that must be defined when using the model to compute the signal (GetSignal()).

Returns
A vector of parameter name strings.

Implements mitk::ModelTraitsInterface.

Definition at line 115 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetParameterScales()

template<class TModel >
ParamterScaleMapType mitk::ConcreteModelParameterizerBase< TModel >::GetParameterScales ( ) const
inlineoverridevirtual

Returns the scaling factors for all model parameters.

Returns
A map from parameter name to its scale factor.

Implements mitk::ModelTraitsInterface.

Definition at line 125 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetParameterUnits()

template<class TModel >
ParamterUnitMapType mitk::ConcreteModelParameterizerBase< TModel >::GetParameterUnits ( ) const
inlineoverridevirtual

Returns the unit strings for all model parameters.

Returns
A map from parameter name to its unit string.

Implements mitk::ModelTraitsInterface.

Definition at line 130 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetXAxisName()

template<class TModel >
std::string mitk::ConcreteModelParameterizerBase< TModel >::GetXAxisName ( ) const
inlineoverridevirtual

Returns the display name of the x-axis (e.g. "Time").

Returns
The x-axis name string.

Implements mitk::ModelTraitsInterface.

Definition at line 180 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetXAxisUnit()

template<class TModel >
std::string mitk::ConcreteModelParameterizerBase< TModel >::GetXAxisUnit ( ) const
inlineoverridevirtual

Returns the unit of the x-axis (e.g. "s", "ms").

Returns
The x-axis unit string.

Implements mitk::ModelTraitsInterface.

Definition at line 185 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetXName()

template<class TModel >
std::string mitk::ConcreteModelParameterizerBase< TModel >::GetXName ( ) const
inlineoverridevirtual

Returns the name of the independent variable used by the model (e.g. "x").

Returns
The variable name string.

Implements mitk::ModelTraitsInterface.

Definition at line 175 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetYAxisName()

template<class TModel >
std::string mitk::ConcreteModelParameterizerBase< TModel >::GetYAxisName ( ) const
inlineoverridevirtual

Returns the display name of the y-axis (e.g. "Signal Intensity").

Returns
The y-axis name string.

Implements mitk::ModelTraitsInterface.

Definition at line 190 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ GetYAxisUnit()

template<class TModel >
std::string mitk::ConcreteModelParameterizerBase< TModel >::GetYAxisUnit ( ) const
inlineoverridevirtual

Returns the unit of the y-axis.

Returns
The y-axis unit string.

Implements mitk::ModelTraitsInterface.

Definition at line 195 of file mitkConcreteModelParameterizerBase.h.

References mitk::ConcreteModelParameterizerBase< TModel >::GenerateParameterizedModel().

◆ New()

template<class TModel >
static Pointer mitk::ConcreteModelParameterizerBase< TModel >::New ( )
static

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