org.das2.qds

Class Slice0DataSet

java.lang.Object

org.das2.qds.AbstractDataSet

org.das2.qds.Slice0DataSet

All Implemented Interfaces:

MutablePropertyDataSet, QDataSet, RankZeroDataSet

public final class Slice0DataSet
extends AbstractDataSet
implements RankZeroDataSet

Wraps a rank N dataset, slicing on an index of the first dimension to make a rank N-1 dataset. This is currently used to implement DataSetOps.slice0(). Slicing a rank 1 dataset results in a rank 0 dataset. Supports rank 2 depend_1 datasets. Supports CONTEXT_0, DELTA_PLUS, DELTA_MINUS Supports BINS_1, JOIN_0

Field Summary

Fields inherited from class org.das2.qds.AbstractDataSet

properties

Fields inherited from interface org.das2.qds.QDataSet

AVERAGE_TYPE, BIN_MAX, BIN_MAX_NAME, BIN_MIN, BIN_MIN_NAME, BIN_MINUS, BIN_MINUS_NAME, BIN_PLUS, BIN_PLUS_NAME, BINS_0, BINS_1, BUNDLE_0, BUNDLE_1, BUNDLE_2, BUNDLE_3, CACHE_TAG, CADENCE, CONTEXT_0, CONTEXT_1, COORDINATE_FRAME, DEFAULT_FILL_VALUE, DELTA_MINUS, DELTA_MINUS_NAME, DELTA_PLUS, DELTA_PLUS_NAME, DEPEND_0, DEPEND_1, DEPEND_2, DEPEND_3, DEPENDNAME_0, DEPENDNAME_1, DESCRIPTION, ELEMENT_DIMENSIONS, ELEMENT_LABEL, ELEMENT_NAME, FILL_VALUE, FORMAT, JOIN_0, LABEL, LIMIT_HUGE_DATASET, MAX_HIGH_RANK, MAX_PLANE_COUNT, MAX_RANK, MAX_UNIT_BUNDLE_COUNT, METADATA, METADATA_MODEL, MIN_WAVEFORM_LENGTH, MONOTONIC, NAME, NOTES, PLANE_0, QUBE, RENDER_TYPE, SCALE_TYPE, SOURCE, START_INDEX, TITLE, TYPICAL_MAX, TYPICAL_MIN, UNITS, USER_PROPERTIES, VALID_MAX, VALID_MIN, VALUE_AVERAGE_TYPE_GEOMETRIC, VALUE_AVERAGE_TYPE_LINEAR, VALUE_AVERAGE_TYPE_MOD24, VALUE_AVERAGE_TYPE_MOD360, VALUE_AVERAGE_TYPE_MODPI, VALUE_AVERAGE_TYPE_MODTAU, VALUE_AVERAGE_TYPE_NONE, VALUE_BINS_MIN_MAX, VALUE_BINS_MIN_MAX_INCLUSIVE, VALUE_COORDINATE_FRAME_COMPLEX_NUMBER, VALUE_METADATA_MODEL_ISTP, VALUE_METADATA_MODEL_SPASE, VALUE_RENDER_TYPE_COMPOSITE_IMAGE, VALUE_RENDER_TYPE_DIGITAL, VALUE_RENDER_TYPE_EVENTS_BAR, VALUE_RENDER_TYPE_NNSPECTROGRAM, VALUE_RENDER_TYPE_SERIES, VALUE_RENDER_TYPE_TRIANGLE_MESH, VALUE_SCALE_TYPE_LINEAR, VALUE_SCALE_TYPE_LOG, VERSION, WEIGHTS

Constructor Summary

Constructors

Constructor and Description
Slice0DataSet(QDataSet ds, int index)
Slice0DataSet(QDataSet ds, int index, boolean addContext)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	hashCode()
int	length() return the length of the first dimension
int	length(int i0) return the length of the second dimension, for the ith element of the first dimension.
int	length(int i0, int i1) return the length of the third dimension, for the ith element of the first dimension and jth element of the second dimension.
java.lang.Object	property(java.lang.String name) accessor for properties attached to the dataset.
java.lang.Object	property(java.lang.String name, int i) accessor for properties attached to the dataset's first index.
int	rank() returns the rank of the dataset, which is the number of indeces used to access data.
double	value() rank 0 accessor.
double	value(int i) rank 1 accessor.
double	value(int i0, int i1) rank 2 accessor.
double	value(int i0, int i1, int i2) rank 3 accessor.

