de.gsi.dataset

Interface DataSetError

All Superinterfaces:

DataSet, EventSource, Serializable

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 and Description
static class	DataSetError.ErrorType

Field Summary

Fields inherited from interface de.gsi.dataset.DataSet

DIM_X, DIM_Y, DIM_Z

Method Summary

Modifier and Type	Method and Description
default double	getErrorNegative(int dimIndex, double x) Returns the negative error along the 'dimIndex' axis of a point specified by the x coordinate.
double	getErrorNegative(int dimIndex, int index) Returns the negative error along the 'dimIndex' axis of a point specified by the index.
default double	getErrorPositive(int dimIndex, double x) Returns the positive error along the 'dimIndex' axis of a point specified by the x coordinate.
double	getErrorPositive(int dimIndex, int index) Returns the positive error along the 'dimIndex' axis of a point specified by the index.
default double[]	getErrorsNegative(int dimIndex) Returns the negative error along the 'dimIndex' axis for all available data points.
default double[]	getErrorsPositive(int dimIndex) Returns the positive error along the 'dimIndex' axis for all available data points.
DataSetError.ErrorType	getErrorType(int dimIndex) Returns the given error type for a specific dimension that may be used to drive given simplifications and optimisation in derived classes.

Methods inherited from interface de.gsi.dataset.DataSet

get, getAxisDescription, getAxisDescriptions, getDataCount, getDataCount, getDataLabel, getDimension, getIndex, getName, getStyle, getStyle, getValue, getValues, lock, recomputeLimits, setStyle

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

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

Method Detail

getErrorNegative

default double getErrorNegative(int dimIndex,
                                double x)

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

Parameters:

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

x - horizontal 'dimIndex' coordinate

Returns:

negative 'dimIndex' error

getErrorNegative

double getErrorNegative(int dimIndex,
                        int index)

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

Parameters:

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

index - of negative 'dimIndex' error to be returned.

Returns:

negative 'dimIndex' error

getErrorPositive

default double getErrorPositive(int dimIndex,
                                double x)

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

Parameters:

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

x - horizontal 'dimIndex' coordinate

Returns:

positive 'dimIndex' error

getErrorPositive

double getErrorPositive(int dimIndex,
                        int index)

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

Parameters:

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

index - of positive 'dimIndex' error to be returned.

Returns:

positive 'dimIndex' error

getErrorsNegative

default double[] getErrorsNegative(int dimIndex)

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

Parameters:

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

Returns:

array containing negative 'dimIndex' error

getErrorsPositive

default double[] getErrorsPositive(int dimIndex)

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

Parameters:

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

Returns:

array containing positive 'dimIndex' error

getErrorType

DataSetError.ErrorType getErrorType(int dimIndex)

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

Parameters:

dimIndex - the dimension for which to query the ErrorType

Returns:

one of the error types specified in ErrorType