Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitk::ExponentialDecayModel Class Reference

Simple model of exponential decay in the form of: y(x) = y-intercept * exp(-x/lambda) with lambda being the decay constant. More...

#include <mitkExponentialDecayModel.h>

Inheritance diagram for mitk::ExponentialDecayModel:
Collaboration diagram for mitk::ExponentialDecayModel:

Public Types

typedef ExponentialDecayModel Self
 
typedef mitk::ModelBase Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::ParameterNameType ParameterNameType
 
typedef Superclass::ParametersSizeType ParametersSizeType
 
- Public Types inherited from mitk::ModelBase
typedef ModelBase Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
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< StaticParameterValueTypeStaticParameterValuesType
 
typedef std::map< ParameterNameType, StaticParameterValuesTypeStaticParameterMapType
 
typedef double DerivedParameterValueType
 
typedef std::map< ParameterNameType, DerivedParameterValueTypeDerivedParameterMapType
 
- Public Types inherited from mitk::ModelTraitsInterface
typedef itk::Array< double > ModelResultType
 
using ParameterValueType = double
 
typedef itk::Array< ParameterValueTypeParametersType
 
typedef std::string ParameterNameType
 
typedef std::vector< ParameterNameTypeParameterNamesType
 
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
 
ParameterNamesType GetParameterNames () const override
 
ParametersSizeType GetNumberOfParameters () const override
 
ParamterUnitMapType GetParameterUnits () const override
 
ParameterNamesType GetDerivedParameterNames () const override
 
ParametersSizeType GetNumberOfDerivedParameters () const override
 
ParamterUnitMapType GetDerivedParameterUnits () const override
 
ParameterNamesType GetStaticParameterNames () const override
 
ParametersSizeType GetNumberOfStaticParameters () const override
 
std::string GetModelDisplayName () const override
 
std::string GetModelType () const override
 
FunctionStringType GetFunctionString () const override
 
std::string GetXName () const override
 
std::string GetXAxisName () const override
 
std::string GetXAxisUnit () const override
 
std::string GetYAxisName () const override
 
std::string GetYAxisUnit () 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
 
std::string GetModelDisplayName () const override
 
std::string GetModelType () const override
 
FunctionStringType GetFunctionString () const override
 
ModellClassIDType GetClassID () const override
 
std::string GetXName () 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
 
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 TimeGridTypeGetTimeGrid ()
 
ModelResultType GetSignal (const ParametersType &parameters) const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const std::string NAME_PARAMETER_y0
 
static const std::string NAME_PARAMETER_lambda
 
static const unsigned int NUMBER_OF_PARAMETERS
 
static const std::string UNIT_PARAMETER_y0
 
static const std::string UNIT_PARAMETER_lambda
 
static const unsigned int POSITION_PARAMETER_y0
 
static const unsigned int POSITION_PARAMETER_lambda
 
static const std::string NAME_DERIVED_PARAMETER_k
 
static const unsigned int NUMBER_OF_DERIVED_PARAMETERS
 
static const std::string UNIT_DERIVED_PARAMETER_k
 
static const unsigned int NUMBER_OF_STATIC_PARAMETERS
 
static const std::string MODEL_DISPLAY_NAME
 
static const std::string MODEL_TYPE
 
static const std::string FUNCTION_STRING
 
static const std::string X_NAME
 
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

 ExponentialDecayModel ()
 
 ~ExponentialDecayModel () 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 exponential decay in the form of: y(x) = y-intercept * exp(-x/lambda) with lambda being the decay constant.

Definition at line 27 of file mitkExponentialDecayModel.h.

Member Typedef Documentation

◆ ConstPointer

◆ ParameterNameType

◆ ParametersSizeType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ExponentialDecayModel()

mitk::ExponentialDecayModel::ExponentialDecayModel ( )
inlineprotected

Definition at line 118 of file mitkExponentialDecayModel.h.

◆ ~ExponentialDecayModel()

mitk::ExponentialDecayModel::~ExponentialDecayModel ( )
inlineoverrideprotected

Definition at line 119 of file mitkExponentialDecayModel.h.

Member Function Documentation

◆ Clone()

Pointer mitk::ExponentialDecayModel::Clone ( ) const

◆ ComputeDerivedParameters()

mitk::ModelBase::DerivedParameterMapType mitk::ExponentialDecayModel::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::ExponentialDecayModel::ComputeModelfunction ( const ParametersType parameters) const
overrideprotectedvirtual

Implements mitk::ModelBase.

◆ GetClassName()

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

Run-time type information (and related methods).

Reimplemented from mitk::ModelBase.

◆ GetDerivedParameterNames()

ParameterNamesType mitk::ExponentialDecayModel::GetDerivedParameterNames ( ) const
overridevirtual

Returns the names of derived parameters that must be defined when using the model to compute them (GetDerivedParameters()).

Implements mitk::ModelTraitsInterface.

◆ GetDerivedParameterUnits()

ParamterUnitMapType mitk::ExponentialDecayModel::GetDerivedParameterUnits ( ) const
overridevirtual

◆ GetFunctionString()

FunctionStringType mitk::ExponentialDecayModel::GetFunctionString ( ) const
overridevirtual

◆ GetModelDisplayName()

