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::ModelParameterizerBase Class Referenceabstract

#include <mitkModelParameterizerBase.h>

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

Public Types

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

Protected Member Functions

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

Protected Attributes

InitialParameterizationDelegateBase::ConstPointer m_InitialDelegate
 
TimeGridType m_DefaultTimeGrid
 

Detailed Description

Base class for all model parameterizers Model parameterizers are used to offer a generic api to generate/bind models with specific global static and local static parameters in order to utilize the model correctly.

  • Global static parameter: parameters that are the same for a model independent of the spatial position (in image space) that should be modeled (e.g. parameter "Tau" for the DescriptivePharmacokineticBrixModel)
  • Local static parameter: parameters that are specific for the spatial position (in image space) that should be modeled (e.g. parameter "S0" for the DescriptivePharmacokineticBrixModel)

Definition at line 36 of file mitkModelParameterizerBase.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 42 of file mitkModelParameterizerBase.h.

◆ IndexType

typedef ::itk::Index<3> mitk::ModelParameterizerBase::IndexType

Definition at line 55 of file mitkModelParameterizerBase.h.

◆ ModelBasePointer

typedef ModelBaseType::Pointer mitk::ModelParameterizerBase::ModelBasePointer

Definition at line 47 of file mitkModelParameterizerBase.h.

◆ ModelBaseType

typedef ModelBase mitk::ModelParameterizerBase::ModelBaseType

Definition at line 46 of file mitkModelParameterizerBase.h.

◆ ParametersType

typedef ModelBaseType::ParametersType mitk::ModelParameterizerBase::ParametersType

Definition at line 49 of file mitkModelParameterizerBase.h.

◆ Pointer

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

Definition at line 41 of file mitkModelParameterizerBase.h.

◆ Self

typedef ModelParameterizerBase mitk::ModelParameterizerBase::Self

Definition at line 39 of file mitkModelParameterizerBase.h.

◆ StaticParameterMapType

typedef ModelBaseType::StaticParameterMapType mitk::ModelParameterizerBase::StaticParameterMapType

Definition at line 52 of file mitkModelParameterizerBase.h.

◆ StaticParameterValuesType

typedef ModelBaseType::StaticParameterValuesType mitk::ModelParameterizerBase::StaticParameterValuesType

Definition at line 51 of file mitkModelParameterizerBase.h.

◆ StaticParameterValueType

typedef ModelBaseType::StaticParameterValueType mitk::ModelParameterizerBase::StaticParameterValueType

Definition at line 50 of file mitkModelParameterizerBase.h.

◆ Superclass

typedef itk::Object mitk::ModelParameterizerBase::Superclass

Definition at line 40 of file mitkModelParameterizerBase.h.

◆ TimeGridType

typedef ModelBaseType::TimeGridType mitk::ModelParameterizerBase::TimeGridType

Definition at line 53 of file mitkModelParameterizerBase.h.

Constructor & Destructor Documentation

◆ ModelParameterizerBase()

mitk::ModelParameterizerBase::ModelParameterizerBase ( )
protected

◆ ~ModelParameterizerBase()

mitk::ModelParameterizerBase::~ModelParameterizerBase ( )
overrideprotected

Member Function Documentation

◆ GenerateParameterizedModel() [1/2]

virtual ModelBasePointer mitk::ModelParameterizerBase::GenerateParameterizedModel ( ) const
pure virtual

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.

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelParameterizerBase< GenericParamModel >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialSaturationModel >, mitk::ConcreteModelParameterizerBase< mitk::ExpDecayOffsetModel >, mitk::ConcreteModelParameterizerBase< mitk::TwoStepLinearModel >, mitk::ConcreteModelParameterizerBase< TAIFBasedModel >, mitk::ConcreteModelParameterizerBase< mitk::ThreeStepLinearModel >, mitk::ConcreteModelParameterizerBase< mitk::DescriptivePharmacokineticBrixModel >, and mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >.

◆ GenerateParameterizedModel() [2/2]

