blob: aa22d69e3fae8f6774836a052ce650d4510e0dbb [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>AxesConvention (Apache SIS 1.3 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.sis.referencing.cs, enum: AxesConvention">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.referencing.cs.AxesConvention class">
<meta name="keywords" content="values()">
<meta name="keywords" content="valueOf()">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/AxesConvention.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li><a href="#nested-class-summary">Nested</a></li>
<li><a href="#enum-constant-summary">Enum Constants</a></li>
<li>Field</li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li><a href="#enum-constant-detail">Enum Constants</a></li>
<li>Field</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#enum-constant-summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#enum-constant-detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.referencing.cs</a></div>
<h1 title="Enum Class AxesConvention" class="title">Enum Class AxesConvention</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">AxesConvention</a>&gt;
<div class="inheritance">AxesConvention</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;<a href="AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">Axes­Convention</a>&gt;</code>, <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code>, <code><a href="AxisFilter.html" title="interface in org.apache.sis.referencing.cs">Axis­Filter</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">AxesConvention</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">AxesConvention</a>&gt;
implements <a href="AxisFilter.html" title="interface in org.apache.sis.referencing.cs">AxisFilter</a></span></div>
<div class="block">High-level characteristics about the axes of a coordinate system.
This enumeration provides a convenient way to identify some common axes conventions like
axis order or range of longitude values. Apache SIS Coordinate System objects can be made
compliant to a given convention by calls to their <code>for­Convention(Axes­Convention)</code> method.
<p>The following table summarizes the coordinate system aspects that may be modified by each enum value,
with an example of change applied by the enum. Blank cells mean that the property is not changed by the
enum value.</p>
<table class="sis">
<caption>Coordinate system properties changed by enum values</caption>
<tr>
<th>Property</th>
<th>Example</th>
<th><a href="#NORMALIZED">Normalized</a></th>
<th><a href="#DISPLAY_ORIENTED"><code>Display<br>oriented</code></a></th>
<th><a href="#RIGHT_HANDED">Right<br>handed</a></th>
<th><a href="#POSITIVE_RANGE">Positive<br>range</a></th>
</tr>
<tr>
<td>Axis order</td>
<td>(<var>longitude</var>, <var>latitude</var>)</td>
<td style="text-align:center"></td>
<td style="text-align:center"></td>
<td style="text-align:center"></td>
<td></td>
</tr>
<tr>
<td>Axis direction</td>
<td>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/AxisDirection.html#EAST" title="class or interface in org.opengis.referencing.cs" class="external-link">east</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/AxisDirection.html#NORTH" title="class or interface in org.opengis.referencing.cs" class="external-link">north</a>)</td>
<td style="text-align:center"></td>
<td style="text-align:center"></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Unit of measurement</td>
<td>Angular degrees &amp; metres</td>
<td style="text-align:center"></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Range of values</td>
<td>[0 … 360]° of longitude</td>
<td></td>
<td></td>
<td></td>
<td style="text-align:center"></td>
</tr>
</table>
<h2>Note on axis order</h2>
The axis order is specified by the authority (typically a national agency) defining the Coordinate Reference System
(CRS). The order depends on the CRS type and the country defining the CRS. In the case of geographic CRS, the
(<var>latitude</var>, <var>longitude</var>) axis order is widely used by geographers and pilotes for centuries.
However, software developers tend to consistently use the (<var>x</var>,<var>y</var>) order for every kind of CRS.
Those different practices resulted in contradictory definitions of axis order for almost every CRS of kind
<code>Geographic­CRS</code>, for some <code>Projected­CRS</code> in the South hemisphere (South Africa, Australia, <i>etc.</i>)
and for some polar projections among others.
<p>Recent OGC standards mandate the use of axis order as defined by the authority. Oldest OGC standards used the
(<var>x</var>,<var>y</var>) axis order instead, ignoring any authority specification. Many software products still use
the old (<var>x</var>,<var>y</var>) axis order, because it is easier to implement. Apache SIS supports both conventions.
By default, SIS creates CRS with axis order as defined by the authority. Those CRS are created by calls to the
<a href="../CRS.html#forCode(java.lang.String)"><code>CRS​.for­Code(String)</code></a> method. The actual axis order can be verified after the CRS
creation with <code>System​.out​.println(crs)</code>. If (<var>x</var>,<var>y</var>) axis order is wanted for compatibility
with older OGC specifications or other software products, CRS forced to "longitude first" axis order can be created
using the <a href="#DISPLAY_ORIENTED"><code>DISPLAY_ORIENTED</code></a> or <a href="#NORMALIZED"><code>NORMALIZED</code></a> enumeration value.</p>
<h2>Note on range of longitude values</h2>
Most geographic CRS have a longitude axis defined in the [-180 … +180]° range. All map projections in Apache SIS are
designed to work in that range. This is also the range of <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Math.html" title="class or interface in java.lang" class="external-link"><code>Math</code></a> trigonometric functions like <code>atan2(y,x)</code>.
However, some data use the [0 … 360]° range instead. A geographic CRS can be shifted to that range of longitude values
using the <a href="#POSITIVE_RANGE"><code>POSITIVE_RANGE</code></a> enumeration value. The choice of longitude range will impact not only some
coordinate conversions, but also the methods that verify the <cite>domain of validity</cite>
(e.g. <a href="../../geometry/GeneralEnvelope.html#normalize()"><code>General­Envelope​.normalize()</code></a>).</div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.4</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="AbstractCS.html#forConvention(org.apache.sis.referencing.cs.AxesConvention)"><code>Abstract­CS​.for­Convention(Axes­Convention)</code></a></li>
<li><a href="../crs/AbstractCRS.html#forConvention(org.apache.sis.referencing.cs.AxesConvention)"><code>Abstract­CRS​.for­Convention(Axes­Convention)</code></a></li>
</ul>
</dd>
<p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum​.Enum­Desc</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>&gt;&gt;</code></div>
</section>
</li>
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<li>
<section class="constants-summary" id="enum-constant-summary">
<h2>Enum Constant Summary</h2>
<div class="caption"><span>Enum Constants</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Enum Constant</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="#DISPLAY_ORIENTED" class="member-name-link">DISPLAY_ORIENTED</a></code></div>
<div class="col-last even-row-color">
<div class="block">Axes are reordered and oriented toward directions commonly used for displaying purpose.</div>
</div>
<div class="col-first odd-row-color"><code><a href="#NORMALIZED" class="member-name-link">NORMALIZED</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Axes order, direction and units of measurement are forced to commonly used predefined values.</div>
</div>
<div class="col-first even-row-color"><code><a href="#POSITIVE_RANGE" class="member-name-link">POSITIVE_RANGE</a></code></div>
<div class="col-last even-row-color">
<div class="block">Axes having a <cite>wraparound</cite>
<a href="DefaultCoordinateSystemAxis.html#getRangeMeaning()">range meaning</a> are
shifted to their ranges of positive values.</div>
</div>
<div class="col-first odd-row-color"><code><a href="#RIGHT_HANDED" class="member-name-link">RIGHT_HANDED</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Axes are ordered for a <cite>right-handed</cite> coordinate system.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-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="AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">Axes­Convention</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">value­Of</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</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 enum constant of this class with the specified name.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">Axes­Convention</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Enum">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compare­To</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describe­Constable</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.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/16/docs/api/java.base/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">get­Declaring­Class</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hash­Code</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">to­String</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">value­Of</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">get­Class</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notify­All</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-AxisFilter">Methods inherited from interface&nbsp;<a href="AxisFilter.html" title="interface in org.apache.sis.referencing.cs">AxisFilter</a></h3>
<code><a href="AxisFilter.html#accept(org.opengis.referencing.cs.CoordinateSystemAxis)">accept</a>, <a href="AxisFilter.html#getDirectionReplacement(org.opengis.referencing.cs.CoordinateSystemAxis,org.opengis.referencing.cs.AxisDirection)">get­Direction­Replacement</a>, <a href="AxisFilter.html#getUnitReplacement(org.opengis.referencing.cs.CoordinateSystemAxis,javax.measure.Unit)">get­Unit­Replacement</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<li>
<section class="constant-details" id="enum-constant-detail">
<h2>Enum Constant Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="NORMALIZED">
<h3>NORMALIZED</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">AxesConvention</a></span>&nbsp;<span class="element-name">NORMALIZED</span></div>
<div class="block">Axes order, direction and units of measurement are forced to commonly used predefined values.
This convention implies the following changes on a coordinate system:
<ul>
<li>Axes are oriented and ordered as defined for <a href="#DISPLAY_ORIENTED"><code>DISPLAY_ORIENTED</code></a> coordinate systems.</li>
<li>Known units are normalized (this list may be expanded in future SIS versions):
<ul>
<li>Angular units are set to <a href="../../measure/Units.html#DEGREE"><code>Units​.DEGREE</code></a>.</li>
<li>Linear units are set to <a href="../../measure/Units.html#METRE"><code>Units​.METRE</code></a>.</li>
<li>Temporal units are set to <a href="../../measure/Units.html#DAY"><code>Units​.DAY</code></a>.</li>
</ul>
</li>
</ul>
This convention does not normalize longitude values to the [-180 … +180]° range and does not set the
<a href="../datum/DefaultGeodeticDatum.html#getPrimeMeridian()">prime meridian</a> to Greenwich.
Those changes are not applied for avoiding discontinuity in conversions from the non-normalized CRS to the normalized CRS.
<div class="note"><b>Rational:</b>
The reason why we do not normalize the range and the prime meridian is because doing so
would cause the conversion between old and new coordinate systems to be non-affine for axes
having <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/RangeMeaning.html#WRAPAROUND" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>Range­Meaning​.WRAPAROUND</code></a>. Furthermore, changing the
prime meridian would be a datum change rather than a coordinate system change, and datum
changes are more difficult to handle by coordinate operation factories.
</div></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../CommonCRS.html#normalizedGeographic()"><code>Common­CRS​.normalized­Geographic()</code></a></li>
<li><a href="CoordinateSystems.html#replaceAxes(org.opengis.referencing.cs.CoordinateSystem,org.apache.sis.referencing.cs.AxisFilter)"><code>Coordinate­Systems​.replace­Axes(Coordinate­System, Axis­Filter)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="DISPLAY_ORIENTED">
<h3>DISPLAY_ORIENTED</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">AxesConvention</a></span>&nbsp;<span class="element-name">DISPLAY_ORIENTED</span></div>
<div class="block">Axes are reordered and oriented toward directions commonly used for displaying purpose.
Units of measurement are unchanged. This convention can be used for deriving a coordinate system with the
<i>(<var>longitude</var>, <var>latitude</var>)</i> or <i>(<var>x</var>,<var>y</var>)</i> axis order.
A similar concept appears in the Web Map Services (WMS) 1.3 specification, quoted here:
<div class="note"><b>6.7.2 Map CS</b>
The usual orientation of the Map CS shall be such that the <var>i</var> axis is parallel to the East-to-West axis
of the Layer CRS and increases Eastward, and the <var>j</var> axis is parallel to the North-to-South axis of the
Layer CRS and increases Southward. This orientation will not be possible in some cases, as (for example) in an
orthographic projection over the South Pole. The convention to be followed is that, wherever possible, East shall
be to the right edge and North shall be toward the upper edge of the Map CS.</div>
The above-cited <i>(<var>i</var>,<var>j</var>)</i> axes are mapped to <cite>display right</cite> and
<cite>display down</cite> directions respectively.
Other kinds of axis are mapped to <cite>east</cite> and <cite>north</cite> directions when possible.
More specifically, Apache SIS tries to setup the following directions
(replacing a direction by its "forward" counterpart when necessary, e.g. <code>SOUTH</code><code>NORTH</code>)
in the order shown below:
<table class="sis">
<caption>Axis directions and order</caption>
<tr>
<th>Preferred axis sequences</th>
<th>Purpose</th>
</tr><tr>
<td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/AxisDirection.html#EAST" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>EAST</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/AxisDirection.html#NORTH" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>NORTH</code></a>,
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/AxisDirection.html#UP" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>UP</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/AxisDirection.html#FUTURE" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>FUTURE</code></a></td>
<td>Commonly used <i>(<var>x</var>, <var>y</var>, <var>z</var>, <var>t</var>)</i> directions for coordinates.</td>
</tr><tr>
<td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/AxisDirection.html#DISPLAY_RIGHT" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>DISPLAY_RIGHT</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/AxisDirection.html#DISPLAY_DOWN" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>DISPLAY_DOWN</code></a></td>
<td>Commonly used <i>(<var>x</var>, <var>y</var>)</i> directions for screen devices.</td>
</tr><tr>
<td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/AxisDirection.html#ROW_POSITIVE" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>ROW_POSITIVE</code></a>,
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/AxisDirection.html#COLUMN_POSITIVE" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>COLUMN_POSITIVE</code></a></td>
<td>Indices in grids or matrices.</td>
</tr>
</table>
<div class="note"><b>Notes:</b>
we do not provide a <cite>"longitude or <var>x</var> axis first"</cite> enumeration value because such criterion
is hard to apply to inter-cardinal directions and has no meaning for map projections over a pole.
The <cite>display oriented</cite> enumeration name applies to a wider range of cases,
but still have a loosely definition which may be adjusted in future Apache SIS versions.
If a more stable definition is needed, consider using <a href="#RIGHT_HANDED"><code>RIGHT_HANDED</code></a> instead since
<cite>right-handed</cite> coordinate systems have a more precise meaning in Apache SIS.</div></div>
<dl class="notes">
<dt>Since:</dt>
<dd>1.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="RIGHT_HANDED">
<h3>RIGHT_HANDED</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">AxesConvention</a></span>&nbsp;<span class="element-name">RIGHT_HANDED</span></div>
<div class="block">Axes are ordered for a <cite>right-handed</cite> coordinate system. Axis directions, ranges or coordinate values
and units of measurement are unchanged. In the two-dimensional case, the handedness is defined from the point of
view of an observer above the plane of the system.
<p>Note that a right-handed coordinate system does not guarantee that longitude or <var>x</var> axis
will be first in every cases. The most notable exception is the case of (West, North) orientations.
The following table lists that case, together with other common axis orientations.
The axes orientations implied by this <code>RIGHT_HANDED</code> enum is shown,
together with <a href="#DISPLAY_ORIENTED"><code>DISPLAY_ORIENTED</code></a> axes for reference:</p>
<div class="note">
<table class="sis">
<caption>Examples of left-handed and right-handed coordinate systems</caption>
<tr><th>Left-handed</th> <th>Right-handed</th> <th>Display oriented</th> <th>Remarks</th></tr>
<tr><td>North, East</td> <td>East, North</td> <td>East, North</td> <td>This is the most common case.</td></tr>
<tr><td>West, North</td> <td>North, West</td> <td>East, North</td> <td>This right-handed system has latitude first.</td></tr>
<tr><td>South, West</td> <td>West, South</td> <td>East, North</td> <td>Used for the mapping of southern Africa.</td></tr>
<tr><td>South along 0°,<br>South along 90° West</td>
<td>South along 90° West,<br>South along 0°</td>
<td>(Same as right-handed)</td>
<td>Can be used for the mapping of North pole.</td></tr>
</table></div></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="CoordinateSystems.html#angle(org.opengis.referencing.cs.AxisDirection,org.opengis.referencing.cs.AxisDirection)"><code>Coordinate­Systems​.angle(Axis­Direction, Axis­Direction)</code></a></li>
<li><a href="https://en.wikipedia.org/wiki/Right_hand_rule">Right-hand rule on Wikipedia</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="POSITIVE_RANGE">
<h3>POSITIVE_RANGE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">AxesConvention</a></span>&nbsp;<span class="element-name">POSITIVE_RANGE</span></div>
<div class="block">Axes having a <cite>wraparound</cite>
<a href="DefaultCoordinateSystemAxis.html#getRangeMeaning()">range meaning</a> are
shifted to their ranges of positive values. The units of measurement and range period (difference between
<a href="DefaultCoordinateSystemAxis.html#getMaximumValue()">maximum</a> and
<a href="DefaultCoordinateSystemAxis.html#getMinimumValue()">minimum value</a>)
are unchanged.
<h4>Usage</h4>
The most frequent usage of this enum is for shifting longitude values from the [-180 … +180]° range
to the [0 … 360]° range. However, this enum could also be used with climatological calendars if their
time axis has a wrapround range meaning.
<p>Note that conversions from an coordinate system using the [-180 … +180]° range to a coordinate system
using the [0 … 360]° range may not be affine. For example, the data in the West hemisphere ([-180 … 0]°)
may need to move on the right side of the East hemisphere ([180 … 360]°).
Some geometries may need to be separated in two parts, and others may need to be merged.</p></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/RangeMeaning.html#WRAPAROUND" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>Range­Meaning​.WRAPAROUND</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="values()">
<h3>values</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">AxesConvention</a>[]</span>&nbsp;<span class="element-name">values</span>()</div>
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>an array containing the constants of this enum class, in the order they are declared</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="valueOf(java.lang.String)">
<h3>valueOf</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">AxesConvention</a></span>&nbsp;<span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Returns the enum constant of this class with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this class. (Extraneous whitespace characters are
not permitted.)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt>Returns:</dt>
<dd>the enum constant with the specified name</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">Illegal­Argument­Exception</a></code> - if this enum class has no constant with the specified name</dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">Null­Pointer­Exception</a></code> - if the argument is null</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>