org.das2.dataset

Interface TableDataSet

All Superinterfaces:

DataSet

All Known Implementing Classes:

AbstractTableDataSet, AppendTableDataSet, ContourMeDataSet, DefaultTableDataSet, DistTableDataSet, FunctionTableDataSet, Rank3TableDataSetAdapter, RipplesDataSet, SimpleTableDataSet, SineWaveTable, TableDataSetAdapter, TableDataSetWrapper, WeightsTableDataSet, WindowTableDataSet, WritableTableDataSet

public interface TableDataSet
extends DataSet

A DataSet implementation for 3 dimensional z(x,y) data sets where the data is arranged in a sequence of tables. Each table will have a set of monotonically increasing x tags and y tags. The x tags for all the tables, when taken together in the order that the table are in, will be monotonically increasing over the whole data set. The y tags are constant over the y scans of each table, but may change, either in number or value, from table to table.

Field Summary

Fields inherited from interface org.das2.dataset.DataSet

PROPERTY_CACHE_TAG, PROPERTY_FORMATTER, PROPERTY_OPERATION, PROPERTY_PLANE_PEAKS, PROPERTY_PLANE_WEIGHTS, PROPERTY_RENDERER, PROPERTY_SIZE_BYTES, PROPERTY_SOURCE, PROPERTY_SUMMARY, PROPERTY_TITLE, PROPERTY_X_CACHE_RES, PROPERTY_X_CACHE_RNG, PROPERTY_X_FORMAT, PROPERTY_X_LABEL, PROPERTY_X_MONOTONIC, PROPERTY_X_RANGE, PROPERTY_X_SUMMARY, PROPERTY_X_TAG_WIDTH, PROPERTY_X_VALID_MAX, PROPERTY_X_VALID_MIN, PROPERTY_Y_CACHE_RES, PROPERTY_Y_CACHE_RNG, PROPERTY_Y_FILL, PROPERTY_Y_FORMAT, PROPERTY_Y_LABEL, PROPERTY_Y_MONOTONIC, PROPERTY_Y_RANGE, PROPERTY_Y_SCALETYPE, PROPERTY_Y_SUMMARY, PROPERTY_Y_TAG_WIDTH, PROPERTY_Y_VALID_MAX, PROPERTY_Y_VALID_MIN, PROPERTY_Z_FILL, PROPERTY_Z_FORMAT, PROPERTY_Z_LABEL, PROPERTY_Z_RANGE, PROPERTY_Z_SCALETYPE, PROPERTY_Z_SUMMARY, PROPERTY_Z_VALID_MAX, PROPERTY_Z_VALID_MIN

Method Summary

Modifier and Type	Method and Description
Datum	getDatum(int i, int j) Returns the Z value for the given indices into the x and y tags as a Datum.
double	getDouble(int i, int j, Units units) Returns the Z value for the given indices into the x and y tags as a double with the given units.
double[]	getDoubleScan(int i, Units units)
int	getInt(int i, int j, Units units) Returns the Z value for the given indices into the x and y tags as a int with the given units.
java.lang.Object	getProperty(int table, java.lang.String name) Return the property value attached to the table.
DatumVector	getScan(int i)
VectorDataSet	getXSlice(int i) Returns a slice view of this data set for a specific x value
int	getYLength(int table) Returns the number of y tags in the specified table for this data set.
VectorDataSet	getYSlice(int j, int table) Returns a slice view of this data set for a specific y value
Datum	getYTagDatum(int table, int j) Returns the value of the y tag at the given index j as a Datum.
double	getYTagDouble(int table, int j, Units units) Returns the value of the y tag at the given index j as a double in the given units.
int	getYTagInt(int table, int j, Units units) Returns the value of the y tag at the given index j as an int in the given units.
DatumVector	getYTags(int table) Returns the yTags for this data set as a DatumVector
Units	getZUnits() Returns the Units object representing the unit type of the y values for this data set.
int	tableCount() Returns the number of tables in this data set
int	tableEnd(int table) Returns the index after the last x tag index of the specified table
int	tableOfIndex(int i) Returns the table number that the specified index is in.
int	tableStart(int table) Returns the first x tag index of the specified table.

Methods inherited from interface org.das2.dataset.DataSet

getPlanarView, getPlaneIds, getProperties, getProperty, getXLength, getXTagDatum, getXTagDouble, getXTagInt, getXUnits, getYUnits

Method Detail

getZUnits

Units getZUnits()

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

Returns:

the x units

getDatum

Datum getDatum(int i,
               int j)

Returns the Z value for the given indices into the x and y tags as a Datum.

Parameters:

i - index of the x tag for the requested value.

j - index of the y tag for the requested value.

Returns:

the value at index location (i, j) as a Datum

getDouble

double getDouble(int i,
                 int j,
                 Units units)

Returns the Z value for the given indices into the x and y tags as a double with the given units.

Parameters:

j - index of the x tag for the requested value.

i - index of the y tag for the requested value.

units - the units the returned value should be converted to.

Returns:

the value at index location (i, j) as a double.

getScan

DatumVector getScan(int i)

getDoubleScan

double[] getDoubleScan(int i,
                       Units units)

getInt

int getInt(int i,
           int j,
           Units units)

Returns the Z value for the given indices into the x and y tags as a int with the given units.

Parameters:

i - index of the x tag for the requested value.

j - index of the y tag for the requested value.

units - the units the returned value should be converted to.

Returns:

the value at index location (i, j) as a int.

getYTags

DatumVector getYTags(int table)

Returns the yTags for this data set as a DatumVector

Parameters:

table - the table number

Returns:

the yTags for this data set as a DatumVector

getYTagDatum

Datum getYTagDatum(int table,
                   int j)

Returns the value of the y tag at the given index j as a Datum.

Parameters:

table - the table number

j - the index of the requested y tag

Returns:

the value of the y tag at the given index j as a Datum.

getYTagDouble

double getYTagDouble(int table,
                     int j,
                     Units units)

Returns the value of the y tag at the given index j as a double in the given units. YTags must be monotonically increasing with j.

Parameters:

table - the table number

units - the units of the returned value

j - the index of the requested y tag

Returns:

the value of the y tag at the given index j as a double.

getYTagInt

int getYTagInt(int table,
               int j,
               Units units)

Returns the value of the y tag at the given index j as an int in the given units. YTags must be monotonically increasing with j.

Parameters:

units - the units of the returned value

j - the index of the requested y tag

Returns:

the value of the y tag at the given index j as an int.

getYLength

int getYLength(int table)

Returns the number of y tags in the specified table for this data set. YTags must be monotonically increasing with j.

Parameters:

table - index of the table

Returns:

the number of x tags in this data set.

tableStart

int tableStart(int table)

Returns the first x tag index of the specified table.

Parameters:

table - the index of the table.

Returns:

the first x tag index of the specified table

tableEnd

int tableEnd(int table)

Returns the index after the last x tag index of the specified table

Parameters:

table - the index of the table

Returns:

the index after the last x tag index of the specified table

tableCount

int tableCount()

Returns the number of tables in this data set

Returns:

the number of tables in this data set

tableOfIndex

int tableOfIndex(int i)

Returns the table number that the specified index is in.

Parameters:

i - x tag index

Returns:

the table number that the specified index is in

getXSlice

VectorDataSet getXSlice(int i)

Returns a slice view of this data set for a specific x value

getYSlice

VectorDataSet getYSlice(int j,
                        int table)

Returns a slice view of this data set for a specific y value

getProperty

java.lang.Object getProperty(int table,
                             java.lang.String name)

Return the property value attached to the table. This should simply return DataSet.getProperty() if the table has no special value for the table.

Parameters:

table -

name -

Returns: