mitk::DescriptivePharmacokineticBrixModel Class Reference

#include <mitkDescriptivePharmacokineticBrixModel.h>

Inheritance diagram for mitk::DescriptivePharmacokineticBrixModel:

Collaboration diagram for mitk::DescriptivePharmacokineticBrixModel:

Public Types
typedef DescriptivePharmacokineticBrixModel	Self
typedef ModelBase	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
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
virtual void	SetTau (double _arg)
virtual const double &	GetTau ()
virtual void	SetS0 (double _arg)
virtual const double &	GetS0 ()
std::string	GetModelDisplayName () const override
std::string	GetModelType () const override
std::string	GetXAxisName () const override
std::string	GetXAxisUnit () const override
std::string	GetYAxisName () const override
std::string	GetYAxisUnit () const override
ParameterNamesType	GetParameterNames () const override
ParametersSizeType	GetNumberOfParameters () const override
ParamterUnitMapType	GetParameterUnits () const override
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_A
static const std::string	NAME_PARAMETER_kep
static const std::string	NAME_PARAMETER_kel
static const std::string	NAME_PARAMETER_tlag
static const std::string	NAME_STATIC_PARAMETER_Tau
static const std::string	NAME_STATIC_PARAMETER_S0
static const std::string	UNIT_PARAMETER_A
static const std::string	UNIT_PARAMETER_kep
static const std::string	UNIT_PARAMETER_kel
static const std::string	UNIT_PARAMETER_tlag
static const std::string	UNIT_STATIC_PARAMETER_Tau
static const std::string	UNIT_STATIC_PARAMETER_S0
static const unsigned int	POSITION_PARAMETER_A
static const unsigned int	POSITION_PARAMETER_kep
static const unsigned int	POSITION_PARAMETER_kel
static const unsigned int	POSITION_PARAMETER_tlag
static const unsigned int	NUMBER_OF_PARAMETERS

Protected Member Functions
	DescriptivePharmacokineticBrixModel ()
	~DescriptivePharmacokineticBrixModel () override
itk::LightObject::Pointer	InternalClone () const override
ModelResultType	ComputeModelfunction (const ParametersType &parameters) const override
void	SetStaticParameter (const ParameterNameType &name, const StaticParameterValuesType &values) override
StaticParameterValuesType	GetStaticParameterValue (const ParameterNameType &name) const override
void	PrintSelf (std::ostream &os, ::itk::Indent indent) const override
Protected Member Functions inherited from mitk::ModelBase
virtual bool	ValidateModel (std::string &error) const
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::ModelBase
TimeGridType	m_TimeGrid

Detailed Description

Definition at line 24 of file mitkDescriptivePharmacokineticBrixModel.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 31 of file mitkDescriptivePharmacokineticBrixModel.h.

Pointer

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

Definition at line 30 of file mitkDescriptivePharmacokineticBrixModel.h.

Self

typedef DescriptivePharmacokineticBrixModel mitk::DescriptivePharmacokineticBrixModel::Self

Definition at line 28 of file mitkDescriptivePharmacokineticBrixModel.h.

Superclass

typedef ModelBase mitk::DescriptivePharmacokineticBrixModel::Superclass

Definition at line 29 of file mitkDescriptivePharmacokineticBrixModel.h.

Constructor & Destructor Documentation

DescriptivePharmacokineticBrixModel()

mitk::DescriptivePharmacokineticBrixModel::DescriptivePharmacokineticBrixModel ( )

protected

Definition at line 73 of file mitkDescriptivePharmacokineticBrixModel.cpp.

~DescriptivePharmacokineticBrixModel()

mitk::DescriptivePharmacokineticBrixModel::~DescriptivePharmacokineticBrixModel ( )

overrideprotected

Definition at line 78 of file mitkDescriptivePharmacokineticBrixModel.cpp.

Member Function Documentation

Clone()

Pointer mitk::DescriptivePharmacokineticBrixModel::Clone

(

)

const

ComputeModelfunction()

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

overrideprotectedvirtual

Implements mitk::ModelBase.

Definition at line 145 of file mitkDescriptivePharmacokineticBrixModel.cpp.

