de.gsi.dataset.spi

Class DoubleErrorDataSet

java.lang.Object

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

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

de.gsi.dataset.spi.AbstractErrorDataSet<DoubleErrorDataSet>

de.gsi.dataset.spi.DoubleErrorDataSet

All Implemented Interfaces:

DataSet, DataSetError, DataSetMetaData, EventSource

public class DoubleErrorDataSet
extends AbstractErrorDataSet<DoubleErrorDataSet>
implements DataSetError

Implementation of the DataSetError interface which stores x,y, +eyn, -eyn values in separate double arrays. It provides methods allowing easily manipulate of data points.
User provides X and Y coordinates or only Y coordinates. In the former case X coordinates have value of data point index. This version being optimised for native double arrays.

Author:

rstein

See Also:

for an equivalent implementation without errors

Nested Class Summary

Nested classes/interfaces inherited from interface de.gsi.dataset.DataSetError

DataSetError.ErrorType

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Integer,String>	dataLabels
protected int	dataMaxIndex
protected Map<Integer,String>	dataStyles
protected double[]	xValues
protected double[]	yErrorsNeg
protected double[]	yErrorsPos
protected double[]	yValues

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

lock, name, updateListeners, xRange, yRange

Fields inherited from interface de.gsi.dataset.DataSetMetaData

TAG_GAIN_RANGE, TAG_OVERSHOOT, TAG_UNDERSHOOT

Constructor Summary

Constructors

Constructor and Description
DoubleErrorDataSet(String name) Creates a new instance of DoubleErrorDataSet.
DoubleErrorDataSet(String name, double[] yValues) Creates a new instance of DoubleErrorDataSet.
DoubleErrorDataSet(String name, double[] xValues, double[] yValues) Creates a new instance of DoubleErrorDataSet.
DoubleErrorDataSet(String name, double[] xValues, double[] yValues, double[] yErrorsNeg, double[] yErrorsPos, int nData) Creates a new instance of DoubleErrorDataSet.
DoubleErrorDataSet(String name, double[] xValues, double[] yValues, int nData) Creates a new instance of DoubleErrorDataSet.
DoubleErrorDataSet(String name, double[] yValues, int nData) Creates a new instance of DoubleErrorDataSet.
DoubleErrorDataSet(String name, int initalSize) Creates a new instance of DoubleErrorDataSet.

Method Summary

Modifier and Type	Method and Description
DoubleErrorDataSet	add(double[] xValues, double[] yValues, double[] yErrorsNeg, double[] yErrorsPos) Initialises the data set with specified data.
DoubleErrorDataSet	add(double x, double y, double yErrorNeg, double yErrorPos) Add point to the DoublePoints object
String	addDataLabel(int index, String label) adds a custom new data label for a point The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.
String	addDataStyle(int index, String style) A string representation of the CSS style associated with this specific DataSet data point.
DoubleErrorDataSet	clearData() clears all data
int	getDataCount() Get the number of data points in the data set
String	getDataLabel(int index) Returns label of a data point specified by the index.
Map<Integer,String>	getDataLabelMap()
Map<Integer,String>	getDataStyleMap()
String	getStyle(int index) A string representation of the CSS style associated with this specific DataSet data point.
double	getX(int index) Gets the x value of the data point with the index i
double	getXErrorNegative(int index) Returns the negative error along the X axis of a point specified by the index.
double	getXErrorPositive(int index) Returns the positive error along the X axis of a point specified by the index.
double[]	getXValues()
double	getY(int index) Gets the y value of the data point with the index i
double	getYErrorNegative(int index) Returns the negative error along the Y axis of a point specified by the index.
double	getYErrorPositive(int index) Returns the positive error along the Y axis of a point specified by the index.
double[]	getYErrorsNegative() Returns the negative error along the Y axis for all available data points.
double[]	getYErrorsPositive() Returns the positive error along the y axis for all available data points.
double[]	getYValues()
DoubleErrorDataSet	remove(int fromIndex, int toIndex) remove sub-range of data points
String	removeDataLabel(int index) remove a custom data label for a point The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.
String	removeStyle(int index) A string representation of the CSS style associated with this specific DataSet data point.
DoubleErrorDataSet	set(DataSet other) replace/overwrite data points with those from another data set
DoubleErrorDataSet	set(DataSet other, boolean copy) replace/overwrite data points with those from another data set
DoubleErrorDataSet	set(double[] xValues, double[] yValues, double[] yErrorsNeg, double[] yErrorsPos) Initialises the data set with specified data.
DoubleErrorDataSet	set(double[] xValues, double[] yValues, double[] yErrorsNeg, double[] yErrorsPos, boolean copy) Initialises the data set with specified data.
DoubleErrorDataSet	set(int index, double x, double y, double yErrorNeg, double yErrorPos) replaces point coordinate of existing data point

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

computeLimits, getErrorType, getThis, setErrorType

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

