org.das2.qds

Class SortDataSet

java.lang.Object

org.das2.qds.AbstractDataSet

org.das2.qds.SortDataSet

All Implemented Interfaces:

MutablePropertyDataSet, QDataSet

public class SortDataSet
extends AbstractDataSet

wraps QDataSet, rearranging the elements of the first index as specified by a rank 1 data set of indeces.

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
SortDataSet(QDataSet source, QDataSet sort) creates the SortDataSet

Method Summary

Modifier and Type	Method and Description
<T> T	capability(java.lang.Class<T> clazz) return null or an object implementing the capability for the given interface For example:
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 i, int j) 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 i, int j, int k) 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) TODO: this is dangerous code, because as new properties are added to QDataSet, they may not be handled properly here.
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(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.
double	value(int i0, int i1, int i2, int i3) rank 4 accessor.

Methods inherited from class org.das2.qds.AbstractDataSet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SortDataSet

public SortDataSet(QDataSet source,
                   QDataSet sort)

creates the SortDataSet

Parameters:

source - rank N dataset. Supports plane_0. Supports rank 2 Depend_1.

sort - the rank 1 indeces of the sort.

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

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)

TODO: this is dangerous code, because as new properties are added to QDataSet, they may not be handled properly here. (e.g. BIN_PLUS). Note the properties are intended to mask the things that have changed!

Specified by:

property in interface QDataSet

Overrides:

property in class AbstractDataSet

Parameters:

name -

Returns:

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

capability

public <T> T capability(java.lang.Class<T> clazz)

Description copied from interface: QDataSet

return null or an object implementing the capability for the given interface For example:

ds= DDataSet.createRank1(100);
WriteCapability write= ds.capability( WriteCapability.class );
write.putValue( 99, -1e31 );

This allows operations to be performed efficiently. Note there is no WriteCapability class, this is just an example.

Specified by:

capability in interface QDataSet

Overrides:

capability in class AbstractDataSet

Type Parameters:

T - a capability

Parameters:

clazz - the class, such as WriteCapability.class

Returns:

the implementing class, or null (Jython None) if the capability is not provided.

See Also:

LongWriteAccess, LongReadAccess, FloatReadAccess

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 i,
                  int j)

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:

i - the index

j - the index

Returns:

the length of the third dimension at index i.

length

public int length(int i,
                  int j,
                  int k)

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:

i - the index

j - the index

k - the index

Returns:

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