Tomato
Public Member Functions | Public Attributes | List of all members
Ox::ModelT1Shmolli< MeasureType > Class Template Reference

Container for a CalculatorShmolli model function $ A-B\exp(t/T_1^*) $, cost function and Least-Squares function and derivatives. More...

#include <OxModelT1Shmolli.h>

Inheritance diagram for Ox::ModelT1Shmolli< MeasureType >:
Inheritance graph
[legend]
Collaboration diagram for Ox::ModelT1Shmolli< MeasureType >:
Collaboration graph
[legend]

Public Member Functions

virtual MeasureType calcModelValue (const MeasureType *parameters, MeasureType time)
 
virtual void calcLSResiduals (const MeasureType *parameters, MeasureType *residuals)
 
virtual void calcLSJacobian (const MeasureType *parameters, MeasureType *jacobian)
 
virtual MeasureType calcCostValue (const MeasureType *parameters)
 
virtual void calcCostDerivative (const MeasureType *parameters, MeasureType *derivative)
 
virtual Model< MeasureType > * newByCloning ()
 
virtual ~ModelT1Shmolli ()
 do not forget about the virtual destructor, see https://stackoverflow.com/questions/461203/when-to-use-virtual-destructors
 
- Public Member Functions inherited from Ox::Model< MeasureType >
virtual int getNSamples ()
 
virtual const MeasureType * getInvTimes () const
 
virtual const MeasureType * getEchoTimes () const
 
virtual const MeasureType * getRepTimes () const
 
virtual const MeasureType * getRelAcqTimes () const
 
virtual const MeasureType * getSignal () const
 
virtual int getNDims ()
 
void setNSamples (int _nSamples)
 
virtual void setInvTimes (const MeasureType *_InvTimes)
 
virtual void setEchoTimes (const MeasureType *_EchoTimes)
 
virtual void setRepTimes (const MeasureType *_RepTimes)
 
virtual void setRelAcqTimes (const MeasureType *_RelAcqTimes)
 
virtual void setSignal (const MeasureType *_Signal)
 
virtual std::string getNthParamName (int nthParam)
 
virtual void disp ()
 show me your ModelT1
 
void setAllPointersToNull ()
 set all the pointers to zero
 
 Model ()
 constructor
 
 Model (const Model &old)
 copy constructor keeps only _nSamples and _nDims More...
 
virtual ~Model ()
 do not forget about the virtual destructor, see https://stackoverflow.com/questions/461203/when-to-use-virtual-destructors
 

Public Attributes

bool _expAbsCost
 
bool _preventUnderOverFlow
 
bool _costHeuristic
 
bool _rootMedianSquareCost
 

Additional Inherited Members

- Protected Attributes inherited from Ox::Model< MeasureType >
const MeasureType * _InvTimes
 
const MeasureType * _EchoTimes
 
const MeasureType * _RepTimes
 
const MeasureType * _RelAcqTimes
 
const MeasureType * _Signal
 
int _nSamples
 
int _nDims
 
MeasureType * _Residuals
 

Detailed Description

template<typename MeasureType>
class Ox::ModelT1Shmolli< MeasureType >

Container for a CalculatorShmolli model function $ A-B\exp(t/T_1^*) $, cost function and Least-Squares function and derivatives.

Template Parameters
MeasureType

Member Function Documentation

template<typename MeasureType >
void Ox::ModelT1Shmolli< MeasureType >::calcCostDerivative ( const MeasureType *  parameters,
MeasureType *  derivative 
)
virtual

calcCostDerivative the most important function of this class

Parameters
derivative

Implements Ox::Model< MeasureType >.

template<typename MeasureType >
MeasureType Ox::ModelT1Shmolli< MeasureType >::calcCostValue ( const MeasureType *  parameters)
virtual

calcCostValue the most important function of this class

Returns

Implements Ox::Model< MeasureType >.

template<typename MeasureType >
void Ox::ModelT1Shmolli< MeasureType >::calcLSJacobian ( const MeasureType *  parameters,
MeasureType *  jacobian 
)
virtual

calcLSJacobian the most important function of this class

Parameters
jacobian- 2d matrix stored as 1d array

Implements Ox::Model< MeasureType >.

template<typename MeasureType >
void Ox::ModelT1Shmolli< MeasureType >::calcLSResiduals ( const MeasureType *  parameters,
MeasureType *  residuals 
)
virtual

calcLSResiduals the most important function of this class

Parameters
residuals

Implements Ox::Model< MeasureType >.

template<typename MeasureType >
MeasureType Ox::ModelT1Shmolli< MeasureType >::calcModelValue ( const MeasureType *  parameters,
MeasureType  time 
)
virtual

calcModelValue the most important function of this class

Parameters
time
Returns
model(time)

Implements Ox::Model< MeasureType >.

template<typename MeasureType>
virtual Model<MeasureType>* Ox::ModelT1Shmolli< MeasureType >::newByCloning ( )
inlinevirtual

cloning

Returns

Implements Ox::Model< MeasureType >.

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