sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r981726 - in /websites/staging/sis/trunk/content: ./ command-line.html
Date Thu, 03 Mar 2016 11:42:39 GMT
Author: buildbot
Date: Thu Mar  3 11:42:39 2016
New Revision: 981726

Log:
Staging update by buildbot for sis

Modified:
    websites/staging/sis/trunk/content/   (props changed)
    websites/staging/sis/trunk/content/command-line.html

Propchange: websites/staging/sis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Mar  3 11:42:39 2016
@@ -1 +1 @@
-1733395
+1733449

Modified: websites/staging/sis/trunk/content/command-line.html
==============================================================================
--- websites/staging/sis/trunk/content/command-line.html (original)
+++ websites/staging/sis/trunk/content/command-line.html Thu Mar  3 11:42:39 2016
@@ -93,7 +93,7 @@
   visibility: hidden;
 }
 h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover
> .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink
{ visibility: visible }</style>
-<p>A command-line interface is provided for extracting information from a data file.</p>
+<p>A command-line interface is provided for extracting information from data files
or authority codes.</p>
 <div class="toc">
 <ul>
 <li><a href="#install">Installation</a><ul>
@@ -129,12 +129,12 @@ Example:</p>
 </pre></div>
 
 
-<p>The remaining of this page assumes that <code>bin</code> is on the search
path.
-If not, just prepend the <code>sis</code> command by its path (e.g. <code>./apache-sis-0.6/bin/sis</code>).</p>
+<p>The remaining of this page assumes that the <code>bin</code> directory
is on the search path.
+If not, the same examples can still be executed by replacing the <code>sis</code>
command by <code>./apache-sis-0.6/bin/sis</code>.</p>
 <h2 id="dependencies">Optional dependencies<a class="headerlink" href="#dependencies"
title="Permanent link">&para;</a></h2>
-<p>Every JAR files present in the <code>lib</code> sub-directory will be
included on the classpath during the execution of <code>sis</code> command.
-By default, the <code>lib</code> directory contains only the SIS archive. However
users can add other JAR files in that directory for
-the following optional dependencies:</p>
+<p>Every JAR files present in the <code>lib</code> sub-directory will be
included on the classpath during <code>sis</code> command execution.
+By default, the <code>lib</code> directory contains only the <code>sis.jar</code>
file.
+ However users can add other JAR files in that directory for the following optional dependencies:</p>
 <ul>
 <li>
 <p><strong>Derby driver —</strong>
@@ -148,7 +148,7 @@ the following optional dependencies:</p>
 </li>
 </ul>
 <h1 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h1>
-<p>Invoking <code>sis</code> without argument show a summary of available
commands and all options.
+<p>Invoking <code>sis</code> without argument shows a summary of available
commands and all options.
 For executing a command, the syntax is:</p>
 <div class="codehilite"><pre>sis &lt;<span class="nb">command</span>&gt;
<span class="o">[</span>options<span class="o">]</span> <span class="o">[</span>files<span
class="o">]</span>
 </pre></div>
@@ -160,7 +160,7 @@ For executing a command, the syntax is:<
   <tr><td><code>about</code></td>      <td>Show information
about Apache SIS and system configuration.</td></tr>
   <tr><td><code>mime-type</code></td>  <td>Show MIME
type for the given file.</td></tr>
   <tr><td><code>metadata</code></td>   <td>Show metadata
information for the given file.</td></tr>
-  <tr><td><code>crs</code></td>        <td>Show Coordinate
Reference System information for the given file or code.</td></tr>
+  <tr><td><code>crs</code></td>        <td>Show Coordinate
Reference System (CRS) information for the given file or code.</td></tr>
   <tr><td><code>identifier</code></td> <td>Show identifiers
for metadata and referencing systems in the given file.</td></tr>
 </table>
 
@@ -190,7 +190,7 @@ The reason is that command output may be
 <li><em>Well Known Text</em> (WKT) format version 1 and 2</li>
 <li><em>Geographic Markup Language</em> (GML) version 3.2</li>
 </ul>
-<p>The easiest way is see a CRS definition is to use an EPSG code.
+<p>The easiest way to see a CRS definition is to use an EPSG code.
 The <a href="http://www.epsg.org/">EPSG geodetic dataset</a> is a widely-used
source of definitions for thousands of Coordinate Reference Systems.
 Appache SIS provides a <a href="book/tables/CoordinateReferenceSystems.html">list of
supported codes</a>, which can be queried from the command line.
 For example the following command prints the definition of the <em>"JGD2011 / Japan
Plane Rectangular CS VIII"</em> Coordinate Reference System:</p>
@@ -230,21 +230,28 @@ However some applications are restricted
 For an output using the legacy WKT 1 format, one can add the <code>--format wkt1</code>
option to the above command.</p>
 <p>The “WKT 2” specification allows some flexibility in keyword names and
in the way to specify units of measurement.
 By default, the command-line uses this flexibility for producing less verbose but still legal
WKT 2 output.
-If an output closer to the WKT 2 recommendations is desired, one can add the <code>--format
wkt2</code> option to the above command.</p>
+If an output closer to WKT 2 recommendations is desired, one can add the <code>--format
wkt2</code> option to the above command.
+The result will be slightly more verbose.</p>
 <p>Apache SIS can also read and write CRS definitions in the <em>Geographic Markup
