Package de.gsi.dataset.spi

Class AveragingDataSet

java.lang.Object

de.gsi.dataset.spi.AbstractStylable<D>

de.gsi.dataset.spi.AbstractDataSet<AveragingDataSet>

de.gsi.dataset.spi.AveragingDataSet

All Implemented Interfaces:

DataSet, DataSetMetaData, EventSource, java.io.Serializable

public class AveragingDataSet
extends AbstractDataSet<AveragingDataSet>
implements DataSet

TODO: Change to ErrorDataSet and calculate standard deviation.

Author:

braeun

See Also:

Serialized Form

Field Summary

Fields inherited from class de.gsi.dataset.spi.AbstractDataSet

axisListener, dimension

Fields inherited from interface de.gsi.dataset.DataSet

DIM_X, DIM_Y, DIM_Z

Fields inherited from interface de.gsi.dataset.DataSetMetaData

TAG_GAIN_RANGE, TAG_OVERSHOOT, TAG_UNDERSHOOT

Constructor Summary

Constructors

Constructor	Description
AveragingDataSet(java.lang.String name, int nDims)
AveragingDataSet(java.lang.String name, int nDims, int fuzzyCount)

Method Summary

Modifier and Type	Method	Description
void	add(DataSet ds)
void	clear()	clear all data
double	get(int dimIndex, int index)	Gets the x value of the data point with the index i
int	getAverageCount()
int	getAverageSize()
int	getDataCount()	Get the number of data points in the data set.
int	getFuzzyCount()	Gets the fuzzy count.
java.lang.String	getStyle(int index)	A string representation of the CSS style associated with this specific DataSet data point.
double	getValue(int dimIndex, double... x)	Returns the value along the 'dimIndex' axis of a point specified by the x coordinate.
DataSet	set(DataSet other, boolean copy)
void	setAverageSize(int avgCount)
void	setFuzzyCount(int fuzzyCount)	Sets the fuzzy count.

Methods inherited from class de.gsi.dataset.spi.AbstractDataSet

addDataLabel, addDataStyle, autoNotification, binarySearch, binarySearch, clearMetaInfo, copyAxisDescription, copyDataLabelsAndStyles, copyMetaData, equalDataLabels, equalEditConstraints, equalErrorValues, equalMetaData, equals, equals, equalValues, fireInvalidated, getAxisDescriptions, getDataLabel, getDataLabelMap, getDataStyleMap, getDimension, getEditConstraints, getErrorList, getIndex, getInfoList, getMetaInfo, getName, getThis, getValues, getWarningList, hashCode, lock, recomputeLimits, removeDataLabel, removeStyle, setEditConstraints, setName, toString, updateEventListener

Methods inherited from class de.gsi.dataset.spi.AbstractStylable

getStyle, setStyle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.gsi.dataset.DataSet

getAxisDescription, getAxisDescriptions, getDataLabel, getDimension, getIndex, getName, getStyle, getValues, lock, recomputeLimits, set, setStyle

Methods inherited from interface de.gsi.dataset.event.EventSource

addListener, autoNotification, invokeListener, invokeListener, invokeListener, isAutoNotification, removeListener, updateEventListener

Constructor Detail

AveragingDataSet

public AveragingDataSet(java.lang.String name,
                        int nDims)

Parameters:

name - data set name

nDims - number of dimensions

AveragingDataSet

public AveragingDataSet(java.lang.String name,
                        int nDims,
                        int fuzzyCount)

Parameters:

name - data set name

nDims - number of dimensions

fuzzyCount - binning accuracy @see #setFuzzyCount

Method Detail

add

public void add(DataSet ds)

Parameters:

ds - new DataSet to be added to average

clear

public void clear()

clear all data

getAverageCount

public int getAverageCount()

Returns:

number of data sets that have been averaged

getAverageSize

public int getAverageSize()

Returns:

number of data sets that are supposed to be averaged

getDataCount

public int getDataCount()

Description copied from interface: DataSet

Get the number of data points in the data set.

Specified by:

getDataCount in interface DataSet

Returns:

the number of data points

getFuzzyCount

public int getFuzzyCount()

Gets the fuzzy count.

Returns:

fuzzy count

getStyle

public java.lang.String getStyle(int index)

Description copied from class: AbstractDataSet

A string representation of the CSS style associated with this specific DataSet data point. @see #getStyle()

Specified by:

getStyle in interface DataSet

Overrides:

getStyle in class AbstractDataSet<AveragingDataSet>

Parameters:

index - the index of the specific data point

Returns:

user-specific data set style description (ie. may be set by user)

get

public final double get(int dimIndex,
                        int index)

Description copied from interface: DataSet

Gets the x value of the data point with the index i

Specified by:

get in interface DataSet

Parameters:

dimIndex - the dimension index (ie. '0' equals 'X', '1' equals 'Y')

index - data point index

Returns:

the x value

setAverageSize

public void setAverageSize(int avgCount)

Parameters:

avgCount - number of data sets that are supposed to be averaged

setFuzzyCount

public void setFuzzyCount(int fuzzyCount)

Sets the fuzzy count. The fuzzy count allows for a mismatch in the data count of the datasets added to the average. Datasets will be added if the size difference is less or equal to the fuzzy count. In case of a mismatch in size, the longer dataset will be truncated to the shorter one.

Parameters:

fuzzyCount - the fuzzy count

getValue

public double getValue(int dimIndex,
                       double... x)

Description copied from interface: DataSet

Returns the value along the 'dimIndex' axis of a point specified by the x coordinate.

Specified by:

getValue in interface DataSet

Overrides:

getValue in class AbstractDataSet<AveragingDataSet>

Parameters:

dimIndex - the dimension index (ie. '0' equals 'X', '1' equals 'Y')

x - horizontal 'dimIndex' coordinate

Returns:

'dimIndex' value

set

public DataSet set(DataSet other,
                   boolean copy)

Specified by:

set in interface DataSet

Parameters:

other - Other DataSet to copy into this DataSet

copy - true: perform a deep copy (default), false: reuse the other dataset's internal data structures (if applicable)

Returns:

itself (fluent design) -- N.B. existing update listener are preserved