binarySearchX, binarySearchY, fireInvalidated, getDataCount, getErrorList, getInfoList, getMetaInfo, getName, getUndefValue, getWarningList, getXIndex, getXMax, getXMin, getXRange, getYIndex, getYMax, getYMin, getYRange, isAutoNotification, lock, minNeigbourSearchX, setAutoNotifaction, setName, toString, unlock, updateEventListener

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

getStyle, setStyle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.gsi.dataset.DataSetError

getErrorType, getXErrorNegative, getXErrorPositive, getXErrorsNegative, getXErrorsPositive, getYErrorNegative, getYErrorPositive

Methods inherited from interface de.gsi.dataset.DataSet

getDataCount, getName, getStyle, getUndefValue, getValue, getXIndex, getXMax, getXMin, getYIndex, getYMax, getYMin, isAutoNotification, lock, setAutoNotifaction, setStyle, unlock

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

addListener, invokeListener, invokeListener, removeListener, updateEventListener

Field Detail

dataLabels

protected Map<Integer,String> dataLabels

dataStyles

protected Map<Integer,String> dataStyles

xValues

protected double[] xValues

yValues

protected double[] yValues

yErrorsPos

protected double[] yErrorsPos

yErrorsNeg

protected double[] yErrorsNeg

dataMaxIndex

protected int dataMaxIndex

Constructor Detail

DoubleErrorDataSet

public DoubleErrorDataSet(String name)

Creates a new instance of DoubleErrorDataSet.

Parameters:

name - name of this DataSet.

Throws:

IllegalArgumentException - if name is null

DoubleErrorDataSet

public DoubleErrorDataSet(String name,
                          int initalSize)

Creates a new instance of DoubleErrorDataSet.

Parameters:

name - name of this DataSet.

initalSize - maximum capacity of buffer

Throws:

IllegalArgumentException - if name is null

DoubleErrorDataSet

public DoubleErrorDataSet(String name,
                          double[] yValues,
                          int nData)

Creates a new instance of DoubleErrorDataSet. X coordinates are equal to data points indices.

Parameters:

name - name of this data set.

yValues - Y coordinates

nData - how many data points are relevant to be taken

Throws:

IllegalArgumentException - if any of parameters is null

DoubleErrorDataSet

public DoubleErrorDataSet(String name,
                          double[] yValues)

Creates a new instance of DoubleErrorDataSet. X coordinates are equal to data points indices.

Parameters:

name - name of this data set.

yValues - Y coordinates

Throws:

IllegalArgumentException - if any of parameters is null

DoubleErrorDataSet

public DoubleErrorDataSet(String name,
                          double[] xValues,
                          double[] yValues,
                          int nData)

Creates a new instance of DoubleErrorDataSet. X coordinates are equal to data points indices.

Parameters:

name - name of this data set.

xValues - x coordinates

yValues - Y coordinates

nData - how many data points are relevant to be taken

Throws:

IllegalArgumentException - if any of parameters is null

DoubleErrorDataSet

public DoubleErrorDataSet(String name,
                          double[] xValues,
                          double[] yValues)

Creates a new instance of DoubleErrorDataSet. X coordinates are equal to data points indices.

Parameters:

name - name of this data set.

xValues - x coordinates

yValues - Y coordinates

Throws:

IllegalArgumentException - if any of parameters is null

DoubleErrorDataSet

public DoubleErrorDataSet(String name,
                          double[] xValues,
                          double[] yValues,
                          double[] yErrorsNeg,
                          double[] yErrorsPos,
                          int nData)

Creates a new instance of DoubleErrorDataSet.

Parameters:

name - name of this data set.

xValues - X coordinates

yValues - Y coordinates

yErrorsNeg - Y negative coordinate error

yErrorsPos - Y positive coordinate error

nData - how many data points are relevant to be taken

Throws:

IllegalArgumentException - if any of parameters is null or if arrays with coordinates have different lengths

Method Detail

getDataLabelMap

public Map<Integer,String> getDataLabelMap()

Returns:

data label map for given data point

getDataStyleMap

public Map<Integer,String> getDataStyleMap()

Returns:

data style map (CSS-styling)

getXValues

public double[] getXValues()

Specified by:

getXValues in interface DataSet

Returns:

the x value array

getYValues

public double[] getYValues()

Specified by:

getYValues in interface DataSet

Returns:

the y value array

getYErrorsPositive

public double[] getYErrorsPositive()

Description copied from interface: DataSetError

Returns the positive error along the y axis for all available data points. Please note that errors are assumed to be always positive!

Specified by:

getYErrorsPositive in interface DataSetError

Returns:

array containing positive y error

getYErrorsNegative

public double[] getYErrorsNegative()

Description copied from interface: DataSetError

Returns the negative error along the Y axis for all available data points. Please note that errors are assumed to be always positive!

Specified by:

getYErrorsNegative in interface DataSetError

Returns:

array containing negative Y error

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

clearData

public DoubleErrorDataSet clearData()

clears all data

Returns:

itself (fluent design)

getX

public double getX(int index)

Description copied from interface: DataSet

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

Specified by:

getX in interface DataSet

Parameters:

index - the index of the data point

Returns:

the x value

getY

public double getY(int index)

Description copied from interface: DataSet

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

