Medical Imaging Interaction Toolkit  2024.06.99-60d9b802
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
mitk::ModelTraitsInterface Class Referenceabstract

#include <mitkModelTraitsInterface.h>

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

Public Types

typedef itk::Array< double > ModelResultType
 
using ParameterValueType = double
 
typedef itk::Array< ParameterValueType > ParametersType
 
typedef std::string ParameterNameType
 
typedef std::vector< ParameterNameType > ParameterNamesType
 
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

typedef ParameterNamesType mitk::ModelTraitsInterface::DerivedParameterNamesType

Definition at line 36 of file mitkModelTraitsInterface.h.

◆ DerivedParametersSizeType

typedef ParametersSizeType mitk::ModelTraitsInterface::DerivedParametersSizeType

Definition at line 37 of file mitkModelTraitsInterface.h.

◆ DerivedParamterScaleMapType

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

Definition at line 41 of file mitkModelTraitsInterface.h.

◆ DerivedParamterUnitMapType

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

Definition at line 42 of file mitkModelTraitsInterface.h.

◆ FunctionStringType

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

Definition at line 44 of file mitkModelTraitsInterface.h.

◆ ModellClassIDType

typedef std::string mitk::ModelTraitsInterface::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

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

Definition at line 34 of file mitkModelTraitsInterface.h.

◆ ParameterNameType

typedef std::string mitk::ModelTraitsInterface::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

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

Definition at line 31 of file mitkModelTraitsInterface.h.

◆ ParameterValueType

using mitk::ModelTraitsInterface::ParameterValueType = double

Definition at line 30 of file mitkModelTraitsInterface.h.

◆ ParamterScaleMapType

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

Definition at line 39 of file mitkModelTraitsInterface.h.

◆ ParamterUnitMapType

typedef std::map<ParameterNameType, std::string> mitk::ModelTraitsInterface::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()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelFactoryBase< TModel >, and mitk::ModelBase.

◆ 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::ModelBase, mitk::ConcreteModelParameterizerBase< TModel >, mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::ExponentialDecayModel, mitk::ConcreteModelFactoryBase< TModel >, mitk::LinearModel, mitk::ExtendedToftsModel, mitk::StandardToftsModel, and mitk::TestModel.

◆ GetDerivedParameterScales()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelFactoryBase< TModel >, and mitk::ModelBase.

◆ GetDerivedParameterUnits()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ThreeStepLinearModel, mitk::ConcreteModelFactoryBase< TModel >, mitk::TwoStepLinearModel, mitk::ExponentialDecayModel, mitk::LinearModel, mitk::ModelBase, mitk::ExtendedToftsModel, and mitk::StandardToftsModel.

◆ GetFunctionString()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::ExponentialDecayModel, mitk::LinearModel, mitk::ModelBase, mitk::ExponentialSaturationModel, mitk::ExpDecayOffsetModel, mitk::GenericParamModel, mitk::GenericParamModelParameterizer, and mitk::TestModel.

◆ GetModelDisplayName()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ThreeStepLinearModel, mitk::ConcreteModelFactoryBase< TModel >, mitk::TwoStepLinearModel, mitk::ExponentialDecayModel, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::ModelBase, mitk::ExpDecayOffsetModel, mitk::DescriptivePharmacokineticBrixModel, mitk::TwoCompartmentExchangeModel, mitk::ExtendedToftsModel, mitk::StandardToftsModel, mitk::TwoTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::GenericParamModel, mitk::ExtendedOneTissueCompartmentModel, mitk::OneTissueCompartmentModel, and mitk::TestModel.

◆ GetModelType()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ThreeStepLinearModel, mitk::ConcreteModelFactoryBase< TModel >, mitk::TwoStepLinearModel, mitk::ExponentialDecayModel, mitk::LinearModel, mitk::ModelBase, mitk::ExponentialSaturationModel, mitk::ExpDecayOffsetModel, mitk::DescriptivePharmacokineticBrixModel, mitk::TwoCompartmentExchangeModel, mitk::ExtendedToftsModel, mitk::StandardToftsModel, mitk::TwoTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::GenericParamModel, mitk::ExtendedOneTissueCompartmentModel, mitk::OneTissueCompartmentModel, and mitk::TestModel.

◆ 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::ModelBase, mitk::ConcreteModelParameterizerBase< TModel >, mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::ConcreteModelFactoryBase< TModel >, mitk::ExponentialDecayModel, mitk::LinearModel, mitk::ExtendedToftsModel, mitk::StandardToftsModel, and mitk::TestModel.

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

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

◆ GetParameterScales()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ModelBase, mitk::ConcreteModelFactoryBase< TModel >, and mitk::TestModel.

◆ GetParameterUnits()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ThreeStepLinearModel, mitk::DescriptivePharmacokineticBrixModel, mitk::TwoStepLinearModel, mitk::ExponentialDecayModel, mitk::TwoCompartmentExchangeModel, mitk::ExponentialSaturationModel, mitk::ConcreteModelFactoryBase< TModel >, mitk::ExpDecayOffsetModel, mitk::LinearModel, mitk::ModelBase, mitk::ExtendedToftsModel, mitk::GenericParamModel, mitk::StandardToftsModel, mitk::TwoTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::ExtendedOneTissueCompartmentModel, mitk::OneTissueCompartmentModel, and mitk::TestModel.

◆ GetXAxisName()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::ExponentialDecayModel, mitk::ModelBase, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::ExpDecayOffsetModel, mitk::DescriptivePharmacokineticBrixModel, mitk::AIFBasedModelBase, and mitk::TestModel.

◆ GetXAxisUnit()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::ExponentialDecayModel, mitk::ModelBase, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::ExpDecayOffsetModel, mitk::DescriptivePharmacokineticBrixModel, mitk::AIFBasedModelBase, and mitk::TestModel.

◆ GetXName()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::ExponentialDecayModel, mitk::ModelBase, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::ExpDecayOffsetModel, mitk::GenericParamModel, and mitk::TestModel.

◆ GetYAxisName()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::ModelBase, mitk::ExponentialDecayModel, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::ExpDecayOffsetModel, mitk::DescriptivePharmacokineticBrixModel, mitk::AIFBasedModelBase, and mitk::TestModel.

◆ GetYAxisUnit()

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

Implemented in mitk::ConcreteModelParameterizerBase< TModel >, mitk::ConcreteModelFactoryBase< TModel >, mitk::ThreeStepLinearModel, mitk::TwoStepLinearModel, mitk::ModelBase, mitk::ExponentialDecayModel, mitk::LinearModel, mitk::ExponentialSaturationModel, mitk::ExpDecayOffsetModel, mitk::DescriptivePharmacokineticBrixModel, mitk::AIFBasedModelBase, and mitk::TestModel.

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