[Liblas-commits] hg: some doc work

liblas-commits at liblas.org liblas-commits at liblas.org
Thu Oct 28 16:23:37 EDT 2010


changeset 1113f11e04c3 in /Volumes/Data/www/liblas.org/hg
details: http://hg.liblas.orghg?cmd=changeset;node=1113f11e04c3
summary: some doc work

diffstat:

 doc/compilation.txt       |   6 ++--
 doc/docs.txt              |   1 +
 doc/download.txt          |  21 +++++++++++++---
 doc/faq.txt               |  23 ++++++++---------
 doc/features.txt          |  12 ++++----
 doc/index.txt             |   3 +-
 doc/osgeo4w.txt           |  11 ++++++++
 doc/start.txt             |  58 +++++++++++++++++++++++++++++++++++++++++++++++
 doc/utilities/las2las.txt |   6 ++++-
 doc/utilities/lasinfo.txt |  10 ++++++-
 10 files changed, 122 insertions(+), 29 deletions(-)

diffs (truncated from 301 to 300 lines):

diff -r 9178ecb2d62e -r 1113f11e04c3 doc/compilation.txt
--- a/doc/compilation.txt	Thu Oct 28 13:59:42 2010 -0500
+++ b/doc/compilation.txt	Thu Oct 28 15:23:28 2010 -0500
@@ -15,8 +15,8 @@
 :Contact: hobu.inc at gmail dot com
 
 .. warning::
-    This document is only for the un-released 1.6 libLAS release.  Unfortunately,
-    there is no documentation for building libLAS 1.2.1 at this time, though 
+    This document is only for the 1.6 libLAS release.  Unfortunately,
+    there is no documentation for building earlier libLAS releases at this time, though 
     it is a straightforward `Autoconf`_ setup for unix and nmake files for 
     windows.
     
@@ -54,7 +54,7 @@
 * MSVC 2010
 * GCC 4.0
 * GCC 4.2
-* LLVM 4.2
+* LLVM 4.8/Clang 2.8
 
 `Boost`_
 ------------------------------------------------------------------------------
diff -r 9178ecb2d62e -r 1113f11e04c3 doc/docs.txt
--- a/doc/docs.txt	Thu Oct 28 13:59:42 2010 -0500
+++ b/doc/docs.txt	Thu Oct 28 15:23:28 2010 -0500
@@ -17,6 +17,7 @@
 .. toctree::
    :maxdepth: 2
    
+   start
    compilation
    tutorial/index
    faq
diff -r 9178ecb2d62e -r 1113f11e04c3 doc/download.txt
--- a/doc/download.txt	Thu Oct 28 13:59:42 2010 -0500
+++ b/doc/download.txt	Thu Oct 28 15:23:28 2010 -0500
@@ -16,7 +16,7 @@
   - `libLAS-1.6.0b1-src.zip <http://trac.liblas.org/raw-attachment/wiki/1.6.0b1/libLAS-1.6.0b1.zip>`_ 
     `(md5) <http://trac.liblas.org/raw-attachment/wiki/1.6.0b1/libLAS-1.6.0b1.zip.md5>`__
 
-  - `Release Notes <http://trac.liblas.org/wiki/1.2.1>`__
+  - `Release Notes <http://trac.liblas.org/wiki/1.6.0b1>`__
 
 .. _`libLAS-1.6.0b1-src.tar.gz`: http://trac.liblas.org/raw-attachment/wiki/1.6.0b1/libLAS-1.6.0b1.tar.gz
 
@@ -26,7 +26,11 @@
 .. seealso::
     A `sample library <http://liblas.org/samples>`__ is also available to provide 
     data to test your tools.
-    
+
+.. seealso::
+    See :ref:`start` for information 
+    how to get started using the tools once they are installed.
+
 
 Past Releases
 ------------------------------------------------------------------------------
@@ -76,6 +80,8 @@
    :alt: PDF icon
    :target: /libLAS.pdf
 
+
+
 Binaries
 ------------------------------------------------------------------------------
 
@@ -91,8 +97,15 @@
     GDAL/OGR, GRASS, MapServer, OpenEV, uDig, as well as many other packages
     (about 70 as of summer 2008).
     
-    Obtain `OSGeo4W`_ and select the libLAS package to install. GDAL support
-    is only provided with the `OSGeo4W`_ package, however.
+    .. note::
+        OSGeo4W is the preferred and only supported way to get a binary 
+        of libLAS as of the 1.6 release.  The OSGeo4W libLAS build contains 
+        a fully-featured set of utilities including support for GDAL, 
+        :ref:`las2oci <las2oci>`, and reprojection.  
+    
+    .. seealso::
+        :ref:`osgeo4w_install` contains information how to install and configure 
+        your OSGeo4W build to utilize libLAS.  
 
     
 .. _`OSGeo4W`: http://trac.osgeo.org/osgeo4w/
