<h2>org.das2.dataset.DataSet</h2><p>General interface for objects encapsulating a data set</p>
<hr>
<a name="PROPERTY_CACHE_TAG"></a>
<h2>PROPERTY_CACHE_TAG</h2>
<p>CacheTag object describing the start, end, and resolution of the dataset.</p>

<hr>
<a name="PROPERTY_X_CACHE_RNG"></a>
<h2>PROPERTY_X_CACHE_RNG</h2>
<p>DatumRange describing the range of a dataset in the X dimension</p>

<hr>
<a name="PROPERTY_X_CACHE_RES"></a>
<h2>PROPERTY_X_CACHE_RES</h2>
<p>Datum providing the resolution in the X dimension</p>

<hr>
<a name="PROPERTY_Y_CACHE_RNG"></a>
<h2>PROPERTY_Y_CACHE_RNG</h2>
<p>DatumRange describing the range of a dataset in the X dimension</p>

<hr>
<a name="PROPERTY_Y_CACHE_RES"></a>
<h2>PROPERTY_Y_CACHE_RES</h2>
<p>Datum providing the resolution in the X dimension</p>

<hr>
<a name="PROPERTY_SIZE_BYTES"></a>
<h2>PROPERTY_SIZE_BYTES</h2>
<p>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.</p>

<hr>
<a name="PROPERTY_X_TAG_WIDTH"></a>
<h2>PROPERTY_X_TAG_WIDTH</h2>
<p>Datum which is the nominal distance between successive xTags.  This is used for example to prevent
 interpolation between distant measurements</p>

<hr>
<a name="PROPERTY_Y_TAG_WIDTH"></a>
<h2>PROPERTY_Y_TAG_WIDTH</h2>
<p>Datum, see xTagWidth</p>

<hr>
<a name="PROPERTY_X_RANGE"></a>
<h2>PROPERTY_X_RANGE</h2>
<p>DatumRange useful for setting scales</p>

<hr>
<a name="PROPERTY_X_VALID_MIN"></a>
<h2>PROPERTY_X_VALID_MIN</h2>
<p>Double, used to indicate minimum valid X value</p>

<hr>
<a name="PROPERTY_X_VALID_MAX"></a>
<h2>PROPERTY_X_VALID_MAX</h2>
<p>Double, used to indicate maximum valid X value</p>

<hr>
<a name="PROPERTY_Y_RANGE"></a>
<h2>PROPERTY_Y_RANGE</h2>
<p>Datum, useful for setting scales</p>

<hr>
<a name="PROPERTY_Y_VALID_MIN"></a>
<h2>PROPERTY_Y_VALID_MIN</h2>
<p>Double, used to indicate minimum valid X value</p>

<hr>
<a name="PROPERTY_Y_VALID_MAX"></a>
<h2>PROPERTY_Y_VALID_MAX</h2>
<p>Double, used to indicate maximum valid X value</p>

<hr>
<a name="PROPERTY_Z_RANGE"></a>
<h2>PROPERTY_Z_RANGE</h2>
<p>DatumRange useful for setting scales</p>

<hr>
<a name="PROPERTY_Z_VALID_MIN"></a>
<h2>PROPERTY_Z_VALID_MIN</h2>
<p>Double, used to indicate minimum valid X value</p>

<hr>
<a name="PROPERTY_Z_VALID_MAX"></a>
<h2>PROPERTY_Z_VALID_MAX</h2>
<p>Double, used to indicate maximum valid X value</p>

<hr>
<a name="PROPERTY_Y_FILL"></a>
<h2>PROPERTY_Y_FILL</h2>
<p>Double: Raw value used to indicate fill data.</p>

<hr>
<a name="PROPERTY_Z_FILL"></a>
<h2>PROPERTY_Z_FILL</h2>
<p>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</p>

<hr>
<a name="PROPERTY_RENDERER"></a>
<h2>PROPERTY_RENDERER</h2>
<p>suggest render method to use.  These are 
 canonical:
    spectrogram
    symbolLine
    stackedHistogram</p>

<hr>
<a name="PROPERTY_Y_SCALETYPE"></a>
<h2>PROPERTY_Y_SCALETYPE</h2>
<p>String "log" or "linear"</p>

<hr>
<a name="PROPERTY_Z_SCALETYPE"></a>
<h2>PROPERTY_Z_SCALETYPE</h2>
<p>String "log" or "linear"</p>

<hr>
<a name="PROPERTY_X_LABEL"></a>
<h2>PROPERTY_X_LABEL</h2>
<p></p>

<hr>
<a name="PROPERTY_Y_LABEL"></a>
<h2>PROPERTY_Y_LABEL</h2>
<p></p>

<hr>
<a name="PROPERTY_Z_LABEL"></a>
<h2>PROPERTY_Z_LABEL</h2>
<p></p>

<hr>
<a name="PROPERTY_X_SUMMARY"></a>
<h2>PROPERTY_X_SUMMARY</h2>
<p>A brief description of the x direction values</p>

<hr>
<a name="PROPERTY_Y_SUMMARY"></a>
<h2>PROPERTY_Y_SUMMARY</h2>
<p>A brief description of the y direction values</p>

<hr>
<a name="PROPERTY_Z_SUMMARY"></a>
<h2>PROPERTY_Z_SUMMARY</h2>
<p>A brief description of the z direction values</p>

<hr>
<a name="PROPERTY_SUMMARY"></a>
<h2>PROPERTY_SUMMARY</h2>
<p>A brief description for the entire stream</p>

<hr>
<a name="PROPERTY_X_FORMAT"></a>
<h2>PROPERTY_X_FORMAT</h2>
<p>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</p>