References mitk::ModelBase::m_TimeGrid, POSITION_PARAMETER_A, POSITION_PARAMETER_kel, POSITION_PARAMETER_kep, and POSITION_PARAMETER_tlag.

GetClassName()

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

virtual

Run-time type information (and related methods).

Reimplemented from mitk::ModelBase.

GetModelDisplayName()

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

overridevirtual

Default implementation returns GetClassID as display name.

Reimplemented from mitk::ModelBase.

Definition at line 43 of file mitkDescriptivePharmacokineticBrixModel.cpp.

References MODEL_DISPLAY_NAME.

GetModelType()

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

overridevirtual

Default implementation returns "Unkown" as model type.

Reimplemented from mitk::ModelBase.

Definition at line 48 of file mitkDescriptivePharmacokineticBrixModel.cpp.

GetNumberOfParameters()

mitk::DescriptivePharmacokineticBrixModel::ParametersSizeType mitk::DescriptivePharmacokineticBrixModel::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 97 of file mitkDescriptivePharmacokineticBrixModel.cpp.

References NUMBER_OF_PARAMETERS.

GetNumberOfStaticParameters()

mitk::DescriptivePharmacokineticBrixModel::ParametersSizeType mitk::DescriptivePharmacokineticBrixModel::GetNumberOfStaticParameters ( ) const

overridevirtual

Returns the number of static parameters that will be used when using the model to compute the signal (but are not defined via GetSignal()).

Implements mitk::ModelBase.

Definition at line 138 of file mitkDescriptivePharmacokineticBrixModel.cpp.

GetParameterNames()

mitk::DescriptivePharmacokineticBrixModel::ParameterNamesType mitk::DescriptivePharmacokineticBrixModel::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 84 of file mitkDescriptivePharmacokineticBrixModel.cpp.

References NAME_PARAMETER_A, NAME_PARAMETER_kel, NAME_PARAMETER_kep, and NAME_PARAMETER_tlag.

GetParameterUnits()

mitk::DescriptivePharmacokineticBrixModel::ParamterUnitMapType mitk::DescriptivePharmacokineticBrixModel::GetParameterUnits ( ) const

overridevirtual

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

Reimplemented from mitk::ModelBase.

Definition at line 103 of file mitkDescriptivePharmacokineticBrixModel.cpp.

References NAME_PARAMETER_A, NAME_PARAMETER_kel, NAME_PARAMETER_kep, NAME_PARAMETER_tlag, UNIT_PARAMETER_A, UNIT_PARAMETER_kel, UNIT_PARAMETER_kep, and UNIT_PARAMETER_tlag.

GetS0()

virtual const double& mitk::DescriptivePharmacokineticBrixModel::GetS0 ( )

virtual

Referenced by GetStaticParameterValue().

GetStaticParameterNames()

mitk::DescriptivePharmacokineticBrixModel::ParameterNamesType mitk::DescriptivePharmacokineticBrixModel::GetStaticParameterNames ( ) const

overridevirtual

Returns the names of static parameters that will be used when using the model to compute the signal (but are not defined via GetSignal()).

Implements mitk::ModelBase.

Definition at line 116 of file mitkDescriptivePharmacokineticBrixModel.cpp.

References NAME_STATIC_PARAMETER_S0, and NAME_STATIC_PARAMETER_Tau.

GetStaticParameterUnits()

mitk::DescriptivePharmacokineticBrixModel::ParamterUnitMapType mitk::DescriptivePharmacokineticBrixModel::GetStaticParameterUnits ( ) const

overridevirtual

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

Reimplemented from mitk::ModelBase.

Definition at line 127 of file mitkDescriptivePharmacokineticBrixModel.cpp.

References NAME_STATIC_PARAMETER_S0, NAME_STATIC_PARAMETER_Tau, UNIT_STATIC_PARAMETER_S0, and UNIT_STATIC_PARAMETER_Tau.

GetStaticParameterValue()

mitk::DescriptivePharmacokineticBrixModel::StaticParameterValuesType mitk::DescriptivePharmacokineticBrixModel::GetStaticParameterValue ( const ParameterNameType &  name ) const

overrideprotectedvirtual

Helper function called by GetStaticParameters(). Implement in derived classes to realize the concrete retrieval of static parameters.

Implements mitk::ModelBase.

Definition at line 221 of file mitkDescriptivePharmacokineticBrixModel.cpp.

References GetS0(), GetTau(), NAME_STATIC_PARAMETER_S0, and NAME_STATIC_PARAMETER_Tau.

GetTau()

virtual const double& mitk::DescriptivePharmacokineticBrixModel::GetTau ( )

virtual

Referenced by GetStaticParameterValue().

GetXAxisName()

std::string mitk::DescriptivePharmacokineticBrixModel::GetXAxisName ( ) const

overridevirtual

Default implementation returns an empty string.

Reimplemented from mitk::ModelBase.

Definition at line 53 of file mitkDescriptivePharmacokineticBrixModel.cpp.

GetXAxisUnit()

std::string mitk::DescriptivePharmacokineticBrixModel::GetXAxisUnit ( ) const

overridevirtual

Default implementation returns an empty string.

Reimplemented from mitk::ModelBase.

Definition at line 58 of file mitkDescriptivePharmacokineticBrixModel.cpp.

GetYAxisName()

std::string mitk::DescriptivePharmacokineticBrixModel::GetYAxisName ( ) const

overridevirtual

Default implementation returns an empty string.

Reimplemented from mitk::ModelBase.

Definition at line 63 of file mitkDescriptivePharmacokineticBrixModel.cpp.

GetYAxisUnit()

std::string mitk::DescriptivePharmacokineticBrixModel::GetYAxisUnit ( ) const

overridevirtual

Default implementation returns an empty string.

Reimplemented from mitk::ModelBase.

Definition at line 68 of file mitkDescriptivePharmacokineticBrixModel.cpp.

InternalClone()

itk::LightObject::Pointer mitk::DescriptivePharmacokineticBrixModel::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 239 of file mitkDescriptivePharmacokineticBrixModel.cpp.

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

New()

static Pointer mitk::DescriptivePharmacokineticBrixModel::New ( )

static

Method for creation through the object factory.

Referenced by InternalClone(), and mitkDescriptivePharmacokineticBrixModelTest().

PrintSelf()

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

overrideprotected

Definition at line 250 of file mitkDescriptivePharmacokineticBrixModel.cpp.

References mitk::ModelBase::PrintSelf().

SetS0()

virtual void mitk::DescriptivePharmacokineticBrixModel::SetS0 ( double  _arg )

virtual

Referenced by SetStaticParameter().

SetStaticParameter()

void mitk::DescriptivePharmacokineticBrixModel::SetStaticParameter ( const ParameterNameType &  name, const StaticParameterValuesType &  values  )

overrideprotectedvirtual

Helper function called by SetStaticParameters(). Implement in derived classes to realize the concrete setting of static parameters.

Implements mitk::ModelBase.

Definition at line 206 of file mitkDescriptivePharmacokineticBrixModel.cpp.

References NAME_STATIC_PARAMETER_S0, NAME_STATIC_PARAMETER_Tau, SetS0(), and SetTau().

SetTau()

virtual void mitk::DescriptivePharmacokineticBrixModel::SetTau ( double  _arg )

virtual

Referenced by SetStaticParameter().

Member Data Documentation

MODEL_DISPLAY_NAME

const std::string mitk::DescriptivePharmacokineticBrixModel::MODEL_DISPLAY_NAME

static

Definition at line 38 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetModelDisplayName().

NAME_PARAMETER_A

const std::string mitk::DescriptivePharmacokineticBrixModel::NAME_PARAMETER_A

static

Definition at line 42 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetParameterNames(), and GetParameterUnits().

NAME_PARAMETER_kel

const std::string mitk::DescriptivePharmacokineticBrixModel::NAME_PARAMETER_kel

static

Definition at line 44 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetParameterNames(), and GetParameterUnits().

NAME_PARAMETER_kep

const std::string mitk::DescriptivePharmacokineticBrixModel::NAME_PARAMETER_kep

static

Definition at line 43 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetParameterNames(), and GetParameterUnits().

NAME_PARAMETER_tlag

const std::string mitk::DescriptivePharmacokineticBrixModel::NAME_PARAMETER_tlag

static

Definition at line 45 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetParameterNames(), and GetParameterUnits().

NAME_STATIC_PARAMETER_S0

const std::string mitk::DescriptivePharmacokineticBrixModel::NAME_STATIC_PARAMETER_S0

static

Definition at line 47 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetStaticParameterNames(), GetStaticParameterUnits(), GetStaticParameterValue(), and SetStaticParameter().

NAME_STATIC_PARAMETER_Tau

const std::string mitk::DescriptivePharmacokineticBrixModel::NAME_STATIC_PARAMETER_Tau

static

Definition at line 46 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by mitk::DescriptivePharmacokineticBrixModelFactory::DoCreateParameterizer(), GetStaticParameterNames(), GetStaticParameterUnits(), GetStaticParameterValue(), and SetStaticParameter().

NUMBER_OF_PARAMETERS

const unsigned int mitk::DescriptivePharmacokineticBrixModel::NUMBER_OF_PARAMETERS

static

Definition at line 63 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetNumberOfParameters().

POSITION_PARAMETER_A

const unsigned int mitk::DescriptivePharmacokineticBrixModel::POSITION_PARAMETER_A

static

Definition at line 56 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by ComputeModelfunction(), mitk::DescriptivePharmacokineticBrixModelValueBasedParameterizer::GetDefaultInitialParameterization(), mitk::DescriptivePharmacokineticBrixModelParameterizer::GetDefaultInitialParameterization(), and mitkDescriptivePharmacokineticBrixModelTest().

POSITION_PARAMETER_kel

const unsigned int mitk::DescriptivePharmacokineticBrixModel::POSITION_PARAMETER_kel

static

Definition at line 58 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by ComputeModelfunction(), mitk::DescriptivePharmacokineticBrixModelValueBasedParameterizer::GetDefaultInitialParameterization(), mitk::DescriptivePharmacokineticBrixModelParameterizer::GetDefaultInitialParameterization(), and mitkDescriptivePharmacokineticBrixModelTest().

POSITION_PARAMETER_kep

const unsigned int mitk::DescriptivePharmacokineticBrixModel::POSITION_PARAMETER_kep

static

Definition at line 57 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by ComputeModelfunction(), mitk::DescriptivePharmacokineticBrixModelValueBasedParameterizer::GetDefaultInitialParameterization(), mitk::DescriptivePharmacokineticBrixModelParameterizer::GetDefaultInitialParameterization(), and mitkDescriptivePharmacokineticBrixModelTest().

POSITION_PARAMETER_tlag

const unsigned int mitk::DescriptivePharmacokineticBrixModel::POSITION_PARAMETER_tlag

static

Definition at line 61 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by ComputeModelfunction(), mitk::DescriptivePharmacokineticBrixModelValueBasedParameterizer::GetDefaultInitialParameterization(), mitk::DescriptivePharmacokineticBrixModelParameterizer::GetDefaultInitialParameterization(), and mitkDescriptivePharmacokineticBrixModelTest().

UNIT_PARAMETER_A

const std::string mitk::DescriptivePharmacokineticBrixModel::UNIT_PARAMETER_A

static

Definition at line 49 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetParameterUnits().

UNIT_PARAMETER_kel

const std::string mitk::DescriptivePharmacokineticBrixModel::UNIT_PARAMETER_kel

static

Definition at line 51 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetParameterUnits().

UNIT_PARAMETER_kep

const std::string mitk::DescriptivePharmacokineticBrixModel::UNIT_PARAMETER_kep

static

Definition at line 50 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetParameterUnits().

UNIT_PARAMETER_tlag

const std::string mitk::DescriptivePharmacokineticBrixModel::UNIT_PARAMETER_tlag

static

Definition at line 52 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetParameterUnits().

UNIT_STATIC_PARAMETER_S0

const std::string mitk::DescriptivePharmacokineticBrixModel::UNIT_STATIC_PARAMETER_S0

static

Definition at line 54 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetStaticParameterUnits().

UNIT_STATIC_PARAMETER_Tau

const std::string mitk::DescriptivePharmacokineticBrixModel::UNIT_STATIC_PARAMETER_Tau

static

Definition at line 53 of file mitkDescriptivePharmacokineticBrixModel.h.

Referenced by GetStaticParameterUnits().

---

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

• mitkDescriptivePharmacokineticBrixModel.h
• mitkDescriptivePharmacokineticBrixModel.cpp