Language</em> (GML) format.
 For GML output, one can add the <code>--format xml</code> option to the above
command.
-Note that the result is quite verbose.</p>
+The result will be much more verbose than WKT outputs.</p>
 <h2 id="identifier">Extracting EPSG identifier from a Coordinate Reference System<a
class="headerlink" href="#identifier" title="Permanent link">&para;</a></h2>
 <p>Because the EPSG geodetic dataset is so commonly used,
-it is very common to define a CRS by only its EPSG code instead than its full definition.
-Such codes can be written as “<code>EPSG:4326</code>” or “<code>urn:ogc:def:crs:EPSG::4326</code>”
for instance.
-In a <em>Well Known Text</em> (WKT) string, the code appears at the bottom of
the definition
-in an element like <code>ID["EPSG", 4326]</code> or <code>AUTHORITY["EPSG",
"4326"]</code>.
-However in many case the code is missing.
-But Apache SIS can find it by comparing a given CRS against the definitions in the EPSG database.</p>
-<p>The following example read a WKT for the <em>“NTF (Paris) / Lambert zone
II”</em> Coordinate Reference System,
-but in which the <code>ID["EPSG", 27572]</code> has been intentionally omitted.
-Furthermore, the <em>“NTF (Paris) / Lambert zone II”</em> name has
been replaced by <em>“NTF (Paris) / zone to be discovered by the demo”</em>
+a very common practice is to specify a CRS using only its EPSG code instead than its full
definition.
+Such codes can be written in different ways. For example all the following strings are for
the same code:</p>
+<ul>
+<li><code>EPSG:4326</code></li>
+<li><code>urn:ogc:def:crs:EPSG::4326</code></li>
+<li><code>http://www​.opengis​.net/def/crs/epsg/0/4326</code>
(not yet supported on the command-line)</li>
+<li><code>http://www​.opengis​.net/gml/srs/epsg​.xml#4326</code>
(not yet supported on the command-line)</li>
+</ul>
+<p>In a <em>Well Known Text</em> (WKT) string, the code can appear at the
bottom of the definition
+in an optional element like <code>ID["EPSG", 4326]</code> or <code>AUTHORITY["EPSG",
"4326"]</code>.
+However in many cases the code is missing.
+Sometime Apache SIS can find a missing code by comparing a given CRS against the definitions
in the EPSG database.</p>
+<p>The following example reads a WKT for the <em>“NTF (Paris) / Lambert
zone II”</em> Coordinate Reference System,
+but in which the <code>ID["EPSG", 27572]</code> element has been intentionally
omitted.
+Furthermore, the <em>“NTF (Paris) / Lambert zone II”</em> name has
been replaced by <em>“NTF (Paris) / zone to be discovered by the demo”</em>
name.
 Executing the following command:</p>
 <div class="codehilite"><pre>sis identifier http://sis.staging.apache.org/examples/MissingIdentifier.wkt
 </pre></div>
@@ -275,7 +282,7 @@ Legend:
 
 <p>Apache SIS can perform such analysis because it “understands” the CRS
definition.
 This analysis capability can be tested by altering the CRS definition.
-The following example asks the identifier of a CRS which is normally defined as below:</p>
+The next example asks the identifier of a CRS which is normally defined as below:</p>
 <div class="codehilite"><pre>ProjectedCRS[&quot;WGS 84 / Mercator 41&quot;,
   (... definition omitted for brevity ...)
     Method[&quot;Mercator (variant B)&quot;],
@@ -304,8 +311,10 @@ The following example asks the identifie
 </pre></div>
 
 
-<p>Apache SIS has been able to detect that the second CRS is numerically equivalent
to the first one,
-and return the identifier for the CRS that we should use.</p>
+<p>In above example, Apache SIS used the fact that a
+<em>“Mercator (variant A)”</em> projection with a <em>“Scale
factor at natural origin”</em> parameter value of 0.755799… on the WGS84 datum
is numerically equivalent to a
+<em>“Mercator (variant B)”</em> projection with a <em>“Latitude
of 1st standard parallel”</em> parameter value of 41° on the same datum.
+This recognition allowed SIS to return the EPSG:3994 code even if it stands for a CRS defined
as a <em>“Mercator (variant B)”</em> projection rather than variant
A.</p>
 <h2 id="metadata">Extracting ISO 19115 Metadata<a class="headerlink" href="#metadata"
title="Permanent link">&para;</a></h2>
 <p>SIS can read the header of a data file and print the metadata in an ISO 19115 structure.
 The data file given in argument can be a local file or a URL.
@@ -361,8 +370,9 @@ As of SIS 0.6, only CF-compliant NetCDF
 The output is not shown in this page because of its verbosity.</p>
 <h1 id="performance">Performance consideration<a class="headerlink" href="#performance"
title="Permanent link">&para;</a></h1>
 <p>If there is a large amount of files to process, invoking the above command many
time may be inefficient
-since it would restart a new JVM on every invocation. For such cases, it is more efficient
to loop inside
-a small Java program using the <a href="apidocs/index.html">SIS API</a>.</p>
+since it would restart a new JVM on every invocation.
+If the operation requires the EPSG dataset, booting the Derby database also has a significant
cost.
+For such cases, it is more efficient to loop inside a small Java program using the <a
href="apidocs/index.html">SIS API</a>.</p>
             </article>
           </section>
         </div><!--/span-->



Mime
View raw message