mitk::ExpDecayOffsetModel Class Reference

Implementation of a general exponential decay model with offset, following the function: y(x) = y-intercept * exp(-rate*x) + baseline. More...

#include <mitkExpDecayOffsetModel.h>

Inheritance diagram for mitk::ExpDecayOffsetModel:

Collaboration diagram for mitk::ExpDecayOffsetModel:

Public Types
typedef ExpDecayOffsetModel	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
ParameterNamesType	GetParameterNames () const override
ParametersSizeType	GetNumberOfParameters () const override
ParamterUnitMapType	GetParameterUnits () 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
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 TimeGridType &	GetTimeGrid ()
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_k
static const std::string	NAME_PARAMETER_y_bl
static const unsigned int	NUMBER_OF_PARAMETERS
static const std::string	UNIT_PARAMETER_y0
static const std::string	UNIT_PARAMETER_k
static const std::string	UNIT_PARAMETER_y_bl
static const unsigned int	POSITION_PARAMETER_y0
static const unsigned int	POSITION_PARAMETER_k
static const unsigned int	POSITION_PARAMETER_y_bl
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
	ExpDecayOffsetModel ()
	~ExpDecayOffsetModel () 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
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::ModelBase
TimeGridType	m_TimeGrid

Detailed Description

Implementation of a general exponential decay model with offset, following the function: y(x) = y-intercept * exp(-rate*x) + baseline.

Definition at line 27 of file mitkExpDecayOffsetModel.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 34 of file mitkExpDecayOffsetModel.h.

ParameterNameType

typedef Superclass::ParameterNameType mitk::ExpDecayOffsetModel::ParameterNameType

Definition at line 36 of file mitkExpDecayOffsetModel.h.

ParametersSizeType

typedef Superclass::ParametersSizeType mitk::ExpDecayOffsetModel::ParametersSizeType

Definition at line 37 of file mitkExpDecayOffsetModel.h.

Pointer

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

Definition at line 33 of file mitkExpDecayOffsetModel.h.

Self

typedef ExpDecayOffsetModel mitk::ExpDecayOffsetModel::Self

Definition at line 31 of file mitkExpDecayOffsetModel.h.

Superclass

typedef mitk::ModelBase mitk::ExpDecayOffsetModel::Superclass

Definition at line 32 of file mitkExpDecayOffsetModel.h.

Constructor & Destructor Documentation

ExpDecayOffsetModel()

mitk::ExpDecayOffsetModel::ExpDecayOffsetModel ( )

inlineprotected

Definition at line 105 of file mitkExpDecayOffsetModel.h.

~ExpDecayOffsetModel()

mitk::ExpDecayOffsetModel::~ExpDecayOffsetModel ( )

inlineoverrideprotected

Definition at line 106 of file mitkExpDecayOffsetModel.h.

Member Function Documentation

Clone()

Pointer mitk::ExpDecayOffsetModel::Clone

(

)

const

ComputeModelfunction()

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

overrideprotectedvirtual

Implements mitk::ModelBase.

GetClassName()

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

virtual

Run-time type information (and related methods).

Reimplemented from mitk::ModelBase.

GetFunctionString()

FunctionStringType mitk::ExpDecayOffsetModel::GetFunctionString ( ) const

overridevirtual

Implements mitk::ModelTraitsInterface.

GetModelDisplayName()

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

overridevirtual

Implements mitk::ModelTraitsInterface.

GetModelType()

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

overridevirtual

Implements mitk::ModelTraitsInterface.

GetNumberOfParameters()

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

overridevirtual

Implements mitk::ModelTraitsInterface.

GetStaticParameterNames()

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

overridevirtual

Implements mitk::ModelTraitsInterface.

GetXAxisUnit()

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

overridevirtual

Implements mitk::ModelTraitsInterface.

GetXName()

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

overridevirtual

Implements mitk::ModelTraitsInterface.

GetYAxisName()

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

overridevirtual

Implements mitk::ModelTraitsInterface.

GetYAxisUnit()

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

