org/apache/sis/referencing/operation/transform/InterpolatedTransform.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (19) -->
 <title>InterpolatedTransform (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.referencing.operation.transform, class: InterpolatedTransform">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.referencing.operation.transform.InterpolatedTransform class">
 <meta name="keywords" content="createGeodeticTransformation()">
 <meta name="keywords" content="getShiftGrid()">
 <meta name="keywords" content="getSourceDimensions()">
 <meta name="keywords" content="getTargetDimensions()">
 <meta name="keywords" content="transform()">
 <meta name="keywords" content="inverse()">
 <meta name="keywords" content="computeHashCode()">
 <meta name="keywords" content="equals()">
 <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/InterpolatedTransform.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.referencing.operation.transform</a></div>
 <h1 title="Class InterpolatedTransform" class="title">Class InterpolatedTransform</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"><a href="../../../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a>
 <div class="inheritance"><a href="AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform</a>
 <div class="inheritance"><a href="DatumShiftTransform.html" title="class in org.apache.sis.referencing.operation.transform">DatumShiftTransform</a>
 <div class="inheritance">InterpolatedTransform</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/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../../../parameter/Parameterized.html" title="interface in org.apache.sis.parameter">Parameterized</a></code>, <code><a href="../../../util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">InterpolatedTransform</span>
 <span class="extends-implements">extends <a href="DatumShiftTransform.html" title="class in org.apache.sis.referencing.operation.transform">DatumShiftTransform</a></span></div>
 <div class="block">Transforms between two CRS by performing translations interpolated from a grid file.
  The source and target coordinate reference systems are typically, but not necessarily,
  two-dimensional <a href="../../crs/DefaultGeographicCRS.html" title="class in org.apache.sis.referencing.crs">geographic CRS</a>.
  The actual number of dimensions is determined by <a href="../../datum/DatumShiftGrid.html#getTranslationDimensions()"><code>DatumShiftGrid.getTranslationDimensions()</code></a>.

  <div class="note"><b>Example:</b>
  this transform is used for example with NADCON and NTv2 datum shift grids.</div>

  <h2>Input and output coordinates</h2>
  First, <cite>"real world"</cite> input coordinates (<var>x</var>,<var>y</var>) are converted to
  <cite>grid</cite> coordinates (<var>gridX</var>, <var>gridY</var>), which are zero-based indices
  in the two-dimensional grid. This conversion is applied by an affine transform <em>before</em>
  to be passed to the <code>transform</code> methods of this <code>InterpolatedTransform</code> class.

  <p>Translation vectors are stored in the datum shift grid at the specified grid indices.
  If the grid indices are non-integer values, then the translations are interpolated using a bilinear interpolation.
  If the grid indices are outside the grid domain ([0 … <var>width</var>-1] × [0 … <var>height</var>-1]
  where <var>width</var> and <var>height</var> are the number of columns and rows in the grid),
  then the translations are extrapolated. The translation is finally added to the input coordinates.</p>

  <p>The input and output coordinates can have any number of dimensions, provided that they are the same
  than the number of <a href="../../datum/DatumShiftGrid.html#getTranslationDimensions()">translation dimensions</a>.
  However, current implementation uses only the two first dimensions for interpolations in the grid.</p></div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>0.7</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum"><code>DatumShiftGrid</code></a></li>
 <li><a href="../builder/LocalizationGridBuilder.html" title="class in org.apache.sis.referencing.operation.builder"><code>LocalizationGridBuilder</code></a></li>
 <li><a href="../../../../../../serialized-form.html#org.apache.sis.referencing.operation.transform.InterpolatedTransform">Serialized Form</a></li>
 </ul>
 </dd>

 <p><font size="-1">Defined in the <code>sis-referencing</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 three-column-summary">
 <div class="table-header col-first">Modifier</div>
 <div class="table-header col-second">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>protected </code></div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.referencing.datum.DatumShiftGrid)" class="member-name-link">InterpolatedTransform</a><wbr>(<a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum">DatumShiftGrid</a>&lt;T,<wbr>T&gt;&nbsp;grid)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a transform for the given interpolation grid.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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>protected int</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#computeHashCode()" class="member-name-link">computeHashCode</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Computes a hash value for this transform.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;T extends <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link">Quantity</a>&lt;T&gt;&gt;<br><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createGeodeticTransformation(org.opengis.referencing.operation.MathTransformFactory,org.apache.sis.referencing.datum.DatumShiftGrid)" class="member-name-link">createGeodeticTransformation</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransformFactory.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransformFactory</a>&nbsp;factory,
  <a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum">DatumShiftGrid</a>&lt;T,<wbr>T&gt;&nbsp;grid)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Creates a transformation between two geodetic CRS.</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="#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)" class="member-name-link">equals</a><wbr>(<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>&nbsp;object,
  <a href="../../../util/ComparisonMode.html" title="enum class in org.apache.sis.util">ComparisonMode</a>&nbsp;mode)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Compares the specified object with this math transform for equality.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum">DatumShiftGrid</a>&lt;?,<wbr>?&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getShiftGrid()" class="member-name-link">getShiftGrid</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 grid of datum shifts specified at construction time.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSourceDimensions()" class="member-name-link">getSourceDimensions</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 number of input dimensions.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetDimensions()" class="member-name-link">getTargetDimensions</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 target dimensions.</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/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#inverse()" class="member-name-link">inverse</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 inverse of this interpolated transform.</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/referencing/operation/Matrix.html" title="class or interface in org.opengis.referencing.operation" class="external-link">Matrix</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#transform(double%5B%5D,int,double%5B%5D,int,boolean)" class="member-name-link">transform</a><wbr>(double[]&nbsp;srcPts,
  int&nbsp;srcOff,
  double[]&nbsp;dstPts,
  int&nbsp;dstOff,
  boolean&nbsp;derivate)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Applies the datum shift on a coordinate tuple and optionally returns the derivative at that location.</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="#transform(double%5B%5D,int,double%5B%5D,int,int)" class="member-name-link">transform</a><wbr>(double[]&nbsp;srcPts,
  int&nbsp;srcOff,
  double[]&nbsp;dstPts,
  int&nbsp;dstOff,
  int&nbsp;numPts)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Transforms an arbitrary number of coordinate tuples.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-DatumShiftTransform">Methods inherited from class&nbsp;<a href="DatumShiftTransform.html" title="class in org.apache.sis.referencing.operation.transform">DatumShiftTransform</a></h3>
 <code><a href="DatumShiftTransform.html#getContextualParameters()">getContextualParameters</a>, <a href="DatumShiftTransform.html#getParameterValues()">getParameterValues</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-AbstractMathTransform">Methods inherited from class&nbsp;<a href="AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform</a></h3>
 <code><a href="AbstractMathTransform.html#derivative(org.opengis.geometry.DirectPosition)">derivative</a>, <a href="AbstractMathTransform.html#equals(java.lang.Object)">equals</a>, <a href="AbstractMathTransform.html#formatTo(org.apache.sis.io.wkt.Formatter)">formatTo</a>, <a href="AbstractMathTransform.html#getDomain(org.apache.sis.referencing.operation.transform.DomainDefinition)">getDomain</a>, <a href="AbstractMathTransform.html#getParameterDescriptors()">getParameterDescriptors</a>, <a href="AbstractMathTransform.html#hashCode()">hashCode</a>, <a href="AbstractMathTransform.html#isIdentity()">isIdentity</a>, <a href="AbstractMathTransform.html#transform(double%5B%5D,int,float%5B%5D,int,int)">transform</a>, <a href="AbstractMathTransform.html#transform(float%5B%5D,int,double%5B%5D,int,int)">transform</a>, <a href="AbstractMathTransform.html#transform(float%5B%5D,int,float%5B%5D,int,int)">transform</a>, <a href="AbstractMathTransform.html#transform(org.opengis.geometry.DirectPosition,org.opengis.geometry.DirectPosition)">transform</a>, <a href="AbstractMathTransform.html#tryConcatenate(boolean,org.opengis.referencing.operation.MathTransform,org.opengis.referencing.operation.MathTransformFactory)">tryConcatenate</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-FormattableObject">Methods inherited from class&nbsp;<a href="../../../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></h3>
 <code><a href="../../../io/wkt/FormattableObject.html#print()">print</a>, <a href="../../../io/wkt/FormattableObject.html#toString()">toString</a>, <a href="../../../io/wkt/FormattableObject.html#toString(org.apache.sis.io.wkt.Convention)">toString</a>, <a href="../../../io/wkt/FormattableObject.html#toWKT()">toWKT</a></code></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#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#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#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>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-MathTransform">Methods inherited from interface&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></h3>
 <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html#toWKT()" title="class or interface in org.opengis.referencing.operation" class="external-link">toWKT</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;(org.apache.sis.referencing.datum.DatumShiftGrid)">
 <h3>InterpolatedTransform</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">InterpolatedTransform</span><wbr><span class="parameters">(<a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum">DatumShiftGrid</a>&lt;T,<wbr>T&gt;&nbsp;grid)</span>
                          throws <span class="exceptions"><a href="../matrix/NoninvertibleMatrixException.html" title="class in org.apache.sis.referencing.operation.matrix">NoninvertibleMatrixException</a></span></div>
 <div class="block">Creates a transform for the given interpolation grid.
  This <code>InterpolatedTransform</code> class works with coordinate values in <em>units of grid cell</em>
  For example, input coordinates (4,5) is the position of the center of the cell at grid index (4,5).
  The output units are the same than the input units.

  <p>For converting geodetic coordinates, <code>InterpolatedTransform</code> instances need to be concatenated
  with the following affine transforms:

  <ul>
    <li><cite>Normalization</cite> before <code>InterpolatedTransform</code>
      for converting the geodetic coordinates into grid coordinates.</li>
    <li><cite>Denormalization</cite> after <code>InterpolatedTransform</code>
      for converting grid coordinates into geodetic coordinates.</li>
  </ul>

  After <code>InterpolatedTransform</code> construction,
  the full conversion chain including the above affine transforms can be created by
  <code><a href="DatumShiftTransform.html#getContextualParameters()">DatumShiftTransform.getContextualParameters()</a>.<a href="ContextualParameters.html#completeTransform(org.opengis.referencing.operation.MathTransformFactory,org.opengis.referencing.operation.MathTransform)">completeTransform</a>(factory, this)}</code>.</div>
 <dl class="notes">
 <dt>Type Parameters:</dt>
 <dd><code>T</code> - dimension of the coordinate tuples and the translation unit.</dd>
 <dt>Parameters:</dt>
 <dd><code>grid</code> - the grid of datum shifts from source to target datum.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="../matrix/NoninvertibleMatrixException.html" title="class in org.apache.sis.referencing.operation.matrix">NoninvertibleMatrixException</a></code> - if the conversion from geodetic coordinates
          to grid indices cannot be inverted.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="#createGeodeticTransformation(org.opengis.referencing.operation.MathTransformFactory,org.apache.sis.referencing.datum.DatumShiftGrid)"><code>createGeodeticTransformation(MathTransformFactory, DatumShiftGrid)</code></a></li>
 </ul>
 </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="createGeodeticTransformation(org.opengis.referencing.operation.MathTransformFactory,org.apache.sis.referencing.datum.DatumShiftGrid)">
 <h3>createGeodeticTransformation</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;T extends <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link">Quantity</a>&lt;T&gt;&gt;</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></span>&nbsp;<span class="element-name">createGeodeticTransformation</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransformFactory.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransformFactory</a>&nbsp;factory,
  <a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum">DatumShiftGrid</a>&lt;T,<wbr>T&gt;&nbsp;grid)</span>
                                                                           throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/FactoryException.html" title="class or interface in org.opengis.util" class="external-link">FactoryException</a></span></div>
 <div class="block">Creates a transformation between two geodetic CRS. This factory method combines the
  <code>InterpolatedTransform</code> instance with the steps needed for converting values between
  geodetic and grid coordinates.

  <h4>Unit of measurement</h4>
  The unit of measurement is determined by <a href="../../datum/DatumShiftGrid.html#getCoordinateUnit()"><code>DatumShiftGrid.getCoordinateUnit()</code></a>:
  <ul>
    <li>If the datum shift unit <a href="../../../measure/Units.html#isAngular(javax.measure.Unit)">is angular</a>, then the transform
        will work with input and output coordinates in degrees of angle.</li>
    <li>If the datum shift unit <a href="../../../measure/Units.html#isLinear(javax.measure.Unit)">is linear</a>, then the transform
        will work with input and output coordinates in metres.</li>
    <li>If the datum shift unit <a href="../../../measure/Units.html#isTemporal(javax.measure.Unit)">is temporal</a>, then the transform
        will work with input and output coordinates in seconds.</li>
    <li>Generally for all units other than angular, the transform will work with input and output
        coordinates in the unit given by <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html#getSystemUnit()" title="class or interface in javax.measure" class="external-link"><code>Unit.getSystemUnit()</code></a>.</li>
  </ul></div>
 <dl class="notes">
 <dt>Type Parameters:</dt>
 <dd><code>T</code> - dimension of the coordinate tuples and the translation unit.</dd>
 <dt>Parameters:</dt>
 <dd><code>factory</code> - the factory to use for creating the transform.</dd>
 <dd><code>grid</code> - the grid of datum shifts from source to target datum.
                   The <a href="../../datum/DatumShiftGrid.html#interpolateInCell(double,double,double%5B%5D)"><code>DatumShiftGrid.interpolateInCell(…)</code></a>
                   method shall compute translations from <em>source</em> to <em>target</em> as
                   <a href="../../datum/DatumShiftGrid.html#isCellValueRatio()">ratio of offsets divided by cell sizes</a>.</dd>
 <dt>Returns:</dt>
 <dd>the transformation between geodetic coordinates.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/FactoryException.html" title="class or interface in org.opengis.util" class="external-link">FactoryException</a></code> - if an error occurred while creating a transform.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getShiftGrid()">
 <h3>getShiftGrid</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum">DatumShiftGrid</a>&lt;?,<wbr>?&gt;</span>&nbsp;<span class="element-name">getShiftGrid</span>()</div>
 <div class="block">Returns the grid of datum shifts specified at construction time.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the grid of datum shifts from source to target datum.</dd>
 <dt>Since:</dt>
 <dd>1.1</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSourceDimensions()">
 <h3>getSourceDimensions</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getSourceDimensions</span>()</div>
 <div class="block">Returns the number of input dimensions.
  This fixed to <a href="../../datum/DatumShiftGrid.html#getTranslationDimensions()"><code>DatumShiftGrid.getTranslationDimensions()</code></a>.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html#getSourceDimensions()" title="class or interface in org.opengis.referencing.operation" class="external-link">getSourceDimensions</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></code></dd>
 <dt>Specified by:</dt>
 <dd><code><a href="AbstractMathTransform.html#getSourceDimensions()">getSourceDimensions</a></code>&nbsp;in class&nbsp;<code><a href="AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform</a></code></dd>
 <dt>Returns:</dt>
 <dd>the dimension of input points.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="../DefaultOperationMethod.html#getSourceDimensions()"><code>DefaultOperationMethod.getSourceDimensions()</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getTargetDimensions()">
 <h3>getTargetDimensions</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getTargetDimensions</span>()</div>
 <div class="block">Returns the number of target dimensions.
  This fixed to <a href="../../datum/DatumShiftGrid.html#getTranslationDimensions()"><code>DatumShiftGrid.getTranslationDimensions()</code></a>.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html#getTargetDimensions()" title="class or interface in org.opengis.referencing.operation" class="external-link">getTargetDimensions</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></code></dd>
 <dt>Specified by:</dt>
 <dd><code><a href="AbstractMathTransform.html#getTargetDimensions()">getTargetDimensions</a></code>&nbsp;in class&nbsp;<code><a href="AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform</a></code></dd>
 <dt>Returns:</dt>
 <dd>the dimension of output points.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="../DefaultOperationMethod.html#getTargetDimensions()"><code>DefaultOperationMethod.getTargetDimensions()</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="transform(double[],int,double[],int,boolean)">
 <h3>transform</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/Matrix.html" title="class or interface in org.opengis.referencing.operation" class="external-link">Matrix</a></span>&nbsp;<span class="element-name">transform</span><wbr><span class="parameters">(double[]&nbsp;srcPts,
  int&nbsp;srcOff,
  double[]&nbsp;dstPts,
  int&nbsp;dstOff,
  boolean&nbsp;derivate)</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">Applies the datum shift on a coordinate tuple and optionally returns the derivative at that location.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="AbstractMathTransform.html#transform(double%5B%5D,int,double%5B%5D,int,boolean)">transform</a></code>&nbsp;in class&nbsp;<code><a href="AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>srcPts</code> - the array containing the source coordinates (cannot be <code>null</code>).</dd>
 <dd><code>srcOff</code> - the offset to the point to be transformed in the source array.</dd>
 <dd><code>dstPts</code> - the array into which the transformed coordinates is returned. May be the same than <code>srcPts</code>.
                    May be <code>null</code> if only the derivative matrix is desired.</dd>
 <dd><code>dstOff</code> - the offset to the location of the transformed point that is stored in the destination array.</dd>
 <dd><code>derivate</code> - <code>true</code> for computing the derivative, or <code>false</code> if not needed.</dd>
 <dt>Returns:</dt>
 <dd>the matrix of the transform derivative at the given source position,
          or <code>null</code> if the <code>derivate</code> argument is <code>false</code>.</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 the point cannot be transformed or
          if a problem occurred while calculating the derivative.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="AbstractMathTransform.html#derivative(org.opengis.geometry.DirectPosition)"><code>AbstractMathTransform.derivative(DirectPosition)</code></a></li>
 <li><a href="AbstractMathTransform.html#transform(org.opengis.geometry.DirectPosition,org.opengis.geometry.DirectPosition)"><code>AbstractMathTransform.transform(DirectPosition, DirectPosition)</code></a></li>
 <li><a href="MathTransforms.html#derivativeAndTransform(org.opengis.referencing.operation.MathTransform,double%5B%5D,int,double%5B%5D,int)"><code>MathTransforms.derivativeAndTransform(MathTransform, double[], int, double[], int)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="transform(double[],int,double[],int,int)">
 <h3>transform</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">transform</span><wbr><span class="parameters">(double[]&nbsp;srcPts,
  int&nbsp;srcOff,
  double[]&nbsp;dstPts,
  int&nbsp;dstOff,
  int&nbsp;numPts)</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">Transforms an arbitrary number of coordinate tuples.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html#transform(double%5B%5D,int,double%5B%5D,int,int)" title="class or interface in org.opengis.referencing.operation" class="external-link">transform</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></code></dd>
 <dt>Overrides:</dt>
 <dd><code><a href="AbstractMathTransform.html#transform(double%5B%5D,int,double%5B%5D,int,int)">transform</a></code>&nbsp;in class&nbsp;<code><a href="AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>srcPts</code> - the array containing the source point coordinates.</dd>
 <dd><code>srcOff</code> - the offset to the first point to be transformed in the source array.</dd>
 <dd><code>dstPts</code> - the array into which the transformed point coordinates are returned.
                  May be the same than <code>srcPts</code>.</dd>
 <dd><code>dstOff</code> - the offset to the location of the first transformed point that is stored in the destination array.</dd>
 <dd><code>numPts</code> - the number of point objects to be transformed.</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 a point cannot be transformed.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="inverse()">
 <h3>inverse</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></span>&nbsp;<span class="element-name">inverse</span>()</div>
 <div class="block">Returns the inverse of this interpolated transform.
  The source ellipsoid of the returned transform will be the target ellipsoid of this transform, and conversely.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html#inverse()" title="class or interface in org.opengis.referencing.operation" class="external-link">inverse</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></code></dd>
 <dt>Overrides:</dt>
 <dd><code><a href="AbstractMathTransform.html#inverse()">inverse</a></code>&nbsp;in class&nbsp;<code><a href="AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform</a></code></dd>
 <dt>Returns:</dt>
 <dd>a transform from the target ellipsoid to the source ellipsoid of this transform.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="computeHashCode()">
 <h3>computeHashCode</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">computeHashCode</span>()</div>
 <div class="block">Computes a hash value for this transform. This method is invoked by <a href="AbstractMathTransform.html#hashCode()"><code>AbstractMathTransform.hashCode()</code></a> when first needed.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="DatumShiftTransform.html#computeHashCode()">computeHashCode</a></code>&nbsp;in class&nbsp;<code><a href="DatumShiftTransform.html" title="class in org.apache.sis.referencing.operation.transform">DatumShiftTransform</a></code></dd>
 <dt>Returns:</dt>
 <dd>the hash code value. This value may change between different execution of the Apache SIS library.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">
 <h3>equals</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(<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>&nbsp;object,
  <a href="../../../util/ComparisonMode.html" title="enum class in org.apache.sis.util">ComparisonMode</a>&nbsp;mode)</span></div>
 <div class="block">Compares the specified object with this math transform for equality.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../../../util/LenientComparable.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code></dd>
 <dt>Overrides:</dt>
 <dd><code><a href="DatumShiftTransform.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a></code>&nbsp;in class&nbsp;<code><a href="DatumShiftTransform.html" title="class in org.apache.sis.referencing.operation.transform">DatumShiftTransform</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>object</code> - the object to compare with this transform.</dd>
 <dd><code>mode</code> - the strictness level of the comparison. Default to <a href="../../../util/ComparisonMode.html#STRICT"><code>STRICT</code></a>.</dd>
 <dt>Returns:</dt>
 <dd><code>true</code> if the given object is considered equals to this math transform.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="../../../util/Utilities.html#deepEquals(java.lang.Object,java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>Utilities.deepEquals(Object, Object, ComparisonMode)</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 &#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>