mitk::AIFBasedModelBase Class Reference

Base Class for all physiological perfusion models using an Aterial Input Function All AIF based models come with an array of AIF values and the corresponding TimeGrid ( AIF(t)) This class provides functions for setting the AIF Values and optionally a specific AIF TimeGrid. It also provides a method for interpolation of the AIF source array to a specified Timegrid that differs from AIFTimeGrid. The AIF must be set with an itk::Array. If no AIFTimeGrid is specified with the Setter, it is assumed that the AIFTimeGrid is the same as the ModelTimegrid (e.g. AIF is derived from data set to be fitted). In this case, AIFvalues must have the same length as ModelTimeGrid, otherwise an exception is generated. More...

#include <mitkAIFBasedModelBase.h>

Inheritance diagram for mitk::AIFBasedModelBase:

Collaboration diagram for mitk::AIFBasedModelBase:

Public Types
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
virtual const char *	GetClassName () const
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
ParamterUnitMapType	GetParameterUnits () const override
DerivedParamterScaleMapType	GetDerivedParameterScales () const override
DerivedParamterUnitMapType	GetDerivedParameterUnits () const override
std::string	GetModelDisplayName () const override
std::string	GetModelType () 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
Public Member Functions inherited from mitk::ModelTraitsInterface
virtual ParameterNamesType	GetParameterNames () const =0
virtual ParametersSizeType	GetNumberOfParameters () const =0

Static Public Attributes
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
static const unsigned int	NUMBER_OF_STATIC_PARAMETERS
static const std::string	X_AXIS_NAME
static const std::string	X_AXIS_UNIT
static const std::string	Y_AXIS_NAME
static const std::string	Y_AXIS_UNIT

Protected Member Functions
	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 ModelResultType	ComputeModelfunction (const ParametersType &parameters) const =0
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 ()

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

Detailed Description

Base Class for all physiological perfusion models using an Aterial Input Function All AIF based models come with an array of AIF values and the corresponding TimeGrid ( AIF(t)) This class provides functions for setting the AIF Values and optionally a specific AIF TimeGrid. It also provides a method for interpolation of the AIF source array to a specified Timegrid that differs from AIFTimeGrid. The AIF must be set with an itk::Array. If no AIFTimeGrid is specified with the Setter, it is assumed that the AIFTimeGrid is the same as the ModelTimegrid (e.g. AIF is derived from data set to be fitted). In this case, AIFvalues must have the same length as ModelTimeGrid, otherwise an exception is generated.

Definition at line 31 of file mitkAIFBasedModelBase.h.

Member Typedef Documentation

AterialInputFunctionType

typedef itk::Array<double> mitk::AIFBasedModelBase::AterialInputFunctionType

Typedef for Aterial InputFunction AIF(t)

Definition at line 62 of file mitkAIFBasedModelBase.h.

ConstPointer

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

Definition at line 38 of file mitkAIFBasedModelBase.h.

Pointer

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

Definition at line 37 of file mitkAIFBasedModelBase.h.

Self

typedef AIFBasedModelBase mitk::AIFBasedModelBase::Self

Definition at line 35 of file mitkAIFBasedModelBase.h.

Superclass

typedef ModelBase mitk::AIFBasedModelBase::Superclass

Definition at line 36 of file mitkAIFBasedModelBase.h.

Constructor & Destructor Documentation

AIFBasedModelBase()

mitk::AIFBasedModelBase::AIFBasedModelBase ( )

protected

~AIFBasedModelBase()

mitk::AIFBasedModelBase::~AIFBasedModelBase ( )

overrideprotected

Member Function Documentation

GetAterialInputFunction()

const AterialInputFunctionType mitk::AIFBasedModelBase::GetAterialInputFunction

(

TimeGridType

currentTimeGrid

)

const

Returns the Aterial Input function matching currentTimeGrid The original values are interpolated to the passed TimeGrid if currentTimeGrid.Size() = 0 , the Original AIF will be returned

GetAterialInputFunctionTimeGrid()

virtual const TimeGridType& mitk::AIFBasedModelBase::GetAterialInputFunctionTimeGrid ( )

virtual

GetAterialInputFunctionValues()

virtual const AterialInputFunctionType& mitk::AIFBasedModelBase::GetAterialInputFunctionValues ( )

virtual

GetClassName()

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

virtual

Run-time type information (and related methods).

Reimplemented from mitk::ModelBase.

Reimplemented in mitk::TwoCompartmentExchangeModel, mitk::ExtendedToftsModel, mitk::StandardToftsModel, mitk::ExtendedOneTissueCompartmentModel, mitk::TwoTissueCompartmentFDGModel, mitk::TwoTissueCompartmentModel, and mitk::OneTissueCompartmentModel.

