jasext.hist.function

Class LorentzianFunction

java.lang.Object

java.util.Observable

jas2.hist.Basic1DFunction

jas2.hist.Fittable1DFunction

jasext.hist.function.LorentzianFunction

All Implemented Interfaces:

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

public class LorentzianFunction
extends Fittable1DFunction
implements HasHandles

Fittable Lorentzian function with handles: y(x) = A*(g/2)^2/((x-x0)^2+(g/2)^2) A = maximum value of the function x0 = origin, corresponding to the maximum value of y(x) g = width Also known as a Breit-Wigner distribution in nuclear physics. The initial function shape will be based on the current maximum and minimum axis values (not the data). Handles: There are three handles. Handle 1: Changes the function amplitude and origin. The handle position corresponds to the current amplitude and origin values. Handles 2,3: Change the function width. The handle y position is the function value at half amplitude. The x position is offset from the function origin by +/- the half width.

See Also:

Serialized Form

Field Summary

Fields inherited from interface jas2.hist.DataSource

DATE, DELTATIME, DOUBLE, INTEGER, STRING

Constructor Summary

Constructors

Constructor and Description
LorentzianFunction(double xmin, double xmax, double ymin, double ymax)

Method Summary

Modifier and Type	Method and Description
Handle[]	getHandles(double xLow, double xHigh, double yLow, double yHigh)
java.lang.String[]	getParameterNames()
double[]	getParameterValues()
java.lang.String	getTitle() Return the caption to be used in the legend for this data.
void	setFit(Fitter fit, double[] value)
void	setParameter(int index, double value)
double	valueAt(double x)
double	valueAt(double x, double[] a)

Methods inherited from class jas2.hist.Fittable1DFunction

clearFit, clearFitParams, getDerivatives, getExtendedStatistic, getFit, getIncludeParametersInFit, getStatistic, getStatisticNames, setIncludeParameterInFit

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

Constructor Detail

LorentzianFunction

public LorentzianFunction(double xmin,
                          double xmax,
                          double ymin,
                          double ymax)

Method Detail

valueAt

public double valueAt(double x)

Specified by:

valueAt in interface FunctionData

valueAt

public double valueAt(double x,
                      double[] a)

Specified by:

valueAt in class Fittable1DFunction

getParameterNames

public java.lang.String[] getParameterNames()

Specified by:

getParameterNames in interface FunctionData

getParameterValues

public double[] getParameterValues()

Specified by:

getParameterValues in interface FunctionData

setParameter

public void setParameter(int index,
                         double value)

Specified by:

setParameter in interface FunctionData

setFit

public void setFit(Fitter fit,
                   double[] value)

Specified by:

setFit in class Fittable1DFunction

getTitle

public java.lang.String getTitle()

Description copied from interface: DataSource

Return the caption to be used in the legend for this data.

Specified by:

getTitle in interface DataSource

getHandles

public Handle[] getHandles(double xLow,
                           double xHigh,
                           double yLow,
                           double yHigh)

Specified by:

getHandles in interface HasHandles