Package de.gsi.dataset

Interface DataSetError

All Superinterfaces:

DataSet, EventSource

All Known Implementing Classes:

AbstractErrorDataSet, AbstractTestFunction, CircularDoubleErrorDataSet, CosineFunction, DefaultErrorDataSet, DoubleErrorDataSet, FifoDoubleErrorDataSet, GaussFunction, LimitedIndexedTreeDataSet, ListErrorDataSet, RandomStepFunction, RandomWalkFunction, SincFunction, SineFunction, SingleOutlierFunction

public interface DataSetError
extends DataSet

The DataSetError is a basic interface that specifies all methods needed to read and modify data point error. This interface is kept most general. However, derived classes may have dummy implementation for error types that are not relevant. For plotting speed improvement this simplification can/should be indicated via the

Author:

rstein

See Also:

interface for error type details

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DataSetError.ErrorType

Method Summary

Modifier and Type	Method	Description
DataSetError.ErrorType	getErrorType()	Returns the given error type that may be used to drive given simplifications and optimisation in derived classes.
default double	getXErrorNegative(double x)	Returns the negative error along the X axis of a point specified by the x coordinate.
double	getXErrorNegative(int index)	Returns the negative error along the X axis of a point specified by the index.
default double	getXErrorPositive(double x)	Returns the positive error along the X axis of a point specified by the x coordinate.
double	getXErrorPositive(int index)	Returns the positive error along the X axis of a point specified by the index.
default double[]	getXErrorsNegative()	Returns the negative error along the X axis for all available data points.
default double[]	getXErrorsPositive()	Returns the positive error along the X axis for all available data points.
default double	getYErrorNegative(double x)	Returns the negative error along the Y axis of a point specified by the x coordinate.
double	getYErrorNegative(int index)	Returns the negative error along the Y axis of a point specified by the index.
default double	getYErrorPositive(double x)	Returns the positive error along the Y axis of a point specified by the x coordinate.
double	getYErrorPositive(int index)	Returns the positive error along the Y axis of a point specified by the index.
default double[]	getYErrorsNegative()	Returns the negative error along the Y axis for all available data points.
default double[]	getYErrorsPositive()	Returns the positive error along the y axis for all available data points.

Methods inherited from interface de.gsi.dataset.DataSet

getDataCount, getDataCount, getDataLabel, getName, getStyle, getStyle, getUndefValue, getValue, getX, getXIndex, getXMax, getXMin, getXValues, getY, getYIndex, getYMax, getYMin, getYValues, isAutoNotification, lock, setAutoNotifaction, setStyle, unlock

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

addListener, invokeListener, invokeListener, removeListener, updateEventListener

Method Detail

getErrorType

DataSetError.ErrorType getErrorType()

Returns the given error type that may be used to drive given simplifications and optimisation in derived classes.

Returns:

one of the error types specified in ErrorType

getXErrorNegative

double getXErrorNegative(int index)

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!

Parameters:

index - of negative X error to be returned.

Returns:

negative X error

getXErrorsNegative

default double[] getXErrorsNegative()

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

Returns:

array containing negative X error

getXErrorPositive

double getXErrorPositive(int index)

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!

Parameters:

index - of positive X error to be returned.

Returns:

positive X error

getXErrorsPositive

default double[] getXErrorsPositive()

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

Returns:

array containing positive X error

getYErrorNegative

double getYErrorNegative(int index)

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!

Parameters:

index - of negative Y error to be returned.

Returns:

negative Y error

getYErrorsNegative

default double[] getYErrorsNegative()

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

Returns:

array containing negative Y error

getYErrorPositive

double getYErrorPositive(int index)

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!

Parameters:

index - of positive Y error to be returned.

Returns:

positive Y error

getYErrorsPositive

default double[] getYErrorsPositive()

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

Returns:

array containing positive y error

getXErrorNegative

default double getXErrorNegative(double x)

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

Parameters:

x - horizontal x coordinate

Returns:

negative X error

getXErrorPositive

default double getXErrorPositive(double x)

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

Parameters:

x - horizontal x coordinate

Returns:

positive X error

getYErrorNegative

default double getYErrorNegative(double x)

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

Parameters:

x - horizontal x coordinate

Returns:

negative Y error

getYErrorPositive

default double getYErrorPositive(double x)

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

Parameters:

x - horizontal x coordinate.

Returns:

positive Y error