org.das2.qds

Class JoinDataSet

java.lang.Object

org.das2.qds.AbstractDataSet

org.das2.qds.JoinDataSet

All Implemented Interfaces:

MutablePropertyDataSet, QDataSet

Direct Known Subclasses:

WritableJoinDataSet

public class JoinDataSet
extends AbstractDataSet

Create a higher rank dataset with dim 0 being a JOIN dimension. Join implies that the joined datasets occupy the same physical dimension, and this can be thought of as the "array of" index. Note DEPEND_0 is treated as a special case of join. Note this dataset is mutable, and clients should not mutate it once the reference is made public.

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
JoinDataSet(int rank) Creates a new instance of JoinDataSet
JoinDataSet(QDataSet ds1) create a new JoinDataSet, and join the first dataset.

Method Summary

Modifier and Type	Method and Description
static JoinDataSet	copy(JoinDataSet joinDataSet) copy the JoinDataSet without copying each dataset it contains.
static QDataSet	deepCopy(QDataSet rds) Deprecated. see WritableJoinDataSet
void	join(int index, QDataSet ds) set the dataset at the index.
void	join(QDataSet ds) add the dataset to this set of joined datasets.
void	joinAll(JoinDataSet ds1) copy all the records into this JoinDataSet.
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) accessor for properties attached to the dataset.
java.lang.Object	property(java.lang.String name, int i0) accessor for properties attached to the dataset's first index.
void	putProperty(java.lang.String name, java.lang.Object value) We override putProperty here because we remove the JOIN_0 if DEPEND_0 is set.
int	rank() returns the rank of the dataset, which is the number of indeces used to access data.
QDataSet	slice(int idx) slice the dataset by returning the joined dataset at this index.
java.lang.String	toString() return a human-readable string representation of this QDataSet.
JoinDataSet	trim(int imin, int imax) return a dataset that is a subset of this 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, putProperty, svalue, value

Methods inherited from class java.lang.Object

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

Constructor Detail

JoinDataSet

public JoinDataSet(int rank)

Creates a new instance of JoinDataSet

Parameters:

rank - The rank of the JoinDataSet. Each dataset joined must have rank rank-1.

JoinDataSet

public JoinDataSet(QDataSet ds1)

create a new JoinDataSet, and join the first dataset.

ds1= Ops.rand(30);
jds= new JoinDataSet( ds1 );
assert( ds1.rank()==1 );
assert( jds.rank()==2 );
assert( jds.slice(0).equals(ds1) );

Parameters:

ds1 - rank N-1 dataset that will be the first slice to add to this rank N dataset.

Method Detail

deepCopy

public static QDataSet deepCopy(QDataSet rds)

Deprecated. see WritableJoinDataSet

return a copy of the dataset, creating a new JoinDataSet and copying each slice into the JoinDataSet.

Parameters:

rds - any dataset

Returns:

a copy of the original dataset.

copy

public static JoinDataSet copy(JoinDataSet joinDataSet)

copy the JoinDataSet without copying each dataset it contains.

Parameters:

joinDataSet - another JoinDataSet

Returns:

a copy of the dataset.

joinAll

public void joinAll(JoinDataSet ds1)

copy all the records into this JoinDataSet. Note this is a shallow copy, and changes to one of the element datasets is visible in both JoinDataSets. TODO: this is probably under implemented, for example element properties.

Parameters:

ds1 -

join

public final void join(QDataSet ds)

add the dataset to this set of joined datasets.

Parameters:

ds - rank N-1 dataset where N is the rank of this JoinDataSet.

Throws:

java.lang.IllegalArgumentException - if the dataset rank is not consistent with the other datasets.

join

public final void join(int index,
                       QDataSet ds)

set the dataset at the index. This must be used sequentially.

Parameters:

index - the index of the dataset

ds - the dataset

Throws:

java.lang.IllegalArgumentException - if the dataset rank is not consistent with the other datasets.

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

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

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

putProperty

public final void putProperty(java.lang.String name,
                              java.lang.Object value)

We override putProperty here because we remove the JOIN_0 if DEPEND_0 is set.

Specified by:

putProperty in interface MutablePropertyDataSet

Overrides:

putProperty in class AbstractDataSet

Parameters:

name -

value -

See Also:

putProperty which properly checks mutability of the dataset, 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)

trim

public JoinDataSet trim(int imin,
                        int imax)

Description copied from interface: QDataSet

return a dataset that is a subset of this dataset. For example:

 
    ds= DDataSet.createRank1(100);
    QDataSet trim= ds.trim(50,60);
    assert( trim.length()==10 );
 
 

Note start and end must be positive. Negative indices, referenced from the end of the dataset, are not supported here.

Specified by:

trim in interface QDataSet

Overrides:

trim in class AbstractDataSet

Parameters:

imin - the first index to be included in the new dataset.

imax - the exclusive index indicating the last index.

Returns:

a QDataSet with the same rank but fewer elements.

slice

public QDataSet slice(int idx)

slice the dataset by returning the joined dataset at this index. If the dataset is a MutablePropertiesDataSet, then add the properties of this join dataset to it. The result is made a mutable properties dataset if it is not already, the danger here is that we may mutate the original data. Capabilities will fix this.

Specified by:

slice in interface QDataSet

Overrides:

slice in class AbstractDataSet

Parameters:

idx - the index for the slice

Returns:

the rank N-1 slice at the position.