jas2.hist.test

Class Gauss

java.lang.Object

java.util.Observable

jas2.hist.test.Gauss

All Implemented Interfaces:

DataSource, HasStatistics, HasStyle, Rebinnable1DHistogramData, HasXMLRepresentation

Direct Known Subclasses:

StringGauss, TimeGauss

public class Gauss
extends java.util.Observable
implements Rebinnable1DHistogramData, HasStyle, HasStatistics, HasXMLRepresentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Gauss.PaulStatistics

Field Summary

Fields inherited from interface jas2.hist.DataSource

DATE, DELTATIME, DOUBLE, INTEGER, STRING

Constructor Summary

Constructors

Constructor and Description
Gauss()
Gauss(java.lang.String name, int entries, double max, double offX, double offY)

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAxisLabels() Returns the axis labels.
int	getAxisType() Returns one of DOUBLE,INTEGER,STRING,DATE or DELTATIME
int	getBins() Returns the (suggested) number of bins to use
double	getData(int i)
double	getMax() Returns the (suggested) maximum value for the X axis
double	getMin() Returns the (suggested) minimum value for the X axis
int	getSize()
Statistics	getStatistics()
JASHistStyle	getStyle() This method is called by the plot to determine what style to be used for a plot.
java.lang.String	getTitle() Return the caption to be used in the legend for this data.
boolean	isRebinnable() Returns true if the data source is capable of recalculating the bin contents, or false of the interface is not-capable of recalculating the bin contents.
double[][]	rebin(int bins, double min, double max, boolean wantErrors, boolean hurry) Called to request the binned data be returned.
void	setSize(int newSize)
void	setStats()
void	setStyle(JASHist1DHistogramStyle style)
void	writeAsXML(XMLWriter pw)

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

Gauss

public Gauss()

Gauss

public Gauss(java.lang.String name,
             int entries,
             double max,
             double offX,
             double offY)

Method Detail

writeAsXML

public void writeAsXML(XMLWriter pw)

Specified by:

writeAsXML in interface HasXMLRepresentation

setStyle

public void setStyle(JASHist1DHistogramStyle style)

getStyle

public JASHistStyle getStyle()

Description copied from interface: HasStyle

This method is called by the plot to determine what style to be used for a plot. It is the programmers responsibility to return the correct subclass of JASHistStyle corresponding to the type of data being implemented by the DataSource.

Specified by:

getStyle in interface HasStyle

Returns:

The style to be used, or null to use the default style.

See Also:

JASHist1DHistogramStyle, JASHist2DHistogramStyle, JASHistScatterPlotStyle

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

getMin

public double getMin()

Description copied from interface: Rebinnable1DHistogramData

Returns the (suggested) minimum value for the X axis

Specified by:

getMin in interface Rebinnable1DHistogramData

getMax

public double getMax()

Description copied from interface: Rebinnable1DHistogramData

Returns the (suggested) maximum value for the X axis

Specified by:

getMax in interface Rebinnable1DHistogramData

isRebinnable

public boolean isRebinnable()

Description copied from interface: Rebinnable1DHistogramData

Returns true if the data source is capable of recalculating the bin contents, or false of the interface is not-capable of recalculating the bin contents. In the former case the values returned by getMin, getMax and getBins are just taken to be suggestions, in the latter case they are taken to be fixed in stone.

Specified by:

isRebinnable in interface Rebinnable1DHistogramData

Returns:

True if the datasource is rebinnable

getAxisLabels

public java.lang.String[] getAxisLabels()

Description copied from interface: Rebinnable1DHistogramData

Returns the axis labels. Only relevant if the axisType is STRING, otherwise can return null

Specified by:

getAxisLabels in interface Rebinnable1DHistogramData

Returns:

An array of bin labels to use on the X axis

getBins

public int getBins()

Description copied from interface: Rebinnable1DHistogramData

Returns the (suggested) number of bins to use

Specified by:

getBins in interface Rebinnable1DHistogramData

getAxisType

public int getAxisType()

Description copied from interface: Rebinnable1DHistogramData

Returns one of DOUBLE,INTEGER,STRING,DATE or DELTATIME

Specified by:

getAxisType in interface Rebinnable1DHistogramData

rebin

public double[][] rebin(int bins,
                        double min,
                        double max,
                        boolean wantErrors,
                        boolean hurry)

Description copied from interface: Rebinnable1DHistogramData

Called to request the binned data be returned. If the DataSource indicated it was not rebinnable then the bins, min and max arguments are guaranteed to be the same values as returned by getMin(), getMax() and getBins() methods.

The routine returns a two dimensional array where the first dimension has the following meaning:

• [0] An array of data points (one entry per bin)
• [1] An array of plus errors (one entry per bin)
• [2] An array of minus errors (one entry per bin)

If the minus error is absent the errors are assumed to be symmetric, if the plus error is also absent the errors are assumed to be the square root of the data.

Specified by:

rebin in interface Rebinnable1DHistogramData

min - The min of the range over which to bin

max - The max of the range over which to bin

wantErrors - If false indicates that the errors are not required and need not be calculated (most implementations will ignore this parameter)

hurry - If true indicates the results should be provided as fast as possible, even if some approximation is needed (most implementations will ignore this parameter)

Returns:

An array representing the binned data and errors (see description above)

getSize

public int getSize()

setSize

public void setSize(int newSize)

getData

public double getData(int i)

getStatistics

public Statistics getStatistics()

Specified by:

getStatistics in interface HasStatistics

setStats

public void setStats()