org.das2.dataset.test

Class WavVectorDataSet

java.lang.Object

org.das2.dataset.test.WavVectorDataSet

All Implemented Interfaces:

DataSet, VectorDataSet

public abstract class WavVectorDataSet
extends java.lang.Object
implements VectorDataSet

Wraps .wav file as a VectorDataSet. The dataset will have a set of data planes for each channel identified channel0, channel1, and so on. The x values are elapsed time, and the y units are dimensionless and normalized to 0.0 to +1.0.

Field Summary

Fields inherited from interface org.das2.dataset.DataSet

PROPERTY_CACHE_TAG, PROPERTY_FORMATTER, PROPERTY_OPERATION, PROPERTY_PLANE_PEAKS, PROPERTY_PLANE_WEIGHTS, PROPERTY_RENDERER, PROPERTY_SIZE_BYTES, PROPERTY_SOURCE, PROPERTY_SUMMARY, PROPERTY_TITLE, PROPERTY_X_CACHE_RES, PROPERTY_X_CACHE_RNG, PROPERTY_X_FORMAT, PROPERTY_X_LABEL, PROPERTY_X_MONOTONIC, PROPERTY_X_RANGE, PROPERTY_X_SUMMARY, PROPERTY_X_TAG_WIDTH, PROPERTY_X_VALID_MAX, PROPERTY_X_VALID_MIN, PROPERTY_Y_CACHE_RES, PROPERTY_Y_CACHE_RNG, PROPERTY_Y_FILL, PROPERTY_Y_FORMAT, PROPERTY_Y_LABEL, PROPERTY_Y_MONOTONIC, PROPERTY_Y_RANGE, PROPERTY_Y_SCALETYPE, PROPERTY_Y_SUMMARY, PROPERTY_Y_TAG_WIDTH, PROPERTY_Y_VALID_MAX, PROPERTY_Y_VALID_MIN, PROPERTY_Z_FILL, PROPERTY_Z_FORMAT, PROPERTY_Z_LABEL, PROPERTY_Z_RANGE, PROPERTY_Z_SCALETYPE, PROPERTY_Z_SUMMARY, PROPERTY_Z_VALID_MAX, PROPERTY_Z_VALID_MIN

Method Summary

Modifier and Type	Method and Description
static WavVectorDataSet	createFromFile(java.io.File wavFile)
static WavVectorDataSet	createWavVectorDataSet(java.nio.ByteBuffer buf, javax.sound.sampled.AudioFormat audioFormat)
Datum	getDatum(int i) Returns the Y value for the given index into the x tags as a Datum.
int	getInt(int i, Units units) Returns the Y value for the given index into the x tags as a int with the given units.
DataSet	getPlanarView(java.lang.String planeID) Returns a DataSet with the specified view as the primary view.
java.lang.String[]	getPlaneIds() Returns a list of auxiliary planes (e.g.
java.util.Map	getProperties() Returns all dataset properties in a Map.
java.lang.Object	getProperty(java.lang.String name) Returns the property value associated with the string name
int	getXLength() Returns the number of x tags in this data set.
Datum	getXTagDatum(int i) Returns the value of the x tag at the given index i as a Datum.
double	getXTagDouble(int i, Units units) Returns the value of the x tag at the given index i as a double in the given units.
int	getXTagInt(int i, Units units) Returns the value of the x tag at the given index i as an int in the given units.
Units	getXUnits() Returns the Units object representing the unit type of the x tags for this data set.
Units	getYUnits() Returns the Units object representing the unit type of the y tags or y values for this data set.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.das2.dataset.VectorDataSet

getDouble

Method Detail

getPlanarView

public DataSet getPlanarView(java.lang.String planeID)

Description copied from interface: DataSet

Returns a DataSet with the specified view as the primary view.

Specified by:

getPlanarView in interface DataSet

Parameters:

planeID - the String id of the requested plane.

Returns:

the specified view, as a DataSet

getPlaneIds

public java.lang.String[] getPlaneIds()

Description copied from interface: DataSet

Returns a list of auxiliary planes (e.g. weights, peaks) for the dataset. Note that the default plane, "" may or may not be returned, based on implementations.

Specified by:

getPlaneIds in interface DataSet

createWavVectorDataSet

public static WavVectorDataSet createWavVectorDataSet(java.nio.ByteBuffer buf,
                                                      javax.sound.sampled.AudioFormat audioFormat)
                                               throws java.io.IOException

Throws:

java.io.IOException

createFromFile

public static WavVectorDataSet createFromFile(java.io.File wavFile)
                                       throws java.io.FileNotFoundException,
                                              java.io.IOException

Throws:

java.io.FileNotFoundException

java.io.IOException

getXLength

public int getXLength()

Description copied from interface: DataSet

Returns the number of x tags in this data set. XTags must be monotonically increasing with i.

Specified by:

getXLength in interface DataSet

Returns:

the number of x tags in this data set.

getXTagDouble

public double getXTagDouble(int i,
                            Units units)

Description copied from interface: DataSet

Returns the value of the x tag at the given index i as a double in the given units. XTags must be monotonically increasing with i.

Specified by:

getXTagDouble in interface DataSet

Parameters:

i - the index of the requested x tag

units - the units of the returned value

Returns:

the value of the x tag at the given index i as a double.

getXUnits

public Units getXUnits()

Description copied from interface: DataSet

Returns the Units object representing the unit type of the x tags for this data set.

Specified by:

getXUnits in interface DataSet

Returns:

the x units

getYUnits

public Units getYUnits()

Description copied from interface: DataSet

Returns the Units object representing the unit type of the y tags or y values for this data set.

Specified by:

getYUnits in interface DataSet

Returns:

the y units

getDatum

public Datum getDatum(int i)

Description copied from interface: VectorDataSet

Returns the Y value for the given index into the x tags as a Datum.

Specified by:

getDatum in interface VectorDataSet

Parameters:

i - index of the x tag for the requested value.

Returns:

the value at index location i as a Datum

getInt

public int getInt(int i,
                  Units units)

Description copied from interface: VectorDataSet

Returns the Y value for the given index into the x tags as a int with the given units.

Specified by:

getInt in interface VectorDataSet

Parameters:

i - index of the x tag for the requested value.

units - the units the returned value should be coverted to.

Returns:

the value at index location i as a int.

getProperties

public java.util.Map getProperties()

Description copied from interface: DataSet

Returns all dataset properties in a Map.

Specified by:

getProperties in interface DataSet

Returns:

a Map of all properties.

getProperty

public java.lang.Object getProperty(java.lang.String name)

Description copied from interface: DataSet

Returns the property value associated with the string name

Specified by:

getProperty in interface DataSet

Parameters:

name - the name of the property requested

Returns:

the property value for name or null

getXTagDatum

public Datum getXTagDatum(int i)

Description copied from interface: DataSet

Returns the value of the x tag at the given index i as a Datum.

Specified by:

getXTagDatum in interface DataSet

Parameters:

i - the index of the requested x tag

Returns:

the value of the x tag at the given index i as a Datum.

getXTagInt

public int getXTagInt(int i,
                      Units units)

Description copied from interface: DataSet

Returns the value of the x tag at the given index i as an int in the given units. XTags must be monotonically increasing with i.

Specified by:

getXTagInt in interface DataSet

Parameters:

i - the index of the requested x tag

units - the units of the returned value.

Returns:

the value of the x tag at the given index i as an int.