| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>org.apache.sis.coverage.grid (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.feature, package: org.apache.sis.coverage.grid"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.coverage.grid package"> |
| <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="package-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 class="nav-bar-cell1-rev">Package</li> |
| <li>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#package">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li><a href="#related-package-summary">Related Packages</a></li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-package">Module</span> <a href="../../../../../module-summary.html">org.apache.sis.feature</a></div> |
| <h1 title="Package org.apache.sis.coverage.grid" class="title">Package org.apache.sis.coverage.grid</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.coverage.grid</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">A coverage backed by a regular grid. |
| In the two-dimensional case, the grid coverage is an image and the cells are pixels. |
| In the three-dimensional case, the cells are voxels. |
| |
| <p><a href="GridCoverage2D.html" title="class in org.apache.sis.coverage.grid"><code>GridCoverage2D</code></a> |
| is a two-dimensional slice in a <var>n</var>-dimensional cube of data. |
| Despite its name, <code>GridCoverage2D</code> instances can be associated to <var>n</var>-dimensional |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">envelopes</a> providing that only two dimensions have a |
| <a href="GridExtent.html#getSize(int)"><code>grid span</code></a> greater than 1.</p> |
| |
| <p><a href="GridCoverageBuilder.html" title="class in org.apache.sis.coverage.grid"><code>GridCoverageBuilder</code></a> is a convenience class |
| making easier to create a grid coverage for some common cases.</p> |
| |
| <h2 id="accurate-definition-of-georeferencing-information-heading">Accurate definition of georeferencing information</h2> |
| While it is possible to create a grid coverage from a geodetic |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">envelope</a>, this approach should be used <em>in last resort</em> only. |
| Instead, always specify the <cite>grid to CRS</cite> affine transform. |
| This is preferable because envelopes have ambiguities |
| (do we need to swap the longitude and latitude axes? Do we need to flip the <var>y</var> axis?). |
| On the other hand, the <cite>grid to CRS</cite> affine transform is fully determinist.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.sis.coverage</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Functions that associates positions within a bounded space (its domain) to values (its range).</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exception Classes</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="BufferedGridCoverage.html" title="class in org.apache.sis.coverage.grid">BufferedGridCoverage</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Basic access to grid data values backed by a <var>n</var>-dimensional <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/DataBuffer.html" title="class or interface in java.awt.image" class="external-link"><code>DataBuffer</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DimensionalityReduction.html" title="class in org.apache.sis.coverage.grid">DimensionalityReduction</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Description about how to reduce the number of dimensions of the domain of a grid coverage.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="DisjointExtentException.html" title="class in org.apache.sis.coverage.grid">DisjointExtentException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5"> |
| <div class="block">Thrown when the domain of two grid coverages or images do not intersect.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DomainLinearizer.html" title="class in org.apache.sis.coverage.grid">DomainLinearizer</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Method for replacing a non-linear "grid to CRS" conversion by a linear conversion (affine transform).</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="FractionalGridCoordinates.html" title="class in org.apache.sis.coverage.grid">FractionalGridCoordinates</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Grid coordinates which may have fraction digits after the integer part.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="GridClippingMode.html" title="enum class in org.apache.sis.coverage.grid">GridClippingMode</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Specifies clipping behavior during computations of <a href="GridExtent.html" title="class in org.apache.sis.coverage.grid"><code>GridExtent</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="GridCoverage.html" title="class in org.apache.sis.coverage.grid">GridCoverage</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Base class of coverages with domains defined as a set of grid points.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="GridCoverage.Evaluator.html" title="interface in org.apache.sis.coverage.grid">GridCoverage.Evaluator</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Interpolates values of sample dimensions at given positions.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="GridCoverage2D.html" title="class in org.apache.sis.coverage.grid">GridCoverage2D</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Basic access to grid data values backed by a two-dimensional <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link"><code>RenderedImage</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="GridCoverageBuilder.html" title="class in org.apache.sis.coverage.grid">GridCoverageBuilder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Helper class for the creation of <a href="GridCoverage.html" title="class in org.apache.sis.coverage.grid"><code>GridCoverage</code></a> instances.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="GridCoverageProcessor.html" title="class in org.apache.sis.coverage.grid">GridCoverageProcessor</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A predefined set of operations on grid coverages.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="GridCoverageProcessor.Optimization.html" title="enum class in org.apache.sis.coverage.grid">GridCoverageProcessor.Optimization</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Types of changes that a coverage processor can do for executing an operation more efficiently.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="GridDerivation.html" title="class in org.apache.sis.coverage.grid">GridDerivation</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Creates a new grid geometry derived from a base grid geometry with different extent or resolution.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="GridExtent.html" title="class in org.apache.sis.coverage.grid">GridExtent</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A range of grid coverage coordinates, also known as "grid envelope".</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Valid extent of grid coordinates together with the transform from those grid coordinates |
| to real world coordinates.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="GridOrientation.html" title="class in org.apache.sis.coverage.grid">GridOrientation</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">High-level description about how a grid is orientated relative to the CRS axes.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="GridRoundingMode.html" title="enum class in org.apache.sis.coverage.grid">GridRoundingMode</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> |
| <div class="block">Specifies rounding behavior during computations of <a href="GridExtent.html" title="class in org.apache.sis.coverage.grid"><code>GridExtent</code></a> from floating-point values.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab5"><a href="IllegalGridGeometryException.html" title="class in org.apache.sis.coverage.grid">IllegalGridGeometryException</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab5"> |
| <div class="block">Thrown when the argument specified to a method or constructor would result in an invalid <a href="GridGeometry.html" title="class in org.apache.sis.coverage.grid"><code>GridGeometry</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ImageRenderer.html" title="class in org.apache.sis.coverage.grid">ImageRenderer</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A builder for the rendered image to be returned by <a href="GridCoverage.html#render(org.apache.sis.coverage.grid.GridExtent)"><code>GridCoverage.render(GridExtent)</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab5"><a href="IncompleteGridGeometryException.html" title="class in org.apache.sis.coverage.grid">IncompleteGridGeometryException</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab5"> |
| <div class="block">Thrown by <a href="GridGeometry.html" title="class in org.apache.sis.coverage.grid"><code>GridGeometry</code></a> when a grid geometry cannot provide the requested information.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="PixelTranslation.html" title="class in org.apache.sis.coverage.grid">PixelTranslation</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The translation to apply for different values of <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/spatial/PixelOrientation.html" title="class or interface in org.opengis.metadata.spatial" class="external-link"><code>PixelOrientation</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/PixelInCell.html" title="class or interface in org.opengis.referencing.datum" class="external-link"><code>PixelInCell</code></a>.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
