Tomato
Public Member Functions | Protected Attributes | List of all members
Ox::Calculator< MeasureType > Class Template Referenceabstract
Inheritance diagram for Ox::Calculator< MeasureType >:
Inheritance graph
[legend]

Public Member Functions

virtual int calculate ()=0
 
virtual int prepareToCalculate ()=0
 
virtual std::map< std::string, MeasureType > getResults () const
 
virtual Model< MeasureType > * getModel () const
 
virtual Fitter< MeasureType > * getFitter () const
 
virtual StartPointCalculator< MeasureType > * getStartPointCalculator () const
 
virtual SignCalculator< MeasureType > * getSignCalculator () const
 
virtual const MeasureType * getInvTimes () const
 
virtual const MeasureType * getEchoTimes () const
 
virtual const MeasureType * getRepTimes () const
 
virtual const MeasureType * getRelAcqTimes () const
 
virtual const MeasureType * getSigMag () const
 
virtual const MeasureType * getSigPha () const
 
virtual const MeasureType * getNoise () const
 
virtual MeasureType * getSignal () const
 
virtual MeasureType * getSigns () const
 
virtual MeasureType * getStartPoint ()
 
virtual MeasureType getMeanCutOff () const
 
virtual int getNSamples () const
 
virtual int getNDims () const
 
MeasureType * getParametersAfterFitting () const
 
virtual void setModel (Model< MeasureType > *_Model)
 
virtual void setFitter (Fitter< MeasureType > *_Fitter)
 
virtual void setSignCalculator (SignCalculator< MeasureType > *_SignCalculator)
 
virtual void setStartPointCalculator (StartPointCalculator< MeasureType > *_StartPointCalculator)
 
virtual void setInvTimes (const MeasureType *_InvTimes)
 
virtual void setEchoTimes (const MeasureType *_EchoTimes)
 
virtual void setSigMag (const MeasureType *_SigMag)
 
virtual void setSigPha (const MeasureType *_SigPha)
 
virtual void setNoise (const MeasureType *_Noise)
 
virtual void setMeanCutOff (MeasureType _MeanCutOff)
 
virtual void setNSamples (int _nSamples)
 
virtual void setNDims (int _nDims)
 
void disp ()
 show me your Model
 
void setAllPointersToNull ()
 set all the pointers to zero
 
 Calculator ()
 constructor
 
 Calculator (const Calculator &old)
 copy constructor
 
virtual Calculator< MeasureType > * newByCloning ()=0
 
virtual ~Calculator ()
 do not forget about the virtual destructor, see https://stackoverflow.com/questions/461203/when-to-use-virtual-destructors
 

Protected Attributes

Model< MeasureType > * _Model
 
Fitter< MeasureType > * _Fitter
 
SignCalculator< MeasureType > * _SignCalculator
 
StartPointCalculator< MeasureType > * _StartPointCalculator
 
const MeasureType * _InvTimes
 
const MeasureType * _EchoTimes
 
const MeasureType * _RepTimes
 
const MeasureType * _RelAcqTimes
 
const MeasureType * _SigMag
 
const MeasureType * _SigPha
 
const MeasureType * _Noise
 
MeasureType * _Signal
 
MeasureType * _Signs
 
MeasureType * _StartPoint
 
int _nSamples
 
int _nDims
 
MeasureType _MeanCutOff
 
MeasureType * _ParametersAfterFitting
 
std::map< std::string, MeasureType > _Results
 

Member Function Documentation

template<typename MeasureType>
virtual int Ox::Calculator< MeasureType >::calculate ( )
pure virtual

the most important function of this class

Returns
success/failure

Implemented in Ox::CalculatorT1Shmolli< MeasureType >, and Ox::CalculatorT1WithSignCheck< MeasureType >.

template<typename MeasureType >
Fitter< MeasureType > * Ox::Calculator< MeasureType >::getFitter ( ) const
virtual

/throw exception if _Fitter == 0

Returns
template<typename MeasureType >
Model< MeasureType > * Ox::Calculator< MeasureType >::getModel ( ) const
virtual

/throw exception if _Model == 0

Returns
template<typename MeasureType >
int Ox::Calculator< MeasureType >::getNDims ( ) const
virtual

/throw exception if _nDims == 0

Returns
template<typename MeasureType >
int Ox::Calculator< MeasureType >::getNSamples ( ) const
virtual

/throw exception if _nSamples == 0

Returns
template<typename MeasureType >
const MeasureType * Ox::Calculator< MeasureType >::getSigMag ( ) const
virtual

/throw exception if _SigMag == 0

Returns
template<typename MeasureType >
const MeasureType * Ox::Calculator< MeasureType >::getSigPha ( ) const
virtual

does not have to be set

Returns
SigPha pointer, can be 0 (NULL)
template<typename MeasureType>
virtual Calculator<MeasureType>* Ox::Calculator< MeasureType >::newByCloning ( )
pure virtual

cloning

Returns

Implemented in Ox::CalculatorT1WithSignCheck< MeasureType >, and Ox::CalculatorT1Shmolli< MeasureType >.

template<typename MeasureType>
virtual int Ox::Calculator< MeasureType >::prepareToCalculate ( )
pure virtual

processing before calculate is called

Returns
success/failure

Implemented in Ox::CalculatorT1Shmolli< MeasureType >, and Ox::CalculatorT1WithSignCheck< MeasureType >.

template<typename MeasureType >
void Ox::Calculator< MeasureType >::setNDims ( int  nDims)
virtual

_StartPoint is allocated here!!!

Parameters
_nDims
template<typename MeasureType >
void Ox::Calculator< MeasureType >::setNSamples ( int  _nSamples)
virtual

_Signal and _Signs are allocated here!!!

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