diff options
Diffstat (limited to 'apps')
| -rw-r--r-- | apps/cct.html | 371 | ||||
| -rw-r--r-- | apps/common_man.html | 118 | ||||
| -rw-r--r-- | apps/cs2cs.html | 475 | ||||
| -rw-r--r-- | apps/geod.html | 322 | ||||
| -rw-r--r-- | apps/gie.html | 514 | ||||
| -rw-r--r-- | apps/index.html | 160 | ||||
| -rw-r--r-- | apps/proj.html | 365 | ||||
| -rw-r--r-- | apps/projinfo.html | 799 | ||||
| -rw-r--r-- | apps/projsync.html | 325 |
9 files changed, 3449 insertions, 0 deletions
diff --git a/apps/cct.html b/apps/cct.html new file mode 100644 index 00000000..918aba97 --- /dev/null +++ b/apps/cct.html @@ -0,0 +1,371 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>cct — PROJ 9.0.0 documentation</title> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="shortcut icon" href="../_static/favicon.png"/> + <link rel="canonical" href="https://proj.orgapps/cct.html"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> + <script src="../_static/js/theme.js"></script> + <link rel="author" title="About these documents" href="../about.html" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="cs2cs" href="cs2cs.html" /> + <link rel="prev" title="Applications" href="index.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" style="background: #353130" > + <a href="../index.html"> + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> + <div class="version"> + 9.0.0 + </div> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li> +<li class="toctree-l1"><a class="reference internal" href="../news.html">News</a></li> +<li class="toctree-l1"><a class="reference internal" href="../download.html">Download</a></li> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../usage/index.html">Using PROJ</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Applications</a><ul class="current"> +<li class="toctree-l2 current"><a class="current reference internal" href="#">cct</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li> +<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li> +<li class="toctree-l3"><a class="reference internal" href="#use-of-remote-grids">Use of remote grids</a></li> +<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li> +<li class="toctree-l3"><a class="reference internal" href="#background">Background</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="cs2cs.html">cs2cs</a></li> +<li class="toctree-l2"><a class="reference internal" href="geod.html">geod</a></li> +<li class="toctree-l2"><a class="reference internal" href="gie.html">gie</a></li> +<li class="toctree-l2"><a class="reference internal" href="proj.html">proj</a></li> +<li class="toctree-l2"><a class="reference internal" href="projinfo.html">projinfo</a></li> +<li class="toctree-l2"><a class="reference internal" href="projsync.html">projsync</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../operations/index.html">Coordinate operations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../resource_files.html">Resource files</a></li> +<li class="toctree-l1"><a class="reference internal" href="../geodesic.html">Geodesic calculations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../specifications/index.html">Specifications</a></li> +<li class="toctree-l1"><a class="reference internal" href="../community/index.html">Community</a></li> +<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../zreferences.html">References</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #353130" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">PROJ</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home"></a> »</li> + <li><a href="index.html">Applications</a> »</li> + <li>cct</li> + <li class="wy-breadcrumbs-aside"> + <a href="https://github.com/OSGeo/PROJ/edit/8.2/docs/source/apps/cct.rst" class="fa fa-github"> Edit on GitHub</a> + </li> + </ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation"> + <a href="index.html" class="btn btn-neutral float-left" title="Applications" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="cs2cs.html" class="btn btn-neutral float-right" title="cs2cs" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="cct"> +<span id="id1"></span><h1>cct<a class="headerlink" href="#cct" title="Permalink to this headline">¶</a></h1> +<p id="index-0">Coordinate Conversion and Transformation.</p> +<section id="synopsis"> +<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><p><strong>cct</strong> [<strong>-cIostvz</strong> [args]] <em>+opt[=arg]</em> … file …</p> +</div></blockquote> +<p>or</p> +<blockquote> +<div><p><strong>cct</strong> [<strong>-cIostvz</strong> [args]] {object_definition} file …</p> +</div></blockquote> +<p>Where {object_definition} is one of the possibilities accepted +by <a class="reference internal" href="../development/reference/functions.html#c.proj_create" title="proj_create"><code class="xref c c-func docutils literal notranslate"><span class="pre">proj_create()</span></code></a>, provided it expresses a coordinate operation</p> +<blockquote> +<div><ul class="simple"> +<li><p>a proj-string,</p></li> +<li><p>a WKT string,</p></li> +<li><p>an object code (like “EPSG:1671” “urn:ogc:def:coordinateOperation:EPSG::1671”),</p></li> +<li><p>an object name. e.g. “ITRF2014 to ETRF2014 (1)”. In that case as +uniqueness is not guaranteed, heuristics are applied to determine the appropriate best match.</p></li> +<li><p>a OGC URN combining references for concatenated operations +(e.g. “<a class="reference external" href="urn:ogc:def:coordinateOperation,coordinateOperation:EPSG::3895,coordinateOperation:EPSG::1618">urn:ogc:def:coordinateOperation,coordinateOperation:EPSG::3895,coordinateOperation:EPSG::1618</a>”)</p></li> +<li><p>a PROJJSON string. The jsonschema is at <a class="reference external" href="https://proj.org/schemas/v0.4/projjson.schema.json">https://proj.org/schemas/v0.4/projjson.schema.json</a></p></li> +</ul> +<div class="versionadded"> +<p><span class="versionmodified added">New in version 8.0.0.</span></p> +</div> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>Before version 8.0.0 only proj-strings could be used to instantiate +operations in <strong class="program">cct</strong>.</p> +</div> +</div></blockquote> +<p>or</p> +<blockquote> +<div><p><strong>cct</strong> [<strong>-cIostvz</strong> [args]] {object_reference} file …</p> +</div></blockquote> +<p>where {object_reference} is a filename preceded by the ‘@’ character. The +file referenced by the {object_reference} must contain a valid +{object_definition}.</p> +<blockquote> +<div><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.0.0.</span></p> +</div> +</div></blockquote> +</section> +<section id="description"> +<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> +<p><strong class="program">cct</strong> is a 4D equivalent to the <strong class="program">proj</strong> projection program, +performs transformation coordinate systems on a set of input points. The +coordinate system transformation can include translation between projected +and geographic coordinates as well as the application of datum shifts.</p> +<p>The following control parameters can appear in any order:</p> +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cct-c"> +<span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"> <span class="pre"><x,y,z,t></span></span><a class="headerlink" href="#cmdoption-cct-c" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify input columns for (up to) 4 input parameters. Defaults to 1,2,3,4.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cct-d"> +<span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"> <span class="pre"><n></span></span><a class="headerlink" href="#cmdoption-cct-d" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 5.2.0.</span></p> +</div> +<p>Specify the number of decimals in the output.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cct-I"> +<span id="cmdoption-cct-i"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cct-I" title="Permalink to this definition">¶</a></dt> +<dd><p>Do the inverse transformation.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cct-o"> +<span id="cmdoption-cct-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre"><output</span> <span class="pre">file</span> <span class="pre">name></span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"><span class="pre">=<output</span> <span class="pre">file</span> <span class="pre">name></span></span><a class="headerlink" href="#cmdoption-cct-o" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify the name of the output file.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cct-t"> +<span id="cmdoption-cct-time"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"> <span class="pre"><time></span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--time</span></span><span class="sig-prename descclassname"><span class="pre">=<time></span></span><a class="headerlink" href="#cmdoption-cct-t" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify a fixed observation <em>time</em> to be used for all input data.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cct-z"> +<span id="cmdoption-cct-height"></span><span class="sig-name descname"><span class="pre">-z</span></span><span class="sig-prename descclassname"> <span class="pre"><height></span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--height</span></span><span class="sig-prename descclassname"><span class="pre">=<height></span></span><a class="headerlink" href="#cmdoption-cct-z" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify a fixed observation <em>height</em> to be used for all input data.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cct-s"> +<span id="cmdoption-cct-skip-lines"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"> <span class="pre"><n></span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--skip-lines</span></span><span class="sig-prename descclassname"><span class="pre">=<n></span></span><a class="headerlink" href="#cmdoption-cct-s" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 5.1.0.</span></p> +</div> +<p>Skip the first <em>n</em> lines of input. This applies to any kind of input, whether +it comes from <code class="docutils literal notranslate"><span class="pre">STDIN</span></code>, a file or interactive user input.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cct-v"> +<span id="cmdoption-cct-verbose"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cct-v" title="Permalink to this definition">¶</a></dt> +<dd><p>Write non-essential, but potentially useful, information to stderr. +Repeat for additional information (<code class="docutils literal notranslate"><span class="pre">-vv</span></code>, <code class="docutils literal notranslate"><span class="pre">-vvv</span></code>, etc.)</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cct-version"> +<span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cct-version" title="Permalink to this definition">¶</a></dt> +<dd><p>Print version number.</p> +</dd></dl> + +<p>The <em>+opt</em> arguments are associated with coordinate operation parameters. +Usage varies with operation.</p> +<p>For a complete description consult the <a class="reference internal" href="../operations/projections/index.html#projections"><span class="std std-ref">projection pages</span></a>.</p> +<p><strong class="program">cct</strong> is an acronym meaning <em>Coordinate Conversion and Transformation</em>.</p> +<p>The acronym refers to definitions given in the OGC 08-015r2/ISO-19111 +standard “Geographical Information – Spatial Referencing by Coordinates”, +which defines two different classes of <em>coordinate operations</em>:</p> +<p><em>Coordinate Conversions</em>, which are coordinate operations where input +and output datum are identical (e.g. conversion from geographical to +cartesian coordinates) and</p> +<p><em>Coordinate Transformations</em>, which are coordinate operations where +input and output datums differ (e.g. change of reference frame).</p> +</section> +<section id="use-of-remote-grids"> +<h2>Use of remote grids<a class="headerlink" href="#use-of-remote-grids" title="Permalink to this headline">¶</a></h2> +<div class="versionadded"> +<p><span class="versionmodified added">New in version 7.0.0.</span></p> +</div> +<p>If the <span class="target" id="index-1"></span><a class="reference internal" href="../usage/environmentvars.html#envvar-PROJ_NETWORK"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PROJ_NETWORK</span></code></a> environment variable is set to <code class="docutils literal notranslate"><span class="pre">ON</span></code>, +<strong class="program">cct</strong> will attempt to use remote grids stored on CDN (Content +Delivery Network) storage, when they are not available locally.</p> +<p>More details are available in the <a class="reference internal" href="../usage/network.html#network"><span class="std std-ref">Network capabilities</span></a> section.</p> +</section> +<section id="examples"> +<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2> +<ol class="arabic simple"> +<li><p>The operator specs describe the action to be performed by <strong class="program">cct</strong>. So +the following script</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">echo 12 55 0 0 | cct +proj=utm +zone=32 +ellps=GRS80</span> +</pre></div> +</div> +<p>will transform the input geographic coordinates into UTM zone 32 coordinates. +Hence, the command</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">echo 12 55 | cct -z0 -t0 +proj=utm +zone=32 +ellps=GRS80</span> +</pre></div> +</div> +<p>Should give results comparable to the classic <strong class="program">proj</strong> command</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">echo 12 55 | proj +proj=utm +zone=32 +ellps=GRS80</span> +</pre></div> +</div> +<ol class="arabic simple" start="2"> +<li><p>Convert geographical input to UTM zone 32 on the GRS80 ellipsoid:</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">cct +proj=utm +ellps=GRS80 +zone=32</span> +</pre></div> +</div> +<ol class="arabic simple" start="3"> +<li><p>Roundtrip accuracy check for the case above:</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">cct +proj=pipeline +proj=utm +ellps=GRS80 +zone=32 +step +step +inv</span> +</pre></div> +</div> +<ol class="arabic simple" start="4"> +<li><p>As (2) but specify input columns for longitude, latitude, height and time:</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">cct -c 5,2,1,4 +proj=utm +ellps=GRS80 +zone=32</span> +</pre></div> +</div> +<ol class="arabic simple" start="5"> +<li><p>As (2) but specify fixed height and time, hence needing only 2 cols in +input:</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">cct -t 0 -z 0 +proj=utm +ellps=GRS80 +zone=32</span> +</pre></div> +</div> +<ol class="arabic simple" start="6"> +<li><p>Auxiliary data following the coordinate input is forward to the output +stream:</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">echo</span> <span class="m">12</span> <span class="m">56</span> <span class="m">100</span> <span class="m">2018</span>.0 auxiliary data <span class="p">|</span> cct +proj<span class="o">=</span>merc +<span class="go">1335833.8895 7522963.2411 100.0000 2018.0000 auxiliary data</span> +</pre></div> +</div> +<ol class="arabic simple" start="7"> +<li><p>Coordinate operation referenced through its code</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">echo</span> <span class="m">3541657</span>.3778 <span class="m">948984</span>.2343 <span class="m">5201383</span>.5231 <span class="m">2020</span>.5 <span class="p">|</span> cct EPSG:8366 +<span class="go">3541657.9112 948983.7503 5201383.2482 2020.5000</span> +</pre></div> +</div> +<ol class="arabic simple" start="8"> +<li><p>Coordinate operation referenced through its name</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">echo</span> <span class="m">3541657</span>.3778 <span class="m">948984</span>.2343 <span class="m">5201383</span>.5231 <span class="m">2020</span>.5 <span class="p">|</span> cct <span class="s2">"ITRF2014 to ETRF2014 (1)"</span> +<span class="go">3541657.9112 948983.7503 5201383.2482 2020.5000</span> +</pre></div> +</div> +</section> +<section id="background"> +<h2>Background<a class="headerlink" href="#background" title="Permalink to this headline">¶</a></h2> +<p><strong class="program">cct</strong> also refers to Carl Christian Tscherning (1942–2014), +professor of Geodesy at the University of Copenhagen, mentor and advisor +for a generation of Danish geodesists, colleague and collaborator for +two generations of global geodesists, Secretary General for the +International Association of Geodesy, IAG (1995–2007), fellow of the +American Geophysical Union (1991), recipient of the IAG Levallois Medal +(2007), the European Geosciences Union Vening Meinesz Medal (2008), and +of numerous other honours.</p> +<p><em>cct</em>, or Christian, as he was known to most of us, was recognized for his +good mood, his sharp wit, his tireless work, and his great commitment to +the development of geodesy – both through his scientific contributions, +comprising more than 250 publications, and by his mentoring and teaching +of the next generations of geodesists.</p> +<p>As Christian was an avid Fortran programmer, and a keen Unix connoisseur, +he would have enjoyed to know that his initials would be used to name a +modest Unix style transformation filter, hinting at the tireless aspect +of his personality, which was certainly one of the reasons he accomplished +so much, and meant so much to so many people.</p> +<p>Hence, in honour of <em>cct</em> (the geodesist) this is <strong class="program">cct</strong> (the program).</p> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="index.html" class="btn btn-neutral float-left" title="Applications" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="cs2cs.html" class="btn btn-neutral float-right" title="cs2cs" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 1983-2022. + <span class="lastupdated">Last updated on 22 Mar 2022. + </span></p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/apps/common_man.html b/apps/common_man.html new file mode 100644 index 00000000..e3facb4c --- /dev/null +++ b/apps/common_man.html @@ -0,0 +1,118 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Bugs — PROJ 9.0.0 documentation</title> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="shortcut icon" href="../_static/favicon.png"/> + <link rel="canonical" href="https://proj.orgapps/common_man.html"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> + <script src="../_static/js/theme.js"></script> + <link rel="author" title="About these documents" href="../about.html" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" style="background: #353130" > + <a href="../index.html"> + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> + <div class="version"> + 9.0.0 + </div> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul> +<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li> +<li class="toctree-l1"><a class="reference internal" href="../news.html">News</a></li> +<li class="toctree-l1"><a class="reference internal" href="../download.html">Download</a></li> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../usage/index.html">Using PROJ</a></li> +<li class="toctree-l1"><a class="reference internal" href="index.html">Applications</a></li> +<li class="toctree-l1"><a class="reference internal" href="../operations/index.html">Coordinate operations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../resource_files.html">Resource files</a></li> +<li class="toctree-l1"><a class="reference internal" href="../geodesic.html">Geodesic calculations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../specifications/index.html">Specifications</a></li> +<li class="toctree-l1"><a class="reference internal" href="../community/index.html">Community</a></li> +<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../zreferences.html">References</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #353130" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">PROJ</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home"></a> »</li> + <li>Bugs</li> + <li class="wy-breadcrumbs-aside"> + <a href="https://github.com/OSGeo/PROJ/edit/8.2/docs/source/apps/common_man.rst" class="fa fa-github"> Edit on GitHub</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + + + </div> + </div> + <footer> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 1983-2022. + <span class="lastupdated">Last updated on 22 Mar 2022. + </span></p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/apps/cs2cs.html b/apps/cs2cs.html new file mode 100644 index 00000000..92d98322 --- /dev/null +++ b/apps/cs2cs.html @@ -0,0 +1,475 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>cs2cs — PROJ 9.0.0 documentation</title> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="shortcut icon" href="../_static/favicon.png"/> + <link rel="canonical" href="https://proj.orgapps/cs2cs.html"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> + <script src="../_static/js/theme.js"></script> + <link rel="author" title="About these documents" href="../about.html" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="geod" href="geod.html" /> + <link rel="prev" title="cct" href="cct.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" style="background: #353130" > + <a href="../index.html"> + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> + <div class="version"> + 9.0.0 + </div> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li> +<li class="toctree-l1"><a class="reference internal" href="../news.html">News</a></li> +<li class="toctree-l1"><a class="reference internal" href="../download.html">Download</a></li> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../usage/index.html">Using PROJ</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Applications</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="cct.html">cct</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">cs2cs</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li> +<li class="toctree-l3"><a class="reference internal" href="#description">Description</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#use-of-remote-grids">Use of remote grids</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#using-proj-strings">Using PROJ strings</a></li> +<li class="toctree-l4"><a class="reference internal" href="#using-epsg-crs-codes">Using EPSG CRS codes</a></li> +<li class="toctree-l4"><a class="reference internal" href="#using-epsg-crs-names">Using EPSG CRS names</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="geod.html">geod</a></li> +<li class="toctree-l2"><a class="reference internal" href="gie.html">gie</a></li> +<li class="toctree-l2"><a class="reference internal" href="proj.html">proj</a></li> +<li class="toctree-l2"><a class="reference internal" href="projinfo.html">projinfo</a></li> +<li class="toctree-l2"><a class="reference internal" href="projsync.html">projsync</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../operations/index.html">Coordinate operations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../resource_files.html">Resource files</a></li> +<li class="toctree-l1"><a class="reference internal" href="../geodesic.html">Geodesic calculations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../specifications/index.html">Specifications</a></li> +<li class="toctree-l1"><a class="reference internal" href="../community/index.html">Community</a></li> +<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../zreferences.html">References</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #353130" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">PROJ</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home"></a> »</li> + <li><a href="index.html">Applications</a> »</li> + <li>cs2cs</li> + <li class="wy-breadcrumbs-aside"> + <a href="https://github.com/OSGeo/PROJ/edit/8.2/docs/source/apps/cs2cs.rst" class="fa fa-github"> Edit on GitHub</a> + </li> + </ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation"> + <a href="cct.html" class="btn btn-neutral float-left" title="cct" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="geod.html" class="btn btn-neutral float-right" title="geod" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="cs2cs"> +<span id="id1"></span><h1>cs2cs<a class="headerlink" href="#cs2cs" title="Permalink to this headline">¶</a></h1> +<p>Filter for transformations between two coordinate reference systems.</p> +<section id="synopsis"> +<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><div class="line-block"> +<div class="line"><strong>cs2cs</strong> [<strong>-eEfIlrstvwW</strong> [args]]</div> +<div class="line-block"> +<div class="line">[[–area <name_or_code>] | [–bbox <west_long,south_lat,east_long,north_lat>]]</div> +<div class="line">[–authority <name>] [–no-ballpark] [–accuracy <accuracy>]</div> +<div class="line">([<em>+opt[=arg]</em> …] [+to <em>+opt[=arg]</em> …] | {source_crs} {target_crs})</div> +<div class="line">file …</div> +</div> +</div> +<p>where {source_crs} or {target_crs} is one of the possibilities accepted +by <a class="reference internal" href="../development/reference/functions.html#c.proj_create" title="proj_create"><code class="xref c c-func docutils literal notranslate"><span class="pre">proj_create()</span></code></a>, provided it expresses a CRS</p> +<ul class="simple"> +<li><p>a proj-string,</p></li> +<li><p>a WKT string,</p></li> +<li><p>an object code (like “EPSG:4326”, “urn:ogc:def:crs:EPSG::4326”, +“urn:ogc:def:coordinateOperation:EPSG::1671”),</p></li> +<li><p>an Object name. e.g “WGS 84”, “WGS 84 / UTM zone 31N”. In that case as +uniqueness is not guaranteed, heuristics are applied to determine the appropriate best match.</p></li> +<li><p>a OGC URN combining references for compound coordinate reference systems +(e.g “<a class="reference external" href="urn:ogc:def:crs,crs:EPSG::2393,crs:EPSG::5717">urn:ogc:def:crs,crs:EPSG::2393,crs:EPSG::5717</a>” or custom abbreviated +syntax “EPSG:2393+5717”),</p></li> +<li><p>a OGC URN combining references for references for projected or derived CRSs +e.g. for Projected 3D CRS “UTM zone 31N / WGS 84 (3D)”: +“<a class="reference external" href="urn:ogc:def:crs,crs:EPSG::4979,cs:PROJ::ENh,coordinateOperation:EPSG::16031">urn:ogc:def:crs,crs:EPSG::4979,cs:PROJ::ENh,coordinateOperation:EPSG::16031</a>” +(<em>added in 6.2</em>)</p></li> +<li><p>a OGC URN combining references for concatenated operations +(e.g. “<a class="reference external" href="urn:ogc:def:coordinateOperation,coordinateOperation:EPSG::3895,coordinateOperation:EPSG::1618">urn:ogc:def:coordinateOperation,coordinateOperation:EPSG::3895,coordinateOperation:EPSG::1618</a>”)</p></li> +<li><p>a PROJJSON string. The jsonschema is at <a class="reference external" href="https://proj.org/schemas/v0.4/projjson.schema.json">https://proj.org/schemas/v0.4/projjson.schema.json</a> (<em>added in 6.2</em>)</p></li> +<li><p>a compound CRS made from two object names separated with ” + “. e.g. “WGS 84 + EGM96 height” (<em>added in 7.1</em>)</p></li> +</ul> +<div class="versionadded"> +<p><span class="versionmodified added">New in version 6.0.0.</span></p> +</div> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>before 7.0.1, it was needed to add +to between {source_crs} and {target_crs} +when adding a filename</p> +</div> +</div></blockquote> +</section> +<section id="description"> +<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> +<p><strong class="program">cs2cs</strong> performs transformation between the source and destination +cartographic coordinate reference system on a set of input points. The coordinate +reference system transformation can include translation between projected and +geographic coordinates as well as the application of datum shifts.</p> +<p>The following control parameters can appear in any order:</p> +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-I"> +<span id="cmdoption-cs2cs-i"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-I" title="Permalink to this definition">¶</a></dt> +<dd><p>Method to specify inverse translation, convert from <em>+to</em> coordinate system to +the primary coordinate system defined.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-t-a"> +<span class="sig-name descname"><span class="pre">-t<a></span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-t-a" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>a</em> specifies a character employed as the first character to denote a control +line to be passed through without processing. This option applicable to +ASCII input only. (# is the default value).</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-d"> +<span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"> <span class="pre"><n></span></span><a class="headerlink" href="#cmdoption-cs2cs-d" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 5.2.0.</span></p> +</div> +<p>Specify the number of decimals in the output.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-e"> +<span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"> <span class="pre"><string></span></span><a class="headerlink" href="#cmdoption-cs2cs-e" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>string</em> is an arbitrary string to be output if an error is detected during +data transformations. The default value is a three character string: <code class="docutils literal notranslate"><span class="pre">*\t*</span></code>.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-E"> +<span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-E" title="Permalink to this definition">¶</a></dt> +<dd><p>Causes the input coordinates to be copied to the output line prior to +printing the converted values.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-l"> +<span class="sig-name descname"><span class="pre">-l<[</span></span><span class="sig-prename descclassname"><span class="pre">=id]></span></span><a class="headerlink" href="#cmdoption-cs2cs-l" title="Permalink to this definition">¶</a></dt> +<dd><p>List projection identifiers that can be selected with <em>+proj</em>. <code class="docutils literal notranslate"><span class="pre">cs2cs</span> <span class="pre">-l=id</span></code> +gives expanded description of projection <em>id</em>, e.g. <code class="docutils literal notranslate"><span class="pre">cs2cs</span> <span class="pre">-l=merc</span></code>.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-lp"> +<span class="sig-name descname"><span class="pre">-lp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-lp" title="Permalink to this definition">¶</a></dt> +<dd><p>List of all projection id that can be used with the <em>+proj</em> parameter. +Equivalent to <code class="docutils literal notranslate"><span class="pre">cs2cs</span> <span class="pre">-l</span></code>.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-lP"> +<span class="sig-name descname"><span class="pre">-lP</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-lP" title="Permalink to this definition">¶</a></dt> +<dd><p>Expanded description of all projections that can be used with the <em>+proj</em> +parameter.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-le"> +<span class="sig-name descname"><span class="pre">-le</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-le" title="Permalink to this definition">¶</a></dt> +<dd><p>List of all ellipsoids that can be selected with the <em>+ellps</em> parameters.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-lu"> +<span class="sig-name descname"><span class="pre">-lu</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-lu" title="Permalink to this definition">¶</a></dt> +<dd><p>List of all distance units that can be selected with the <em>+units</em> parameter.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-r"> +<span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-r" title="Permalink to this definition">¶</a></dt> +<dd><p>This options reverses the order of the first two expected +inputs from that specified by the CRS to the opposite +order. The third coordinate, typically height, remains +third.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-s"> +<span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-s" title="Permalink to this definition">¶</a></dt> +<dd><p>This options reverses the order of the first two expected +outputs from that specified by the CRS to the opposite +order. The third coordinate, typically height, remains +third.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-f"> +<span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"> <span class="pre"><format></span></span><a class="headerlink" href="#cmdoption-cs2cs-f" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>format</em> is a printf format string to control the form of the output values. +For inverse projections, the output will be in degrees when this option is +employed. If a format is specified for inverse projection the output data +will be in decimal degrees. The default format is <code class="docutils literal notranslate"><span class="pre">"%.2f"</span></code> for forward +projection and DMS for inverse.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-w-n"> +<span class="sig-name descname"><span class="pre">-w<n></span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-w-n" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>n</em> is the number of significant fractional digits to employ for seconds +output (when the option is not specified, <code class="docutils literal notranslate"><span class="pre">-w3</span></code> is assumed).</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-W-n"> +<span class="sig-name descname"><span class="pre">-W<n></span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-W-n" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>n</em> is the number of significant fractional digits to employ for seconds +output. When <code class="docutils literal notranslate"><span class="pre">-W</span></code> is employed the fields will be constant width +with leading zeroes.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-v"> +<span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-v" title="Permalink to this definition">¶</a></dt> +<dd><p>Causes a listing of cartographic control parameters tested for and used by +the program to be printed prior to input data.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-area"> +<span class="sig-name descname"><span class="pre">--area</span></span><span class="sig-prename descclassname"> <span class="pre"><name_or_code></span></span><a class="headerlink" href="#cmdoption-cs2cs-area" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.0.0.</span></p> +</div> +<p>Specify an area of interest to restrict the results when researching +coordinate operations between 2 CRS. The area of interest can be specified either +as a name (e.g “Denmark - onshore”) or a AUTHORITY:CODE (EPSG:3237)</p> +<p>This option is mutually exclusive with <a class="reference internal" href="#cmdoption-cs2cs-bbox"><code class="xref std std-option docutils literal notranslate"><span class="pre">--bbox</span></code></a>.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-bbox"> +<span class="sig-name descname"><span class="pre">--bbox</span></span><span class="sig-prename descclassname"> <span class="pre"><west_long,south_lat,east_long,north_lat></span></span><a class="headerlink" href="#cmdoption-cs2cs-bbox" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.0.0.</span></p> +</div> +<p>Specify an area of interest to restrict the results when researching +coordinate operations between 2 CRS. The area of interest is specified as a +bounding box with geographic coordinates, expressed in degrees in a +unspecified geographic CRS. +<cite>west_long</cite> and <cite>east_long</cite> should be in the [-180,180] range, and +<cite>south_lat</cite> and <cite>north_lat</cite> in the [-90,90]. <cite>west_long</cite> is generally lower than +<cite>east_long</cite>, except in the case where the area of interest crosses the antimeridian.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-no-ballpark"> +<span class="sig-name descname"><span class="pre">--no-ballpark</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cs2cs-no-ballpark" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.0.0.</span></p> +</div> +<p>Disallow any coordinate operation that is, or contains, a +<a class="reference internal" href="../glossary.html#term-Ballpark-transformation"><span class="xref std std-term">Ballpark transformation</span></a></p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-accuracy"> +<span class="sig-name descname"><span class="pre">--accuracy</span></span><span class="sig-prename descclassname"> <span class="pre"><accuracy></span></span><a class="headerlink" href="#cmdoption-cs2cs-accuracy" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.0.0.</span></p> +</div> +<p>Sets the minimum desired accuracy for candidate coordinate operations.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-cs2cs-authority"> +<span class="sig-name descname"><span class="pre">--authority</span></span><span class="sig-prename descclassname"> <span class="pre"><name></span></span><a class="headerlink" href="#cmdoption-cs2cs-authority" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.0.0.</span></p> +</div> +<p>This option can be used to restrict the authority of coordinate operations +looked up in the database. When not specified, coordinate +operations from any authority will be searched, with the restrictions set +in the <code class="docutils literal notranslate"><span class="pre">authority_to_authority_preference</span></code> database table related to the authority +of the source/target CRS themselves. +If authority is set to <code class="docutils literal notranslate"><span class="pre">any</span></code>, then coordinate operations from any authority will be searched +If authority is a non-empty string different of <code class="docutils literal notranslate"><span class="pre">any</span></code>, then coordinate operations +will be searched only in that authority namespace (e.g <code class="docutils literal notranslate"><span class="pre">EPSG</span></code>).</p> +<p>This option is mutually exclusive with <a class="reference internal" href="#cmdoption-cs2cs-bbox"><code class="xref std std-option docutils literal notranslate"><span class="pre">--bbox</span></code></a>.</p> +</dd></dl> + +<p>The <em>+opt</em> run-line arguments are associated with cartographic +parameters. Usage varies with projection and for a complete description +consult the <a class="reference internal" href="../operations/projections/index.html#projections"><span class="std std-ref">projection pages</span></a>.</p> +<p>The <strong class="program">cs2cs</strong> program requires two coordinate reference system (CRS) definitions. The first (or +primary is defined based on all projection parameters not appearing after the +<em>+to</em> argument. All projection parameters appearing after the <em>+to</em> argument +are considered the definition of the second CRS. If there is no +second CRS defined, a geographic CRS based on the +datum and ellipsoid of the source CRS is assumed. Note that the +source and destination CRS can both of same or different nature (geographic, +projected, compound CRS), or one of each and may have the same or different datums.</p> +<p>When using a WKT definition or a AUTHORITY:CODE, the axis order of the CRS will +be enforced. So for example if using EPSG:4326, the first value expected (or +returned) will be a latitude.</p> +<p>Internally, <strong class="program">cs2cs</strong> uses the <a class="reference internal" href="../development/reference/functions.html#c.proj_create_crs_to_crs" title="proj_create_crs_to_crs"><code class="xref c c-func docutils literal notranslate"><span class="pre">proj_create_crs_to_crs()</span></code></a> function +to compute the appropriate coordinate operation, so implementation details of +this function directly impact the results returned by the program.</p> +<p>The environment parameter <span class="target" id="index-0"></span><a class="reference internal" href="../usage/environmentvars.html#envvar-PROJ_LIB"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PROJ_LIB</span></code></a> establishes the +directory for resource files (database, datum shift grids, etc.)</p> +<p>One or more files (processed in left to right order) specify the source of +data to be transformed. A <code class="docutils literal notranslate"><span class="pre">-</span></code> will specify the location of processing standard +input. If no files are specified, the input is assumed to be from stdin. +For input data the two data values must be in the first two white space +separated fields and when both input and output are ASCII all trailing portions +of the input line are appended to the output line.</p> +<p>Input geographic data (longitude and latitude) must be in DMS or decimal +degrees format and input cartesian data must be in units consistent with the +ellipsoid major axis or sphere radius units. Output geographic coordinates will +normally be in DMS format (use <code class="docutils literal notranslate"><span class="pre">-f</span> <span class="pre">%.12f</span></code> for decimal degrees with 12 decimal +places), while projected (cartesian) coordinates will be in linear +(meter, feet) units.</p> +<section id="use-of-remote-grids"> +<h3>Use of remote grids<a class="headerlink" href="#use-of-remote-grids" title="Permalink to this headline">¶</a></h3> +<div class="versionadded"> +<p><span class="versionmodified added">New in version 7.0.0.</span></p> +</div> +<p>If the <span class="target" id="index-1"></span><a class="reference internal" href="../usage/environmentvars.html#envvar-PROJ_NETWORK"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PROJ_NETWORK</span></code></a> environment variable is set to <code class="docutils literal notranslate"><span class="pre">ON</span></code>, +<strong class="program">cs2cs</strong> will attempt to use remote grids stored on CDN (Content +Delivery Network) storage, when they are not available locally.</p> +<p>More details are available in the <a class="reference internal" href="../usage/network.html#network"><span class="std std-ref">Network capabilities</span></a> section.</p> +</section> +</section> +<section id="examples"> +<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2> +<section id="using-proj-strings"> +<h3>Using PROJ strings<a class="headerlink" href="#using-proj-strings" title="Permalink to this headline">¶</a></h3> +<p>The following script</p> +<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>cs2cs +proj=latlong +datum=NAD83 +to +proj=utm +zone=10 +datum=NAD27 -r <<EOF +45°15'33.1" 111.5W +45d15.551666667N -111d30 ++45.25919444444 111d30'000w +EOF +</pre></div> +</div> +<p>will transform the input NAD83 geographic coordinates into NAD27 coordinates in +the UTM projection with zone 10 selected. The geographic values of this +example are equivalent and meant as examples of various forms of DMS input. +The x-y output data will appear as three lines of:</p> +<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>1402293.44 5076292.68 0.00 +</pre></div> +</div> +</section> +<section id="using-epsg-crs-codes"> +<h3>Using EPSG CRS codes<a class="headerlink" href="#using-epsg-crs-codes" title="Permalink to this headline">¶</a></h3> +<p>Transforming from WGS 84 latitude/longitude (in that order) to UTM Zone 31N/WGS 84</p> +<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>cs2cs EPSG:4326 EPSG:32631 <<EOF +45N 2E +EOF +</pre></div> +</div> +<p>outputs</p> +<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>421184.70 4983436.77 0.00 +</pre></div> +</div> +</section> +<section id="using-epsg-crs-names"> +<h3>Using EPSG CRS names<a class="headerlink" href="#using-epsg-crs-names" title="Permalink to this headline">¶</a></h3> +<p>Transforming from WGS 84 latitude/longitude (in that order) with EGM96 height to +UTM Zone 31N/WGS 84 with WGS84 ellipsoidal height</p> +<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>echo 45 2 0 | cs2cs "WGS 84 + EGM96 height" "WGS 84 / UTM zone 31N" +</pre></div> +</div> +<p>outputs</p> +<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>421184.70 4983436.77 50.69 +</pre></div> +</div> +</section> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="cct.html" class="btn btn-neutral float-left" title="cct" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="geod.html" class="btn btn-neutral float-right" title="geod" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 1983-2022. + <span class="lastupdated">Last updated on 22 Mar 2022. + </span></p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/apps/geod.html b/apps/geod.html new file mode 100644 index 00000000..2c1e5b03 --- /dev/null +++ b/apps/geod.html @@ -0,0 +1,322 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>geod — PROJ 9.0.0 documentation</title> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="shortcut icon" href="../_static/favicon.png"/> + <link rel="canonical" href="https://proj.orgapps/geod.html"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> + <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script> + <script src="../_static/js/theme.js"></script> + <link rel="author" title="About these documents" href="../about.html" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="gie" href="gie.html" /> + <link rel="prev" title="cs2cs" href="cs2cs.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" style="background: #353130" > + <a href="../index.html"> + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> + <div class="version"> + 9.0.0 + </div> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li> +<li class="toctree-l1"><a class="reference internal" href="../news.html">News</a></li> +<li class="toctree-l1"><a class="reference internal" href="../download.html">Download</a></li> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../usage/index.html">Using PROJ</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Applications</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="cct.html">cct</a></li> +<li class="toctree-l2"><a class="reference internal" href="cs2cs.html">cs2cs</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">geod</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li> +<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li> +<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li> +<li class="toctree-l3"><a class="reference internal" href="#further-reading">Further reading</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="gie.html">gie</a></li> +<li class="toctree-l2"><a class="reference internal" href="proj.html">proj</a></li> +<li class="toctree-l2"><a class="reference internal" href="projinfo.html">projinfo</a></li> +<li class="toctree-l2"><a class="reference internal" href="projsync.html">projsync</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../operations/index.html">Coordinate operations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../resource_files.html">Resource files</a></li> +<li class="toctree-l1"><a class="reference internal" href="../geodesic.html">Geodesic calculations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../specifications/index.html">Specifications</a></li> +<li class="toctree-l1"><a class="reference internal" href="../community/index.html">Community</a></li> +<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../zreferences.html">References</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #353130" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">PROJ</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home"></a> »</li> + <li><a href="index.html">Applications</a> »</li> + <li>geod</li> + <li class="wy-breadcrumbs-aside"> + <a href="https://github.com/OSGeo/PROJ/edit/8.2/docs/source/apps/geod.rst" class="fa fa-github"> Edit on GitHub</a> + </li> + </ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation"> + <a href="cs2cs.html" class="btn btn-neutral float-left" title="cs2cs" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="gie.html" class="btn btn-neutral float-right" title="gie" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="geod"> +<span id="id1"></span><h1>geod<a class="headerlink" href="#geod" title="Permalink to this headline">¶</a></h1> +<section id="synopsis"> +<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><p><strong>geod</strong> <em>+ellps=<ellipse></em> [<strong>-afFIlptwW</strong> [args]] [<em>+opt[=arg]</em> …] file …</p> +<p><strong>invgeod</strong> <em>+ellps=<ellipse></em> [<strong>-afFIlptwW</strong> [args]] [<em>+opt[=arg]</em> …] file …</p> +</div></blockquote> +</section> +<section id="description"> +<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> +<p><strong class="program">geod</strong> (direct) and <strong class="program">invgeod</strong> (inverse) perform geodesic +(Great Circle) computations for determining latitude, longitude and back +azimuth of a terminus point given a initial point latitude, longitude, +azimuth and distance (direct) or the forward and back azimuths and distance +between an initial and terminus point latitudes and longitudes (inverse). +The results are accurate to round off for <span class="math notranslate nohighlight">\(|f| < 1/50\)</span>, where +<span class="math notranslate nohighlight">\(f\)</span> is flattening.</p> +<p><strong class="program">invgeod</strong> may not be available on all platforms; in this case +use <a class="reference internal" href="#cmdoption-geod-I"><code class="xref std std-option docutils literal notranslate"><span class="pre">geod</span> <span class="pre">-I</span></code></a> instead.</p> +<p>The following command-line options can appear in any order:</p> +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-geod-I"> +<span id="cmdoption-geod-i"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-geod-I" title="Permalink to this definition">¶</a></dt> +<dd><p>Specifies that the inverse geodesic computation is to be performed. May be +used with execution of <strong class="program">geod</strong> as an alternative to <strong class="program">invgeod</strong> execution.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-geod-a"> +<span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-geod-a" title="Permalink to this definition">¶</a></dt> +<dd><p>Latitude and longitudes of the initial and terminal points, forward and +back azimuths and distance are output.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-geod-t-a"> +<span class="sig-name descname"><span class="pre">-t<a></span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-geod-t-a" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>a</em> specifies a character employed as the first character to denote a control +line to be passed through without processing.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-geod-le"> +<span class="sig-name descname"><span class="pre">-le</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-geod-le" title="Permalink to this definition">¶</a></dt> +<dd><p>Gives a listing of all the ellipsoids that may be selected with the +<em>+ellps=</em> option.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-geod-lu"> +<span class="sig-name descname"><span class="pre">-lu</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-geod-lu" title="Permalink to this definition">¶</a></dt> +<dd><p>Gives a listing of all the units that may be selected with the <em>+units=</em> +option. (Default units are meters.)</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-geod-f"> +<span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"> <span class="pre"><format></span></span><a class="headerlink" href="#cmdoption-geod-f" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>format</em> is a printf format string to control the output form of the +geographic coordinate values. The default mode is DMS.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-geod-F"> +<span class="sig-name descname"><span class="pre">-F</span></span><span class="sig-prename descclassname"> <span class="pre"><format></span></span><a class="headerlink" href="#cmdoption-geod-F" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>format</em> is a printf format string to control the output form of the distance +value. The default mode is <code class="docutils literal notranslate"><span class="pre">"%.3f"</span></code>.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-geod-w-n"> +<span class="sig-name descname"><span class="pre">-w<n></span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-geod-w-n" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>n</em> is the number of significant fractional digits to employ for seconds +output (when the option is not specified, <code class="docutils literal notranslate"><span class="pre">-w3</span></code> is assumed).</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-geod-W-n"> +<span class="sig-name descname"><span class="pre">-W<n></span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-geod-W-n" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>n</em> is the number of significant fractional digits to employ for seconds +output. When <code class="docutils literal notranslate"><span class="pre">-W</span></code> is employed the fields will be constant width +with leading zeroes.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-geod-p"> +<span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-geod-p" title="Permalink to this definition">¶</a></dt> +<dd><p>This option causes the azimuthal values to be output as unsigned DMS +numbers between 0 and 360 degrees. Also note <a class="reference internal" href="#cmdoption-geod-f"><code class="xref std std-option docutils literal notranslate"><span class="pre">-f</span></code></a>.</p> +</dd></dl> + +<p>The <em>+opt</em> command-line options are associated with geodetic +parameters for specifying the ellipsoidal or sphere to use. +controls. The options are processed in left to right order +from the command line. Reentry of an option is ignored with +the first occurrence assumed to be the desired value.</p> +<p>See <a class="reference internal" href="../usage/projections.html#projections-intro"><span class="std std-ref">Cartographic projection</span></a> for full +list of these parameters and controls.</p> +<p>One or more files (processed in left to right order) specify +the source of data to be transformed. A <code class="docutils literal notranslate"><span class="pre">-</span></code> will specify the +location of processing standard input. If no files are specified, +the input is assumed to be from stdin.</p> +<p>For direct determinations input data must be in latitude, longitude, +azimuth and distance order and output will be latitude, +longitude and back azimuth of the terminus point. Latitude, +longitude of the initial and terminus point are input for the +inverse mode and respective forward and back azimuth from the +initial and terminus points are output along with the distance +between the points.</p> +<p>Input geographic coordinates (latitude and longitude) and +azimuthal data must be in decimal degrees or DMS format and +input distance data must be in units consistent with the ellipsoid +major axis or sphere radius units. The latitude must lie +in the range [-90d,90d]. Output geographic coordinates will be +in DMS (if the <a class="reference internal" href="#cmdoption-geod-f"><code class="xref std std-option docutils literal notranslate"><span class="pre">-f</span></code></a> switch is not employed) to 0.001” with trailing, +zero-valued minute-second fields deleted. Output distance +data will be in the same units as the ellipsoid or sphere +radius.</p> +<p>The Earth’s ellipsoidal figure may be selected in the same manner +as program <strong class="program">proj</strong> by using <em>+ellps=</em>, <em>+a=</em>, <em>+es=</em>, etc.</p> +<p><strong class="program">geod</strong> may also be used to determine intermediate points along +either a geodesic line between two points or along an arc of +specified distance from a geographic point. In both cases an +initial point must be specified with <em>+lat_1=lat</em> and <em>+lon_1=lon</em> +parameters and either a terminus point <em>+lat_2=lat</em> and +<em>+lon_2=lon</em> or a distance and azimuth from the initial point +with <em>+S=distance</em> and <em>+A=azimuth</em> must be specified.</p> +<p>If points along a geodesic are to be determined then either +<em>+n_S=integer</em> specifying the number of intermediate points +and/or <em>+del_S=distance</em> specifying the incremental distance +between points must be specified.</p> +<p>To determine points along an arc equidistant from the initial +point both <em>+del_A=angle</em> and <em>+n_A=integer</em> must be specified +which determine the respective angular increments and number of +points to be determined.</p> +</section> +<section id="examples"> +<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2> +<p>The following script determines the geodesic azimuths and distance in U.S. +statute miles from Boston, MA, to Portland, OR:</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">geod +ellps=clrk66 <<EOF -I +units=us-mi</span> +<span class="go">42d15'N 71d07'W 45d31'N 123d41'W</span> +<span class="go">EOF</span> +</pre></div> +</div> +<p>which gives the results:</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">-66d31'50.141" 75d39'13.083" 2587.504</span> +</pre></div> +</div> +<p>where the first two values are the azimuth from Boston to Portland, +the back azimuth from Portland to Boston followed by the distance.</p> +<p>An example of forward geodesic use is to use the Boston location +and determine Portland’s location by azimuth and distance:</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">geod +ellps=clrk66 <<EOF +units=us-mi</span> +<span class="go">42d15'N 71d07'W -66d31'50.141" 2587.504</span> +<span class="go">EOF</span> +</pre></div> +</div> +<p>which gives:</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">45d31'0.003"N 123d40'59.985"W 75d39'13.094"</span> +</pre></div> +</div> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>Lack of precision in the distance value compromises the +precision of the Portland location.</p> +</div> +</section> +<section id="further-reading"> +<h2>Further reading<a class="headerlink" href="#further-reading" title="Permalink to this headline">¶</a></h2> +<ol class="arabic simple"> +<li><p><a class="reference external" href="https://geographiclib.sourceforge.io">GeographicLib</a>.</p></li> +<li><p>C. F. F. Karney, <a class="reference external" href="https://doi.org/10.1007/s00190-012-0578-z">Algorithms for Geodesics</a>, J. Geodesy <strong>87</strong>(1), 43–55 (2013); +<a class="reference external" href="https://geographiclib.sourceforge.io/geod-addenda.html">addenda</a>.</p></li> +<li><p><a class="reference external" href="https://geographiclib.sourceforge.io/geodesic-papers/biblio.html">A geodesic bibliography</a>.</p></li> +</ol> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="cs2cs.html" class="btn btn-neutral float-left" title="cs2cs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="gie.html" class="btn btn-neutral float-right" title="gie" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 1983-2022. + <span class="lastupdated">Last updated on 22 Mar 2022. + </span></p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/apps/gie.html b/apps/gie.html new file mode 100644 index 00000000..af88bca5 --- /dev/null +++ b/apps/gie.html @@ -0,0 +1,514 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>gie — PROJ 9.0.0 documentation</title> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="shortcut icon" href="../_static/favicon.png"/> + <link rel="canonical" href="https://proj.orgapps/gie.html"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> + <script src="../_static/js/theme.js"></script> + <link rel="author" title="About these documents" href="../about.html" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="proj" href="proj.html" /> + <link rel="prev" title="geod" href="geod.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" style="background: #353130" > + <a href="../index.html"> + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> + <div class="version"> + 9.0.0 + </div> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li> +<li class="toctree-l1"><a class="reference internal" href="../news.html">News</a></li> +<li class="toctree-l1"><a class="reference internal" href="../download.html">Download</a></li> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../usage/index.html">Using PROJ</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Applications</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="cct.html">cct</a></li> +<li class="toctree-l2"><a class="reference internal" href="cs2cs.html">cs2cs</a></li> +<li class="toctree-l2"><a class="reference internal" href="geod.html">geod</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">gie</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li> +<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li> +<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li> +<li class="toctree-l3"><a class="reference internal" href="#gie-command-language">gie command language</a></li> +<li class="toctree-l3"><a class="reference internal" href="#strict-mode">Strict mode</a></li> +<li class="toctree-l3"><a class="reference internal" href="#background">Background</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="proj.html">proj</a></li> +<li class="toctree-l2"><a class="reference internal" href="projinfo.html">projinfo</a></li> +<li class="toctree-l2"><a class="reference internal" href="projsync.html">projsync</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../operations/index.html">Coordinate operations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../resource_files.html">Resource files</a></li> +<li class="toctree-l1"><a class="reference internal" href="../geodesic.html">Geodesic calculations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../specifications/index.html">Specifications</a></li> +<li class="toctree-l1"><a class="reference internal" href="../community/index.html">Community</a></li> +<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../zreferences.html">References</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #353130" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">PROJ</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home"></a> »</li> + <li><a href="index.html">Applications</a> »</li> + <li>gie</li> + <li class="wy-breadcrumbs-aside"> + <a href="https://github.com/OSGeo/PROJ/edit/8.2/docs/source/apps/gie.rst" class="fa fa-github"> Edit on GitHub</a> + </li> + </ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation"> + <a href="geod.html" class="btn btn-neutral float-left" title="geod" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="proj.html" class="btn btn-neutral float-right" title="proj" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="gie"> +<span id="id1"></span><h1>gie<a class="headerlink" href="#gie" title="Permalink to this headline">¶</a></h1> +<p id="index-0">The Geospatial Integrity Investigation Environment</p> +<section id="synopsis"> +<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><p><strong>gie</strong> [ <strong>-hovql</strong> [ args ] ] file[s]</p> +</div></blockquote> +</section> +<section id="description"> +<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> +<p><strong class="program">gie</strong>, the Geospatial Integrity Investigation Environment, is a +regression testing environment for the PROJ transformation library. Its primary +design goal is to be able to perform regression testing of code that are a part +of PROJ, while not requiring any other kind of tooling than the same C compiler +already employed for compiling the library.</p> +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-h"> +<span id="cmdoption-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-h" title="Permalink to this definition">¶</a></dt> +<dd><p>Print usage information</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-o"> +<span id="cmdoption-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre"><file></span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre"><file></span></span><a class="headerlink" href="#cmdoption-o" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify output file name</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-v"> +<span id="cmdoption-verbose"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-v" title="Permalink to this definition">¶</a></dt> +<dd><p>Verbose: Provide non-essential informational output. Repeat <a class="reference internal" href="#cmdoption-v"><code class="xref std std-option docutils literal notranslate"><span class="pre">-v</span></code></a> for +more verbosity (e.g. <code class="docutils literal notranslate"><span class="pre">-vv</span></code>)</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-q"> +<span id="cmdoption-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-q" title="Permalink to this definition">¶</a></dt> +<dd><p>Quiet: Opposite of verbose. In quiet mode not even errors are +reported. Only interaction is through the return code (0 on success, +non-zero indicates number of FAILED tests)</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-l"> +<span id="cmdoption-list"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-l" title="Permalink to this definition">¶</a></dt> +<dd><p>List the PROJ internal system error codes</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-version"> +<span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-version" title="Permalink to this definition">¶</a></dt> +<dd><p>Print version number</p> +</dd></dl> + +<p>Tests for <strong class="program">gie</strong> are defined in simple text files. Usually having the +extension <code class="docutils literal notranslate"><span class="pre">.gie</span></code>. Test for <strong class="program">gie</strong> are written in the purpose-build command language for gie. +The basic functionality of the gie command language is implemented through just +3 command verbs: <code class="docutils literal notranslate"><span class="pre">operation</span></code>, which defines the PROJ operation to test, +<code class="docutils literal notranslate"><span class="pre">accept</span></code>, which defines the input coordinate to read, and <code class="docutils literal notranslate"><span class="pre">expect</span></code>, which +defines the result to expect.</p> +<p>A sample test file for <strong class="program">gie</strong> that uses the three above basic commands looks +like:</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go"><gie></span> + +<span class="go">--------------------------------------------</span> +<span class="go">Test output of the UTM projection</span> +<span class="go">--------------------------------------------</span> +<span class="go">operation +proj=utm +zone=32 +ellps=GRS80</span> +<span class="go">--------------------------------------------</span> +<span class="go">accept 12 55</span> +<span class="go">expect 691_875.632_14 6_098_907.825_05</span> + +<span class="go"></gie></span> +</pre></div> +</div> +<p>Parsing of a <strong class="program">gie</strong> file starts at <code class="docutils literal notranslate"><span class="pre"><gie></span></code> and ends when <code class="docutils literal notranslate"><span class="pre"></gie></span></code> +is reached. Anything before <code class="docutils literal notranslate"><span class="pre"><gie></span></code> and after <code class="docutils literal notranslate"><span class="pre"></gie></span></code> is not considered. +Test cases are created by defining an <a class="reference internal" href="#cmdoption-arg-operation"><code class="xref std std-option docutils literal notranslate"><span class="pre">operation</span></code></a> which +<a class="reference internal" href="#cmdoption-arg-accept"><code class="xref std std-option docutils literal notranslate"><span class="pre">accept</span></code></a> an input coordinate and <a class="reference internal" href="#cmdoption-arg-expect"><code class="xref std std-option docutils literal notranslate"><span class="pre">expect</span></code></a> an output +coordinate.</p> +<p>Because <strong class="program">gie</strong> tests are wrapped in the <code class="docutils literal notranslate"><span class="pre"><gie></span></code>/<code class="docutils literal notranslate"><span class="pre"></gie></span></code> tags it is +also possible to add test cases to custom made <a class="reference internal" href="../resource_files.html#init-files"><span class="std std-ref">init files</span></a>. +The tests will be ignore by PROJ when reading the init file with <em>+init</em> and +<strong class="program">gie</strong> ignores anything not wrapped in <code class="docutils literal notranslate"><span class="pre"><gie></span></code>/<code class="docutils literal notranslate"><span class="pre"></gie></span></code>.</p> +<p><strong class="program">gie</strong> tests are defined by a set of commands like <a class="reference internal" href="#cmdoption-arg-operation"><code class="xref std std-option docutils literal notranslate"><span class="pre">operation</span></code></a>, +<a class="reference internal" href="#cmdoption-arg-accept"><code class="xref std std-option docutils literal notranslate"><span class="pre">accept</span></code></a> and <a class="reference internal" href="#cmdoption-arg-expect"><code class="xref std std-option docutils literal notranslate"><span class="pre">expect</span></code></a> in the example above. Together the +commands make out the <strong class="program">gie</strong> command language. Any line in a +<strong class="program">gie</strong> file that does not start with a command is ignored. In the +example above it is seen how this can be used to add comments and styling to +<strong class="program">gie</strong> test files in order to make them more readable as well as +documenting what the purpose of the various tests are.</p> +<p>Below the <a class="reference internal" href="#gie-commands"><span class="std std-ref">gie command language</span></a> is explained in details.</p> +</section> +<section id="examples"> +<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2> +<ol class="arabic simple"> +<li><p>Run all tests in a file with all debug information turned on</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">gie -vvvv corner-cases.gie</span> +</pre></div> +</div> +<ol class="arabic simple" start="2"> +<li><p>Run all tests in several files</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">gie foo bar</span> +</pre></div> +</div> +</section> +<section id="gie-command-language"> +<span id="gie-commands"></span><h2>gie command language<a class="headerlink" href="#gie-command-language" title="Permalink to this headline">¶</a></h2> +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-arg-operation"> +<span class="sig-name descname"><span class="pre">operation</span></span><span class="sig-prename descclassname"> <span class="pre"><+args></span></span><a class="headerlink" href="#cmdoption-arg-operation" title="Permalink to this definition">¶</a></dt> +<dd><p>Define a PROJ operation to test. Example:</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">operation proj=utm zone=32 ellps=GRS80</span> +<span class="gp"># </span><span class="nb">test</span> 4D <span class="k">function</span> +<span class="go">accept 12 55 0 0</span> +<span class="go">expect 691875.63214 6098907.82501 0 0</span> + +<span class="gp"># </span><span class="nb">test</span> 2D <span class="k">function</span> +<span class="go">accept 12 56</span> +<span class="go">expect 687071.4391 6210141.3267</span> +</pre></div> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-arg-accept"> +<span class="sig-name descname"><span class="pre">accept</span></span><span class="sig-prename descclassname"> <span class="pre"><x</span> <span class="pre">y</span> <span class="pre">[z</span> <span class="pre">[t]]></span></span><a class="headerlink" href="#cmdoption-arg-accept" title="Permalink to this definition">¶</a></dt> +<dd><p>Define the input coordinate to read. Takes test coordinate. The coordinate +can be defined by either 2, 3 or 4 values, where the first two values are +the x- and y-components, the 3rd is the z-component and the 4th is the time +component. The number of components in the coordinate determines which +version of the operation is tested (2D, 3D or 4D). Many coordinates can be +accepted for one <a class="reference internal" href="#cmdoption-arg-operation"><code class="xref std std-option docutils literal notranslate"><span class="pre">operation</span></code></a>. For each <a class="reference internal" href="#cmdoption-arg-accept"><code class="xref std std-option docutils literal notranslate"><span class="pre">accept</span></code></a> an +accompanying <a class="reference internal" href="#cmdoption-arg-expect"><code class="xref std std-option docutils literal notranslate"><span class="pre">expect</span></code></a> is needed.</p> +<p>Note that <strong class="program">gie</strong> accepts the underscore (<code class="docutils literal notranslate"><span class="pre">_</span></code>) as a thousands +separator. It is not required (in fact, it is entirely ignored by the +input routine), but it significantly improves the readability of the very +long strings of numbers typically required in projected coordinates.</p> +<p>See <a class="reference internal" href="#cmdoption-arg-operation"><code class="xref std std-option docutils literal notranslate"><span class="pre">operation</span></code></a> for an example.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-arg-expect"> +<span class="sig-name descname"><span class="pre">expect</span></span><span class="sig-prename descclassname"> <span class="pre"><x</span> <span class="pre">y</span> <span class="pre">[z</span> <span class="pre">[t]]></span> <span class="pre">|</span> <span class="pre"><error</span> <span class="pre">code></span></span><a class="headerlink" href="#cmdoption-arg-expect" title="Permalink to this definition">¶</a></dt> +<dd><p>Define the expected coordinate that will be returned from accepted +coordinate passed though an operation. The expected coordinate can be +defined by either 2, 3 or 4 components, similarly to <a class="reference internal" href="#cmdoption-arg-accept"><code class="xref std std-option docutils literal notranslate"><span class="pre">accept</span></code></a>. +Many coordinates can be expected for one <a class="reference internal" href="#cmdoption-arg-operation"><code class="xref std std-option docutils literal notranslate"><span class="pre">operation</span></code></a>. For each +<a class="reference internal" href="#cmdoption-arg-expect"><code class="xref std std-option docutils literal notranslate"><span class="pre">expect</span></code></a> an accompanying <a class="reference internal" href="#cmdoption-arg-accept"><code class="xref std std-option docutils literal notranslate"><span class="pre">accept</span></code></a> is needed.</p> +<p>See <a class="reference internal" href="#cmdoption-arg-operation"><code class="xref std std-option docutils literal notranslate"><span class="pre">operation</span></code></a> for an example.</p> +<p>In addition to expecting a coordinate it is also possible to expect a +PROJ error code in case an operation can’t be created. This is useful when +testing that errors are caught and handled correctly. Below is an example of +that tests that the pipeline operator fails correctly when a non-invertible +pipeline is constructed.</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">operation proj=pipeline step</span> +<span class="go"> proj=urm5 n=0.5 inv</span> +<span class="go">expect failure pjd_err_malformed_pipeline</span> +</pre></div> +</div> +<p>See <a class="reference internal" href="#cmdoption-l"><code class="xref std std-option docutils literal notranslate"><span class="pre">gie</span> <span class="pre">--list</span></code></a> for a list of error codes that can be expected.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-arg-tolerance"> +<span class="sig-name descname"><span class="pre">tolerance</span></span><span class="sig-prename descclassname"> <span class="pre"><tolerance></span></span><a class="headerlink" href="#cmdoption-arg-tolerance" title="Permalink to this definition">¶</a></dt> +<dd><p>The <a class="reference internal" href="#cmdoption-arg-tolerance"><code class="xref std std-option docutils literal notranslate"><span class="pre">tolerance</span></code></a> command controls how much accepted coordinates +can deviate from the expected coordinate. This is handy to test that an +operation meets a certain numerical tolerance threshold. Some operations +are expected to be accurate within millimeters where others might only be +accurate within a few meters. <a class="reference internal" href="#cmdoption-arg-tolerance"><code class="xref std std-option docutils literal notranslate"><span class="pre">tolerance</span></code></a> should</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">operation proj=merc</span> +<span class="gp"># </span><span class="nb">test</span> coordinate as returned by <span class="sb">```</span><span class="nb">echo</span> <span class="m">12</span> <span class="m">55</span> <span class="p">|</span> proj +proj<span class="o">=</span>merc<span class="sb">``</span> +<span class="go">tolerance 1 cm</span> +<span class="go">accept 12 55</span> +<span class="go">expect 1335833.89 7326837.72</span> + +<span class="gp"># </span><span class="nb">test</span> that the same coordinate with a <span class="m">50</span> m <span class="nb">false</span> easting as determined +<span class="gp"># </span>by <span class="sb">``</span><span class="nb">echo</span> <span class="m">12</span> <span class="m">55</span> <span class="p">|</span>proj +proj<span class="o">=</span>merc +x_0<span class="o">=</span><span class="m">50</span><span class="sb">``</span> is still within a <span class="m">100</span> m +<span class="gp"># </span>tolerance of the unaltered coordinate from <span class="nv">proj</span><span class="o">=</span>merc +<span class="go">tolerance 100 m</span> +<span class="go">accept 12 55</span> +<span class="go">expect 1335883.89 7326837.72</span> +</pre></div> +</div> +<p>The default tolerance is 0.5 mm. See <a class="reference internal" href="proj.html#cmdoption-proj-lu"><code class="xref std std-option docutils literal notranslate"><span class="pre">proj</span> <span class="pre">-lu</span></code></a> for a list of possible +units.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-arg-roundtrip"> +<span class="sig-name descname"><span class="pre">roundtrip</span></span><span class="sig-prename descclassname"> <span class="pre"><n></span> <span class="pre"><tolerance></span></span><a class="headerlink" href="#cmdoption-arg-roundtrip" title="Permalink to this definition">¶</a></dt> +<dd><p>Do a roundtrip test of an operation. <a class="reference internal" href="#cmdoption-arg-roundtrip"><code class="xref std std-option docutils literal notranslate"><span class="pre">roundtrip</span></code></a> needs a +<a class="reference internal" href="#cmdoption-arg-operation"><code class="xref std std-option docutils literal notranslate"><span class="pre">operation</span></code></a> and a <a class="reference internal" href="#cmdoption-arg-accept"><code class="xref std std-option docutils literal notranslate"><span class="pre">accept</span></code></a> command +to function. The accepted coordinate is passed to the operation first in +it’s forward mode, then the output from the forward operation is passed +back to the inverse operation. This procedure is done <code class="docutils literal notranslate"><span class="pre">n</span></code> times. If the +resulting coordinate is within the set tolerance of the initial coordinate, +the test is passed.</p> +<p>Example with the default 100 iterations and the default tolerance:</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">operation proj=merc</span> +<span class="go">accept 12 55</span> +<span class="go">roundtrip</span> +</pre></div> +</div> +<p>Example with count and default tolerance:</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">operation proj=merc</span> +<span class="go">accept 12 55</span> +<span class="go">roundtrip 10000</span> +</pre></div> +</div> +<p>Example with count and tolerance:</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">operation proj=merc</span> +<span class="go">accept 12 55</span> +<span class="go">roundtrip 10000 5 mm</span> +</pre></div> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-arg-direction"> +<span class="sig-name descname"><span class="pre">direction</span></span><span class="sig-prename descclassname"> <span class="pre"><direction></span></span><a class="headerlink" href="#cmdoption-arg-direction" title="Permalink to this definition">¶</a></dt> +<dd><p>The <a class="reference internal" href="#cmdoption-arg-direction"><code class="xref std std-option docutils literal notranslate"><span class="pre">direction</span></code></a> command specifies in which direction an operation +is performed. This can either be <code class="docutils literal notranslate"><span class="pre">forward</span></code> or <code class="docutils literal notranslate"><span class="pre">inverse</span></code>. An example of +this is seen below where it is tested that a symmetrical transformation +pipeline returns the same results in both directions.</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">operation proj=pipeline zone=32 step</span> +<span class="go"> proj=utm ellps=GRS80 step</span> +<span class="go"> proj=utm ellps=GRS80 inv</span> +<span class="go">tolerance 0.1 mm</span> + +<span class="go">accept 12 55 0 0</span> +<span class="go">expect 12 55 0 0</span> + +<span class="gp"># </span>Now the inverse direction <span class="o">(</span>still same result: the pipeline is symmetrical<span class="o">)</span> + +<span class="go">direction inverse</span> +<span class="go">expect 12 55 0 0</span> +</pre></div> +</div> +<p>The default direction is “forward”.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-arg-ignore"> +<span class="sig-name descname"><span class="pre">ignore</span></span><span class="sig-prename descclassname"> <span class="pre"><error</span> <span class="pre">code></span></span><a class="headerlink" href="#cmdoption-arg-ignore" title="Permalink to this definition">¶</a></dt> +<dd><p>This is especially +useful in test cases that rely on a grid that is not guaranteed to be +available. Below is an example of that situation.</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">operation proj=hgridshift +grids=nzgd2kgrid0005.gsb ellps=GRS80</span> +<span class="go">tolerance 1 mm</span> +<span class="go">ignore pjd_err_failed_to_load_grid</span> +<span class="go">accept 172.999892181021551 -45.001620431954613</span> +<span class="go">expect 173 -45</span> +</pre></div> +</div> +<p>See <a class="reference internal" href="#cmdoption-l"><code class="xref std std-option docutils literal notranslate"><span class="pre">gie</span> <span class="pre">--list</span></code></a> for a list of error codes that can be ignored.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-arg-require_grid"> +<span id="cmdoption-arg-require-grid"></span><span class="sig-name descname"><span class="pre">require_grid</span></span><span class="sig-prename descclassname"> <span class="pre"><grid_name></span></span><a class="headerlink" href="#cmdoption-arg-require_grid" title="Permalink to this definition">¶</a></dt> +<dd><p>Checks the availability of the grid <grid_name>. If it is not found, then +all <a class="reference internal" href="#cmdoption-arg-accept"><code class="xref std std-option docutils literal notranslate"><span class="pre">accept</span></code></a>/<a class="reference internal" href="#cmdoption-arg-expect"><code class="xref std std-option docutils literal notranslate"><span class="pre">expect</span></code></a> pairs until the next +<a class="reference internal" href="#cmdoption-arg-operation"><code class="xref std std-option docutils literal notranslate"><span class="pre">operation</span></code></a> will be skipped. +<a class="reference internal" href="#cmdoption-arg-require_grid"><code class="xref std std-option docutils literal notranslate"><span class="pre">require_grid</span></code></a> can be repeated several times to specify several grids whose +presence is required.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-arg-echo"> +<span class="sig-name descname"><span class="pre">echo</span></span><span class="sig-prename descclassname"> <span class="pre"><text></span></span><a class="headerlink" href="#cmdoption-arg-echo" title="Permalink to this definition">¶</a></dt> +<dd><p>Add user defined text to the output stream. See the example below.</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go"><gie></span> +<span class="go">echo ** Mercator projection tests **</span> +<span class="go">operation +proj=merc</span> +<span class="go">accept 0 0</span> +<span class="go">expect 0 0</span> +<span class="go"></gie></span> +</pre></div> +</div> +<p>which returns</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">-------------------------------------------------------------------------------</span> +<span class="go">Reading file 'test.gie'</span> +<span class="go">** Mercator projection test **</span> +<span class="go">-------------------------------------------------------------------------------</span> +<span class="go">total: 1 tests succeeded, 0 tests skipped, 0 tests failed.</span> +<span class="go">-------------------------------------------------------------------------------</span> +</pre></div> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-arg-skip"> +<span class="sig-name descname"><span class="pre">skip</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-arg-skip" title="Permalink to this definition">¶</a></dt> +<dd><p>Skip any test after the first occurrence of <a class="reference internal" href="#cmdoption-arg-skip"><code class="xref std std-option docutils literal notranslate"><span class="pre">skip</span></code></a>. In the example below only +the first test will be performed. The second test is skipped. This feature is mostly +relevant for debugging when writing new test cases.</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go"><gie></span> +<span class="go">operation proj=merc</span> +<span class="go">accept 0 0</span> +<span class="go">expect 0 0</span> +<span class="go">skip</span> +<span class="go">accept 0 1</span> +<span class="go">expect 0 110579.9</span> +<span class="go"></gie></span> +</pre></div> +</div> +</dd></dl> + +</section> +<section id="strict-mode"> +<h2>Strict mode<a class="headerlink" href="#strict-mode" title="Permalink to this headline">¶</a></h2> +<div class="versionadded"> +<p><span class="versionmodified added">New in version 7.1.</span></p> +</div> +<p>A stricter variant of normal gie syntax can be used by wrapping gie commands +between <code class="docutils literal notranslate"><span class="pre"><gie-strict></span></code> and <code class="docutils literal notranslate"><span class="pre"></gie-strict></span></code>. In strict mode, comment lines +must start with a sharp character. Unknown commands will be considered as an error. +A command can still be split on several lines, but intermediate lines must +end with the space character followed by backslash to mark the continuation.</p> +<blockquote> +<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go"><gie-strict></span> +<span class="gp"># </span>This is a comment. The following line with multiple repeated characters too +<span class="go">-------------------------------------------------</span> +<span class="gp"># </span>A <span class="nb">command</span> on several lines must use <span class="s2">" \" continuation</span> +<span class="go">operation proj=hgridshift +grids=nzgd2kgrid0005.gsb \</span> +<span class="go"> ellps=GRS80</span> +<span class="go">tolerance 1 mm</span> +<span class="go">ignore pjd_err_failed_to_load_grid</span> +<span class="go">accept 172.999892181021551 -45.001620431954613</span> +<span class="go">expect 173 -45</span> +<span class="go"></gie-strict></span> +</pre></div> +</div> +</div></blockquote> +</section> +<section id="background"> +<h2>Background<a class="headerlink" href="#background" title="Permalink to this headline">¶</a></h2> +<p>More importantly than being an acronym for “Geospatial Integrity Investigation +Environment”, gie were also the initials, user id, and USGS email address of +Gerald Ian Evenden (1935–2016), the geospatial visionary, who, already in the +1980s, started what was to become the PROJ of today.</p> +<p>Gerald’s clear vision was that map projections are <em>just special functions</em>. +Some of them rather complex, most of them of two variables, but all of them +<em>just special functions</em>, and not particularly more special than the <code class="xref c c-func docutils literal notranslate"><span class="pre">sin()</span></code>, +<code class="xref c c-func docutils literal notranslate"><span class="pre">cos()</span></code>, <code class="xref c c-func docutils literal notranslate"><span class="pre">tan()</span></code>, and <code class="xref c c-func docutils literal notranslate"><span class="pre">hypot()</span></code> already available in the C standard library.</p> +<p>And hence, according to Gerald, <em>they should not be particularly much harder +to use</em>, for a programmer, than the <code class="xref c c-func docutils literal notranslate"><span class="pre">sin()</span></code>’s, <code class="xref c c-func docutils literal notranslate"><span class="pre">tan()</span></code>’s and +<code class="xref c c-func docutils literal notranslate"><span class="pre">hypot()</span></code>’s so readily available.</p> +<p>Gerald’s ingenuity also showed in the implementation of the vision, where +he devised a comprehensive, yet simple, system of key-value pairs for +parameterising a map projection, and the highly flexible <a class="reference internal" href="../development/reference/datatypes.html#c.PJ" title="PJ"><code class="xref c c-type docutils literal notranslate"><span class="pre">PJ</span></code></a> struct, storing +run-time compiled versions of those key-value pairs, hence making a map +projection function call, <code class="docutils literal notranslate"><span class="pre">pj_fwd(PJ,</span> <span class="pre">point)</span></code>, as easy as a traditional function +call like <code class="docutils literal notranslate"><span class="pre">hypot(x,y)</span></code>.</p> +<p>While today, we may have more formally well defined metadata systems (most +prominent the OGC WKT2 representation), nothing comes close being as easily +readable (“human compatible”) as Gerald’s key-value system. This system in +particular, and the PROJ system in general, was Gerald’s great gift to anyone +using and/or communicating about geodata.</p> +<p>It is only reasonable to name a program, keeping an eye on the +integrity of the PROJ system, in honour of Gerald.</p> +<p>So in honour, and hopefully also in the spirit, of Gerald Ian Evenden +(1935–2016), this is the Geospatial Integrity Investigation Environment.</p> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="geod.html" class="btn btn-neutral float-left" title="geod" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="proj.html" class="btn btn-neutral float-right" title="proj" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 1983-2022. + <span class="lastupdated">Last updated on 22 Mar 2022. + </span></p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/apps/index.html b/apps/index.html new file mode 100644 index 00000000..dcbc4cb5 --- /dev/null +++ b/apps/index.html @@ -0,0 +1,160 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Applications — PROJ 9.0.0 documentation</title> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="shortcut icon" href="../_static/favicon.png"/> + <link rel="canonical" href="https://proj.orgapps/index.html"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> + <script src="../_static/js/theme.js"></script> + <link rel="author" title="About these documents" href="../about.html" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="cct" href="cct.html" /> + <link rel="prev" title="Network capabilities" href="../usage/network.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" style="background: #353130" > + <a href="../index.html"> + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> + <div class="version"> + 9.0.0 + </div> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li> +<li class="toctree-l1"><a class="reference internal" href="../news.html">News</a></li> +<li class="toctree-l1"><a class="reference internal" href="../download.html">Download</a></li> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../usage/index.html">Using PROJ</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Applications</a><ul> +<li class="toctree-l2"><a class="reference internal" href="cct.html">cct</a></li> +<li class="toctree-l2"><a class="reference internal" href="cs2cs.html">cs2cs</a></li> +<li class="toctree-l2"><a class="reference internal" href="geod.html">geod</a></li> +<li class="toctree-l2"><a class="reference internal" href="gie.html">gie</a></li> +<li class="toctree-l2"><a class="reference internal" href="proj.html">proj</a></li> +<li class="toctree-l2"><a class="reference internal" href="projinfo.html">projinfo</a></li> +<li class="toctree-l2"><a class="reference internal" href="projsync.html">projsync</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../operations/index.html">Coordinate operations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../resource_files.html">Resource files</a></li> +<li class="toctree-l1"><a class="reference internal" href="../geodesic.html">Geodesic calculations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../specifications/index.html">Specifications</a></li> +<li class="toctree-l1"><a class="reference internal" href="../community/index.html">Community</a></li> +<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../zreferences.html">References</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #353130" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">PROJ</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home"></a> »</li> + <li>Applications</li> + <li class="wy-breadcrumbs-aside"> + <a href="https://github.com/OSGeo/PROJ/edit/8.2/docs/source/apps/index.rst" class="fa fa-github"> Edit on GitHub</a> + </li> + </ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation"> + <a href="../usage/network.html" class="btn btn-neutral float-left" title="Network capabilities" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="cct.html" class="btn btn-neutral float-right" title="cct" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="applications"> +<span id="apps"></span><h1>Applications<a class="headerlink" href="#applications" title="Permalink to this headline">¶</a></h1> +<p>Bundled with PROJ comes a set of small command line utilities. The <strong class="program">proj</strong> +program is limited to converting between geographic and projection coordinates +within one datum. The <strong class="program">cs2cs</strong> program operates similarly, but allows +translation between any pair of definable coordinate systems, including support +for datum transformation. The <strong class="program">geod</strong> program provides the ability to do +geodesic (great circle) computations. <strong class="program">gie</strong> is the program used for +regression tests in PROJ. <strong class="program">cct</strong>, a 4D equivalent to the <strong class="program">proj</strong> +program, performs transformation coordinate systems on a set of input points. +<strong class="program">projinfo</strong> performs queries for geodetic objects and coordinate +operations. <strong class="program">projsync</strong> is a tool for synchronizing PROJ datum and +transformation support data.</p> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="cct.html">cct</a></li> +<li class="toctree-l1"><a class="reference internal" href="cs2cs.html">cs2cs</a></li> +<li class="toctree-l1"><a class="reference internal" href="geod.html">geod</a></li> +<li class="toctree-l1"><a class="reference internal" href="gie.html">gie</a></li> +<li class="toctree-l1"><a class="reference internal" href="proj.html">proj</a></li> +<li class="toctree-l1"><a class="reference internal" href="projinfo.html">projinfo</a></li> +<li class="toctree-l1"><a class="reference internal" href="projsync.html">projsync</a></li> +</ul> +</div> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="../usage/network.html" class="btn btn-neutral float-left" title="Network capabilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="cct.html" class="btn btn-neutral float-right" title="cct" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 1983-2022. + <span class="lastupdated">Last updated on 22 Mar 2022. + </span></p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/apps/proj.html b/apps/proj.html new file mode 100644 index 00000000..98bd06a9 --- /dev/null +++ b/apps/proj.html @@ -0,0 +1,365 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>proj — PROJ 9.0.0 documentation</title> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="shortcut icon" href="../_static/favicon.png"/> + <link rel="canonical" href="https://proj.orgapps/proj.html"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> + <script src="../_static/js/theme.js"></script> + <link rel="author" title="About these documents" href="../about.html" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="projinfo" href="projinfo.html" /> + <link rel="prev" title="gie" href="gie.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" style="background: #353130" > + <a href="../index.html"> + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> + <div class="version"> + 9.0.0 + </div> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li> +<li class="toctree-l1"><a class="reference internal" href="../news.html">News</a></li> +<li class="toctree-l1"><a class="reference internal" href="../download.html">Download</a></li> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../usage/index.html">Using PROJ</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Applications</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="cct.html">cct</a></li> +<li class="toctree-l2"><a class="reference internal" href="cs2cs.html">cs2cs</a></li> +<li class="toctree-l2"><a class="reference internal" href="geod.html">geod</a></li> +<li class="toctree-l2"><a class="reference internal" href="gie.html">gie</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">proj</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li> +<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li> +<li class="toctree-l3"><a class="reference internal" href="#example">Example</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="projinfo.html">projinfo</a></li> +<li class="toctree-l2"><a class="reference internal" href="projsync.html">projsync</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../operations/index.html">Coordinate operations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../resource_files.html">Resource files</a></li> +<li class="toctree-l1"><a class="reference internal" href="../geodesic.html">Geodesic calculations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../specifications/index.html">Specifications</a></li> +<li class="toctree-l1"><a class="reference internal" href="../community/index.html">Community</a></li> +<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../zreferences.html">References</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #353130" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">PROJ</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home"></a> »</li> + <li><a href="index.html">Applications</a> »</li> + <li>proj</li> + <li class="wy-breadcrumbs-aside"> + <a href="https://github.com/OSGeo/PROJ/edit/8.2/docs/source/apps/proj.rst" class="fa fa-github"> Edit on GitHub</a> + </li> + </ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation"> + <a href="gie.html" class="btn btn-neutral float-left" title="gie" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="projinfo.html" class="btn btn-neutral float-right" title="projinfo" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="proj"> +<span id="id1"></span><h1>proj<a class="headerlink" href="#proj" title="Permalink to this headline">¶</a></h1> +<p>Cartographic projection filter.</p> +<section id="synopsis"> +<span id="index-0"></span><h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><p><strong>proj</strong> [<strong>-beEfiIlmorsStTvVwW</strong>] [args]] [<em>+opt[=arg]</em> …] file …</p> +<p><strong>invproj</strong> [<strong>-beEfiIlmorsStTvVwW</strong>] [args]] [<em>+opt[=arg]</em> …] file …</p> +</div></blockquote> +</section> +<section id="description"> +<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> +<p><strong class="program">proj</strong> and <strong class="program">invproj</strong> perform respective forward and inverse +conversion of cartographic data to or from cartesian data with a wide +range of selectable projection functions.</p> +<p><strong class="program">invproj</strong> may not be available on all platforms; in this case +use <a class="reference internal" href="#cmdoption-proj-I"><code class="xref std std-option docutils literal notranslate"><span class="pre">proj</span> <span class="pre">-I</span></code></a> instead.</p> +<p>The following control parameters can appear in any order</p> +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-b"> +<span class="sig-name descname"><span class="pre">-b</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-b" title="Permalink to this definition">¶</a></dt> +<dd><p>Special option for binary coordinate data input and output through standard +input and standard output. Data is assumed to be in system type double +floating point words. This option is to be used when <strong class="program">proj</strong> is a child process +and allows bypassing formatting operations.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-d"> +<span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"> <span class="pre"><n></span></span><a class="headerlink" href="#cmdoption-proj-d" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<div class="versionadded"> +<p><span class="versionmodified added">New in version 5.2.0: </span>Specify the number of decimals in the output.</p> +</div> +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-i"> +<span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-i" title="Permalink to this definition">¶</a></dt> +<dd><p>Selects binary input only (see <a class="reference internal" href="#cmdoption-proj-b"><code class="xref std std-option docutils literal notranslate"><span class="pre">-b</span></code></a>).</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-I"> +<span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-I" title="Permalink to this definition">¶</a></dt> +<dd><p>Alternate method to specify inverse projection. Redundant when used with +<strong class="program">invproj</strong>.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-o"> +<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-o" title="Permalink to this definition">¶</a></dt> +<dd><p>Selects binary output only (see <a class="reference internal" href="#cmdoption-proj-b"><code class="xref std std-option docutils literal notranslate"><span class="pre">-b</span></code></a>).</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-t-a"> +<span class="sig-name descname"><span class="pre">-t<a></span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-t-a" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>a</em> specifies a character employed as the first character to denote a +control line to be passed through without processing. This option +applicable to ASCII input only. (# is the default value).</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-e"> +<span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"> <span class="pre"><string></span></span><a class="headerlink" href="#cmdoption-proj-e" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>string</em> is an arbitrary string to be output if an error is detected during +data transformations. The default value is a three character string: <code class="docutils literal notranslate"><span class="pre">*\t*</span></code>. +Note that if the <a class="reference internal" href="#cmdoption-proj-b"><code class="xref std std-option docutils literal notranslate"><span class="pre">-b</span></code></a>, <a class="reference internal" href="#cmdoption-proj-i"><code class="xref std std-option docutils literal notranslate"><span class="pre">-i</span></code></a> or <a class="reference internal" href="#cmdoption-proj-o"><code class="xref std std-option docutils literal notranslate"><span class="pre">-o</span></code></a> options are employed, an error +is returned as HUGE_VAL value for both return values.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-E"> +<span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-E" title="Permalink to this definition">¶</a></dt> +<dd><p>Causes the input coordinates to be copied to the output line prior to +printing the converted values.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-l"> +<span class="sig-name descname"><span class="pre">-l<[</span></span><span class="sig-prename descclassname"><span class="pre">=id]></span></span><a class="headerlink" href="#cmdoption-proj-l" title="Permalink to this definition">¶</a></dt> +<dd><p>List projection identifiers that can be selected with <em>+proj</em>. <code class="docutils literal notranslate"><span class="pre">proj</span> <span class="pre">-l=id</span></code> +gives expanded description of projection <em>id</em>, e.g. <code class="docutils literal notranslate"><span class="pre">proj</span> <span class="pre">-l=merc</span></code>.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-lp"> +<span class="sig-name descname"><span class="pre">-lp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-lp" title="Permalink to this definition">¶</a></dt> +<dd><p>List of all projection id that can be used with the <em>+proj</em> parameter. +Equivalent to <code class="docutils literal notranslate"><span class="pre">proj</span> <span class="pre">-l</span></code>.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-lP"> +<span class="sig-name descname"><span class="pre">-lP</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-lP" title="Permalink to this definition">¶</a></dt> +<dd><p>Expanded description of all projections that can be used with the <em>+proj</em> +parameter.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-le"> +<span class="sig-name descname"><span class="pre">-le</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-le" title="Permalink to this definition">¶</a></dt> +<dd><p>List of all ellipsoids that can be selected with the <em>+ellps</em> parameters.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-lu"> +<span class="sig-name descname"><span class="pre">-lu</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-lu" title="Permalink to this definition">¶</a></dt> +<dd><p>List of all distance units that can be selected with the <em>+units</em> parameter.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-r"> +<span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-r" title="Permalink to this definition">¶</a></dt> +<dd><p>This options reverses the order of the expected input from +longitude-latitude or x-y to latitude-longitude or y-x.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-s"> +<span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-s" title="Permalink to this definition">¶</a></dt> +<dd><p>This options reverses the order of the output from x-y or longitude-latitude +to y-x or latitude-longitude.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-S"> +<span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-S" title="Permalink to this definition">¶</a></dt> +<dd><p>Causes estimation of meridional and parallel scale factors, area scale +factor and angular distortion, and maximum and minimum scale factors to be +listed between <> for each input point. For conformal projections meridional +and parallel scales factors will be equal and angular distortion zero. Equal +area projections will have an area factor of 1.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-m"> +<span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"> <span class="pre"><mult></span></span><a class="headerlink" href="#cmdoption-proj-m" title="Permalink to this definition">¶</a></dt> +<dd><p>The cartesian data may be scaled by the <em>mult</em> parameter. When processing data +in a forward projection mode the cartesian output values are multiplied by +<em>mult</em> otherwise the input cartesian values are divided by <em>mult</em> before inverse +projection. If the first two characters of <em>mult</em> are 1/ or 1: then the +reciprocal value of <em>mult</em> is employed.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-f"> +<span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"> <span class="pre"><format></span></span><a class="headerlink" href="#cmdoption-proj-f" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>format</em> is a printf format string to control the form of the output values. +For inverse projections, the output will be in degrees when this option is +employed. The default format is <code class="docutils literal notranslate"><span class="pre">"%.2f"</span></code> for forward projection and DMS for +inverse.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-w-n"> +<span class="sig-name descname"><span class="pre">-w<n></span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-w-n" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>n</em> is the number of significant fractional digits to employ for seconds +output (when the option is not specified, <code class="docutils literal notranslate"><span class="pre">-w3</span></code> is assumed).</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-W-n"> +<span class="sig-name descname"><span class="pre">-W<n></span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-W-n" title="Permalink to this definition">¶</a></dt> +<dd><p>Where <em>n</em> is the number of significant fractional digits to employ for seconds +output. When <code class="docutils literal notranslate"><span class="pre">-W</span></code> is employed the fields will be constant width +with leading zeroes.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-v"> +<span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-v" title="Permalink to this definition">¶</a></dt> +<dd><p>Causes a listing of cartographic control parameters tested for and used by +the program to be printed prior to input data.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-proj-V"> +<span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-proj-V" title="Permalink to this definition">¶</a></dt> +<dd><p>This option causes an expanded annotated listing of the characteristics of +the projected point. <a class="reference internal" href="#cmdoption-proj-v"><code class="xref std std-option docutils literal notranslate"><span class="pre">-v</span></code></a> is implied with this option.</p> +</dd></dl> + +<p>The <em>+opt</em> run-line arguments are associated with cartographic parameters. +Additional projection control parameters may be contained in two auxiliary +control files: the first is optionally referenced with the +<em>+init=file:id</em> and the second is always processed after the name of the +projection has been established from either the run-line or the contents of ++init file. The environment parameter <span class="target" id="index-1"></span><a class="reference internal" href="../usage/environmentvars.html#envvar-PROJ_LIB"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PROJ_LIB</span></code></a> establishes the +default directory for a file reference without an absolute path. This is +also used for supporting files like datum shift files.</p> +<p>Usage of <em>+opt</em> varies with projection and for a complete description +consult the <a class="reference internal" href="../operations/projections/index.html#projections"><span class="std std-ref">projection pages</span></a>.</p> +<p>One or more files (processed in left to right order) specify the source of +data to be converted. A <code class="docutils literal notranslate"><span class="pre">-</span></code> will specify the location of processing standard +input. If no files are specified, the input is assumed to be from stdin. +For ASCII input data the two data values must be in the first two white space +separated fields and when both input and output are ASCII all trailing +portions of the input line are appended to the output line.</p> +<p>Input geographic data (longitude and latitude) must be in DMS or decimal degrees format and input +cartesian data must be in units consistent with the ellipsoid major axis or +sphere radius units. Output geographic coordinates will be in DMS (if the +<code class="docutils literal notranslate"><span class="pre">-w</span></code> switch is not employed) and precise to 0.001” with trailing, zero-valued +minute-second fields deleted.</p> +</section> +<section id="example"> +<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2> +<p>The following script</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">proj +proj=utm +lon_0=112w +ellps=clrk66 -r <<EOF</span> +<span class="go">45d15'33.1" 111.5W</span> +<span class="go">45d15.551666667N -111d30</span> +<span class="go">+45.25919444444 111d30'000w</span> +<span class="go">EOF</span> +</pre></div> +</div> +<p>will perform UTM forward projection with a standard UTM central meridian +nearest longitude 112W. The geographic values of this example are equivalent +and meant as examples of various forms of DMS input. The x-y output +data will appear as three lines of:</p> +<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>460769.27 5011648.45 +</pre></div> +</div> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="gie.html" class="btn btn-neutral float-left" title="gie" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="projinfo.html" class="btn btn-neutral float-right" title="projinfo" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 1983-2022. + <span class="lastupdated">Last updated on 22 Mar 2022. + </span></p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/apps/projinfo.html b/apps/projinfo.html new file mode 100644 index 00000000..7deccc2b --- /dev/null +++ b/apps/projinfo.html @@ -0,0 +1,799 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>projinfo — PROJ 9.0.0 documentation</title> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="shortcut icon" href="../_static/favicon.png"/> + <link rel="canonical" href="https://proj.orgapps/projinfo.html"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> + <script src="../_static/js/theme.js"></script> + <link rel="author" title="About these documents" href="../about.html" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="projsync" href="projsync.html" /> + <link rel="prev" title="proj" href="proj.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" style="background: #353130" > + <a href="../index.html"> + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> + <div class="version"> + 9.0.0 + </div> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li> +<li class="toctree-l1"><a class="reference internal" href="../news.html">News</a></li> +<li class="toctree-l1"><a class="reference internal" href="../download.html">Download</a></li> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../usage/index.html">Using PROJ</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Applications</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="cct.html">cct</a></li> +<li class="toctree-l2"><a class="reference internal" href="cs2cs.html">cs2cs</a></li> +<li class="toctree-l2"><a class="reference internal" href="geod.html">geod</a></li> +<li class="toctree-l2"><a class="reference internal" href="gie.html">gie</a></li> +<li class="toctree-l2"><a class="reference internal" href="proj.html">proj</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">projinfo</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li> +<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li> +<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="projsync.html">projsync</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../operations/index.html">Coordinate operations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../resource_files.html">Resource files</a></li> +<li class="toctree-l1"><a class="reference internal" href="../geodesic.html">Geodesic calculations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../specifications/index.html">Specifications</a></li> +<li class="toctree-l1"><a class="reference internal" href="../community/index.html">Community</a></li> +<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../zreferences.html">References</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #353130" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">PROJ</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home"></a> »</li> + <li><a href="index.html">Applications</a> »</li> + <li>projinfo</li> + <li class="wy-breadcrumbs-aside"> + <a href="https://github.com/OSGeo/PROJ/edit/8.2/docs/source/apps/projinfo.rst" class="fa fa-github"> Edit on GitHub</a> + </li> + </ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation"> + <a href="proj.html" class="btn btn-neutral float-left" title="proj" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="projsync.html" class="btn btn-neutral float-right" title="projsync" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="projinfo"> +<span id="id1"></span><h1>projinfo<a class="headerlink" href="#projinfo" title="Permalink to this headline">¶</a></h1> +<div class="versionadded" id="index-0"> +<p><span class="versionmodified added">New in version 6.0.0.</span></p> +</div> +<p>Geodetic object and coordinate operation queries</p> +<section id="synopsis"> +<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><div class="line-block"> +<div class="line"><strong>projinfo</strong></div> +<div class="line-block"> +<div class="line">[-o formats] [-k crs|operation|datum|ensemble|ellipsoid] [–summary] [-q]</div> +<div class="line">[[–area name_or_code] | [–bbox west_long,south_lat,east_long,north_lat]]</div> +<div class="line">[–spatial-test contains|intersects]</div> +<div class="line">[–crs-extent-use none|both|intersection|smallest]</div> +<div class="line">[–grid-check none|discard_missing|sort|known_available]</div> +<div class="line">[–pivot-crs always|if_no_direct_transformation|never|{auth:code[,auth:code]*}]</div> +<div class="line">[–show-superseded] [–hide-ballpark] [–accuracy {accuracy}]</div> +<div class="line">[–allow-ellipsoidal-height-as-vertical-crs]</div> +<div class="line">[–boundcrs-to-wgs84]</div> +<div class="line">[–authority name]</div> +<div class="line">[–main-db-path path] [–aux-db-path path]*</div> +<div class="line">[–dump-db-structure]</div> +<div class="line">[–identify] [–3d]</div> +<div class="line">[–output-id AUTH:CODE]</div> +<div class="line">[–c-ify] [–single-line]</div> +<div class="line">–searchpaths | –remote-data |</div> +<div class="line">–list-crs [list-crs-filter] |</div> +<div class="line">–dump-db-structure [{object_definition} | {object_reference}] |</div> +<div class="line">{object_definition} | {object_reference} | (-s {srs_def} -t {srs_def})</div> +<div class="line"><br /></div> +</div> +</div> +<p>where {object_definition} or {srs_def} is one of the possibilities accepted +by <a class="reference internal" href="../development/reference/functions.html#c.proj_create" title="proj_create"><code class="xref c c-func docutils literal notranslate"><span class="pre">proj_create()</span></code></a></p> +<ul class="simple"> +<li><p>a proj-string,</p></li> +<li><p>a WKT string,</p></li> +<li><p>an object code (like “EPSG:4326”, “urn:ogc:def:crs:EPSG::4326”, +“urn:ogc:def:coordinateOperation:EPSG::1671”),</p></li> +<li><p>an Object name. e.g “WGS 84”, “WGS 84 / UTM zone 31N”. In that case as +uniqueness is not guaranteed, heuristics are applied to determine the appropriate best match.</p></li> +<li><p>a OGC URN combining references for compound coordinate reference systems +(e.g “<a class="reference external" href="urn:ogc:def:crs,crs:EPSG::2393,crs:EPSG::5717">urn:ogc:def:crs,crs:EPSG::2393,crs:EPSG::5717</a>” or custom abbreviated +syntax “EPSG:2393+5717”),</p></li> +<li><p>a OGC URN combining references for references for projected or derived CRSs +e.g. for Projected 3D CRS “UTM zone 31N / WGS 84 (3D)”: +“<a class="reference external" href="urn:ogc:def:crs,crs:EPSG::4979,cs:PROJ::ENh,coordinateOperation:EPSG::16031">urn:ogc:def:crs,crs:EPSG::4979,cs:PROJ::ENh,coordinateOperation:EPSG::16031</a>” +(<em>added in 6.2</em>)</p></li> +<li><p>a OGC URN combining references for concatenated operations +(e.g. “<a class="reference external" href="urn:ogc:def:coordinateOperation,coordinateOperation:EPSG::3895,coordinateOperation:EPSG::1618">urn:ogc:def:coordinateOperation,coordinateOperation:EPSG::3895,coordinateOperation:EPSG::1618</a>”)</p></li> +<li><p>a PROJJSON string. The jsonschema is at <a class="reference external" href="https://proj.org/schemas/v0.4/projjson.schema.json">https://proj.org/schemas/v0.4/projjson.schema.json</a> (<em>added in 6.2</em>)</p></li> +<li><p>a compound CRS made from two object names separated with ” + “. e.g. “WGS 84 + EGM96 height” (<em>added in 7.1</em>)</p></li> +</ul> +<p>{object_reference} is a filename preceded by the ‘@’ character. The +file referenced by the {object_reference} must contain a valid +{object_definition}.</p> +</div></blockquote> +</section> +<section id="description"> +<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> +<p><strong class="program">projinfo</strong> is a program that can query information on a geodetic object, +coordinate reference system (CRS) or coordinate operation, when the <code class="docutils literal notranslate"><span class="pre">-s</span></code> and <code class="docutils literal notranslate"><span class="pre">-t</span></code> +options are specified, and display it under different formats (PROJ string, WKT string +or PROJJSON string).</p> +<p>It can also be used to query coordinate operations available between two CRS.</p> +<p>The program is named with some reference to the GDAL <strong class="program">gdalsrsinfo</strong> that offers +partly similar services.</p> +<p>The following control parameters can appear in any order:</p> +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-o"> +<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">formats</span></span><a class="headerlink" href="#cmdoption-projinfo-o" title="Permalink to this definition">¶</a></dt> +<dd><p>formats is a comma separated combination of: +<code class="docutils literal notranslate"><span class="pre">all</span></code>, <code class="docutils literal notranslate"><span class="pre">default</span></code>, <code class="docutils literal notranslate"><span class="pre">PROJ</span></code>, <code class="docutils literal notranslate"><span class="pre">WKT_ALL</span></code>, <code class="docutils literal notranslate"><span class="pre">WKT2:2015</span></code>, <code class="docutils literal notranslate"><span class="pre">WKT2:2019</span></code>, <code class="docutils literal notranslate"><span class="pre">WKT1:GDAL</span></code>, <code class="docutils literal notranslate"><span class="pre">WKT1:ESRI</span></code>, <code class="docutils literal notranslate"><span class="pre">PROJJSON</span></code>, <code class="docutils literal notranslate"><span class="pre">SQL</span></code>.</p> +<p>Except <code class="docutils literal notranslate"><span class="pre">all</span></code> and <code class="docutils literal notranslate"><span class="pre">default</span></code>, other formats can be preceded by <code class="docutils literal notranslate"><span class="pre">-</span></code> to disable them.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>WKT2_2019 was previously called WKT2_2018.</p> +</div> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>Before PROJ 6.3.0, WKT1:GDAL was implicitly calling –boundcrs-to-wgs84. +This is no longer the case.</p> +</div> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>When SQL is specified, <a class="reference internal" href="#cmdoption-projinfo-output-id"><code class="xref std std-option docutils literal notranslate"><span class="pre">--output-id</span></code></a> must be specified.</p> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-k"> +<span class="sig-name descname"><span class="pre">-k</span></span><span class="sig-prename descclassname"> <span class="pre">crs|operation|datum|ensemble|ellipsoid</span></span><a class="headerlink" href="#cmdoption-projinfo-k" title="Permalink to this definition">¶</a></dt> +<dd><p>When used to query a single object with a AUTHORITY:CODE, determines the (k)ind of the object +in case there are CRS, coordinate operations or ellipsoids with the same CODE. +The default is crs.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-summary"> +<span class="sig-name descname"><span class="pre">--summary</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-summary" title="Permalink to this definition">¶</a></dt> +<dd><p>When listing coordinate operations available between 2 CRS, return the +result in a summary format, mentioning only the name of the coordinate +operation, its accuracy and its area of use.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>only used for coordinate operation computation</p> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-q"> +<span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-q" title="Permalink to this definition">¶</a></dt> +<dd><p>Turn on quiet mode. Quiet mode is only available for queries on single objects, +and only one output format is selected. In that mode, only the PROJ, WKT or PROJJSON +string is displayed, without other introduction output. The output is then +potentially compatible of being piped in other utilities.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-area"> +<span class="sig-name descname"><span class="pre">--area</span></span><span class="sig-prename descclassname"> <span class="pre">name_or_code</span></span><a class="headerlink" href="#cmdoption-projinfo-area" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify an area of interest to restrict the results when researching +coordinate operations between 2 CRS. The area of interest can be specified either +as a name (e.g “Denmark - onshore”) or a AUTHORITY:CODE (EPSG:3237) +This option is exclusive of <a class="reference internal" href="#cmdoption-projinfo-bbox"><code class="xref std std-option docutils literal notranslate"><span class="pre">--bbox</span></code></a>.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>only used for coordinate operation computation</p> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-bbox"> +<span class="sig-name descname"><span class="pre">--bbox</span></span><span class="sig-prename descclassname"> <span class="pre">west_long,south_lat,east_long,north_lat</span></span><a class="headerlink" href="#cmdoption-projinfo-bbox" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify an area of interest to restrict the results when researching +coordinate operations between 2 CRS. The area of interest is specified as a +bounding box with geographic coordinates, expressed in degrees in a +unspecified geographic CRS. +<cite>west_long</cite> and <cite>east_long</cite> should be in the [-180,180] range, and +<cite>south_lat</cite> and <cite>north_lat</cite> in the [-90,90]. <cite>west_long</cite> is generally lower than +<cite>east_long</cite>, except in the case where the area of interest crosses the antimeridian.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>only used for coordinate operation computation</p> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-spatial-test"> +<span class="sig-name descname"><span class="pre">--spatial-test</span></span><span class="sig-prename descclassname"> <span class="pre">contains|intersects</span></span><a class="headerlink" href="#cmdoption-projinfo-spatial-test" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify how the area of use of coordinate operations found in the database +are compared to the area of use specified explicitly with <a class="reference internal" href="#cmdoption-projinfo-area"><code class="xref std std-option docutils literal notranslate"><span class="pre">--area</span></code></a> or <a class="reference internal" href="#cmdoption-projinfo-bbox"><code class="xref std std-option docutils literal notranslate"><span class="pre">--bbox</span></code></a>, +or derived implicitly from the area of use of the source and target CRS. +By default, <strong class="program">projinfo</strong> will only keep coordinate operations whose are of use +is strictly within the area of interest (<code class="docutils literal notranslate"><span class="pre">contains</span></code> strategy). +If using the <code class="docutils literal notranslate"><span class="pre">intersects</span></code> strategy, the spatial test is relaxed, and any +coordinate operation whose area of use at least partly intersects the +area of interest is listed.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>only used for coordinate operation computation</p> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-crs-extent-use"> +<span class="sig-name descname"><span class="pre">--crs-extent-use</span></span><span class="sig-prename descclassname"> <span class="pre">none|both|intersection|smallest</span></span><a class="headerlink" href="#cmdoption-projinfo-crs-extent-use" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify which area of interest to consider when no explicit one is specified +with <a class="reference internal" href="#cmdoption-projinfo-area"><code class="xref std std-option docutils literal notranslate"><span class="pre">--area</span></code></a> or <a class="reference internal" href="#cmdoption-projinfo-bbox"><code class="xref std std-option docutils literal notranslate"><span class="pre">--bbox</span></code></a> options. +By default (<code class="docutils literal notranslate"><span class="pre">smallest</span></code> strategy), the area of +use of the source or target CRS will be looked, and the one that is the +smallest one in terms of area will be used as the area of interest. +If using <code class="docutils literal notranslate"><span class="pre">none</span></code>, no area of interest is used. +If using <code class="docutils literal notranslate"><span class="pre">both</span></code>, only coordinate operations that relate (contain or intersect +depending of the <a class="reference internal" href="#cmdoption-projinfo-spatial-test"><code class="xref std std-option docutils literal notranslate"><span class="pre">--spatial-test</span></code></a> strategy) to the area of use of both CRS +are selected. +If using <code class="docutils literal notranslate"><span class="pre">intersection</span></code>, the area of interest is the intersection of the +bounding box of the area of use of the source and target CRS</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>only used for coordinate operation computation</p> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-grid-check"> +<span class="sig-name descname"><span class="pre">--grid-check</span></span><span class="sig-prename descclassname"> <span class="pre">none|discard_missing|sort|known_available</span></span><a class="headerlink" href="#cmdoption-projinfo-grid-check" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify how the presence or absence of a horizontal or vertical shift grid +required for a coordinate operation affects the results returned when +researching coordinate operations between 2 CRS. +The default strategy is <code class="docutils literal notranslate"><span class="pre">sort</span></code> (if <span class="target" id="index-1"></span><a class="reference internal" href="../usage/environmentvars.html#envvar-PROJ_NETWORK"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PROJ_NETWORK</span></code></a> is not defined). +In that case, all candidate +operations are returned, but the actual availability of the grids is used +to determine the sorting order. That is, if a coordinate operation involves +using a grid that is not available in the PROJ resource directories +(determined by the <span class="target" id="index-2"></span><a class="reference internal" href="../usage/environmentvars.html#envvar-PROJ_LIB"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PROJ_LIB</span></code></a> environment variable, it will be listed in +the bottom of the results. +The <code class="docutils literal notranslate"><span class="pre">none</span></code> strategy completely disables the checks of presence of grids and +this returns the results as if all the grids where available. +The <code class="docutils literal notranslate"><span class="pre">discard_missing</span></code> strategy discards results that involve grids not +present in the PROJ resource directories. +The <code class="docutils literal notranslate"><span class="pre">known_available</span></code> strategy discards results that involve grids not +present in the PROJ resource directories and that are not known of the CDN. +This is the default strategy is <span class="target" id="index-3"></span><a class="reference internal" href="../usage/environmentvars.html#envvar-PROJ_NETWORK"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PROJ_NETWORK</span></code></a> is set to <code class="docutils literal notranslate"><span class="pre">ON</span></code>.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>only used for coordinate operation computation</p> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-pivot-crs"> +<span class="sig-name descname"><span class="pre">--pivot-crs</span></span><span class="sig-prename descclassname"> <span class="pre">always|if_no_direct_transformation|never|{auth:code[,auth:code]*}</span></span><a class="headerlink" href="#cmdoption-projinfo-pivot-crs" title="Permalink to this definition">¶</a></dt> +<dd><p>Determine if intermediate (pivot) CRS can be used when researching coordinate +operation between 2 CRS. A typical example is the WGS84 pivot. By default, +<strong class="program">projinfo</strong> will consider any potential pivot if there is no direct transformation +( <code class="docutils literal notranslate"><span class="pre">if_no_direct_transformation</span></code>). If using the <code class="docutils literal notranslate"><span class="pre">never</span></code> strategy, +only direct transformations between the source and target CRS will be +used. If using the <code class="docutils literal notranslate"><span class="pre">always</span></code> strategy, intermediate CRS will be considered +even if there are direct transformations. +It is also possible to restrict the pivot CRS to consider by specifying +one or several CRS by their AUTHORITY:CODE.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>only used for coordinate operation computation</p> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-show-superseded"> +<span class="sig-name descname"><span class="pre">--show-superseded</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-show-superseded" title="Permalink to this definition">¶</a></dt> +<dd><p>When enabled, coordinate operations that are superseded by others will be +listed. Note that supersession is not equivalent to deprecation: superseded +operations are still considered valid although they have a better equivalent, +whereas deprecated operations have been determined to be erroneous and are +not considered at all.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>only used for coordinate operation computation</p> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-hide-ballpark"> +<span class="sig-name descname"><span class="pre">--hide-ballpark</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-hide-ballpark" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 7.1.</span></p> +</div> +<p>Hides any coordinate operation that is, or contains, a +<a class="reference internal" href="../glossary.html#term-Ballpark-transformation"><span class="xref std std-term">Ballpark transformation</span></a></p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>only used for coordinate operation computation</p> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-accuracy"> +<span class="sig-name descname"><span class="pre">--accuracy</span></span><span class="sig-prename descclassname"> <span class="pre">{accuracy}</span></span><a class="headerlink" href="#cmdoption-projinfo-accuracy" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.0.</span></p> +</div> +<p>Sets the minimum desired accuracy for returned coordinate operations.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>only used for coordinate operation computation</p> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-allow-ellipsoidal-height-as-vertical-crs"> +<span class="sig-name descname"><span class="pre">--allow-ellipsoidal-height-as-vertical-crs</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-allow-ellipsoidal-height-as-vertical-crs" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.0.</span></p> +</div> +<p>Allows exporting a geographic or projected 3D CRS as a compound CRS whose +vertical CRS represents the ellipsoidal height.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>only used for CRS, and with WKT1:GDAL output format</p> +</div> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-boundcrs-to-wgs84"> +<span class="sig-name descname"><span class="pre">--boundcrs-to-wgs84</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-boundcrs-to-wgs84" title="Permalink to this definition">¶</a></dt> +<dd><p>When specified, this option researches a coordinate operation from the +base geographic CRS of the single CRS, source or target CRS to the WGS84 +geographic CRS, and if found, wraps those CRS into a BoundCRS object. +This is mostly to be used for early-binding approaches.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-authority"> +<span class="sig-name descname"><span class="pre">--authority</span></span><span class="sig-prename descclassname"> <span class="pre">name</span></span><a class="headerlink" href="#cmdoption-projinfo-authority" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify the name of the authority into which to restrict looks up for +objects, when specifying an object by name or when coordinate operations are +computed. The default is to allow all authorities.</p> +<p>When used with SQL output, this restricts the authorities to which intermediate +objects can belong to (the default is EPSG and PROJ). Note that the authority +of the <a class="reference internal" href="#cmdoption-projinfo-output-id"><code class="xref std std-option docutils literal notranslate"><span class="pre">--output-id</span></code></a> option will also be implicitly added.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-main-db-path"> +<span class="sig-name descname"><span class="pre">--main-db-path</span></span><span class="sig-prename descclassname"> <span class="pre">path</span></span><a class="headerlink" href="#cmdoption-projinfo-main-db-path" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify the name and path of the database to be used by <strong class="program">projinfo</strong>. +The default is <code class="file docutils literal notranslate"><span class="pre">proj.db</span></code> in the PROJ resource directories.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-aux-db-path"> +<span class="sig-name descname"><span class="pre">--aux-db-path</span></span><span class="sig-prename descclassname"> <span class="pre">path</span></span><a class="headerlink" href="#cmdoption-projinfo-aux-db-path" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify the name and path of auxiliary databases, that are to be combined +with the main database. Those auxiliary databases must have a table +structure that is identical to the main database, but can be partly filled +and their entries can refer to entries of the main database. +The option may be repeated to specify several auxiliary databases.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-identify"> +<span class="sig-name descname"><span class="pre">--identify</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-identify" title="Permalink to this definition">¶</a></dt> +<dd><p>When used with an object definition, this queries the PROJ database to find +known objects, typically CRS, that are close or identical to the object. +Each candidate object is associated with an approximate likelihood percentage. +This is useful when used with a WKT string that lacks a EPSG identifier, +such as ESRI WKT1. This might also be used with PROJ strings. +For example, <cite>+proj=utm +zone=31 +datum=WGS84 +type=crs</cite> will be identified +with a likelihood of 70% to EPSG:32631</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-dump-db-structure"> +<span class="sig-name descname"><span class="pre">--dump-db-structure</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-dump-db-structure" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.1.</span></p> +</div> +<p>Outputs the sequence of SQL statements to create a new empty valid auxiliary +database. This option can be specified as the only switch of the utility. +If also specifying a CRS object and the <a class="reference internal" href="#cmdoption-projinfo-output-id"><code class="xref std std-option docutils literal notranslate"><span class="pre">--output-id</span></code></a> option, the +definition of the object as SQL statements will be appended.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-list-crs"> +<span class="sig-name descname"><span class="pre">--list-crs</span></span><span class="sig-prename descclassname"> <span class="pre">[list-crs-filter]</span></span><a class="headerlink" href="#cmdoption-projinfo-list-crs" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.1.</span></p> +</div> +<p>Outputs a list (authority name:code and CRS name) of the filtered CRSs from the database. +If no filter is provided all authority names and types of non deprecated CRSs are dumped. +list-crs-filter is a comma separated combination of: allow_deprecated,geodetic,geocentric, +geographic,geographic_2d,geographic_3d,vertical,projected,compound. +Affected by options <a class="reference internal" href="#cmdoption-projinfo-authority"><code class="xref std std-option docutils literal notranslate"><span class="pre">--authority</span></code></a>, <a class="reference internal" href="#cmdoption-projinfo-area"><code class="xref std std-option docutils literal notranslate"><span class="pre">--area</span></code></a>, <a class="reference internal" href="#cmdoption-projinfo-bbox"><code class="xref std std-option docutils literal notranslate"><span class="pre">--bbox</span></code></a> and <a class="reference internal" href="#cmdoption-projinfo-spatial-test"><code class="xref std std-option docutils literal notranslate"><span class="pre">--spatial-test</span></code></a></p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-3d"> +<span class="sig-name descname"><span class="pre">--3d</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-3d" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 6.3.</span></p> +</div> +<p>“Promote” the CRS(s) to their 3D version. In the context of researching +available coordinate transformations, explicitly specifying this option is +not necessary, because when one of the source or target CRS has a vertical +component but not the other one, the one that has no vertical component is +automatically promoted to a 3D version, where its vertical axis is the +ellipsoidal height in metres, using the ellipsoid of the base geodetic CRS.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-output-id"> +<span class="sig-name descname"><span class="pre">--output-id</span></span><span class="sig-prename descclassname"><span class="pre">=AUTH:NAME</span></span><a class="headerlink" href="#cmdoption-projinfo-output-id" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.1.</span></p> +</div> +<p>Identifier to assign to the object (for SQL output).</p> +<p>It is strongly recommended that new objects should not be added in common +registries, such as <code class="docutils literal notranslate"><span class="pre">EPSG</span></code>, <code class="docutils literal notranslate"><span class="pre">ESRI</span></code>, <code class="docutils literal notranslate"><span class="pre">IAU</span></code>, etc. +Users should use a custom authority name instead. If a new object should be +added to the official EPSG registry, users are invited to follow the +procedure explained at <a class="reference external" href="https://epsg.org/dataset-change-requests.html">https://epsg.org/dataset-change-requests.html</a>.</p> +<p>Combined with <a class="reference internal" href="#cmdoption-projinfo-dump-db-structure"><code class="xref std std-option docutils literal notranslate"><span class="pre">--dump-db-structure</span></code></a>, users can create +auxiliary databases, instead of directly modifying the main <code class="file docutils literal notranslate"><span class="pre">proj.db</span></code> database. +See the <a class="reference internal" href="#projinfo-aux-db-example"><span class="std std-ref">example how to export to an auxiliary database</span></a>.</p> +<p>Those auxiliary databases can be specified through +<code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">proj_context_set_database_path()</span></code> or the <span class="target" id="index-4"></span><a class="reference internal" href="../usage/environmentvars.html#envvar-PROJ_AUX_DB"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PROJ_AUX_DB</span></code></a> +environment variable.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-c-ify"> +<span class="sig-name descname"><span class="pre">--c-ify</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-c-ify" title="Permalink to this definition">¶</a></dt> +<dd><p>For developers only. Modify the string output of the utility so that it +is easy to put those strings in C/C++ code</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-single-line"> +<span class="sig-name descname"><span class="pre">--single-line</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-single-line" title="Permalink to this definition">¶</a></dt> +<dd><p>Output PROJ, WKT or PROJJSON strings on a single line, instead of multiple +indented lines by default.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-searchpaths"> +<span class="sig-name descname"><span class="pre">--searchpaths</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-searchpaths" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 7.0.</span></p> +</div> +<p>Output the directories into which PROJ resources will be looked for +(if not using C API such as <code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">proj_context_set_search_paths()</span></code> +that will override them.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projinfo-remote-data"> +<span class="sig-name descname"><span class="pre">--remote-data</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projinfo-remote-data" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 7.0.</span></p> +</div> +<p>Display information regarding if <a class="reference internal" href="../usage/network.html#network"><span class="std std-ref">Network capabilities</span></a> is enabled, and the +related URL.</p> +</dd></dl> + +</section> +<section id="examples"> +<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2> +<ol class="arabic simple"> +<li><p>Query the CRS object corresponding to EPSG:4326</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">projinfo EPSG:4326</span> +</pre></div> +</div> +<p>Output:</p> +<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>PROJ.4 string: ++proj=longlat +datum=WGS84 +no_defs +type=crs + +WKT2:2019 string: +GEOGCRS["WGS 84", + DATUM["World Geodetic System 1984", + ELLIPSOID["WGS 84",6378137,298.257223563, + LENGTHUNIT["metre",1]]], + PRIMEM["Greenwich",0, + ANGLEUNIT["degree",0.0174532925199433]], + CS[ellipsoidal,2], + AXIS["geodetic latitude (Lat)",north, + ORDER[1], + ANGLEUNIT["degree",0.0174532925199433]], + AXIS["geodetic longitude (Lon)",east, + ORDER[2], + ANGLEUNIT["degree",0.0174532925199433]], + USAGE[ + SCOPE["unknown"], + AREA["World"], + BBOX[-90,-180,90,180]], + ID["EPSG",4326]] +</pre></div> +</div> +<ol class="arabic simple" start="2"> +<li><p>List the coordinate operations between NAD27 (designed with its CRS name) +and NAD83 (designed with its EPSG code 4269) within an area of interest</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">projinfo -s NAD27 -t EPSG:4269 --area "USA - Missouri"</span> +</pre></div> +</div> +<p>Output:</p> +<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>DERIVED_FROM(EPSG):1241, NAD27 to NAD83 (1), 0.15 m, USA - CONUS including EEZ + +PROJ string: ++proj=pipeline +step +proj=axisswap +order=2,1 +step +proj=unitconvert \ ++xy_in=deg +xy_out=rad +step +proj=hgridshift +grids=conus \ ++step +proj=unitconvert +xy_in=rad +xy_out=deg +step +proj=axisswap +order=2,1 + +WKT2:2019 string: +COORDINATEOPERATION["NAD27 to NAD83 (1)", + SOURCECRS[ + GEOGCRS["NAD27", + DATUM["North American Datum 1927", + ELLIPSOID["Clarke 1866",6378206.4,294.978698213898, + LENGTHUNIT["metre",1]]], + PRIMEM["Greenwich",0, + ANGLEUNIT["degree",0.0174532925199433]], + CS[ellipsoidal,2], + AXIS["geodetic latitude (Lat)",north, + ORDER[1], + ANGLEUNIT["degree",0.0174532925199433]], + AXIS["geodetic longitude (Lon)",east, + ORDER[2], + ANGLEUNIT["degree",0.0174532925199433]]]], + TARGETCRS[ + GEOGCRS["NAD83", + DATUM["North American Datum 1983", + ELLIPSOID["GRS 1980",6378137,298.257222101, + LENGTHUNIT["metre",1]]], + PRIMEM["Greenwich",0, + ANGLEUNIT["degree",0.0174532925199433]], + CS[ellipsoidal,2], + AXIS["geodetic latitude (Lat)",north, + ORDER[1], + ANGLEUNIT["degree",0.0174532925199433]], + AXIS["geodetic longitude (Lon)",east, + ORDER[2], + ANGLEUNIT["degree",0.0174532925199433]]]], + METHOD["CTABLE2"], + PARAMETERFILE["Latitude and longitude difference file","conus"], + OPERATIONACCURACY[0.15], + USAGE[ + SCOPE["unknown"], + AREA["USA - CONUS including EEZ"], + BBOX[23.81,-129.17,49.38,-65.69]], + ID["DERIVED_FROM(EPSG)",1241]] +</pre></div> +</div> +<ol class="arabic simple" start="3"> +<li><p>Export an object as a PROJJSON string</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">projinfo GDA94 -o PROJJSON -q</span> +</pre></div> +</div> +<p>Output:</p> +<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span> +<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GeographicCRS"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GDA94"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"datum"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span> +<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GeodeticReferenceFrame"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Geocentric Datum of Australia 1994"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"ellipsoid"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span> +<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GRS 1980"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"semi_major_axis"</span><span class="p">:</span><span class="w"> </span><span class="mi">6378137</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"inverse_flattening"</span><span class="p">:</span><span class="w"> </span><span class="mf">298.257222101</span><span class="w"></span> +<span class="w"> </span><span class="p">}</span><span class="w"></span> +<span class="w"> </span><span class="p">},</span><span class="w"></span> +<span class="w"> </span><span class="nt">"coordinate_system"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span> +<span class="w"> </span><span class="nt">"subtype"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ellipsoidal"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"axis"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span> +<span class="w"> </span><span class="p">{</span><span class="w"></span> +<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Geodetic latitude"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"abbreviation"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lat"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"direction"</span><span class="p">:</span><span class="w"> </span><span class="s2">"north"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"degree"</span><span class="w"></span> +<span class="w"> </span><span class="p">},</span><span class="w"></span> +<span class="w"> </span><span class="p">{</span><span class="w"></span> +<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Geodetic longitude"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"abbreviation"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lon"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"direction"</span><span class="p">:</span><span class="w"> </span><span class="s2">"east"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"degree"</span><span class="w"></span> +<span class="w"> </span><span class="p">}</span><span class="w"></span> +<span class="w"> </span><span class="p">]</span><span class="w"></span> +<span class="w"> </span><span class="p">},</span><span class="w"></span> +<span class="w"> </span><span class="nt">"area"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Australia - GDA"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"bbox"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span> +<span class="w"> </span><span class="nt">"south_latitude"</span><span class="p">:</span><span class="w"> </span><span class="mf">-60.56</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"west_longitude"</span><span class="p">:</span><span class="w"> </span><span class="mf">93.41</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"north_latitude"</span><span class="p">:</span><span class="w"> </span><span class="mf">-8.47</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"east_longitude"</span><span class="p">:</span><span class="w"> </span><span class="mf">173.35</span><span class="w"></span> +<span class="w"> </span><span class="p">},</span><span class="w"></span> +<span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span> +<span class="w"> </span><span class="nt">"authority"</span><span class="p">:</span><span class="w"> </span><span class="s2">"EPSG"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">4283</span><span class="w"></span> +<span class="w"> </span><span class="p">}</span><span class="w"></span> +<span class="p">}</span><span class="w"></span> +</pre></div> +</div> +<ol class="arabic simple" id="projinfo-aux-db-example" start="4"> +<li><p>Exporting the SQL statements to insert a new CRS in an auxiliary database.</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>Get the SQL statements <span class="k">for</span> a custom CRS +<span class="go">projinfo "+proj=merc +lat_ts=5 +datum=WGS84 +type=crs +title=my_crs" --output-id HOBU:MY_CRS -o SQL -q > my_crs.sql</span> +<span class="go">cat my_crs.sql</span> + +<span class="gp"># </span>Initialize an auxiliary database with the schema of the reference database +<span class="go">echo ".schema" | sqlite3 /path/to/proj.db | sqlite3 aux.db</span> + +<span class="gp"># </span>Append the content of the definition of HOBU:MY_CRS +<span class="go">sqlite3 aux.db < my_crs.db</span> + +<span class="gp"># </span>Check that everything works OK +<span class="go">projinfo --aux-db-path aux.db HOBU:MY_CRS</span> +</pre></div> +</div> +<p>or more simply:</p> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>Create an auxiliary database with the definition of a custom CRS. +<span class="go">projinfo "+proj=merc +lat_ts=5 +datum=WGS84 +type=crs +title=my_crs" --output-id HOBU:MY_CRS --dump-db-structure | sqlite3 aux.db</span> + +<span class="gp"># </span>Check that everything works OK +<span class="go">projinfo --aux-db-path aux.db HOBU:MY_CRS</span> +</pre></div> +</div> +<p>Output:</p> +<div class="highlight-sql notranslate"><div class="highlight"><pre><span></span><span class="k">INSERT</span><span class="w"> </span><span class="k">INTO</span><span class="w"> </span><span class="n">geodetic_crs</span><span class="w"> </span><span class="k">VALUES</span><span class="p">(</span><span class="s1">'HOBU'</span><span class="p">,</span><span class="s1">'GEODETIC_CRS_MY_CRS'</span><span class="p">,</span><span class="s1">'unknown'</span><span class="p">,</span><span class="s1">''</span><span class="p">,</span><span class="s1">'geographic 2D'</span><span class="p">,</span><span class="s1">'EPSG'</span><span class="p">,</span><span class="s1">'6424'</span><span class="p">,</span><span class="s1">'EPSG'</span><span class="p">,</span><span class="s1">'6326'</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="mi">0</span><span class="p">);</span><span class="w"></span> +<span class="k">INSERT</span><span class="w"> </span><span class="k">INTO</span><span class="w"> </span><span class="k">usage</span><span class="w"> </span><span class="k">VALUES</span><span class="p">(</span><span class="s1">'HOBU'</span><span class="p">,</span><span class="s1">'USAGE_GEODETIC_CRS_MY_CRS'</span><span class="p">,</span><span class="s1">'geodetic_crs'</span><span class="p">,</span><span class="s1">'HOBU'</span><span class="p">,</span><span class="s1">'GEODETIC_CRS_MY_CRS'</span><span class="p">,</span><span class="s1">'PROJ'</span><span class="p">,</span><span class="s1">'EXTENT_UNKNOWN'</span><span class="p">,</span><span class="s1">'PROJ'</span><span class="p">,</span><span class="s1">'SCOPE_UNKNOWN'</span><span class="p">);</span><span class="w"></span> +<span class="k">INSERT</span><span class="w"> </span><span class="k">INTO</span><span class="w"> </span><span class="k">conversion</span><span class="w"> </span><span class="k">VALUES</span><span class="p">(</span><span class="s1">'HOBU'</span><span class="p">,</span><span class="s1">'CONVERSION_MY_CRS'</span><span class="p">,</span><span class="s1">'unknown'</span><span class="p">,</span><span class="s1">''</span><span class="p">,</span><span class="s1">'EPSG'</span><span class="p">,</span><span class="s1">'9805'</span><span class="p">,</span><span class="s1">'Mercator (variant B)'</span><span class="p">,</span><span class="s1">'EPSG'</span><span class="p">,</span><span class="s1">'8823'</span><span class="p">,</span><span class="s1">'Latitude of 1st standard parallel'</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="s1">'EPSG'</span><span class="p">,</span><span class="s1">'9122'</span><span class="p">,</span><span class="s1">'EPSG'</span><span class="p">,</span><span class="s1">'8802'</span><span class="p">,</span><span class="s1">'Longitude of natural origin'</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="s1">'EPSG'</span><span class="p">,</span><span class="s1">'9122'</span><span class="p">,</span><span class="s1">'EPSG'</span><span class="p">,</span><span class="s1">'8806'</span><span class="p">,</span><span class="s1">'False easting'</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="s1">'EPSG'</span><span class="p">,</span><span class="s1">'9001'</span><span class="p">,</span><span class="s1">'EPSG'</span><span class="p">,</span><span class="s1">'8807'</span><span class="p">,</span><span class="s1">'False northing'</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="s1">'EPSG'</span><span class="p">,</span><span class="s1">'9001'</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="mi">0</span><span class="p">);</span><span class="w"></span> +<span class="k">INSERT</span><span class="w"> </span><span class="k">INTO</span><span class="w"> </span><span class="k">usage</span><span class="w"> </span><span class="k">VALUES</span><span class="p">(</span><span class="s1">'HOBU'</span><span class="p">,</span><span class="s1">'USAGE_CONVERSION_MY_CRS'</span><span class="p">,</span><span class="s1">'conversion'</span><span class="p">,</span><span class="s1">'HOBU'</span><span class="p">,</span><span class="s1">'CONVERSION_MY_CRS'</span><span class="p">,</span><span class="s1">'PROJ'</span><span class="p">,</span><span class="s1">'EXTENT_UNKNOWN'</span><span class="p">,</span><span class="s1">'PROJ'</span><span class="p">,</span><span class="s1">'SCOPE_UNKNOWN'</span><span class="p">);</span><span class="w"></span> +<span class="k">INSERT</span><span class="w"> </span><span class="k">INTO</span><span class="w"> </span><span class="n">projected_crs</span><span class="w"> </span><span class="k">VALUES</span><span class="p">(</span><span class="s1">'HOBU'</span><span class="p">,</span><span class="s1">'MY_CRS'</span><span class="p">,</span><span class="s1">'my_crs'</span><span class="p">,</span><span class="s1">''</span><span class="p">,</span><span class="s1">'EPSG'</span><span class="p">,</span><span class="s1">'4400'</span><span class="p">,</span><span class="s1">'HOBU'</span><span class="p">,</span><span class="s1">'GEODETIC_CRS_MY_CRS'</span><span class="p">,</span><span class="s1">'HOBU'</span><span class="p">,</span><span class="s1">'CONVERSION_MY_CRS'</span><span class="p">,</span><span class="k">NULL</span><span class="p">,</span><span class="mi">0</span><span class="p">);</span><span class="w"></span> +<span class="k">INSERT</span><span class="w"> </span><span class="k">INTO</span><span class="w"> </span><span class="k">usage</span><span class="w"> </span><span class="k">VALUES</span><span class="p">(</span><span class="s1">'HOBU'</span><span class="p">,</span><span class="s1">'USAGE_PROJECTED_CRS_MY_CRS'</span><span class="p">,</span><span class="s1">'projected_crs'</span><span class="p">,</span><span class="s1">'HOBU'</span><span class="p">,</span><span class="s1">'MY_CRS'</span><span class="p">,</span><span class="s1">'PROJ'</span><span class="p">,</span><span class="s1">'EXTENT_UNKNOWN'</span><span class="p">,</span><span class="s1">'PROJ'</span><span class="p">,</span><span class="s1">'SCOPE_UNKNOWN'</span><span class="p">);</span><span class="w"></span> +</pre></div> +</div> +<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>PROJ.4 string: ++proj=merc +lat_ts=5 +lon_0=0 +x_0=0 +y_0=0 +datum=WGS84 +units=m +no_defs +type=crs + +WKT2:2019 string: +PROJCRS["my_crs", + BASEGEOGCRS["unknown", + ENSEMBLE["World Geodetic System 1984 ensemble", + MEMBER["World Geodetic System 1984 (Transit)"], + MEMBER["World Geodetic System 1984 (G730)"], + MEMBER["World Geodetic System 1984 (G873)"], + MEMBER["World Geodetic System 1984 (G1150)"], + MEMBER["World Geodetic System 1984 (G1674)"], + MEMBER["World Geodetic System 1984 (G1762)"], + ELLIPSOID["WGS 84",6378137,298.257223563, + LENGTHUNIT["metre",1]], + ENSEMBLEACCURACY[2.0]], + PRIMEM["Greenwich",0, + ANGLEUNIT["degree",0.0174532925199433]], + ID["HOBU","GEODETIC_CRS_MY_CRS"]], + CONVERSION["unknown", + METHOD["Mercator (variant B)", + ID["EPSG",9805]], + PARAMETER["Latitude of 1st standard parallel",5, + ANGLEUNIT["degree",0.0174532925199433], + ID["EPSG",8823]], + PARAMETER["Longitude of natural origin",0, + ANGLEUNIT["degree",0.0174532925199433], + ID["EPSG",8802]], + PARAMETER["False easting",0, + LENGTHUNIT["metre",1], + ID["EPSG",8806]], + PARAMETER["False northing",0, + LENGTHUNIT["metre",1], + ID["EPSG",8807]]], + CS[Cartesian,2], + AXIS["(E)",east, + ORDER[1], + LENGTHUNIT["metre",1]], + AXIS["(N)",north, + ORDER[2], + LENGTHUNIT["metre",1]], + ID["HOBU","MY_CRS"]] +</pre></div> +</div> +<ol class="arabic simple" start="5"> +<li><p>Get the WKT representation of EPSG:25832 in the WKT1:GDAL output format and on a single line</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">projinfo -o WKT1:GDAL --single-line EPSG:25832</span> +</pre></div> +</div> +<p>Output:</p> +<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>WKT1:GDAL string: +PROJCS["ETRS89 / UTM zone 32N",GEOGCS["ETRS89",DATUM["European_Terrestrial_Reference_System_1989",SPHEROID["GRS 1980",6378137,298.257222101,AUTHORITY["EPSG","7019"]],AUTHORITY["EPSG","6258"]],PRIMEM["Greenwich",0,AUTHORITY["EPSG","8901"]],UNIT["degree",0.0174532925199433,AUTHORITY["EPSG","9122"]],AUTHORITY["EPSG","4258"]],PROJECTION["Transverse_Mercator"],PARAMETER["latitude_of_origin",0],PARAMETER["central_meridian",9],PARAMETER["scale_factor",0.9996],PARAMETER["false_easting",500000],PARAMETER["false_northing",0],UNIT["metre",1,AUTHORITY["EPSG","9001"]],AXIS["Easting",EAST],AXIS["Northing",NORTH],AUTHORITY["EPSG","25832"]] +</pre></div> +</div> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="proj.html" class="btn btn-neutral float-left" title="proj" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="projsync.html" class="btn btn-neutral float-right" title="projsync" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 1983-2022. + <span class="lastupdated">Last updated on 22 Mar 2022. + </span></p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/apps/projsync.html b/apps/projsync.html new file mode 100644 index 00000000..dd542a57 --- /dev/null +++ b/apps/projsync.html @@ -0,0 +1,325 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>projsync — PROJ 9.0.0 documentation</title> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="shortcut icon" href="../_static/favicon.png"/> + <link rel="canonical" href="https://proj.orgapps/projsync.html"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> + <script src="../_static/js/theme.js"></script> + <link rel="author" title="About these documents" href="../about.html" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Coordinate operations" href="../operations/index.html" /> + <link rel="prev" title="projinfo" href="projinfo.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" style="background: #353130" > + <a href="../index.html"> + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> + <div class="version"> + 9.0.0 + </div> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li> +<li class="toctree-l1"><a class="reference internal" href="../news.html">News</a></li> +<li class="toctree-l1"><a class="reference internal" href="../download.html">Download</a></li> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../usage/index.html">Using PROJ</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Applications</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="cct.html">cct</a></li> +<li class="toctree-l2"><a class="reference internal" href="cs2cs.html">cs2cs</a></li> +<li class="toctree-l2"><a class="reference internal" href="geod.html">geod</a></li> +<li class="toctree-l2"><a class="reference internal" href="gie.html">gie</a></li> +<li class="toctree-l2"><a class="reference internal" href="proj.html">proj</a></li> +<li class="toctree-l2"><a class="reference internal" href="projinfo.html">projinfo</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">projsync</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li> +<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li> +<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../operations/index.html">Coordinate operations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../resource_files.html">Resource files</a></li> +<li class="toctree-l1"><a class="reference internal" href="../geodesic.html">Geodesic calculations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../specifications/index.html">Specifications</a></li> +<li class="toctree-l1"><a class="reference internal" href="../community/index.html">Community</a></li> +<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../zreferences.html">References</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #353130" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">PROJ</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home"></a> »</li> + <li><a href="index.html">Applications</a> »</li> + <li>projsync</li> + <li class="wy-breadcrumbs-aside"> + <a href="https://github.com/OSGeo/PROJ/edit/8.2/docs/source/apps/projsync.rst" class="fa fa-github"> Edit on GitHub</a> + </li> + </ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation"> + <a href="projinfo.html" class="btn btn-neutral float-left" title="projinfo" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="../operations/index.html" class="btn btn-neutral float-right" title="Coordinate operations" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="projsync"> +<span id="id1"></span><h1>projsync<a class="headerlink" href="#projsync" title="Permalink to this headline">¶</a></h1> +<div class="versionadded" id="index-0"> +<p><span class="versionmodified added">New in version 7.0.0.</span></p> +</div> +<p>Tool for synchronizing PROJ datum and transformation support data.</p> +<section id="synopsis"> +<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><div class="line-block"> +<div class="line"><strong>projsync</strong></div> +<div class="line-block"> +<div class="line">[–endpoint URL]</div> +<div class="line">[–local-geojson-file FILENAME]</div> +<div class="line">([–user-writable-directory] | [–system-directory] | [–target-dir DIRNAME])</div> +<div class="line">[–bbox west_long,south_lat,east_long,north_lat]</div> +<div class="line">[–spatial-test contains|intersects]</div> +<div class="line">[–source-id ID] [–area-of-use NAME]</div> +<div class="line">[–file NAME]</div> +<div class="line">[–all] [–exclude-world-coverage]</div> +<div class="line">[–quiet | –verbose] [–dry-run] [–list-files]</div> +<div class="line">[–no-version-filtering]</div> +</div> +</div> +</div></blockquote> +</section> +<section id="description"> +<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> +<p><strong class="program">projsync</strong> is a program that downloads remote resource files +into a local directory. This is an alternative to downloading a proj-data-X.Y.Z +archive file, or using the on-demand <a class="reference internal" href="../usage/network.html#network"><span class="std std-ref">networking capabilities</span></a> of PROJ.</p> +<p>The following control parameters can appear in any order:</p> +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-endpoint"> +<span class="sig-name descname"><span class="pre">--endpoint</span></span><span class="sig-prename descclassname"> <span class="pre">URL</span></span><a class="headerlink" href="#cmdoption-projsync-endpoint" title="Permalink to this definition">¶</a></dt> +<dd><p>Defines the URL where to download the master <code class="file docutils literal notranslate"><span class="pre">files.geojson</span></code> file and then +the resource files. Defaults to the value set in <a class="reference internal" href="../resource_files.html#proj-ini"><span class="std std-ref">proj.ini</span></a></p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-local-geojson-file"> +<span class="sig-name descname"><span class="pre">--local-geojson-file</span></span><span class="sig-prename descclassname"> <span class="pre">FILENAME</span></span><a class="headerlink" href="#cmdoption-projsync-local-geojson-file" title="Permalink to this definition">¶</a></dt> +<dd><p>Defines the filename for the master GeoJSON files that references resources. +Defaults to <code class="docutils literal notranslate"><span class="pre">${endpoint}/files.geojson</span></code></p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-user-writable-directory"> +<span class="sig-name descname"><span class="pre">--user-writable-directory</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projsync-user-writable-directory" title="Permalink to this definition">¶</a></dt> +<dd><p>Specifies that resource files must be downloaded in the +<a class="reference internal" href="../resource_files.html#user-writable-directory"><span class="std std-ref">user writable directory</span></a>. This is the default.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-system-directory"> +<span class="sig-name descname"><span class="pre">--system-directory</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projsync-system-directory" title="Permalink to this definition">¶</a></dt> +<dd><p>Specifies that resource files must be downloaded in the +${installation_prefix}/share/proj directory. The user launching projsync +should make sure it has writing rights in that directory.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-target-dir"> +<span class="sig-name descname"><span class="pre">--target-dir</span></span><span class="sig-prename descclassname"> <span class="pre">DIRNAME</span></span><a class="headerlink" href="#cmdoption-projsync-target-dir" title="Permalink to this definition">¶</a></dt> +<dd><p>Directory into which resource files must be downloaded.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-bbox"> +<span class="sig-name descname"><span class="pre">--bbox</span></span><span class="sig-prename descclassname"> <span class="pre">west_long,south_lat,east_long,north_lat</span></span><a class="headerlink" href="#cmdoption-projsync-bbox" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify an area of interest to restrict the resources to download. +The area of interest is specified as a +bounding box with geographic coordinates, expressed in degrees in a +unspecified geographic CRS. +<cite>west_long</cite> and <cite>east_long</cite> should be in the [-180,180] range, and +<cite>south_lat</cite> and <cite>north_lat</cite> in the [-90,90]. <cite>west_long</cite> is generally lower than +<cite>east_long</cite>, except in the case where the area of interest crosses the antimeridian.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-spatial-test"> +<span class="sig-name descname"><span class="pre">--spatial-test</span></span><span class="sig-prename descclassname"> <span class="pre">contains|intersects</span></span><a class="headerlink" href="#cmdoption-projsync-spatial-test" title="Permalink to this definition">¶</a></dt> +<dd><p>Specify how the extent of the resource files +are compared to the area of use specified explicitly with <a class="reference internal" href="#cmdoption-projsync-bbox"><code class="xref std std-option docutils literal notranslate"><span class="pre">--bbox</span></code></a>. +By default, any resource files whose extent intersects the value specified +by <a class="reference internal" href="#cmdoption-projsync-bbox"><code class="xref std std-option docutils literal notranslate"><span class="pre">--bbox</span></code></a> will be selected. +If using the <code class="docutils literal notranslate"><span class="pre">contains</span></code> strategy, only resource files whose extent is +contained in the value specified by <a class="reference internal" href="#cmdoption-projsync-bbox"><code class="xref std std-option docutils literal notranslate"><span class="pre">--bbox</span></code></a> will be selected.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-source-id"> +<span class="sig-name descname"><span class="pre">--source-id</span></span><span class="sig-prename descclassname"> <span class="pre">ID</span></span><a class="headerlink" href="#cmdoption-projsync-source-id" title="Permalink to this definition">¶</a></dt> +<dd><p>Restrict resource files to be downloaded to those whose source_id property +contains the ID value. Specifying <code class="docutils literal notranslate"><span class="pre">?</span></code> as ID will list all possible values.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-area-of-use"> +<span class="sig-name descname"><span class="pre">--area-of-use</span></span><span class="sig-prename descclassname"> <span class="pre">NAME</span></span><a class="headerlink" href="#cmdoption-projsync-area-of-use" title="Permalink to this definition">¶</a></dt> +<dd><p>Restrict resource files to be downloaded to those whose area_of_use property +contains the NAME value. Specifying <code class="docutils literal notranslate"><span class="pre">?</span></code> as NAME will list all possible values.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-file"> +<span class="sig-name descname"><span class="pre">--file</span></span><span class="sig-prename descclassname"> <span class="pre">NAME</span></span><a class="headerlink" href="#cmdoption-projsync-file" title="Permalink to this definition">¶</a></dt> +<dd><p>Restrict resource files to be downloaded to those whose name property +contains the NAME value. Specifying <code class="docutils literal notranslate"><span class="pre">?</span></code> as NAME will list all possible values.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-all"> +<span class="sig-name descname"><span class="pre">--all</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projsync-all" title="Permalink to this definition">¶</a></dt> +<dd><p>Ask to download all files.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-exclude-world-coverage"> +<span class="sig-name descname"><span class="pre">--exclude-world-coverage</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projsync-exclude-world-coverage" title="Permalink to this definition">¶</a></dt> +<dd><p>Exclude files which have world coverage.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-q"> +<span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"> <span class="pre">/</span> <span class="pre">--quiet</span></span><a class="headerlink" href="#cmdoption-projsync-q" title="Permalink to this definition">¶</a></dt> +<dd><p>Quiet mode</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-verbose"> +<span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projsync-verbose" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.1.</span></p> +</div> +<p>Verbose mode (more than default)</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-dry-run"> +<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projsync-dry-run" title="Permalink to this definition">¶</a></dt> +<dd><p>Simulate the behavior of the tool without downloading resource files.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-list-files"> +<span class="sig-name descname"><span class="pre">--list-files</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projsync-list-files" title="Permalink to this definition">¶</a></dt> +<dd><p>List file names, with the source_id and area_of_use properties.</p> +</dd></dl> + +<dl class="std option"> +<dt class="sig sig-object std" id="cmdoption-projsync-no-version-filtering"> +<span class="sig-name descname"><span class="pre">--no-version-filtering</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-projsync-no-version-filtering" title="Permalink to this definition">¶</a></dt> +<dd><div class="versionadded"> +<p><span class="versionmodified added">New in version 8.1.</span></p> +</div> +<p>By default, projsync only downloads files that are compatible of +the PROJ_DATA.VERSION metadata of <code class="file docutils literal notranslate"><span class="pre">proj.db</span></code>, taking into account the +<code class="docutils literal notranslate"><span class="pre">version_added</span></code> and <code class="docutils literal notranslate"><span class="pre">version_removed</span></code> properties of entries in <code class="file docutils literal notranslate"><span class="pre">files.geojson</span></code>. +When specifying this switch, all files referenced in <code class="file docutils literal notranslate"><span class="pre">files.geojson</span></code> +will be candidate (combined with other filters).</p> +</dd></dl> + +<p>At least one of <a class="reference internal" href="#cmdoption-projsync-list-files"><code class="xref std std-option docutils literal notranslate"><span class="pre">--list-files</span></code></a>, <a class="reference internal" href="#cmdoption-projsync-file"><code class="xref std std-option docutils literal notranslate"><span class="pre">--file</span></code></a>, <a class="reference internal" href="#cmdoption-projsync-source-id"><code class="xref std std-option docutils literal notranslate"><span class="pre">--source-id</span></code></a>, +<a class="reference internal" href="#cmdoption-projsync-area-of-use"><code class="xref std std-option docutils literal notranslate"><span class="pre">--area-of-use</span></code></a>, <a class="reference internal" href="#cmdoption-projsync-bbox"><code class="xref std std-option docutils literal notranslate"><span class="pre">--bbox</span></code></a> or <a class="reference internal" href="#cmdoption-projsync-all"><code class="xref std std-option docutils literal notranslate"><span class="pre">--all</span></code></a> must be specified.</p> +<p>Options <a class="reference internal" href="#cmdoption-projsync-file"><code class="xref std std-option docutils literal notranslate"><span class="pre">--file</span></code></a>, <a class="reference internal" href="#cmdoption-projsync-source-id"><code class="xref std std-option docutils literal notranslate"><span class="pre">--source-id</span></code></a>, <a class="reference internal" href="#cmdoption-projsync-area-of-use"><code class="xref std std-option docutils literal notranslate"><span class="pre">--area-of-use</span></code></a> and +<a class="reference internal" href="#cmdoption-projsync-bbox"><code class="xref std std-option docutils literal notranslate"><span class="pre">--bbox</span></code></a> are combined with a AND logic.</p> +</section> +<section id="examples"> +<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2> +<ol class="arabic simple"> +<li><p>Download all resource files</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">projsync --all</span> +</pre></div> +</div> +<ol class="arabic simple" start="2"> +<li><p>Download resource files covering specified point and attributing to an agency</p></li> +</ol> +<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">projsync --source-id fr_ign --bbox 2,49,2,49</span> +</pre></div> +</div> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="projinfo.html" class="btn btn-neutral float-left" title="projinfo" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="../operations/index.html" class="btn btn-neutral float-right" title="Coordinate operations" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 1983-2022. + <span class="lastupdated">Last updated on 22 Mar 2022. + </span></p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file |