blob: dc49286eda9b1d4a73f667344d3659f67957f4ad [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>org.apache.sis.referencing.cs (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">
<meta name="generator" content="javadoc/PackageWriterImpl">
<meta name="keywords" content="org.apache.sis.referencing.cs package">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../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="package-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 class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#package">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Package:</p>
<ul>
<li><a href="#package-description">Description</a></li>
<li><a href="#related-package-summary">Related Packages</a></li>
<li><a href="#class-summary">Classes and Interfaces</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</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">
<div class="header">
<h1 title="Package org.apache.sis.referencing.cs" class="title">Package org.apache.sis.referencing.cs</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.sis.referencing.cs</span></div>
<section class="package-description" id="package-description">
<div class="block">Coordinate System (CS) definitions as the set of coordinate system axes that spans the coordinate space.
An explanation for this package is provided in the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/package-summary.html" class="external-link">OpenGIS® javadoc</a>.
The remaining discussion on this page is specific to the SIS implementation.
<p>The root class in this package is <a href="AbstractCS.html" title="class in org.apache.sis.referencing.cs"><code>Abstract­CS</code></a>.
Various subclasses are defined for various kinds of mathematical rules that determine
how coordinates are associated to quantities such as angles and distances.
Those SIS subclasses provide additional methods that are not part of OGC/ISO specifications:</p>
<ul>
<li><a href="AbstractCS.html#forConvention(org.apache.sis.referencing.cs.AxesConvention)"><code>Abstract­CS​.for­Convention(Axes­Convention)</code></a></li>
</ul>
This package provides also a <a href="CoordinateSystems.html" title="class in org.apache.sis.referencing.cs"><code>Coordinate­Systems</code></a> utility class
with static methods for estimating an angle between two axes, determining the change of axis directions
and units between two coordinate systems, or filtering axes.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.4</dd>
<p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.sis.referencing</a></div>
<div class="col-last even-row-color">
<div class="block">Base classes for reference systems used for general positioning.</div>
</div>
<div class="col-first odd-row-color"><a href="../crs/package-summary.html">org.apache.sis.referencing.crs</a></div>
<div class="col-last odd-row-color">
<div class="block">Coordinate Reference System (CRS) definitions as coordinate systems related to the earth through datum.</div>
</div>
<div class="col-first even-row-color"><a href="../datum/package-summary.html">org.apache.sis.referencing.datum</a></div>
<div class="col-last even-row-color">
<div class="block">Relationship of a <code>Coordinate­System</code> (an abstract mathematical entity) to the earth or other system.</div>
</div>
<div class="col-first odd-row-color"><a href="../factory/package-summary.html">org.apache.sis.referencing.factory</a></div>
<div class="col-last odd-row-color">
<div class="block">Creates Coordinate Reference System (CRS) objects from given properties or authority codes.</div>
</div>
<div class="col-first even-row-color"><a href="../gazetteer/package-summary.html">org.apache.sis.referencing.gazetteer</a></div>
<div class="col-last even-row-color">
<div class="block">Mapping between geographic identifiers (addresses, grid indexes…) and locations (descriptions, coordinates…).</div>
</div>
<div class="col-first odd-row-color"><a href="../operation/package-summary.html">org.apache.sis.referencing.operation</a></div>
<div class="col-last odd-row-color">
<div class="block">Relationship between any two <a href="../crs/AbstractCRS.html" title="class in org.apache.sis.referencing.crs">Coordinate Reference Systems</a> (CRS).</div>
</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractCS.html" title="class in org.apache.sis.referencing.cs">AbstractCS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The set of <a href="DefaultCoordinateSystemAxis.html" title="class in org.apache.sis.referencing.cs">coordinate system axes</a> that spans a given coordinate space.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="AxesConvention.html" title="enum class in org.apache.sis.referencing.cs">AxesConvention</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">
<div class="block">High-level characteristics about the axes of a coordinate system.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="AxisFilter.html" title="interface in org.apache.sis.referencing.cs">AxisFilter</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Modifications to apply on the axes of a coordinate system in order to produce a new coordinate system.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CoordinateSystems.html" title="class in org.apache.sis.referencing.cs">CoordinateSystems</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Utility methods working on <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/cs/CoordinateSystem.html" title="class or interface in org.opengis.referencing.cs" class="external-link"><code>Coordinate­System</code></a> objects and their axes.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultAffineCS.html" title="class in org.apache.sis.referencing.cs">DefaultAffineCS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A 2- or 3-dimensional coordinate system with straight axes that are not necessarily orthogonal.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultCartesianCS.html" title="class in org.apache.sis.referencing.cs">DefaultCartesianCS</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A 2- or 3-dimensional Cartesian coordinate system made of straight orthogonal axes.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultCompoundCS.html" title="class in org.apache.sis.referencing.cs">DefaultCompoundCS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A coordinate system made of two or more independent coordinate systems.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultCoordinateSystemAxis.html" title="class in org.apache.sis.referencing.cs">DefaultCoordinateSystemAxis</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Coordinate system axis name, direction, unit and range of values.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultCylindricalCS.html" title="class in org.apache.sis.referencing.cs">DefaultCylindricalCS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A 3-dimensional coordinate system made of a
<a href="DefaultPolarCS.html" title="class in org.apache.sis.referencing.cs">polar coordinate system</a> extended by a straight perpendicular axis.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultEllipsoidalCS.html" title="class in org.apache.sis.referencing.cs">DefaultEllipsoidalCS</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A 2- or 3-dimensional coordinate system for geodetic latitude and longitude, optionally with ellipsoidal height.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultLinearCS.html" title="class in org.apache.sis.referencing.cs">DefaultLinearCS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A 1-dimensional coordinate system for points that lie on a single axis (not necessarily a straight line).</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultParametricCS.html" title="class in org.apache.sis.referencing.cs">DefaultParametricCS</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A 1-dimensional coordinate system for parametric values or functions.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultPolarCS.html" title="class in org.apache.sis.referencing.cs">DefaultPolarCS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A 2-dimensional coordinate system for coordinates represented by a distance from the origin
and an angle from a fixed direction.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultSphericalCS.html" title="class in org.apache.sis.referencing.cs">DefaultSphericalCS</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A 3-dimensional coordinate system with one distance measured from the origin and two angular coordinates.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultTimeCS.html" title="class in org.apache.sis.referencing.cs">DefaultTimeCS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A 1-dimensional coordinate system for time elapsed in the specified time units from a specified time origin.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultUserDefinedCS.html" title="class in org.apache.sis.referencing.cs">DefaultUserDefinedCS</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A 2- or 3-dimensional coordinate system for any combination of coordinate axes not covered by other CS types.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultVerticalCS.html" title="class in org.apache.sis.referencing.cs">DefaultVerticalCS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A 1-dimensional coordinate system for heights or depths of points.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</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>