| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>DefaultSampleDimension (Apache SIS 1.4 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.metadata, package: org.apache.sis.metadata.iso.content, class: DefaultSampleDimension"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.metadata.iso.content.DefaultSampleDimension class"> |
| <meta name="keywords" content="getNumberOfValues()"> |
| <meta name="keywords" content="setNumberOfValues()"> |
| <meta name="keywords" content="getMinValue()"> |
| <meta name="keywords" content="setMinValue()"> |
| <meta name="keywords" content="getMaxValue()"> |
| <meta name="keywords" content="setMaxValue()"> |
| <meta name="keywords" content="getMeanValue()"> |
| <meta name="keywords" content="setMeanValue()"> |
| <meta name="keywords" content="getStandardDeviation()"> |
| <meta name="keywords" content="setStandardDeviation()"> |
| <meta name="keywords" content="getUnits()"> |
| <meta name="keywords" content="setUnits()"> |
| <meta name="keywords" content="getScaleFactor()"> |
| <meta name="keywords" content="setScaleFactor()"> |
| <meta name="keywords" content="getOffset()"> |
| <meta name="keywords" content="setOffset()"> |
| <meta name="keywords" content="getTransferFunctionType()"> |
| <meta name="keywords" content="setTransferFunctionType()"> |
| <meta name="keywords" content="getBitsPerValue()"> |
| <meta name="keywords" content="setBitsPerValue()"> |
| <meta name="keywords" content="getRangeElementDescriptions()"> |
| <meta name="keywords" content="setRangeElementDescriptions()"> |
| <meta name="keywords" content="getNominalSpatialResolution()"> |
| <meta name="keywords" content="setNominalSpatialResolution()"> |
| <meta name="keywords" content="getOtherPropertyType()"> |
| <meta name="keywords" content="setOtherPropertyType()"> |
| <meta name="keywords" content="getOtherProperty()"> |
| <meta name="keywords" content="setOtherProperty()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li><a href="#nested-class-summary">Nested</a></li> |
| <li><a href="#field-summary">Field</a></li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../../../module-summary.html">org.apache.sis.metadata</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.metadata.iso.content</a></div> |
| <h1 title="Class DefaultSampleDimension" class="title">Class DefaultSampleDimension</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="../../AbstractMetadata.html" title="class in org.apache.sis.metadata">AbstractMetadata</a> |
| <div class="inheritance"><a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a> |
| <div class="inheritance"><a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a> |
| <div class="inheritance"><a href="DefaultRangeDimension.html" title="class in org.apache.sis.metadata.iso.content">DefaultRangeDimension</a> |
| <div class="inheritance">DefaultSampleDimension</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../../../../../../../org.apache.sis.util/org/apache/sis/util/Emptiable.html" title="interface in org.apache.sis.util">Emptiable</a></code>, <code><a href="../../../../../../../org.apache.sis.util/org/apache/sis/util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code>, <code><a href="../../../xml/IdentifiedObject.html" title="interface in org.apache.sis.xml">IdentifiedObject</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/RangeDimension.html" title="class or interface in org.opengis.metadata.content" class="external-link">RangeDimension</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="DefaultBand.html" title="class in org.apache.sis.metadata.iso.content">DefaultBand</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="MD_SampleDimension", |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>) |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">DefaultSampleDimension</span> |
| <span class="extends-implements">extends <a href="DefaultRangeDimension.html" title="class in org.apache.sis.metadata.iso.content">DefaultRangeDimension</a></span></div> |
| <div class="block">The characteristic of each dimension (layer) included in the resource. |
| The following property is conditional (i.e. mandatory under some circumstances) |
| in a well-formed metadata according ISO 19115: |
| |
| <div class="preformat"><code>MD_SampleDimension</code> |
| <code> └─units………………………</code> Units of data in each dimension included in the resource.</div> |
| |
| <div class="warning"><b>Note on International Standard versions</b><br> |
| This class is derived from a new type defined in the ISO 19115 international standard published in 2014, |
| while GeoAPI 3.0 is based on the version published in 2003. Consequently this implementation class does |
| not yet implement a GeoAPI interface, but is expected to do so after the next GeoAPI releases. |
| When the interface will become available, all references to this implementation class in Apache SIS will |
| be replaced be references to the <code>SampleDimension</code> interface. |
| </div> |
| |
| <h2 id="terminology-heading">Terminology</h2> |
| <cite>Data values</cite> should be physical values expressed in the unit of measurement |
| given by <a href="#getUnits()"><code>getUnits()</code></a>. <cite>Cell values</cite> are values stored in the device, |
| before conversion to data values by application of <a href="#getScaleFactor()">scale |
| factor</a> and <a href="#getOffset()">offset</a>. |
| |
| <h2 id="limitations-heading">Limitations</h2> |
| <ul> |
| <li>Instances of this class are not synchronized for multi-threading. |
| Synchronization, if needed, is caller's responsibility.</li> |
| <li>Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. |
| Serialization support is appropriate for short term storage or RMI between applications running the |
| same version of Apache SIS. For long term storage, use <a href="../../../xml/XML.html" title="class in org.apache.sis.xml"><code>XML</code></a> instead.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.5</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="../../../../../../../serialized-form.html#org.apache.sis.metadata.iso.content.DefaultSampleDimension">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.sis.metadata.ModifiableMetadata">Nested classes/interfaces inherited from class <a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></h2> |
| <code><a href="../../ModifiableMetadata.State.html" title="enum class in org.apache.sis.metadata">ModifiableMetadata.State</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-ISOMetadata">Fields inherited from class <a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></h3> |
| <code><a href="../ISOMetadata.html#identifiers">identifiers</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">DefaultSampleDimension</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs an initially empty sample dimension.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.metadata.iso.content.DefaultSampleDimension)" class="member-name-link">DefaultSampleDimension</a><wbr>(<a href="DefaultSampleDimension.html" title="class in org.apache.sis.metadata.iso.content">DefaultSampleDimension</a> object)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Constructs a new instance initialized with the values from the specified metadata object.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBitsPerValue()" class="member-name-link">getBitsPerValue</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the maximum number of significant bits in the uncompressed representation |
| for the value in each band of each pixel.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxValue()" class="member-name-link">getMaxValue</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the maximum value of data values in each dimension included in the resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMeanValue()" class="member-name-link">getMeanValue</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the mean value of data values in each dimension included in the resource.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinValue()" class="member-name-link">getMinValue</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the minimum value of data values in each dimension included in the resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNominalSpatialResolution()" class="member-name-link">getNominalSpatialResolution</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the smallest distance between which separate points can be distinguished, |
| as specified in instrument design.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumberOfValues()" class="member-name-link">getNumberOfValues</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of values used in a thematic classification resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOffset()" class="member-name-link">getOffset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the physical value corresponding to a cell value of zero.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/Record.html" title="class or interface in org.opengis.util" class="external-link">Record</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOtherProperty()" class="member-name-link">getOtherProperty</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns instance of other/attributeType that defines attributes not explicitly |
| included in <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/CoverageContentType.html" title="class or interface in org.opengis.metadata.content" class="external-link"><code>CoverageContentType</code></a>, or <code>null</code> if none.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/RecordType.html" title="class or interface in org.opengis.util" class="external-link">RecordType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOtherPropertyType()" class="member-name-link">getOtherPropertyType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns type of other attribute description.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><wbr><<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/RangeElementDescription.html" title="class or interface in org.opengis.metadata.content" class="external-link">RangeElementDescription</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRangeElementDescriptions()" class="member-name-link">getRangeElementDescriptions</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Provides the description and values of the specific range elements of a sample dimension.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScaleFactor()" class="member-name-link">getScaleFactor</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the scale factor which has been applied to the cell value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStandardDeviation()" class="member-name-link">getStandardDeviation</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the standard deviation of data values in each dimension included in the resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/TransferFunctionType.html" title="class or interface in org.opengis.metadata.content" class="external-link">TransferFunctionType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTransferFunctionType()" class="member-name-link">getTransferFunctionType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns type of transfer function to be used when scaling a physical value for a given element.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html" title="class or interface in javax.measure" class="external-link">Unit</a><wbr><?></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUnits()" class="member-name-link">getUnits</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the units of data in the dimension.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBitsPerValue(java.lang.Integer)" class="member-name-link">setBitsPerValue</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> newValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the maximum number of significant bits in the uncompressed representation |
| for the value in each band of each pixel.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxValue(java.lang.Double)" class="member-name-link">setMaxValue</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the maximum value of data values in each dimension included in the resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMeanValue(java.lang.Double)" class="member-name-link">setMeanValue</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the mean value of data values in each dimension included in the resource.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMinValue(java.lang.Double)" class="member-name-link">setMinValue</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the minimum value of data values in each dimension included in the resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNominalSpatialResolution(java.lang.Double)" class="member-name-link">setNominalSpatialResolution</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the smallest distance between which separate points can be distinguished, |
| as specified in instrument design.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNumberOfValues(java.lang.Integer)" class="member-name-link">setNumberOfValues</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> newValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the number of values used in a thematic classification resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOffset(java.lang.Double)" class="member-name-link">setOffset</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the physical value corresponding to a cell value of zero.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOtherProperty(org.opengis.util.Record)" class="member-name-link">setOtherProperty</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/Record.html" title="class or interface in org.opengis.util" class="external-link">Record</a> newValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets a new instance of other/attributeType that defines attributes not explicitly |
| included in <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/CoverageContentType.html" title="class or interface in org.opengis.metadata.content" class="external-link"><code>CoverageContentType</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOtherPropertyType(org.opengis.util.RecordType)" class="member-name-link">setOtherPropertyType</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/RecordType.html" title="class or interface in org.opengis.util" class="external-link">RecordType</a> newValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets a new type of other attribute description.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRangeElementDescriptions(java.util.Collection)" class="member-name-link">setRangeElementDescriptions</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><? extends <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/RangeElementDescription.html" title="class or interface in org.opengis.metadata.content" class="external-link">RangeElementDescription</a>> newValues)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the description and values of the specific range elements of a sample dimension.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setScaleFactor(java.lang.Double)" class="member-name-link">setScaleFactor</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the scale factor which has been applied to the cell value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStandardDeviation(java.lang.Double)" class="member-name-link">setStandardDeviation</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the standard deviation of data values in each dimension included in the resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTransferFunctionType(org.opengis.metadata.content.TransferFunctionType)" class="member-name-link">setTransferFunctionType</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/TransferFunctionType.html" title="class or interface in org.opengis.metadata.content" class="external-link">TransferFunctionType</a> newValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the type of transfer function to be used when scaling a physical value for a given element.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUnits(javax.measure.Unit)" class="member-name-link">setUnits</a><wbr>(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html" title="class or interface in javax.measure" class="external-link">Unit</a><?> newValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the units of data in the dimension.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-DefaultRangeDimension">Methods inherited from class <a href="DefaultRangeDimension.html" title="class in org.apache.sis.metadata.iso.content">DefaultRangeDimension</a></h3> |
| <code><a href="DefaultRangeDimension.html#castOrCopy(org.opengis.metadata.content.RangeDimension)">castOrCopy</a>, <a href="DefaultRangeDimension.html#getDescription()">getDescription</a>, <a href="DefaultRangeDimension.html#getDescriptor()">getDescriptor</a>, <a href="DefaultRangeDimension.html#getNames()">getNames</a>, <a href="DefaultRangeDimension.html#getSequenceIdentifier()">getSequenceIdentifier</a>, <a href="DefaultRangeDimension.html#setDescription(org.opengis.util.InternationalString)">setDescription</a>, <a href="DefaultRangeDimension.html#setDescriptor(org.opengis.util.InternationalString)">setDescriptor</a>, <a href="DefaultRangeDimension.html#setNames(java.util.Collection)">setNames</a>, <a href="DefaultRangeDimension.html#setSequenceIdentifier(org.opengis.util.MemberName)">setSequenceIdentifier</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-ISOMetadata">Methods inherited from class <a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></h3> |
| <code><a href="../ISOMetadata.html#getIdentifier()">getIdentifier</a>, <a href="../ISOMetadata.html#getIdentifierMap()">getIdentifierMap</a>, <a href="../ISOMetadata.html#getIdentifiers()">getIdentifiers</a>, <a href="../ISOMetadata.html#getStandard()">getStandard</a>, <a href="../ISOMetadata.html#setIdentifier(org.opengis.metadata.Identifier)">setIdentifier</a>, <a href="../ISOMetadata.html#transitionTo(org.apache.sis.metadata.ModifiableMetadata.State)">transitionTo</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-ModifiableMetadata">Methods inherited from class <a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></h3> |
| <code><a href="../../ModifiableMetadata.html#checkWritePermission(java.lang.Object)">checkWritePermission</a>, <a href="../../ModifiableMetadata.html#collectionType(java.lang.Class)">collectionType</a>, <a href="../../ModifiableMetadata.html#copyCollection(java.util.Collection,java.lang.Class)">copyCollection</a>, <a href="../../ModifiableMetadata.html#copyList(java.util.Collection,java.lang.Class)">copyList</a>, <a href="../../ModifiableMetadata.html#copyMap(java.util.Map,java.lang.Class)">copyMap</a>, <a href="../../ModifiableMetadata.html#copySet(java.util.Collection,java.lang.Class)">copySet</a>, <a href="../../ModifiableMetadata.html#deepCopy(org.apache.sis.metadata.ModifiableMetadata.State)">deepCopy</a>, <a href="../../ModifiableMetadata.html#nonNullCollection(java.util.Collection,java.lang.Class)">nonNullCollection</a>, <a href="../../ModifiableMetadata.html#nonNullList(java.util.List,java.lang.Class)">nonNullList</a>, <a href="../../ModifiableMetadata.html#nonNullMap(java.util.Map,java.lang.Class)">nonNullMap</a>, <a href="../../ModifiableMetadata.html#nonNullSet(java.util.Set,java.lang.Class)">nonNullSet</a>, <a href="../../ModifiableMetadata.html#singleton(E,java.lang.Class)">singleton</a>, <a href="../../ModifiableMetadata.html#state()">state</a>, <a href="../../ModifiableMetadata.html#writeCollection(java.util.Collection,java.util.Collection,java.lang.Class)">writeCollection</a>, <a href="../../ModifiableMetadata.html#writeList(java.util.Collection,java.util.List,java.lang.Class)">writeList</a>, <a href="../../ModifiableMetadata.html#writeMap(java.util.Map,java.util.Map,java.lang.Class)">writeMap</a>, <a href="../../ModifiableMetadata.html#writeSet(java.util.Collection,java.util.Set,java.lang.Class)">writeSet</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-AbstractMetadata">Methods inherited from class <a href="../../AbstractMetadata.html" title="class in org.apache.sis.metadata">AbstractMetadata</a></h3> |
| <code><a href="../../AbstractMetadata.html#asMap()">asMap</a>, <a href="../../AbstractMetadata.html#asTreeTable()">asTreeTable</a>, <a href="../../AbstractMetadata.html#equals(java.lang.Object)">equals</a>, <a href="../../AbstractMetadata.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a>, <a href="../../AbstractMetadata.html#getInterface()">getInterface</a>, <a href="../../AbstractMetadata.html#hashCode()">hashCode</a>, <a href="../../AbstractMetadata.html#isEmpty()">isEmpty</a>, <a href="../../AbstractMetadata.html#prune()">prune</a>, <a href="../../AbstractMetadata.html#toString()">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>DefaultSampleDimension</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DefaultSampleDimension</span>()</div> |
| <div class="block">Constructs an initially empty sample dimension.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.sis.metadata.iso.content.DefaultSampleDimension)"> |
| <h3>DefaultSampleDimension</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DefaultSampleDimension</span><wbr><span class="parameters">(<a href="DefaultSampleDimension.html" title="class in org.apache.sis.metadata.iso.content">DefaultSampleDimension</a> object)</span></div> |
| <div class="block">Constructs a new instance initialized with the values from the specified metadata object. |
| This is a <em>shallow</em> copy constructor, because the other metadata contained in the |
| given object are not recursively copied. |
| |
| <h4 id="note-on-properties-validation-heading">Note on properties validation</h4> |
| This constructor does not verify the property values of the given metadata (e.g. whether it contains |
| unexpected negative values). This is because invalid metadata exist in practice, and verifying their |
| validity in this copy constructor is often too late. Note that this is not the only hole, as invalid |
| metadata instances can also be obtained by unmarshalling an invalid XML document.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>object</code> - the metadata to copy values from, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getNumberOfValues()"> |
| <h3>getNumberOfValues</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html" title="annotation interface in org.apache.sis.measure">@ValueRange</a>(<a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html#minimum()">minimum</a>=0.0) |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="numberOfValues", |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#OPTIONAL" title="class or interface in org.opengis.annotation" class="external-link">OPTIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">getNumberOfValues</span>()</div> |
| <div class="block">Returns the number of values used in a thematic classification resource.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the number of values used in a thematic classification resource, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setNumberOfValues(java.lang.Integer)"> |
| <h3>setNumberOfValues</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setNumberOfValues</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> newValue)</span></div> |
| <div class="block">Sets the number of values used in a thematic classification resource.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new number of values used in a thematic classification resource.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is negative.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMinValue()"> |
| <h3>getMinValue</h3> |
| <div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="minValue", |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#OPTIONAL" title="class or interface in org.opengis.annotation" class="external-link">OPTIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></span> <span class="element-name">getMinValue</span>()</div> |
| <div class="block">Returns the minimum value of data values in each dimension included in the resource. |
| This value should be expressed in the unit of measurement given by <a href="#getUnits()"><code>getUnits()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>minimum value of data values in each dimension included in the resource, or <code>null</code> if unspecified.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMinValue(java.lang.Double)"> |
| <h3>setMinValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMinValue</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</span></div> |
| <div class="block">Sets the minimum value of data values in each dimension included in the resource. |
| This value should be expressed in the unit of measurement given by <a href="#getUnits()"><code>getUnits()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new new minimum value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxValue()"> |
| <h3>getMaxValue</h3> |
| <div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="maxValue", |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#OPTIONAL" title="class or interface in org.opengis.annotation" class="external-link">OPTIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></span> <span class="element-name">getMaxValue</span>()</div> |
| <div class="block">Returns the maximum value of data values in each dimension included in the resource. |
| This value should be expressed in the unit of measurement given by <a href="#getUnits()"><code>getUnits()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>maximum value of data values in each dimension included in the resource, or <code>null</code> if unspecified.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMaxValue(java.lang.Double)"> |
| <h3>setMaxValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaxValue</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</span></div> |
| <div class="block">Sets the maximum value of data values in each dimension included in the resource. |
| This value should be expressed in the unit of measurement given by <a href="#getUnits()"><code>getUnits()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new new maximum value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMeanValue()"> |
| <h3>getMeanValue</h3> |
| <div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="meanValue", |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#OPTIONAL" title="class or interface in org.opengis.annotation" class="external-link">OPTIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></span> <span class="element-name">getMeanValue</span>()</div> |
| <div class="block">Returns the mean value of data values in each dimension included in the resource. |
| This value should be expressed in the unit of measurement given by <a href="#getUnits()"><code>getUnits()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the mean value of data values in each dimension included in the resource, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMeanValue(java.lang.Double)"> |
| <h3>setMeanValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMeanValue</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</span></div> |
| <div class="block">Sets the mean value of data values in each dimension included in the resource. |
| This value should be expressed in the unit of measurement given by <a href="#getUnits()"><code>getUnits()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new mean value of data values in each dimension included in the resource.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStandardDeviation()"> |
| <h3>getStandardDeviation</h3> |
| <div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="standardDeviation", |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#OPTIONAL" title="class or interface in org.opengis.annotation" class="external-link">OPTIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></span> <span class="element-name">getStandardDeviation</span>()</div> |
| <div class="block">Returns the standard deviation of data values in each dimension included in the resource. |
| This value should be expressed in the unit of measurement given by <a href="#getUnits()"><code>getUnits()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>standard deviation of data values in each dimension included in the resource, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStandardDeviation(java.lang.Double)"> |
| <h3>setStandardDeviation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStandardDeviation</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</span></div> |
| <div class="block">Sets the standard deviation of data values in each dimension included in the resource. |
| This value should be expressed in the unit of measurement given by <a href="#getUnits()"><code>getUnits()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new standard deviation of data values in each dimension included in the resource.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnits()"> |
| <h3>getUnits</h3> |
| <div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="units", |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#CONDITIONAL" title="class or interface in org.opengis.annotation" class="external-link">CONDITIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html" title="class or interface in javax.measure" class="external-link">Unit</a><?></span> <span class="element-name">getUnits</span>()</div> |
| <div class="block">Returns the units of data in the dimension.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the units of data in the dimension, or <code>null</code> if unspecified.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUnits(javax.measure.Unit)"> |
| <h3>setUnits</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setUnits</span><wbr><span class="parameters">(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html" title="class or interface in javax.measure" class="external-link">Unit</a><?> newValue)</span></div> |
| <div class="block">Sets the units of data in the dimension.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new units of data in the dimension.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScaleFactor()"> |
| <h3>getScaleFactor</h3> |
| <div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="scaleFactor", |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#OPTIONAL" title="class or interface in org.opengis.annotation" class="external-link">OPTIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></span> <span class="element-name">getScaleFactor</span>()</div> |
| <div class="block">Returns the scale factor which has been applied to the cell value.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>scale factor which has been applied to the cell value, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setScaleFactor(java.lang.Double)"> |
| <h3>setScaleFactor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setScaleFactor</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</span></div> |
| <div class="block">Sets the scale factor which has been applied to the cell value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new scale factor which has been applied to the cell value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOffset()"> |
| <h3>getOffset</h3> |
| <div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="offset", |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#OPTIONAL" title="class or interface in org.opengis.annotation" class="external-link">OPTIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></span> <span class="element-name">getOffset</span>()</div> |
| <div class="block">Returns the physical value corresponding to a cell value of zero.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the physical value corresponding to a cell value of zero, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setOffset(java.lang.Double)"> |
| <h3>setOffset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setOffset</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</span></div> |
| <div class="block">Sets the physical value corresponding to a cell value of zero.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new physical value corresponding to a cell value of zero.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTransferFunctionType()"> |
| <h3>getTransferFunctionType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/TransferFunctionType.html" title="class or interface in org.opengis.metadata.content" class="external-link">TransferFunctionType</a></span> <span class="element-name">getTransferFunctionType</span>()</div> |
| <div class="block">Returns type of transfer function to be used when scaling a physical value for a given element. |
| |
| <h4 id="note-on-xml-marshalling-heading">Note on XML marshalling</h4> |
| ISO 19115-2 defines this property in <a href="DefaultBand.html" title="class in org.apache.sis.metadata.iso.content">a subtype</a> for historical reasons. |
| Apache SIS moves this property up in the hierarchy since this property can apply to any sample dimension, |
| not only the measurements in the electromagnetic spectrum. However, this property will not appear in XML |
| documents unless this <code>SampleDimension</code> is actually a <code>Band</code>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>type of transfer function, or <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTransferFunctionType(org.opengis.metadata.content.TransferFunctionType)"> |
| <h3>setTransferFunctionType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTransferFunctionType</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/TransferFunctionType.html" title="class or interface in org.opengis.metadata.content" class="external-link">TransferFunctionType</a> newValue)</span></div> |
| <div class="block">Sets the type of transfer function to be used when scaling a physical value for a given element.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new transfer function value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBitsPerValue()"> |
| <h3>getBitsPerValue</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html" title="annotation interface in org.apache.sis.measure">@ValueRange</a>(<a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html#minimum()">minimum</a>=1.0) |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="bitsPerValue", |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#OPTIONAL" title="class or interface in org.opengis.annotation" class="external-link">OPTIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">getBitsPerValue</span>()</div> |
| <div class="block">Returns the maximum number of significant bits in the uncompressed representation |
| for the value in each band of each pixel.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>maximum number of significant bits in the uncompressed representation |
| for the value in each band of each pixel, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBitsPerValue(java.lang.Integer)"> |
| <h3>setBitsPerValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setBitsPerValue</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> newValue)</span></div> |
| <div class="block">Sets the maximum number of significant bits in the uncompressed representation |
| for the value in each band of each pixel.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new maximum number of significant bits.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is zero or negative.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRangeElementDescriptions()"> |
| <h3>getRangeElementDescriptions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/RangeElementDescription.html" title="class or interface in org.opengis.metadata.content" class="external-link">RangeElementDescription</a>></span> <span class="element-name">getRangeElementDescriptions</span>()</div> |
| <div class="block">Provides the description and values of the specific range elements of a sample dimension. |
| Example: missing data.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>description and values of the specific range elements.</dd> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRangeElementDescriptions(java.util.Collection)"> |
| <h3>setRangeElementDescriptions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRangeElementDescriptions</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><? extends <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/RangeElementDescription.html" title="class or interface in org.opengis.metadata.content" class="external-link">RangeElementDescription</a>> newValues)</span></div> |
| <div class="block">Sets the description and values of the specific range elements of a sample dimension.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValues</code> - the new range element description.</dd> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNominalSpatialResolution()"> |
| <h3>getNominalSpatialResolution</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html" title="annotation interface in org.apache.sis.measure">@ValueRange</a>(<a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html#minimum()">minimum</a>=0.0, |
| <a href="../../../../../../../org.apache.sis.util/org/apache/sis/measure/ValueRange.html#isMinIncluded()">isMinIncluded</a>=false) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a></span> <span class="element-name">getNominalSpatialResolution</span>()</div> |
| <div class="block">Returns the smallest distance between which separate points can be distinguished, |
| as specified in instrument design. |
| |
| <h4 id="note-on-xml-marshalling-heading1">Note on XML marshalling</h4> |
| ISO 19115-2 defines this property in <a href="DefaultBand.html" title="class in org.apache.sis.metadata.iso.content">a subtype</a> for historical reasons. |
| Apache SIS moves this property up in the hierarchy since this property can apply to any sample dimension, |
| not only the measurements in the electromagnetic spectrum. However, this property will not appear in XML |
| documents unless this <code>SampleDimension</code> is actually a <code>Band</code>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>smallest distance between which separate points can be distinguished, or <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setNominalSpatialResolution(java.lang.Double)"> |
| <h3>setNominalSpatialResolution</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setNominalSpatialResolution</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a> newValue)</span></div> |
| <div class="block">Sets the smallest distance between which separate points can be distinguished, |
| as specified in instrument design.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new nominal spatial resolution.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given value is negative.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOtherPropertyType()"> |
| <h3>getOtherPropertyType</h3> |
| <div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="otherPropertyType", |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#OPTIONAL" title="class or interface in org.opengis.annotation" class="external-link">OPTIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/RecordType.html" title="class or interface in org.opengis.util" class="external-link">RecordType</a></span> <span class="element-name">getOtherPropertyType</span>()</div> |
| <div class="block">Returns type of other attribute description.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>type of other attribute description, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setOtherPropertyType(org.opengis.util.RecordType)"> |
| <h3>setOtherPropertyType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setOtherPropertyType</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/RecordType.html" title="class or interface in org.opengis.util" class="external-link">RecordType</a> newValue)</span></div> |
| <div class="block">Sets a new type of other attribute description.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new type of other attribute description.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOtherProperty()"> |
| <h3>getOtherProperty</h3> |
| <div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="otherProperty", |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#OPTIONAL" title="class or interface in org.opengis.annotation" class="external-link">OPTIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/Record.html" title="class or interface in org.opengis.util" class="external-link">Record</a></span> <span class="element-name">getOtherProperty</span>()</div> |
| <div class="block">Returns instance of other/attributeType that defines attributes not explicitly |
| included in <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/CoverageContentType.html" title="class or interface in org.opengis.metadata.content" class="external-link"><code>CoverageContentType</code></a>, or <code>null</code> if none.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>instance of other/attributeType that defines attributes, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setOtherProperty(org.opengis.util.Record)"> |
| <h3>setOtherProperty</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setOtherProperty</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/Record.html" title="class or interface in org.opengis.util" class="external-link">Record</a> newValue)</span></div> |
| <div class="block">Sets a new instance of other/attributeType that defines attributes not explicitly |
| included in <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/content/CoverageContentType.html" title="class or interface in org.opengis.metadata.content" class="external-link"><code>CoverageContentType</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - the new instance of other/attributeType.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
