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

Pure virtual interface that defines the traits (metadata) of a model used for fitting. More...

#include <mitkModelTraitsInterface.h>

Inheritance diagram for mitk::ModelTraitsInterface:
Inheritance graph
[legend]

Public Types

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 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

 ModelTraitsInterface ()
 
virtual ~ModelTraitsInterface ()
 

Detailed Description

Pure virtual interface that defines the traits (metadata) of a model used for fitting.

This interface provides a common contract for querying model properties such as parameter names, units, scales, derived parameter information, axis labels, and model identification strings. All model-related classes that need to expose these traits (e.g. ModelBase, ModelFactoryBase, ModelParameterizerBase) implement this interface.

See also
ModelBase, ModelFactoryBase, ModelParameterizerBase

Definition at line 36 of file mitkModelTraitsInterface.h.

Member Typedef Documentation

◆ DerivedParameterNamesType

typedef ParameterNamesType mitk::ModelTraitsInterface::DerivedParameterNamesType

Type for a list of derived parameter names.

Definition at line 54 of file mitkModelTraitsInterface.h.

◆ DerivedParametersSizeType

typedef ParametersSizeType mitk::ModelTraitsInterface::DerivedParametersSizeType

Type for the count of derived parameters.

Definition at line 56 of file mitkModelTraitsInterface.h.

◆ DerivedParamterScaleMapType

typedef std::map<ParameterNameType, double> mitk::ModelTraitsInterface::DerivedParamterScaleMapType

Map type associating derived parameter names to their scaling factors.

Definition at line 63 of file mitkModelTraitsInterface.h.

◆ DerivedParamterUnitMapType

typedef std::map<ParameterNameType, std::string> mitk::ModelTraitsInterface::DerivedParamterUnitMapType

Map type associating derived parameter names to their unit strings.

Definition at line 65 of file mitkModelTraitsInterface.h.

◆ FunctionStringType

typedef std::string mitk::ModelTraitsInterface::FunctionStringType

Type for the function string representation of the model.

Definition at line 68 of file mitkModelTraitsInterface.h.

◆ ModellClassIDType

typedef std::string mitk::ModelTraitsInterface::ModellClassIDType

Type for the unique class identifier of the model.

Definition at line 70 of file mitkModelTraitsInterface.h.

◆ ModelResultType

typedef itk::Array<double> mitk::ModelTraitsInterface::ModelResultType

Type representing the model output signal as an array of doubles.

Definition at line 41 of file mitkModelTraitsInterface.h.

◆ ParameterNamesType

typedef std::vector<ParameterNameType> mitk::ModelTraitsInterface::ParameterNamesType

Type for a list of parameter names.

Definition at line 50 of file mitkModelTraitsInterface.h.

◆ ParameterNameType

typedef std::string mitk::ModelTraitsInterface::ParameterNameType

Type used for parameter names.

Definition at line 48 of file mitkModelTraitsInterface.h.

◆ ParametersSizeType

typedef ParametersType::SizeValueType mitk::ModelTraitsInterface::ParametersSizeType

Type for the count of parameters.

Definition at line 52 of file mitkModelTraitsInterface.h.

◆ ParametersType

typedef itk::Array<ParameterValueType> mitk::ModelTraitsInterface::ParametersType

Type representing a vector of parameter values.

Definition at line 45 of file mitkModelTraitsInterface.h.

◆ ParameterValueType

using mitk::ModelTraitsInterface::ParameterValueType = double

Type of a single parameter value.

Definition at line 43 of file mitkModelTraitsInterface.h.

◆ ParamterScaleMapType

typedef std::map<ParameterNameType, double> mitk::ModelTraitsInterface::ParamterScaleMapType

Map type associating parameter names to their scaling factors.

Definition at line 59 of file mitkModelTraitsInterface.h.

◆ ParamterUnitMapType

typedef std::map<ParameterNameType, std::string> mitk::ModelTraitsInterface::ParamterUnitMapType

Map type associating parameter names to their unit strings.

Definition at line 61 of file mitkModelTraitsInterface.h.

Constructor & Destructor Documentation

◆ ModelTraitsInterface()

mitk::ModelTraitsInterface::ModelTraitsInterface ( )
inlineprotected

Definition at line 177 of file mitkModelTraitsInterface.h.

◆ ~ModelTraitsInterface()

