Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
mitk::TwoStepLinearModel Class Reference

#include <mitkTwoStepLinearModel.h>

Inheritance diagram for mitk::TwoStepLinearModel:
Inheritance graph
[legend]
Collaboration diagram for mitk::TwoStepLinearModel:
Collaboration graph
[legend]

Public Types

typedef TwoStepLinearModel 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
 
virtual std::string GetModelDisplayName () const override
 
virtual std::string GetModelType () const override
 
virtual FunctionStringType GetFunctionString () const override
 
virtual std::string GetXName () const override
 
virtual ParameterNamesType GetParameterNames () const override
 
virtual ParametersSizeType GetNumberOfParameters () const override
 
virtual ParameterNamesType GetStaticParameterNames () const override
 
virtual ParametersSizeType GetNumberOfStaticParameters () const override
 
virtual ParameterNamesType GetDerivedParameterNames () const override
 
virtual ParametersSizeType GetNumberOfDerivedParameters () 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
 
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 ()
 

Static Public Attributes

static const std::string MODELL_NAME
 
static const std::string NAME_PARAMETER_y1
 
static const std::string NAME_PARAMETER_t
 
static const std::string NAME_PARAMETER_a1
 
static const std::string NAME_PARAMETER_a2
 
static const unsigned int POSITION_PARAMETER_y1
 
static const unsigned int POSITION_PARAMETER_t
 
static const unsigned int POSITION_PARAMETER_a1
 
static const unsigned int POSITION_PARAMETER_a2
 
static const unsigned int NUMBER_OF_PARAMETERS
 

Protected Member Functions

 TwoStepLinearModel ()
 
virtual ~TwoStepLinearModel ()
 
virtual itk::LightObject::Pointer InternalClone () const
 
virtual ModelResultType ComputeModelfunction (const ParametersType &parameters) const
 
virtual DerivedParameterMapType ComputeDerivedParameters (const mitk::ModelBase::ParametersType &parameters) const
 
virtual void SetStaticParameter (const ParameterNameType &name, const StaticParameterValuesType &values)
 
virtual StaticParameterValuesType GetStaticParameterValue (const ParameterNameType &name) const
 
- 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

Definition at line 23 of file mitkTwoStepLinearModel.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 30 of file mitkTwoStepLinearModel.h.

◆ ParameterNameType

typedef Superclass::ParameterNameType mitk::TwoStepLinearModel::ParameterNameType

Definition at line 32 of file mitkTwoStepLinearModel.h.

◆ ParametersSizeType

typedef Superclass::ParametersSizeType mitk::TwoStepLinearModel::ParametersSizeType

Definition at line 33 of file mitkTwoStepLinearModel.h.

◆ Pointer

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

Definition at line 29 of file mitkTwoStepLinearModel.h.

◆ Self

typedef TwoStepLinearModel mitk::TwoStepLinearModel::Self

Definition at line 27 of file mitkTwoStepLinearModel.h.

◆ Superclass

typedef mitk::ModelBase mitk::TwoStepLinearModel::Superclass

Definition at line 28 of file mitkTwoStepLinearModel.h.

Constructor & Destructor Documentation

◆ TwoStepLinearModel()

mitk::TwoStepLinearModel::TwoStepLinearModel ( )
inlineprotected

Definition at line 77 of file mitkTwoStepLinearModel.h.

◆ ~TwoStepLinearModel()

virtual mitk::TwoStepLinearModel::~TwoStepLinearModel ( )
inlineprotectedvirtual

Definition at line 78 of file mitkTwoStepLinearModel.h.

Member Function Documentation

◆ Clone()

Pointer mitk::TwoStepLinearModel::Clone ( ) const

◆ ComputeDerivedParameters()

virtual DerivedParameterMapType mitk::TwoStepLinearModel::ComputeDerivedParameters ( const mitk::ModelBase::ParametersType &  parameters) const
protectedvirtual

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

virtual ModelResultType mitk::TwoStepLinearModel::ComputeModelfunction ( const ParametersType &  parameters) const
protectedvirtual

Implements mitk::ModelBase.

◆ GetClassName()

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

Run-time type information (and related methods).

Reimplemented from mitk::ModelBase.

◆ GetDerivedParameterNames()

virtual ParameterNamesType mitk::TwoStepLinearModel::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()