GetCurrentAterialInputFunctionTimeGrid()

const TimeGridType& mitk::AIFBasedModelBase::GetCurrentAterialInputFunctionTimeGrid

(

)

const

Returns the TimeGrid used for the AIF. Either the externally set AIF time grid or the time grid of the model if nothing is set.

GetNumberOfStaticParameters()

ParametersSizeType mitk::AIFBasedModelBase::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.

GetStaticParameterNames()

ParameterNamesType mitk::AIFBasedModelBase::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.

GetStaticParameterUnits()

ParamterUnitMapType mitk::AIFBasedModelBase::GetStaticParameterUnits ( ) const

overridevirtual

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

Reimplemented from mitk::ModelBase.

GetStaticParameterValue()

StaticParameterValuesType mitk::AIFBasedModelBase::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.

GetXAxisName()

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

overridevirtual

Default implementation returns an empty string.

Reimplemented from mitk::ModelBase.

GetXAxisUnit()

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

overridevirtual

Default implementation returns an empty string.

Reimplemented from mitk::ModelBase.

GetYAxisName()

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

overridevirtual

Default implementation returns an empty string.

Reimplemented from mitk::ModelBase.

GetYAxisUnit()

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

overridevirtual

Default implementation returns an empty string.

Reimplemented from mitk::ModelBase.

PrintSelf()

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

overrideprotected

SetAterialInputFunctionTimeGrid()

virtual void mitk::AIFBasedModelBase::SetAterialInputFunctionTimeGrid ( TimeGridType  _arg )

virtual

SetAterialInputFunctionValues()

virtual void mitk::AIFBasedModelBase::SetAterialInputFunctionValues ( AterialInputFunctionType  _arg )

virtual

SetStaticParameter()

void mitk::AIFBasedModelBase::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.

ValidateModel()

bool mitk::AIFBasedModelBase::ValidateModel ( std::string &  error ) const

overrideprotectedvirtual

Reimplementation that checks if AIF and timegrid settings are valid.

Parameters

[out]

error

Set internally to indicate the error reason if method returns false. Is used by GetSignal() for the exception comment.

Returns

Returns true if the model is valid and can compute a signal. Otherwise it returns false.

Reimplemented from mitk::ModelBase.

Member Data Documentation

m_AterialInputFunctionTimeGrid

TimeGridType mitk::AIFBasedModelBase::m_AterialInputFunctionTimeGrid

protected

Definition at line 110 of file mitkAIFBasedModelBase.h.

m_AterialInputFunctionValues

AterialInputFunctionType mitk::AIFBasedModelBase::m_AterialInputFunctionValues

protected

Definition at line 111 of file mitkAIFBasedModelBase.h.

NAME_STATIC_PARAMETER_AIF

const std::string mitk::AIFBasedModelBase::NAME_STATIC_PARAMETER_AIF

static

Definition at line 42 of file mitkAIFBasedModelBase.h.

NAME_STATIC_PARAMETER_AIFTimeGrid

const std::string mitk::AIFBasedModelBase::NAME_STATIC_PARAMETER_AIFTimeGrid

static

Definition at line 46 of file mitkAIFBasedModelBase.h.

NUMBER_OF_STATIC_PARAMETERS

const unsigned int mitk::AIFBasedModelBase::NUMBER_OF_STATIC_PARAMETERS

static

Definition at line 51 of file mitkAIFBasedModelBase.h.

UNIT_STATIC_PARAMETER_AIF

const std::string mitk::AIFBasedModelBase::UNIT_STATIC_PARAMETER_AIF

static

Definition at line 48 of file mitkAIFBasedModelBase.h.

UNIT_STATIC_PARAMETER_AIFTimeGrid

const std::string mitk::AIFBasedModelBase::UNIT_STATIC_PARAMETER_AIFTimeGrid

static

Definition at line 49 of file mitkAIFBasedModelBase.h.

X_AXIS_NAME

const std::string mitk::AIFBasedModelBase::X_AXIS_NAME

static

Definition at line 53 of file mitkAIFBasedModelBase.h.

X_AXIS_UNIT

const std::string mitk::AIFBasedModelBase::X_AXIS_UNIT

static

Definition at line 55 of file mitkAIFBasedModelBase.h.

Y_AXIS_NAME

const std::string mitk::AIFBasedModelBase::Y_AXIS_NAME

static

Definition at line 57 of file mitkAIFBasedModelBase.h.

Y_AXIS_UNIT

const std::string mitk::AIFBasedModelBase::Y_AXIS_UNIT

static

Definition at line 59 of file mitkAIFBasedModelBase.h.

---

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

• mitkAIFBasedModelBase.h