| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>org.apache.sis.referencing.operation.transform (Apache SIS 1.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2019-09-20"> |
| <meta name="keywords" content="org.apache.sis.referencing.operation.transform package"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.sis.referencing.operation.transform (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.sis.referencing.operation.transform</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Conversions or transformations of multi-dimensional coordinate points. |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>MathTransform</code></a> provides a single API for |
| coordinate conversions or transformations, including map projections. |
| Each <code>MathTransform</code> instances can: |
| |
| <ul> |
| <li>transform a single point,</li> |
| <li>transform efficiently an array of coordinates,</li> |
| <li>transform a Java2D <a href="https://docs.oracle.com/javase/8/docs/api/java/awt/Shape.html?is-external=true" title="class or interface in java.awt" class="externalLink"><code>Shape</code></a> (<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform2D.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>MathTransform2D</code></a> only),</li> |
| <li>compute the transform derivative at a location (for advanced users),</li> |
| <li>be concatenated in a conversion or transformation chain.</li> |
| </ul> |
| |
| <code>MathTransform</code> are truly <var>n</var>-dimensional, but specialized implementations |
| for 1D and 2D cases are provided for performance reasons or for inter-operability with Java2D. |
| In the 2D case, Apache SIS provides instances of the standard <a href="https://docs.oracle.com/javase/8/docs/api/java/awt/geom/AffineTransform.html?is-external=true" title="class or interface in java.awt.geom" class="externalLink"><code>AffineTransform</code></a> |
| class when possible. |
| |
| <p>This package does not include map projections, which are a special kind of transforms defined |
| in their own <a href="../projection/package-summary.html">projection</a> package.</p> |
| |
| |
| <div class="section">Creating math transforms</div> |
| <code>MathTransform</code> instances can be created either directly or indirectly. |
| The recommended way is the indirect one: first |
| <a href="../../CRS.html#findOperation(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.metadata.extent.GeographicBoundingBox)">find the coordinate operation</a> |
| (generally from a pair of <var>source</var> and <var>target</var> CRS), then invoke |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true#getMathTransform()" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>CoordinateOperation.getMathTransform()</code></a>. |
| However sophisticated users can also create math transforms explicitly from a group of parameter values |
| using the <a href="DefaultMathTransformFactory.html" title="class in org.apache.sis.referencing.operation.transform">math |
| transform factory</a>. |
| |
| |
| <div class="section">Non-spatial coordinates</div> |
| <code>MathTransform</code> usually performs conversions or transformations from points given in a |
| <a href="../AbstractCoordinateOperation.html#getSourceCRS()">source coordinate reference system</a> to coordinate values for the same points in the |
| <a href="../AbstractCoordinateOperation.html#getTargetCRS()">target coordinate reference system</a>. However the conversions are not necessarily between CRS; |
| a <code>MathTransform</code> can also be used for converting the sample values in a raster for example. |
| Such kind of transforms are named <a href="TransferFunction.html" title="class in org.apache.sis.referencing.operation.transform">transfer functions</a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.5</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a></th> |
| <td class="colLast"> |
| <div class="block">A usually affine, or otherwise a projective transform, which convert coordinates using only linear equations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="MathTransformProvider.html" title="interface in org.apache.sis.referencing.operation.transform">MathTransformProvider</a></th> |
| <td class="colLast"> |
| <div class="block">An object capable to create <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>MathTransform</code></a> instances from given parameter values.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform</a></th> |
| <td class="colLast"> |
| <div class="block">Provides a default implementation for most methods required by the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>MathTransform</code></a> interface.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractMathTransform.Inverse.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform.Inverse</a></th> |
| <td class="colLast"> |
| <div class="block">Base class for implementations of inverse math transforms.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractMathTransform1D.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform1D</a></th> |
| <td class="colLast"> |
| <div class="block">Base class for math transforms that are known to be one-dimensional in all cases.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractMathTransform1D.Inverse.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform1D.Inverse</a></th> |
| <td class="colLast"> |
| <div class="block">Base class for implementation of inverse math transforms.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractMathTransform2D.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform2D</a></th> |
| <td class="colLast"> |
| <div class="block">Base class for math transforms that are known to be two-dimensional in all cases.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractMathTransform2D.Inverse.html" title="class in org.apache.sis.referencing.operation.transform">AbstractMathTransform2D.Inverse</a></th> |
| <td class="colLast"> |
| <div class="block">Base class for implementation of inverse math transforms.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ContextualParameters.html" title="class in org.apache.sis.referencing.operation.transform">ContextualParameters</a></th> |
| <td class="colLast"> |
| <div class="block">The parameters that describe a sequence of |
| <cite>normalize</cite> → <cite>non-linear kernel</cite> → <cite>denormalize</cite> transforms as a whole.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DatumShiftTransform.html" title="class in org.apache.sis.referencing.operation.transform">DatumShiftTransform</a></th> |
| <td class="colLast"> |
| <div class="block">Transforms between two CRS (usually geographic) based on different datum.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultMathTransformFactory.html" title="class in org.apache.sis.referencing.operation.transform">DefaultMathTransformFactory</a></th> |
| <td class="colLast"> |
| <div class="block">Low level factory for creating <a href="AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">math transforms</a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultMathTransformFactory.Context.html" title="class in org.apache.sis.referencing.operation.transform">DefaultMathTransformFactory.Context</a></th> |
| <td class="colLast"> |
| <div class="block">Source and target coordinate systems for which a new parameterized transform is going to be used.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EllipsoidToCentricTransform.html" title="class in org.apache.sis.referencing.operation.transform">EllipsoidToCentricTransform</a></th> |
| <td class="colLast"> |
| <div class="block">Transform from two- or three- dimensional ellipsoidal coordinates to (geo)centric coordinates.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="InterpolatedGeocentricTransform.html" title="class in org.apache.sis.referencing.operation.transform">InterpolatedGeocentricTransform</a></th> |
| <td class="colLast"> |
| <div class="block">Transforms between two geographic CRS by performing geocentric translations interpolated from a grid file.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="InterpolatedMolodenskyTransform.html" title="class in org.apache.sis.referencing.operation.transform">InterpolatedMolodenskyTransform</a></th> |
| <td class="colLast"> |
| <div class="block">Transforms between two geographic CRS by performing geocentric translations interpolated from a grid file, but using |
| Molodensky approximation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="InterpolatedTransform.html" title="class in org.apache.sis.referencing.operation.transform">InterpolatedTransform</a></th> |
| <td class="colLast"> |
| <div class="block">Transforms between two CRS by performing translations interpolated from a grid file.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="MathTransforms.html" title="class in org.apache.sis.referencing.operation.transform">MathTransforms</a></th> |
| <td class="colLast"> |
| <div class="block">Utility methods creating or working on <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>MathTransform</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="MolodenskyTransform.html" title="class in org.apache.sis.referencing.operation.transform">MolodenskyTransform</a></th> |
| <td class="colLast"> |
| <div class="block">Two- or three-dimensional datum shift using the (potentially abridged) Molodensky transformation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PassThroughTransform.html" title="class in org.apache.sis.referencing.operation.transform">PassThroughTransform</a></th> |
| <td class="colLast"> |
| <div class="block">Transform which passes through a subset of coordinates to another transform.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="TransferFunction.html" title="class in org.apache.sis.referencing.operation.transform">TransferFunction</a></th> |
| <td class="colLast"> |
| <div class="block">The function converting raster <cite>sample values</cite> to <cite>geophysics values</cite>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="TransformSeparator.html" title="class in org.apache.sis.referencing.operation.transform">TransformSeparator</a></th> |
| <td class="colLast"> |
| <div class="block">Extracts a sub-transform from a given <code>MathTransform</code> and source or target dimension indices.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ContextualParameters.MatrixRole.html" title="enum in org.apache.sis.referencing.operation.transform">ContextualParameters.MatrixRole</a></th> |
| <td class="colLast"> |
| <div class="block">Whether a matrix is used for <cite>normalization</cite> or <cite>denormalization</cite> |
| before or after a non-linear operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EllipsoidToCentricTransform.TargetType.html" title="enum in org.apache.sis.referencing.operation.transform">EllipsoidToCentricTransform.TargetType</a></th> |
| <td class="colLast"> |
| <div class="block">Whether the output coordinate system is Cartesian or Spherical.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="IterationStrategy.html" title="enum in org.apache.sis.referencing.operation.transform">IterationStrategy</a></th> |
| <td class="colLast"> |
| <div class="block">Strategy for iterating over the point arrays given to |
| <a href="AbstractMathTransform.html#transform(double%5B%5D,int,double%5B%5D,int,int)"><code>AbstractMathTransform.transform(…)</code></a> methods.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
