blob: 671f920bd8d23d05d9120e1938575c2522646e8a [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
<title>org.apache.sis.referencing.cs (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 package">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.sis.referencing.cs (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.sis.referencing.cs</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<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/referencing/cs/package-summary.html?is-external=true" class="externalLink">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>
<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>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AxisFilter.html" title="interface in org.apache.sis.referencing.cs">AxisFilter</a></th>
<td class="colLast">
<div class="block">Modifications to apply on the axes of a coordinate system in order to produce a new coordinate system.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AbstractCS.html" title="class in org.apache.sis.referencing.cs">AbstractCS</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CoordinateSystems.html" title="class in org.apache.sis.referencing.cs">CoordinateSystems</a></th>
<td class="colLast">
<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>Coordinate­System</code></a> objects and their axes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultAffineCS.html" title="class in org.apache.sis.referencing.cs">DefaultAffineCS</a></th>
<td class="colLast">
<div class="block">A 2- or 3-dimensional coordinate system with straight axes that are not necessarily orthogonal.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultCartesianCS.html" title="class in org.apache.sis.referencing.cs">DefaultCartesianCS</a></th>
<td class="colLast">
<div class="block">A 2- or 3-dimensional Cartesian coordinate system made of straight orthogonal axes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultCompoundCS.html" title="class in org.apache.sis.referencing.cs">DefaultCompoundCS</a></th>
<td class="colLast">
<div class="block">A coordinate system made of two or more independent coordinate systems.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultCoordinateSystemAxis.html" title="class in org.apache.sis.referencing.cs">DefaultCoordinateSystemAxis</a></th>
<td class="colLast">
<div class="block">Coordinate system axis name, direction, unit and range of values.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultCylindricalCS.html" title="class in org.apache.sis.referencing.cs">DefaultCylindricalCS</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultEllipsoidalCS.html" title="class in org.apache.sis.referencing.cs">DefaultEllipsoidalCS</a></th>
<td class="colLast">
<div class="block">A 2- or 3-dimensional coordinate system for geodetic latitude and longitude, optionally with ellipsoidal height.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultLinearCS.html" title="class in org.apache.sis.referencing.cs">DefaultLinearCS</a></th>
<td class="colLast">
<div class="block">A 1-dimensional coordinate system for points that lie on a single axis (not necessarily a straight line).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultParametricCS.html" title="class in org.apache.sis.referencing.cs">DefaultParametricCS</a></th>
<td class="colLast">
<div class="block">A 1-dimensional coordinate system for parametric values or functions.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultPolarCS.html" title="class in org.apache.sis.referencing.cs">DefaultPolarCS</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultSphericalCS.html" title="class in org.apache.sis.referencing.cs">DefaultSphericalCS</a></th>
<td class="colLast">
<div class="block">A 3-dimensional coordinate system with one distance measured from the origin and two angular coordinates.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultTimeCS.html" title="class in org.apache.sis.referencing.cs">DefaultTimeCS</a></th>
<td class="colLast">
<div class="block">A 1-dimensional coordinate system for time elapsed in the specified time units from a specified time origin.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultUserDefinedCS.html" title="class in org.apache.sis.referencing.cs">DefaultUserDefinedCS</a></th>
<td class="colLast">
<div class="block">A 2- or 3-dimensional coordinate system for any combination of coordinate axes not covered by other CS types.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultVerticalCS.html" title="class in org.apache.sis.referencing.cs">DefaultVerticalCS</a></th>
<td class="colLast">
<div class="block">A 1-dimensional coordinate system for heights or depths of points.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AxesConvention.html" title="enum in org.apache.sis.referencing.cs">AxesConvention</a></th>
<td class="colLast">
<div class="block">High-level characteristics about the axes of a coordinate system.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>