jas2.hist

Class Fittable1DFunction

java.lang.Object

java.util.Observable

jas2.hist.Basic1DFunction

jas2.hist.Fittable1DFunction

All Implemented Interfaces:

DataSource, ExtendedStatistics, FunctionData, HasStatistics, Statistics, java.io.Serializable

Direct Known Subclasses:

CubicFunction, ExponentialFunction, FunctionData1DWithType, GaussianFunction, LandauFunction, LorentzianFunction, PolynomialFunction, PowerLawFunction, QuadraticFunction, StraightLineFunction

public abstract class Fittable1DFunction
extends Basic1DFunction
implements ExtendedStatistics

See Also:

Serialized Form

Field Summary

Fields inherited from interface jas2.hist.DataSource

DATE, DELTATIME, DOUBLE, INTEGER, STRING

Constructor Summary

Constructors

Constructor and Description
Fittable1DFunction()

Method Summary

Modifier and Type	Method and Description
void	clearFit()
void	clearFitParams()
double[]	getDerivatives(double x, double[] a) Calculates the partial derivative of the function with respect to each parameter at point x.
java.lang.Object	getExtendedStatistic(java.lang.String name) Returns an object corresponding to the named statistic.
Fitter	getFit()
boolean[]	getIncludeParametersInFit()
double	getStatistic(java.lang.String name)
java.lang.String[]	getStatisticNames()
abstract void	setFit(Fitter fit, double[] param)
void	setIncludeParameterInFit(int index, boolean value)
abstract double	valueAt(double x, double[] param)

Methods inherited from class jas2.hist.Basic1DFunction

getStatistics, setBatch, setChanged, setChanged

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Methods inherited from interface jas2.hist.FunctionData

getParameterNames, getParameterValues, setParameter, valueAt

Methods inherited from interface jas2.hist.DataSource

getTitle

Constructor Detail

Fittable1DFunction

public Fittable1DFunction()

Method Detail

valueAt

public abstract double valueAt(double x,
                               double[] param)
                        throws FunctionValueUndefined

Throws:

FunctionValueUndefined

setFit

public abstract void setFit(Fitter fit,
                            double[] param)
                     throws InvalidFunctionParameter

Throws:

InvalidFunctionParameter

getIncludeParametersInFit

public boolean[] getIncludeParametersInFit()

clearFitParams

public void clearFitParams()

setIncludeParameterInFit

public void setIncludeParameterInFit(int index,
                                     boolean value)

getDerivatives

public double[] getDerivatives(double x,
                               double[] a)
                        throws FunctionValueUndefined

Calculates the partial derivative of the function with respect to each parameter at point x. This is a non-analytical calculation which can be overriden by subclasses which wish to provide an analytical calculation

Throws:

FunctionValueUndefined - if the function is not defined for x

getFit

public Fitter getFit()

clearFit

public void clearFit()

getStatisticNames

public java.lang.String[] getStatisticNames()

Specified by:

getStatisticNames in interface Statistics

Overrides:

getStatisticNames in class Basic1DFunction

Returns:

A list of statistic names

getStatistic

public double getStatistic(java.lang.String name)

Specified by:

getStatistic in interface Statistics

Overrides:

getStatistic in class Basic1DFunction

Returns:

The value for the statistic

getExtendedStatistic

public java.lang.Object getExtendedStatistic(java.lang.String name)

Description copied from interface: ExtendedStatistics

Returns an object corresponding to the named statistic. In general the statistic will be displayed by calling its toString method, however if a Format object has been defined for this class (how?) then it will be used instead. By default the following formatters are defined

java.lang.Double

jas2.util.ScientificFormat

jas2.util.DoubleWithError

jas2.util.ScientificFormat

If the method returns null, then the getStatistic() method from the subclass will be called instead. This simplifies the use of simple floating point statistics (no need to create a Double object for each one).

Specified by:

getExtendedStatistic in interface ExtendedStatistics

Parameters:

name - The name of the statistic to return

See Also:

ScientificFormat, DoubleWithError