org.das2.qds

Class FDataSet

java.lang.Object

org.das2.qds.AbstractDataSet

org.das2.qds.ArrayDataSet

org.das2.qds.FDataSet

All Implemented Interfaces:

MutablePropertyDataSet, QDataSet, WritableDataSet

public final class FDataSet
extends ArrayDataSet

rank 0,1,2,3 or 4 dataset backed by float array (4 byte real numbers). Note access to the array is still done via doubles.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FDataSet.FDataSetFloatReadAccess

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	version

Fields inherited from class org.das2.qds.ArrayDataSet

logger

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

Modifier	Constructor and Description
protected	FDataSet(int rank, int len0, int len1, int len2, int len3)
protected	FDataSet(int rank, int len0, int len1, int len2, int len3, float[] back)

Method Summary

Modifier and Type	Method and Description
void	addValue(int i0, double value) add this value to the current value.
void	addValue(int i0, int i1, double value) add this value to the current value.
<T> T	capability(java.lang.Class<T> clazz) TODO: this is untested, but is left in to demonstrate how the capability method should be implemented.
static FDataSet	create(int[] qube) Makes an array from array of dimension sizes.
static FDataSet	createRank1(int len0) create a rank 1 dataset backed by array of floats.
static FDataSet	createRank2(int len0, int len1) create a rank 2 qube dataset backed by array of floats.
static FDataSet	createRank3(int len0, int len1, int len2) create a rank 3 qube dataset backed by array of floats.
static FDataSet	createRank4(int len0, int len1, int len2, int len3) create a rank 4 qube dataset backed by array of floats.
protected java.lang.Object	getBack() provide access to the backing array.
protected java.lang.Object	getBackCopy() return a copy of the backing array, to support ArrayDataSet.copy.
protected int	getBackJvmMemory() return the size of the backing in JvmMemory.
protected java.lang.Object	getBackReadOnly() return the backing array to the client, who promises not to modify the memory.
void	putProperty(java.lang.String name, java.lang.Object value) check for fill as well, since often numerical noise will corrupt the fill values.
void	putValue(double value) put a value into the rank 0 dataset.
void	putValue(int i0, double value) put a value into the rank 1 dataset.
void	putValue(int i0, int i1, double value) put a value into the rank 2 dataset.
void	putValue(int i0, int i1, int i2, double value) put a value into the rank 3 dataset.
void	putValue(int i0, int i1, int i2, int i3, double value) put a value into the rank 4 dataset.
protected void	setBack(java.lang.Object back) reset the back to this new backing array.
QDataSet	slice(int i) the slice operator is better implemented here.
QDataSet	trim(int start, int end) trim operator copies the data into a new dataset.
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.
static FDataSet	wrap(float[] back) creates a rank1 FDataSet by wrapping an existing array.
static FDataSet	wrap(float[] data, int[] qube) Wraps an array from array of dimension sizes.
static FDataSet	wrap(float[] back, int nx, int ny) creates a FDataSet by wrapping an existing array, aliasing it to rank 2.
static FDataSet	wrap(float[] back, int nx, int ny, int nz) creates a rank1 DDataSet by wrapping an existing array.
static FDataSet	wrap(float[] back, int rank, int len0, int len1, int len2) wrap the array to make it into a dataset.

Methods inherited from class org.das2.qds.ArrayDataSet

about, append, append, canAppend, checkFill, copy, copy, copy, create, create, createRank0, createRank1, createRank2, createRank3, createRank4, flattenArray, getComponentType, grow, guessBackingStore, joinProperties, jvmMemory, length, length, length, length, maybeCopy, maybeCopy, monotonicSubset, monotonicSubset2, putLength, rank, setUnits, toString, wrap

Methods inherited from class org.das2.qds.AbstractDataSet

checkImmutable, isImmutable, makeImmutable, property, property, putProperty, svalue

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

Methods inherited from interface org.das2.qds.QDataSet

property, property, svalue

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

Constructor Detail

FDataSet

protected FDataSet(int rank,
                   int len0,
                   int len1,
                   int len2,
                   int len3)

FDataSet

protected FDataSet(int rank,
                   int len0,
                   int len1,
                   int len2,
                   int len3,
                   float[] back)

Method Detail

createRank1

public static FDataSet createRank1(int len0)

create a rank 1 dataset backed by array of floats.

Parameters:

len0 - length of the dimension

Returns:

rank 1 qube dataset of backed by array of floats.

createRank2

public static FDataSet createRank2(int len0,
                                   int len1)

create a rank 2 qube dataset backed by array of floats.

Parameters:

len0 - length of the dimension

len1 - length of the dimension

Returns:

rank 2 qube dataset of backed by array of floats.

createRank3

public static FDataSet createRank3(int len0,
                                   int len1,
                                   int len2)

create a rank 3 qube dataset backed by array of floats.

Parameters:

len0 - length of the dimension

len1 - length of the dimension

len2 - length of the dimension

Returns:

rank 3 qube dataset of backed by array of floats.

createRank4

public static FDataSet createRank4(int len0,
                                   int len1,
                                   int len2,
                                   int len3)

create a rank 4 qube dataset backed by array of floats.

Parameters:

len0 - length of the dimension

len1 - length of the dimension

len2 - length of the dimension

len3 - length of the dimension

Returns:

rank 4 qube dataset of backed by array of floats.

create

public static FDataSet create(int[] qube)

Makes an array from array of dimension sizes. The result will have rank qube.length().

Parameters:

qube - array specifying the rank and size of each dimension

Returns:

the array as a QDataSet

wrap

public static FDataSet wrap(float[] data,
                            int[] qube)

Wraps an array from array of dimension sizes. The result will have rank qube.length(). For rank 0, data is 1-element array.

Parameters:

data - array containing the data, with the last dimension contiguous in memory.

qube - array specifying the rank and size of each dimension

Returns:

the array as a QDataSet

wrap

public static FDataSet wrap(float[] back,
                            int rank,
                            int len0,
                            int len1,
                            int len2)

wrap the array to make it into a dataset. This is the same as wrap( back, qube ). The data is not copied, so be sure that no outside codes modify the data unintentionally.

Parameters:

back - the array

rank - the rank of the dataset

len0 - the length, or 1 if the index is not needed.

len1 - the length, or 1 if the index is not needed.

len2 - the length, or 1 if the index is not needed.

Returns:

the dataset wrapping the array.

getBack

protected java.lang.Object getBack()

Description copied from class: ArrayDataSet

provide access to the backing array.

Specified by:

getBack in class ArrayDataSet

Returns:

the backing array for the data.

getBackJvmMemory

protected int getBackJvmMemory()

Description copied from class: ArrayDataSet

return the size of the backing in JvmMemory.

Specified by:

getBackJvmMemory in class ArrayDataSet

Returns:

the backing array for the data.

getBackReadOnly

protected java.lang.Object getBackReadOnly()

Description copied from class: ArrayDataSet

return the backing array to the client, who promises not to modify the memory.

Specified by:

getBackReadOnly in class ArrayDataSet

Returns:

the backing array for the data, which must not be modified.

getBackCopy

protected java.lang.Object getBackCopy()

Description copied from class: ArrayDataSet

return a copy of the backing array, to support ArrayDataSet.copy.

Specified by:

getBackCopy in class ArrayDataSet

Returns:

a copy of the array for the data.

setBack

protected void setBack(java.lang.Object back)

Description copied from class: ArrayDataSet

reset the back to this new backing array.

Specified by:

setBack in class ArrayDataSet

Parameters:

back - the new backing array.

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.

putValue

public void putValue(double value)

Description copied from interface: WritableDataSet

put a value into the rank 0 dataset.

Parameters:

value - the value

putValue

public void putValue(int i0,
                     double value)

Description copied from interface: WritableDataSet

put a value into the rank 1 dataset.

Parameters:

i0 - the index

value - the value

putValue

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

Description copied from interface: WritableDataSet

put a value into the rank 2 dataset.

Parameters:

i0 - the index

i1 - the index

value - the value

putValue

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

Description copied from interface: WritableDataSet

put a value into the rank 3 dataset.

Parameters:

i0 - the index

i1 - the index

i2 - the index

value - the value

putValue

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

Description copied from interface: WritableDataSet

put a value into the rank 4 dataset.

Parameters:

i0 - the index

i1 - the index

i2 - the index

i3 - the index

value - the value

addValue

public void addValue(int i0,
                     double value)

add this value to the current value.

Parameters:

i0 - the index

value - the value

addValue

public void addValue(int i0,
                     int i1,
                     double value)

add this value to the current value.

Parameters:

i0 - the index

i1 - the index

value - the value

wrap

public static FDataSet wrap(float[] back)

creates a rank1 FDataSet by wrapping an existing array.

Parameters:

back - the new backing array

Returns:

the dataset

wrap

public static FDataSet wrap(float[] back,
                            int nx,
                            int ny)

creates a FDataSet by wrapping an existing array, aliasing it to rank 2.

Parameters:

back - the new backing array

nx - number of elements in the zeroth index

ny - number of elements in the first index

Returns:

the dataset

wrap

public static FDataSet wrap(float[] back,
                            int nx,
                            int ny,
                            int nz)

creates a rank1 DDataSet by wrapping an existing array.

Parameters:

back - the new backing array

nx - number of elements in the zeroth index

ny - number of elements in the first index

nz - number of elements in the second index

Returns:

the dataset

putProperty

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

check for fill as well, since often numerical noise will corrupt the fill values.

Specified by:

putProperty in interface MutablePropertyDataSet

Overrides:

putProperty in class AbstractDataSet

Parameters:

name - the property name

value - the property value

See Also:

putProperty which properly checks mutability of the dataset, QDataSet.UNITS

slice

public QDataSet slice(int i)

the slice operator is better implemented here. Presently, we use System.arraycopy to copy out the data, but this could be re-implemented along with an offset parameter so the original data can be used to back the data.

Specified by:

slice in interface QDataSet

Overrides:

slice in class AbstractDataSet

Parameters:

i - the index

Returns:

a rank N-1 slice of the data.

trim

public QDataSet trim(int start,
                     int end)

trim operator copies the data into a new dataset.

Specified by:

trim in interface QDataSet

Overrides:

trim in class AbstractDataSet

Parameters:

start - the first index

end - the last index, exclusive

Returns:

a shorter dataset of the same rank.

capability

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

TODO: this is untested, but is left in to demonstrate how the capability method should be implemented. Clients should use this instead of casting the class to the capability class.

Specified by:

capability in interface QDataSet

Overrides:

capability in class AbstractDataSet

Type Parameters:

T -

Parameters:

clazz - the class, such as WritableDataSet.class

Returns:

null or the capability if exists, such as WritableDataSet

See Also:

LongWriteAccess, LongReadAccess, FloatReadAccess