blob: e95cff8e10af7cbae3778b5b567f8e78a80b08c3 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>org.apache.sis.referencing.crs (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.crs">
<meta name="generator" content="javadoc/PackageWriterImpl">
<meta name="keywords" content="org.apache.sis.referencing.crs 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.crs" class="title">Package org.apache.sis.referencing.crs</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.sis.referencing.crs</span></div>
<section class="package-description" id="package-description">
<div class="block">Coordinate Reference System (CRS) definitions as coordinate systems related to the earth through datum.
An explanation for this package is provided in the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/crs/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 for this package is <a href="AbstractCRS.html" title="class in org.apache.sis.referencing.crs"><code>Abstract­CRS</code></a>.
Coordinate Reference System (CRS) can have various number of dimensions, but some restrictions
apply depending on the CRS type:</p>
<table class="sis">
<caption>Common Coordinate Reference System types</caption>
<tr><th>Dimension</th> <th>CRS type examples</th> <th>Remarks</th></tr>
<tr>
<td>3</td>
<td><a href="DefaultGeographicCRS.html" title="class in org.apache.sis.referencing.crs">Geographic</a>,
<a href="DefaultGeocentricCRS.html" title="class in org.apache.sis.referencing.crs">Geocentric</a></td>
<td>ISO 19111 uses the same class, <code>Geodetic­CRS</code>, for those two cases.</td>
</tr><tr>
<td>2</td>
<td><a href="DefaultGeographicCRS.html" title="class in org.apache.sis.referencing.crs">Geographic</a>,
<a href="DefaultProjectedCRS.html" title="class in org.apache.sis.referencing.crs">Projected</a></td>
<td><code>GeographicCRS</code> can also be 3D.</td>
</tr><tr>
<td>1</td>
<td><a href="DefaultVerticalCRS.html" title="class in org.apache.sis.referencing.crs">Vertical</a>,
<a href="DefaultTemporalCRS.html" title="class in org.apache.sis.referencing.crs">Temporal</a>.</td>
<td></td>
</tr><tr>
<td>Any</td>
<td><a href="DefaultCompoundCRS.html" title="class in org.apache.sis.referencing.crs">Compound</a></td>
<td>Often used for adding a time axis to the above CRS.</td>
</tr>
</table>
<h2>Apache SIS extensions</h2>
Some SIS implementations provide additional methods that are not part of OGC/ISO specifications:
<ul>
<li><code>Abstract­CRS​.for­Convention(Axes­Convention)</code></li>
<li><a href="DefaultTemporalCRS.html#toDate(double)"><code>Default­Temporal­CRS​.to­Date(double)</code></a></li>
<li><a href="DefaultTemporalCRS.html#toValue(java.time.Instant)"><code>Default­Temporal­CRS​.to­Value(Date)</code></a></li>
</ul>
In addition Apache SIS provides two distinct classes for geographic and geocentric CRS where OGC/ISO defines
a single <code>Geodetic­CRS</code> type. OGC/ISO distinguishes the geographic/geocentric cases according the type
of the coordinate system associated to that CRS:
<ul>
<li>A geodetic CRS associated to an <a href="../cs/DefaultEllipsoidalCS.html" title="class in org.apache.sis.referencing.cs">ellipsoidal CS</a>
is geographic.</li>
<li>A geodetic CRS associated to a <a href="../cs/DefaultSphericalCS.html" title="class in org.apache.sis.referencing.cs">spherical</a> or
<a href="../cs/DefaultCartesianCS.html" title="class in org.apache.sis.referencing.cs">Cartesian CS</a> is geocentric.</li>
</ul>
SIS keeps the geographic and geocentric CRS as distinct types since such distinction is in wide use.</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="../cs/package-summary.html">org.apache.sis.referencing.cs</a></div>
<div class="col-last odd-row-color">
<div class="block">Coordinate System (CS) definitions as the set of coordinate system axes that spans the coordinate space.</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="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="caption"><span>Classes</span></div>
<div class="summary-table two-column-summary">
<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="AbstractCRS.html" title="class in org.apache.sis.referencing.crs">AbstractCRS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Coordinate reference system, defined by a <a href="../cs/AbstractCS.html" title="class in org.apache.sis.referencing.cs">coordinate system</a>
and (usually) a <a href="../datum/AbstractDatum.html" title="class in org.apache.sis.referencing.datum">datum</a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultCompoundCRS.html" title="class in org.apache.sis.referencing.crs">DefaultCompoundCRS</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A CRS describing the position of points through two or more independent coordinate reference systems.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultDerivedCRS.html" title="class in org.apache.sis.referencing.crs">DefaultDerivedCRS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A coordinate reference system that is defined by its coordinate <a href="../operation/DefaultConversion.html" title="class in org.apache.sis.referencing.operation">conversion</a>
from another CRS (not by a <a href="../datum/AbstractDatum.html" title="class in org.apache.sis.referencing.datum">datum</a>).</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultEngineeringCRS.html" title="class in org.apache.sis.referencing.crs">DefaultEngineeringCRS</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A 1-, 2- or 3-dimensional contextually local coordinate reference system.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultGeocentricCRS.html" title="class in org.apache.sis.referencing.crs">DefaultGeocentricCRS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A 3-dimensional coordinate reference system with the origin at the approximate centre of mass of the earth.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultGeographicCRS.html" title="class in org.apache.sis.referencing.crs">DefaultGeographicCRS</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A 2- or 3-dimensional coordinate reference system based on an ellipsoidal approximation of the geoid.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultImageCRS.html" title="class in org.apache.sis.referencing.crs">DefaultImageCRS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A 2-dimensional engineering coordinate reference system applied to locations in images.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultParametricCRS.html" title="class in org.apache.sis.referencing.crs">DefaultParametricCRS</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A 1-dimensional coordinate reference system which uses parameter values or functions.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultProjectedCRS.html" title="class in org.apache.sis.referencing.crs">DefaultProjectedCRS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A 2-dimensional coordinate reference system used to approximate the shape of the earth on a planar surface.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultTemporalCRS.html" title="class in org.apache.sis.referencing.crs">DefaultTemporalCRS</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A 1-dimensional coordinate reference system used for the recording of time.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultVerticalCRS.html" title="class in org.apache.sis.referencing.crs">DefaultVerticalCRS</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A 1-dimensional coordinate reference system used for recording heights or depths.</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>