FunctionBase Class Reference

#include <FunctionBase.h>

Inheritance diagram for FunctionBase:

Inheritance graph
BrokenPowerLawChi2DistConstantFErfcExponentialFunctionWrapGaussianLandauLinearLinearSumFunctionLogNormalLogParabolaNovosibirskPowerLawQuadraticQuadratic2
[legend]
Collaboration diagram for FunctionBase:

Collaboration graph
[legend]
List of all members.

Detailed Description

A function that can be added to a DataRep and used in a fitter.

This is the base class for functions that can be added to a DataRep and used by a fitter. The initial value of the functions parameters can be set by a call to the initialParameters() member function. This function takes as argument a FunctionHelper which maybe connected to the data set. The function can make calls to the FunctionHelper to get some summaries from the data set and make an estimate of parameter values so that the function will at least appear on the DataRep if not come close to fitting it. This function must be implemented in a derived class.

The value of the function at a given value of the one dimensional coordinate x, or multi-dimensional coordinates as vector of doubles is obtained by a call to the overloaded member function operator()(). This function must be implemented in a derived class.

To support a user interface, the name of the function may be obtained by a call to the name() member function and the name of the function's parameters from the parmNames() member function. The values of the function's parameters can be obtained by a call to the getParameters() member function. The number of parameters can be obtained by the size member function.

Internally, setting and receiving the parameters described above is done by the functions that take an iterator as an argument. The iterator skips over fixed parameters in both setting and receiving functions. This architecture is used to support the derived class LinearSumFunction.

Derived classes need to implement a few pure virtual functions defined by this class.

Once there conditions are satisfied, the class maybe added to the FunctionFactory for use in applications.

Note:
This class does not have any dependence on any other part of the HippoDraw class library. If the function classes are useful for other applications or class library builders, it could be split off as a separate package. Please let the author know if you would like to use this class outside the context of HippoDraw.
Author:
Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Definition at line 90 of file FunctionBase.h.

Public Member Functions

virtual void addToComposite (FunctionBase *)
 Does nothing.
virtual FunctionBaseclone () const
 Creates a new function object by copying an existing one.
virtual int count ()
 Returns 0.
virtual double derivByParm (int i, double x) const
 Returns the function's derivative at the coordinate value x with respect to the i-th parameter.
virtual unsigned int dimensions () const
 Returns the number of dimensions of the data coordinate.
virtual const std::vector<
double > & 
getParameters () const
 Returns the values of the parameters as a vector.
virtual bool hasDerivatives () const
 Returns true if function can calculate its partial derivatives.
virtual void initialParameters (const FunctionHelper *helper)
 Sets the FunctionHelper so that the function can calculate a reasonable set of initial parameter values.
virtual double integrate (double lower_limit, double upper_limit) const
virtual bool isComposite () const
 Returns false.
const std::string & name () const
 Returns the name of the function.
virtual double operator() (const std::vector< double > &v) const
 The function call operator for multi-dimension coordinate variable.
virtual double operator() (double x) const
 The function call operator.
virtual const std::vector<
std::string > & 
parmNames () const
 Returns a reference to a vector of parameter names.
virtual void removeFromComposite (FunctionBase *)
 Does nothing.
virtual std::vector< double
>::const_iterator 
setParameters (std::vector< double >::const_iterator it)
 Sets the parameter values to the value pointed to by the iterator.
virtual void setParameters (const std::vector< double > &incr)
 Sets the parameter values.
void setParmNames (const std::vector< std::string > &names)
 Sets the names of the parameters.
virtual int size () const
 Returns the number of parameters.
virtual ~FunctionBase ()
 The virtual destructor.

Protected Member Functions

 FunctionBase (const FunctionBase &)
 FunctionBase ()
 Should never be called.
virtual void initialize ()
 Initializes the function and parameter names.
virtual void resize ()
 Re-sizes the appropriate vectors maintained in this base class.
void setName (const char *)
 Sets the name of the function.

Protected Attributes

std::string m_name
 The name of the function.
std::vector< std::string > m_parm_names
 The names of the function parameters.
std::vector< double > m_parms
 The parameter values.


Constructor & Destructor Documentation

FunctionBase (  )  [protected]

Should never be called.

Definition at line 30 of file FunctionBase.cxx.

References FunctionBase::m_name.

FunctionBase ( const FunctionBase fb  )  [protected]

