joptima

Class Fitter

java.lang.Object

joptima.Fitter

All Implemented Interfaces:

Function, Minimizable

Direct Known Subclasses:

ChiSquaredFitter, ChiSquaredFitter2D

public abstract class Fitter
extends java.lang.Object
implements Minimizable, Function

An abstract fitter.

Extensions of this class typically need to do the following:

• provide the appropriate setData() methods or some other way of handling the measured data points;
• override the addFunction() method if fitting children of Function or something entirely different;
• implement the Minimizable.calculate() method to calculate the value of the appropriate likelihood function, given the data points and the set of Functions.

Constructor Summary

Constructors

Constructor and Description
Fitter()

Method Summary

Modifier and Type	Method and Description
void	addFunction(Function f) Adds a Function to this Fitter.
double	calculate(double x) Returns the value of the sum of functions at the given point.
java.lang.String	getName() Returns a function name for this fitter.
Parameter[]	getParameters() Creates a list of all the Function parameters for this Fitter.
void	removeAllFunctions() Removes all Functions from this Fitter.
void	setName(java.lang.String newname) Sets the function name for this fitter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface joptima.Minimizable

calculate

Constructor Detail

Fitter

public Fitter()

Method Detail

addFunction

public void addFunction(Function f)

Adds a Function to this Fitter.

removeAllFunctions

public void removeAllFunctions()

Removes all Functions from this Fitter. The Fitter may then be reused with existing data.

calculate

public double calculate(double x)

Returns the value of the sum of functions at the given point. Useful for plotting the fitted function after the fit converges.

Specified by:

calculate in interface Function

Parameters:

x - the x coordinate to calculate the function at

Returns:

the value of the function at the given coordinate

getName

public java.lang.String getName()

Returns a function name for this fitter. By default the name is created from the names of all functions. If setName() was called, that is returned instead.

Specified by:

getName in interface Function

Returns:

the name of the function

setName

public void setName(java.lang.String newname)

Sets the function name for this fitter.

Specified by:

setName in interface Function

Parameters:

newname - the new name for the function

getParameters

public Parameter[] getParameters()

Creates a list of all the Function parameters for this Fitter. This method retrieves the parameters lists from individual Functions and copies them into a single array to pass to a Minimizer.

Specified by:

getParameters in interface Function

Specified by:

getParameters in interface Minimizable

Returns:

a Parameter[] of delegates that access the proper member variables.