virtual ModelBasePointer mitk::ModelParameterizerBase::GenerateParameterizedModel ( const IndexType &  currentPosition) const
pure virtual

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.

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelParameterizerBase< GenericParamModel >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialSaturationModel >, mitk::ConcreteModelParameterizerBase< mitk::ExpDecayOffsetModel >, mitk::ConcreteModelParameterizerBase< mitk::TwoStepLinearModel >, mitk::ConcreteModelParameterizerBase< TAIFBasedModel >, mitk::ConcreteModelParameterizerBase< mitk::ThreeStepLinearModel >, mitk::ConcreteModelParameterizerBase< mitk::DescriptivePharmacokineticBrixModel >, and mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >.

◆ GetClassName()

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

Reimplemented in mitk::TwoTissueCompartmentModelParameterizer, mitk::TwoTissueCompartmentFDGModelParameterizer, mitk::TwoCompartmentExchangeModelParameterizer, mitk::StandardToftsModelParameterizer, mitk::OneTissueCompartmentModelParameterizer, mitk::ExtendedToftsModelParameterizer, mitk::ExtendedOneTissueCompartmentModelParameterizer, mitk::DescriptivePharmacokineticBrixModelValueBasedParameterizer, mitk::DescriptivePharmacokineticBrixModelParameterizer, mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >, mitk::AIFBasedModelParameterizerBase< mitk::TwoTissueCompartmentFDGModel >, mitk::AIFBasedModelParameterizerBase< mitk::TwoCompartmentExchangeModel >, mitk::AIFBasedModelParameterizerBase< mitk::ExtendedOneTissueCompartmentModel >, mitk::AIFBasedModelParameterizerBase< mitk::OneTissueCompartmentModel >, mitk::AIFBasedModelParameterizerBase< mitk::StandardToftsModel >, mitk::AIFBasedModelParameterizerBase< mitk::TwoTissueCompartmentModel >, mitk::AIFBasedModelParameterizerBase< mitk::ExtendedToftsModel >, mitk::TwoStepLinearModelParameterizer, mitk::ThreeStepLinearModelParameterizer, mitk::GenericParamModelParameterizer, mitk::ExponentialSaturationModelParameterizer, mitk::ExponentialDecayModelParameterizer, mitk::ExpDecayOffsetModelParameterizer, mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelParameterizerBase< GenericParamModel >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialSaturationModel >, mitk::ConcreteModelParameterizerBase< mitk::ExpDecayOffsetModel >, mitk::ConcreteModelParameterizerBase< mitk::TwoStepLinearModel >, mitk::ConcreteModelParameterizerBase< TAIFBasedModel >, mitk::ConcreteModelParameterizerBase< mitk::ThreeStepLinearModel >, mitk::ConcreteModelParameterizerBase< mitk::DescriptivePharmacokineticBrixModel >, and mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >.

◆ GetDefaultInitialParameterization()

virtual ParametersType mitk::ModelParameterizerBase::GetDefaultInitialParameterization ( ) const
pure virtual

Returns the default initial parameterization defined by the model developer.

Returns
The default initial parameter values for fitting.

Implemented in mitk::TwoTissueCompartmentModelParameterizer, mitk::TwoTissueCompartmentFDGModelParameterizer, mitk::TwoCompartmentExchangeModelParameterizer, mitk::StandardToftsModelParameterizer, mitk::OneTissueCompartmentModelParameterizer, mitk::ExtendedToftsModelParameterizer, mitk::ExtendedOneTissueCompartmentModelParameterizer, mitk::DescriptivePharmacokineticBrixModelValueBasedParameterizer, mitk::DescriptivePharmacokineticBrixModelParameterizer, mitk::TwoStepLinearModelParameterizer, mitk::ThreeStepLinearModelParameterizer, mitk::GenericParamModelParameterizer, mitk::ExponentialSaturationModelParameterizer, mitk::ExponentialDecayModelParameterizer, mitk::ExpDecayOffsetModelParameterizer, mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelParameterizerBase< GenericParamModel >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialSaturationModel >, mitk::ConcreteModelParameterizerBase< mitk::ExpDecayOffsetModel >, mitk::ConcreteModelParameterizerBase< mitk::TwoStepLinearModel >, mitk::ConcreteModelParameterizerBase< TAIFBasedModel >, mitk::ConcreteModelParameterizerBase< mitk::ThreeStepLinearModel >, mitk::ConcreteModelParameterizerBase< mitk::DescriptivePharmacokineticBrixModel >, and mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >.

◆ GetDefaultTimeGrid()

