Medical Imaging Interaction Toolkit  2025.12.02
Medical Imaging Interaction Toolkit
mitk::ModelTraitsInterface Class Referenceabstract

#include <mitkModelTraitsInterface.h>

Inheritance diagram for mitk::ModelTraitsInterface:

Public Types

typedef itk::Array< double > ModelResultType
 
using ParameterValueType = double
 
typedef itk::Array< ParameterValueTypeParametersType
 
typedef std::string ParameterNameType
 
typedef std::vector< ParameterNameTypeParameterNamesType
 
typedef ParametersType::SizeValueType ParametersSizeType
 
typedef ParameterNamesType DerivedParameterNamesType
 
typedef ParametersSizeType DerivedParametersSizeType
 
typedef std::map< ParameterNameType, double > ParamterScaleMapType
 
typedef std::map< ParameterNameType, std::string > ParamterUnitMapType
 
typedef std::map< ParameterNameType, double > DerivedParamterScaleMapType
 
typedef std::map< ParameterNameType, std::string > DerivedParamterUnitMapType
 
typedef std::string FunctionStringType
 
typedef std::string ModellClassIDType
 

Public Member Functions

virtual ParameterNamesType GetParameterNames () const =0
 
virtual ParametersSizeType GetNumberOfParameters () const =0
 
virtual ParamterScaleMapType GetParameterScales () const =0
 
virtual ParamterUnitMapType GetParameterUnits () const =0
 
virtual DerivedParameterNamesType GetDerivedParameterNames () const =0
 
virtual DerivedParametersSizeType GetNumberOfDerivedParameters () const =0
 
virtual DerivedParamterScaleMapType GetDerivedParameterScales () const =0
 
virtual DerivedParamterUnitMapType GetDerivedParameterUnits () const =0
 
virtual std::string GetModelDisplayName () const =0
 
virtual std::string GetModelType () const =0
 
virtual FunctionStringType GetFunctionString () const =0
 
virtual ModellClassIDType GetClassID () const =0
 
virtual std::string GetXName () const =0
 
virtual std::string GetXAxisName () const =0
 
virtual std::string GetXAxisUnit () const =0
 
virtual std::string GetYAxisName () const =0
 
virtual std::string GetYAxisUnit () const =0
 

Protected Member Functions

 ModelTraitsInterface ()
 
virtual ~ModelTraitsInterface ()
 

Detailed Description

Definition at line 24 of file mitkModelTraitsInterface.h.

Member Typedef Documentation

◆ DerivedParameterNamesType

◆ DerivedParametersSizeType

◆ DerivedParamterScaleMapType

◆ DerivedParamterUnitMapType

◆ FunctionStringType

Definition at line 44 of file mitkModelTraitsInterface.h.

◆ ModellClassIDType

Definition at line 45 of file mitkModelTraitsInterface.h.

◆ ModelResultType

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

Definition at line 29 of file mitkModelTraitsInterface.h.

◆ ParameterNamesType

◆ ParameterNameType

Definition at line 33 of file mitkModelTraitsInterface.h.

◆ ParametersSizeType

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

Definition at line 35 of file mitkModelTraitsInterface.h.

◆ ParametersType

◆ ParameterValueType

◆ ParamterScaleMapType

◆ ParamterUnitMapType

Definition at line 40 of file mitkModelTraitsInterface.h.

Constructor & Destructor Documentation

◆ ModelTraitsInterface()

mitk::ModelTraitsInterface::ModelTraitsInterface ( )
inlineprotected

Definition at line 84 of file mitkModelTraitsInterface.h.

◆ ~ModelTraitsInterface()

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

Definition at line 85 of file mitkModelTraitsInterface.h.

Member Function Documentation

◆ GetClassID()

◆ GetDerivedParameterNames()

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

Returns the names of derived parameters that must be defined when using the model to compute them (GetDerivedParameters()).

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

◆ GetDerivedParameterUnits()

◆ GetFunctionString()

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

◆ GetModelDisplayName()

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

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

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 must be defined when using the model to compute them (GetDerivedParameters()).

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()).

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()).

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

◆ GetParameterUnits()

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

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

◆ GetXAxisUnit()

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

◆ GetXName()

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

◆ GetYAxisName()

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

◆ GetYAxisUnit()

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

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