diff -r 9178ecb2d62e -r 1113f11e04c3 doc/faq.txt
--- a/doc/faq.txt	Thu Oct 28 13:59:42 2010 -0500
+++ b/doc/faq.txt	Thu Oct 28 15:23:28 2010 -0500
@@ -11,17 +11,17 @@
 What software is using libLAS?
 --------------------------------------------------------------------------------
 
-A number of commercial and open source softwares utilize libLAS for their 
-LAS reading and writing support.  Additionally, a number of organizations 
-also use libLAS for a variety of tasks.  See `here <http://trac.liblas.org/wiki/WhoUsesLibLAS>`__ 
-for more details.
+A number of commercial and open source softwares utilize libLAS for their LAS
+reading and writing support. Additionally, a number of organizations also use
+libLAS for a variety of tasks. See `here
+<http://trac.liblas.org/wiki/WhoUsesLibLAS>`__ for more details.
 
 What software supports ASPRS LAS Format?
 --------------------------------------------------------------------------------
 
 There is a number of geospatial software packages that support read/write of
-ASPRS LAS Format. Popular software is listed on the `Software <http://trac.liblas.org/wiki/Software>`__ Wiki
-page.
+ASPRS LAS Format. Popular software is listed on the `Software
+<http://trac.liblas.org/wiki/Software>`__ Wiki page.
 
 
 How does ASPRS LAS Format handle endianness?
@@ -45,19 +45,18 @@
 Does libLAS support LAS 1.3?
 --------------------------------------------------------------------------------
 
-Not at this time.  Waveform data and software models to support waveform 
-models within libLAS have not yet been developed.  It is planned that the 
-1.6 of libLAS will include support for reading point data from LAS 1.3 
-files, but waveform data will not be supported.
+Not at this time. Waveform data and software models to support waveform models
+within libLAS have not yet been developed. libLAS 1.6 supports reading point
+data from LAS 1.3 files, but waveform data is not supported.
 
 How can I remove points classified as ground from LAS files?
 --------------------------------------------------------------------------------
 
-Use the :ref:`las2las` utility to generate a new file with the 
+Use the :ref:`las2las <las2las>` utility to generate a new file with the 
 points removed::
 
    
-    las2las -i input.las -o output.las --eliminate_class 2
+    las2las input.las output.las --drop-classes 2
 
 How can I get past the linking error when building svn trunk on OS X 10.4?
 --------------------------------------------------------------------------------
diff -r 9178ecb2d62e -r 1113f11e04c3 doc/features.txt
--- a/doc/features.txt	Thu Oct 28 13:59:42 2010 -0500
+++ b/doc/features.txt	Thu Oct 28 15:23:28 2010 -0500
@@ -22,12 +22,12 @@
 Spatial Reference System Support
 ..............................................................................
 
-Linked against a 1.2.5+ version of `libgeotiff`_, you can set and get the spatial reference 
-systems of LAS files using simple `proj.4`_ coordinate system definitions.  
-Alternatively, with libLAS 1.2, you can link against `GDAL`_ to be able to 
-manipulate spatial references using `OGC WKT`_.  The current development version of 
-libLAS can be used in combination with `GDAL`_ 1.7 to support `vertical coordinate systems`_ 
-as well.
+Linked against a 1.2.5+ version of `libgeotiff`_, you can set and get the
+spatial reference systems of LAS files using simple `proj.4`_ coordinate
+system definitions. Alternatively, with libLAS 1.2, you can link against
+`GDAL`_ to be able to manipulate spatial references using `OGC WKT`_. Version
+1.6 or greater of libLAS can be used in combination with `GDAL`_ 1.8+ to
+support `vertical coordinate systems`_ as well.
 
 Simple Variable Length Record Abstraction
 ..............................................................................
diff -r 9178ecb2d62e -r 1113f11e04c3 doc/index.txt
--- a/doc/index.txt	Thu Oct 28 13:59:42 2010 -0500
+++ b/doc/index.txt	Thu Oct 28 15:23:28 2010 -0500
@@ -9,7 +9,8 @@
 `LiDAR`_ format. The `ASPRS LAS format`_ is a sequential binary format used to
 store data from LiDAR sensors and by LiDAR processing software for data
 interchange and archival.  See :ref:`features` for more details on what 
-libLAS can provide a LiDAR software developer.
+libLAS can provide a LiDAR software developer.  See :ref:`start` for how to 
+get started using the library.
 
 libLAS' initial development was supported in 2007-2008 by the `IGSB`_ of the
 Iowa DNR for use in its state-wide `LIDAR`_ project.  Ongoing support for 
