Piecewise linear model with three segments and two transition points. More...

#include <mitkThreeStepLinearModel.h>

Inheritance diagram for mitk::ThreeStepLinearModel:

[legend]

Collaboration diagram for mitk::ThreeStepLinearModel:

[legend]

Public Types
typedef ThreeStepLinearModel	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
	Type defining the time grid used by models. More...

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
	Type representing the model output signal as an array of doubles. More...

using	ParameterValueType = double
	Type of a single parameter value. More...

typedef itk::Array< ParameterValueType >	ParametersType
	Type representing a vector of parameter values. More...

typedef std::string	ParameterNameType
	Type used for parameter names. More...

typedef std::vector< ParameterNameType >	ParameterNamesType
	Type for a list of parameter names. More...

typedef ParametersType::SizeValueType	ParametersSizeType
	Type for the count of parameters. More...

typedef ParameterNamesType	DerivedParameterNamesType
	Type for a list of derived parameter names. More...

typedef ParametersSizeType	DerivedParametersSizeType
	Type for the count of derived parameters. More...

typedef std::map< ParameterNameType, double >	ParamterScaleMapType
	Map type associating parameter names to their scaling factors. More...

typedef std::map< ParameterNameType, std::string >	ParamterUnitMapType
	Map type associating parameter names to their unit strings. More...

typedef std::map< ParameterNameType, double >	DerivedParamterScaleMapType
	Map type associating derived parameter names to their scaling factors. More...

typedef std::map< ParameterNameType, std::string >	DerivedParamterUnitMapType
	Map type associating derived parameter names to their unit strings. More...

typedef std::string	FunctionStringType
	Type for the function string representation of the model. More...

typedef std::string	ModellClassIDType
	Type for the unique class identifier of the model. More...

Public Member Functions
Pointer	Clone () const

virtual const char *	GetClassName () const

ParameterNamesType	GetParameterNames () const override
	Returns the names of parameters that must be defined when using the model to compute the signal (GetSignal()). More...

ParametersSizeType	GetNumberOfParameters () const override
	Returns the number of parameters that must be defined when using the model to compute the signal (GetSignal()). More...

ParamterUnitMapType	GetParameterUnits () const override
	Default implementation returns no unit string ("") for every defined parameter. More...

ParameterNamesType	GetDerivedParameterNames () const override
	Returns the names of derived parameters that can be computed by the model. More...

ParametersSizeType	GetNumberOfDerivedParameters () const override
	Returns the number of derived parameters that can be computed by the model. More...

ParamterUnitMapType	GetDerivedParameterUnits () const override
	Default implementation returns no unit string ("") for every defined derived parameter. More...

ParameterNamesType	GetStaticParameterNames () const override
	Returns the names of static parameters used when computing the signal. More...

ParametersSizeType	GetNumberOfStaticParameters () const override
	Returns the number of static parameters. More...

std::string	GetModelDisplayName () const override
	Default implementation returns GetClassID as display name. More...

std::string	GetModelType () const override
	Default implementation returns "Unknown" as model type. More...

FunctionStringType	GetFunctionString () const override
	Default implementation returns an empty function string. More...

std::string	GetXName () const override
	Default implementation returns an empty string. More...

std::string	GetXAxisName () const override
	Default implementation returns an empty string. More...

std::string	GetXAxisUnit () const override
	Default implementation returns an empty string. More...

std::string	GetYAxisName () const override
	Default implementation returns an empty string. More...

std::string	GetYAxisUnit () const override
	Default implementation returns an empty string. More...

Public Member Functions inherited from mitk::ModelBase
ParamterScaleMapType	GetParameterScales () const override
	Default implementation returns a scale of 1.0 for every defined parameter. More...

DerivedParamterScaleMapType	GetDerivedParameterScales () const override
	Default implementation returns a scale of 1.0 for every defined derived parameter. More...

ModellClassIDType	GetClassID () const override
	Default implementation returns the class name of the concrete instance as ID. More...

virtual ParamterUnitMapType	GetStaticParameterUnits () const
	Default implementation returns no unit string ("") for every defined static parameter. More...

void	SetStaticParameters (const StaticParameterMapType &parameters, bool allParameters=true)
	Sets the static parameters of the model before it is used. More...

StaticParameterMapType	GetStaticParameters () const
	Retrieves the static parameters of the model (e.g. for serialization). More...

DerivedParameterMapType	GetDerivedParameters (const ParametersType &parameters) const
	Computes all derived parameters for the given model parameters. More...

virtual void	SetTimeGrid (const TimeGridType &grid)
	Sets the time grid of the model. More...

virtual const TimeGridType &	GetTimeGrid ()
	Gets the time grid of the model. More...

ModelResultType	GetSignal (const ParametersType &parameters) const
	Computes and returns the model signal for the given parameters. More...

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const std::string	NAME_PARAMETER_y_bl

static const std::string	NAME_PARAMETER_x0

static const std::string	NAME_PARAMETER_x1

static const std::string	NAME_PARAMETER_b0

static const std::string	NAME_PARAMETER_b1

static const unsigned int	NUMBER_OF_PARAMETERS

static const std::string	UNIT_PARAMETER_y_bl

static const std::string	UNIT_PARAMETER_x0

static const std::string	UNIT_PARAMETER_x1

static const std::string	UNIT_PARAMETER_b0

static const std::string	UNIT_PARAMETER_b1

static const unsigned int	POSITION_PARAMETER_y_bl

static const unsigned int	POSITION_PARAMETER_x0

static const unsigned int	POSITION_PARAMETER_x1

static const unsigned int	POSITION_PARAMETER_b0

static const unsigned int	POSITION_PARAMETER_b1

static const std::string	NAME_DERIVED_PARAMETER_auc

static const std::string	NAME_DERIVED_PARAMETER_x_fin

static const std::string	NAME_DERIVED_PARAMETER_y_fin

static const std::string	NAME_DERIVED_PARAMETER_y_max

static const std::string	NAME_DERIVED_PARAMETER_y1

static const std::string	NAME_DERIVED_PARAMETER_y2

static const unsigned int	NUMBER_OF_DERIVED_PARAMETERS

static const std::string	UNIT_DERIVED_PARAMETER_auc

static const std::string	UNIT_DERIVED_PARAMETER_x_fin

static const std::string	UNIT_DERIVED_PARAMETER_y_fin

static const std::string	UNIT_DERIVED_PARAMETER_y_max

static const std::string	UNIT_DERIVED_PARAMETER_y1

static const std::string	UNIT_DERIVED_PARAMETER_y2

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
	ThreeStepLinearModel ()

	~ThreeStepLinearModel () override

	ThreeStepLinearModel (const ThreeStepLinearModel &source)

	mitkCloneMacro (ThreeStepLinearModel)

ModelResultType	ComputeModelfunction (const ParametersType &parameters) const override
	Computes the model function for the given parameters. More...

DerivedParameterMapType	ComputeDerivedParameters (const mitk::ModelBase::ParametersType &parameters) const override
	Computes derived parameters from the given model parameters. More...

void	SetStaticParameter (const ParameterNameType &name, const StaticParameterValuesType &values) override
	Sets a single static parameter by name. More...

StaticParameterValuesType	GetStaticParameterValue (const ParameterNameType &name) const override
	Retrieves a single static parameter value by name. More...

Protected Member Functions inherited from mitk::ModelBase
virtual bool	ValidateModel (std::string &error) const
	Validates whether the model is in a valid state to compute the signal. More...

	ModelBase ()

	~ModelBase () override

	ModelBase (const ModelBase &source)

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

Protected Member Functions inherited from mitk::ModelTraitsInterface
	ModelTraitsInterface ()

virtual	~ModelTraitsInterface ()

Static Protected Member Functions
static double	ComputeSignalFromParameters (double x, double s0, double t1, double t2, double a1, double a2, double b1, double b2)

Additional Inherited Members
Protected Attributes inherited from mitk::ModelBase
TimeGridType	m_TimeGrid

Detailed Description

Piecewise linear model with three segments and two transition points.

The model defines three linear segments: a baseline region before x0, an ascending/descending region between x0 and x1, and a final region after x1. Parameters are the baseline value (y_bl), transition points (x0, x1), and slopes (b0, b1). Derived parameters include AUC, x_fin, y_fin, y_max, y1, and y2.

See also: ThreeStepLinearModelFactory, ThreeStepLinearModelParameterizer, ModelBase

Definition at line 34 of file mitkThreeStepLinearModel.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 41 of file mitkThreeStepLinearModel.h.

◆ ParameterNameType

typedef Superclass::ParameterNameType mitk::ThreeStepLinearModel::ParameterNameType

Definition at line 43 of file mitkThreeStepLinearModel.h.

◆ ParametersSizeType

typedef Superclass::ParametersSizeType mitk::ThreeStepLinearModel::ParametersSizeType

Definition at line 44 of file mitkThreeStepLinearModel.h.

◆ Pointer

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

Definition at line 40 of file mitkThreeStepLinearModel.h.

◆ Self

typedef ThreeStepLinearModel mitk::ThreeStepLinearModel::Self

Definition at line 38 of file mitkThreeStepLinearModel.h.

◆ Superclass

typedef mitk::ModelBase mitk::ThreeStepLinearModel::Superclass

Definition at line 39 of file mitkThreeStepLinearModel.h.

Constructor & Destructor Documentation

◆ ThreeStepLinearModel() [1/2]

mitk::ThreeStepLinearModel::ThreeStepLinearModel ( )

inlineprotected

Definition at line 141 of file mitkThreeStepLinearModel.h.

◆ ~ThreeStepLinearModel()

mitk::ThreeStepLinearModel::~ThreeStepLinearModel ( )

inlineoverrideprotected

Definition at line 142 of file mitkThreeStepLinearModel.h.

◆ ThreeStepLinearModel() [2/2]

mitk::ThreeStepLinearModel::ThreeStepLinearModel ( const ThreeStepLinearModel & source )

protected

Member Function Documentation

◆ Clone()

Pointer mitk::ThreeStepLinearModel::Clone ( ) const

◆ ComputeDerivedParameters()

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

overrideprotectedvirtual

Computes derived parameters from the given model parameters.

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::ThreeStepLinearModel::ComputeModelfunction ( const ParametersType & parameters ) const

overrideprotectedvirtual

Computes the model function for the given parameters.

Must be implemented by derived classes.

Parameters

parameters The model parameters.

Returns: The computed model result.

Implements mitk::ModelBase.

◆ ComputeSignalFromParameters()

static double mitk::ThreeStepLinearModel::ComputeSignalFromParameters	(	double	x,
		double	s0,
		double	t1,
		double	t2,
		double	a1,
		double	a2,
		double	b1,
		double	b2
	)

staticprotected

◆ GetClassName()

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

virtual

Run-time type information (and related methods).

Reimplemented from mitk::ModelBase.

◆ GetDerivedParameterNames()

ParameterNamesType mitk::ThreeStepLinearModel::GetDerivedParameterNames ( ) const

overridevirtual

Returns the names of derived parameters that can be computed by the model.

Remarks: Default implementation has no derived parameters.

Reimplemented from mitk::ModelBase.

◆ GetDerivedParameterUnits()

ParamterUnitMapType mitk::ThreeStepLinearModel::GetDerivedParameterUnits ( ) const

overridevirtual

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

Reimplemented from mitk::ModelBase.

◆ GetFunctionString()

FunctionStringType mitk::ThreeStepLinearModel::GetFunctionString ( ) const

overridevirtual

Default implementation returns an empty function string.

Reimplemented from mitk::ModelBase.

◆ GetModelDisplayName()

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

overridevirtual

Default implementation returns GetClassID as display name.

Reimplemented from mitk::ModelBase.

◆ GetModelType()

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

overridevirtual

Default implementation returns "Unknown" as model type.

Reimplemented from mitk::ModelBase.

◆ GetNumberOfDerivedParameters()

ParametersSizeType mitk::ThreeStepLinearModel::GetNumberOfDerivedParameters ( ) const

overridevirtual

Returns the number of derived parameters that can be computed by the model.

Remarks: Default implementation has no derived parameters.

Reimplemented from mitk::ModelBase.

◆ GetNumberOfParameters()

ParametersSizeType mitk::ThreeStepLinearModel::GetNumberOfParameters ( ) const

overridevirtual

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

Returns: The number of model parameters.

Implements mitk::ModelTraitsInterface.

◆ GetNumberOfStaticParameters()

ParametersSizeType mitk::ThreeStepLinearModel::GetNumberOfStaticParameters ( ) const

overridevirtual

Returns the number of static parameters.

Returns: The count of static parameters.

Implements mitk::ModelBase.

◆ GetParameterNames()

ParameterNamesType mitk::ThreeStepLinearModel::GetParameterNames ( ) const

overridevirtual

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

Returns: A vector of parameter name strings.

Implements mitk::ModelTraitsInterface.

◆ GetParameterUnits()

ParamterUnitMapType mitk::ThreeStepLinearModel::GetParameterUnits ( ) const

overridevirtual

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

Reimplemented from mitk::ModelBase.

◆ GetStaticParameterNames()

ParameterNamesType mitk::ThreeStepLinearModel::GetStaticParameterNames ( ) const

overridevirtual

Returns the names of static parameters used when computing the signal.

Static parameters are not part of the fitting scope but configure the model.

Returns: A vector of static parameter names.

Implements mitk::ModelBase.

◆ GetStaticParameterValue()

StaticParameterValuesType mitk::ThreeStepLinearModel::GetStaticParameterValue ( const ParameterNameType & name ) const

overrideprotectedvirtual

Retrieves a single static parameter value by name.

Helper function called by GetStaticParameters(). Must be implemented in derived classes.

Implements mitk::ModelBase.