org.das2.dataset
Interface DataSet

All Known Subinterfaces:

TableDataSet, VectorDataSet

All Known Implementing Classes:

AbstractDataSet, AbstractDataSet.ViewDataSet, AbstractTableDataSet, AbstractTableDataSet.XSliceDataSet, AbstractTableDataSet.YSliceDataSet, AbstractVectorDataSet, AppendTableDataSet, ClippedTableDataSet, ClippedVectorDataSet, ContourMeDataSet, DefaultTableDataSet, DefaultVectorDataSet, DistTableDataSet, FunctionTableDataSet, NearestNeighborTableDataSet, OrbitVectorDataSet, QuickVectorDataSet, RipplesDataSet, SimpleTableDataSet, SineWaveTable, SingleVectorDataSet, TableDataSetWrapper, TagMapTableDataSet, ViewDataSet, WavVectorDataSet, WeightsTableDataSet, WindowTableDataSet, WritableTableDataSet, XSliceDataSet, XTagsVectorDataSet, YSliceDataSet

public interface DataSet

General interface for objects encapsulating a data set

Field Summary

static java.lang.String	PROPERTY_CACHE_TAG CacheTag object describing the start, end, and resolution of the dataset.
static java.lang.String	PROPERTY_FORMATTER DatumFormatter for formatting data in the dataset.
static java.lang.String	PROPERTY_PLANE_PEAKS dataset containing the peaks when available
static java.lang.String	PROPERTY_PLANE_WEIGHTS dataset containing the weights when available
static java.lang.String	PROPERTY_RENDERER suggest render method to use.
static java.lang.String	PROPERTY_SIZE_BYTES Long estimating the size of the dataset in memory.
static java.lang.String	PROPERTY_X_LABEL
static java.lang.String	PROPERTY_X_MONOTONIC Boolean assuring that the dataset is monotonic in X.
static java.lang.String	PROPERTY_X_RANGE DatumRange useful for setting scales
static java.lang.String	PROPERTY_X_TAG_WIDTH Datum which is the nominal distance between successive xTags.
static java.lang.String	PROPERTY_Y_LABEL
static java.lang.String	PROPERTY_Y_RANGE DatumRange useful for setting scales
static java.lang.String	PROPERTY_Y_SCALETYPE String "log" or "linear"
static java.lang.String	PROPERTY_Y_TAG_WIDTH Datum, see xTagWidth
static java.lang.String	PROPERTY_Z_LABEL
static java.lang.String	PROPERTY_Z_RANGE DatumRange useful for setting scales
static java.lang.String	PROPERTY_Z_SCALETYPE String "log" or "linear"

Method Summary

