| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>InterpolatedGeocentricTransform (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.referencing, package: org.apache.sis.referencing.operation.transform, class: InterpolatedGeocentricTransform"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.referencing.operation.transform.InterpolatedGeocentricTransform class"> |
| <meta name="keywords" content="createGeodeticTransformation()"> |
| <meta name="keywords" content="getSourceDimensions()"> |
| <meta name="keywords" content="getTargetDimensions()"> |
| <meta name="keywords" content="transform()"> |
| <meta name="keywords" content="inverse()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../../../module-summary.html">org.apache.sis.referencing</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.referencing.operation.transform</a></div> |
| <h1 title="Class InterpolatedGeocentricTransform" class="title">Class InterpolatedGeocentricTransform</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="../../../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">InterpolatedGeocentricTransform</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../../../parameter/Parameterized.html" title="interface in org.apache.sis.parameter">Parameterized</a></code>, <code><a href="../../../../../../../org.apache.sis.util/org/apache/sis/util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code>, <code><a href="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">InterpolatedGeocentricTransform</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 geographic CRS by performing geocentric translations interpolated from a grid file. |
| This transform is used mainly for <cite>"France geocentric interpolation"</cite> (ESPG:9655) datum shifts, |
| but Apache SIS implementation allows the use for other regions. |
| |
| <h2 id="algorithm-heading">Algorithm</h2> |
| This class transforms two- or three- dimensional coordinates from a geographic CRS to another geographic CRS. |
| The changes between source and target coordinates are small (usually less than 400 metres), but vary for every |
| position. Those changes are provided in a <a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum">datum shift grid</a>, usually loaded from one |
| or two files. |
| |
| <p>Many datum shift grids like NADCON and NTv2 apply the changes directly on geographic coordinates. |
| This relatively simple case is handled by <a href="InterpolatedTransform.html" title="class in org.apache.sis.referencing.operation.transform"><code>InterpolatedTransform</code></a>. |
| But the <code>InterpolatedGeocentricTransform</code> algorithm uses the grid in a more complex way:</p> |
| |
| <ol> |
| <li>Convert input geographic coordinate (λ,φ) to geocentric coordinate (X,Y,Z).</li> |
| <li>Ask <a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum"><code>DatumShiftGrid</code></a> for the offset to apply for coordinate (λ,φ). |
| But instead of returning a (Δλ, Δφ) offset, the grid shall return a (ΔX, ΔY, ΔZ) offset.</li> |
| <li>Convert the shifted geocentric coordinate (X+ΔX, Y+ΔY, Z+ΔZ) back to a geographic coordinate.</li> |
| </ol> |
| |
| <h3 id="reference-heading">Reference</h3> |
| IGN document <code>NTG_88.pdf</code>, |
| <cite>"Grille de paramètres de transformation de coordonnées"</cite> |
| at <a href="http://www.ign.fr">http://www.ign.fr</a>. |
| Note however that the signs of (ΔX, ΔY, ΔZ) values expected by this class are the opposite of the |
| signs used in NTG_88 document. This is because NTG_88 grid defines shifts from target to source, |
| while this class expects shifts from source to target. |
| |
| <p><b>Note:</b> this algorithm is not the same as a (theoretical) <a href="EllipsoidToCentricTransform.html" title="class in org.apache.sis.referencing.operation.transform"><code>EllipsoidToCentricTransform</code></a> → |
| <a href="InterpolatedTransform.html" title="class in org.apache.sis.referencing.operation.transform"><code>InterpolatedTransform</code></a> → (inverse of <code>EllipsoidToCentricTransform</code>) concatenation |
| because the <code>DatumShiftGrid</code> inputs are geographic coordinates even if the interpolated |
| grid values are in geocentric space.</p> |
| |
| <h2 id="performance-consideration-heading">Performance consideration</h2> |
| <a href="InterpolatedMolodenskyTransform.html" title="class in org.apache.sis.referencing.operation.transform"><code>InterpolatedMolodenskyTransform</code></a> performs the same calculation more efficiently at the cost of |
| a few centimetres error. Both classes are instantiated in the same way and expect the same inputs.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.7</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="InterpolatedMolodenskyTransform.html" title="class in org.apache.sis.referencing.operation.transform"><code>InterpolatedMolodenskyTransform</code></a></li> |
| <li><a href="../../../../../../../serialized-form.html#org.apache.sis.referencing.operation.transform.InterpolatedGeocentricTransform">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </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.opengis.referencing.datum.Ellipsoid,boolean,org.opengis.referencing.datum.Ellipsoid,boolean,org.apache.sis.referencing.datum.DatumShiftGrid)" class="member-name-link">InterpolatedGeocentricTransform</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link">Ellipsoid</a> source, |
| boolean isSource3D, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link">Ellipsoid</a> target, |
| boolean isTarget3D, |
| <a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum">DatumShiftGrid</a><<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Angle.html" title="class or interface in javax.measure.quantity" class="external-link">Angle</a>,<wbr><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Length.html" title="class or interface in javax.measure.quantity" class="external-link">Length</a>> grid)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a transform from the specified parameters.</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-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#createGeodeticTransformation(org.opengis.referencing.operation.MathTransformFactory,org.opengis.referencing.datum.Ellipsoid,boolean,org.opengis.referencing.datum.Ellipsoid,boolean,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> factory, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link">Ellipsoid</a> source, |
| boolean isSource3D, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link">Ellipsoid</a> target, |
| boolean isTarget3D, |
| <a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum">DatumShiftGrid</a><<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Angle.html" title="class or interface in javax.measure.quantity" class="external-link">Angle</a>,<wbr><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Length.html" title="class or interface in javax.measure.quantity" class="external-link">Length</a>> grid)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a transformation between two geographic CRS.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the dimension of input points.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the dimension of output points.</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/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-tab2 method-summary-table-tab4"><code><a href="#inverse()" class="member-name-link">inverse</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 inverse of this interpolated geocentric transform.</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/Matrix.html" title="class or interface in org.opengis.referencing.operation" class="external-link">Matrix</a></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,boolean)" class="member-name-link">transform</a><wbr>(double[] srcPts, |
| int srcOff, |
| double[] dstPts, |
| int dstOff, |
| boolean derivate)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Transforms the (λ,φ) or (λ,φ,<var>h</var>) coordinates between two geographic CRS, |
| and optionally returns the derivative at that location.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-DatumShiftTransform">Methods inherited from class <a href="DatumShiftTransform.html" title="class in org.apache.sis.referencing.operation.transform">DatumShiftTransform</a></h3> |
| <code><a href="DatumShiftTransform.html#computeHashCode()">computeHashCode</a>, <a href="DatumShiftTransform.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a>, <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 <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,double%5B%5D,int,int)">transform</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 <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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-MathTransform">Methods inherited from interface <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="<init>(org.opengis.referencing.datum.Ellipsoid,boolean,org.opengis.referencing.datum.Ellipsoid,boolean,org.apache.sis.referencing.datum.DatumShiftGrid)"> |
| <h3>InterpolatedGeocentricTransform</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">InterpolatedGeocentricTransform</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link">Ellipsoid</a> source, |
| boolean isSource3D, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link">Ellipsoid</a> target, |
| boolean isTarget3D, |
| <a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum">DatumShiftGrid</a><<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Angle.html" title="class or interface in javax.measure.quantity" class="external-link">Angle</a>,<wbr><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Length.html" title="class or interface in javax.measure.quantity" class="external-link">Length</a>> grid)</span></div> |
| <div class="block">Creates a transform from the specified parameters. |
| This <code>InterpolatedGeocentricTransform</code> class expects coordinate values in the following order and units: |
| <ol> |
| <li>longitudes in <strong>radians</strong> relative to the prime meridian (usually Greenwich),</li> |
| <li>latitudes in <strong>radians</strong>,</li> |
| <li>optionally heights above the ellipsoid, in same units than the source ellipsoid axes.</li> |
| </ol> |
| |
| For converting geographic coordinates in degrees, <code>InterpolatedGeocentricTransform</code> instances |
| need to be concatenated with the following affine transforms: |
| |
| <ul> |
| <li><cite>Normalization</cite> before <code>InterpolatedGeocentricTransform</code>:<ul> |
| <li>Conversion of (λ,φ) from degrees to radians.</li> |
| </ul></li> |
| <li><cite>Denormalization</cite> after <code>InterpolatedGeocentricTransform</code>:<ul> |
| <li>Conversion of (λ,φ) from radians to degrees.</li> |
| </ul></li> |
| </ul> |
| |
| After <code>InterpolatedGeocentricTransform</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>Parameters:</dt> |
| <dd><code>source</code> - the source ellipsoid.</dd> |
| <dd><code>isSource3D</code> - <code>true</code> if the source coordinates have a height.</dd> |
| <dd><code>target</code> - the target ellipsoid.</dd> |
| <dd><code>isTarget3D</code> - <code>true</code> if the target coordinates have a height.</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 (ΔX, ΔY, ΔZ) translations from <em>source</em> to <em>target</em> in the |
| unit of source ellipsoid axes.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#createGeodeticTransformation(org.opengis.referencing.operation.MathTransformFactory,org.opengis.referencing.datum.Ellipsoid,boolean,org.opengis.referencing.datum.Ellipsoid,boolean,org.apache.sis.referencing.datum.DatumShiftGrid)"><code>createGeodeticTransformation(MathTransformFactory, Ellipsoid, boolean, Ellipsoid, boolean, 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.opengis.referencing.datum.Ellipsoid,boolean,org.opengis.referencing.datum.Ellipsoid,boolean,org.apache.sis.referencing.datum.DatumShiftGrid)"> |
| <h3>createGeodeticTransformation</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <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> <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> factory, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link">Ellipsoid</a> source, |
| boolean isSource3D, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/Ellipsoid.html" title="class or interface in org.opengis.referencing.datum" class="external-link">Ellipsoid</a> target, |
| boolean isTarget3D, |
| <a href="../../datum/DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum">DatumShiftGrid</a><<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Angle.html" title="class or interface in javax.measure.quantity" class="external-link">Angle</a>,<wbr><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Length.html" title="class or interface in javax.measure.quantity" class="external-link">Length</a>> 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 geographic CRS. This factory method combines the |
| <code>InterpolatedGeocentricTransform</code> instance with the steps needed for converting values between |
| degrees to radians. The transform works with input and output coordinates in the following units: |
| |
| <ol> |
| <li>longitudes in <strong>degrees</strong> relative to the prime meridian (usually Greenwich),</li> |
| <li>latitudes in <strong>degrees</strong>,</li> |
| <li>optionally heights above the ellipsoid, in same units than the source ellipsoids axes.</li> |
| </ol> |
| |
| Note however that the given <code>grid</code> instance shall expect geographic coordinates (λ,φ) |
| in <strong>radians</strong>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factory</code> - the factory to use for creating the transform.</dd> |
| <dd><code>source</code> - the source ellipsoid.</dd> |
| <dd><code>isSource3D</code> - <code>true</code> if the source coordinates have a height.</dd> |
| <dd><code>target</code> - the target ellipsoid.</dd> |
| <dd><code>isTarget3D</code> - <code>true</code> if the target coordinates have a height.</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 (ΔX, ΔY, ΔZ) translations from <em>source</em> to <em>target</em> in the |
| unit of source ellipsoid axes.</dd> |
| <dt>Returns:</dt> |
| <dd>the transformation between geographic coordinates in degrees.</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="getSourceDimensions()"> |
| <h3>getSourceDimensions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getSourceDimensions</span>()</div> |
| <div class="block">Gets the dimension of input points.</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> in interface <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> in class <code><a href="AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the input dimension, which is 2 or 3.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-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</span> <span class="return-type">int</span> <span class="element-name">getTargetDimensions</span>()</div> |
| <div class="block">Gets the dimension of output points.</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> in interface <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> in class <code><a href="AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the output dimension, which is 2 or 3.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-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> <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> <span class="element-name">transform</span><wbr><span class="parameters">(double[] srcPts, |
| int srcOff, |
| double[] dstPts, |
| int dstOff, |
| boolean 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">Transforms the (λ,φ) or (λ,φ,<var>h</var>) coordinates between two geographic CRS, |
| 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> in class <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="tag-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="inverse()"> |
| <h3>inverse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform</a></span> <span class="element-name">inverse</span>()</div> |
| <div class="block">Returns the inverse of this interpolated geocentric 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> in interface <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> in class <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> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |