org.das2.qds

Class BundleDataSet

java.lang.Object

org.das2.qds.AbstractDataSet

org.das2.qds.BundleDataSet

All Implemented Interfaces:

MutablePropertyDataSet, QDataSet

public final class BundleDataSet
extends AbstractDataSet

create a higher rank dataset with dim 1 being a bundle dimension. Each dataset must have the same length. Note this was created before BUNDLE_1 and bundle descriptor datasets were introduced, so this code is suspect. TODO: review and ensure compatibility with updates to bundle dataset semantics. Copied from JoinDataSet in June 2009 Modification History:

• 2012-07-17: allow rank 2 datasets to be bundled. TODO: really? code doesn't look like it!
• See https://sourceforge.net/p/autoplot/feature-requests/267/

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BundleDataSet.BundleDescriptor special dataset describing the bundled datasets in a BundleDataSet.

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
BundleDataSet() Creates a new instance of BundleDataSet that accepts rank 1 datasets.
BundleDataSet(int rank) Creates a new instance of BundleDataSet with the given rank.
BundleDataSet(QDataSet ds) create a bundle with the first dataset.

Method Summary

Modifier and Type	Method and Description
void	bundle(QDataSet ds) add the dataset to the bundle of datasets.
static BundleDataSet	createRank0Bundle() return a BundleDataSet for bundling rank 0 datasets.
static BundleDataSet	createRank1Bundle() return a BundleDataSet for bundling rank 1 datasets.
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.
int	length(int i0, int i1, int i2) return the length of the fourth dimension for the ith, jth and kth elements of the first three dimensions.
java.lang.Object	property(java.lang.String name, int i0) 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.
java.lang.String	toString() return a human-readable string representation of this QDataSet.
QDataSet	unbundle(int i) allow to simply unbundle the dataset.
double	value(int i0) rank 1 accessor.
double	value(int i0, int i1) rank 2 accessor.
double	value(int i0, int i1, int i2) rank 3 accessor.
double	value(int i0, int i1, int i2, int i3) rank 4 accessor.

Methods inherited from class org.das2.qds.AbstractDataSet

capability, checkImmutable, isImmutable, makeImmutable, property, putProperty, putProperty, slice, svalue, trim, value

Methods inherited from class java.lang.Object

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

Constructor Detail

BundleDataSet

public BundleDataSet()

Creates a new instance of BundleDataSet that accepts rank 1 datasets. (Rank 2 and up are not yet supported.)

BundleDataSet

public BundleDataSet(int rank)

Creates a new instance of BundleDataSet with the given rank. Rank 1 datasets can bundle rank 0 datasets, while rank 2 can only bundle rank 1 datasets with the same depend_0.

Parameters:

rank - rank of the bundle.

BundleDataSet

public BundleDataSet(QDataSet ds)

create a bundle with the first dataset. The result will have rank N+1 where ds has rank N.

Parameters:

ds - rank N dataset.

Method Detail

createRank0Bundle

public static BundleDataSet createRank0Bundle()

return a BundleDataSet for bundling rank 0 datasets. The result will be a rank 1 datasets with BUNDLE_0 non-null.

Returns:

a rank 1 BundleDataSet

createRank1Bundle

public static BundleDataSet createRank1Bundle()

return a BundleDataSet for bundling rank 1 datasets. The result will be a rank 2 datasets with BUNDLE_1 non-null.

Returns:

a rank 2 BundleDataSet

bundle

public void bundle(QDataSet ds)

add the dataset to the bundle of datasets. Currently this implementation only supports rank N-1 datasets (N is this dataset's rank), but the QDataSet spec allows for qube datasets of any rank>1 to be bundled. This limitation will be removed in a future version. (Note QDataSet changes http://autoplot.org/QDataSet#2011-Apr-13)

Parameters:

ds -

unbundle

public QDataSet unbundle(int i)

allow to simply unbundle the dataset. If the bundle has DEPEND_0, then DEPEND_0 may be added to the result.

Parameters:

i - the index.

Returns:

the dataset at i.

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(int i0)

Description copied from interface: QDataSet

rank 1 accessor.

Specified by:

value in interface QDataSet

Overrides:

value in class AbstractDataSet

Parameters:

i0 - 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.

value

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

Description copied from interface: QDataSet

rank 4 accessor.

Specified by:

value in interface QDataSet

Overrides:

value in class AbstractDataSet

Parameters:

i0 - the index

i1 - the index

i2 - the index

i3 - the index

Returns:

the value, see the property UNITS to interpret this.

property

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

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"

i0 - 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.

length

public int length(int i0,
                  int i1,
                  int i2)

Description copied from interface: QDataSet

return the length of the fourth dimension for the ith, jth and kth elements of the first three dimensions.

Specified by:

length in interface QDataSet

Overrides:

length in class AbstractDataSet

Parameters:

i0 - the index

i1 - the index

i2 - the index

Returns:

the length of the fourth dimension for the ith, jth and kth elements of the first three dimensions.

toString

public java.lang.String toString()

Description copied from class: AbstractDataSet

return a human-readable string representation of this QDataSet.

Overrides:

toString in class AbstractDataSet

Returns:

a human-readable string representation of this QDataSet.

See Also:

DataSetUtil.toString(org.das2.qds.QDataSet)