std::string mitk::ExponentialDecayModel::GetModelDisplayName ( ) const
overridevirtual

◆ GetModelType()

std::string mitk::ExponentialDecayModel::GetModelType ( ) const
overridevirtual

◆ GetNumberOfDerivedParameters()

ParametersSizeType mitk::ExponentialDecayModel::GetNumberOfDerivedParameters ( ) const
overridevirtual

Returns the number of derived parameters that must be defined when using the model to compute them (GetDerivedParameters()).

Implements mitk::ModelTraitsInterface.

◆ GetNumberOfParameters()

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

◆ GetStaticParameterNames()

ParameterNamesType mitk::ExponentialDecayModel::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::ExponentialDecayModel::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::ExponentialDecayModel::GetXAxisName ( ) const
overridevirtual

◆ GetXAxisUnit()

std::string mitk::ExponentialDecayModel::GetXAxisUnit ( ) const
overridevirtual

◆ GetXName()

std::string mitk::ExponentialDecayModel::GetXName ( ) const
overridevirtual

◆ GetYAxisName()

std::string mitk::ExponentialDecayModel::GetYAxisName ( ) const
overridevirtual

◆ GetYAxisUnit()

std::string mitk::ExponentialDecayModel::GetYAxisUnit ( ) const
overridevirtual

◆ InternalClone()

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

Method for creation through the object factory.

◆ SetStaticParameter()

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

Member Data Documentation

◆ FUNCTION_STRING

const std::string mitk::ExponentialDecayModel::FUNCTION_STRING
static

Definition at line 70 of file mitkExponentialDecayModel.h.

◆ MODEL_DISPLAY_NAME

const std::string mitk::ExponentialDecayModel::MODEL_DISPLAY_NAME
static

Definition at line 66 of file mitkExponentialDecayModel.h.

◆ MODEL_TYPE

const std::string mitk::ExponentialDecayModel::MODEL_TYPE
static

Definition at line 68 of file mitkExponentialDecayModel.h.

◆ NAME_DERIVED_PARAMETER_k

const std::string mitk::ExponentialDecayModel::NAME_DERIVED_PARAMETER_k
static

Definition at line 58 of file mitkExponentialDecayModel.h.

◆ NAME_PARAMETER_lambda

const std::string mitk::ExponentialDecayModel::NAME_PARAMETER_lambda
static

Definition at line 48 of file mitkExponentialDecayModel.h.

◆ NAME_PARAMETER_y0

const std::string mitk::ExponentialDecayModel::NAME_PARAMETER_y0
static

Definition at line 44 of file mitkExponentialDecayModel.h.

◆ NUMBER_OF_DERIVED_PARAMETERS

const unsigned int mitk::ExponentialDecayModel::NUMBER_OF_DERIVED_PARAMETERS
static

Definition at line 60 of file mitkExponentialDecayModel.h.

◆ NUMBER_OF_PARAMETERS

const unsigned int mitk::ExponentialDecayModel::NUMBER_OF_PARAMETERS
static

Definition at line 50 of file mitkExponentialDecayModel.h.

◆ NUMBER_OF_STATIC_PARAMETERS

const unsigned int mitk::ExponentialDecayModel::NUMBER_OF_STATIC_PARAMETERS
static

Definition at line 64 of file mitkExponentialDecayModel.h.

◆ POSITION_PARAMETER_lambda

const unsigned int mitk::ExponentialDecayModel::POSITION_PARAMETER_lambda
static

Definition at line 56 of file mitkExponentialDecayModel.h.

◆ POSITION_PARAMETER_y0

const unsigned int mitk::ExponentialDecayModel::POSITION_PARAMETER_y0
static

Definition at line 55 of file mitkExponentialDecayModel.h.

◆ UNIT_DERIVED_PARAMETER_k

const std::string mitk::ExponentialDecayModel::UNIT_DERIVED_PARAMETER_k
static

Definition at line 62 of file mitkExponentialDecayModel.h.

◆ UNIT_PARAMETER_lambda

const std::string mitk::ExponentialDecayModel::UNIT_PARAMETER_lambda
static

Definition at line 53 of file mitkExponentialDecayModel.h.

◆ UNIT_PARAMETER_y0

const std::string mitk::ExponentialDecayModel::UNIT_PARAMETER_y0
static

Definition at line 52 of file mitkExponentialDecayModel.h.

◆ X_AXIS_NAME

const std::string mitk::ExponentialDecayModel::X_AXIS_NAME
static

Definition at line 74 of file mitkExponentialDecayModel.h.

◆ X_AXIS_UNIT

const std::string mitk::ExponentialDecayModel::X_AXIS_UNIT
static

Definition at line 76 of file mitkExponentialDecayModel.h.

◆ X_NAME

const std::string mitk::ExponentialDecayModel::X_NAME
static

Definition at line 72 of file mitkExponentialDecayModel.h.

◆ Y_AXIS_NAME

const std::string mitk::ExponentialDecayModel::Y_AXIS_NAME
static

Definition at line 78 of file mitkExponentialDecayModel.h.

◆ Y_AXIS_UNIT

const std::string mitk::ExponentialDecayModel::Y_AXIS_UNIT
static

Definition at line 80 of file mitkExponentialDecayModel.h.


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