virtual mitk::ModelTraitsInterface::~ModelTraitsInterface ( )
inlineprotectedvirtual

Definition at line 178 of file mitkModelTraitsInterface.h.

Member Function Documentation

◆ GetClassID()

virtual ModellClassIDType mitk::ModelTraitsInterface::GetClassID ( ) const
pure virtual

Returns the unique class identifier for this model type.

Returns
The model class ID string.

Implemented in mitk::ModelBase, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetDerivedParameterNames()

virtual DerivedParameterNamesType mitk::ModelTraitsInterface::GetDerivedParameterNames ( ) const
pure virtual

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

Returns
A vector of derived parameter name strings.

Implemented in mitk::StandardToftsModel, mitk::ExtendedToftsModel, mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::ModelBase, mitk::LinearModel, mitk::ExponentialDecayModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetDerivedParameterScales()

virtual DerivedParamterScaleMapType mitk::ModelTraitsInterface::GetDerivedParameterScales ( ) const
pure virtual

Returns the scaling factors for all derived parameters.

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

Implemented in mitk::ModelBase, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetDerivedParameterUnits()

virtual DerivedParamterUnitMapType mitk::ModelTraitsInterface::GetDerivedParameterUnits ( ) const
pure virtual

Returns the unit strings for all derived parameters.

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

Implemented in mitk::StandardToftsModel, mitk::ExtendedToftsModel, mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::ModelBase, mitk::LinearModel, mitk::ExponentialDecayModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetFunctionString()

virtual FunctionStringType mitk::ModelTraitsInterface::GetFunctionString ( ) const
pure virtual

Returns a parsable function string representing the model equation.

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

Implemented in mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::ModelBase, mitk::LinearModel, mitk::GenericParamModelParameterizer, mitk::GenericParamModel, mitk::ExponentialSaturationModel, mitk::ExponentialDecayModel, mitk::ExpDecayOffsetModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetModelDisplayName()

virtual std::string mitk::ModelTraitsInterface::GetModelDisplayName ( ) const
pure virtual

Returns the human-readable display name of the model.

Returns
The model display name.

Implemented in mitk::TwoTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::TwoCompartmentExchangeModel, mitk::StandardToftsModel, mitk::OneTissueCompartmentModel, mitk::ExtendedToftsModel, mitk::ExtendedOneTissueCompartmentModel, mitk::DescriptivePharmacokineticBrixModel, mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::ModelBase, mitk::LinearModel, mitk::GenericParamModel, mitk::ExponentialSaturationModel, mitk::ExponentialDecayModel, mitk::ExpDecayOffsetModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetModelType()

virtual std::string mitk::ModelTraitsInterface::GetModelType ( ) const
pure virtual

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

Returns
The model type string.

Implemented in mitk::TwoTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::TwoCompartmentExchangeModel, mitk::StandardToftsModel, mitk::OneTissueCompartmentModel, mitk::ExtendedToftsModel, mitk::ExtendedOneTissueCompartmentModel, mitk::DescriptivePharmacokineticBrixModel, mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::ModelBase, mitk::LinearModel, mitk::GenericParamModel, mitk::ExponentialSaturationModel, mitk::ExponentialDecayModel, mitk::ExpDecayOffsetModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetNumberOfDerivedParameters()

virtual DerivedParametersSizeType mitk::ModelTraitsInterface::GetNumberOfDerivedParameters ( ) const
pure virtual

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

Returns
The number of derived parameters.

Implemented in mitk::StandardToftsModel, mitk::ExtendedToftsModel, mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::ModelBase, mitk::LinearModel, mitk::ExponentialDecayModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetNumberOfParameters()

virtual ParametersSizeType mitk::ModelTraitsInterface::GetNumberOfParameters ( ) const
pure virtual

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

Returns
The number of model parameters.

Implemented in mitk::TwoTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::TwoCompartmentExchangeModel, mitk::StandardToftsModel, mitk::OneTissueCompartmentModel, mitk::ExtendedToftsModel, mitk::ExtendedOneTissueCompartmentModel, mitk::DescriptivePharmacokineticBrixModel, mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::LinearModel, mitk::GenericParamModel, mitk::ExponentialSaturationModel, mitk::ExponentialDecayModel, mitk::ExpDecayOffsetModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetParameterNames()

virtual ParameterNamesType mitk::ModelTraitsInterface::GetParameterNames ( ) const
pure virtual

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.