diff -r 9178ecb2d62e -r 1113f11e04c3 doc/osgeo4w.txt
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/osgeo4w.txt	Thu Oct 28 15:23:28 2010 -0500
@@ -0,0 +1,11 @@
+.. _osgeo4w_install:
+
+******************************************************************************
+Installing libLAS using OSGeo4W
+******************************************************************************
+
+
+:Author: Howard Butler
+:Contact: hobu.inc at gmail dot com
+
+.. _`OSGeo4W`: http://trac.osgeo.org/osgeo4w/
diff -r 9178ecb2d62e -r 1113f11e04c3 doc/start.txt
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/start.txt	Thu Oct 28 15:23:28 2010 -0500
@@ -0,0 +1,58 @@
+.. _start:
+
+******************************************************************************
+Getting Started with libLAS
+******************************************************************************
+
+.. contents::
+    :depth: 3
+    :backlinks: none
+
+
+
+:Author: Howard Butler
+:Contact: hobu.inc at gmail dot com
+
+    
+Overview
+------------------------------------------------------------------------------
+
+libLAS is two things: a library for embedding read and write support of the 
+ASPRS LAS format into your own C/C++ applications, and a suite of command-line 
+utilities based on :ref:`LASTools <lastools_liblas>` for inspecting, manipulating, 
+transforming, and processing LAS LiDAR data.
+
+This document is an entry point into the world of libLAS, and will give a 
+general overview of the types of operations you can do with the :ref:`libLAS utilities <utilities>` 
+as well as point you to other information for developing your own applications 
+with libLAS.  
+
+Installation
+------------------------------------------------------------------------------
+
+:ref:`download` contains the canonical location for obtaining libLAS in 
+both source and binary forms.  
+
+Windows
+..............................................................................
+
+:ref:`osgeo4w_install` contains information how to install libLAS on Windows.  
+
+Compilation
+..............................................................................
+
+:ref:`compilation` shows how to compile libLAS for your own use on Windows,
+Mac OSX, and Linux. 
+    
+    
+.. _`CMake`: http://www.cmake.org/
+.. _`CTest`: http://cmake.org/cmake/help/ctest-2-8-docs.html
+.. _`CMake 2.8.0+`: http://www.cmake.org/cmake/help/cmake-2-8-docs.html
+.. _`CDash`: http://www.cdash.org/
+.. _`continuous integration`: http://en.wikipedia.org/wiki/Continuous_integration
+.. _`libLAS CDash`: http://my.cdash.org/index.php?project=libLAS
+.. _`Curses`: http://en.wikipedia.org/wiki/Curses_%28programming_library%29
+.. _`Autoconf`: http://www.gnu.org/software/autoconf/
+.. _`LLVM`: http://llvm.org/
+.. _`OSGeo4W`: http://trac.osgeo.org/osgeo4w/
+.. _`Boost`: http://www.boost.org/
\ No newline at end of file
diff -r 9178ecb2d62e -r 1113f11e04c3 doc/utilities/las2las.txt
--- a/doc/utilities/las2las.txt	Thu Oct 28 13:59:42 2010 -0500
+++ b/doc/utilities/las2las.txt	Thu Oct 28 15:23:28 2010 -0500
@@ -39,7 +39,11 @@
 
 :ref:`las2las <las2las>` started a port of Martin Isenburg's :ref:`las2las` utility from `LASTools`_ 
 to the libLAS library.  It is much-improved from his version, however, and 
-provides a number of additional capabilities.
+provides a number of additional capabilities. 
+
+.. seealso::
+    :ref:`lastools_liblas` contains background information on the port of 
+    Isenburg and Shewchuck's utilities to the libLAS library.
 
 * Text output describing the operation(s) is only provided when the --verbose (-v)
   switch is provided.  Errors are reported to stderr.
diff -r 9178ecb2d62e -r 1113f11e04c3 doc/utilities/lasinfo.txt
--- a/doc/utilities/lasinfo.txt	Thu Oct 28 13:59:42 2010 -0500
+++ b/doc/utilities/lasinfo.txt	Thu Oct 28 15:23:28 2010 -0500
@@ -12,7 +12,7 @@
 ::
 
     --------------------------------------------------------------------
-        lasinfo2 (libLAS 1.6.0 with GeoTIFF 1.3.0 GDAL 1.8dev)
+        lasinfo (libLAS 1.6.0 with GeoTIFF 1.3.0 GDAL 1.8dev)
     --------------------------------------------------------------------
 
     lasinfo2 options:
@@ -22,7 +22,8 @@
       --no-vlrs             Don't show VLRs
       --no-schema           Don't show schema
       --no-check            Don't scan points
-      --xml                 Output summary as XML
+      --xml                 Output XML
+      -p [ --point ] arg    Display a point with a given id.  --point 44
 
     Filtering options:
       -e [ --extent ] arg    Extent window that points must fall within to keep.
@@ -87,6 +88,11 @@
                              Define colors as two 3-tuples (R,G,B-R,G,B):  
                              --drop-color '255,255,255-65536,65536,65536'
 
+    For more information, see the full documentation for lasinfo2 at:
+     http://liblas.org/utilities/lasinfo2.html
+    ----------------------------------------------------------
+
+
 
 Example data


More information about the Liblas-commits mailing list