mitk::TwoTissueCompartmentModel Class Reference

#include <mitkTwoTissueCompartmentModel.h>

Inheritance diagram for mitk::TwoTissueCompartmentModel:

Collaboration diagram for mitk::TwoTissueCompartmentModel:

Public Types
typedef TwoTissueCompartmentModel	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	NAME_PARAMETER_K1
static const std::string	NAME_PARAMETER_k2
static const std::string	NAME_PARAMETER_k3
static const std::string	NAME_PARAMETER_k4
static const std::string	NAME_PARAMETER_vb
static const std::string	UNIT_PARAMETER_K1
static const std::string	UNIT_PARAMETER_k2
static const std::string	UNIT_PARAMETER_k3
static const std::string	UNIT_PARAMETER_k4
static const std::string	UNIT_PARAMETER_vb
static const unsigned int	POSITION_PARAMETER_K1
static const unsigned int	POSITION_PARAMETER_k2
static const unsigned int	POSITION_PARAMETER_k3
static const unsigned int	POSITION_PARAMETER_k4
static const unsigned int	POSITION_PARAMETER_vb
static const unsigned int	NUMBER_OF_PARAMETERS
static const std::string	MODEL_DISPLAY_NAME
static const std::string	MODEL_TYPE
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
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
	TwoTissueCompartmentModel ()
	~TwoTissueCompartmentModel () 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

Definition at line 22 of file mitkTwoTissueCompartmentModel.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 29 of file mitkTwoTissueCompartmentModel.h.

Pointer

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

Definition at line 28 of file mitkTwoTissueCompartmentModel.h.

Self

typedef TwoTissueCompartmentModel mitk::TwoTissueCompartmentModel::Self

Definition at line 26 of file mitkTwoTissueCompartmentModel.h.

Superclass

typedef AIFBasedModelBase mitk::TwoTissueCompartmentModel::Superclass

Definition at line 27 of file mitkTwoTissueCompartmentModel.h.

Constructor & Destructor Documentation

TwoTissueCompartmentModel()

mitk::TwoTissueCompartmentModel::TwoTissueCompartmentModel ( )

protected

~TwoTissueCompartmentModel()

mitk::TwoTissueCompartmentModel::~TwoTissueCompartmentModel ( )

overrideprotected

Member Function Documentation

Clone()

Pointer mitk::TwoTissueCompartmentModel::Clone

(

)

const

ComputeModelfunction()

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

overrideprotectedvirtual

Implements mitk::ModelBase.

GetClassName()

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

virtual

Run-time type information (and related methods).

Reimplemented from mitk::AIFBasedModelBase.

GetModelDisplayName()

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

overridevirtual

Default implementation returns GetClassID as display name.

Reimplemented from mitk::ModelBase.

GetModelType()

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

overridevirtual

Default implementation returns "Unkown" as model type.

Reimplemented from mitk::ModelBase.

GetNumberOfParameters()

ParametersSizeType mitk::TwoTissueCompartmentModel::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::TwoTissueCompartmentModel::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::TwoTissueCompartmentModel::GetParameterUnits ( ) const

overridevirtual

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

Reimplemented from mitk::ModelBase.

InternalClone()

itk::LightObject::Pointer mitk::TwoTissueCompartmentModel::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::TwoTissueCompartmentModel::New ( )

static

Method for creation through the object factory.

PrintSelf()

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

overrideprotected

Member Data Documentation

MODEL_DISPLAY_NAME

const std::string mitk::TwoTissueCompartmentModel::MODEL_DISPLAY_NAME

static

Definition at line 60 of file mitkTwoTissueCompartmentModel.h.

MODEL_TYPE

const std::string mitk::TwoTissueCompartmentModel::MODEL_TYPE

static

Definition at line 62 of file mitkTwoTissueCompartmentModel.h.

NAME_PARAMETER_K1

const std::string mitk::TwoTissueCompartmentModel::NAME_PARAMETER_K1

static

Model Specifications

Definition at line 36 of file mitkTwoTissueCompartmentModel.h.

NAME_PARAMETER_k2

const std::string mitk::TwoTissueCompartmentModel::NAME_PARAMETER_k2

static

Definition at line 41 of file mitkTwoTissueCompartmentModel.h.

NAME_PARAMETER_k3

const std::string mitk::TwoTissueCompartmentModel::NAME_PARAMETER_k3

static

Definition at line 42 of file mitkTwoTissueCompartmentModel.h.

NAME_PARAMETER_k4

const std::string mitk::TwoTissueCompartmentModel::NAME_PARAMETER_k4

static

Definition at line 43 of file mitkTwoTissueCompartmentModel.h.

NAME_PARAMETER_vb

const std::string mitk::TwoTissueCompartmentModel::NAME_PARAMETER_vb

static

Definition at line 44 of file mitkTwoTissueCompartmentModel.h.

NUMBER_OF_PARAMETERS

const unsigned int mitk::TwoTissueCompartmentModel::NUMBER_OF_PARAMETERS

static

Definition at line 58 of file mitkTwoTissueCompartmentModel.h.

POSITION_PARAMETER_K1

const unsigned int mitk::TwoTissueCompartmentModel::POSITION_PARAMETER_K1

static

Definition at line 52 of file mitkTwoTissueCompartmentModel.h.

POSITION_PARAMETER_k2

const unsigned int mitk::TwoTissueCompartmentModel::POSITION_PARAMETER_k2

static

Definition at line 53 of file mitkTwoTissueCompartmentModel.h.

POSITION_PARAMETER_k3

const unsigned int mitk::TwoTissueCompartmentModel::POSITION_PARAMETER_k3

static

Definition at line 54 of file mitkTwoTissueCompartmentModel.h.

POSITION_PARAMETER_k4

const unsigned int mitk::TwoTissueCompartmentModel::POSITION_PARAMETER_k4

static

Definition at line 55 of file mitkTwoTissueCompartmentModel.h.

POSITION_PARAMETER_vb

const unsigned int mitk::TwoTissueCompartmentModel::POSITION_PARAMETER_vb

static

Definition at line 56 of file mitkTwoTissueCompartmentModel.h.

UNIT_PARAMETER_K1

const std::string mitk::TwoTissueCompartmentModel::UNIT_PARAMETER_K1

static

Definition at line 46 of file mitkTwoTissueCompartmentModel.h.

UNIT_PARAMETER_k2

const std::string mitk::TwoTissueCompartmentModel::UNIT_PARAMETER_k2

static

Definition at line 47 of file mitkTwoTissueCompartmentModel.h.

UNIT_PARAMETER_k3

const std::string mitk::TwoTissueCompartmentModel::UNIT_PARAMETER_k3

static

Definition at line 48 of file mitkTwoTissueCompartmentModel.h.

UNIT_PARAMETER_k4

const std::string mitk::TwoTissueCompartmentModel::UNIT_PARAMETER_k4

static

Definition at line 49 of file mitkTwoTissueCompartmentModel.h.

UNIT_PARAMETER_vb

const std::string mitk::TwoTissueCompartmentModel::UNIT_PARAMETER_vb

static

Definition at line 50 of file mitkTwoTissueCompartmentModel.h.

---

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

• mitkTwoTissueCompartmentModel.h