Implemented in mitk::TwoTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::TwoCompartmentExchangeModel, mitk::StandardToftsModel, mitk::OneTissueCompartmentModel, mitk::ExtendedToftsModel, mitk::ExtendedOneTissueCompartmentModel, mitk::DescriptivePharmacokineticBrixModel, mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::LinearModel, mitk::GenericParamModel, mitk::ExponentialSaturationModel, mitk::ExponentialDecayModel, mitk::ExpDecayOffsetModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetParameterScales()

virtual ParamterScaleMapType mitk::ModelTraitsInterface::GetParameterScales ( ) const
pure virtual

Returns the scaling factors for all model parameters.

Returns
A map from parameter name to its scale factor.

Implemented in mitk::TestModel, mitk::ModelBase, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetParameterUnits()

virtual ParamterUnitMapType mitk::ModelTraitsInterface::GetParameterUnits ( ) const
pure virtual

Returns the unit strings for all model parameters.

Returns
A map from parameter name to its unit string.

Implemented in mitk::TwoTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::TwoCompartmentExchangeModel, mitk::StandardToftsModel, mitk::OneTissueCompartmentModel, mitk::ExtendedToftsModel, mitk::ExtendedOneTissueCompartmentModel, mitk::DescriptivePharmacokineticBrixModel, mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::ModelBase, mitk::LinearModel, mitk::GenericParamModel, mitk::ExponentialSaturationModel, mitk::ExponentialDecayModel, mitk::ExpDecayOffsetModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetXAxisName()

virtual std::string mitk::ModelTraitsInterface::GetXAxisName ( ) const
pure virtual

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

Returns
The x-axis name string.

Implemented in mitk::DescriptivePharmacokineticBrixModel, mitk::AIFBasedModelBase, mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::ModelBase, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::ExponentialDecayModel, mitk::ExpDecayOffsetModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetXAxisUnit()

virtual std::string mitk::ModelTraitsInterface::GetXAxisUnit ( ) const
pure virtual

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

Returns
The x-axis unit string.

Implemented in mitk::DescriptivePharmacokineticBrixModel, mitk::AIFBasedModelBase, mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::ModelBase, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::ExponentialDecayModel, mitk::ExpDecayOffsetModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetXName()

virtual std::string mitk::ModelTraitsInterface::GetXName ( ) const
pure virtual

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

Returns
The variable name string.

Implemented in mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::ModelBase, mitk::LinearModel, mitk::GenericParamModel, mitk::ExponentialSaturationModel, mitk::ExponentialDecayModel, mitk::ExpDecayOffsetModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetYAxisName()

virtual std::string mitk::ModelTraitsInterface::GetYAxisName ( ) const
pure virtual

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

Returns
The y-axis name string.

Implemented in mitk::DescriptivePharmacokineticBrixModel, mitk::AIFBasedModelBase, mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::ModelBase, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::ExponentialDecayModel, mitk::ExpDecayOffsetModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

◆ GetYAxisUnit()

virtual std::string mitk::ModelTraitsInterface::GetYAxisUnit ( ) const
pure virtual

Returns the unit of the y-axis.

Returns
The y-axis unit string.

Implemented in mitk::DescriptivePharmacokineticBrixModel, mitk::AIFBasedModelBase, mitk::TwoStepLinearModel, mitk::ThreeStepLinearModel, mitk::TestModel, mitk::ModelBase, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::ExponentialDecayModel, mitk::ExpDecayOffsetModel, 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 >, mitk::ConcreteModelParameterizerBase< mitk::ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ConcreteModelFactoryBase< GenericParamModel >, mitk::ConcreteModelFactoryBase< ExponentialSaturationModel >, mitk::ConcreteModelFactoryBase< LinearModel >, mitk::ConcreteModelFactoryBase< ThreeStepLinearModel >, mitk::ConcreteModelFactoryBase< TwoStepLinearModel >, mitk::ConcreteModelFactoryBase< ExponentialDecayModel >, mitk::ConcreteModelFactoryBase< TestModel >, mitk::ConcreteModelFactoryBase< DescriptivePharmacokineticBrixModel >, mitk::ConcreteModelFactoryBase< ExpDecayOffsetModel >, and mitk::ConcreteModelFactoryBase< TModelParameterizer::ModelType >.

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