Requests:
Remove this copy constructor, it was only tempoary to try to fix cloning functions written in Python with SIP.

Definition at line 39 of file FunctionBase.cxx.

~FunctionBase (  )  [virtual]

The virtual destructor.

Definition at line 46 of file FunctionBase.cxx.


Member Function Documentation

void addToComposite ( FunctionBase  )  [virtual]

Does nothing.

Derived classes that are a composite of functions should override this member function and add functions to the composite.

Reimplemented in LinearSumFunction.

Definition at line 166 of file FunctionBase.cxx.

FunctionBase * clone (  )  const [virtual]

Creates a new function object by copying an existing one.

The implementation raises an assertion as this member function should be reimplemented in s derived class.

Note:
There's an implementation here to satisfy the SIP interface.

Reimplemented in BrokenPowerLaw, Chi2Dist, ConstantF, Erfc, Exponential, Gaussian, Landau, Linear, LinearSumFunction, LogNormal, LogParabola, Novosibirsk, PowerLaw, Quadratic, Quadratic2, and FunctionWrap.

Definition at line 52 of file FunctionBase.cxx.

int count (  )  [virtual]

Returns 0.

Derived classes that are a composite of functions should override this member function to return the number of functions in the composite.

Reimplemented in LinearSumFunction.

Definition at line 174 of file FunctionBase.cxx.

double derivByParm ( int  i,
double  x 
) const [virtual]

Returns the function's derivative at the coordinate value x with respect to the i-th parameter.

Derived classes must implement this function.

Todo:
Provide a numeric method for doing this calculation that will be the default. Derived classes should provide more efficient analytic method if available.
Bug:
Make this function pure when problem compiling python/FunctionWrap under Windows is solved.

Reimplemented in BrokenPowerLaw, Chi2Dist, ConstantF, Erfc, Exponential, Gaussian, Landau, Linear, LinearSumFunction, LogNormal, LogParabola, Novosibirsk, PowerLaw, Quadratic, Quadratic2, and FunctionWrap.

Definition at line 190 of file FunctionBase.cxx.

unsigned int dimensions (  )  const [virtual]

Returns the number of dimensions of the data coordinate.

This implementation in the base class returns 1. Derived class should override this function if the data coordinate is multi-dimensional.

Reimplemented in FunctionWrap.

Definition at line 213 of file FunctionBase.cxx.

Referenced by FunctionWrap::dimensions().

const vector< double > & getParameters (  )  const [virtual]

Returns the values of the parameters as a vector.

The function is non-const because a derived class may need to create the vector.

Reimplemented in LinearSumFunction.

Definition at line 99 of file FunctionBase.cxx.

References FunctionBase::m_parms.

Referenced by FunctionProjectorXML::createElement(), FuncParmRep::drawProjectedValues(), hippodraw::Python::export_FunctionBase(), FunctionRep::parameters(), FunctionProjector::saveParameters(), and FunctionProjector::setParameters().

bool hasDerivatives (  )  const [virtual]

Returns true if function can calculate its partial derivatives.

This base class implementation returns true. Derived class that can not calculate its partial derivatives should return false. This allows an application to not attempt to use a minimizer that requires derivatives to use this function.

Reimplemented in LogNormal, LogParabola, Novosibirsk, and FunctionWrap.

Definition at line 126 of file FunctionBase.cxx.

void initialize (  )  [protected, virtual]

Initializes the function and parameter names.

The derived classes should initialize their names and the vector of parameter names and then invoke the resize() member function.

Note:
Make this member pure when problem compiling python/FunctionWrap under Windows is solved.

Reimplemented in BrokenPowerLaw, Chi2Dist, ConstantF, Erfc, Exponential, Gaussian, Landau, Linear, LinearSumFunction, LogNormal, LogParabola, Novosibirsk, PowerLaw, Quadratic, Quadratic2, and FunctionWrap.

Definition at line 198 of file FunctionBase.cxx.

void initialParameters ( const FunctionHelper helper  )  [virtual]

Sets the FunctionHelper so that the function can calculate a reasonable set of initial parameter values.

Reimplemented in BrokenPowerLaw, Chi2Dist, ConstantF, Erfc, Exponential, Gaussian, Landau, Linear, LinearSumFunction, LogNormal, LogParabola, Novosibirsk, PowerLaw, Quadratic, Quadratic2, and FunctionWrap.

Definition at line 60 of file FunctionBase.cxx.

