## org.das2.dataset.DataSet

General interface for objects encapsulating a data set

## PROPERTY_CACHE_TAG

CacheTag object describing the start, end, and resolution of the dataset.

## PROPERTY_X_CACHE_RNG

DatumRange describing the range of a dataset in the X dimension

## PROPERTY_X_CACHE_RES

Datum providing the resolution in the X dimension

## PROPERTY_Y_CACHE_RNG

DatumRange describing the range of a dataset in the X dimension

## PROPERTY_Y_CACHE_RES

Datum providing the resolution in the X dimension

## PROPERTY_SIZE_BYTES

Long estimating the size of the dataset in memory. For example, if a dataset is backed by a local file, then zero for this indicates no penalty for storing this dataset.

## PROPERTY_X_TAG_WIDTH

Datum which is the nominal distance between successive xTags. This is used for example to prevent interpolation between distant measurements

## PROPERTY_Y_TAG_WIDTH

Datum, see xTagWidth

## PROPERTY_X_RANGE

DatumRange useful for setting scales

## PROPERTY_X_VALID_MIN

Double, used to indicate minimum valid X value

## PROPERTY_X_VALID_MAX

Double, used to indicate maximum valid X value

## PROPERTY_Y_RANGE

Datum, useful for setting scales

## PROPERTY_Y_VALID_MIN

Double, used to indicate minimum valid X value

## PROPERTY_Y_VALID_MAX

Double, used to indicate maximum valid X value

## PROPERTY_Z_RANGE

DatumRange useful for setting scales

## PROPERTY_Z_VALID_MIN

Double, used to indicate minimum valid X value

## PROPERTY_Z_VALID_MAX

Double, used to indicate maximum valid X value

## PROPERTY_Y_FILL

Double: Raw value used to indicate fill data.

## PROPERTY_Z_FILL

Raw value used to indicate fill data. Since yscan's are rectangular it's handy to have a fill value to indicate gaps in the rectangle

## PROPERTY_RENDERER

suggest render method to use. These are canonical: spectrogram symbolLine stackedHistogram

## PROPERTY_Y_SCALETYPE

String "log" or "linear"

## PROPERTY_Z_SCALETYPE

String "log" or "linear"

## PROPERTY_X_LABEL

## PROPERTY_Y_LABEL

## PROPERTY_Z_LABEL

## PROPERTY_X_SUMMARY

A brief description of the x direction values

## PROPERTY_Y_SUMMARY

A brief description of the y direction values

## PROPERTY_Z_SUMMARY

A brief description of the z direction values

## PROPERTY_SUMMARY

A brief description for the entire stream

## PROPERTY_X_FORMAT

The format for printing X, Y and Z items, see the Das 2.2.2 (or higher) ICD for a list of valid foramt strings

## PROPERTY_Y_FORMAT

## PROPERTY_Z_FORMAT

## PROPERTY_TITLE

finally, this data model is done with the addition of title.

## PROPERTY_X_MONOTONIC

Boolean assuring that the dataset is monotonic in X. This allows some optimizations to be made.

## PROPERTY_Y_MONOTONIC

Boolean assuring that the dataset is monotonic in Y. This allows some optimizations to be made.

## PROPERTY_PLANE_PEAKS

dataset containing the peaks when available

## PROPERTY_SOURCE

Indicator that dataset is not intrinsic but was derived from some other dataset

## PROPERTY_OPERATION

Indicator of which operation was performed on the input source

## PROPERTY_PLANE_WEIGHTS

dataset containing the weights when available

## PROPERTY_FORMATTER

DatumFormatter for formatting data in the dataset.

## getPlanarView

getPlanarView( String planeID ) → org.das2.dataset.DataSet

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

### Parameters

planeID - the `String` id of the requested plane.

### Returns:

the specified view, as a `DataSet`
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getPlaneIds

getPlaneIds( ) → String[]

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.

### Returns:

java.lang.String[]
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getProperties

getProperties( ) → java.util.Map

Returns all dataset properties in a Map.

### Returns:

a Map of all properties.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getProperty

getProperty( String name ) → Object

Returns the property value associated with the string `name`

### Parameters

name - the name of the property requested

### Returns:

the property value for `name` or null
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getXLength

getXLength( ) → int

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

### Returns:

the number of x tags in this data set.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getXTagDatum

getXTagDatum( int i ) → Datum

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

### Parameters

i - the index of the requested x tag

### Returns:

the value of the x tag at the given index i as a `Datum`.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getXTagDouble

getXTagDouble( int i, Units units ) → double

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.

### 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`.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getXTagInt

getXTagInt( int i, Units units ) → int

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.

### 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`.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getXUnits

getXUnits( ) → Units

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

### Returns:

the x units
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getYUnits

getYUnits( ) → Units

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

### Returns:

the y units
[search for examples] [view on GitHub] [view on old javadoc] [view source]