Base class for parameterizers of pharmacokinetic models that use an Arterial Input Function (AIF). More...

#include <mitkAIFBasedModelParameterizerBase.h>

Inheritance diagram for mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >:

[legend]

Collaboration diagram for mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >:

[legend]

Public Types
typedef AIFBasedModelParameterizerBase< TAIFBasedModel >	Self

typedef ConcreteModelParameterizerBase< TAIFBasedModel >	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef Superclass::ModelBaseType	ModelBaseType

typedef Superclass::ModelBasePointer	ModelBasePointer

typedef Superclass::ModelType	ModelType

typedef Superclass::ModelPointer	ModelPointer

typedef Superclass::StaticParameterValueType	StaticParameterValueType

typedef Superclass::StaticParameterValuesType	StaticParameterValuesType

typedef Superclass::StaticParameterMapType	StaticParameterMapType

typedef Superclass::IndexType	IndexType

Public Types inherited from mitk::ConcreteModelParameterizerBase< TAIFBasedModel >
typedef ConcreteModelParameterizerBase< TAIFBasedModel >	Self

typedef ModelParameterizerBase	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef Superclass::ModelBaseType	ModelBaseType

typedef Superclass::ModelBasePointer	ModelBasePointer

typedef TAIFBasedModel	ModelType

typedef ModelType::Pointer	ModelPointer

typedef Superclass::StaticParameterValueType	StaticParameterValueType

typedef Superclass::StaticParameterValuesType	StaticParameterValuesType

typedef Superclass::StaticParameterMapType	StaticParameterMapType

typedef Superclass::IndexType	IndexType

Public Types inherited from mitk::ModelParameterizerBase
typedef ModelParameterizerBase	Self

typedef itk::Object	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef ModelBase	ModelBaseType

typedef ModelBaseType::Pointer	ModelBasePointer

typedef ModelBaseType::ParametersType	ParametersType

typedef ModelBaseType::StaticParameterValueType	StaticParameterValueType

typedef ModelBaseType::StaticParameterValuesType	StaticParameterValuesType

typedef ModelBaseType::StaticParameterMapType	StaticParameterMapType

typedef ModelBaseType::TimeGridType	TimeGridType

typedef ::itk::Index< 3 >	IndexType

Public Types inherited from mitk::ModelTraitsInterface
typedef itk::Array< double >	ModelResultType
	Type representing the model output signal as an array of doubles. More...

using	ParameterValueType = double
	Type of a single parameter value. More...

typedef itk::Array< ParameterValueType >	ParametersType
	Type representing a vector of parameter values. More...

typedef std::string	ParameterNameType
	Type used for parameter names. More...

typedef std::vector< ParameterNameType >	ParameterNamesType
	Type for a list of parameter names. More...

typedef ParametersType::SizeValueType	ParametersSizeType
	Type for the count of parameters. More...

typedef ParameterNamesType	DerivedParameterNamesType
	Type for a list of derived parameter names. More...

typedef ParametersSizeType	DerivedParametersSizeType
	Type for the count of derived parameters. More...

typedef std::map< ParameterNameType, double >	ParamterScaleMapType
	Map type associating parameter names to their scaling factors. More...

typedef std::map< ParameterNameType, std::string >	ParamterUnitMapType
	Map type associating parameter names to their unit strings. More...

typedef std::map< ParameterNameType, double >	DerivedParamterScaleMapType
	Map type associating derived parameter names to their scaling factors. More...

typedef std::map< ParameterNameType, std::string >	DerivedParamterUnitMapType
	Map type associating derived parameter names to their unit strings. More...

typedef std::string	FunctionStringType
	Type for the function string representation of the model. More...

typedef std::string	ModellClassIDType
	Type for the unique class identifier of the model. More...

Public Member Functions
virtual const char *	GetClassName () const

virtual void	SetAIF (mitk::AIFBasedModelBase::AterialInputFunctionType _arg)
	Sets the Arterial Input Function concentration values. More...

virtual const mitk::AIFBasedModelBase::AterialInputFunctionType &	GetAIF ()
	Returns the currently set AIF concentration values. More...

