org/apache/sis/coverage/grid/DomainLinearizer.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (19) -->
 <title>DomainLinearizer (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: DomainLinearizer">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.coverage.grid.DomainLinearizer class">
 <meta name="keywords" content="getGridStartsAtZero()">
 <meta name="keywords" content="setGridStartsAtZero()">
 <meta name="keywords" content="getScaleFactor()">
 <meta name="keywords" content="setScaleFactor()">
 <meta name="keywords" content="apply()">
 <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">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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/DomainLinearizer.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><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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.sis.coverage.grid</a></div>
 <h1 title="Class DomainLinearizer" class="title">Class DomainLinearizer</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 <div class="inheritance">DomainLinearizer</div>
 </div>
 <section class="class-description" id="class-description">
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DomainLinearizer</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
 <div class="block">Method for replacing a non-linear "grid to CRS" conversion by a linear conversion (affine transform).
  The <code>GridGeometry</code> class allows non-linear <a href="GridGeometry.html#getGridToCRS(org.opengis.referencing.datum.PixelInCell)">"grid to CRS"</a>
  conversions, but some <code>GridGeometry</code> usages are restricted to linear (affine) conversions.
  The <code>DomainLinearizer</code> class encapsulates the method used for replacing non-linear conversions
  by a linear approximation.

  <p>The same instance can be reused by invoking <code>apply(…)</code> methods for many <a href="GridCoverage.html" title="class in org.apache.sis.coverage.grid"><code>GridCoverage</code></a>
  or <a href="GridGeometry.html" title="class in org.apache.sis.coverage.grid"><code>GridGeometry</code></a> instances.</p>

  <h2>Limitations</h2>
  Current implementation is designed for two-dimensional grid geometries.
  Support for higher dimensions is not guaranteed.</div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>1.1</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="../../referencing/operation/builder/LinearTransformBuilder.html#approximate(org.opengis.referencing.operation.MathTransform,org.opengis.geometry.Envelope)"><code>LinearTransformBuilder.approximate(MathTransform, Envelope)</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">
 <!-- ======== 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">DomainLinearizer</a>()</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a new linearizer.</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="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-tab4"><code><a href="#apply(org.apache.sis.coverage.grid.GridCoverage)" class="member-name-link">apply</a><wbr>(<a href="GridCoverage.html" title="class in org.apache.sis.coverage.grid">GridCoverage</a>&nbsp;coverage)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns a grid coverage with a linear approximation of the <cite>grid to CRS</cite> conversion.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#apply(org.apache.sis.coverage.grid.GridGeometry)" class="member-name-link">apply</a><wbr>(<a href="GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a>&nbsp;gg)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Creates a grid geometry with a linear approximation of the <cite>grid to CRS</cite> conversion.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGridStartsAtZero()" class="member-name-link">getGridStartsAtZero</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 whether <code>GridExtent</code> should have their lower grid coordinates set to zero.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
 <div class="col-second odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the scale factor applied on coordinates in all dimensions.</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="#setGridStartsAtZero(boolean)" class="member-name-link">setGridStartsAtZero</a><wbr>(boolean&nbsp;force)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets whether <code>GridExtent</code> should have their lower grid coordinates set to 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="#setScaleFactor(double)" class="member-name-link">setScaleFactor</a><wbr>(double&nbsp;factor)</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 scale factor to apply on coordinates in all dimensions.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/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="&lt;init&gt;()">
 <h3>DomainLinearizer</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DomainLinearizer</span>()</div>
 <div class="block">Creates a new linearizer.</div>
 </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="getGridStartsAtZero()">
 <h3>getGridStartsAtZero</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">getGridStartsAtZero</span>()</div>
 <div class="block">Returns whether <code>GridExtent</code> should have their lower grid coordinates set to zero.
  If <code>true</code>, then <code>DomainLinearizer</code> will opportunistically apply translation
  on the <a href="GridGeometry.html#getGridToCRS(org.opengis.referencing.datum.PixelInCell)">"grid to CRS"</a> conversion in such a way that
  <code>GridExtent.getLow()</code> is 0 for all dimensions.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>whether to force lower grid coordinates to (0,0,…).</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="GridExtent.html#startsAtZero()"><code>GridExtent.startsAtZero()</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setGridStartsAtZero(boolean)">
 <h3>setGridStartsAtZero</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setGridStartsAtZero</span><wbr><span class="parameters">(boolean&nbsp;force)</span></div>
 <div class="block">Sets whether <code>GridExtent</code> should have their lower grid coordinates set to zero.
  The default value is <code>false</code>.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>force</code> - whether to force lower grid coordinates to (0,0,…).</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getScaleFactor()">
 <h3>getScaleFactor</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getScaleFactor</span>()</div>
 <div class="block">Returns the scale factor applied on coordinates in all dimensions.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>scale factor applied on coordinates in all dimensions, or 1 if none.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setScaleFactor(double)">
 <h3>setScaleFactor</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setScaleFactor</span><wbr><span class="parameters">(double&nbsp;factor)</span></div>
 <div class="block">Sets the scale factor to apply on coordinates in all dimensions.
  Must be a value greater than zero. The default value is 1.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>factor</code> - scale factor applied on coordinates in all dimensions, or 1 if none.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="apply(org.apache.sis.coverage.grid.GridCoverage)">
 <h3>apply</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="GridCoverage.html" title="class in org.apache.sis.coverage.grid">GridCoverage</a></span>&nbsp;<span class="element-name">apply</span><wbr><span class="parameters">(<a href="GridCoverage.html" title="class in org.apache.sis.coverage.grid">GridCoverage</a>&nbsp;coverage)</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">Returns a grid coverage with a linear approximation of the <cite>grid to CRS</cite> conversion.
  The linear approximation is computed by <a href="#apply(org.apache.sis.coverage.grid.GridGeometry)"><code>apply(GridGeometry)</code></a>. If the <cite>grid to CRS</cite>
  conversion of the given coverage is already linear, then this method returns <code>coverage</code>.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>coverage</code> - the grid coverage in which to make the <cite>grid to CRS</cite> conversion linear.</dd>
 <dt>Returns:</dt>
 <dd>a grid coverage with a linear approximation of the <cite>grid to CRS</cite> conversion.</dd>
 <dt>Throws:</dt>
 <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 some cell coordinates cannot be computed.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="apply(org.apache.sis.coverage.grid.GridGeometry)">
 <h3>apply</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a></span>&nbsp;<span class="element-name">apply</span><wbr><span class="parameters">(<a href="GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a>&nbsp;gg)</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">Creates a grid geometry with a linear approximation of the <cite>grid to CRS</cite> conversion.
  The approximation is computed by <cite>Least Mean Squares</cite> method: the affine transform
  coefficients are chosen in way making the average value of (<var>position</var> − <var>linear
  approximation of position</var>)² as small as possible for all cells in given grid geometry.
  If the <cite>grid to CRS</cite> conversion of the given grid geometry is already linear,
  then this method returns <code>gg</code>.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>gg</code> - the grid geometry in which to make the <cite>grid to CRS</cite> conversion linear.</dd>
 <dt>Returns:</dt>
 <dd>a grid geometry with a linear approximation of the <cite>grid to CRS</cite> conversion.</dd>
 <dt>Throws:</dt>
 <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 some cell coordinates cannot be computed.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>