org.epics.graphene

Interface Cell2DDataset

public interface Cell2DDataset

A dataset consisting on a set of 2D cells.

It represents values distributed on a 2D grid and their statistical information.

Author:

carcassi

Method Summary

Methods

Modifier and Type	Method and Description
Statistics	getStatistics() Returns the statistics of all values at all cells.
double	getValue(int x, int y) Returns the value at the given coordinates.
org.epics.util.array.ListNumber	getXBoundaries() Returns the boundaries of the cells along x.
int	getXCount() The number of cells defined along the x direction.
Range	getXRange() The range along x.
org.epics.util.array.ListNumber	getYBoundaries() Returns the boundaries of the cells along y.
int	getYCount() The number of cells defined along the y direction.
Range	getYRange() The range along y.

Method Detail

getValue

double getValue(int x,
              int y)

Returns the value at the given coordinates.

Parameters:

x - the x coordinate

y - the y coordinate

Returns:

the value

Throws:

ArrayIndexOutOfBoundsException - if any coordinate is $lt; 0 or >= its count

getStatistics

Statistics getStatistics()

Returns the statistics of all values at all cells.

If the the grid has zero cells, or if all values are NaN, it returns null.

Returns:

statistical information; null if no actual value is defined on the grid

getXBoundaries

org.epics.util.array.ListNumber getXBoundaries()

Returns the boundaries of the cells along x.

The number of elements matches getXCount() + 1. If no cells are defined, it will return null. The boundaries are ordered from the smallest to the greatest.

Returns:

the boundaries of the cells; null if 0 cells are defined

getXRange

Range getXRange()

The range along x.

Effectively the first and last elements of getXBoundaries(). If no cells are defined, it will return null.

Returns:

the range along x; null if 0 cells are defined

getXCount

int getXCount()

The number of cells defined along the x direction.

Returns:

the number of cells along x

getYBoundaries

org.epics.util.array.ListNumber getYBoundaries()

Returns the boundaries of the cells along y.

The number of elements matches getYCount() + 1. If no cells are defined, it will return null. The boundaries are ordered from the smallest to the greatest.

Returns:

the boundaries of the cells; null if 0 cells are defined

getYRange

Range getYRange()

The range along y.

Effectively the first and last elements of getYBoundaries(). If no cells are defined, it will return null.

Returns:

the range along y; null if 0 cells are defined

getYCount

int getYCount()

The number of cells defined along the y direction.

Returns:

the number of cells along y