virtual void	SetAIFTimeGrid (mitk::ModelBase::TimeGridType _arg)
	Sets the time grid corresponding to the AIF values. More...

virtual const mitk::ModelBase::TimeGridType &	GetAIFTimeGrid ()
	Returns the currently set AIF time grid. More...

StaticParameterMapType	GetGlobalStaticParameters () const override
	Returns the global static parameters for the model. More...

Public Member Functions inherited from mitk::ConcreteModelParameterizerBase< TAIFBasedModel >
StaticParameterMapType	GetGlobalStaticParameters () const override
	Returns the global static parameters that are the same for all positions. More...

StaticParameterMapType	GetLocalStaticParameters (const IndexType &) const override
	Returns the local static parameters specific to the given image position. More...

ModelBasePointer	GenerateParameterizedModel (const IndexType &currentPosition) const override
	Generates a fully parameterized model instance for the given position. More...

ModelBasePointer	GenerateParameterizedModel () const override
	Generates a model instance with only global static parameterization. More...

ParametersType	GetDefaultInitialParameterization () const override
	Returns the default initial parameterization defined by the model developer. More...

ParameterNamesType	GetParameterNames () const override
	Returns the names of parameters that must be defined when using the model to compute the signal (GetSignal()). More...

ParametersSizeType	GetNumberOfParameters () const override
	Returns the number of parameters that must be defined when using the model to compute the signal (GetSignal()). More...

ParamterScaleMapType	GetParameterScales () const override
	Returns the scaling factors for all model parameters. More...

ParamterUnitMapType	GetParameterUnits () const override
	Returns the unit strings for all model parameters. More...

ParameterNamesType	GetDerivedParameterNames () const override
	Returns the names of derived parameters that can be computed by the model. More...

ParametersSizeType	GetNumberOfDerivedParameters () const override
	Returns the number of derived parameters that can be computed by the model. More...

DerivedParamterScaleMapType	GetDerivedParameterScales () const override
	Returns the scaling factors for all derived parameters. More...

DerivedParamterUnitMapType	GetDerivedParameterUnits () const override
	Returns the unit strings for all derived parameters. More...

std::string	GetModelDisplayName () const override
	Returns the human-readable display name of the model. More...

std::string	GetModelType () const override
	Returns the type/category string of the model (e.g. "Linear", "Pharmacokinetic"). More...

FunctionStringType	GetFunctionString () const override
	Returns a parsable function string representing the model equation. More...

ModellClassIDType	GetClassID () const override
	Returns the unique class identifier for this model type. More...

std::string	GetXName () const override
	Returns the name of the independent variable used by the model (e.g. "x"). More...

std::string	GetXAxisName () const override
	Returns the display name of the x-axis (e.g. "Time"). More...

std::string	GetXAxisUnit () const override
	Returns the unit of the x-axis (e.g. "s", "ms"). More...

std::string	GetYAxisName () const override
	Returns the display name of the y-axis (e.g. "Signal Intensity"). More...

std::string	GetYAxisUnit () const override
	Returns the unit of the y-axis. More...

Public Member Functions inherited from mitk::ModelParameterizerBase
ParametersType	GetInitialParameterization () const
	Returns the initial parameterization for fitting. More...

ParametersType	GetInitialParameterization (const IndexType &currentPosition) const
	Returns the initial parameterization for a specific image position. More...

void	SetInitialParameterizationDelegate (const InitialParameterizationDelegateBase *delegate)
	Sets a custom strategy for defining the initial parameterization. More...

virtual void	SetDefaultTimeGrid (TimeGridType _arg)

virtual const TimeGridType &	GetDefaultTimeGrid ()

Protected Member Functions
	AIFBasedModelParameterizerBase ()

	~AIFBasedModelParameterizerBase () override

Protected Member Functions inherited from mitk::ConcreteModelParameterizerBase< TAIFBasedModel >
	ConcreteModelParameterizerBase ()

	~ConcreteModelParameterizerBase () override

Protected Member Functions inherited from mitk::ModelParameterizerBase
	ModelParameterizerBase ()

	~ModelParameterizerBase () override

Protected Member Functions inherited from mitk::ModelTraitsInterface
	ModelTraitsInterface ()

virtual	~ModelTraitsInterface ()

Protected Attributes
mitk::AIFBasedModelBase::AterialInputFunctionType	m_AIF

mitk::ModelBase::TimeGridType	m_AIFTimeGrid

Protected Attributes inherited from mitk::ModelParameterizerBase
InitialParameterizationDelegateBase::ConstPointer	m_InitialDelegate

TimeGridType	m_DefaultTimeGrid

Additional Inherited Members
Static Public Member Functions inherited from mitk::ConcreteModelParameterizerBase< TAIFBasedModel >
static Pointer	New ()

Detailed Description

template<class TAIFBasedModel>
class mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >

Base class for parameterizers of pharmacokinetic models that use an Arterial Input Function (AIF).

This template class stores the AIF concentration values and corresponding time grid, and provides them as global static parameters when configuring model instances for fitting.

Template Parameters

TAIFBasedModel The concrete AIF-based model type (must derive from AIFBasedModelBase).

See also: AIFBasedModelBase, ConcreteModelParameterizerBase

Definition at line 31 of file mitkAIFBasedModelParameterizerBase.h.

Member Typedef Documentation

◆ ConstPointer

template<class TAIFBasedModel >

typedef itk::SmartPointer< const Self > mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::ConstPointer

Definition at line 38 of file mitkAIFBasedModelParameterizerBase.h.

◆ IndexType

template<class TAIFBasedModel >

typedef Superclass::IndexType mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::IndexType

Definition at line 53 of file mitkAIFBasedModelParameterizerBase.h.

◆ ModelBasePointer

template<class TAIFBasedModel >

typedef Superclass::ModelBasePointer mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::ModelBasePointer

Definition at line 43 of file mitkAIFBasedModelParameterizerBase.h.

◆ ModelBaseType

template<class TAIFBasedModel >

typedef Superclass::ModelBaseType mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::ModelBaseType

Definition at line 42 of file mitkAIFBasedModelParameterizerBase.h.

◆ ModelPointer

template<class TAIFBasedModel >

typedef Superclass::ModelPointer mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::ModelPointer

Definition at line 46 of file mitkAIFBasedModelParameterizerBase.h.

◆ ModelType

template<class TAIFBasedModel >

typedef Superclass::ModelType mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::ModelType

Definition at line 45 of file mitkAIFBasedModelParameterizerBase.h.

◆ Pointer

template<class TAIFBasedModel >

typedef itk::SmartPointer< Self > mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::Pointer

Definition at line 37 of file mitkAIFBasedModelParameterizerBase.h.

◆ Self

template<class TAIFBasedModel >

typedef AIFBasedModelParameterizerBase<TAIFBasedModel> mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::Self

Definition at line 35 of file mitkAIFBasedModelParameterizerBase.h.

◆ StaticParameterMapType

template<class TAIFBasedModel >

typedef Superclass::StaticParameterMapType mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::StaticParameterMapType

Definition at line 50 of file mitkAIFBasedModelParameterizerBase.h.

◆ StaticParameterValuesType

template<class TAIFBasedModel >

typedef Superclass::StaticParameterValuesType mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::StaticParameterValuesType

Definition at line 49 of file mitkAIFBasedModelParameterizerBase.h.

◆ StaticParameterValueType

template<class TAIFBasedModel >

typedef Superclass::StaticParameterValueType mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::StaticParameterValueType

Definition at line 48 of file mitkAIFBasedModelParameterizerBase.h.

◆ Superclass

template<class TAIFBasedModel >

typedef ConcreteModelParameterizerBase<TAIFBasedModel> mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::Superclass

Definition at line 36 of file mitkAIFBasedModelParameterizerBase.h.

Constructor & Destructor Documentation

◆ AIFBasedModelParameterizerBase()

template<class TAIFBasedModel >

mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::AIFBasedModelParameterizerBase ( )

inlineprotected

