[Liblas-commits] r1159 - trunk/doc

liblas-commits at liblas.org liblas-commits at liblas.org
Mon Mar 30 14:18:19 EDT 2009


Author: hobu
Date: Mon Mar 30 14:18:18 2009
New Revision: 1159
URL: http://liblas.org/changeset/1159

Log:
doc updates

Modified:
   trunk/doc/index.txt
   trunk/doc/las2las.txt
   trunk/doc/las2ogr.txt
   trunk/doc/las2txt.txt
   trunk/doc/lasdiff.txt
   trunk/doc/lasinfo.txt
   trunk/doc/lasmerge.txt
   trunk/doc/txt2las.txt

Modified: trunk/doc/index.txt
==============================================================================
--- trunk/doc/index.txt	(original)
+++ trunk/doc/index.txt	Mon Mar 30 14:18:18 2009
@@ -9,9 +9,16 @@
 Contents:
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    
    lasinfo
+   las2las
+   las2txt
+   lasmerge
+   lasdiff
+   las2ogr
+   txt2las
+   
 
 Indices and tables
 ==================

Modified: trunk/doc/las2las.txt
==============================================================================
--- trunk/doc/las2las.txt	(original)
+++ trunk/doc/las2las.txt	Mon Mar 30 14:18:18 2009
@@ -1,5 +1,7 @@
+.. _las2las:
+
 ****************************************************************
-  las2las: converts from binary LAS to binary LAS
+  las2las
 ****************************************************************
 
 :Author: Martin Isenburg
@@ -9,8 +11,6 @@
 :Revision: $Revision$
 :Date: $Date$
 
-.. sectnum::
-
 .. contents::
     :depth: 3
     :backlinks: top
@@ -18,11 +18,11 @@
 Description
 -----------
 
-`las2las` reads and writes LiDAR data in the ASPRS LAS 1.0 and 1.1 formats while 
+:ref:`las2las` reads and writes LiDAR data in the ASPRS LAS 1.0 and 1.1 formats while 
 modifying its contents. While `lasinfo` can do a few simple operations like 
 updating header information, more drastic changes, like removing points or 
-altering values, will require `las2las`.  `las2las` is expected to be used for 
-modifying single files at a time, and all `las2las` operations require multiple 
+altering values, will require :ref:`las2las`.  :ref:`las2las` is expected to be used for 
+modifying single files at a time, and all :ref:`las2las` operations require multiple 
 read passes through the points.   Some examples of operations `las2las` can be 
 used for include:
 
@@ -37,7 +37,7 @@
 * changing the format from LAS 1.0 to 1.1 or vice versa
 * eliminating points of a given classification (--eliminate class 2)
 
-`las2las` is a port of Martin Isenburg's `las2las` utility from `LASTools`_ 
+:ref:`las2las` is a port of Martin Isenburg's :ref:`las2las` utility from `LASTools`_ 
 to the libLAS library.  For the most part, it is unchanged from Martin's 
 utility except for a few differences:
 

Modified: trunk/doc/las2ogr.txt
==============================================================================
--- trunk/doc/las2ogr.txt	(original)
+++ trunk/doc/las2ogr.txt	Mon Mar 30 14:18:18 2009
@@ -1,5 +1,7 @@
+.. _las2ogr:
+
 ****************************************************************
-  las2ogr: converts from binary LAS to one of OGR formats
+  las2ogr
 ****************************************************************
 
 :Author: Mateusz Loskot
@@ -7,8 +9,6 @@
 :Revision: $Revision$
 :Date: $Date$
 
-.. sectnum::
-
 .. contents::
     :depth: 3
     :backlinks: top

Modified: trunk/doc/las2txt.txt
==============================================================================
--- trunk/doc/las2txt.txt	(original)
+++ trunk/doc/las2txt.txt	Mon Mar 30 14:18:18 2009
@@ -1,20 +1,96 @@
-****************************************************************
-  las2txt: converts from binary LAS to a standard ASCII format
-****************************************************************
+.. _las2txt:
+
+******************************************************************************
+  las2txt
+******************************************************************************
 
 :Author: Martin Isenburg
 :Contact: isenburg at cs.unc.edu
+:Author: Howard Butler
+:Contact: hobu.inc at gmail.com
 :Revision: $Revision$
 :Date: $Date$
 
-.. sectnum::
-
 .. contents::
     :depth: 3
     :backlinks: top
 
+Description
+==============================================================================
+
+:ref:`las2txt` allows you to output ASRPS LAS files into ASCII text.
+
+Usage
+==============================================================================
+
+::
+
+    C:\lastools\bin>las2txt -h
+    usage:
+    las2txt lidar.las
+    las2txt -parse xyziar lidar.las lidar.txt
+    las2txt -i lidar.las -o lidar.laz -parse xyz
+    las2txt -parse xyzt -verbose lidar.las
+    las2txt -parse xyz lidar.las.gz
+    las2txt -h
+
+The '-parse txyz' flag specifies how to format each each line of the ASCII 
+file. For example, 'txyzia' means that the first number of each line should 
+be the gpstime, the next three numbers should be the x, y, and z coordinate, 
+the next number should be the intensity and the next number should be the 
+scan angle.
+
+Supported entries
+------------------------------------------------------------------------------
+
+* a - scan angle
+* i - intensity,
+* n - number of returns for given pulse
+* r - number of this return
+* c - classification 
+* u - user data
+* p - point source ID
+* e - edge of flight line flag
+* d - direction of scan flag 
+* R - red channel of RGB color
+* G - green channel of RGB color
+* B - blue channel of RGB color
+* M - vertex index number
+ 
+Separators
+------------------------------------------------------------------------------
+
+The '-sep space' flag specifies what separator to use. The default is a 
+space.  The following list is valid for separator characters (case sensitive):
+
+* tab
+* comma
+* colon
+* hyphen
+* dot
+* semicolon
+
+Header Separators
+------------------------------------------------------------------------------
+
+The '-header pound' flag results in the header information being printed at 
+the beginning of the ASCII file in form of a comment that starts with the 
+special character '#'. Other possible special characters include (case sensitive):
+
+* percent
+* dollar
+* semicolon
+* comma
+* star
+* colon
+* semicolon
+
+
+Examples
+==============================================================================
+
 Simple conversion to text file
