mitk::T2DecayModel Class Reference

Simple model of the MR T2 signal decay. This corresponds to an exponential decay in the form of: f(t) = M0 * exp(-t/T2) with T2 being the transverse / spin-spin relaxation time. The derived parameter R2 is calculated from T2 by inversion. More...

#include <mitkT2DecayModel.h>

Inheritance diagram for mitk::T2DecayModel:

Collaboration diagram for mitk::T2DecayModel:

Public Types
typedef T2DecayModel	Self
typedef mitk::ModelBase	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Superclass::ParameterNameType	ParameterNameType
typedef Superclass::ParametersSizeType	ParametersSizeType
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
FunctionStringType	GetFunctionString () const override
std::string	GetXName () const override
ParameterNamesType	GetParameterNames () const override
ParametersSizeType	GetNumberOfParameters () const override
ParameterNamesType	GetStaticParameterNames () const override
ParametersSizeType	GetNumberOfStaticParameters () const override
DerivedParametersSizeType	GetNumberOfDerivedParameters () const override
DerivedParameterNamesType	GetDerivedParameterNames () const override
mitk::ModelBase::DerivedParameterMapType	ComputeDerivedParameters (const mitk::ModelBase::ParametersType &parameters) const
Public Member Functions inherited from mitk::ModelBase
ParamterScaleMapType	GetParameterScales () const override
ParamterUnitMapType	GetParameterUnits () const override
DerivedParamterScaleMapType	GetDerivedParameterScales () const override
DerivedParamterUnitMapType	GetDerivedParameterUnits () const override
ModellClassIDType	GetClassID () const override
std::string	GetXAxisName () const override
std::string	GetXAxisUnit () const override
std::string	GetYAxisName () const override
std::string	GetYAxisUnit () const override
virtual ParamterUnitMapType	GetStaticParameterUnits () const
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 ()

Protected Member Functions
	T2DecayModel ()
	~T2DecayModel () 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
Protected Member Functions inherited from mitk::ModelBase
virtual bool	ValidateModel (std::string &error) 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

Simple model of the MR T2 signal decay. This corresponds to an exponential decay in the form of: f(t) = M0 * exp(-t/T2) with T2 being the transverse / spin-spin relaxation time. The derived parameter R2 is calculated from T2 by inversion.

Definition at line 28 of file mitkT2DecayModel.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 35 of file mitkT2DecayModel.h.

ParameterNameType

typedef Superclass::ParameterNameType mitk::T2DecayModel::ParameterNameType

Definition at line 37 of file mitkT2DecayModel.h.

ParametersSizeType

typedef Superclass::ParametersSizeType mitk::T2DecayModel::ParametersSizeType

Definition at line 38 of file mitkT2DecayModel.h.

Pointer

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

Definition at line 34 of file mitkT2DecayModel.h.

Self

typedef T2DecayModel mitk::T2DecayModel::Self

Definition at line 32 of file mitkT2DecayModel.h.

Superclass

typedef mitk::ModelBase mitk::T2DecayModel::Superclass

Definition at line 33 of file mitkT2DecayModel.h.

Constructor & Destructor Documentation

T2DecayModel()

mitk::T2DecayModel::T2DecayModel ( )

inlineprotected

Definition at line 71 of file mitkT2DecayModel.h.

~T2DecayModel()

mitk::T2DecayModel::~T2DecayModel ( )

inlineoverrideprotected

Definition at line 72 of file mitkT2DecayModel.h.

Member Function Documentation

Clone()

Pointer mitk::T2DecayModel::Clone

(

)

const

ComputeDerivedParameters()

mitk::ModelBase::DerivedParameterMapType mitk::T2DecayModel::ComputeDerivedParameters ( const mitk::ModelBase::ParametersType &  parameters ) const

virtual

Helper function called by GetDerivedParameters(). Implement in derived classes to realize the concrete computation of derived parameters.

Remarks

Default implementation has no derived parameters

Reimplemented from mitk::ModelBase.

ComputeModelfunction()

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

overrideprotectedvirtual

Implements mitk::ModelBase.

GetClassName()

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

virtual

Run-time type information (and related methods).

Reimplemented from mitk::ModelBase.

GetDerivedParameterNames()

DerivedParameterNamesType mitk::T2DecayModel::GetDerivedParameterNames ( ) const

overridevirtual

Returns the names of derived parameters that can/will be computed by the model given specific model parameters.

Remarks

Default implementation has no derived parameters

Reimplemented from mitk::ModelBase.

GetFunctionString()

FunctionStringType mitk::T2DecayModel::GetFunctionString ( ) const

overridevirtual

Default implementation returns an empty functions string.

Reimplemented from mitk::ModelBase.

GetModelDisplayName()

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

overridevirtual

Default implementation returns GetClassID as display name.

Reimplemented from mitk::ModelBase.

GetModelType()

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

overridevirtual

Default implementation returns "Unkown" as model type.

Reimplemented from mitk::ModelBase.

GetNumberOfDerivedParameters()

DerivedParametersSizeType mitk::T2DecayModel::GetNumberOfDerivedParameters ( ) const

overridevirtual

Returns the number of derived parameters that can/will be computed by the model given specific model parameters.

Remarks

Default implementation has no derived parameters

Reimplemented from mitk::ModelBase.

GetNumberOfParameters()

ParametersSizeType mitk::T2DecayModel::GetNumberOfParameters ( ) const

overridevirtual

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

Implements mitk::ModelTraitsInterface.

GetNumberOfStaticParameters()

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

GetParameterNames()

ParameterNamesType mitk::T2DecayModel::GetParameterNames ( ) const

overridevirtual

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

Implements mitk::ModelTraitsInterface.

GetStaticParameterNames()

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

GetStaticParameterValue()

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

GetXName()

std::string mitk::T2DecayModel::GetXName ( ) const

overridevirtual

Default implementation returns an empty string.

Reimplemented from mitk::ModelBase.

InternalClone()

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

static

Method for creation through the object factory.

SetStaticParameter()

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

---

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

• mitkT2DecayModel.h