FunctionHelper Class Reference

#include <FunctionHelper.h>

Inheritance diagram for FunctionHelper:

[legend]List of all members.

---

Detailed Description

An abstract base class to help FunctionBase objects perform some operations.

The class helps FunctionBase objects perform some operations that require access to the data set upon which the function will be used. In particular, for a function to estimate its initial parameters, it requires some summary information about the data set, such as the mean value for X or Y.

The use pattern is as follows. The client creates a function via its default constructor, maybe via the FunctionFactory. It then calls initialParameters() with a pointer to a concrete implementation of this class that has access to the data set. The FunctionBase object will then call one or more of the member functions declared by this class to estimate its initial parameters.

All the member functions declared in this class are pure virtual and there are no data member declared.

Author:

Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Definition at line 41 of file FunctionHelper.h.

Public Member Functions
virtual double	getTotal () const =0
	Returns the sum of the values of the data set.
virtual double	maxCoord () const =0
	Returns the largest coordinate value along the X axis in the data set.
virtual double	maxValue () const =0
	Returns the largest value in the data set.
virtual double	meanCoord () const =0
	Returns the mean of the coordinates along a X axis in the data set.
virtual double	meanValue () const =0
	Returns the mean of the values in the data set.
virtual double	minCoord () const =0
	Returns the smallest coordinate value along the X axis in the data set.
virtual double	minValue () const =0
	Returns the smallest value in the data set.
virtual int	size () const =0
	Returns the number of points in the data set.
virtual double	stdCoord () const =0
	Returns the standard deviation of the coordinates along a X axis in the data set.
virtual double	valueAt (double x) const =0
	Returns the value at a given coordinate.
virtual	~FunctionHelper ()
	The virtual destructor.
Protected Member Functions
	FunctionHelper ()
	The default constructor.

---

Constructor & Destructor Documentation

FunctionHelper::FunctionHelper (   )  [inline, protected]

The default constructor. The default constructor is protected to force creation of derived class. Definition at line 47 of file FunctionHelper.h.

virtual FunctionHelper::~FunctionHelper (   )  [inline, virtual]

The virtual destructor. No implementation is needed in this base Derived classes may need to release resources This declaration also keeps some compilers from issuing warnings. Definition at line 54 of file FunctionHelper.h.

---

Member Function Documentation

virtual double FunctionHelper::getTotal (   )  const [pure virtual]

Returns the sum of the values of the data set. Implemented in ProjectorHelper. Referenced by LogNormal::initialParameters(), and Gaussian::initialParameters().

virtual double FunctionHelper::maxCoord (   )  const [pure virtual]

Returns the largest coordinate value along the X axis in the data set. Implemented in ProjectorHelper. Referenced by Quadratic2::initialParameters(), Quadratic::initialParameters(), PowerLaw::initialParameters(), LogNormal::initialParameters(), Linear::initialParameters(), Gaussian::initialParameters(), Exponential::initialParameters(), and BrokenPowerLaw::initialParameters().

virtual double FunctionHelper::maxValue (   )  const [pure virtual]

Returns the largest value in the data set. Implemented in ProjectorHelper. Referenced by Quadratic::initialParameters(), PowerLaw::initialParameters(), Linear::initialParameters(), Landau::initialParameters(), Erfc::initialParameters(), Chi2Dist::initialParameters(), and BrokenPowerLaw::initialParameters().

virtual double FunctionHelper::meanCoord (   )  const [pure virtual]

Returns the mean of the coordinates along a X axis in the data set. Implemented in ProjectorHelper. Referenced by LogNormal::initialParameters(), Landau::initialParameters(), Gaussian::initialParameters(), Erfc::initialParameters(), Chi2Dist::initialParameters(), and BrokenPowerLaw::initialParameters().

virtual double FunctionHelper::meanValue (   )  const [pure virtual]

Returns the mean of the values in the data set. Implemented in ProjectorHelper. Referenced by ConstantF::initialParameters().

virtual double FunctionHelper::minCoord (   )  const [pure virtual]

Returns the smallest coordinate value along the X axis in the data set. Implemented in ProjectorHelper. Referenced by Quadratic2::initialParameters(), Quadratic::initialParameters(), PowerLaw::initialParameters(), LogNormal::initialParameters(), Linear::initialParameters(), Gaussian::initialParameters(), Exponential::initialParameters(), and BrokenPowerLaw::initialParameters().

virtual double FunctionHelper::minValue (   )  const [pure virtual]

Returns the smallest value in the data set. Implemented in ProjectorHelper. Referenced by Quadratic2::initialParameters(), Quadratic::initialParameters(), PowerLaw::initialParameters(), Linear::initialParameters(), and BrokenPowerLaw::initialParameters().

virtual int FunctionHelper::size (   )  const [pure virtual]

Returns the number of points in the data set. Implemented in ProjectorHelper. Referenced by LogNormal::initialParameters(), and Gaussian::initialParameters().

virtual double FunctionHelper::stdCoord (   )  const [pure virtual]

Returns the standard deviation of the coordinates along a X axis in the data set. Implemented in ProjectorHelper. Referenced by LogNormal::initialParameters(), Landau::initialParameters(), and Gaussian::initialParameters().

virtual double FunctionHelper::valueAt (  double  x  )  const [pure virtual]

Returns the value at a given coordinate. Implemented in ProjectorHelper. Referenced by PowerLaw::initialParameters(), Exponential::initialParameters(), and BrokenPowerLaw::initialParameters().

---

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

• FunctionHelper.h

---