| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>CRS (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, class: CRS"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.referencing.CRS class"> |
| <meta name="keywords" content="forCode()"> |
| <meta name="keywords" content="fromWKT()"> |
| <meta name="keywords" content="fromXML()"> |
| <meta name="keywords" content="fromAuthority()"> |
| <meta name="keywords" content="suggestCommonTarget()"> |
| <meta name="keywords" content="findOperation()"> |
| <meta name="keywords" content="findOperations()"> |
| <meta name="keywords" content="getLinearAccuracy()"> |
| <meta name="keywords" content="getGeographicBoundingBox()"> |
| <meta name="keywords" content="getDomainOfValidity()"> |
| <meta name="keywords" content="compound()"> |
| <meta name="keywords" content="selectDimensions()"> |
| <meta name="keywords" content="selectComponents()"> |
| <meta name="keywords" content="isHorizontalCRS()"> |
| <meta name="keywords" content="getHorizontalComponent()"> |
| <meta name="keywords" content="getVerticalComponent()"> |
| <meta name="keywords" content="getTemporalComponent()"> |
| <meta name="keywords" content="getSingleComponents()"> |
| <meta name="keywords" content="getComponentAt()"> |
| <meta name="keywords" content="getGreenwichLongitude()"> |
| <meta name="keywords" content="getAuthorityFactory()"> |
| <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>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="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</a></div> |
| <h1 title="Class CRS" class="title">Class CRS</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="../../../../../org.apache.sis.util/org/apache/sis/util/Static.html" title="class in org.apache.sis.util">Static</a> |
| <div class="inheritance">CRS</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">CRS</span> |
| <span class="extends-implements">extends <a href="../../../../../org.apache.sis.util/org/apache/sis/util/Static.html" title="class in org.apache.sis.util">Static</a></span></div> |
| <div class="block">Static methods working on <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">Coordinate Reference Systems</a>. |
| The methods defined in this class can be grouped in three categories: |
| |
| <ul> |
| <li>Factory methods, the most notable one being <a href="#forCode(java.lang.String)"><code>forCode(String)</code></a>.</li> |
| <li>Methods providing information, like <a href="#isHorizontalCRS(org.opengis.referencing.crs.CoordinateReferenceSystem)"><code>isHorizontalCRS(CoordinateReferenceSystem)</code></a>.</li> |
| <li>Finding coordinate operations between a source and a target CRS.</li> |
| </ul> |
| |
| <h2 id="usage-example-heading">Usage example</h2> |
| The most frequently used methods in this class are <a href="#forCode(java.lang.String)"><code>forCode(…)</code></a>, <a href="#fromWKT(java.lang.String)"><code>fromWKT(…)</code></a> |
| and <a href="#findOperation(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.metadata.extent.GeographicBoundingBox)"><code>findOperation(…)</code></a>. An usage example is like below |
| (see the <a href="https://sis.apache.org/tables/CoordinateReferenceSystems.html">Apache SIS™ Coordinate |
| Reference System (CRS) codes</a> page for the complete list of EPSG codes): |
| |
| |
| <div class="snippet-container"><button class="copy snippet-copy" aria-label="Copy snippet" onclick="copySnippet(this)"><span data-copied="Copied!">Copy</span><img src="../../../../../copy.svg" alt="Copy snippet"></button> |
| <pre class="snippet"><code class="language-java">CoordinateReferenceSystem source = CRS.forCode("EPSG:4326"); // WGS 84 |
| CoordinateReferenceSystem target = CRS.forCode("EPSG:3395"); // WGS 84 / World Mercator |
| CoordinateOperation operation = CRS.findOperation(source, target, null); |
| if (CRS.getLinearAccuracy(operation) > 100) { |
| // If the accuracy is coarser than 100 metres (or any other threshold at application choice) |
| // maybe the operation is not suitable. Decide here what to do (throw an exception, etc). |
| } |
| MathTransform mt = operation.getMathTransform(); |
| DirectPosition position = new DirectPosition2D(20, 30); // 20°N 30°E (watch out axis order!) |
| position = mt.transform(position, position); |
| System.out.println(position); |
| </code></pre> |
| </div> |
| |
| |
| <h2 id="note-on-kinds-of-crs-heading">Note on kinds of CRS</h2> |
| The <a href="#getSingleComponents(org.opengis.referencing.crs.CoordinateReferenceSystem)"><code>getSingleComponents(CoordinateReferenceSystem)</code></a> method decomposes an arbitrary CRS into a flat |
| list of single components. In such flat list, vertical and temporal components can easily be identified by |
| <code>instanceof</code> checks. But identifying the horizontal component is not as easy. The list below suggests |
| ways to classify the components: |
| |
| <ul> |
| <li><code>if (crs instanceof TemporalCRS)</code> determines if the CRS is for the temporal component.</li> |
| <li><code>if (crs instanceof VerticalCRS)</code> determines if the CRS is for the vertical component.</li> |
| <li><code>if (CRS.<a href="#isHorizontalCRS(org.opengis.referencing.crs.CoordinateReferenceSystem)">isHorizontalCRS</a>(crs))</code> |
| determines if the CRS is for the horizontal component.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-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-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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#compound(org.opengis.referencing.crs.CoordinateReferenceSystem...)" class="member-name-link">compound</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a>... components)</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 compound coordinate reference system from an ordered list of CRS components.</div> |
| </div> |
| <div class="col-first odd-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/CoordinateOperation.html" title="class or interface in org.opengis.referencing.operation" class="external-link">CoordinateOperation</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#findOperation(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.metadata.extent.GeographicBoundingBox)" class="member-name-link">findOperation</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> sourceCRS, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> targetCRS, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/GeographicBoundingBox.html" title="class or interface in org.opengis.metadata.extent" class="external-link">GeographicBoundingBox</a> areaOfInterest)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Finds a mathematical operation that transforms or converts coordinates from the given source to the |
| given target coordinate reference system.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/CoordinateOperation.html" title="class or interface in org.opengis.referencing.operation" class="external-link">CoordinateOperation</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#findOperations(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.metadata.extent.GeographicBoundingBox)" class="member-name-link">findOperations</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> sourceCRS, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> targetCRS, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/GeographicBoundingBox.html" title="class or interface in org.opengis.metadata.extent" class="external-link">GeographicBoundingBox</a> areaOfInterest)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Finds mathematical operations that transform or convert coordinates from the given source to the |
| given target coordinate reference system.</div> |
| </div> |
| <div class="col-first odd-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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#forCode(java.lang.String)" class="member-name-link">forCode</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> code)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the Coordinate Reference System for the given authority code.</div> |
| </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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromAuthority(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CRSAuthorityFactory,java.util.logging.Filter)" class="member-name-link">fromAuthority</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CRSAuthorityFactory.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CRSAuthorityFactory</a> factory, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Filter.html" title="class or interface in java.util.logging" class="external-link">Filter</a> warningFilter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Replaces the given coordinate reference system by an authoritative description, if one can be found.</div> |
| </div> |
| <div class="col-first odd-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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromWKT(java.lang.String)" class="member-name-link">fromWKT</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> text)</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 Coordinate Reference System object from a <cite>Well Known Text</cite> (WKT).</div> |
| </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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromXML(java.lang.String)" class="member-name-link">fromXML</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> xml)</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 coordinate reference system object from a XML string.</div> |
| </div> |
| <div class="col-first odd-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/crs/CRSAuthorityFactory.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CRSAuthorityFactory</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getAuthorityFactory(java.lang.String)" class="member-name-link">getAuthorityFactory</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> authority)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the system-wide authority factory used by <a href="#forCode(java.lang.String)"><code>forCode(String)</code></a> and other SIS methods.</div> |
| </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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getComponentAt(org.opengis.referencing.crs.CoordinateReferenceSystem,int,int)" class="member-name-link">getComponentAt</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs, |
| int lower, |
| int upper)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the coordinate reference system in the given range of dimension indices.</div> |
| </div> |
| <div class="col-first odd-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/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">Envelope</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDomainOfValidity(org.opengis.referencing.crs.CoordinateReferenceSystem)" class="member-name-link">getDomainOfValidity</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the domain of validity of the specified coordinate reference system, or <code>null</code> if unknown.</div> |
| </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/metadata/extent/GeographicBoundingBox.html" title="class or interface in org.opengis.metadata.extent" class="external-link">GeographicBoundingBox</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getGeographicBoundingBox(org.opengis.referencing.crs.CoordinateReferenceSystem)" class="member-name-link">getGeographicBoundingBox</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the valid geographic area for the given coordinate reference system, or <code>null</code> if unknown.</div> |
| </div> |
| <div class="col-first odd-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/metadata/extent/GeographicBoundingBox.html" title="class or interface in org.opengis.metadata.extent" class="external-link">GeographicBoundingBox</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getGeographicBoundingBox(org.opengis.referencing.operation.CoordinateOperation)" class="member-name-link">getGeographicBoundingBox</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/CoordinateOperation.html" title="class or interface in org.opengis.referencing.operation" class="external-link">CoordinateOperation</a> operation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the valid geographic area for the given coordinate operation, or <code>null</code> if unknown.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getGreenwichLongitude(org.opengis.referencing.crs.GeodeticCRS)" class="member-name-link">getGreenwichLongitude</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/GeodeticCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">GeodeticCRS</a> crs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the Greenwich longitude of the prime meridian of the given CRS in degrees.</div> |
| </div> |
| <div class="col-first odd-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/crs/SingleCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">SingleCRS</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getHorizontalComponent(org.opengis.referencing.crs.CoordinateReferenceSystem)" class="member-name-link">getHorizontalComponent</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the first horizontal coordinate reference system found in the given CRS, or <code>null</code> if there is |
| none.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLinearAccuracy(org.opengis.referencing.operation.CoordinateOperation)" class="member-name-link">getLinearAccuracy</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/CoordinateOperation.html" title="class or interface in org.opengis.referencing.operation" class="external-link">CoordinateOperation</a> operation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a positional accuracy estimation in metres for the given operation, or <code>NaN</code> if unknown.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/SingleCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">SingleCRS</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSingleComponents(org.opengis.referencing.crs.CoordinateReferenceSystem)" class="member-name-link">getSingleComponents</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the ordered list of single coordinate reference systems for the specified CRS.</div> |
| </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/crs/TemporalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">TemporalCRS</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTemporalComponent(org.opengis.referencing.crs.CoordinateReferenceSystem)" class="member-name-link">getTemporalComponent</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the first temporal coordinate reference system found in the given CRS, or <code>null</code> if there is none.</div> |
| </div> |
| <div class="col-first odd-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/crs/VerticalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">VerticalCRS</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getVerticalComponent(org.opengis.referencing.crs.CoordinateReferenceSystem,boolean)" class="member-name-link">getVerticalComponent</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs, |
| boolean allowCreateEllipsoidal)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the first vertical coordinate reference system found in the given CRS, or <code>null</code> if there is none.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isHorizontalCRS(org.opengis.referencing.crs.CoordinateReferenceSystem)" class="member-name-link">isHorizontalCRS</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns <code>true</code> if the given CRS is horizontal.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#selectComponents(org.opengis.referencing.crs.CoordinateReferenceSystem,int...)" class="member-name-link">selectComponents</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs, |
| int... dimensions)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets or creates CRS components for a subset of the dimensions of the given CRS.</div> |
| </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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#selectDimensions(org.opengis.referencing.crs.CoordinateReferenceSystem,int...)" class="member-name-link">selectDimensions</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs, |
| int... dimensions)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets or creates a coordinate reference system with a subset of the dimensions of the given CRS.</div> |
| </div> |
| <div class="col-first odd-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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#suggestCommonTarget(org.opengis.metadata.extent.GeographicBoundingBox,org.opengis.referencing.crs.CoordinateReferenceSystem...)" class="member-name-link">suggestCommonTarget</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/GeographicBoundingBox.html" title="class or interface in org.opengis.metadata.extent" class="external-link">GeographicBoundingBox</a> regionOfInterest, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a>... sourceCRS)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Suggests a coordinate reference system which could be a common target for coordinate operations having the |
| given sources.</div> |
| </div> |
| </div> |
| </div> |
| </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#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/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#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</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#toString()" title="class or interface in java.lang" class="external-link">toString</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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="forCode(java.lang.String)"> |
| <h3>forCode</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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></span> <span class="element-name">forCode</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> code)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/NoSuchAuthorityCodeException.html" title="class or interface in org.opengis.referencing" class="external-link">NoSuchAuthorityCodeException</a>, |
| <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">Returns the Coordinate Reference System for the given authority code. |
| There is <a href="https://sis.apache.org/tables/CoordinateReferenceSystems.html">many thousands |
| of reference systems</a> defined by the EPSG authority or by other authorities. |
| Whether those codes are recognized or not depends on whether the |
| <a href="https://sis.apache.org/epsg.html">EPSG dataset is installed</a>. |
| The following table lists a small subset of codes which are guaranteed to be available |
| on any installation of Apache SIS: |
| |
| <blockquote><table class="sis"> |
| <caption>Minimal set of supported authority codes</caption> |
| <tr><th>Code</th> <th>Enum</th> <th>CRS Type</th> <th>Description</th></tr> |
| <tr><td>CRS:27</td> <td><a href="CommonCRS.html#NAD27"><code>NAD27</code></a></td> <td>Geographic</td> <td>Like EPSG:4267 except for (<var>longitude</var>, <var>latitude</var>) axis order</td></tr> |
| <tr><td>CRS:83</td> <td><a href="CommonCRS.html#NAD83"><code>NAD83</code></a></td> <td>Geographic</td> <td>Like EPSG:4269 except for (<var>longitude</var>, <var>latitude</var>) axis order</td></tr> |
| <tr><td>CRS:84</td> <td><a href="CommonCRS.html#WGS84"><code>WGS84</code></a></td> <td>Geographic</td> <td>Like EPSG:4326 except for (<var>longitude</var>, <var>latitude</var>) axis order</td></tr> |
| <tr><td>CRS:88</td> <td><a href="CommonCRS.Vertical.html#NAVD88"><code>NAVD88</code></a></td><td>Vertical</td><td>North American Vertical Datum 1988 height</td></tr> |
| <tr><td>EPSG:4230</td> <td><a href="CommonCRS.html#ED50"><code>ED50</code></a></td> <td>Geographic</td> <td>European Datum 1950</td></tr> |
| <tr><td>EPSG:4258</td> <td><a href="CommonCRS.html#ETRS89"><code>ETRS89</code></a></td> <td>Geographic</td> <td>European Terrestrial Reference System 1989</td></tr> |
| <tr><td>EPSG:4267</td> <td><a href="CommonCRS.html#NAD27"><code>NAD27</code></a></td> <td>Geographic</td> <td>North American Datum 1927</td></tr> |
| <tr><td>EPSG:4269</td> <td><a href="CommonCRS.html#NAD83"><code>NAD83</code></a></td> <td>Geographic</td> <td>North American Datum 1983</td></tr> |
| <tr><td>EPSG:4322</td> <td><a href="CommonCRS.html#WGS72"><code>WGS72</code></a></td> <td>Geographic</td> <td>World Geodetic System 1972</td></tr> |
| <tr><td>EPSG:4326</td> <td><a href="CommonCRS.html#WGS84"><code>WGS84</code></a></td> <td>Geographic</td> <td>World Geodetic System 1984</td></tr> |
| <tr><td>EPSG:4936</td> <td><a href="CommonCRS.html#ETRS89"><code>ETRS89</code></a></td> <td>Geocentric</td> <td>European Terrestrial Reference System 1989</td></tr> |
| <tr><td>EPSG:4937</td> <td><a href="CommonCRS.html#ETRS89"><code>ETRS89</code></a></td> <td>Geographic 3D</td> <td>European Terrestrial Reference System 1989</td></tr> |
| <tr><td>EPSG:4978</td> <td><a href="CommonCRS.html#WGS84"><code>WGS84</code></a></td> <td>Geocentric</td> <td>World Geodetic System 1984</td></tr> |
| <tr><td>EPSG:4979</td> <td><a href="CommonCRS.html#WGS84"><code>WGS84</code></a></td> <td>Geographic 3D</td> <td>World Geodetic System 1984</td></tr> |
| <tr><td>EPSG:4984</td> <td><a href="CommonCRS.html#WGS72"><code>WGS72</code></a></td> <td>Geocentric</td> <td>World Geodetic System 1972</td></tr> |
| <tr><td>EPSG:4985</td> <td><a href="CommonCRS.html#WGS72"><code>WGS72</code></a></td> <td>Geographic 3D</td> <td>World Geodetic System 1972</td></tr> |
| <tr><td>EPSG:5041</td> <td><a href="CommonCRS.html#WGS84"><code>WGS84</code></a></td> <td>Projected</td> <td>WGS 84 / UPS North (E,N)</td></tr> |
| <tr><td>EPSG:5042</td> <td><a href="CommonCRS.html#WGS84"><code>WGS84</code></a></td> <td>Projected</td> <td>WGS 84 / UPS South (E,N)</td></tr> |
| <tr><td>EPSG:322##</td> <td><a href="CommonCRS.html#WGS72"><code>WGS72</code></a></td> <td>Projected</td> <td>WGS 72 / UTM zone ##N</td></tr> |
| <tr><td>EPSG:323##</td> <td><a href="CommonCRS.html#WGS72"><code>WGS72</code></a></td> <td>Projected</td> <td>WGS 72 / UTM zone ##S</td></tr> |
| <tr><td>EPSG:326##</td> <td><a href="CommonCRS.html#WGS84"><code>WGS84</code></a></td> <td>Projected</td> <td>WGS 84 / UTM zone ##N</td></tr> |
| <tr><td>EPSG:327##</td> <td><a href="CommonCRS.html#WGS84"><code>WGS84</code></a></td> <td>Projected</td> <td>WGS 84 / UTM zone ##S</td></tr> |
| <tr><td>EPSG:5714</td> <td><a href="CommonCRS.Vertical.html#MEAN_SEA_LEVEL"><code>MEAN_SEA_LEVEL</code></a></td> <td>Vertical</td> <td>Mean Sea Level height</td></tr> |
| <tr><td>EPSG:5715</td> <td><a href="CommonCRS.Vertical.html#DEPTH"><code>DEPTH</code></a></td> <td>Vertical</td> <td>Mean Sea Level depth</td></tr> |
| <tr><td>OGC:JulianDate</td><td><a href="CommonCRS.Temporal.html#JULIAN"><code>JULIAN</code></a></td> <td>Temporal</td> <td>Julian date (days)</td></tr> |
| <tr><td>OGC:TruncatedJulianDate</td><td><a href="CommonCRS.Temporal.html#TRUNCATED_JULIAN"><code>TRUNCATED_JULIAN</code></a></td> <td>Temporal</td> <td>Truncated Julian date (days)</td></tr> |
| <tr><td>OGC:UnixTime</td> <td><a href="CommonCRS.Temporal.html#UNIX"><code>UNIX</code></a></td> <td>Unix</td> <td>Unix time (seconds)</td></tr> |
| </table></blockquote> |
| |
| For codes in above table, the EPSG geodetic database is used when available, |
| otherwise Apache SIS fallbacks on definitions from public sources with no EPSG metadata except the identifiers. |
| If the EPSG geodetic dataset has been used, the <a href="ImmutableIdentifier.html#getAuthority()">authority</a> title |
| will be something like <cite>"EPSG geodetic dataset"</cite>, otherwise it will be <cite>"Subset of EPSG"</cite>. |
| |
| <h4 id="uri-forms-heading">URI forms</h4> |
| This method accepts also the URN and URL syntaxes. |
| For example, the following codes are considered equivalent to <code>"EPSG:4326"</code>: |
| <ul> |
| <li><code>"EPSG::4326"</code></li> |
| <li><code>"urn:ogc:def:crs:EPSG::4326"</code></li> |
| <li><code>"http://www.opengis.net/def/crs/epsg/0/4326"</code></li> |
| <li><code>"http://www.opengis.net/gml/srs/epsg.xml#4326"</code></li> |
| </ul> |
| |
| URIs can be combined for creating larger objects. For example, the following URIs combine a |
| two-dimensional WGS84 reference system (EPSG:4326) with a Mean Sea Level height (EPSG:5714). |
| The result is a three-dimensional <a href="crs/DefaultCompoundCRS.html" title="class in org.apache.sis.referencing.crs">compound coordinate reference system</a>: |
| |
| <ul> |
| <li><code>"urn:ogc:def:crs,crs:EPSG::4326,crs:EPSG::5714"</code></li> |
| <li><code>"http://www.opengis.net/def/crs-compound?<br> |
| 1=http://www.opengis.net/def/crs/epsg/0/4326&<br> |
| 2=http://www.opengis.net/def/crs/epsg/0/5714"</code></li> |
| </ul> |
| |
| <p>URNs (but not URLs) can also combine a |
| <a href="datum/DefaultGeodeticDatum.html" title="class in org.apache.sis.referencing.datum">geodetic datum</a> with an |
| <a href="cs/DefaultEllipsoidalCS.html" title="class in org.apache.sis.referencing.cs">ellipsoidal coordinate system</a> for creating a new |
| <a href="crs/DefaultGeographicCRS.html" title="class in org.apache.sis.referencing.crs">geographic CRS</a>, or a base geographic CRS with a |
| <a href="operation/DefaultConversion.html" title="class in org.apache.sis.referencing.operation">conversion</a> and a |
| <a href="cs/DefaultCartesianCS.html" title="class in org.apache.sis.referencing.cs">Cartesian coordinate system</a> for creating a new |
| <a href="crs/DefaultProjectedCRS.html" title="class in org.apache.sis.referencing.crs">projected coordinate reference system</a>.</p> |
| |
| <h4 id="reverse-operation-heading">Reverse operation</h4> |
| The <a href="IdentifiedObjects.html#lookupURN(org.opengis.referencing.IdentifiedObject,org.opengis.metadata.citation.Citation)"><code>IdentifiedObjects.lookupURN(IdentifiedObject, Citation)</code></a> method can be seen |
| as a converse of this method: from a CRS object, it tries to find a URN that describes it. |
| More codes may also be supported depending on which extension modules are available.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>code</code> - the authority code.</dd> |
| <dt>Returns:</dt> |
| <dd>the Coordinate Reference System for the given authority code.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/NoSuchAuthorityCodeException.html" title="class or interface in org.opengis.referencing" class="external-link">NoSuchAuthorityCodeException</a></code> - if there is no known CRS associated to the given code.</dd> |
| <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 the CRS creation failed for another reason.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="#getAuthorityFactory(java.lang.String)"><code>getAuthorityFactory(String)</code></a></li> |
| <li><a href="factory/GeodeticAuthorityFactory.html" title="class in org.apache.sis.referencing.factory"><code>GeodeticAuthorityFactory</code></a></li> |
| <li><a href="https://epsg.org/">EPSG Geodetic Registry</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fromWKT(java.lang.String)"> |
| <h3>fromWKT</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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></span> <span class="element-name">fromWKT</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> text)</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 Coordinate Reference System object from a <cite>Well Known Text</cite> (WKT). |
| The default <a href="../io/wkt/package-summary.html">Apache SIS parser</a> understands both |
| version 1 (a.k.a. OGC 01-009) and version 2 (a.k.a. ISO 19162) of the WKT format. |
| |
| <h4 id="example-heading">Example</h4> |
| Below is a slightly simplified WKT 2 string for a Mercator projection. |
| For making this example smaller, some optional <code>UNIT[…]</code> and <code>ORDER[…]</code> elements have been omitted. |
| |
| |
| <div class="snippet-container"><button class="copy snippet-copy" aria-label="Copy snippet" onclick="copySnippet(this)"><span data-copied="Copied!">Copy</span><img src="../../../../../copy.svg" alt="Copy snippet"></button> |
| <pre class="snippet"><code class="language-wkt">ProjectedCRS["SIRGAS 2000 / Brazil Mercator", |
| BaseGeodCRS["SIRGAS 2000", |
| Datum["Sistema de Referencia Geocentrico para las Americas 2000", |
| Ellipsoid["GRS 1980", 6378137, 298.257222101]]], |
| Conversion["Petrobras Mercator", |
| Method["Mercator (variant B)", Id["EPSG",9805]], |
| Parameter["Latitude of 1st standard parallel", -2], |
| Parameter["Longitude of natural origin", -43], |
| Parameter["False easting", 5000000], |
| Parameter["False northing", 10000000]], |
| CS[cartesian,2], |
| Axis["easting (E)", east], |
| Axis["northing (N)", north], |
| LengthUnit["metre", 1], |
| Id["EPSG",5641]] |
| </code></pre> |
| </div> |
| |
| |
| <h4 id="logging-heading">Logging</h4> |
| If the parsing produced warnings, they will be reported in a logger named <code>"org.apache.sis.io.wkt"</code>. |
| In particular, this method verifies if the description provided by the WKT matches the description provided |
| by the authority (<code>"EPSG:5641"</code> in above example) and reports discrepancies. |
| Note that this comparison between parsed CRS and authoritative CRS is specific to this convenience method; |
| other APIs documented in <cite>see also</cite> section do not perform this comparison automatically. |
| Should the WKT description and the authoritative description be in conflict, the WKT description prevails |
| as mandated by ISO 19162 standard (see <a href="#fromAuthority(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CRSAuthorityFactory,java.util.logging.Filter)"><code>fromAuthority(…)</code></a> if a different behavior is needed). |
| |
| <h4 id="usage-and-performance-considerations-heading">Usage and performance considerations</h4> |
| This convenience method delegates to <a href="factory/GeodeticObjectFactory.html#createFromWKT(java.lang.String)"><code>GeodeticObjectFactory.createFromWKT(String)</code></a> |
| using a default factory instance. This is okay for occasional use, but has the following limitations: |
| |
| <ul> |
| <li>Performance may be sub-optimal in a multi-thread environment.</li> |
| <li>No control on the WKT <a href="../io/wkt/Convention.html" title="enum class in org.apache.sis.io.wkt">conventions</a> in use.</li> |
| <li>No control on the handling of <a href="../io/wkt/Warnings.html" title="class in org.apache.sis.io.wkt">warnings</a>.</li> |
| </ul> |
| |
| Applications which need to parse a large amount of WKT strings should consider to use |
| the <a href="../io/wkt/WKTFormat.html" title="class in org.apache.sis.io.wkt"><code>WKTFormat</code></a> class instead of this method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>text</code> - coordinate system encoded in Well-Known Text format (version 1 or 2).</dd> |
| <dt>Returns:</dt> |
| <dd>the parsed Coordinate Reference System.</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 the given WKT cannot be parsed.</dd> |
| <dt>Since:</dt> |
| <dd>0.6</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="../io/wkt/WKTFormat.html" title="class in org.apache.sis.io.wkt"><code>WKTFormat</code></a></li> |
| <li><a href="factory/GeodeticObjectFactory.html#createFromWKT(java.lang.String)"><code>GeodeticObjectFactory.createFromWKT(String)</code></a></li> |
| <li><a href="../geometry/Envelopes.html#fromWKT(java.lang.CharSequence)"><code>Envelopes.fromWKT(CharSequence)</code></a></li> |
| <li><a href="http://docs.opengeospatial.org/is/12-063r5/12-063r5.html">WKT 2 specification</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fromXML(java.lang.String)"> |
| <h3>fromXML</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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></span> <span class="element-name">fromXML</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> xml)</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 coordinate reference system object from a XML string. |
| Note that the given argument is the XML document itself, <strong>not</strong> a URL to a XML document. |
| For reading XML documents from readers or input streams, |
| see static methods in the <a href="../../../../../org.apache.sis.metadata/org/apache/sis/xml/XML.html" title="class in org.apache.sis.xml"><code>XML</code></a> class. |
| |
| <p>If the unmarshalling produced warnings, they will be reported in a logger named <code>"org.apache.sis.xml"</code>. |
| In particular, this method verifies if the description provided by the XML matches the description provided by |
| the authority code given in <code><gml:identifier></code> element, and reports discrepancies. |
| Note that this comparison between unmarshalled CRS and authoritative CRS is specific to this convenience method; |
| other APIs documented in <cite>see also</cite> section do not perform this comparison automatically. |
| Should the XML description and the authoritative description be in conflict, the XML description prevails |
| (see <a href="#fromAuthority(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CRSAuthorityFactory,java.util.logging.Filter)"><code>fromAuthority(…)</code></a> if a different behavior is needed).</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>xml</code> - coordinate reference system encoded in XML format.</dd> |
| <dt>Returns:</dt> |
| <dd>the unmarshalled Coordinate Reference System.</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 the object creation failed.</dd> |
| <dt>Since:</dt> |
| <dd>0.7</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="factory/GeodeticObjectFactory.html#createFromXML(java.lang.String)"><code>GeodeticObjectFactory.createFromXML(String)</code></a></li> |
| <li><a href="../../../../../org.apache.sis.metadata/org/apache/sis/xml/XML.html#unmarshal(java.lang.String)"><code>XML.unmarshal(String)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fromAuthority(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CRSAuthorityFactory,java.util.logging.Filter)"> |
| <h3>fromAuthority</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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></span> <span class="element-name">fromAuthority</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CRSAuthorityFactory.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CRSAuthorityFactory</a> factory, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Filter.html" title="class or interface in java.util.logging" class="external-link">Filter</a> warningFilter)</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">Replaces the given coordinate reference system by an authoritative description, if one can be found. |
| This method can be invoked after constructing a CRS in a context where the EPSG (or other authority) |
| code is suspected more reliable than the rest of the description. A common case is a <cite>Well Known |
| Text</cite> (WKT) string declaring wrong projection method or parameter values for the EPSG code that |
| it pretends to describe. For example: |
| |
| <blockquote> |
| <code>PROJCS["WGS 84 / Pseudo-Mercator",</code><br> |
| <code> </code>(…base CRS omitted for brevity…)<br> |
| <code> PROJECTION["Mercator (variant A)"],</code> — <em><b>wrong:</b> shall be "Popular Visualisation Pseudo Mercator"</em><br> |
| <code> </code>(…parameters and axes omitted for brevity…)<br> |
| <code> AUTHORITY["EPSG", "3857"]]</code> |
| </blockquote> |
| |
| In such cases, Apache SIS behavior in <a href="#fromWKT(java.lang.String)"><code>fromWKT(String)</code></a>, <a href="#fromXML(java.lang.String)"><code>fromXML(String)</code></a> and other methods is |
| conform to the <a href="http://docs.opengeospatial.org/is/12-063r5/12-063r5.html">ISO 19162 specification</a>: |
| |
| <blockquote><cite>"Should any attributes or values given in the cited identifier be in conflict with attributes |
| or values given explicitly in the WKT description, the WKT values shall prevail."</cite></blockquote> |
| |
| In situations where the opposite behavior is desired (i.e. to make the authority identifier prevails), |
| this method can be invoked. This method performs the following actions: |
| |
| <ul> |
| <li>If the given CRS has an <a href="AbstractIdentifiedObject.html#getIdentifiers()">identifier</a> and if the authority factory can |
| <a href="factory/GeodeticAuthorityFactory.html#createCoordinateReferenceSystem(java.lang.String)">create a CRS</a> |
| for that identifier, then: |
| <ul> |
| <li>If the CRS defined by the authority is <a href="../../../../../org.apache.sis.util/org/apache/sis/util/Utilities.html#equalsIgnoreMetadata(java.lang.Object,java.lang.Object)">equal, ignoring metadata</a>, |
| to the given CRS, then this method returns silently the <em>authoritative</em> CRS.</li> |
| <li>Otherwise if the CRS defined by the authority is equal, ignoring axis order and units, to the given CRS, |
| then this method returns a <em>new</em> CRS derived from the authoritative one but with same |
| <a href="cs/AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">axes convention</a> than the given CRS. |
| A warning is emitted.</li> |
| <li>Otherwise this method discards the given CRS and returns the <em>authoritative</em> CRS. |
| A warning is emitted with a message indicating where a difference has been found.</li> |
| </ul> |
| </li> |
| <li>Otherwise if the given CRS does not have identifier, then this method |
| <a href="factory/IdentifiedObjectFinder.html" title="class in org.apache.sis.referencing.factory">searches for an equivalent CRS</a> |
| defined by the authority factory. If such CRS is found, then: |
| <ul> |
| <li>If the CRS defined by the authority is <a href="../../../../../org.apache.sis.util/org/apache/sis/util/Utilities.html#equalsIgnoreMetadata(java.lang.Object,java.lang.Object)">equal, ignoring metadata</a>, |
| to the given CRS, then this method returns silently the <em>authoritative</em> CRS.</li> |
| <li>Otherwise if the CRS defined by the authority is equal, ignoring axis order and units, to the given CRS, |
| then this method returns silently a <em>new</em> CRS derived from the authoritative one but with same |
| <a href="cs/AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">axes convention</a> than the given CRS.</li> |
| </ul> |
| </li> |
| <li>Otherwise this method silently returns the given CRS as-is.</li> |
| </ul> |
| |
| <h4 id="avoiding-warning-redundancies-heading">Avoiding warning redundancies</h4> |
| The warnings logged by this method are redundant with warnings logged by other methods in this class, |
| in particular <a href="#fromWKT(java.lang.String)"><code>fromWKT(String)</code></a> and <a href="#fromXML(java.lang.String)"><code>fromXML(String)</code></a> methods. For avoiding this annoyance, |
| a <code>null</code> value for the <code>warningFilter</code> argument means to shut off those redundant loggings. |
| A non-null <code>warningFilter</code> argument is more useful for CRS parsed by methods outside this class, |
| for example <a href="../io/wkt/WKTFormat.html" title="class in org.apache.sis.io.wkt"><code>WKTFormat</code></a> or <a href="../../../../../org.apache.sis.metadata/org/apache/sis/xml/XML.html#unmarshal(java.lang.String)"><code>XML.unmarshal(String)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the CRS to replace by an authoritative CRS, or <code>null</code>.</dd> |
| <dd><code>factory</code> - the factory where to search for authoritative definitions, or <code>null</code> for the default.</dd> |
| <dd><code>warningFilter</code> - whether to log warnings, or <code>null</code> for the default behavior (which is to filter out |
| the warnings that are redundant with warnings emitted by other methods in this class).</dd> |
| <dt>Returns:</dt> |
| <dd>the suggested CRS to use (may be the <code>crs</code> argument itself), or <code>null</code> if the given CRS was null.</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 querying the authority factory.</dd> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="suggestCommonTarget(org.opengis.metadata.extent.GeographicBoundingBox,org.opengis.referencing.crs.CoordinateReferenceSystem...)"> |
| <h3>suggestCommonTarget</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../org.apache.sis.util/org/apache/sis/util/OptionalCandidate.html" title="annotation interface in org.apache.sis.util">@OptionalCandidate</a> |
| </span><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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></span> <span class="element-name">suggestCommonTarget</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/GeographicBoundingBox.html" title="class or interface in org.opengis.metadata.extent" class="external-link">GeographicBoundingBox</a> regionOfInterest, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a>... sourceCRS)</span></div> |
| <div class="block">Suggests a coordinate reference system which could be a common target for coordinate operations having the |
| given sources. This method compares the <a href="#getGeographicBoundingBox(org.opengis.referencing.crs.CoordinateReferenceSystem)">domain of validity</a> of all given CRSs. If a CRS has a domain of validity that contains the domain of all other |
| CRS, then that CRS is returned. Otherwise this method verifies if a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/GeneralDerivedCRS.html#getBaseCRS()" title="class or interface in org.opengis.referencing.crs" class="external-link">base CRS</a> (usually a <a href="crs/DefaultGeographicCRS.html" title="class in org.apache.sis.referencing.crs">geographic CRS</a> instance) |
| would be suitable. If no suitable CRS is found, then this method returns <code>null</code>. |
| |
| <h4 id="use-case-heading">Use case</h4> |
| Before to test if two arbitrary envelopes <a href="../geometry/AbstractEnvelope.html#intersects(org.opengis.geometry.Envelope)">intersect</a> each other, |
| they need to be <a href="../geometry/Envelopes.html#transform(org.opengis.geometry.Envelope,org.opengis.referencing.crs.CoordinateReferenceSystem)">transformed</a> in the same CRS. |
| However if one CRS is a Transverse Mercator projection while the other CRS is a world-wide geographic CRS, then |
| attempts to use the Transverse Mercator projection as the common CRS is likely to fail since the geographic envelope |
| may span an area far outside the projection domain of validity. This <code>suggestCommonTarget(…)</code> method can used |
| for choosing a common CRS which is less likely to fail.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>regionOfInterest</code> - the geographic area for which the coordinate operations will be applied, |
| or <code>null</code> if unknown. Will be intersected with CRS domains of validity.</dd> |
| <dd><code>sourceCRS</code> - the coordinate reference systems for which a common target CRS is desired. |
| May contain <code>null</code> elements, which are ignored.</dd> |
| <dt>Returns:</dt> |
| <dd>a CRS that may be used as a common target for all the given source CRS in the given region of interest, |
| or <code>null</code> if this method did not find a common target CRS. The returned CRS may be different than |
| all given CRS.</dd> |
| <dt>Since:</dt> |
| <dd>0.8</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findOperation(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.metadata.extent.GeographicBoundingBox)"> |
| <h3>findOperation</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/CoordinateOperation.html" title="class or interface in org.opengis.referencing.operation" class="external-link">CoordinateOperation</a></span> <span class="element-name">findOperation</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> sourceCRS, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> targetCRS, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/GeographicBoundingBox.html" title="class or interface in org.opengis.metadata.extent" class="external-link">GeographicBoundingBox</a> areaOfInterest)</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">Finds a mathematical operation that transforms or converts coordinates from the given source to the |
| given target coordinate reference system. If an estimation of the geographic area containing the points |
| to transform is known, it can be specified for helping this method to find a better suited operation. |
| If no area of interest is specified, then the current default is the widest |
| <a href="operation/AbstractCoordinateOperation.html#getDomainOfValidity()">domain of validity</a>. |
| A future Apache SIS version may also take the country of current locale in account. |
| |
| <div class="note"><b>Note:</b> |
| the area of interest is just one aspect that may affect the coordinate operation. |
| Other aspects are the time of interest (because some coordinate operations take in account the |
| plate tectonics movement) or the desired accuracy. For more control on the coordinate operation |
| to create, see <a href="operation/CoordinateOperationContext.html" title="class in org.apache.sis.referencing.operation"><code>CoordinateOperationContext</code></a>.</div> |
| |
| After the caller received a <code>CoordinateOperation</code> instance, the following methods can be invoked |
| for checking if the operation suits the caller's needs: |
| |
| <ul> |
| <li><a href="#getGeographicBoundingBox(org.opengis.referencing.operation.CoordinateOperation)"><code>getGeographicBoundingBox(CoordinateOperation)</code></a> |
| for checking if the operation is valid in the caller's area of interest.</li> |
| <li><a href="#getLinearAccuracy(org.opengis.referencing.operation.CoordinateOperation)"><code>getLinearAccuracy(CoordinateOperation)</code></a> |
| for checking if the operation has sufficient accuracy for caller's purpose.</li> |
| </ul> |
| |
| If the source and target CRS are equivalent, then this method returns an operation backed by an |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform.html#isIdentity()" title="class or interface in org.opengis.referencing.operation" class="external-link">identity</a> transform. |
| If there is no known operation between the given pair of CRS, then this method throws an |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/OperationNotFoundException.html" title="class or interface in org.opengis.referencing.operation" class="external-link"><code>OperationNotFoundException</code></a>. |
| |
| <p>Note that <code>CRS.findOperation(<var>B</var>, <var>A</var>, <var>aoi</var>)</code> is not necessarily |
| the exact converse of <code>CRS.findOperation(<var>A</var>, <var>B</var>, <var>aoi</var>)</code>. |
| Some deviations may exist for example because of different paths explored in the geodetic database. |
| For the inverse of an existing <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/CoordinateOperation.html" title="class or interface in org.opengis.referencing.operation" class="external-link"><code>CoordinateOperation</code></a>, using |
| <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"><code>MathTransform.inverse()</code></a> is preferable.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sourceCRS</code> - the CRS of source coordinates.</dd> |
| <dd><code>targetCRS</code> - the CRS of target coordinates.</dd> |
| <dd><code>areaOfInterest</code> - the area of interest, or <code>null</code> if none.</dd> |
| <dt>Returns:</dt> |
| <dd>the mathematical operation from <code>sourceCRS</code> to <code>targetCRS</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/OperationNotFoundException.html" title="class or interface in org.opengis.referencing.operation" class="external-link">OperationNotFoundException</a></code> - if no operation was found between the given pair of CRS.</dd> |
| <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 the operation cannot be created for another reason.</dd> |
| <dt>Since:</dt> |
| <dd>0.7</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="../geometry/Envelopes.html#findOperation(org.opengis.geometry.Envelope,org.opengis.geometry.Envelope)"><code>Envelopes.findOperation(Envelope, Envelope)</code></a></li> |
| <li><a href="operation/DefaultCoordinateOperationFactory.html#createOperation(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.apache.sis.referencing.operation.CoordinateOperationContext)"><code>DefaultCoordinateOperationFactory.createOperation(CoordinateReferenceSystem, CoordinateReferenceSystem, CoordinateOperationContext)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findOperations(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.metadata.extent.GeographicBoundingBox)"> |
| <h3>findOperations</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/CoordinateOperation.html" title="class or interface in org.opengis.referencing.operation" class="external-link">CoordinateOperation</a>></span> <span class="element-name">findOperations</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> sourceCRS, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> targetCRS, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/GeographicBoundingBox.html" title="class or interface in org.opengis.metadata.extent" class="external-link">GeographicBoundingBox</a> areaOfInterest)</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">Finds mathematical operations that transform or convert coordinates from the given source to the |
| given target coordinate reference system. If at least one operation exists, they are returned in |
| preference order: the operation having the widest intersection between its |
| <a href="operation/AbstractCoordinateOperation.html#getDomainOfValidity()">domain of validity</a> |
| and the given area of interest are returned first.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sourceCRS</code> - the CRS of source coordinates.</dd> |
| <dd><code>targetCRS</code> - the CRS of target coordinates.</dd> |
| <dd><code>areaOfInterest</code> - the area of interest, or <code>null</code> if none.</dd> |
| <dt>Returns:</dt> |
| <dd>mathematical operations from <code>sourceCRS</code> to <code>targetCRS</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/OperationNotFoundException.html" title="class or interface in org.opengis.referencing.operation" class="external-link">OperationNotFoundException</a></code> - if no operation was found between the given pair of CRS.</dd> |
| <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 the operation cannot be created for another reason.</dd> |
| <dt>Since:</dt> |
| <dd>1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="operation/DefaultCoordinateOperationFactory.html#createOperations(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.apache.sis.referencing.operation.CoordinateOperationContext)"><code>DefaultCoordinateOperationFactory.createOperations(CoordinateReferenceSystem, CoordinateReferenceSystem, CoordinateOperationContext)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLinearAccuracy(org.opengis.referencing.operation.CoordinateOperation)"> |
| <h3>getLinearAccuracy</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../org.apache.sis.util/org/apache/sis/util/OptionalCandidate.html" title="annotation interface in org.apache.sis.util">@OptionalCandidate</a> |
| </span><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getLinearAccuracy</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/CoordinateOperation.html" title="class or interface in org.opengis.referencing.operation" class="external-link">CoordinateOperation</a> operation)</span></div> |
| <div class="block">Returns a positional accuracy estimation in metres for the given operation, or <code>NaN</code> if unknown. |
| This method applies the following heuristics: |
| |
| <ul> |
| <li>If the given operation is an instance of <a href="operation/AbstractCoordinateOperation.html" title="class in org.apache.sis.referencing.operation"><code>AbstractCoordinateOperation</code></a>, then delegate to the |
| operation <a href="operation/AbstractCoordinateOperation.html#getLinearAccuracy()"><code>getLinearAccuracy()</code></a> method.</li> |
| |
| <li>Otherwise if at least one <a href="../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/quality/DefaultQuantitativeResult.html" title="class in org.apache.sis.metadata.iso.quality">quantitative result</a> is found with a linear unit, then return the largest value converted to metres.</li> |
| |
| <li>Otherwise if the operation is a <a href="operation/DefaultConversion.html" title="class in org.apache.sis.referencing.operation">conversion</a>, then returns 0 since a conversion is by definition accurate up to rounding errors.</li> |
| |
| <li>Otherwise if the operation is a <a href="operation/DefaultTransformation.html" title="class in org.apache.sis.referencing.operation">transformation</a>, then the returned value depends on whether the datum shift were applied with the help |
| of Bursa-Wolf parameters of not.</li> |
| </ul> |
| |
| See <a href="operation/AbstractCoordinateOperation.html#getLinearAccuracy()"><code>AbstractCoordinateOperation.getLinearAccuracy()</code></a> for more details on the above heuristic rules.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>operation</code> - the coordinate operation for which to get the accuracy estimation, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the accuracy estimation (always in meters), or NaN if unknown.</dd> |
| <dt>Since:</dt> |
| <dd>0.7</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#findOperation(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.metadata.extent.GeographicBoundingBox)"><code>findOperation(CoordinateReferenceSystem, CoordinateReferenceSystem, GeographicBoundingBox)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGeographicBoundingBox(org.opengis.referencing.operation.CoordinateOperation)"> |
| <h3>getGeographicBoundingBox</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../org.apache.sis.util/org/apache/sis/util/OptionalCandidate.html" title="annotation interface in org.apache.sis.util">@OptionalCandidate</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/GeographicBoundingBox.html" title="class or interface in org.opengis.metadata.extent" class="external-link">GeographicBoundingBox</a></span> <span class="element-name">getGeographicBoundingBox</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/CoordinateOperation.html" title="class or interface in org.opengis.referencing.operation" class="external-link">CoordinateOperation</a> operation)</span></div> |
| <div class="block">Returns the valid geographic area for the given coordinate operation, or <code>null</code> if unknown. |
| This method explores the <a href="operation/AbstractCoordinateOperation.html#getDomainOfValidity()">domain of validity</a> |
| associated with the given operation. If more than one geographic bounding box is found, then this method |
| computes their <a href="../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.html#add(org.opengis.metadata.extent.GeographicBoundingBox)">union</a>. |
| |
| <p><b>Fallback:</b> if the given operation does not declare explicitly a domain of validity, then this |
| method computes the intersection of the domain of validity declared by source and target CRS. If no CRS |
| declare a domain of validity, then this method returns <code>null</code>.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>operation</code> - the coordinate operation for which to get the domain of validity, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the geographic area where the operation is valid, or <code>null</code> if unspecified.</dd> |
| <dt>Since:</dt> |
| <dd>0.7</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#findOperation(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.metadata.extent.GeographicBoundingBox)"><code>findOperation(CoordinateReferenceSystem, CoordinateReferenceSystem, GeographicBoundingBox)</code></a></li> |
| <li><a href="../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/extent/Extents.html#getGeographicBoundingBox(org.opengis.metadata.extent.Extent)"><code>Extents.getGeographicBoundingBox(Extent)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGeographicBoundingBox(org.opengis.referencing.crs.CoordinateReferenceSystem)"> |
| <h3>getGeographicBoundingBox</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../org.apache.sis.util/org/apache/sis/util/OptionalCandidate.html" title="annotation interface in org.apache.sis.util">@OptionalCandidate</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/GeographicBoundingBox.html" title="class or interface in org.opengis.metadata.extent" class="external-link">GeographicBoundingBox</a></span> <span class="element-name">getGeographicBoundingBox</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</span></div> |
| <div class="block">Returns the valid geographic area for the given coordinate reference system, or <code>null</code> if unknown. |
| This method explores the <a href="AbstractReferenceSystem.html#getDomainOfValidity()">domain of |
| validity</a> associated with the given CRS. If more than one geographic bounding box is found, then this method |
| computes their <a href="../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.html#add(org.opengis.metadata.extent.GeographicBoundingBox)">union</a>. |
| together.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the coordinate reference system for which to get the domain of validity, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the geographic area where the coordinate reference system is valid, or <code>null</code> if unspecified.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#getDomainOfValidity(org.opengis.referencing.crs.CoordinateReferenceSystem)"><code>getDomainOfValidity(CoordinateReferenceSystem)</code></a></li> |
| <li><a href="../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/extent/Extents.html#getGeographicBoundingBox(org.opengis.metadata.extent.Extent)"><code>Extents.getGeographicBoundingBox(Extent)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDomainOfValidity(org.opengis.referencing.crs.CoordinateReferenceSystem)"> |
| <h3>getDomainOfValidity</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../org.apache.sis.util/org/apache/sis/util/OptionalCandidate.html" title="annotation interface in org.apache.sis.util">@OptionalCandidate</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">Envelope</a></span> <span class="element-name">getDomainOfValidity</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</span></div> |
| <div class="block">Returns the domain of validity of the specified coordinate reference system, or <code>null</code> if unknown. |
| If non-null, then the returned envelope will use the same coordinate reference system than the given CRS |
| argument.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the coordinate reference system, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the envelope with coordinates in the given CRS, or <code>null</code> if none.</dd> |
| <dt>Since:</dt> |
| <dd>0.8</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#getGeographicBoundingBox(org.opengis.referencing.crs.CoordinateReferenceSystem)"><code>getGeographicBoundingBox(CoordinateReferenceSystem)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="compound(org.opengis.referencing.crs.CoordinateReferenceSystem...)"> |
| <h3>compound</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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></span> <span class="element-name">compound</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a>... components)</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 compound coordinate reference system from an ordered list of CRS components. |
| A CRS is inferred from the given components and the domain of validity is set to the |
| <a href="../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/extent/DefaultExtent.html#intersect(org.opengis.metadata.extent.Extent)">intersection</a> |
| of the domain of validity of all components. |
| |
| <h4 id="ellipsoidal-height-heading">Ellipsoidal height</h4> |
| If a two-dimensional geographic or projected CRS if followed or preceded by a vertical CRS with ellipsoidal |
| <a href="datum/DefaultVerticalDatum.html#getVerticalDatumType()">datum type</a>, then |
| this method combines them in a single three-dimensional geographic or projected CRS. Note that standalone |
| ellipsoidal heights are not allowed according ISO 19111. But if such situation is nevertheless found, then |
| the action described here fixes the issue. This is the reverse of <code><a href="#getVerticalComponent(org.opengis.referencing.crs.CoordinateReferenceSystem,boolean)">getVerticalComponent</a>(crs, true)</code>. |
| |
| <h4 id="components-order-heading">Components order</h4> |
| Apache SIS is permissive on the order of components that can be used in a compound CRS. |
| However for better inter-operability, users are encouraged to follow the order mandated by ISO 19162: |
| |
| <ol> |
| <li>A mandatory horizontal CRS (only one of two-dimensional <code>GeographicCRS</code> or <code>ProjectedCRS</code> or <code>EngineeringCRS</code>).</li> |
| <li>Optionally followed by a <code>VerticalCRS</code> or a <code>ParametricCRS</code> (but not both).</li> |
| <li>Optionally followed by a <code>TemporalCRS</code>.</li> |
| </ol></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>components</code> - the sequence of coordinate reference systems making the compound CRS.</dd> |
| <dt>Returns:</dt> |
| <dd>the compound CRS, or <code>components[0]</code> if the given array contains only one component.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given array is empty or if the array contains incompatible components.</dd> |
| <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 the geodetic factory failed to create the compound CRS.</dd> |
| <dt>Since:</dt> |
| <dd>0.8</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="crs/DefaultCompoundCRS.html" title="class in org.apache.sis.referencing.crs"><code>DefaultCompoundCRS</code></a></li> |
| <li><a href="factory/GeodeticObjectFactory.html#createCompoundCRS(java.util.Map,org.opengis.referencing.crs.CoordinateReferenceSystem...)"><code>GeodeticObjectFactory.createCompoundCRS(Map, CoordinateReferenceSystem...)</code></a></li> |
| <li><a href="../geometry/Envelopes.html#compound(org.opengis.geometry.Envelope...)"><code>Envelopes.compound(Envelope...)</code></a></li> |
| <li><a href="operation/transform/MathTransforms.html#compound(org.opengis.referencing.operation.MathTransform...)"><code>MathTransforms.compound(MathTransform...)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="selectDimensions(org.opengis.referencing.crs.CoordinateReferenceSystem,int...)"> |
| <h3>selectDimensions</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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></span> <span class="element-name">selectDimensions</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs, |
| int... dimensions)</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">Gets or creates a coordinate reference system with a subset of the dimensions of the given CRS. |
| This method can be used for dimensionality reduction, but not for changing axis order. |
| The specified dimensions are used as if they were in strictly increasing order without duplicated values. |
| |
| <h4 id="ellipsoidal-height-heading1">Ellipsoidal height</h4> |
| This method can transform a three-dimensional geographic CRS into a two-dimensional geographic CRS. |
| In this aspect, this method is the converse of <a href="#compound(org.opengis.referencing.crs.CoordinateReferenceSystem...)"><code>compound(CoordinateReferenceSystem...)</code></a>. |
| This method can also extract the <a href="CommonCRS.Vertical.html#ELLIPSOIDAL">ellipsoidal height</a> |
| from a three-dimensional geographic CRS, but this is generally not recommended since ellipsoidal |
| heights make little sense without their (<var>latitude</var>, <var>longitude</var>) locations.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the CRS to reduce the dimensionality, or <code>null</code> if none.</dd> |
| <dd><code>dimensions</code> - the dimensions to retain. The dimensions will be taken in increasing order, ignoring duplicated values.</dd> |
| <dt>Returns:</dt> |
| <dd>a coordinate reference system for the given dimensions. May be the given <code>crs</code>, which may be <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given array is empty or if the array contains invalid indices.</dd> |
| <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 this method needed to create a new CRS and that operation failed.</dd> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#getComponentAt(org.opengis.referencing.crs.CoordinateReferenceSystem,int,int)"><code>getComponentAt(CoordinateReferenceSystem, int, int)</code></a></li> |
| <li><a href="#compound(org.opengis.referencing.crs.CoordinateReferenceSystem...)"><code>compound(CoordinateReferenceSystem...)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="selectComponents(org.opengis.referencing.crs.CoordinateReferenceSystem,int...)"> |
| <h3>selectComponents</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a>></span> <span class="element-name">selectComponents</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs, |
| int... dimensions)</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">Gets or creates CRS components for a subset of the dimensions of the given CRS. |
| The method performs the same work as <a href="#selectDimensions(org.opengis.referencing.crs.CoordinateReferenceSystem,int...)"><code>selectDimensions(CoordinateReferenceSystem, int...)</code></a> |
| except that it does not build new <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CompoundCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link"><code>CompoundCRS</code></a> instances when the specified dimensions span |
| more than one <a href="crs/DefaultCompoundCRS.html#getComponents()">component</a>. |
| Instead, the components are returned directly. |
| |
| <p>While this method does not create new <code>CompoundCRS</code> instances, it still may create other |
| kinds of CRS for handling ellipsoidal height as documented in the <code>selectDimensions(…)</code> method.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the CRS from which to get a subset of the components, or <code>null</code> if none.</dd> |
| <dd><code>dimensions</code> - the dimensions to retain. The dimensions will be taken in increasing order, ignoring duplicated values.</dd> |
| <dt>Returns:</dt> |
| <dd>components in the specified dimensions, or an empty list if the specified <code>crs</code> is <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given array is empty or if the array contains invalid indices.</dd> |
| <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 this method needed to create a new CRS and that operation failed.</dd> |
| <dt>Since:</dt> |
| <dd>1.4</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#selectDimensions(org.opengis.referencing.crs.CoordinateReferenceSystem,int...)"><code>selectDimensions(CoordinateReferenceSystem, int...)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isHorizontalCRS(org.opengis.referencing.crs.CoordinateReferenceSystem)"> |
| <h3>isHorizontalCRS</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isHorizontalCRS</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</span></div> |
| <div class="block">Returns <code>true</code> if the given CRS is horizontal. The current implementation considers a |
| CRS as horizontal if it is two-dimensional and comply with one of the following conditions: |
| |
| <ul> |
| <li>is an instance of <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/GeographicCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link"><code>GeographicCRS</code></a> (or an equivalent <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/GeodeticCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link"><code>GeodeticCRS</code></a>), or</li> |
| <li>is an instance of <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/ProjectedCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link"><code>ProjectedCRS</code></a>, or</li> |
| <li>is an instance of <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/EngineeringCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link"><code>EngineeringCRS</code></a> (following |
| <a href="http://docs.opengeospatial.org/is/12-063r5/12-063r5.html#111">ISO 19162 §16.1</a> |
| definition of <horizontal crs>).</li> |
| </ul> |
| |
| In case of doubt, this method conservatively returns <code>false</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the coordinate reference system, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the given CRS is non-null and likely horizontal, or <code>false</code> otherwise.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#getHorizontalComponent(org.opengis.referencing.crs.CoordinateReferenceSystem)"><code>getHorizontalComponent(CoordinateReferenceSystem)</code></a></li> |
| </ul> |
| </dd> |
| <dt>"TODO:"</dt> |
| <dd>Future SIS implementation may extend the above conditions list. For example, a radar station could |
| use a polar coordinate system in a <code>DerivedCRS</code> instance based on a projected CRS. |
| Conversely, a future SIS versions may impose more conditions on <code>EngineeringCRS</code>. |
| See <a href="http://issues.apache.org/jira/browse/SIS-161">SIS-161</a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHorizontalComponent(org.opengis.referencing.crs.CoordinateReferenceSystem)"> |
| <h3>getHorizontalComponent</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../org.apache.sis.util/org/apache/sis/util/OptionalCandidate.html" title="annotation interface in org.apache.sis.util">@OptionalCandidate</a> |
| </span><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/crs/SingleCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">SingleCRS</a></span> <span class="element-name">getHorizontalComponent</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</span></div> |
| <div class="block">Returns the first horizontal coordinate reference system found in the given CRS, or <code>null</code> if there is |
| none. If the given CRS is already horizontal according <a href="#isHorizontalCRS(org.opengis.referencing.crs.CoordinateReferenceSystem)"><code>isHorizontalCRS(CoordinateReferenceSystem)</code></a>, |
| then this method returns it as-is. Otherwise if the given CRS is compound, then this method searches for the |
| first horizontal component in the order of the <a href="#getSingleComponents(org.opengis.referencing.crs.CoordinateReferenceSystem)">single components list</a>. |
| |
| <p>In the special case where a three-dimensional geographic or projected CRS is found, this method |
| will create a two-dimensional geographic or projected CRS without the vertical axis.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the coordinate reference system, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the first horizontal CRS, or <code>null</code> if none.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="../geometry/GeneralEnvelope.html#horizontal()"><code>GeneralEnvelope.horizontal()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVerticalComponent(org.opengis.referencing.crs.CoordinateReferenceSystem,boolean)"> |
| <h3>getVerticalComponent</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../org.apache.sis.util/org/apache/sis/util/OptionalCandidate.html" title="annotation interface in org.apache.sis.util">@OptionalCandidate</a> |
| </span><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/crs/VerticalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">VerticalCRS</a></span> <span class="element-name">getVerticalComponent</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs, |
| boolean allowCreateEllipsoidal)</span></div> |
| <div class="block">Returns the first vertical coordinate reference system found in the given CRS, or <code>null</code> if there is none. |
| If the given CRS is already an instance of <code>VerticalCRS</code>, then this method returns it as-is. |
| Otherwise if the given CRS is compound, then this method searches for the first vertical component |
| in the order of the <a href="#getSingleComponents(org.opengis.referencing.crs.CoordinateReferenceSystem)">single components list</a>. |
| |
| <h4 id="height-in-a-three-dimensional-geographic-crs-heading">Height in a three-dimensional geographic CRS</h4> |
| In ISO 19111 model, ellipsoidal heights are indissociable from geographic CRS because such heights |
| without their (<var>latitude</var>, <var>longitude</var>) locations make little sense. Consequently |
| a standard-conformant library should return <code>null</code> when asked for the <code>VerticalCRS</code> |
| component of a geographic CRS. This is what <code>getVerticalComponent(…)</code> does when the |
| <code>allowCreateEllipsoidal</code> argument is <code>false</code>. |
| |
| <p>However, in some exceptional cases, handling ellipsoidal heights like any other kind of heights |
| may simplify the task. For example, when computing <em>difference</em> between heights above the |
| same datum, the impact of ignoring locations may be smaller (but not necessarily canceled). |
| Orphan <code>VerticalCRS</code> may also be useful for information purpose like labeling a plot axis. |
| If the caller feels confident that ellipsoidal heights are safe for his task, he can set the |
| <code>allowCreateEllipsoidal</code> argument to <code>true</code>. In such case, this <code>getVerticalComponent(…)</code> |
| method will create a temporary <code>VerticalCRS</code> from the first three-dimensional <code>GeographicCRS</code> |
| <em>in last resort</em>, only if it cannot find an existing <code>VerticalCRS</code> instance. |
| <strong>Note that this is not a valid CRS according ISO 19111</strong> — use with care.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the coordinate reference system, or <code>null</code>.</dd> |
| <dd><code>allowCreateEllipsoidal</code> - <code>true</code> for allowing the creation of orphan CRS for ellipsoidal heights. |
| The recommended value is <code>false</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the first vertical CRS, or <code>null</code> if none.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#compound(org.opengis.referencing.crs.CoordinateReferenceSystem...)"><code>compound(CoordinateReferenceSystem...)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTemporalComponent(org.opengis.referencing.crs.CoordinateReferenceSystem)"> |
| <h3>getTemporalComponent</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../org.apache.sis.util/org/apache/sis/util/OptionalCandidate.html" title="annotation interface in org.apache.sis.util">@OptionalCandidate</a> |
| </span><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/crs/TemporalCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">TemporalCRS</a></span> <span class="element-name">getTemporalComponent</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</span></div> |
| <div class="block">Returns the first temporal coordinate reference system found in the given CRS, or <code>null</code> if there is none. |
| If the given CRS is already an instance of <code>TemporalCRS</code>, then this method returns it as-is. |
| Otherwise if the given CRS is compound, then this method searches for the first temporal component |
| in the order of the <a href="#getSingleComponents(org.opengis.referencing.crs.CoordinateReferenceSystem)">single components list</a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the coordinate reference system, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the first temporal CRS, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSingleComponents(org.opengis.referencing.crs.CoordinateReferenceSystem)"> |
| <h3>getSingleComponents</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/SingleCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">SingleCRS</a>></span> <span class="element-name">getSingleComponents</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs)</span></div> |
| <div class="block">Returns the ordered list of single coordinate reference systems for the specified CRS. |
| This method performs the following choices: |
| |
| <ul> |
| <li>If the given CRS is null, returns an empty list.</li> |
| <li>If the given CRS is an instance of <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/SingleCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link"><code>SingleCRS</code></a>, returns that instance in a singleton list.</li> |
| <li>If the given CRS is an instance of <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CompoundCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link"><code>CompoundCRS</code></a>, returns a flattened list of its |
| <a href="crs/DefaultCompoundCRS.html#getComponents()">components</a>. Some components may themselves be |
| other <code>CompoundCRS</code> instances, in which case those compound CRS are also flattened in their |
| list of <code>SingleCRS</code> components.</li> |
| <li>Otherwise throws a <code>ClassCastException</code>.</li> |
| </ul> |
| |
| <h4 id="example-heading1">Example</h4> |
| Apache SIS allows 4-dimensional (<var>x</var>,<var>y</var>,<var>z</var>,<var>t</var>) |
| coordinate reference system to be built in two different ways as shown below: |
| |
| <div class="horizontal-flow"> |
| <div><p><b>Hierarchical structure</b></p> |
| <blockquote> |
| <code>CompoundCRS</code> — (<var>x</var>, <var>y</var>, <var>z</var>, <var>t</var>)<br> |
| <code> ├─CompoundCRS</code> — (<var>x</var>, <var>y</var>, <var>z</var>)<br> |
| <code> │ ├─ProjectedCRS</code> — (<var>x</var>, <var>y</var>)<br> |
| <code> │ └─VerticalCRS</code> — (<var>z</var>)<br> |
| <code> └─TemporalCRS</code> — (<var>t</var>) |
| </blockquote></div> |
| <div><p><b>Flat list</b></p> |
| <blockquote> |
| <code>CompoundCRS</code> — (<var>x</var>, <var>y</var>, <var>z</var>, <var>t</var>)<br> |
| <code> ├─ProjectedCRS</code> — (<var>x</var>, <var>y</var>)<br> |
| <code> ├─VerticalCRS</code> — (<var>z</var>)<br> |
| <code> └─TemporalCRS</code> — (<var>t</var>) |
| </blockquote> |
| </div></div> |
| |
| This method guaranteed that the returned list is a flat one as shown on the right side. |
| Note that such flat lists are the only one allowed by ISO/OGC standards for compound CRS. |
| The hierarchical structure is an Apache SIS flexibility.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the coordinate reference system, or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the single coordinate reference systems, or an empty list if the given CRS is <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassCastException.html" title="class or interface in java.lang" class="external-link">ClassCastException</a></code> - if a CRS is neither a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/SingleCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link"><code>SingleCRS</code></a> or a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CompoundCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link"><code>CompoundCRS</code></a>.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="crs/DefaultCompoundCRS.html#getSingleComponents()"><code>DefaultCompoundCRS.getSingleComponents()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComponentAt(org.opengis.referencing.crs.CoordinateReferenceSystem,int,int)"> |
| <h3>getComponentAt</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../org.apache.sis.util/org/apache/sis/util/OptionalCandidate.html" title="annotation interface in org.apache.sis.util">@OptionalCandidate</a> |
| </span><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/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a></span> <span class="element-name">getComponentAt</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CoordinateReferenceSystem.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CoordinateReferenceSystem</a> crs, |
| int lower, |
| int upper)</span></div> |
| <div class="block">Returns the coordinate reference system in the given range of dimension indices. |
| This method processes as below: |
| |
| <ul> |
| <li>If the given <code>crs</code> is <code>null</code>, then this method returns <code>null</code>.</li> |
| <li>Otherwise if <code>lower</code> is 0 and <code>upper</code> is the number of CRS dimensions, |
| then this method returns the given CRS unchanged.</li> |
| <li>Otherwise if the given CRS is an instance of <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CompoundCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link"><code>CompoundCRS</code></a>, then this method |
| searches for a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CompoundCRS.html#getComponents()" title="class or interface in org.opengis.referencing.crs" class="external-link">component</a> where: |
| <ul> |
| <li>The <a href="cs/AbstractCS.html#getDimension()">number of dimensions</a> |
| is equal to <code>upper - lower</code>;</li> |
| <li>The sum of the number of dimensions of all previous CRS is equal to <code>lower</code>.</li> |
| </ul> |
| If such component is found, then it is returned.</li> |
| <li>Otherwise (i.e. no component match), this method returns <code>null</code>.</li> |
| </ul> |
| |
| This method does <strong>not</strong> build new CRS from the components. For example, this method does not |
| create a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/CompoundCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link"><code>CompoundCRS</code></a> or a three-dimensional CRS if the given range spans more than one component.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the coordinate reference system to decompose, or <code>null</code>.</dd> |
| <dd><code>lower</code> - the first dimension to keep, inclusive.</dd> |
| <dd><code>upper</code> - the last dimension to keep, exclusive.</dd> |
| <dt>Returns:</dt> |
| <dd>the sub-coordinate system, or <code>null</code> if the given <code>crs</code> was <code>null</code> |
| or cannot be decomposed for dimensions in the [<code>lower</code> … <code>upper</code>] range.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the given index are out of bounds.</dd> |
| <dt>Since:</dt> |
| <dd>0.5</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="#selectDimensions(org.opengis.referencing.crs.CoordinateReferenceSystem,int...)"><code>selectDimensions(CoordinateReferenceSystem, int...)</code></a></li> |
| <li><a href="../geometry/GeneralEnvelope.html#subEnvelope(int,int)"><code>GeneralEnvelope.subEnvelope(int, int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGreenwichLongitude(org.opengis.referencing.crs.GeodeticCRS)"> |
| <h3>getGreenwichLongitude</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">getGreenwichLongitude</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/GeodeticCRS.html" title="class or interface in org.opengis.referencing.crs" class="external-link">GeodeticCRS</a> crs)</span></div> |
| <div class="block">Returns the Greenwich longitude of the prime meridian of the given CRS in degrees. |
| If the prime meridian uses another unit than degrees, then the value will be converted.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>crs</code> - the coordinate reference system from which to get the prime meridian.</dd> |
| <dt>Returns:</dt> |
| <dd>the Greenwich longitude (in degrees) of the prime meridian of the given CRS.</dd> |
| <dt>Since:</dt> |
| <dd>0.5</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="datum/DefaultPrimeMeridian.html#getGreenwichLongitude(javax.measure.Unit)"><code>DefaultPrimeMeridian.getGreenwichLongitude(Unit)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAuthorityFactory(java.lang.String)"> |
| <h3>getAuthorityFactory</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/crs/CRSAuthorityFactory.html" title="class or interface in org.opengis.referencing.crs" class="external-link">CRSAuthorityFactory</a></span> <span class="element-name">getAuthorityFactory</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> authority)</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">Returns the system-wide authority factory used by <a href="#forCode(java.lang.String)"><code>forCode(String)</code></a> and other SIS methods. |
| If the given authority is non-null, then this method returns a factory specifically for that authority. |
| Otherwise, this method returns the <a href="factory/MultiAuthoritiesFactory.html" title="class in org.apache.sis.referencing.factory"><code>MultiAuthoritiesFactory</code></a> |
| instance that manages all other factories. |
| |
| <p>The <code>authority</code> argument can be <code>"EPSG"</code>, <code>"OGC"</code> or any other authority found |
| on the module path. In the <code>"EPSG"</code> case, whether the full set of EPSG codes is supported or not |
| depends on whether a <a href="factory/sql/package-summary.html">connection to the database</a> |
| can be established. If no connection can be established, then this method returns a small embedded |
| EPSG factory containing at least the CRS defined in the <a href="#forCode(java.lang.String)"><code>forCode(String)</code></a> method javadoc.</p> |
| |
| <p>User-defined authorities can be added to the SIS environment by creating a <code>CRSAuthorityFactory</code> |
| implementation with a public no-argument constructor or a public static <code>provider()</code> method, |
| and declaring the name of that class in the <code>module-info.java</code> file as a provider of the |
| <code>org.opengis.referencing.crs.CRSAuthorityFactory</code> service.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>authority</code> - the authority of the desired factory (typically <code>"EPSG"</code> or <code>"OGC"</code>), |
| or <code>null</code> for the <a href="factory/MultiAuthoritiesFactory.html" title="class in org.apache.sis.referencing.factory"><code>MultiAuthoritiesFactory</code></a> |
| instance that manage all factories.</dd> |
| <dt>Returns:</dt> |
| <dd>the system-wide authority factory used by SIS for the given authority.</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 no factory can be returned for the given authority.</dd> |
| <dt>Since:</dt> |
| <dd>0.7</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="#forCode(java.lang.String)"><code>forCode(String)</code></a></li> |
| <li><a href="factory/MultiAuthoritiesFactory.html" title="class in org.apache.sis.referencing.factory"><code>MultiAuthoritiesFactory</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |