blob: 075c7d427deada647f69ccf0efdb05afb0d72a1b [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>org.apache.sis.referencing.datum (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.datum">
<meta name="generator" content="javadoc/PackageWriterImpl">
<meta name="keywords" content="org.apache.sis.referencing.datum 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.datum" class="title">Package org.apache.sis.referencing.datum</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.sis.referencing.datum</span></div>
<section class="package-description" id="package-description">
<div class="block">Relationship of a <code>Coordinate­System</code> (an abstract mathematical entity) to the earth or other system.
An explanation for this package is provided in the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/datum/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="AbstractDatum.html" title="class in org.apache.sis.referencing.datum"><code>Abstract­Datum</code></a>.
Various subclasses are defined for various kinds of relationship to the Earth or time
(<a href="DefaultGeodeticDatum.html" title="class in org.apache.sis.referencing.datum">geodetic</a>,
<a href="DefaultVerticalDatum.html" title="class in org.apache.sis.referencing.datum">vertical</a>,
<a href="DefaultTemporalDatum.html" title="class in org.apache.sis.referencing.datum">temporal</a>),
or to platforms (mobile or not)
(<a href="DefaultEngineeringDatum.html" title="class in org.apache.sis.referencing.datum">engineering</a>,
<a href="DefaultImageDatum.html" title="class in org.apache.sis.referencing.datum">image</a>).
Some of those SIS subclasses provide additional methods that are not part of OGC/ISO specifications:</p>
<ul>
<li><a href="DefaultEllipsoid.html#getAuthalicRadius()"><code>Default­Ellipsoid​.get­Authalic­Radius()</code></a></li>
<li><a href="DefaultEllipsoid.html#getEccentricity()"><code>Default­Ellipsoid​.get­Eccentricity()</code></a></li>
<li><a href="DefaultPrimeMeridian.html#getGreenwichLongitude(javax.measure.Unit)"><code>Default­Prime­Meridian​.get­Greenwich­Longitude(Unit)</code></a></li>
<li><a href="DefaultGeodeticDatum.html#getBursaWolfParameters()"><code>Default­Geodetic­Datum​.get­Bursa­Wolf­Parameters()</code></a></li>
<li><a href="DefaultGeodeticDatum.html#getPositionVectorTransformation(org.opengis.referencing.datum.GeodeticDatum,org.opengis.metadata.extent.Extent)"><code>Default­Geodetic­Datum​.get­Position­Vector­Transformation(Geodetic­Datum, Extent)</code></a></li>
</ul>
<h2>Datum shifts</h2>
Three classes are provided in support of coordinate transformations between different datums:
<ul>
<li><a href="BursaWolfParameters.html" title="class in org.apache.sis.referencing.datum"><code>Bursa­Wolf­Parameters</code></a> performs an approximation
based on a translation, rotation and scale of geocentric coordinates.</li>
<li><a href="TimeDependentBWP.html" title="class in org.apache.sis.referencing.datum"><code>Time­Dependent­BWP</code></a> is like <code>Bursa­Wolf­Parameters</code>,
but varies with time for taking in account the motion of plate tectonic.</li>
<li><a href="DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum"><code>Datum­Shift­Grid</code></a> is used for more accurate transformations
than what <code>Bursa­Wolf­Parameters</code> allows, by interpolating the geographic or geocentric translations
in a grid (e.g. NADCON or NTv2) instead of apply the same transformation for every points.</li>
</ul></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="../cs/package-summary.html">org.apache.sis.referencing.cs</a></div>
<div class="col-last even-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 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="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="AbstractDatum.html" title="class in org.apache.sis.referencing.datum">AbstractDatum</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Specifies the relationship of a <a href="../cs/AbstractCS.html" title="class in org.apache.sis.referencing.cs">Coordinate System</a> to the earth.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BursaWolfParameters.html" title="class in org.apache.sis.referencing.datum">BursaWolfParameters</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parameters for a geographic transformation between two datum having the same prime meridian.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DatumShiftGrid.html" title="class in org.apache.sis.referencing.datum">DatumShiftGrid</a>&lt;C extends <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link">Quantity</a>&lt;C&gt;,<wbr>T extends <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link">Quantity</a>&lt;T&gt;&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Small but non-constant translations to apply on coordinates for datum shifts or other transformation process.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultEllipsoid.html" title="class in org.apache.sis.referencing.datum">DefaultEllipsoid</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Geometric figure that can be used to describe the approximate shape of the earth.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultEngineeringDatum.html" title="class in org.apache.sis.referencing.datum">DefaultEngineeringDatum</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Defines the origin of an engineering coordinate reference system.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultGeodeticDatum.html" title="class in org.apache.sis.referencing.datum">DefaultGeodeticDatum</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Defines the location and orientation of an ellipsoid that approximates the shape of the earth.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultImageDatum.html" title="class in org.apache.sis.referencing.datum">DefaultImageDatum</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Defines the origin of an image coordinate reference system.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultParametricDatum.html" title="class in org.apache.sis.referencing.datum">DefaultParametricDatum</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Defines the origin of a parametric coordinate reference system.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultPrimeMeridian.html" title="class in org.apache.sis.referencing.datum">DefaultPrimeMeridian</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Defines the origin from which longitude values are determined.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultTemporalDatum.html" title="class in org.apache.sis.referencing.datum">DefaultTemporalDatum</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Defines the origin of a temporal coordinate reference system.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultVerticalDatum.html" title="class in org.apache.sis.referencing.datum">DefaultVerticalDatum</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Identifies a particular reference level surface used as a zero-height surface.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TimeDependentBWP.html" title="class in org.apache.sis.referencing.datum">TimeDependentBWP</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parameters for a time-dependent geographic transformation between two datum.</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>