Definition at line 90 of file mitkAIFBasedModelParameterizerBase.h.

◆ ~AIFBasedModelParameterizerBase()

template<class TAIFBasedModel >

mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::~AIFBasedModelParameterizerBase ( )

inlineoverrideprotected

Definition at line 93 of file mitkAIFBasedModelParameterizerBase.h.

Member Function Documentation

◆ GetAIF()

template<class TAIFBasedModel >

virtual const mitk::AIFBasedModelBase::AterialInputFunctionType& mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::GetAIF ( )

virtual

Returns the currently set AIF concentration values.

Returns: Const reference to the AIF array.

◆ GetAIFTimeGrid()

template<class TAIFBasedModel >

virtual const mitk::ModelBase::TimeGridType& mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::GetAIFTimeGrid ( )

virtual

Returns the currently set AIF time grid.

Returns: Const reference to the AIF time grid array.

◆ GetClassName()

template<class TAIFBasedModel >

virtual const char* mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::GetClassName ( ) const

virtual

Reimplemented from mitk::ConcreteModelParameterizerBase< TAIFBasedModel >.

Reimplemented in mitk::TwoTissueCompartmentModelParameterizer, mitk::TwoTissueCompartmentFDGModelParameterizer, mitk::TwoCompartmentExchangeModelParameterizer, mitk::StandardToftsModelParameterizer, mitk::OneTissueCompartmentModelParameterizer, mitk::ExtendedToftsModelParameterizer, and mitk::ExtendedOneTissueCompartmentModelParameterizer.

◆ GetGlobalStaticParameters()

template<class TAIFBasedModel >

StaticParameterMapType mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::GetGlobalStaticParameters ( ) const

inlineoverridevirtual

Returns the global static parameters for the model.

This default implementation provides only the AIF and its time grid as static parameters. Reimplement in derived classes to add additional static parameters.

Returns: Map of static parameter names to their value vectors.

Implements mitk::ModelParameterizerBase.

Definition at line 75 of file mitkAIFBasedModelParameterizerBase.h.

References mitk::convertArrayToParameter().

◆ SetAIF()

template<class TAIFBasedModel >

virtual void mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::SetAIF ( mitk::AIFBasedModelBase::AterialInputFunctionType _arg )

virtual

Sets the Arterial Input Function concentration values.

Parameters

[in] _arg AIF values as an itk::Array of double.

◆ SetAIFTimeGrid()

template<class TAIFBasedModel >

virtual void mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::SetAIFTimeGrid ( mitk::ModelBase::TimeGridType _arg )

virtual

Sets the time grid corresponding to the AIF values.

Parameters

[in] _arg Time grid as an itk::Array of double (in seconds).

Member Data Documentation

◆ m_AIF

template<class TAIFBasedModel >

mitk::AIFBasedModelBase::AterialInputFunctionType mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::m_AIF

protected

Definition at line 97 of file mitkAIFBasedModelParameterizerBase.h.

◆ m_AIFTimeGrid

template<class TAIFBasedModel >

mitk::ModelBase::TimeGridType mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >::m_AIFTimeGrid

protected

Definition at line 98 of file mitkAIFBasedModelParameterizerBase.h.

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

mitkAIFBasedModelParameterizerBase.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class TAIFBasedModel> class mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ ModelBasePointer

◆ ModelBaseType

◆ ModelPointer

◆ ModelType

◆ Pointer

◆ Self

◆ StaticParameterMapType

◆ StaticParameterValuesType

◆ StaticParameterValueType

◆ Superclass

Constructor & Destructor Documentation

◆ AIFBasedModelParameterizerBase()

◆ ~AIFBasedModelParameterizerBase()

Member Function Documentation

◆ GetAIF()

◆ GetAIFTimeGrid()

◆ GetClassName()

◆ GetGlobalStaticParameters()

◆ SetAIF()

◆ SetAIFTimeGrid()

Member Data Documentation

◆ m_AIF

◆ m_AIFTimeGrid

template<class TAIFBasedModel>
class mitk::AIFBasedModelParameterizerBase< TAIFBasedModel >