Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

Anaphe::IFitter Class Reference

#include <IFitter.h>

List of all members.


Detailed Description

Parameters are accessed via IFitParameter interface. Model function setModel() determines number and names of parameters. Unless overriden, default values of parameters are applied (possibly taking into account data vector).

PENDING: names of parameters to be discussed (for combined models).


Public Methods

virtual void setModel (const char *)=0
 Set model function as a combination of letters: G (Gaussian), E (Exponential), Pn (Polynomial of order n). The number of models and their naming depends of underlying implementation. However some standard naming rules apply. PENDING: exact syntax for combinations to be defined PENDING: at present only basic models supported.

virtual void setData (const IVector *)=0
 Set data vector.

virtual bool chiSquareFit ()=0
 Perform chi-square fit of previosly defined model function and data vector.

virtual bool setParameter (const char *nameId, double start, double step=1.0)=0
 Set starting point for given parameter. Other atrributes are set to their default values. Parameters are identified by case-insensitive nameId. If nameId does not exist return false.

virtual IFitParameterfitParameter (const char *nameId)=0
 Retrieve fit parameter (identified by nameId). Return null pointer if nameId does not exist.

virtual bool includePoint (int i)=0
 Include single point. Return false if index out of bounds (see IVector).

virtual bool excludePoint (int i)=0
 Exclude single point. Return false if index out of bounds (see IVector).

virtual bool includeRange (int iMin, int iMax)=0
 Include all points from iMin to iMax inclusively. Return false if range invalid (see also indexing in IVector).

virtual bool excludeRange (int iMin, int iMax)=0
 Exclude all points from iMin to iMax inclusively. Return false if range invalid (see also indexing in IVector).

virtual void includeAll ()=0
 Include all points (remove all previous exclusions).

virtual void excludeAll ()=0
 Exclude all points. Should be followed by some point inclusion otherwise no data for fitting.

virtual void printParameters (std::ostream &os=std::cout)=0
virtual void printResult (std::ostream &os=std::cout)=0
virtual IVectorfittedVector (IVectorManager *)=0
 Vector representation of the fitted curve. PENDING: not fully discussed (ownership).

virtual ~IFitter ()


Constructor & Destructor Documentation

virtual Anaphe::IFitter::~IFitter   [inline, virtual]
 


Member Function Documentation

virtual bool Anaphe::IFitter::chiSquareFit   [pure virtual]
 

False indicates that error occured and results are not available. This may happen either if model or data are not set, or if fitting failed (minimization not converged).

virtual void Anaphe::IFitter::excludeAll   [pure virtual]
 

virtual bool Anaphe::IFitter::excludePoint int    i [pure virtual]
 

virtual bool Anaphe::IFitter::excludeRange int    iMin,
int    iMax
[pure virtual]
 

virtual IFitParameter* Anaphe::IFitter::fitParameter const char *    nameId [pure virtual]
 

virtual IVector* Anaphe::IFitter::fittedVector IVectorManager   [pure virtual]
 

virtual void Anaphe::IFitter::includeAll   [pure virtual]
 

virtual bool Anaphe::IFitter::includePoint int    i [pure virtual]
 

virtual bool Anaphe::IFitter::includeRange int    iMin,
int    iMax
[pure virtual]
 

virtual void Anaphe::IFitter::printParameters std::ostream &    os = std::cout [pure virtual]
 

virtual void Anaphe::IFitter::printResult std::ostream &    os = std::cout [pure virtual]
 

virtual void Anaphe::IFitter::setData const IVector   [pure virtual]
 

virtual void Anaphe::IFitter::setModel const char *    [pure virtual]
 

virtual bool Anaphe::IFitter::setParameter const char *    nameId,
double    start,
double    step = 1.0
[pure virtual]
 


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

Anaphe documentation generated by Doxygen (www.doxygen.org)