DOpolyfitter.h

Classes

polyfitter -- The C++ side of the glish polyfitter tool. (full description)

class polyfitter : public ApplicationObject

Interface

Public Members

polyfitter()

polyfitter(const polyfitter &other)

polyfitter& operator=(const polyfitter &other)

virtual ~polyfitter()

Bool fit(Vector<Double>& coeff, Vector<Double>& coefferrs, Double& chisq, const Vector<Double>& x, const Vector<Double>& y, const Vector<Double>& sigma, Int order)

Bool multifit(Array<Double>& coeff, Array<Double>& coefferrs, Vector<Double>& chisq, const Vector<Double>& x, const Array<Double>& y, const Array<Double>& sigma, Int order)

Bool eval(Array<Double>& y, const Vector<Double>& x, const Array<Double>& coeff)

virtual String className() const

virtual Vector<String> methods() const

virtual Vector<String> noTraceMethods() const

virtual MethodResult runMethod(uInt which, ParameterSet &inputRecord, Bool runmethod)

Description

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

The Arrays module
The glish polyfitter tool

Etymology

The name MUST have the 'DO' prefix as this class is derived from ApplicationObject, and hence is classified as a distributed object. For the same reason the rest of its name must be in lower case. This class fits polynomials.

Synopsis

Example

Motivation

Thrown Exceptions

To Do

add this feature
fix this bug
start discussion of this possible extension

Member Description

polyfitter()

polyfitter(const polyfitter &other)

polyfitter& operator=(const polyfitter &other)

virtual ~polyfitter()

Bool fit(Vector<Double>& coeff, Vector<Double>& coefferrs, Double& chisq, const Vector<Double>& x, const Vector<Double>& y, const Vector<Double>& sigma, Int order)

the actual implementation of the virtual functions

Bool multifit(Array<Double>& coeff, Array<Double>& coefferrs, Vector<Double>& chisq, const Vector<Double>& x, const Array<Double>& y, const Array<Double>& sigma, Int order)

Bool eval(Array<Double>& y, const Vector<Double>& x, const Array<Double>& coeff)

virtual String className() const

Return the name of this object type. Always returns "polyfitter". This function is required as part of the DO system.

virtual Vector<String> methods() const

The returned vector contains the names of all of the methods which may be used via the distributed object system. This function is required as part of the DO system.

virtual Vector<String> noTraceMethods() const

the returned vector contains the names of all the methods which are too trivial to warrent automatic logging. Currently no functions are logged. This function is required as part of the DO system.

virtual MethodResult runMethod(uInt which, ParameterSet &inputRecord, Bool runmethod)

Run the specified method. This is the function used by the distributed object system to invoke any of the specified member functions in thi s class.