DOsinusoidfitter.h

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 sinusoids

Synopsis

Example

Motivation

Thrown Exceptions

To Do

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

Member Description

enum Methods

sinusoidfitter()

sinusoidfitter(const sinusoidfitter &other)

sinusoidfitter& operator=(const sinusoidfitter &other)

virtual ~sinusoidfitter()

Bool fit(GlishRecord& state, const Vector<Double>& x, const Vector<Double>& y, const Vector<Double>& sigma)

Fit a sinusoid to y given x If sigma has the same number of elements, it is used in the fit, otherwise sigma==1 is assumed. The state argument will contain the state of the fitter after the fit happens. It is not used on input to set the state before the fit begins. Use the setstate() member for that.

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

there is no savings by doing multiple fits in a single pass since there is no setup costs which might be amortized over several fits. However, there may be some advantage in sending over several y vectors to be fit to the same x vector from glish in one event. Its probably worth pondering that for the future.

evaluate the function at x, placing the result in y.

Bool getstate(GlishRecord& state)

Bool setstate(const GlishRecord& state)

virtual String className() const

Return the name of this object type. Always returns "sinusoiditter". 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.