Methods inherited from class org.das2.qds.AbstractDataSet

capability, checkImmutable, isImmutable, length, makeImmutable, putProperty, putProperty, slice, svalue, toString, trim, value

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.das2.qds.QDataSet

capability, length, slice, svalue, trim, value

Constructor Detail

Slice0DataSet

public Slice0DataSet(QDataSet ds,
                     int index)

Slice0DataSet

public Slice0DataSet(QDataSet ds,
                     int index,
                     boolean addContext)

Method Detail

rank

public int rank()

Description copied from interface: QDataSet

returns the rank of the dataset, which is the number of indeces used to access data. Only rank 0, 1, 2, 3, and 4 datasets are supported in the interface. When a dataset's rank is 5 or greater, it should implement the HighRankDataSet interface which affords a slice operation to reduce rank.

Specified by:

rank in interface QDataSet

Specified by:

rank in class AbstractDataSet

Returns:

the rank, or number of indeces used to access data.

value

public double value()

Description copied from interface: QDataSet

rank 0 accessor.

Specified by:

value in interface QDataSet

Specified by:

value in interface RankZeroDataSet

Overrides:

value in class AbstractDataSet

Returns:

the value, see the property UNITS to interpret this.

value

public double value(int i)

Description copied from interface: QDataSet

rank 1 accessor.

Specified by:

value in interface QDataSet

Overrides:

value in class AbstractDataSet

Parameters:

i - the index

Returns:

the value, see the property UNITS to interpret this.

value

public double value(int i0,
                    int i1)

Description copied from interface: QDataSet

rank 2 accessor.

Specified by:

value in interface QDataSet

Overrides:

value in class AbstractDataSet

Parameters:

i0 - the index

i1 - the index

Returns:

the value, see the property UNITS to interpret this.

value

public double value(int i0,
                    int i1,
                    int i2)

Description copied from interface: QDataSet

rank 3 accessor.

Specified by:

value in interface QDataSet

Overrides:

value in class AbstractDataSet

Parameters:

i0 - the index

i1 - the index

i2 - the index

Returns:

the value, see the property UNITS to interpret this.

property

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

Description copied from interface: QDataSet

accessor for properties attached to the dataset. See final static members for example properties.

Specified by:

property in interface QDataSet

Specified by:

property in interface RankZeroDataSet

Overrides:

property in class AbstractDataSet

Parameters:

name - property name, such as "DEPEND_0" or "UNITS"

Returns:

the value

See Also:

QDataSet.DEPEND_0, QDataSet.UNITS

property

public java.lang.Object property(java.lang.String name,
                                 int i)

Description copied from interface: QDataSet

accessor for properties attached to the dataset's first index. These properties override (or shadow) properties attached to the dataset, and often implementations will simply return the result of the no-index accessor. Note: properties of higher dimension are accessible only by slicing.

Specified by:

property in interface QDataSet

Overrides:

property in class AbstractDataSet

Parameters:

name - property name, such as "DEPEND_0" or "UNITS"

i - the index

Returns:

the value

See Also:

QDataSet.DEPEND_0, QDataSet.UNITS

length

public int length()

Description copied from interface: QDataSet

return the length of the first dimension

Specified by:

length in interface QDataSet

Overrides:

length in class AbstractDataSet

Returns:

the length of the first dimension

length

public int length(int i0)

Description copied from interface: QDataSet

return the length of the second dimension, for the ith element of the first dimension. Note if there are zero elements in the first dimension, but this is a QUBE, then this should not throw an IndexOutOfBoundsException.

Specified by:

length in interface QDataSet

Overrides:

length in class AbstractDataSet

Parameters:

i0 - the index

Returns:

the length of the second dimension at index i.

length

public int length(int i0,
                  int i1)

Description copied from interface: QDataSet

return the length of the third dimension, for the ith element of the first dimension and jth element of the second dimension.

Specified by:

length in interface QDataSet

Overrides:

length in class AbstractDataSet

Parameters:

i0 - the index

i1 - the index

Returns:

the length of the third dimension at index i.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object