[Liblas-commits] hg: more doc work
liblas-commits at liblas.org
liblas-commits at liblas.org
Thu Apr 1 15:20:21 EDT 2010
changeset 59eba98aa75c in /Volumes/Data/www/liblas.org/hg
details: http://hg.liblas.orghg?cmd=changeset;node=59eba98aa75c
summary: more doc work
diffstat:
.hgignore | 3 +
doc/Makefile | 5 +
doc/api/doxygen.conf | 2 +-
doc/conf.py | 41 +----
doc/index.txt | 9 +-
doc/las2las.txt | 157 ------------------------
doc/las2ogr.txt | 49 -------
doc/las2txt.txt | 132 --------------------
doc/lasdiff.txt | 26 ----
doc/lasinfo.txt | 142 ----------------------
doc/lasmerge.txt | 74 -----------
doc/python/classes.txt | 12 +
doc/python/index.txt | 12 +
doc/python/tutorial.txt | 221 +++++++++++++++++++++++++++++++++++
doc/styles/liblas-color-pallette.css | 32 +++++
doc/txt2las.txt | 79 ------------
doc/utilities/index.txt | 16 ++
doc/utilities/las2las.txt | 162 +++++++++++++++++++++++++
doc/utilities/las2ogr.txt | 52 ++++++++
doc/utilities/las2txt.txt | 141 ++++++++++++++++++++++
doc/utilities/lasdiff.txt | 30 ++++
doc/utilities/lasinfo.txt | 148 +++++++++++++++++++++++
doc/utilities/lasmerge.txt | 78 ++++++++++++
doc/utilities/txt2las.txt | 85 +++++++++++++
python/liblas/point.py | 46 +-------
25 files changed, 1012 insertions(+), 742 deletions(-)
diffs (truncated from 1945 to 300 lines):
diff -r 3cd20fe36a22 -r 59eba98aa75c .hgignore
--- a/.hgignore Wed Mar 31 21:38:18 2010 -0500
+++ b/.hgignore Thu Apr 01 14:14:47 2010 -0500
@@ -85,4 +85,7 @@
buildout/develop-eggs
buildout/doc
buildout/man
+doc/build
+doc/api/xml
+doc/api/html
*.mshark
diff -r 3cd20fe36a22 -r 59eba98aa75c doc/Makefile
--- a/doc/Makefile Wed Mar 31 21:38:18 2010 -0500
+++ b/doc/Makefile Thu Apr 01 14:14:47 2010 -0500
@@ -49,6 +49,11 @@
@echo
@echo "Build finished; now you can process the JSON files."
+pdf:
+ $(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) build/pdf
+ @echo
+ @echo "Build finished; now you can process the PDF files."
+
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
@echo
diff -r 3cd20fe36a22 -r 59eba98aa75c doc/api/doxygen.conf
--- a/doc/api/doxygen.conf Wed Mar 31 21:38:18 2010 -0500
+++ b/doc/api/doxygen.conf Thu Apr 01 14:14:47 2010 -0500
@@ -910,7 +910,7 @@
# generate an XML file that captures the structure of
# the code including all documentation.
-GENERATE_XML = NO
+GENERATE_XML = YES
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
diff -r 3cd20fe36a22 -r 59eba98aa75c doc/conf.py
--- a/doc/conf.py Wed Mar 31 21:38:18 2010 -0500
+++ b/doc/conf.py Thu Apr 01 14:14:47 2010 -0500
@@ -16,13 +16,13 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.append(os.path.abspath('.'))
+sys.path.append(os.path.abspath('../python'))
# -- General configuration -----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.ifconfig']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'rst2pdf.pdfbuilder', 'breathe']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['templates']
@@ -38,7 +38,7 @@
# General information about the project.
project = u'libLAS'
-copyright = u'2009, Howard Butler'
+copyright = u'2010, Howard Butler'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -161,38 +161,19 @@
htmlhelp_basename = 'libLASdoc'
-# -- Options for LaTeX output --------------------------------------------------
+breathe_projects = {
+ "class":"./api/xml"
+ }
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+breathe_default_project = "class"
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
- ('index', 'libLAS.tex', u'libLAS Documentation',
- u'Howard Butler', 'manual'),
+pdf_documents = [
+ ('index', u'libLAS', u'libLAS Documentation', u'The libLAS Team'),
]
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_use_modindex = True
-
+# A comma-separated list of custom stylesheets. Example:
+pdf_stylesheets = ['sphinx','kerning','a4']
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
diff -r 3cd20fe36a22 -r 59eba98aa75c doc/index.txt
--- a/doc/index.txt Wed Mar 31 21:38:18 2010 -0500
+++ b/doc/index.txt Thu Apr 01 14:14:47 2010 -0500
@@ -11,13 +11,8 @@
.. toctree::
:maxdepth: 1
- lasinfo
- las2las
- las2txt
- lasmerge
- lasdiff
- las2ogr
- txt2las
+ utilities/index
+ python/index
Indices and tables
diff -r 3cd20fe36a22 -r 59eba98aa75c doc/las2las.txt
--- a/doc/las2las.txt Wed Mar 31 21:38:18 2010 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,160 +0,0 @@
-.. _las2las:
-
-****************************************************************
- las2las
-****************************************************************
-
-:Author: Martin Isenburg
-:Contact: isenburg at cs.unc.edu
-:Author: Howard Butler
-:Contact: hobu.inc at gmail.com
-:Revision: $Revision$
-:Date: $Date$
-
-.. contents::
- :depth: 3
- :backlinks: top
-
-Description
------------
-
-: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 :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:
-
-* clipping of points to those that lie within a certain region specified
- by a bounding box (--clip)
-* eliminating points that are the second return (--eliminate_return 2),
-* eliminating points that have a scan angle
- above some threshold (--eliminate_scan_angle_above 5)
-* eliminating points that have an intensity below some
- threshold (--eliminate_intensity_below 15)
-* extracting only first (--first-only) or last (--last-only) returns
-* changing the format from LAS 1.0 to 1.1 or vice versa
-* eliminating points of a given classification (--eliminate class 2)
-
-: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:
-
-* Text output describing the operation(s) is only provided when the --verbose
- switch is provided.
-
-* Provides some point validation
-
-* Variable Length Records (VLRs) are carried forward by default.
-
-* Supports format (1.1->1.0 & 1.0->1.1) conversion.
-
-* GNU-style arguments and switches (although most of the switches used by
- Martin's utilities should continue to work).
-
-Usage
------
-
-Clipping with a rectangle
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ las2las --input in.las --output out.las --clip 63025000 483450000 63050000 483475000
-
-clips points of in.las with x<63025000 or y<483450000 or x>63050000
-or y>483475000 and stores surviving points to out.las. Note that
-clip expects the scaled integer values that the points are stored
-with (not the floating point coordinates they represent).
-
-Eliminating specified returns
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ las2las --input in.las --output out.las --eliminate_return 1
-
-eliminates all points of in.las that are designated first returns by the
-value in their return_number field and stores surviving points to out.las.
-
-Limiting based on scan angle
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ las2las --input in.las --output out.las --eliminate_scan_angle_above 15
-
-eliminates all points of in.las whose scan angle is above 15 or below -15
-and stores surviving points to out.las.
-
-Limiting based on intensity
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ las2las --input in.las --output out.las --eliminate_intensity_below 1000
-
-eliminates all points of in.las whose intensity is below 1000 and stores
-surviving points to out.las.
-
-Extract last returns
-~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ las2las --input in.las --output out.las --last_only
-
-extracts all last return points from in.las and stores them to out.las.
-
-Throw out invalid data
-~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ las2las --input in.las --output out.las --skip_invalid
-
-removes invalid (according to the ASPRS LAS file format specification) points.
-This switch should only be required in a few special circumstances.
-
-Eliminate ground points
-~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ las2las --input in.las --output out.las --eliminate_class 2
-
-removes points with that have a classification of 2. Points with a
-classification of 2 are conventionally called ground points, but that convention
-may not be followed for older LAS 1.0 files.
-
-Convert to 1.1
-~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ las2las --input in.las --output out.las --format 1.1
-
-converts the in.las file to a 1.1-formatted file. For the most part, this
-conversion is "in name only." For example,
-
-
-
-
-Usage
------
-
-::
-
- C:\lastools\bin>las2las -h
- usage:
- las2las -remove_extra_header in.las out.las
- las2las -i in.las -clip 63000000 483450000 63050000 483500000 -o out.las
- las2las -i in.las -eliminate_return 2 -o out.las
- las2las -i in.las -eliminate_scan_angle_above 15 -o out.las
- las2las -i in.las -eliminate_intensity_below 1000 -olas > out.las
- las2las -i in.las -first_only -clip 63000000 483450000 63050000 483500000 -o out.las
- las2las -i in.las -last_only -eliminate_intensity_below 2000 -olas > out.las
- las2las -h
-
-.. _`LAStools`: http://www.cs.unc.edu/~isenburg/lastools/
\ No newline at end of file
diff -r 3cd20fe36a22 -r 59eba98aa75c doc/las2ogr.txt
--- a/doc/las2ogr.txt Wed Mar 31 21:38:18 2010 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
More information about the Liblas-commits
mailing list