Referenced by FunctionProjector::initializeFunction().

double integrate ( double  lower_limit,
double  upper_limit 
) const [virtual]

As of now all the integration is done here numerically using the trapezoidal rule. Derived class may implement an analytical expression in place of this numerical method.

Definition at line 138 of file FunctionBase.cxx.

References FunctionBase::operator()().

bool isComposite (  )  const [virtual]

Returns false.

Derived classes that are a composite of functions should override this member function and return true.

Reimplemented in LinearSumFunction.

Definition at line 161 of file FunctionBase.cxx.

Referenced by FunctionRep::isComposite(), FunctionController::restoreParameters(), and FunctionController::saveParameters().

const string & name (  )  const

Returns the name of the function.

Definition at line 81 of file FunctionBase.cxx.

References FunctionBase::m_name.

Referenced by FunctionProjectorXML::createElement(), FunctionController::createNTuple(), hippodraw::Python::export_FunctionBase(), FunctionController::functionNames(), FunctionProjector::getTitle(), FunctionProjector::getYLabel(), and LinearSumFunction::parmNames().

double operator() ( const std::vector< double > &  v  )  const [virtual]

The function call operator for multi-dimension coordinate variable.

Returns the value of the function at coordinate represented by v. The implementation in this base class uses the first element of the vector and calls operator () ( double ).

Reimplemented in FunctionWrap.

Definition at line 181 of file FunctionBase.cxx.

References FunctionBase::operator()().

double operator() ( double  x  )  const [virtual]

The function call operator.

Bug:
Make this member pure when problem compiling python/FunctionWrap is solved.

Reimplemented in BrokenPowerLaw, Chi2Dist, ConstantF, Erfc, Exponential, Gaussian, Landau, Linear, LinearSumFunction, LogNormal, LogParabola, Novosibirsk, PowerLaw, Quadratic, Quadratic2, and FunctionWrap.

Definition at line 205 of file FunctionBase.cxx.

Referenced by FunctionBase::integrate(), and FunctionBase::operator()().

const vector< string > & parmNames (  )  const [virtual]

Returns a reference to a vector of parameter names.

Reimplemented in LinearSumFunction.

Definition at line 86 of file FunctionBase.cxx.

References FunctionBase::m_parm_names.

Referenced by FuncParmRep::drawProjectedValues(), hippodraw::Python::export_FunctionBase(), and FunctionRep::parmNames().

void removeFromComposite ( FunctionBase  )  [virtual]

Does nothing.

Derived classes that are a composite of functions should override this member function and remove functions from the composite.

Reimplemented in LinearSumFunction.

Definition at line 170 of file FunctionBase.cxx.

void resize (  )  [protected, virtual]

Re-sizes the appropriate vectors maintained in this base class.

Derived classes should call this member function after initializing the m_parm_names data member, as the new size is taken from that data member's size.

Definition at line 71 of file FunctionBase.cxx.

References FunctionBase::m_parm_names, FunctionBase::m_parms, and FunctionBase::size().

Referenced by Quadratic2::initialize(), Quadratic::initialize(), PowerLaw::initialize(), Novosibirsk::initialize(), LogParabola::initialize(), LogNormal::initialize(), Linear::initialize(), Landau::initialize(), Gaussian::initialize(), FunctionWrap::initialize(), Exponential::initialize(), Erfc::initialize(), ConstantF::initialize(), Chi2Dist::initialize(), BrokenPowerLaw::initialize(), FunctionWrap::setParmNames(), and FunctionBase::setParmNames().

void setName ( const char *   )  [protected]

Sets the name of the function.

Definition at line 66 of file FunctionBase.cxx.

References FunctionBase::m_name.

Referenced by FunctionWrap::setName().

vector< double >::const_iterator setParameters ( std::vector< double >::const_iterator  it  )  [virtual]

Sets the parameter values to the value pointed to by the iterator.

Returns an iterator to a data element one past the last used data element.

Reimplemented in LinearSumFunction.

Definition at line 114 of file FunctionBase.cxx.

References FunctionBase::m_parms, and FunctionBase::size().

void setParameters ( const std::vector< double > &  incr  )  [virtual]

Sets the parameter values.

Derived classes should implement this function by invoking incrementValues ( vector< double >::const_iterator ) so that they correctly work with the LinearSumFunction class.

Definition at line 106 of file FunctionBase.cxx.

Referenced by hippodraw::Python::export_FunctionBase(), FunctionProjector::restoreParameters(), FunctionProjectorXML::setAttributes(), and FunctionProjector::setParameters().

void setParmNames ( const std::vector< std::string > &  names  ) 

Sets the names of the parameters.

Reimplemented in FunctionWrap.

Definition at line 93 of file FunctionBase.cxx.

References FunctionBase::m_parm_names, and FunctionBase::resize().

int size (  )  const [virtual]

Returns the number of parameters.

Reimplemented in LinearSumFunction.

Definition at line 156 of file FunctionBase.cxx.

References FunctionBase::m_parm_names.

Referenced by Novosibirsk::initialParameters(), LogParabola::initialParameters(), Gaussian::initialParameters(), FunctionWrap::operator()(), FunctionBase::resize(), FunctionProjectorXML::setAttributes(), and FunctionBase::setParameters().


Member Data Documentation

std::string m_name [protected]

The name of the function.

Definition at line 103 of file FunctionBase.h.

Referenced by FunctionBase::FunctionBase(), Quadratic2::initialize(), Quadratic::initialize(), PowerLaw::initialize(), Novosibirsk::initialize(), LogParabola::initialize(), LogNormal::initialize(), LinearSumFunction::initialize(), Linear::initialize(), Landau::initialize(), Gaussian::initialize(), Exponential::initialize(), Erfc::initialize(), ConstantF::initialize(), Chi2Dist::initialize(), BrokenPowerLaw::initialize(), FunctionBase::name(), and FunctionBase::setName().

std::vector<std::string> m_parm_names [protected]

The names of the function parameters.

Definition at line 106 of file FunctionBase.h.

Referenced by Quadratic2::initialize(), Quadratic::initialize(), PowerLaw::initialize(), Novosibirsk::initialize(), LogParabola::initialize(), LogNormal::initialize(), Linear::initialize(), Landau::initialize(), Gaussian::initialize(), Exponential::initialize(), Erfc::initialize(), ConstantF::initialize(), Chi2Dist::initialize(), BrokenPowerLaw::initialize(), LinearSumFunction::parmNames(), FunctionBase::parmNames(), FunctionBase::resize(), FunctionWrap::setParmNames(), FunctionBase::setParmNames(), and FunctionBase::size().

std::vector< double > m_parms [protected]

The parameter values.

Definition at line 109 of file FunctionBase.h.

Referenced by BrokenPowerLaw::BrokenPowerLaw(), Erfc::calcRed(), Chi2Dist::Chi2Dist(), ConstantF::ConstantF(), Gaussian::derivByMean(), Landau::derivByNorm(), Gaussian::derivByNorm(), Quadratic2::derivByParm(), PowerLaw::derivByParm(), LogParabola::derivByParm(), Exponential::derivByParm(), Erfc::derivByParm(), Chi2Dist::derivByParm(), BrokenPowerLaw::derivByParm(), Landau::derivByPeak(), Landau::derivBySigma(), Gaussian::derivBySigma(), Erfc::Erfc(), Exponential::Exponential(), Gaussian::Gaussian(), LinearSumFunction::getParameters(), FunctionBase::getParameters(), Quadratic2::initialParameters(), Quadratic::initialParameters(), PowerLaw::initialParameters(), Novosibirsk::initialParameters(), LogParabola::initialParameters(), LogNormal::initialParameters(), Linear::initialParameters(), Landau::initialParameters(), Gaussian::initialParameters(), Exponential::initialParameters(), Erfc::initialParameters(), ConstantF::initialParameters(), Chi2Dist::initialParameters(), BrokenPowerLaw::initialParameters(), Landau::Landau(), Linear::Linear(), LogNormal::LogNormal(), LogParabola::LogParabola(), Novosibirsk::Novosibirsk(), Quadratic2::operator()(), Quadratic::operator()(), PowerLaw::operator()(), Novosibirsk::operator()(), LogParabola::operator()(), LogNormal::operator()(), Linear::operator()(), Landau::operator()(), Gaussian::operator()(), Exponential::operator()(), ConstantF::operator()(), Chi2Dist::operator()(), BrokenPowerLaw::operator()(), PowerLaw::PowerLaw(), Quadratic::Quadratic(), Quadratic2::Quadratic2(), FunctionBase::resize(), and FunctionBase::setParameters().


The documentation for this class was generated from the following files:
Generated for HippoDraw Class Library by doxygen