Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

FitFunction Class Reference

#include <FitFunction.h>

Inheritance diagram for FitFunction::

IFitFunction List of all members.

Public Methods

 FitFunction (const std::string &label, const std::string &type, const std::string &options)
 Claims ownership to fitter (must be dynamically allocated). Fitter must have the model defined! More...

virtual ~FitFunction ()
 Delete model and fitter. More...

virtual bool setFixed (const std::string &name, bool state)
virtual bool setBounds (const std::string &name, double lower, double upper)
virtual bool setStart (const std::string &name, double start)
virtual bool clearBounds (const std::string &name)
virtual bool setStepSize (const std::string &name, double step)
virtual double error (const std::string &name)
virtual const std::vector<
double >& 
errors ()
virtual double chiSquare ()
virtual double degreeOfFreedom ()
virtual bool setErrors (const std::vector< double > &errors)
virtual bool setChiSquare (double chiSquare)
virtual bool setDegreeOfFreedom (double degreeOfFreedom)
virtual bool hasGradient () const
virtual const std::vector<
double >& 
getGradient (const std::vector< double > &one, const std::vector< double > &orTwo)
virtual bool fit (const IHistogram &histogram)
virtual bool fit (const IHistogram &histogram, int imin, int imax)
virtual bool fit (const ICloud &cloud, int imin=0, int imax=0)
virtual const std::string& label () const
virtual double value (const std::vector< double > &point) const
virtual int dimension () const
virtual const std::vector<
std::string >& 
parameterNames () const
virtual const std::vector<
double >& 
parameterValues () const
virtual bool setParameterValue (const std::string &name, double value)
virtual const string& version () const

Protected Methods

bool m_fit (int imin, int imax)
void nyi () const

Private Methods

 FitFunction (const FitFunction &)
FitFunction& operator= (const FitFunction &)

Private Attributes

std::auto_ptr<Function_plain_wrapperm_model
std::auto_ptr<FML::IFitter_impl> m_fitter
std::auto_ptr<Anaphe::IVector> m_source_data
std::string m_version
std::vector<double> m_errors_ret
std::string m_method

Constructor & Destructor Documentation

FitFunction::FitFunction ( const std::string & label,
const std::string & type,
const std::string & options )
 

Definition at line 60 of file FitFunction.cpp.

FitFunction::~FitFunction ( ) [virtual]
 

Definition at line 82 of file FitFunction.cpp.

FitFunction::FitFunction ( const FitFunction & ) [private]
 

Definition at line 88 of file FitFunction.cpp.


Member Function Documentation

double FitFunction::chiSquare ( ) [virtual]
 

Definition at line 183 of file FitFunction.cpp.

bool FitFunction::clearBounds ( const std::string & name ) [virtual]
 

Definition at line 135 of file FitFunction.cpp.

double FitFunction::degreeOfFreedom ( ) [virtual]
 

Definition at line 194 of file FitFunction.cpp.

int FitFunction::dimension ( ) const [virtual]
 

Returns:
dimension of the function

Definition at line 318 of file FitFunction.cpp.

double FitFunction::error ( const std::string & name ) [virtual]
 

TODO: missing similar access method for parameter values!!

Definition at line 157 of file FitFunction.cpp.

const std::vector< double > & FitFunction::errors ( ) [virtual]
 

Definition at line 167 of file FitFunction.cpp.

bool FitFunction::fit ( const ICloud & cloud,
int imin = 0,
int imax = 0 ) [virtual]
 

Parameters:
cloud   The cloud to fit to the function. imin, imax : fit range
Returns:
Whether the fit converged or not.

Definition at line 280 of file FitFunction.cpp.

bool FitFunction::fit ( const IHistogram & histogram,
int imin,
int imax ) [virtual]
 

Parameters:
histogram   The histogram to fit to the function. imin, imax : fit range
Returns:
Whether the fit converged or not.

Definition at line 259 of file FitFunction.cpp.

bool FitFunction::fit ( const IHistogram & histogram ) [virtual]
 

Parameters:
histogram   The histogram to fit to the function.
Returns:
Whether the fit converged or not.

Definition at line 254 of file FitFunction.cpp.

const std::vector< double > & FitFunction::getGradient ( const std::vector< double > & one,
const std::vector< double > & orTwo ) [virtual]
 

FIXME: We need a Fitter expert here!

Definition at line 248 of file FitFunction.cpp.

bool FitFunction::hasGradient ( ) const [virtual]
 

Definition at line 235 of file FitFunction.cpp.

const std::string & FitFunction::label ( ) const [virtual]
 

Definition at line 308 of file FitFunction.cpp.

bool FitFunction::m_fit ( int imin,
int imax ) [protected]
 

Definition at line 359 of file FitFunction.cpp.

Referenced by fit().

void FitFunction::nyi ( ) const [protected]
 

Definition at line 348 of file FitFunction.cpp.

Referenced by getGradient(), setChiSquare(), setDegreeOfFreedom(), and setErrors().

FitFunction & FitFunction::operator= ( const FitFunction & rhs ) [private]
 

Definition at line 92 of file FitFunction.cpp.

const std::vector< std::string > & FitFunction::parameterNames ( ) const [virtual]
 

Returns:

Definition at line 323 of file FitFunction.cpp.

const std::vector< double > & FitFunction::parameterValues ( ) const [virtual]
 

Returns:

Definition at line 328 of file FitFunction.cpp.

bool FitFunction::setBounds ( const std::string & name,
double lower,
double upper ) [virtual]
 

  • NOTE you may pass Double.NEGATIVE_INFINITY or Double.POSITIVE_INFINITY

Definition at line 113 of file FitFunction.cpp.

bool FitFunction::setChiSquare ( double chiSquare ) [virtual]
 

Definition at line 223 of file FitFunction.cpp.

bool FitFunction::setDegreeOfFreedom ( double degreeOfFreedom ) [virtual]
 

Definition at line 229 of file FitFunction.cpp.

bool FitFunction::setErrors ( const std::vector< double > & errors ) [virtual]
 

Definition at line 217 of file FitFunction.cpp.

bool FitFunction::setFixed ( const std::string & name,
bool state ) [virtual]
 

Definition at line 99 of file FitFunction.cpp.

bool FitFunction::setParameterValue ( const std::string & name,
double value ) [virtual]
 

Definition at line 338 of file FitFunction.cpp.

bool FitFunction::setStart ( const std::string & name,
double start ) [virtual]
 

Definition at line 124 of file FitFunction.cpp.

bool FitFunction::setStepSize ( const std::string & name,
double step ) [virtual]
 

Definition at line 146 of file FitFunction.cpp.

double FitFunction::value ( const std::vector< double > & point ) const [virtual]
 

Parameters:
point   of evaluation
Returns:
value at the given point or NaN if function is not defined at this point
Exceptions:
IllegalArgumentException   if the length of the array is incorrect

Definition at line 313 of file FitFunction.cpp.

const string & FitFunction::version ( ) const [virtual]
 

Definition at line 333 of file FitFunction.cpp.


Member Data Documentation

std::vector< double > FitFunction::m_errors_ret<double> [private]
 

Definition at line 210 of file FitFunction.h.

std::auto_ptr< FML::IFitter_impl > FitFunction::m_fitter<FML::IFitter_impl> [mutable, private]
 

Definition at line 207 of file FitFunction.h.

std::string FitFunction::m_method [private]
 

Definition at line 211 of file FitFunction.h.

std::auto_ptr< Function_plain_wrapper > FitFunction::m_model<Function_plain_wrapper> [mutable, private]
 

Definition at line 206 of file FitFunction.h.

std::auto_ptr< Anaphe::IVector > FitFunction::m_source_data<Anaphe::IVector> [mutable, private]
 

Definition at line 208 of file FitFunction.h.

std::string FitFunction::m_version [mutable, private]
 

Definition at line 209 of file FitFunction.h.


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

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