virtual FunctionStringType mitk::TwoStepLinearModel::GetFunctionString ( ) const
overridevirtual

Default implementation returns an empty functions string.

Reimplemented from mitk::ModelBase.

◆ GetModelDisplayName()

virtual std::string mitk::TwoStepLinearModel::GetModelDisplayName ( ) const
overridevirtual

Default implementation returns GetClassID as display name.

Reimplemented from mitk::ModelBase.

◆ GetModelType()

virtual std::string mitk::TwoStepLinearModel::GetModelType ( ) const
overridevirtual

Default implementation returns "Unkown" as model type.

Reimplemented from mitk::ModelBase.

◆ GetNumberOfDerivedParameters()

virtual ParametersSizeType mitk::TwoStepLinearModel::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()

virtual ParametersSizeType mitk::TwoStepLinearModel::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()

virtual ParametersSizeType mitk::TwoStepLinearModel::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()

virtual ParameterNamesType mitk::TwoStepLinearModel::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()

virtual ParameterNamesType mitk::TwoStepLinearModel::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()

virtual StaticParameterValuesType mitk::TwoStepLinearModel::GetStaticParameterValue ( const ParameterNameType &  name) const
protectedvirtual

Helper function called by GetStaticParameters(). Implement in derived classes to realize the concrete retrieval of static parameters.

Implements mitk::ModelBase.

◆ GetXName()

virtual std::string mitk::TwoStepLinearModel::GetXName ( ) const
overridevirtual

Default implementation returns an empty string.

Reimplemented from mitk::ModelBase.

◆ InternalClone()

virtual itk::LightObject::Pointer mitk::TwoStepLinearModel::InternalClone ( ) const
protectedvirtual

Actual implementation of the clone method. This method should be reimplemeted in subclasses to clone the extra required parameters.

◆ New()

static Pointer mitk::TwoStepLinearModel::New ( )
static

Method for creation through the object factory.

◆ SetStaticParameter()

virtual void mitk::TwoStepLinearModel::SetStaticParameter ( const ParameterNameType &  name,
const StaticParameterValuesType &  values 
)
protectedvirtual

Helper function called by SetStaticParameters(). Implement in derived classes to realize the concrete setting of static parameters.

Implements mitk::ModelBase.

Member Data Documentation

◆ MODELL_NAME

const std::string mitk::TwoStepLinearModel::MODELL_NAME
static

Definition at line 42 of file mitkTwoStepLinearModel.h.

◆ NAME_PARAMETER_a1

const std::string mitk::TwoStepLinearModel::NAME_PARAMETER_a1
static

Definition at line 45 of file mitkTwoStepLinearModel.h.

◆ NAME_PARAMETER_a2

const std::string mitk::TwoStepLinearModel::NAME_PARAMETER_a2
static

Definition at line 46 of file mitkTwoStepLinearModel.h.

◆ NAME_PARAMETER_t

const std::string mitk::TwoStepLinearModel::NAME_PARAMETER_t
static

Definition at line 44 of file mitkTwoStepLinearModel.h.

◆ NAME_PARAMETER_y1

const std::string mitk::TwoStepLinearModel::NAME_PARAMETER_y1
static

Definition at line 43 of file mitkTwoStepLinearModel.h.

◆ NUMBER_OF_PARAMETERS

const unsigned int mitk::TwoStepLinearModel::NUMBER_OF_PARAMETERS
static

Definition at line 53 of file mitkTwoStepLinearModel.h.

◆ POSITION_PARAMETER_a1

const unsigned int mitk::TwoStepLinearModel::POSITION_PARAMETER_a1
static

Definition at line 50 of file mitkTwoStepLinearModel.h.

◆ POSITION_PARAMETER_a2

const unsigned int mitk::TwoStepLinearModel::POSITION_PARAMETER_a2
static

Definition at line 51 of file mitkTwoStepLinearModel.h.

◆ POSITION_PARAMETER_t

const unsigned int mitk::TwoStepLinearModel::POSITION_PARAMETER_t
static

Definition at line 49 of file mitkTwoStepLinearModel.h.

◆ POSITION_PARAMETER_y1

const unsigned int mitk::TwoStepLinearModel::POSITION_PARAMETER_y1
static

Definition at line 48 of file mitkTwoStepLinearModel.h.

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