Tomato
Public Member Functions | Protected Attributes | List of all members
Ox::Fitter< MeasureType > Class Template Referenceabstract

#include <OxFitter.h>

Public Member Functions

virtual int performFitting ()=0
 
virtual const Model< MeasureType > * getModel () const
 
virtual MeasureType * getParameters ()
 
virtual MeasureType getMse () const
 
virtual const MeasureType getXTolerance () const
 
virtual const MeasureType getFTolerance () const
 
virtual const bool getUseGradient () const
 
virtual const unsigned int getMaxFunctionEvals () const
 
virtual const unsigned int getThreadId () const
 
virtual const bool getVerbose () const
 
virtual const bool getTrace () const
 
virtual void setModel (Model< MeasureType > *_ModelT1)
 
virtual void setParameters (MeasureType *_Parameters)
 
virtual void setMse (MeasureType mse)
 
virtual void setXTolerance (const MeasureType _XTolerance)
 
virtual void setUseGradient (const bool _UseGradient)
 
virtual void setFTolerance (const MeasureType _FTolerance)
 
virtual void setMaxFunctionEvals (const unsigned int _MaxFunctionEvals)
 
virtual void setThreadId (const unsigned int _ThreadId)
 
virtual void setVerbose (const bool _Verbose)
 
virtual void setTrace (const bool _Trace)
 
virtual void copyToParameters (const MeasureType *ptrFrom)
 
virtual void disp ()
 show me your Fitter
 
 Fitter ()
 constructor
 
 Fitter (const Fitter &old)
 
virtual Fitter< MeasureType > * newByCloning ()=0
 
virtual ~Fitter ()
 do not forget about the virtual destructor, see https://stackoverflow.com/questions/461203/when-to-use-virtual-destructors
 

Protected Attributes

Model< MeasureType > * _Model
 
MeasureType * _Parameters
 
MeasureType _Mse
 
MeasureType _XTolerance
 
MeasureType _FTolerance
 
int _MaxFunctionEvals
 
bool _UseGradient
 
unsigned int _ThreadId
 
bool _Verbose
 
bool _Trace
 

Detailed Description

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

Template Parameters
MeasureType

Constructor & Destructor Documentation

template<typename MeasureType>
Ox::Fitter< MeasureType >::Fitter ( const Fitter< MeasureType > &  old)
inline

copy constructor

Parameters
old

Member Function Documentation

template<typename MeasureType>
virtual void Ox::Fitter< MeasureType >::copyToParameters ( const MeasureType *  ptrFrom)
inlinevirtual

copy from ptrFrom to the parameters. Parameters have to be allocated first

Parameters
ptrFrom
template<typename MeasureType>
virtual Fitter<MeasureType>* Ox::Fitter< MeasureType >::newByCloning ( )
pure virtual

cloning

Returns
template<typename MeasureType>
virtual int Ox::Fitter< MeasureType >::performFitting ( )
pure virtual

the most important function of this class

Returns
success/failure
The documentation for this class was generated from the following file: