org.das2.dataset

Class WeightsTableDataSet

java.lang.Object

org.das2.dataset.WeightsTableDataSet

All Implemented Interfaces:

DataSet, TableDataSet

public class WeightsTableDataSet
extends java.lang.Object
implements TableDataSet

WeightsTableDataSet wraps a TableDataSet and returns 0.0 if the data point is not valid, and non-zero (generally one) otherwise. This is intended to provide a consistent way to get the weights without having to handle the case where the weights plane doesn't exist.

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
static TableDataSet	create(TableDataSet source)
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.
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 auxiliary planes (e.g.
java.util.Map	getProperties() Returns all dataset properties in a Map.
java.lang.Object	getProperty(int table, java.lang.String name) Return the property value attached to the table.
java.lang.Object	getProperty(java.lang.String name) Returns the property value associated with the string name
DatumVector	getScan(int i)
int	getXLength() Returns the number of x tags in this data set.
VectorDataSet	getXSlice(int i) Returns a slice view of this data set for a specific x value
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.
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	getYUnits() Returns the Units object representing the unit type of the y tags or y values for this data set.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static TableDataSet create(TableDataSet source)

getDatum

public Datum getDatum(int i,
                      int j)

Description copied from interface: TableDataSet

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

Specified by:

getDatum in interface TableDataSet

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

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

Description copied from interface: TableDataSet

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

Specified by:

getDouble in interface TableDataSet

Parameters:

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

j - index of the x 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.

getDoubleScan

public double[] getDoubleScan(int i,
                              Units units)

Specified by:

getDoubleScan in interface TableDataSet

getInt

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

Description copied from interface: TableDataSet

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

Specified by:

getInt in interface TableDataSet

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.

getPlanarView

public DataSet getPlanarView(java.lang.String planeID)

Description copied from interface: DataSet

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

Specified by:

getPlanarView in interface DataSet

Parameters:

planeID - the String id of the requested plane.

Returns:

the specified view, as a DataSet

getPlaneIds

public java.lang.String[] getPlaneIds()

Description copied from interface: DataSet

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

Specified by:

getPlaneIds in interface DataSet

getProperties

public java.util.Map getProperties()

Description copied from interface: DataSet

Returns all dataset properties in a Map.

Specified by:

getProperties in interface DataSet

Returns:

a Map of all properties.

getProperty

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

Description copied from interface: DataSet

Returns the property value associated with the string name

Specified by:

getProperty in interface DataSet

Parameters:

name - the name of the property requested

Returns:

the property value for name or null

getScan

public DatumVector getScan(int i)

Specified by:

getScan in interface TableDataSet

getXLength

public int getXLength()

Description copied from interface: DataSet

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

Specified by:

getXLength in interface DataSet

Returns:

the number of x tags in this data set.

getXSlice

public VectorDataSet getXSlice(int i)

Description copied from interface: TableDataSet

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

Specified by:

getXSlice in interface TableDataSet

getXTagDatum

public Datum getXTagDatum(int i)

Description copied from interface: DataSet

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

Specified by:

getXTagDatum in interface DataSet

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

public double getXTagDouble(int i,
                            Units units)

Description copied from interface: DataSet

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.

Specified by:

getXTagDouble in interface DataSet

Parameters:

i - the index of the requested x tag

units - the units of the returned value

Returns:

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

getXTagInt

public int getXTagInt(int i,
                      Units units)

Description copied from interface: DataSet

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.

Specified by:

getXTagInt in interface DataSet

Parameters:

i - the index of the requested x tag

units - the units of the returned value.

Returns:

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

getXUnits

public Units getXUnits()

Description copied from interface: DataSet

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

Specified by:

getXUnits in interface DataSet

Returns:

the x units

getYLength

public int getYLength(int table)

Description copied from interface: TableDataSet

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

Specified by:

getYLength in interface TableDataSet

Parameters:

table - index of the table

Returns:

the number of x tags in this data set.

getYSlice

public VectorDataSet getYSlice(int j,
                               int table)

Description copied from interface: TableDataSet

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

Specified by:

getYSlice in interface TableDataSet

getYTagDatum

public Datum getYTagDatum(int table,
                          int j)

Description copied from interface: TableDataSet

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

Specified by:

getYTagDatum in interface TableDataSet

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

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

Description copied from interface: TableDataSet

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.

Specified by:

getYTagDouble in interface TableDataSet

Parameters:

table - the table number

j - the index of the requested y tag

units - the units of the returned value

Returns:

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

getYTagInt

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

Description copied from interface: TableDataSet

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.

Specified by:

getYTagInt in interface TableDataSet

j - the index of the requested y tag

units - the units of the returned value

Returns:

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

getYTags

public DatumVector getYTags(int table)

Description copied from interface: TableDataSet

Returns the yTags for this data set as a DatumVector

Specified by:

getYTags in interface TableDataSet

Parameters:

table - the table number

Returns:

the yTags for this data set as a DatumVector

getYUnits

public Units getYUnits()

Description copied from interface: DataSet

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

Specified by:

getYUnits in interface DataSet

Returns:

the y units

getZUnits

public Units getZUnits()

Description copied from interface: TableDataSet

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

Specified by:

getZUnits in interface TableDataSet

Returns:

the x units

tableCount

public int tableCount()

Description copied from interface: TableDataSet

Returns the number of tables in this data set

Specified by:

tableCount in interface TableDataSet

Returns:

the number of tables in this data set

tableEnd

public int tableEnd(int table)

Description copied from interface: TableDataSet

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

Specified by:

tableEnd in interface TableDataSet

Parameters:

table - the index of the table

Returns:

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

tableOfIndex

public int tableOfIndex(int i)

Description copied from interface: TableDataSet

Returns the table number that the specified index is in.

Specified by:

tableOfIndex in interface TableDataSet

Parameters:

i - x tag index

Returns:

the table number that the specified index is in

tableStart

public int tableStart(int table)

Description copied from interface: TableDataSet

Returns the first x tag index of the specified table.

Specified by:

tableStart in interface TableDataSet

Parameters:

table - the index of the table.

Returns:

the first x tag index of the specified table

getProperty

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

Description copied from interface: TableDataSet

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

Specified by:

getProperty in interface TableDataSet

Returns: