| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>CoordinateSystems (Apache SIS 1.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2019-09-20"> |
| <meta name="keywords" content="org.apache.sis.referencing.cs.CoordinateSystems class"> |
| <meta name="keywords" content="parseAxisDirection()"> |
| <meta name="keywords" content="directionAlongMeridian()"> |
| <meta name="keywords" content="angle()"> |
| <meta name="keywords" content="swapAndScaleAxes()"> |
| <meta name="keywords" content="replaceAxes()"> |
| <meta name="keywords" content="replaceLinearUnit()"> |
| <meta name="keywords" content="replaceAngularUnit()"> |
| <meta name="keywords" content="getAxisDirections()"> |
| <meta name="keywords" content="getEpsgCode()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CoordinateSystems (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CoordinateSystems.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.sis.referencing.cs</a></div> |
| <h2 title="Class CoordinateSystems" class="title">Class CoordinateSystems</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../util/Static.html" title="class in org.apache.sis.util">Static</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>CoordinateSystems</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">CoordinateSystems</span> |
| extends <a href="../../util/Static.html" title="class in org.apache.sis.util">Static</a></pre> |
| <div class="block">Utility methods working on <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>CoordinateSystem</code></a> objects and their axes. |
| Those methods allow for example to <a href="#angle(org.opengis.referencing.cs.AxisDirection,org.opengis.referencing.cs.AxisDirection)">estimate an angle between two axes</a> |
| or <a href="#swapAndScaleAxes(org.opengis.referencing.cs.CoordinateSystem,org.opengis.referencing.cs.CoordinateSystem)">determining the change of axis directions and units</a> |
| between two coordinate systems.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../measure/Angle.html" title="class in org.apache.sis.measure">Angle</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#angle(org.opengis.referencing.cs.AxisDirection,org.opengis.referencing.cs.AxisDirection)">angle</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a> source, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a> target)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the arithmetic (counterclockwise) angle from the first axis direction to the second direction.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#directionAlongMeridian(org.opengis.referencing.cs.AxisDirection,double)">directionAlongMeridian</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a> baseDirection, |
| double meridian)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an axis direction from a pole along a meridian.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAxisDirections(org.opengis.referencing.cs.CoordinateSystem)">getAxisDirections</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> cs)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the axis directions for the specified coordinate system.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEpsgCode(java.lang.Class,org.opengis.referencing.cs.CoordinateSystemAxis...)">getEpsgCode</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><? extends <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a>> type, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystemAxis.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystemAxis</a>... axes)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the EPSG code of a coordinate system using the units and directions of given axes.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEpsgCode(javax.measure.Unit,org.opengis.referencing.cs.AxisDirection...)">getEpsgCode</a></span>​(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a>... directions)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the EPSG code of a coordinate system using the given unit and axis directions.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseAxisDirection(java.lang.String)">parseAxisDirection</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an axis direction code from the given direction name.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replaceAngularUnit(org.opengis.referencing.cs.CoordinateSystem,javax.measure.Unit)">replaceAngularUnit</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> cs, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Angle.html?is-external=true" title="class or interface in javax.measure.quantity" class="externalLink">Angle</a>> newUnit)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a coordinate system derived from the given one but with all angular units replaced by the given unit.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replaceAxes(org.opengis.referencing.cs.CoordinateSystem,org.apache.sis.referencing.cs.AxisFilter)">replaceAxes</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> cs, |
| <a href="AxisFilter.html" title="interface in org.apache.sis.referencing.cs">AxisFilter</a> filter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a coordinate system derived from the given one but with a modified list of axes.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replaceLinearUnit(org.opengis.referencing.cs.CoordinateSystem,javax.measure.Unit)">replaceLinearUnit</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> cs, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Length.html?is-external=true" title="class or interface in javax.measure.quantity" class="externalLink">Length</a>> newUnit)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a coordinate system derived from the given one but with all linear units replaced by the given unit.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/Matrix.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">Matrix</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#swapAndScaleAxes(org.opengis.referencing.cs.CoordinateSystem,org.opengis.referencing.cs.CoordinateSystem)">swapAndScaleAxes</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> sourceCS, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> targetCS)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an affine transform between two coordinate systems.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="parseAxisDirection(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseAxisDirection</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a> parseAxisDirection​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></pre> |
| <div class="block">Returns an axis direction code from the given direction name. |
| Names are case-insensitive. They may be: |
| |
| <ul> |
| <li>Cardinal directions like <cite>"north"</cite> and <cite>"east"</cite>.</li> |
| <li>Inter-cardinal directions <cite>"north-east"</cite> and <cite>"south-south-east"</cite>, |
| using either <code>'-'</code>, <code>'_'</code> or spaces as separator between the cardinal points.</li> |
| <li>Directions from a pole like <cite>"South along 180 deg"</cite> and <cite>"South along 90° East"</cite>, |
| using either the <code>"deg"</code> or <code>"°"</code> symbol. Note that the meridian is not necessarily relative |
| to Greenwich (see <a href="#directionAlongMeridian(org.opengis.referencing.cs.AxisDirection,double)"><code>directionAlongMeridian(…)</code></a> for more information).</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the direction name (e.g. "north", "north-east", <i>etc.</i>).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the axis direction for the given name.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the given name is not a known axis direction.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="directionAlongMeridian(org.opengis.referencing.cs.AxisDirection,double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>directionAlongMeridian</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a> directionAlongMeridian​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a> baseDirection, |
| double meridian)</pre> |
| <div class="block">Returns an axis direction from a pole along a meridian. |
| The given meridian is usually, but not necessarily, relative to the Greenwich meridian. |
| |
| <div class="note"><b>Example:</b> |
| <code>directionAlongMeridian(AxisDirection.SOUTH, -90)</code> returns an axis direction for |
| <cite>“South along 90°W”</cite>.</div> |
| |
| <div class="section">Reference meridian</div> |
| The reference meridian depends on the context. It is usually the prime meridian of the |
| <a href="../datum/DefaultGeodeticDatum.html" title="class in org.apache.sis.referencing.datum">geodetic datum</a> of the |
| <a href="../crs/DefaultGeographicCRS.html" title="class in org.apache.sis.referencing.crs">geographic CRS</a> instance |
| that contains (through its coordinate system) the axes having those directions. |
| This policy is consistent with |
| <a href="http://docs.opengeospatial.org/is/12-063r5/12-063r5.html#40">WKT 2 specification §7.5.4(iv)</a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>baseDirection</code> - the base direction, which must be <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#NORTH" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>AxisDirection.NORTH</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#SOUTH" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>AxisDirection.SOUTH</code></a>.</dd> |
| <dd><code>meridian</code> - the meridian in degrees, relative to a unspecified (usually Greenwich) prime meridian. |
| Meridians in the East hemisphere are positive and meridians in the West hemisphere are negative.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the axis direction along the given meridian.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="angle(org.opengis.referencing.cs.AxisDirection,org.opengis.referencing.cs.AxisDirection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>angle</h4> |
| <pre class="methodSignature">public static <a href="../../measure/Angle.html" title="class in org.apache.sis.measure">Angle</a> angle​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a> source, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a> target)</pre> |
| <div class="block">Returns the arithmetic (counterclockwise) angle from the first axis direction to the second direction. |
| This method returns a value between -180° and +180°, or <code>null</code> if no angle can be computed. |
| |
| <div class="section">Horizontal directions</div> |
| For any pair of compass directions which are not opposite directions, a positive angle denotes |
| a right-handed system while a negative angle denotes a left-handed system. Examples: |
| |
| <ul> |
| <li>The angle from <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#EAST" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>EAST</code></a> to <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#NORTH" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>NORTH</code></a> is 90°</li> |
| <li>The angle from <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#SOUTH" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>SOUTH</code></a> to <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#WEST" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>WEST</code></a> is -90°</li> |
| <li>The angle from <cite>"North along 90° East"</cite> to <cite>"North along 0°"</cite> is 90°.</li> |
| </ul> |
| |
| <div class="note"><b>Note:</b> |
| in the case of directions like <cite>“South along 90°W”</cite>, the caller is responsible to make sure |
| that the meridians are relative to the same prime meridian. This is the case if the axes are part of |
| the same <code>CoordinateSystem</code> instance.</div> |
| |
| <div class="section">Horizontal and vertical directions</div> |
| By convention this method defines the angle from any compass direction to the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#UP" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>UP</code></a> |
| vertical direction as 90°, and the angle of any compass direction to the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#DOWN" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>DOWN</code></a> |
| vertical direction as -90°. The sign of those angles gives no indication about whether the coordinate system |
| is right-handed or left-handed. Those angles are returned as instances of <a href="../../measure/ElevationAngle.html" title="class in org.apache.sis.measure"><code>ElevationAngle</code></a>. |
| |
| <p>All angles are approximations since this method does not take the Earth ellipsoidal or geoidal shape in |
| account.</p> |
| |
| <div class="section">Invariants</div> |
| For any non-null return value: |
| <ul> |
| <li><code>angle(A, A) = 0°</code></li> |
| <li><code>angle(A, opposite(A)) = ±180°</code></li> |
| <li><code>angle(A, B) = -angle(B, A)</code></li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the source axis direction.</dd> |
| <dd><code>target</code> - the target axis direction.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the arithmetic angle (in degrees) of the rotation to apply on a line pointing toward |
| the source direction in order to make it point toward the target direction, or |
| <code>null</code> if this value can not be computed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="swapAndScaleAxes(org.opengis.referencing.cs.CoordinateSystem,org.opengis.referencing.cs.CoordinateSystem)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>swapAndScaleAxes</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/Matrix.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">Matrix</a> swapAndScaleAxes​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> sourceCS, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> targetCS) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a>, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/IncommensurableException.html?is-external=true" title="class or interface in javax.measure" class="externalLink">IncommensurableException</a></pre> |
| <div class="block">Returns an affine transform between two coordinate systems. |
| Only units and axes order (e.g. transforming from |
| (<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#NORTH" title="class or interface in org.opengis.referencing.cs" class="externalLink">North</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#WEST" title="class or interface in org.opengis.referencing.cs" class="externalLink">West</a>) to |
| (<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#EAST" title="class or interface in org.opengis.referencing.cs" class="externalLink">East</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true#NORTH" title="class or interface in org.opengis.referencing.cs" class="externalLink">North</a>) |
| are taken in account by this method. |
| |
| <div class="section">Conditions</div> |
| The two coordinate systems must implement the same GeoAPI coordinate system interface. |
| For example if <code>sourceCS</code> is a <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CartesianCS.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>CartesianCS</code></a>, |
| then <code>targetCS</code> must be a <code>CartesianCS</code> too. |
| |
| <div class="note"><b>Example:</b> |
| If coordinates in <code>sourceCS</code> are (<var>x</var>,<var>y</var>) tuples in metres |
| and coordinates in <code>targetCS</code> are (<var>-y</var>,<var>x</var>) tuples in centimetres, |
| then the transformation can be performed as below: |
| |
| <blockquote><pre>┌ ┐ ┌ ┐ ┌ ┐ |
| │-<var>y</var>(cm)│ │ 0 -100 0 │ │ <var>x</var>(<var>m</var>)│ |
| │ <var>x</var>(cm)│ = │ 100 0 0 │ │ <var>y</var>(<var>m</var>)│ |
| │ 1 │ │ 0 0 1 │ │ 1 │ |
| └ ┘ └ ┘ └ ┘</pre></blockquote> |
| </div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sourceCS</code> - the source coordinate system.</dd> |
| <dd><code>targetCS</code> - the target coordinate system.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the conversion from <code>sourceCS</code> to <code>targetCS</code> as an affine transform. |
| Only axis direction and units are taken in account.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the CS are not of the same type, or axes do not match.</dd> |
| <dd><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/IncommensurableException.html?is-external=true" title="class or interface in javax.measure" class="externalLink">IncommensurableException</a></code> - if the units are not compatible, or the conversion is non-linear.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../operation/matrix/Matrices.html#createTransform(org.opengis.referencing.cs.AxisDirection%5B%5D,org.opengis.referencing.cs.AxisDirection%5B%5D)"><code>Matrices.createTransform(AxisDirection[], AxisDirection[])</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="replaceAxes(org.opengis.referencing.cs.CoordinateSystem,org.apache.sis.referencing.cs.AxisFilter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceAxes</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> replaceAxes​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> cs, |
| <a href="AxisFilter.html" title="interface in org.apache.sis.referencing.cs">AxisFilter</a> filter)</pre> |
| <div class="block">Returns a coordinate system derived from the given one but with a modified list of axes. |
| The axes may be filtered (excluding some axes), reordered or have their unit and direction modified. |
| |
| <div class="note"><b>Example:</b> |
| for replacing all angular units of a coordinate system to degrees (regardless what the original |
| angular units were) while leaving other kinds of units unchanged, one can write: |
| |
| <blockquote><pre>CoordinateSystem cs = ...; |
| cs = CoordinateSystems.<b>replaceAxes</b>(cs, <font color="green">new</font> <b>AxisFilter</b>() { |
| @Override |
| <font color="green">public</font> Unit<?> <b>getUnitReplacement</b>(CoordinateSystemAxis axis, Unit<?> unit) { |
| <font color="green">if</font> (Units.<b>isAngular</b>(unit)) { |
| unit = Units.DEGREE; |
| } |
| <font color="green">return</font> unit; |
| } |
| });</pre></blockquote></div> |
| |
| <div class="section">Coordinate system normalization</div> |
| This method is often used together with <a href="#swapAndScaleAxes(org.opengis.referencing.cs.CoordinateSystem,org.opengis.referencing.cs.CoordinateSystem)"><code>swapAndScaleAxes(…)</code></a> for normalizing the |
| coordinate values given to a <a href="../operation/transform/AbstractMathTransform.html" title="class in org.apache.sis.referencing.operation.transform">math transform</a>. |
| |
| <div class="note"><b>Example:</b> |
| <blockquote><pre>CoordinateSystem sourceCS = ...; |
| CoordinateSystem targetCS = ...; |
| Matrix step1 = <b>swapAndScaleAxes</b>(sourceCS, <b>replaceAxes</b>(sourceCS, AxisConvention.NORMALIZED)); |
| Matrix step2 = ...; <i><font color="gray">// some transform working on coordinates with standard axis order and unit.</font></i> |
| Matrix step3 = <b>swapAndScaleAxes</b>(<b>replaceAxes</b>(targetCS, AxisConvention.NORMALIZED), targetCS);</pre></blockquote></div> |
| |
| A rational for normalized axis order and units is explained in the <cite>Axis units and direction</cite> section |
| in the description of the <a href="../operation/projection/package-summary.html">map projection package</a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cs</code> - the coordinate system, or <code>null</code>.</dd> |
| <dd><code>filter</code> - the modifications to apply on coordinate system axes.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the modified coordinate system as a new instance, |
| or <code>cs</code> if the given coordinate system was null or does not need any change.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the specified coordinate system can not be filtered. |
| It may be because the coordinate system would contain an illegal number of axes, |
| or because an axis would have an unexpected direction or unexpected unit of measurement.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="AxesConvention.html#NORMALIZED"><code>AxesConvention.NORMALIZED</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="replaceLinearUnit(org.opengis.referencing.cs.CoordinateSystem,javax.measure.Unit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceLinearUnit</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> replaceLinearUnit​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> cs, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Length.html?is-external=true" title="class or interface in javax.measure.quantity" class="externalLink">Length</a>> newUnit)</pre> |
| <div class="block">Returns a coordinate system derived from the given one but with all linear units replaced by the given unit. |
| Non-linear units (e.g. angular or scale units) are left unchanged. |
| |
| <p>This convenience method is equivalent to the following code:</p> |
| <blockquote><pre><font color="green">return</font> CoordinateSystems.<b>replaceAxes</b>(cs, <font color="green">new</font> <b>AxisFilter</b>() { |
| @Override <font color="green">public</font> Unit<?> <b>getUnitReplacement</b>(CoordinateSystemAxis axis, Unit<?> unit) { |
| <font color="green">return</font> Units.<b>isLinear</b>(unit) ? newUnit : unit; |
| } |
| });</pre></blockquote></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cs</code> - the coordinate system in which to replace linear units, or <code>null</code>.</dd> |
| <dd><code>newUnit</code> - the new linear unit.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the modified coordinate system as a new instance, or <code>null</code> if the given <code>cs</code> was null, |
| or <code>cs</code> if all linear units were already equal to the given one.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.7</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../measure/Units.html#isLinear(javax.measure.Unit)"><code>Units.isLinear(Unit)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="replaceAngularUnit(org.opengis.referencing.cs.CoordinateSystem,javax.measure.Unit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceAngularUnit</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> replaceAngularUnit​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> cs, |
| <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/quantity/Angle.html?is-external=true" title="class or interface in javax.measure.quantity" class="externalLink">Angle</a>> newUnit)</pre> |
| <div class="block">Returns a coordinate system derived from the given one but with all angular units replaced by the given unit. |
| Non-angular units (e.g. linear or scale units) are left unchanged. |
| |
| <p>This convenience method is equivalent to the following code:</p> |
| <blockquote><pre><font color="green">return</font> CoordinateSystems.<b>replaceAxes</b>(cs, <font color="green">new</font> <b>AxisFilter</b>() { |
| @Override <font color="green">public</font> Unit<?> <b>getUnitReplacement</b>(CoordinateSystemAxis axis, Unit<?> unit) { |
| <font color="green">return</font> Units.<b>isAngular</b>(unit) ? newUnit : unit; |
| } |
| });</pre></blockquote></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cs</code> - the coordinate system in which to replace angular units, or <code>null</code>.</dd> |
| <dd><code>newUnit</code> - the new angular unit.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the modified coordinate system as a new instance, or <code>null</code> if the given <code>cs</code> was null, |
| or <code>cs</code> if all angular units were already equal to the given one.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.7</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../measure/Units.html#isAngular(javax.measure.Unit)"><code>Units.isAngular(Unit)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAxisDirections(org.opengis.referencing.cs.CoordinateSystem)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAxisDirections</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a>[] getAxisDirections​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a> cs)</pre> |
| <div class="block">Returns the axis directions for the specified coordinate system. |
| This method guarantees that the returned array is non-null and does not contain any null direction.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cs</code> - the coordinate system.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the axis directions for the specified coordinate system.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../util/NullArgumentException.html" title="class in org.apache.sis.util">NullArgumentException</a></code> - if <code>cs</code> is null, or one of its axes is null, |
| or a value returned by <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystemAxis.html?is-external=true#getDirection()" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>CoordinateSystemAxis.getDirection()</code></a> is null.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.8</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getEpsgCode(java.lang.Class,org.opengis.referencing.cs.CoordinateSystemAxis...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEpsgCode</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> getEpsgCode​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><? extends <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystem</a>> type, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystemAxis.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">CoordinateSystemAxis</a>... axes)</pre> |
| <div class="block">Returns the EPSG code of a coordinate system using the units and directions of given axes. |
| This method ignores axis metadata (names, abbreviation, identifiers, remarks, <i>etc.</i>). |
| The axis minimum and maximum values are checked only if the |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystemAxis.html?is-external=true#getRangeMeaning()" title="class or interface in org.opengis.referencing.cs" class="externalLink">range meaning</a> is "wraparound". |
| If no suitable coordinate system is known to Apache SIS, then this method returns <code>null</code>. |
| |
| <p>Current implementation uses a hard-coded list of known coordinate systems; |
| it does not yet scan the EPSG database (this may change in future Apache SIS version). |
| The current list of known coordinate systems is given below.</p> |
| |
| <table> |
| <caption>Known coordinate systems (CS)</caption> |
| <tr><th>EPSG</th> <th>CS type</th> <th colspan="3">Axis directions</th> <th>Horizontal unit</th></tr> |
| <tr><td>6424</td> <td>Ellipsoidal</td> <td>east</td> <td>north</td> <td></td> <td>degree</td></tr> |
| <tr><td>6422</td> <td>Ellipsoidal</td> <td>north</td> <td>east</td> <td></td> <td>degree</td></tr> |
| <tr><td>6425</td> <td>Ellipsoidal</td> <td>east</td> <td>north</td> <td></td> <td>grads</td></tr> |
| <tr><td>6403</td> <td>Ellipsoidal</td> <td>north</td> <td>east</td> <td></td> <td>grads</td></tr> |
| <tr><td>6429</td> <td>Ellipsoidal</td> <td>east</td> <td>north</td> <td></td> <td>radian</td></tr> |
| <tr><td>6428</td> <td>Ellipsoidal</td> <td>north</td> <td>east</td> <td></td> <td>radian</td></tr> |
| <tr><td>6426</td> <td>Ellipsoidal</td> <td>east</td> <td>north</td> <td>up</td> <td>degree</td></tr> |
| <tr><td>6423</td> <td>Ellipsoidal</td> <td>north</td> <td>east</td> <td>up</td> <td>degree</td></tr> |
| <tr><td>6427</td> <td>Ellipsoidal</td> <td>east</td> <td>north</td> <td>up</td> <td>grads</td></tr> |
| <tr><td>6421</td> <td>Ellipsoidal</td> <td>north</td> <td>east</td> <td>up</td> <td>grads</td></tr> |
| <tr><td>6431</td> <td>Ellipsoidal</td> <td>east</td> <td>north</td> <td>up</td> <td>radian</td></tr> |
| <tr><td>6430</td> <td>Ellipsoidal</td> <td>north</td> <td>east</td> <td>up</td> <td>radian</td></tr> |
| <tr><td>4400</td> <td>Cartesian</td> <td>east</td> <td>north</td> <td></td> <td>metre</td></tr> |
| <tr><td>4500</td> <td>Cartesian</td> <td>north</td> <td>east</td> <td></td> <td>metre</td></tr> |
| <tr><td>4491</td> <td>Cartesian</td> <td>west</td> <td>north</td> <td></td> <td>metre</td></tr> |
| <tr><td>4501</td> <td>Cartesian</td> <td>north</td> <td>west</td> <td></td> <td>metre</td></tr> |
| <tr><td>6503</td> <td>Cartesian</td> <td>west</td> <td>south</td> <td></td> <td>metre</td></tr> |
| <tr><td>6501</td> <td>Cartesian</td> <td>south</td> <td>west</td> <td></td> <td>metre</td></tr> |
| <tr><td>1039</td> <td>Cartesian</td> <td>east</td> <td>north</td> <td></td> <td>foot</td></tr> |
| <tr><td>1029</td> <td>Cartesian</td> <td>north</td> <td>east</td> <td></td> <td>foot</td></tr> |
| <tr><td>4403</td> <td>Cartesian</td> <td>east</td> <td>north</td> <td></td> <td>Clarke’s foot</td></tr> |
| <tr><td>4502</td> <td>Cartesian</td> <td>north</td> <td>east</td> <td></td> <td>Clarke’s foot</td></tr> |
| <tr><td>4497</td> <td>Cartesian</td> <td>east</td> <td>north</td> <td></td> <td>US survey foot</td></tr> |
| </table></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the type of coordinate system for which an EPSG code is desired, as a GeoAPI interface.</dd> |
| <dd><code>axes</code> - axes for which a coordinate system EPSG code is desired.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>EPSG codes for a coordinate system using the given axes (ignoring metadata), or <code>null</code> if unknown |
| to this method. Note that a null value does not mean that a more extensive search in the EPSG database |
| would not find a matching coordinate system.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../factory/GeodeticAuthorityFactory.html#createCoordinateSystem(java.lang.String)"><code>GeodeticAuthorityFactory.createCoordinateSystem(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getEpsgCode(javax.measure.Unit,org.opengis.referencing.cs.AxisDirection...)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getEpsgCode</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> getEpsgCode​(<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> unit, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/AxisDirection.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink">AxisDirection</a>... directions)</pre> |
| <div class="block">Returns the EPSG code of a coordinate system using the given unit and axis directions. |
| This convenience method performs the work documented in <a href="#getEpsgCode(java.lang.Class,org.opengis.referencing.cs.CoordinateSystemAxis...)"><code>getEpsgCode(Class, CoordinateSystemAxis...)</code></a>, |
| but requiring only a frequently used subset of information. |
| If no suitable coordinate system is known to Apache SIS, then this method returns <code>null</code>. |
| |
| <p>Current implementation uses a hard-coded list of known coordinate systems; |
| it does not yet scan the EPSG database (this may change in future Apache SIS version). |
| The current list of known coordinate systems is documented <a href="#getEpsgCode(java.lang.Class,org.opengis.referencing.cs.CoordinateSystemAxis...)">above</a>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>unit</code> - desired unit of measurement. For three-dimensional ellipsoidal coordinate system, |
| this is the unit for the horizontal axes only; the vertical axis is in metres.</dd> |
| <dd><code>directions</code> - desired axis directions.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>EPSG codes for a coordinate system using the given axis directions and unit of measurement, |
| or <code>null</code> if unknown to this method. Note that a null value does not mean that a more |
| extensive search in the EPSG database would not find a matching coordinate system.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.8</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../measure/Units.html#getEpsgCode(javax.measure.Unit,boolean)"><code>Units.getEpsgCode(Unit, boolean)</code></a>, |
| <a href="../factory/GeodeticAuthorityFactory.html#createCoordinateSystem(java.lang.String)"><code>GeodeticAuthorityFactory.createCoordinateSystem(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CoordinateSystems.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |