org.das2.qds

Class TagGenDataSet

java.lang.Object

org.das2.qds.AbstractDataSet

org.das2.qds.AbstractRank1DataSet

org.das2.qds.TagGenDataSet

All Implemented Interfaces:

MutablePropertyDataSet, QDataSet

public class TagGenDataSet
extends AbstractRank1DataSet

return a value based on the scale and offset. For example, this is used to create timetags:

   TagGenDataSet( 1440, 60, 0, Units.t2000 )
 

These are the 1440 minutely timetags in the first day of 2000-01-01.

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
TagGenDataSet(int length, double scale, double offset) create new dimensionless TagGenDataSet
TagGenDataSet(int length, double scale, double offset, Units units) create new TagGenDataSet

Method Summary

Modifier and Type	Method and Description
QDataSet	slice(int i) return a dataset that is a slice of this dataset, slicing on the zeroth dimension.
QDataSet	trim(int start, int end) return a dataset that is a subset of this dataset.
double	value(int i) rank 1 accessor.

Methods inherited from class org.das2.qds.AbstractRank1DataSet

length, rank

Methods inherited from class org.das2.qds.AbstractDataSet

capability, checkImmutable, isImmutable, length, length, length, makeImmutable, property, property, putProperty, putProperty, svalue, toString, value, value, value, value

Methods inherited from class java.lang.Object

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

Constructor Detail

TagGenDataSet

public TagGenDataSet(int length,
                     double scale,
                     double offset)

create new dimensionless TagGenDataSet

Parameters:

length - number of elements

scale - the increment between elements

offset - the value for the zeroth element.

TagGenDataSet

public TagGenDataSet(int length,
                     double scale,
                     double offset,
                     Units units)

create new TagGenDataSet

Parameters:

length - number of elements

scale - the increment between elements

offset - the value for the zeroth element.

units - the units of the data.

Method Detail

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.

trim

public QDataSet trim(int start,
                     int end)

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:

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

end - the exclusive index indicating the last index.

Returns:

a QDataSet with the same rank but fewer elements.

slice

public QDataSet slice(int i)

Description copied from interface: QDataSet

return a dataset that is a slice of this dataset, slicing on the zeroth dimension. A slice will be the elements at this index, for example if this dataset is a rank 2 dataset flux(Time,Energy) then the slice of this will be a rank 1 dataset flux(Energy). The result of any slice will be a qube. Note the index must be positive. Negative indices, referenced from the end of the dataset, are not supported.

Specified by:

slice in interface QDataSet

Overrides:

slice in class AbstractDataSet

Parameters:

i - the index to slice at

Returns:

the rank n-1 QDataSet at index i.