overridevirtual

Implements mitk::ModelTraitsInterface.

InternalClone()

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

static

Method for creation through the object factory.

SetStaticParameter()

void mitk::ExpDecayOffsetModel::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::ExpDecayOffsetModel::FUNCTION_STRING

static

Definition at line 66 of file mitkExpDecayOffsetModel.h.

MODEL_DISPLAY_NAME

const std::string mitk::ExpDecayOffsetModel::MODEL_DISPLAY_NAME

static

Definition at line 62 of file mitkExpDecayOffsetModel.h.

MODEL_TYPE

const std::string mitk::ExpDecayOffsetModel::MODEL_TYPE

static

Definition at line 64 of file mitkExpDecayOffsetModel.h.

NAME_PARAMETER_k

const std::string mitk::ExpDecayOffsetModel::NAME_PARAMETER_k

static

Definition at line 47 of file mitkExpDecayOffsetModel.h.

NAME_PARAMETER_y0

const std::string mitk::ExpDecayOffsetModel::NAME_PARAMETER_y0

static

Definition at line 44 of file mitkExpDecayOffsetModel.h.

NAME_PARAMETER_y_bl

const std::string mitk::ExpDecayOffsetModel::NAME_PARAMETER_y_bl

static

Definition at line 48 of file mitkExpDecayOffsetModel.h.

NUMBER_OF_PARAMETERS

const unsigned int mitk::ExpDecayOffsetModel::NUMBER_OF_PARAMETERS

static

Definition at line 50 of file mitkExpDecayOffsetModel.h.

NUMBER_OF_STATIC_PARAMETERS

const unsigned int mitk::ExpDecayOffsetModel::NUMBER_OF_STATIC_PARAMETERS

static

Definition at line 60 of file mitkExpDecayOffsetModel.h.

POSITION_PARAMETER_k

const unsigned int mitk::ExpDecayOffsetModel::POSITION_PARAMETER_k

static

Definition at line 57 of file mitkExpDecayOffsetModel.h.

POSITION_PARAMETER_y0

const unsigned int mitk::ExpDecayOffsetModel::POSITION_PARAMETER_y0

static

Definition at line 56 of file mitkExpDecayOffsetModel.h.

POSITION_PARAMETER_y_bl

const unsigned int mitk::ExpDecayOffsetModel::POSITION_PARAMETER_y_bl

static

Definition at line 58 of file mitkExpDecayOffsetModel.h.

UNIT_PARAMETER_k

const std::string mitk::ExpDecayOffsetModel::UNIT_PARAMETER_k

static

Definition at line 53 of file mitkExpDecayOffsetModel.h.

UNIT_PARAMETER_y0

const std::string mitk::ExpDecayOffsetModel::UNIT_PARAMETER_y0

static

Definition at line 52 of file mitkExpDecayOffsetModel.h.

UNIT_PARAMETER_y_bl

const std::string mitk::ExpDecayOffsetModel::UNIT_PARAMETER_y_bl

static

Definition at line 54 of file mitkExpDecayOffsetModel.h.

X_AXIS_NAME

const std::string mitk::ExpDecayOffsetModel::X_AXIS_NAME

static

Definition at line 70 of file mitkExpDecayOffsetModel.h.

X_AXIS_UNIT

const std::string mitk::ExpDecayOffsetModel::X_AXIS_UNIT

static

Definition at line 72 of file mitkExpDecayOffsetModel.h.

X_NAME

const std::string mitk::ExpDecayOffsetModel::X_NAME

static

Definition at line 68 of file mitkExpDecayOffsetModel.h.

Y_AXIS_NAME

const std::string mitk::ExpDecayOffsetModel::Y_AXIS_NAME

static

Definition at line 74 of file mitkExpDecayOffsetModel.h.

Y_AXIS_UNIT

const std::string mitk::ExpDecayOffsetModel::Y_AXIS_UNIT

static

Definition at line 76 of file mitkExpDecayOffsetModel.h.

---

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

• mitkExpDecayOffsetModel.h