-------------------------------
+------------------------------------------------------------------------------
 
 ::
 
@@ -22,10 +98,10 @@
 
 converts LAS file to ASCII and places the x, y, and z coordinate
 of each point at the 1st, 2nd, and 3rd entry of each line. the
-entries are seperated by a space.
+entries are separated by a space.
 
 Specifying a separator
-----------------------
+------------------------------------------------------------------------------
 
 ::
 
@@ -36,8 +112,8 @@
 and the number of the return as the 5th entry of each line. the
 entries are separated by a komma.
 
-Altering the header separtor
-----------------------------
+Altering the header separator
+------------------------------------------------------------------------------
 
 ::
 
@@ -45,12 +121,12 @@
 
 converts LAS file to ASCII and places the x, y, and z coordinate
 at the 1st, 2nd, and 3rd entry, the intensity at the 4th and the
-scan angle as the 5th entry of each line. the entries are separated
+scan angle as the 5th entry of each line. The entries are separated
 by a semicolon. at the beginning of the file we print the header
 information as a comment starting with a '#' symbol.
 
 Altering the coordinate order
------------------------------
+------------------------------------------------------------------------------
 
 ::
 
@@ -61,51 +137,3 @@
 the user data as the 5th entry of each line. the entries are
 separated by a semicolon. at the beginning of the file we print
 the header information as a comment starting with a '%' symbol.
-
-Usage
------
-
-::
-
-    C:\lastools\bin>las2txt -h
-    usage:
-    las2txt lidar.las
-    las2txt -parse xyziar lidar.las lidar.txt
-    las2txt -i lidar.las -o lidar.laz -parse xyz
-    las2txt -parse xyzt -verbose lidar.las
-    las2txt -parse xyz lidar.las.gz
-    las2txt -h
-
-The '-parse txyz' flag specifies how to format each each line of the ASCII 
-file. For example, 'txyzia' means that the first number of each line should 
-be the gpstime, the next three numbers should be the x, y, and z coordinate, 
-the next number should be the intensity and the next number should be the 
-scan angle.
-
-Supported entries
-~~~~~~~~~~~~~~~~~
-
- * a - scan angle
- * i - intensity,
- * n - number of returns for given pulse
- * r - number of this return
- * c - classification 
- * u - user data
- * p - point source ID
- * e - edge of flight line flag
- * d - direction of scan flag 
- 
-Separators
-~~~~~~~~~~
-
-The '-sep space' flag specifies what separator to use. The default is a 
-space but 'tab', 'komma', 'colon', 'hyphen', 'dot', or 'semicolon' 
-are other possibilities.
-
-Header Separators
-~~~~~~~~~~~~~~~~~
-The '-header pound' flag results in the header information being printed at 
-the beginning of the ASCII file in form of a comment that starts with the 
-special character '#'. Also possible are 'percent', 'dollar', 'semicolon', 
-'komma', 'star', 'colon', or 'semicolon' as that special character.
-

Modified: trunk/doc/lasdiff.txt
==============================================================================
--- trunk/doc/lasdiff.txt	(original)
+++ trunk/doc/lasdiff.txt	Mon Mar 30 14:18:18 2009
@@ -1,5 +1,5 @@
 ****************************************************************
-  lasdiff: comparison of LAS files
+  lasdiff
 ****************************************************************
 
 :Author: Martin Isenburg
@@ -7,8 +7,6 @@
 :Revision: $Revision$
 :Date: $Date$
 
-.. sectnum::
-
 .. contents::
     :depth: 3
     :backlinks: top

Modified: trunk/doc/lasinfo.txt
==============================================================================
--- trunk/doc/lasinfo.txt	(original)
+++ trunk/doc/lasinfo.txt	Mon Mar 30 14:18:18 2009
@@ -1,5 +1,5 @@
 ****************************************************************
-  lasinfo: a utility for inspecting LAS files
+  lasinfo
 ****************************************************************
 
 :Author: Martin Isenburg
@@ -9,8 +9,6 @@
 :Revision: $Revision$
 :Date: $Date$
 
-.. sectnum::
-
 .. contents::
     :depth: 3
     :backlinks: top

Modified: trunk/doc/lasmerge.txt
==============================================================================
--- trunk/doc/lasmerge.txt	(original)
+++ trunk/doc/lasmerge.txt	Mon Mar 30 14:18:18 2009
@@ -7,8 +7,6 @@
 :Revision: $Revision$
 :Date: $Date$
 
-.. sectnum::
-
 .. contents::
     :depth: 3
     :backlinks: top

Modified: trunk/doc/txt2las.txt
==============================================================================
--- trunk/doc/txt2las.txt	(original)
+++ trunk/doc/txt2las.txt	Mon Mar 30 14:18:18 2009
@@ -1,5 +1,6 @@
+.. _txt2las
 ****************************************************************
-  las2txt: converts from standard ASCII to LAS
+  txt2las
 ****************************************************************
 
 :Author: Martin Isenburg
@@ -7,8 +8,6 @@
 :Revision: $Revision$
 :Date: $Date$
 
-.. sectnum::
-
 .. contents::
     :depth: 3
     :backlinks: top


More information about the Liblas-commits mailing list