org.das2.qds

Class SparseDataSet

java.lang.Object

org.das2.qds.AbstractDataSet

org.das2.qds.SparseDataSet

All Implemented Interfaces:

MutablePropertyDataSet, QDataSet, WritableDataSet

public class SparseDataSet
extends AbstractDataSet
implements WritableDataSet

DataSet for storing sparse data. This is used initially to describe bundles. This returns 0 where no data has been set. For example,

sp= SparseDataSet.createQube([2,4])
sp[2,2]= 1
print sp[0,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

Method Summary

Modifier and Type	Method and Description
static SparseDataSet	createQube(int[] qube) create the qube dataset with the given dimensions.
static SparseDataSet	createRank(int rank) create the dataset with the given rank.
static SparseDataSet	createRankLen(int rank, int len0) create the dataset with the given rank and initial length.
int	length() return the length of the first dimension
int	length(int i) 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.
void	putValue(double d) put a value into the rank 0 dataset.
void	putValue(int i0, double d) put a value into the rank 1 dataset.
void	putValue(int i0, int i1, double d) put a value into the rank 2 dataset.
void	putValue(int i0, int i1, int i2, double d) put a value into the rank 3 dataset.
void	putValue(int i0, int i1, int i2, int i3, double d) put a value into the rank 4 dataset.
int	rank() returns the rank of the dataset, which is the number of indeces used to access data.
void	setLength(int length) set the length of the zeroth dimension.
void	setQube(int[] qube) make this a qube dataset, where all the lengths are the same.
double	value() rank 0 accessor.
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, property, putProperty, putProperty, slice, svalue, toString, trim

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.das2.qds.MutablePropertyDataSet

isImmutable, makeImmutable, putProperty, putProperty

Methods inherited from interface org.das2.qds.QDataSet

capability, property, property, slice, svalue, trim

Method Detail

createRank

public static SparseDataSet createRank(int rank)

create the dataset with the given rank. The length of any dimension is explicitly set with the setLength method or implicitly by the highest index assigned a value. Note Jython scripts are unable to call the setLength method.

Parameters:

rank - number of indeces

Returns:

a dataset that is empty.

See Also:

createRankLen(int, int), createQube(int[])

createRankLen

public static SparseDataSet createRankLen(int rank,
                                          int len0)

create the dataset with the given rank and initial length. This was introduced because setLength cannot be called from Jython scripts. Each record will have length(i) based on the highest index assigned.

Parameters:

rank - the result's rank.

len0 - the number of records in the result.

Returns:

SparseDataSet with the given rank.

See Also:

createQube(int[])

createQube

public static SparseDataSet createQube(int[] qube)

create the qube dataset with the given dimensions. This was introduced because setQube cannot be called from Jython scripts.

Parameters:

qube - the index dimensions.

Returns:

SparseDataSet with the given rank and dimensions based on qube.

setLength

public void setLength(int length)

set the length of the zeroth dimension. Other dimensions have length set implicitly by the highest value set. If this is not set explicitly, then it will be implicit as well.

Parameters:

length -

setQube

public void setQube(int[] qube)

make this a qube dataset, where all the lengths are the same.

Parameters:

qube -

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.

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 i)

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:

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

putValue

public void putValue(double d)

Description copied from interface: WritableDataSet

put a value into the rank 0 dataset.

Specified by:

putValue in interface WritableDataSet

Parameters:

d - the value

putValue

public void putValue(int i0,
                     double d)

Description copied from interface: WritableDataSet

put a value into the rank 1 dataset.

Specified by:

putValue in interface WritableDataSet

Parameters:

i0 - the index

d - the value

putValue

public void putValue(int i0,
                     int i1,
                     double d)

Description copied from interface: WritableDataSet

put a value into the rank 2 dataset.

Specified by:

putValue in interface WritableDataSet

Parameters:

i0 - the index

i1 - the index

d - the value

putValue

public void putValue(int i0,
                     int i1,
                     int i2,
                     double d)

Description copied from interface: WritableDataSet

put a value into the rank 3 dataset.

Specified by:

putValue in interface WritableDataSet

Parameters:

i0 - the index

i1 - the index

i2 - the index

d - the value

putValue

public void putValue(int i0,
                     int i1,
                     int i2,
                     int i3,
                     double d)

Description copied from interface: WritableDataSet

put a value into the rank 4 dataset.

Specified by:

putValue in interface WritableDataSet

Parameters:

i0 - the index

i1 - the index

i2 - the index

i3 - the index

d - the value

value

public double value()

Description copied from interface: QDataSet

rank 0 accessor.

Specified by:

value in interface QDataSet

Overrides:

value in class AbstractDataSet

Returns:

the value, see the property UNITS to interpret this.

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.