Specified by:

getY in interface DataSet

Parameters:

index - the index of the data point

Returns:

the y value

getXErrorNegative

public double getXErrorNegative(int index)

Description copied from interface: DataSetError

Returns the negative error along the X axis of a point specified by the index. Please note that errors are assumed to be always positive!

Specified by:

getXErrorNegative in interface DataSetError

Parameters:

index - of negative X error to be returned.

Returns:

negative X error

getXErrorPositive

public double getXErrorPositive(int index)

Description copied from interface: DataSetError

Returns the positive error along the X axis of a point specified by the index. Please note that errors are assumed to be always positive!

Specified by:

getXErrorPositive in interface DataSetError

Parameters:

index - of positive X error to be returned.

Returns:

positive X error

getYErrorNegative

public double getYErrorNegative(int index)

Description copied from interface: DataSetError

Returns the negative error along the Y axis of a point specified by the index. Please note that errors are assumed to be always positive!

Specified by:

getYErrorNegative in interface DataSetError

Parameters:

index - of negative Y error to be returned.

Returns:

negative Y error

getYErrorPositive

public double getYErrorPositive(int index)

Description copied from interface: DataSetError

Returns the positive error along the Y axis of a point specified by the index. Please note that errors are assumed to be always positive!

Specified by:

getYErrorPositive in interface DataSetError

Parameters:

index - of positive Y error to be returned.

Returns:

positive Y error

set

public DoubleErrorDataSet set(int index,
                              double x,
                              double y,
                              double yErrorNeg,
                              double yErrorPos)

replaces point coordinate of existing data point

Parameters:

index - the index of the data point

x - new horizontal coordinate

y - new vertical coordinate

yErrorNeg - new vertical negative error of y (can be asymmetric)

yErrorPos - new vertical positive error of y (can be asymmetric)

Returns:

itself (fluent design)

add

public DoubleErrorDataSet add(double x,
                              double y,
                              double yErrorNeg,
                              double yErrorPos)

Add point to the DoublePoints object

Parameters:

x - the new x coordinate

y - the new y coordinate

yErrorNeg - the +dy error

yErrorPos - the -dy error

Returns:

itself

remove

public DoubleErrorDataSet remove(int fromIndex,
                                 int toIndex)

remove sub-range of data points

Parameters:

fromIndex - start index

toIndex - stop index

Returns:

itself (fluent design)

add

public DoubleErrorDataSet add(double[] xValues,
                              double[] yValues,
                              double[] yErrorsNeg,
                              double[] yErrorsPos)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValues - X coordinates

yValues - Y coordinates

yErrorsNeg - the +dy errors

yErrorsPos - the -dy errors

Returns:

itself (fluent design)

set

public DoubleErrorDataSet set(double[] xValues,
                              double[] yValues,
                              double[] yErrorsNeg,
                              double[] yErrorsPos,
                              boolean copy)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValues - X coordinates

yValues - Y coordinates

yErrorsNeg - the +dy errors

yErrorsPos - the -dy errors

copy - true: makes an internal copy, false: use the pointer as is (saves memory allocation)

Returns:

itself (fluent design)

set

public DoubleErrorDataSet set(double[] xValues,
                              double[] yValues,
                              double[] yErrorsNeg,
                              double[] yErrorsPos)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValues - X coordinates

yValues - Y coordinates

yErrorsNeg - the +dy errors

yErrorsPos - the -dy errors

Returns:

itself (fluent design)

set

public DoubleErrorDataSet set(DataSet other)

replace/overwrite data points with those from another data set

Parameters:

other - the other data set

Returns:

itself (fluent design)

set

public DoubleErrorDataSet set(DataSet other,
                              boolean copy)

replace/overwrite data points with those from another data set

Parameters:

other - the other data set

copy - true: makes an internal copy, false: use the pointer as is (saves memory allocation)

Returns:

itself (fluent design)

addDataLabel

public String addDataLabel(int index,
                           String label)

adds a custom new data label for a point The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.

Parameters:

index - of the data point

label - for the data point specified by the index

Returns:

the previously set label or null if no label has been specified

removeDataLabel

public String removeDataLabel(int index)

remove a custom data label for a point The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.

Parameters:

index - of the data point

Returns:

the previously set label or null if no label has been specified

getDataLabel

public String getDataLabel(int index)

Returns label of a data point specified by the index. The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.

Specified by:

getDataLabel in interface DataSet

Overrides:

getDataLabel in class AbstractDataSet<DoubleErrorDataSet>

Parameters:

index - of the data label

Returns:

data point label specified by the index or null if no label has been specified

addDataStyle

public String addDataStyle(int index,
                           String style)

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

Parameters:

index - the index of the specific data point

style - of data point (CSS-styling)

Returns:

itself (fluent interface)

removeStyle

public String removeStyle(int index)

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

Parameters:

index - the index of the specific data point

Returns:

itself (fluent interface)

getStyle

public String getStyle(int index)

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

Specified by:

getStyle in interface DataSet

Parameters:

index - the index of the specific data point

Returns:

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