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 <mitkOneTissueCompartmentModel.h>

Inheritance diagram for mitk::OneTissueCompartmentModel:

[legend]

Collaboration diagram for mitk::OneTissueCompartmentModel:

[legend]

Public Types
typedef OneTissueCompartmentModel	Self

typedef AIFBasedModelBase	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::AIFBasedModelBase
typedef AIFBasedModelBase	Self

typedef ModelBase	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef itk::Array< double >	AterialInputFunctionType

Public Types inherited from mitk::ModelBase
typedef ModelBase	Self

typedef itk::Object	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

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

typedef std::map< ParameterNameType, StaticParameterValuesType >	StaticParameterMapType

typedef double	DerivedParameterValueType

typedef std::map< ParameterNameType, DerivedParameterValueType >	DerivedParameterMapType

Public Types inherited from mitk::ModelTraitsInterface
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
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

Public Member Functions inherited from mitk::AIFBasedModelBase
virtual const AterialInputFunctionType &	GetAterialInputFunctionValues ()

virtual const TimeGridType &	GetAterialInputFunctionTimeGrid ()

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 TimeGridType &	GetCurrentAterialInputFunctionTimeGrid () 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

DerivedParamterUnitMapType	GetDerivedParameterUnits () const override

FunctionStringType	GetFunctionString () const override

ModellClassIDType	GetClassID () const override

std::string	GetXName () const override

DerivedParameterNamesType	GetDerivedParameterNames () const override

DerivedParametersSizeType	GetNumberOfDerivedParameters () 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 TimeGridType &	GetTimeGrid ()

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_k1

static const std::string	NAME_PARAMETER_k2

static const std::string	UNIT_PARAMETER_k1

static const std::string	UNIT_PARAMETER_k2

static const unsigned int	POSITION_PARAMETER_k1

static const unsigned int	POSITION_PARAMETER_k2

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

	~OneTissueCompartmentModel () override

itk::LightObject::Pointer	InternalClone () const override

ModelResultType	ComputeModelfunction (const 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
virtual DerivedParameterMapType	ComputeDerivedParameters (const ParametersType &parameters) const

	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 mitkOneTissueCompartmentModel.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 35 of file mitkOneTissueCompartmentModel.h.

◆ Pointer

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

Definition at line 34 of file mitkOneTissueCompartmentModel.h.

◆ Self

typedef OneTissueCompartmentModel mitk::OneTissueCompartmentModel::Self

Definition at line 32 of file mitkOneTissueCompartmentModel.h.

◆ Superclass

typedef AIFBasedModelBase mitk::OneTissueCompartmentModel::Superclass

Definition at line 33 of file mitkOneTissueCompartmentModel.h.

Constructor & Destructor Documentation

◆ OneTissueCompartmentModel()

mitk::OneTissueCompartmentModel::OneTissueCompartmentModel ( )

protected

◆ ~OneTissueCompartmentModel()

mitk::OneTissueCompartmentModel::~OneTissueCompartmentModel ( )

overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::OneTissueCompartmentModel::Clone ( ) const

◆ ComputeModelfunction()

ModelResultType mitk::OneTissueCompartmentModel::ComputeModelfunction ( const ParametersType & parameters ) const

overrideprotectedvirtual

Implements mitk::ModelBase.

◆ GetClassName()

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

virtual

Run-time type information (and related methods).

Reimplemented from mitk::AIFBasedModelBase.

◆ GetModelDisplayName()

std::string mitk::OneTissueCompartmentModel::GetModelDisplayName ( ) const

overridevirtual

Default implementation returns GetClassID as display name.

Reimplemented from mitk::ModelBase.

◆ GetModelType()

std::string mitk::OneTissueCompartmentModel::GetModelType ( ) const

overridevirtual

Default implementation returns "Unkown" as model type.

Reimplemented from mitk::ModelBase.

◆ GetNumberOfParameters()

ParametersSizeType mitk::OneTissueCompartmentModel::GetNumberOfParameters ( ) const

overridevirtual

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

Implements mitk::ModelTraitsInterface.

◆ GetParameterNames()

ParameterNamesType mitk::OneTissueCompartmentModel::GetParameterNames ( ) const

overridevirtual

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

Implements mitk::ModelTraitsInterface.

◆ GetParameterUnits()

ParamterUnitMapType mitk::OneTissueCompartmentModel::GetParameterUnits ( ) const

overridevirtual

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

Reimplemented from mitk::ModelBase.

◆ InternalClone()

itk::LightObject::Pointer mitk::OneTissueCompartmentModel::InternalClone ( ) const

overrideprotected

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

◆ New()

static Pointer mitk::OneTissueCompartmentModel::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

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

overrideprotected

Member Data Documentation

◆ MODEL_DISPLAY_NAME

const std::string mitk::OneTissueCompartmentModel::MODEL_DISPLAY_NAME

static

Definition at line 42 of file mitkOneTissueCompartmentModel.h.

◆ NAME_PARAMETER_k1

const std::string mitk::OneTissueCompartmentModel::NAME_PARAMETER_k1

static

Definition at line 46 of file mitkOneTissueCompartmentModel.h.

◆ NAME_PARAMETER_k2

const std::string mitk::OneTissueCompartmentModel::NAME_PARAMETER_k2

static

Definition at line 47 of file mitkOneTissueCompartmentModel.h.

◆ NUMBER_OF_PARAMETERS

const unsigned int mitk::OneTissueCompartmentModel::NUMBER_OF_PARAMETERS

static

Definition at line 55 of file mitkOneTissueCompartmentModel.h.

◆ POSITION_PARAMETER_k1

const unsigned int mitk::OneTissueCompartmentModel::POSITION_PARAMETER_k1

static

Definition at line 52 of file mitkOneTissueCompartmentModel.h.

◆ POSITION_PARAMETER_k2

const unsigned int mitk::OneTissueCompartmentModel::POSITION_PARAMETER_k2

static

Definition at line 53 of file mitkOneTissueCompartmentModel.h.

◆ UNIT_PARAMETER_k1

const std::string mitk::OneTissueCompartmentModel::UNIT_PARAMETER_k1

static

Definition at line 49 of file mitkOneTissueCompartmentModel.h.

◆ UNIT_PARAMETER_k2

const std::string mitk::OneTissueCompartmentModel::UNIT_PARAMETER_k2

static

Definition at line 50 of file mitkOneTissueCompartmentModel.h.

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

mitkOneTissueCompartmentModel.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ OneTissueCompartmentModel()

◆ ~OneTissueCompartmentModel()

Member Function Documentation

◆ Clone()

◆ ComputeModelfunction()

◆ GetClassName()

◆ GetModelDisplayName()

◆ GetModelType()

◆ GetNumberOfParameters()

◆ GetParameterNames()

◆ GetParameterUnits()

◆ InternalClone()

◆ New()

◆ PrintSelf()

Member Data Documentation

◆ MODEL_DISPLAY_NAME

◆ NAME_PARAMETER_k1

◆ NAME_PARAMETER_k2

◆ NUMBER_OF_PARAMETERS

◆ POSITION_PARAMETER_k1

◆ POSITION_PARAMETER_k2

◆ UNIT_PARAMETER_k1

◆ UNIT_PARAMETER_k2