Medical Imaging Interaction Toolkit  2018.4.99-a3d2e8fb
Medical Imaging Interaction Toolkit
mitk::StandardToftsModel Class Reference

Implementation of the Model function of the Tofts pharmacokinetic model, using an Aterial Input Function The Model calculates the Concentration-Time-Curve as a convolution of the plasma curve Cp (the AIF) and a tissue specific residue function (in this case an exponential: R(t) = ktrans * exp(-ktrans/ve * (t)) ). C(t) = vp * Cp(t) + conv(Cp(t),R(t)) The parameters ktrans, ve and ve are subject to the fitting routine. More...

#include <mitkStandardToftsModel.h>

Inheritance diagram for mitk::StandardToftsModel:
Collaboration diagram for mitk::StandardToftsModel:

Public Types

typedef StandardToftsModel Self
 
typedef AIFBasedModelBase Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::AIFBasedModelBase
typedef AIFBasedModelBase Self
 
typedef ModelBase Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::Array< double > AterialInputFunctionType
 
- Public Types inherited from mitk::ModelBase
typedef ModelBase Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef ModelTraitsInterface::ModelResultType ModelResultType
 
typedef ModelTraitsInterface::ParameterValueType ParameterValueType
 
typedef ModelTraitsInterface::ParametersType ParametersType
 
typedef itk::Array< double > TimeGridType
 
typedef ModelTraitsInterface::ParameterNameType ParameterNameType
 
typedef ModelTraitsInterface::ParameterNamesType ParameterNamesType
 
typedef ModelTraitsInterface::ParametersSizeType ParametersSizeType
 
typedef ModelTraitsInterface::DerivedParameterNamesType DerivedParameterNamesType
 
typedef ModelTraitsInterface::DerivedParametersSizeType DerivedParametersSizeType
 
typedef double StaticParameterValueType
 
typedef std::vector< StaticParameterValueTypeStaticParameterValuesType
 
typedef std::map< ParameterNameType, StaticParameterValuesTypeStaticParameterMapType
 
typedef double DerivedParameterValueType
 
typedef std::map< ParameterNameType, DerivedParameterValueTypeDerivedParameterMapType
 
- Public Types inherited from mitk::ModelTraitsInterface
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

Pointer Clone () const
 
virtual const char * GetClassName () const
 
std::string GetModelDisplayName () const override
 
std::string GetModelType () const override
 
ParameterNamesType GetParameterNames () const override
 
ParametersSizeType GetNumberOfParameters () const override
 
ParamterUnitMapType GetParameterUnits () const override
 
ParameterNamesType GetDerivedParameterNames () const override
 
ParametersSizeType GetNumberOfDerivedParameters () const override
 
ParamterUnitMapType GetDerivedParameterUnits () const override
 
- Public Member Functions inherited from mitk::AIFBasedModelBase
virtual const AterialInputFunctionTypeGetAterialInputFunctionValues ()
 
virtual const TimeGridTypeGetAterialInputFunctionTimeGrid ()
 
virtual void SetAterialInputFunctionValues (AterialInputFunctionType _arg)
 
virtual void SetAterialInputFunctionTimeGrid (TimeGridType _arg)
 
std::string GetXAxisName () const override
 
std::string GetXAxisUnit () const override
 
std::string GetYAxisName () const override
 
std::string GetYAxisUnit () const override
 
const TimeGridTypeGetCurrentAterialInputFunctionTimeGrid () const
 
const AterialInputFunctionType GetAterialInputFunction (TimeGridType currentTimeGrid) const
 
ParameterNamesType GetStaticParameterNames () const override
 
ParametersSizeType GetNumberOfStaticParameters () const override
 
ParamterUnitMapType GetStaticParameterUnits () const override
 
- Public Member Functions inherited from mitk::ModelBase
ParamterScaleMapType GetParameterScales () const override
 
DerivedParamterScaleMapType GetDerivedParameterScales () const override
 
FunctionStringType GetFunctionString () const override
 
ModellClassIDType GetClassID () const override
 
std::string GetXName () const override
 
void SetStaticParameters (const StaticParameterMapType &parameters, bool allParameters=true)
 
StaticParameterMapType GetStaticParameters () const
 
DerivedParameterMapType GetDerivedParameters (const ParametersType &parameters) const
 
virtual void SetTimeGrid (const TimeGridType &grid)
 
virtual const TimeGridTypeGetTimeGrid ()
 
ModelResultType GetSignal (const ParametersType &parameters) const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const std::string MODEL_DISPLAY_NAME
 
static const std::string NAME_PARAMETER_Ktrans
 
static const std::string NAME_PARAMETER_ve
 
static const std::string NAME_PARAMETER_vp
 
static const std::string UNIT_PARAMETER_Ktrans
 
static const std::string UNIT_PARAMETER_ve
 
static const std::string UNIT_PARAMETER_vp
 
static const unsigned int POSITION_PARAMETER_Ktrans
 
static const unsigned int POSITION_PARAMETER_ve
 
static const unsigned int POSITION_PARAMETER_vp
 
