| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>GridCoverage.Evaluator (Apache SIS 1.3 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="description" content="declaration: package: org.apache.sis.coverage.grid, class: GridCoverage, interface: Evaluator"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.coverage.grid.GridCoverage.Evaluator interface"> |
| <meta name="keywords" content="getCoverage()"> |
| <meta name="keywords" content="getDefaultSlice()"> |
| <meta name="keywords" content="setDefaultSlice()"> |
| <meta name="keywords" content="toGridCoordinates()"> |
| <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"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.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="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/GridCoverage.Evaluator.html">Use</a></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>Nested</li> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.coverage.grid</a></div> |
| <h1 title="Interface GridCoverage.Evaluator" class="title">Interface GridCoverage.Evaluator</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../BandedCoverage.Evaluator.html" title="interface in org.apache.sis.coverage">BandedCoverage.Evaluator</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/DirectPosition.html" title="class or interface in org.opengis.geometry" class="external-link">DirectPosition</a>,<wbr>double[]></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><code><a href="GridCoverage.html" title="class in org.apache.sis.coverage.grid">GridCoverage</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">GridCoverage.Evaluator</span><span class="extends-implements"> |
| extends <a href="../BandedCoverage.Evaluator.html" title="interface in org.apache.sis.coverage">BandedCoverage.Evaluator</a></span></div> |
| <div class="block">Interpolates values of sample dimensions at given positions. |
| Values are computed by calls to <a href="../BandedCoverage.Evaluator.html#apply(org.opengis.geometry.DirectPosition)"><code>BandedCoverage.Evaluator.apply(DirectPosition)</code></a> and are returned as <code>double[]</code>. |
| This method extends <a href="../BandedCoverage.Evaluator.html" title="interface in org.apache.sis.coverage"><code>BandedCoverage.Evaluator</code></a> with the addition of some methods specific to |
| gridded data. |
| |
| <h2>Multi-threading</h2> |
| Evaluators are not thread-safe. An instance of <code>Evaluator</code> should be created |
| for each thread that need to interpolate sample values.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="GridCoverage.html#evaluator()"><code>GridCoverage.evaluator()</code></a></li> |
| </ul> |
| </dd> |
| |
| <p><font size="-1">Defined in the <code>sis-feature</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code><a href="GridCoverage.html" title="class in org.apache.sis.coverage.grid">GridCoverage</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCoverage()" class="member-name-link">getCoverage</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the coverage from which this evaluator is fetching sample values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDefaultSlice()" class="member-name-link">getDefaultSlice</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the default slice where to perform evaluation, or an empty map if unspecified.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setDefaultSlice(java.util.Map)" class="member-name-link">setDefaultSlice</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> slice)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the default slice where to perform evaluation when the points do not have enough dimensions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="FractionalGridCoordinates.html" title="class in org.apache.sis.coverage.grid">FractionalGridCoordinates</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toGridCoordinates(org.opengis.geometry.DirectPosition)" class="member-name-link">toGridCoordinates</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/DirectPosition.html" title="class or interface in org.opengis.geometry" class="external-link">DirectPosition</a> point)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Converts the specified geospatial position to grid coordinates.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-BandedCoverage.Evaluator">Methods inherited from interface <a href="../BandedCoverage.Evaluator.html" title="interface in org.apache.sis.coverage">BandedCoverage.Evaluator</a></h3> |
| <code><a href="../BandedCoverage.Evaluator.html#apply(org.opengis.geometry.DirectPosition)">apply</a>, <a href="../BandedCoverage.Evaluator.html#isNullIfOutside()">isNullIfOutside</a>, <a href="../BandedCoverage.Evaluator.html#isWraparoundEnabled()">isWraparoundEnabled</a>, <a href="../BandedCoverage.Evaluator.html#setNullIfOutside(boolean)">setNullIfOutside</a>, <a href="../BandedCoverage.Evaluator.html#setWraparoundEnabled(boolean)">setWraparoundEnabled</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Function">Methods inherited from interface <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Function.html#andThen(java.util.function.Function)" title="class or interface in java.util.function" class="external-link">andThen</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Function.html#compose(java.util.function.Function)" title="class or interface in java.util.function" class="external-link">compose</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getCoverage()"> |
| <h3>getCoverage</h3> |
| <div class="member-signature"><span class="return-type"><a href="GridCoverage.html" title="class in org.apache.sis.coverage.grid">GridCoverage</a></span> <span class="element-name">getCoverage</span>()</div> |
| <div class="block">Returns the coverage from which this evaluator is fetching sample values. |
| This is the coverage on which the <a href="GridCoverage.html#evaluator()"><code>GridCoverage.evaluator()</code></a> method has been invoked.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../BandedCoverage.Evaluator.html#getCoverage()">getCoverage</a></code> in interface <code><a href="../BandedCoverage.Evaluator.html" title="interface in org.apache.sis.coverage">BandedCoverage.Evaluator</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the source of sample values for this evaluator.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDefaultSlice()"> |
| <h3>getDefaultSlice</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span> <span class="element-name">getDefaultSlice</span>()</div> |
| <div class="block">Returns the default slice where to perform evaluation, or an empty map if unspecified. |
| Keys are dimensions from 0 inclusive to <a href="GridGeometry.html#getDimension()"><code>GridGeometry.getDimension()</code></a> exclusive, |
| and values are the grid coordinates of the slice in the dimension specified by the key. |
| |
| <p>This information allows to invoke <a href="../BandedCoverage.Evaluator.html#apply(org.opengis.geometry.DirectPosition)"><code>BandedCoverage.Evaluator.apply(DirectPosition)</code></a> with for example |
| two-dimensional points even if the underlying coverage is three-dimensional. |
| The missing coordinate values are replaced by the values provided in the map.</p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the default slice where to perform evaluation, or an empty map if unspecified.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDefaultSlice(java.util.Map)"> |
| <h3>setDefaultSlice</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setDefaultSlice</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> slice)</span></div> |
| <div class="block">Sets the default slice where to perform evaluation when the points do not have enough dimensions. |
| A <code>null</code> argument restores the default value, which is to infer the slice from the coverage |
| grid geometry.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>slice</code> - the default slice where to perform evaluation, or an empty map if none.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the map contains an illegal dimension or grid coordinate value.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="GridExtent.html#getSliceCoordinates()"><code>GridExtent.getSliceCoordinates()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toGridCoordinates(org.opengis.geometry.DirectPosition)"> |
| <h3>toGridCoordinates</h3> |
| <div class="member-signature"><span class="return-type"><a href="FractionalGridCoordinates.html" title="class in org.apache.sis.coverage.grid">FractionalGridCoordinates</a></span> <span class="element-name">toGridCoordinates</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/DirectPosition.html" title="class or interface in org.opengis.geometry" class="external-link">DirectPosition</a> point)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/TransformException.html" title="class or interface in org.opengis.referencing.operation" class="external-link">TransformException</a></span></div> |
| <div class="block">Converts the specified geospatial position to grid coordinates. If the given position is associated to |
| a non-null coordinate reference system (CRS) different than the <a href="#getCoverage()">coverage</a> CRS, |
| then this method automatically transforms that position to the <a href="../BandedCoverage.html#getCoordinateReferenceSystem()">coverage CRS</a> before to compute grid coordinates. |
| |
| <p>This method does not put any restriction on the grid coordinates result. |
| The result may be outside the <a href="GridGeometry.html#getExtent()">grid extent</a> |
| if the <a href="GridGeometry.html#getGridToCRS(org.opengis.referencing.datum.PixelInCell)">grid to CRS</a> transform allows it.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>point</code> - geospatial coordinates (in arbitrary CRS) to transform to grid coordinates.</dd> |
| <dt>Returns:</dt> |
| <dd>the grid coordinates for the given geospatial coordinates.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="IncompleteGridGeometryException.html" title="class in org.apache.sis.coverage.grid">IncompleteGridGeometryException</a></code> - if the <a href="GridCoverage.html#getGridGeometry()">grid geometry</a> |
| does not define a "grid to CRS" transform, or if the given point has a non-null CRS but the |
| coverage does not <a href="GridCoverage.html#getCoordinateReferenceSystem()">have a CRS</a>.</dd> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/TransformException.html" title="class or interface in org.opengis.referencing.operation" class="external-link">TransformException</a></code> - if the given coordinates cannot be transformed.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="FractionalGridCoordinates.html#toPosition(org.opengis.referencing.operation.MathTransform)"><code>FractionalGridCoordinates.toPosition(MathTransform)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