virtual const TimeGridType& mitk::ModelParameterizerBase::GetDefaultTimeGrid ( )
virtual

◆ GetGlobalStaticParameters()

virtual StaticParameterMapType mitk::ModelParameterizerBase::GetGlobalStaticParameters ( ) const
pure virtual

Returns the global static parameters that are the same for all positions.

Returns
A map of global static parameter names to their values.

Implemented in mitk::DescriptivePharmacokineticBrixModelValueBasedParameterizer, mitk::DescriptivePharmacokineticBrixModelParameterizer, mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >, mitk::AIFBasedModelParameterizerBase< mitk::TwoTissueCompartmentFDGModel >, mitk::AIFBasedModelParameterizerBase< mitk::TwoCompartmentExchangeModel >, mitk::AIFBasedModelParameterizerBase< mitk::ExtendedOneTissueCompartmentModel >, mitk::AIFBasedModelParameterizerBase< mitk::OneTissueCompartmentModel >, mitk::AIFBasedModelParameterizerBase< mitk::StandardToftsModel >, mitk::AIFBasedModelParameterizerBase< mitk::TwoTissueCompartmentModel >, mitk::AIFBasedModelParameterizerBase< mitk::ExtendedToftsModel >, mitk::GenericParamModelParameterizer, mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelParameterizerBase< GenericParamModel >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialSaturationModel >, mitk::ConcreteModelParameterizerBase< mitk::ExpDecayOffsetModel >, mitk::ConcreteModelParameterizerBase< mitk::TwoStepLinearModel >, mitk::ConcreteModelParameterizerBase< TAIFBasedModel >, mitk::ConcreteModelParameterizerBase< mitk::ThreeStepLinearModel >, mitk::ConcreteModelParameterizerBase< mitk::DescriptivePharmacokineticBrixModel >, and mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >.

◆ GetInitialParameterization() [1/2]

ParametersType mitk::ModelParameterizerBase::GetInitialParameterization ( ) const

Returns the initial parameterization for fitting.

If an InitialParameterizationDelegate has been set, it will be used. Otherwise, GetDefaultInitialParameterization() is returned.

Returns
The initial parameter values.

◆ GetInitialParameterization() [2/2]

ParametersType mitk::ModelParameterizerBase::GetInitialParameterization ( const IndexType &  currentPosition) const

Returns the initial parameterization for a specific image position.

Parameters
[in]currentPositionThe 3D index position in image space.
Returns
The initial parameter values for the given position.

◆ GetLocalStaticParameters()

virtual StaticParameterMapType mitk::ModelParameterizerBase::GetLocalStaticParameters ( const IndexType &  currentPosition) const
pure virtual

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.

Implemented in mitk::DescriptivePharmacokineticBrixModelValueBasedParameterizer, mitk::DescriptivePharmacokineticBrixModelParameterizer, mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelParameterizerBase< GenericParamModel >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialSaturationModel >, mitk::ConcreteModelParameterizerBase< mitk::ExpDecayOffsetModel >, mitk::ConcreteModelParameterizerBase< mitk::TwoStepLinearModel >, mitk::ConcreteModelParameterizerBase< TAIFBasedModel >, mitk::ConcreteModelParameterizerBase< mitk::ThreeStepLinearModel >, mitk::ConcreteModelParameterizerBase< mitk::DescriptivePharmacokineticBrixModel >, and mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >.

◆ SetDefaultTimeGrid()

virtual void mitk::ModelParameterizerBase::SetDefaultTimeGrid ( TimeGridType  _arg)
virtual

◆ SetInitialParameterizationDelegate()

void mitk::ModelParameterizerBase::SetInitialParameterizationDelegate ( const InitialParameterizationDelegateBase *  delegate)

Sets a custom strategy for defining the initial parameterization.

Parameters
[in]delegatePointer to the delegate that provides custom initial values.

Member Data Documentation

◆ m_DefaultTimeGrid

TimeGridType mitk::ModelParameterizerBase::m_DefaultTimeGrid
protected

The default time grid that should be set to generated models.

Definition at line 132 of file mitkModelParameterizerBase.h.

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

◆ m_InitialDelegate

InitialParameterizationDelegateBase::ConstPointer mitk::ModelParameterizerBase::m_InitialDelegate
protected

Definition at line 129 of file mitkModelParameterizerBase.h.

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