DataSet	getPlanarView(java.lang.String planeID) Returns a DataSet with the specified view as the primary view.
java.lang.String[]	getPlaneIds() Returns a list of auxillary planes (e.g.
java.util.Map	getProperties() Returns all dataset properties in a Map.
java.lang.Object	getProperty(java.lang.String name) Returns the property value associated with the string name
int	getXLength() Returns the number of x tags in this data set.
Datum	getXTagDatum(int i) Returns the value of the x tag at the given index i as a Datum.
double	getXTagDouble(int i, Units units) Returns the value of the x tag at the given index i as a double in the given units.
int	getXTagInt(int i, Units units) Returns the value of the x tag at the given index i as an int in the given units.
Units	getXUnits() Returns the Units object representing the unit type of the x tags for this data set.
Units	getYUnits() Returns the Units object representing the unit type of the y tags or y values for this data set.

Field Detail

PROPERTY_CACHE_TAG

static final java.lang.String PROPERTY_CACHE_TAG

CacheTag object describing the start, end, and resolution of the dataset.

See Also:

Constant Field Values

PROPERTY_SIZE_BYTES

static final java.lang.String PROPERTY_SIZE_BYTES

Long estimating the size of the dataset in memory. For example, if a dataset is backed by a local file, then zero for this indicates no penalty for storing this dataset.

See Also:

Constant Field Values

PROPERTY_X_TAG_WIDTH

static final java.lang.String PROPERTY_X_TAG_WIDTH

Datum which is the nominal distance between successive xTags. This is used for example to prevent interpolation between distant measurements

See Also:

Constant Field Values

PROPERTY_Y_TAG_WIDTH

static final java.lang.String PROPERTY_Y_TAG_WIDTH

Datum, see xTagWidth

See Also:

Constant Field Values

PROPERTY_X_RANGE

static final java.lang.String PROPERTY_X_RANGE

DatumRange useful for setting scales

See Also:

Constant Field Values

PROPERTY_Y_RANGE

static final java.lang.String PROPERTY_Y_RANGE

DatumRange useful for setting scales

See Also:

Constant Field Values

PROPERTY_Z_RANGE

static final java.lang.String PROPERTY_Z_RANGE

DatumRange useful for setting scales

See Also:

Constant Field Values

PROPERTY_RENDERER

static final java.lang.String PROPERTY_RENDERER

suggest render method to use. These are canonical: spectrogram symbolLine stackedHistogram

See Also:

Constant Field Values

PROPERTY_Y_SCALETYPE

static final java.lang.String PROPERTY_Y_SCALETYPE

String "log" or "linear"

See Also:

Constant Field Values

PROPERTY_Z_SCALETYPE

static final java.lang.String PROPERTY_Z_SCALETYPE

String "log" or "linear"

See Also:

Constant Field Values

PROPERTY_X_LABEL

static final java.lang.String PROPERTY_X_LABEL

See Also:

Constant Field Values

PROPERTY_Y_LABEL

static final java.lang.String PROPERTY_Y_LABEL

See Also:

Constant Field Values

PROPERTY_Z_LABEL

static final java.lang.String PROPERTY_Z_LABEL

See Also:

Constant Field Values

PROPERTY_X_MONOTONIC

static final java.lang.String PROPERTY_X_MONOTONIC

Boolean assuring that the dataset is monotonic in X. This allows some optimizations to be made.

See Also:

Constant Field Values

PROPERTY_PLANE_PEAKS

static final java.lang.String PROPERTY_PLANE_PEAKS

dataset containing the peaks when available

See Also:

Constant Field Values

PROPERTY_PLANE_WEIGHTS

static final java.lang.String PROPERTY_PLANE_WEIGHTS

dataset containing the weights when available

See Also:

Constant Field Values

PROPERTY_FORMATTER

static final java.lang.String PROPERTY_FORMATTER

DatumFormatter for formatting data in the dataset.

See Also:

Constant Field Values

Method Detail

getProperty

java.lang.Object getProperty(java.lang.String name)

Returns the property value associated with the string name

Parameters:

name - the name of the property requested

Returns:

the property value for name or null

getProperties

java.util.Map getProperties()

Returns all dataset properties in a Map.

Returns:

a Map of all properties.

getXUnits

Units getXUnits()

Returns the Units object representing the unit type of the x tags for this data set.

Returns:

the x units

getYUnits

Units getYUnits()

Returns the Units object representing the unit type of the y tags or y values for this data set.

Returns:

the y units

getXTagDatum

Datum getXTagDatum(int i)

Returns the value of the x tag at the given index i as a Datum.

Parameters:

i - the index of the requested x tag

Returns:

the value of the x tag at the given index i as a Datum.

getXTagDouble

double getXTagDouble(int i,
                     Units units)

Returns the value of the x tag at the given index i as a double in the given units. XTags must be monotonically increasing with i.

Parameters:

units - the units of the returned value

i - the index of the requested x tag

Returns:

the value of the x tag at the given index i as a double.

getXTagInt

int getXTagInt(int i,
               Units units)

Returns the value of the x tag at the given index i as an int in the given units. XTags must be monotonically increasing with i.

Parameters:

units - the units of the returned value.

i - the index of the requested x tag

Returns:

the value of the x tag at the given index i as an int.

getXLength

int getXLength()

Returns the number of x tags in this data set. XTags must be monotonically increasing with i.

Returns:

the number of x tags in this data set.

getPlanarView

DataSet getPlanarView(java.lang.String planeID)

Returns a DataSet with the specified view as the primary view.

Parameters:

planeID - the String id of the requested plane.

Returns:

the specified view, as a DataSet

getPlaneIds

java.lang.String[] getPlaneIds()

Returns a list of auxillary planes (e.g. weights, peaks) for the dataset. Note that the default plane, "" may or may not be returned, based on implementations.