<hr>
<a name="PROPERTY_Y_FORMAT"></a>
<h2>PROPERTY_Y_FORMAT</h2>
<p></p>

<hr>
<a name="PROPERTY_Z_FORMAT"></a>
<h2>PROPERTY_Z_FORMAT</h2>
<p></p>

<hr>
<a name="PROPERTY_TITLE"></a>
<h2>PROPERTY_TITLE</h2>
<p>finally, this data model is done with the addition of title.</p>

<hr>
<a name="PROPERTY_X_MONOTONIC"></a>
<h2>PROPERTY_X_MONOTONIC</h2>
<p>Boolean assuring that the dataset is monotonic in X.  This allows 
 some optimizations to be made.</p>

<hr>
<a name="PROPERTY_Y_MONOTONIC"></a>
<h2>PROPERTY_Y_MONOTONIC</h2>
<p>Boolean assuring that the dataset is monotonic in Y.  This allows 
 some optimizations to be made.</p>

<hr>
<a name="PROPERTY_PLANE_PEAKS"></a>
<h2>PROPERTY_PLANE_PEAKS</h2>
<p>dataset containing the peaks when available</p>

<hr>
<a name="PROPERTY_SOURCE"></a>
<h2>PROPERTY_SOURCE</h2>
<p>Indicator that dataset is not intrinsic but was derived from some other dataset</p>

<hr>
<a name="PROPERTY_OPERATION"></a>
<h2>PROPERTY_OPERATION</h2>
<p>Indicator of which operation was performed on the input source</p>

<hr>
<a name="PROPERTY_PLANE_WEIGHTS"></a>
<h2>PROPERTY_PLANE_WEIGHTS</h2>
<p>dataset containing the weights when available</p>

<hr>
<a name="PROPERTY_FORMATTER"></a>
<h2>PROPERTY_FORMATTER</h2>
<p>DatumFormatter for formatting data in the dataset.</p>

<hr>
<a name="getPlanarView"></a>
<h2>getPlanarView</h2>
getPlanarView( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> planeID ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/dataset/DataSet.html'>org.das2.dataset.DataSet</a>

<p>Returns a <code>DataSet</code> with the specified view as the primary
 view.</p>

<h3>Parameters</h3>
planeID - the <code>String</code> id of the requested plane.

<h3>Returns:</h3>
the specified view, as a <code>DataSet</code>
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getPlanarView&unscoped_q=getPlanarView">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSet.html#getPlanarView">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="getPlaneIds"></a>
<h2>getPlaneIds</h2>
getPlaneIds(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String[]</a>

<p>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.</p>

<h3>Returns:</h3>
java.lang.String[]

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getPlaneIds&unscoped_q=getPlaneIds">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSet.html#getPlaneIds">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="getProperties"></a>
<h2>getProperties</h2>
getProperties(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Map.html'>java.util.Map</a>

<p>Returns all dataset properties in a Map.</p>

<h3>Returns:</h3>
a Map of all properties.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getProperties&unscoped_q=getProperties">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSet.html#getProperties">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="getProperty"></a>
<h2>getProperty</h2>
getProperty( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> name ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html'>Object</a>

<p>Returns the property value associated with the string <code>name</code></p>

<h3>Parameters</h3>
name - the name of the property requested

<h3>Returns:</h3>
the property value for <code>name</code> or null
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getProperty&unscoped_q=getProperty">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSet.html#getProperty">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="getXLength"></a>
<h2>getXLength</h2>
getXLength(  ) &rarr; int

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

<h3>Returns:</h3>
the number of x tags in this data set.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getXLength&unscoped_q=getXLength">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSet.html#getXLength">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="getXTagDatum"></a>
<h2>getXTagDatum</h2>
getXTagDatum( int i ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a>

<p>Returns the value of the x tag at the given index i as a
      <code>Datum</code>.</p>

<h3>Parameters</h3>
i - the index of the requested x tag

<h3>Returns:</h3>
the value of the x tag at the given index i as a
      <code>Datum</code>.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getXTagDatum&unscoped_q=getXTagDatum">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSet.html#getXTagDatum">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="getXTagDouble"></a>
<h2>getXTagDouble</h2>
getXTagDouble( int i, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> units ) &rarr; double

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

<h3>Parameters</h3>
i - the index of the requested x tag
<br>
units - the units of the returned value

<h3>Returns:</h3>
the value of the x tag at the given index i as a
      <code>double</code>.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getXTagDouble&unscoped_q=getXTagDouble">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSet.html#getXTagDouble">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="getXTagInt"></a>
<h2>getXTagInt</h2>
getXTagInt( int i, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a> units ) &rarr; int

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

<h3>Parameters</h3>
i - the index of the requested x tag
<br>
units - the units of the returned value.

<h3>Returns:</h3>
the value of the x tag at the given index i as an
      <code>int</code>.
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getXTagInt&unscoped_q=getXTagInt">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSet.html#getXTagInt">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="getXUnits"></a>
<h2>getXUnits</h2>
getXUnits(  ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a>

<p>Returns the Units object representing the unit type of the x tags
 for this data set.</p>

<h3>Returns:</h3>
the x units
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getXUnits&unscoped_q=getXUnits">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSet.html#getXUnits">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSet.java">[view source]</a>
<br>
<br>
<hr>
<a name="getYUnits"></a>
<h2>getYUnits</h2>
getYUnits(  ) &rarr; <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Units.html'>Units</a>

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

<h3>Returns:</h3>
the y units
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getYUnits&unscoped_q=getYUnits">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/dataset/DataSet.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/dataset/DataSet.html#getYUnits">[view on old javadoc]</a>
 <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/dataset/DataSet.java">[view source]</a>
<br>
<br>