From b77d09e565cb64aab3202f5970abf4575a318463 Mon Sep 17 00:00:00 2001 From: Andrew Bell Date: Wed, 6 Apr 2016 17:18:42 -0500 Subject: [PATCH] Update tindex docs. Make --tindex option in tindex kernel a positional option. Close #1220 --- RELEASENOTES.txt | 4 ++++ doc/apps.rst | 25 ++++++++++++------------- kernels/tindex/TIndexKernel.cpp | 2 +- 3 files changed, 17 insertions(+), 14 deletions(-) diff --git a/RELEASENOTES.txt b/RELEASENOTES.txt index 59651fb3ce..8f96760faa 100644 --- a/RELEASENOTES.txt +++ b/RELEASENOTES.txt @@ -12,6 +12,10 @@ Fixes: - A failure that may have resulted when using filters.hexbin to calculate density in the southern hemisphere has been corrected. +- A failure to create the index file with 'pdal tindex' and GDAL 2.X has + been fixed. +- The '--tindex' option for the 'pdal tindex' command is now a positional + option as specified in the documentation. 1.2.0: diff --git a/doc/apps.rst b/doc/apps.rst index 558efcae85..a0a6b65e90 100644 --- a/doc/apps.rst +++ b/doc/apps.rst @@ -508,10 +508,6 @@ tindex command The ``tindex`` command is used to create a `GDAL`_-style tile index for PDAL-readable point cloud types (see `gdaltindex`_). -.. note:: - - The ``tindex`` command is only available when PDAL is linked with `GDAL`_. - The ``tindex`` command has two modes. The first mode creates a spatial index file for a set of point cloud files. The second mode creates a point cloud file that is the result of merging the points from files referred to in a @@ -525,14 +521,16 @@ tindex Creation Mode $ pdal tindex This command will index the files referred to by ``filespec`` and place the -result in ``tindex``. The ``tindex`` is a vector file or database that can be -handled by `OGR `_. The type of the index +result in ``tindex``. The ``tindex`` is a vector file or database that +will be created by ``pdal`` as necessary to store the file index. +The type of the index file can be specified by specifying the OGR code for the format using the ``--driver`` option. If no driver is specified, the format defaults to "ESRI -Shapefile". +Shapefile". Any filetype that can be handled by +`OGR `_ is acceptable. -In vector file-speak, each file specified by ``filespec`` is stored as a feature -in a layer in the index file. The ``filespec`` is a `glob pattern +In vector file-speak, each file specified by ``filespec`` is stored as a +feature in a layer in the index file. The ``filespec`` is a `glob pattern '_. and normally needs to be quoted to prevent shell expansion of wildcard characters. @@ -560,10 +558,11 @@ tindex Merge Mode $ pdal tindex --merge -This command will read the index file ``tindex`` and merge the points in the -files listed index file that pass any filter that might be specified, writing -the output to the point cloud file specified in ``filespec``. The type of the -output file is determined automatically from the filename extension. +This command will read the existing index file ``tindex`` and merge the +points in the indexed files that pass any filter that might be specified, +writing the output to the point cloud file specified in ``filespec``. +The type of the output file is determined automatically from the filename +extension. :: diff --git a/kernels/tindex/TIndexKernel.cpp b/kernels/tindex/TIndexKernel.cpp index 15eaf0282f..c413e718f5 100644 --- a/kernels/tindex/TIndexKernel.cpp +++ b/kernels/tindex/TIndexKernel.cpp @@ -94,7 +94,7 @@ TIndexKernel::TIndexKernel() void TIndexKernel::addSwitches(ProgramArgs& args) { args.add("tindex", "OGR-readable/writeable tile index output", - m_idxFilename); + m_idxFilename).setPositional(); args.add("filespec", "Build: Pattern of files to index. " "Merge: Output filename", m_filespec).setPositional(); args.add("fast_boundary", "Use extent instead of exact boundary",