static const unsigned int NUMBER_OF_PARAMETERS
 
- Static Public Attributes inherited from mitk::AIFBasedModelBase
static const std::string NAME_STATIC_PARAMETER_AIF
 
static const std::string NAME_STATIC_PARAMETER_AIFTimeGrid
 
static const std::string UNIT_STATIC_PARAMETER_AIF
 
static const std::string UNIT_STATIC_PARAMETER_AIFTimeGrid
 

Protected Member Functions

 StandardToftsModel ()
 
 ~StandardToftsModel () override
 
itk::LightObject::Pointer InternalClone () const override
 
ModelResultType ComputeModelfunction (const ParametersType &parameters) const override
 
DerivedParameterMapType ComputeDerivedParameters (const mitk::ModelBase::ParametersType &parameters) const override
 
void PrintSelf (std::ostream &os, ::itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::AIFBasedModelBase
 AIFBasedModelBase ()
 
 ~AIFBasedModelBase () override
 
bool ValidateModel (std::string &error) const override
 
void PrintSelf (std::ostream &os, ::itk::Indent indent) const override
 
void SetStaticParameter (const ParameterNameType &name, const StaticParameterValuesType &values) override
 
StaticParameterValuesType GetStaticParameterValue (const ParameterNameType &name) const override
 
- Protected Member Functions inherited from mitk::ModelBase
 ModelBase ()
 
 ~ModelBase () override
 
void PrintSelf (std::ostream &os, ::itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::ModelTraitsInterface
 ModelTraitsInterface ()
 
virtual ~ModelTraitsInterface ()
 

Additional Inherited Members

- Protected Attributes inherited from mitk::AIFBasedModelBase
TimeGridType m_AterialInputFunctionTimeGrid
 
AterialInputFunctionType m_AterialInputFunctionValues
 
- Protected Attributes inherited from mitk::ModelBase
TimeGridType m_TimeGrid
 

Detailed Description

Implementation of the Model function of the Tofts pharmacokinetic model, using an Aterial Input Function The Model calculates the Concentration-Time-Curve as a convolution of the plasma curve Cp (the AIF) and a tissue specific residue function (in this case an exponential: R(t) = ktrans * exp(-ktrans/ve * (t)) ). C(t) = vp * Cp(t) + conv(Cp(t),R(t)) The parameters ktrans, ve and ve are subject to the fitting routine.

Definition at line 28 of file mitkStandardToftsModel.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ StandardToftsModel()

mitk::StandardToftsModel::StandardToftsModel ( )
protected

Definition at line 41 of file mitkStandardToftsModel.cpp.

◆ ~StandardToftsModel()

mitk::StandardToftsModel::~StandardToftsModel ( )
overrideprotected

Definition at line 46 of file mitkStandardToftsModel.cpp.

Member Function Documentation

◆ Clone()

Pointer mitk::StandardToftsModel::Clone ( ) const

◆ ComputeDerivedParameters()

mitk::ModelBase::DerivedParameterMapType mitk::StandardToftsModel::ComputeDerivedParameters ( const mitk::ModelBase::ParametersType parameters) const
overrideprotectedvirtual

Helper function called by GetDerivedParameters(). Implement in derived classes to realize the concrete computation of derived parameters.

Remarks
Default implementation has no derived parameters

Reimplemented from mitk::ModelBase.

Definition at line 144 of file mitkStandardToftsModel.cpp.

References POSITION_PARAMETER_Ktrans, and POSITION_PARAMETER_ve.

◆ ComputeModelfunction()

mitk::StandardToftsModel::ModelResultType mitk::StandardToftsModel::ComputeModelfunction ( const ParametersType parameters) const
overrideprotectedvirtual

◆ GetClassName()

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

Run-time type information (and related methods).

Reimplemented from mitk::AIFBasedModelBase.

◆ GetDerivedParameterNames()

mitk::StandardToftsModel::ParameterNamesType mitk::StandardToftsModel::GetDerivedParameterNames ( ) const
overridevirtual

Returns the names of derived parameters that can/will be computed by the model given specific model parameters.

Remarks
Default implementation has no derived parameters

Reimplemented from mitk::ModelBase.

Definition at line 78 of file mitkStandardToftsModel.cpp.

◆ GetDerivedParameterUnits()

mitk::StandardToftsModel::ParamterUnitMapType mitk::StandardToftsModel::GetDerivedParameterUnits ( ) const
overridevirtual

Default implementation returns no unit string ("") for every defined derived parameter.

Reimplemented from mitk::ModelBase.

Definition at line 91 of file mitkStandardToftsModel.cpp.

◆ GetModelDisplayName()

std::string mitk::StandardToftsModel::GetModelDisplayName ( ) const
overridevirtual

Default implementation returns GetClassID as display name.

Reimplemented from mitk::ModelBase.

Definition at line 31 of file mitkStandardToftsModel.cpp.

References MODEL_DISPLAY_NAME.

◆ GetModelType()

std::string mitk::StandardToftsModel::GetModelType ( ) const
overridevirtual

Default implementation returns "Unkown" as model type.

Reimplemented from mitk::ModelBase.

Definition at line 36 of file mitkStandardToftsModel.cpp.

◆ GetNumberOfDerivedParameters()

mitk::StandardToftsModel::ParametersSizeType mitk::StandardToftsModel::GetNumberOfDerivedParameters ( ) const
overridevirtual

Returns the number of derived parameters that can/will be computed by the model given specific model parameters.

Remarks
Default implementation has no derived parameters

Reimplemented from mitk::ModelBase.

Definition at line 86 of file mitkStandardToftsModel.cpp.

◆ GetNumberOfParameters()

mitk::StandardToftsModel::ParametersSizeType mitk::StandardToftsModel::GetNumberOfParameters ( ) const
overridevirtual

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

Implements mitk::ModelTraitsInterface.

Definition at line 61 of file mitkStandardToftsModel.cpp.

References NUMBER_OF_PARAMETERS.

◆ GetParameterNames()

mitk::StandardToftsModel::ParameterNamesType mitk::StandardToftsModel::GetParameterNames ( ) const
overridevirtual

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

Implements mitk::ModelTraitsInterface.

Definition at line 51 of file mitkStandardToftsModel.cpp.

References NAME_PARAMETER_Ktrans, and NAME_PARAMETER_ve.

◆ GetParameterUnits()

mitk::StandardToftsModel::ParamterUnitMapType mitk::StandardToftsModel::GetParameterUnits ( ) const
overridevirtual

Default implementation returns no unit string ("") for every defined parameter.

Reimplemented from mitk::ModelBase.

Definition at line 67 of file mitkStandardToftsModel.cpp.

References NAME_PARAMETER_Ktrans, NAME_PARAMETER_ve, UNIT_PARAMETER_Ktrans, and UNIT_PARAMETER_ve.

◆ InternalClone()

itk::LightObject::Pointer mitk::StandardToftsModel::InternalClone ( ) const
overrideprotected

Actual implementation of the clone method. This method should be reimplemeted in subclasses to clone the extra required parameters.

Definition at line 153 of file mitkStandardToftsModel.cpp.

References mitk::ModelBase::m_TimeGrid, and New().

◆ New()

static Pointer mitk::StandardToftsModel::New ( )
static

Method for creation through the object factory.

Referenced by InternalClone().

◆ PrintSelf()

void mitk::StandardToftsModel::PrintSelf ( std::ostream &  os,
::itk::Indent  indent 
) const
overrideprotected

Definition at line 162 of file mitkStandardToftsModel.cpp.

References mitk::AIFBasedModelBase::PrintSelf().

Member Data Documentation

◆ MODEL_DISPLAY_NAME

const std::string mitk::StandardToftsModel::MODEL_DISPLAY_NAME
static

Definition at line 42 of file mitkStandardToftsModel.h.

Referenced by GetModelDisplayName().

◆ NAME_PARAMETER_Ktrans

const std::string mitk::StandardToftsModel::NAME_PARAMETER_Ktrans
static

Definition at line 46 of file mitkStandardToftsModel.h.

Referenced by GetParameterNames(), and GetParameterUnits().

◆ NAME_PARAMETER_ve

const std::string mitk::StandardToftsModel::NAME_PARAMETER_ve
static

Definition at line 47 of file mitkStandardToftsModel.h.

Referenced by GetParameterNames(), and GetParameterUnits().

◆ NAME_PARAMETER_vp

const std::string mitk::StandardToftsModel::NAME_PARAMETER_vp
static

Definition at line 48 of file mitkStandardToftsModel.h.

◆ NUMBER_OF_PARAMETERS

const unsigned int mitk::StandardToftsModel::NUMBER_OF_PARAMETERS
static

Definition at line 58 of file mitkStandardToftsModel.h.

Referenced by GetNumberOfParameters().

◆ POSITION_PARAMETER_Ktrans

const unsigned int mitk::StandardToftsModel::POSITION_PARAMETER_Ktrans
static

◆ POSITION_PARAMETER_ve

const unsigned int mitk::StandardToftsModel::POSITION_PARAMETER_ve
static

◆ POSITION_PARAMETER_vp

const unsigned int mitk::StandardToftsModel::POSITION_PARAMETER_vp
static

Definition at line 56 of file mitkStandardToftsModel.h.

◆ UNIT_PARAMETER_Ktrans

const std::string mitk::StandardToftsModel::UNIT_PARAMETER_Ktrans
static

Definition at line 50 of file mitkStandardToftsModel.h.

Referenced by GetParameterUnits().

◆ UNIT_PARAMETER_ve

const std::string mitk::StandardToftsModel::UNIT_PARAMETER_ve
static

Definition at line 51 of file mitkStandardToftsModel.h.

Referenced by GetParameterUnits().

◆ UNIT_PARAMETER_vp

const std::string mitk::StandardToftsModel::UNIT_PARAMETER_vp
static

Definition at line 52 of file mitkStandardToftsModel.h.


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