<h2>org.autoplot.cdf.CdfUtil</h2><p>static methods supporting CdfFileDataSource</p> <h2>CdfUtil( )</h2> <p>Creates a new instance of CdfUtil</p> <hr> <a name="OPTION_INCLUDE_EMPTY_RECORDS"></a> <h2>OPTION_INCLUDE_EMPTY_RECORDS</h2> <p>if "true", show empty records (true is default).</p> <hr> <a name="OPTION_IS_MASTER"></a> <h2>OPTION_IS_MASTER</h2> <p>if "true", then don't show the number of records.</p> <hr> <a name="OPTION_DEEP"></a> <h2>OPTION_DEEP</h2> <p>if "true" then return more detailed descriptions in HTML</p> <hr> <a name="OPTION_DATA_ONLY"></a> <h2>OPTION_DATA_ONLY</h2> <p>if "true" return only the data variables, not the support data.</p> <hr> <a name="OPTION_RANK_LIMIT"></a> <h2>OPTION_RANK_LIMIT</h2> <p>if greater than -1, then only read variables up to this rank.</p> <hr> <a name="doApplyAttributes"></a> <h2>doApplyAttributes</h2> doApplyAttributes( <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Map.html'>java.util.Map</a> attr1, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/MutablePropertyDataSet.html'>org.das2.qds.MutablePropertyDataSet</a> result, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> os1, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> constraint ) → void <p>apply the ISTP metadata to the dataset. This is used to implement master files, where metadata from one file can override the data within another. Do not use this, as its location will probably change.</p> <h3>Parameters</h3> attr1 - the ISTP metadata <br> result - the data <br> os1 - if non-null, then modify the metadata for slice1 <br> constraint - if non-null, then drop the render type. <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=doApplyAttributes&unscoped_q=doApplyAttributes">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/cdf/CdfUtil.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/cdf/CdfUtil.html#doApplyAttributes">[view on old javadoc]</a> <br> <br> <hr> <a name="getDimensions"></a> <h2>getDimensions</h2> getDimensions( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/gov/nasa/gsfc/spdf/cdfj/CDFReader.html'>gov.nasa.gsfc.spdf.cdfj.CDFReader</a> cdf, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> variableName ) → int[] <p>This is cdf.getDimensions( variableName ), but then check varies to see if varies[0] is false (for rvariables). This will return "new int[0]" for scalar quantities like density.</p> <h3>Parameters</h3> cdf - a CDFReader <br> variableName - a String <h3>Returns:</h3> the dimensions for each record. <br><br> <a href="https://github.com/autoplot/dev/search?q=getDimensions&unscoped_q=getDimensions">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/cdf/CdfUtil.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/cdf/CdfUtil.html#getDimensions">[view on old javadoc]</a> <br> <br> <hr> <a name="getPlottable"></a> <h2>getPlottable</h2> getPlottable( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/gov/nasa/gsfc/spdf/cdfj/CDFReader.html'>gov.nasa.gsfc.spdf.cdfj.CDFReader</a> cdf, boolean dataOnly, int rankLimit ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Map.html'>java.util.Map</a> <p>Return a map where keys are the names of the variables, and values are descriptions.</p> <h3>Parameters</h3> cdf - the cdf reader reference. <br> dataOnly - show only the DATA and not SUPPORT_DATA. Note I reclaimed this parameter because I wasn't using it. <br> rankLimit - show only variables with no more than this rank. <h3>Returns:</h3> map of parameter name to short description <br><br> <a href="https://github.com/autoplot/dev/search?q=getPlottable&unscoped_q=getPlottable">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/cdf/CdfUtil.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/cdf/CdfUtil.html#getPlottable">[view on old javadoc]</a> <br> <br> getPlottable( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/gov/nasa/gsfc/spdf/cdfj/CDFReader.html'>gov.nasa.gsfc.spdf.cdfj.CDFReader</a> cdf, <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Map.html'>java.util.Map</a> options ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/util/LinkedHashMap.html'>java.util.LinkedHashMap</a><br> getPlottable( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/gov/nasa/gsfc/spdf/cdfj/CDFReader.html'>gov.nasa.gsfc.spdf.cdfj.CDFReader</a> cdf, boolean dataOnly, int rankLimit, <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Map.html'>java.util.Map</a> options ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Map.html'>java.util.Map</a><br> <hr> <a name="getRange"></a> <h2>getRange</h2> getRange( <a href='https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html'>java.util.HashMap</a> attrs ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/DatumRange.html'>DatumRange</a> <p>returns the range of the data by looking for the SCALEMIN/SCALEMAX params, or the required VALIDMIN/VALIDMAX parameters. This is not used.</p> <h3>Parameters</h3> attrs - the properties for the variable <h3>Returns:</h3> the range <br><br> <a href="https://github.com/autoplot/dev/search?q=getRange&unscoped_q=getRange">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/cdf/CdfUtil.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/cdf/CdfUtil.html#getRange">[view on old javadoc]</a> <br> <br> <hr> <a name="getScaleType"></a> <h2>getScaleType</h2> getScaleType( <a href='https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html'>java.util.HashMap</a> attrs ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> <p></p> <h3>Parameters</h3> attrs - a java.util.HashMap <h3>Returns:</h3> java.lang.String <br><br> <a href="https://github.com/autoplot/dev/search?q=getScaleType&unscoped_q=getScaleType">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/cdf/CdfUtil.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/cdf/CdfUtil.html#getScaleType">[view on old javadoc]</a> <br> <br> <hr> <a name="getStringDataType"></a> <h2>getStringDataType</h2> getStringDataType( int type ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> <p>return the data type for the encoding. From https://cdaweb.gsfc.nasa.gov/pub/software/cdf/doc/cdf380/cdf38ifd.pdf page 41.</p> <h3>Parameters</h3> type - integer type, such as 44 for CDF_FLOAT <h3>Returns:</h3> string like "CDF_FLOAT" <br><br> <a href="https://github.com/autoplot/dev/search?q=getStringDataType&unscoped_q=getStringDataType">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/cdf/CdfUtil.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/cdf/CdfUtil.html#getStringDataType">[view on old javadoc]</a> <br> <br> <hr> <a name="hasAttribute"></a> <h2>hasAttribute</h2> hasAttribute( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/gov/nasa/gsfc/spdf/cdfj/CDFReader.html'>gov.nasa.gsfc.spdf.cdfj.CDFReader</a> cdf, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> var, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> attrname ) → boolean <p>return true if the attribute is set for the variable.</p> <h3>Parameters</h3> cdf - the cdf file reader <br> var - the variable name <br> attrname - the attribute name. <h3>Returns:</h3> true if the attribute is set for the variable. <br><br> <a href="https://github.com/autoplot/dev/search?q=hasAttribute&unscoped_q=hasAttribute">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/cdf/CdfUtil.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/cdf/CdfUtil.html#hasAttribute">[view on old javadoc]</a> <br> <br> <hr> <a name="jvmMemory"></a> <h2>jvmMemory</h2> jvmMemory( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/QDataSet.html'>QDataSet</a> ds ) → int <p>returns the amount of JVM memory in bytes occupied by the dataset. This is an approximation, calculated by taking the element type size (e.g. float=4 bytes) times the number of elements for the dataset. This does not include the memory consumed by DEPEND_0, etc.</p> <h3>Parameters</h3> ds - the ArrayDataSet, or TrArrayDataSet, or BufferDataSet. <h3>Returns:</h3> the approximate memory consumption in bytes <br><br> <a href="https://github.com/autoplot/dev/search?q=jvmMemory&unscoped_q=jvmMemory">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/cdf/CdfUtil.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/cdf/CdfUtil.html#jvmMemory">[view on old javadoc]</a> <br> <br> <hr> <a name="loadVariable"></a> <h2>loadVariable</h2> loadVariable( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/gov/nasa/gsfc/spdf/cdfj/CDFReader.html'>gov.nasa.gsfc.spdf.cdfj.CDFReader</a> cdf, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> svariable ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/MutablePropertyDataSet.html'>org.das2.qds.MutablePropertyDataSet</a> <p>Return the named variable as a QDataSet. This does not look at the metadata for DEPEND_0, etc, and only adds metadata to represent time units (e.g. the data is in TT2000) and ordinal data.</p> <h3>Parameters</h3> cdf - the value of CDF <br> svariable - name of the variable <h3>Returns:</h3> the dataset <br><br> <a href="https://github.com/autoplot/dev/search?q=loadVariable&unscoped_q=loadVariable">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/cdf/CdfUtil.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/cdf/CdfUtil.html#loadVariable">[view on old javadoc]</a> <br> <br> loadVariable( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/gov/nasa/gsfc/spdf/cdfj/CDFReader.html'>gov.nasa.gsfc.spdf.cdfj.CDFReader</a> cdf, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> svariable, long recStart, long recCount, long recInterval, int slice1, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/util/monitor/ProgressMonitor.html'>ProgressMonitor</a> mon ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/MutablePropertyDataSet.html'>org.das2.qds.MutablePropertyDataSet</a><br> <hr> <a name="maybeAddValidRange"></a> <h2>maybeAddValidRange</h2> maybeAddValidRange( <a href='https://docs.oracle.com/javase/8/docs/api/java/util/Map.html'>java.util.Map</a> props, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/MutablePropertyDataSet.html'>org.das2.qds.MutablePropertyDataSet</a> ds ) → void <p>add the valid range only if it looks like it is correct. It must contain some of the data.</p> <h3>Parameters</h3> props - the properties for the variable <br> ds - the dataset to which the valid range would be added. <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=maybeAddValidRange&unscoped_q=maybeAddValidRange">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/cdf/CdfUtil.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/cdf/CdfUtil.html#maybeAddValidRange">[view on old javadoc]</a> <br> <br> <hr> <a name="maybeShorten"></a> <h2>maybeShorten</h2> maybeShorten( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> context, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> name ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> <p>abbreviate names, motivated by Cluster CDF files which have Data__C1_CP_PEA_3DRH_cnts with DEPEND_0 of time_tags__C1_CP_PEA_3DRH_cnts.</p> <h3>Parameters</h3> context - a String <br> name - a String <h3>Returns:</h3> a String <br><br> <a href="https://github.com/autoplot/dev/search?q=maybeShorten&unscoped_q=maybeShorten">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/cdf/CdfUtil.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/cdf/CdfUtil.html#maybeShorten">[view on old javadoc]</a> <br> <br> <hr> <a name="wrapCdfData"></a> <h2><del>wrapCdfData</del></h2> Deprecated: use loadCdfVariable instead wrapCdfData( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/gov/nasa/gsfc/spdf/cdfj/CDFReader.html'>gov.nasa.gsfc.spdf.cdfj.CDFReader</a> cdf, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> svariable, long recStart, long recCount, long recInterval, int slice1, boolean depend, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/util/monitor/ProgressMonitor.html'>ProgressMonitor</a> mon ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/MutablePropertyDataSet.html'>org.das2.qds.MutablePropertyDataSet</a><br>