[pktools] 22/28: Add manpage for new utilities.
Sebastiaan Couwenberg
sebastic at moszumanska.debian.org
Wed May 18 10:03:07 UTC 2016
This is an automated email from the git hooks/post-receive script.
sebastic pushed a commit to branch master
in repository pktools.
commit 2ac5090f3c512c6998313ab38b777e5a19b155ce
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Wed May 18 09:34:30 2016 +0200
Add manpage for new utilities.
---
debian/changelog | 1 +
debian/man/pkextractimg.1.xml | 274 +++++++++++++++++++
debian/man/{pkextract.1.xml => pkextractogr.1.xml} | 293 +++------------------
debian/man/pktools-config.1.xml | 84 ++++++
debian/pktools-dev.manpages | 2 +-
debian/pktools.manpages | 4 +-
6 files changed, 402 insertions(+), 256 deletions(-)
diff --git a/debian/changelog b/debian/changelog
index 454fc78..831edcf 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -17,6 +17,7 @@ pktools (2.6.7-1) UNRELEASED; urgency=medium
* Install pktools-config in dev package.
* Add patch to fix spelling errors.
* Add patch to build & install pklas2img.
+ * Add manpage for new utilities.
-- Bas Couwenberg <sebastic at debian.org> Tue, 17 May 2016 20:46:48 +0200
diff --git a/debian/man/pkextractimg.1.xml b/debian/man/pkextractimg.1.xml
new file mode 100644
index 0000000..5d7ba08
--- /dev/null
+++ b/debian/man/pkextractimg.1.xml
@@ -0,0 +1,274 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<refentry id='pkextractimg'>
+
+ <refmeta>
+ <refentrytitle>pkextractimg</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pkextractimg</refname>
+ <refpurpose>extract pixel values from raster image using a raster sample</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pkextractimg</command>
+ <arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg>
+ <arg choice='opt'><option>-s</option> <replaceable>sample</replaceable></arg>
+ <arg choice='plain'><option>-o</option> <replaceable>output</replaceable></arg>
+ <arg choice='opt'><replaceable>options</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>pkextractimg</command> extracts pixel values from an input raster
+ dataset, based on the locations you provide via a sample file.
+ The sample should be a raster dataset with categorical (integer) values.
+ The typical use case is a land cover map that overlaps the input raster
+ dataset.
+ The utility then extracts pixels from the input raster for the respective
+ land cover classes.
+ To select a random subset of the sample raster dataset you can set the
+ threshold option <option>-t</option> with a percentage value.
+ You can provide a threshold value for each class (e.g.
+ <option>-t</option> <replaceable>80</replaceable>
+ <option>-t</option> <replaceable>60</replaceable>).
+ Use value 100 to select all pixels for selected class(es).
+ As output, a new copy of the vector file is created with an extra
+ attribute for the extracted pixel value.
+ For each raster band in the input image, a separate attribute is created.
+ For instance, if the raster dataset contains three bands,
+ three attributes are created (b0, b1 and b2).
+ </para>
+ </refsect1>
+
+ <refsect1 id='options'>
+ <title>OPTIONS</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-i</option> <replaceable>filename</replaceable></term>
+ <term><option>--input</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Raster input dataset containing band information
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-s</option> <replaceable>sample</replaceable></term>
+ <term><option>--sample</option> <replaceable>sample</replaceable></term>
+ <listitem>
+ <para>
+ Raster dataset with categorical values to sample the input raster dataset.
+ Output will contain features with input band information included.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ln</option> <replaceable>layer</replaceable></term>
+ <term><option>--ln</option> <replaceable>layer</replaceable></term>
+ <listitem>
+ <para>
+ Layer name(s) in sample (leave empty to select all)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-rand</option> <replaceable>number</replaceable></term>
+ <term><option>--random</option> <replaceable>number</replaceable></term>
+ <listitem>
+ <para>
+ Create simple random sample of points.
+ Provide number of points to generate
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-grid</option> <replaceable>size</replaceable></term>
+ <term><option>--grid</option> <replaceable>size</replaceable></term>
+ <listitem>
+ <para>
+ Create systematic grid of points.
+ Provide cell grid size (in projected units, e.g,. m)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o</option> <replaceable>filename</replaceable></term>
+ <term><option>--output</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Output sample dataset
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-c</option> <replaceable>class</replaceable></term>
+ <term><option>--class</option> <replaceable>class</replaceable></term>
+ <listitem>
+ <para>
+ Class(es) to extract from input sample image.
+ Leave empty to extract all valid data pixels from sample dataset.
+ Make sure to set classes if rule is set to mode, proportion or count.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-t</option> <replaceable>threshold</replaceable></term>
+ <term><option>--threshold</option> <replaceable>threshold</replaceable></term>
+ <listitem>
+ <para>
+ Probability threshold for selecting samples (randomly).
+ Provide probability in percentage (>0) or absolute (<0).
+ Use a single threshold per vector sample layer.
+ If using raster land cover maps as a sample dataset,
+ you can provide a threshold value for each class
+ (e.g. <option>-t</option> <replaceable>80</replaceable>
+ <option>-t</option> <replaceable>60</replaceable>).
+ Use value 100 to select all pixels for selected class(es)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f</option> <replaceable>format</replaceable></term>
+ <term><option>--f</option> <replaceable>format</replaceable></term>
+ <listitem>
+ <para>
+ Output sample dataset format
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ft</option> <replaceable>fieldType</replaceable></term>
+ <term><option>--ftype</option> <replaceable>fieldType</replaceable></term>
+ <listitem>
+ <para>
+ Field type (only Real or Integer)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-lt</option> <replaceable>labelType</replaceable></term>
+ <term><option>--ltype</option> <replaceable>labelType</replaceable></term>
+ <listitem>
+ <para>
+ Label type: In16 or String
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-b</option> <replaceable>band</replaceable></term>
+ <term><option>--band</option> <replaceable>band</replaceable></term>
+ <listitem>
+ <para>
+ Band index(es) to extract.
+ Leave empty to use all bands
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-sband</option> <replaceable>band</replaceable></term>
+ <term><option>--startband</option> <replaceable>band</replaceable></term>
+ <listitem>
+ <para>
+ Start band sequence number
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-eband</option> <replaceable>band</replaceable></term>
+ <term><option>--endband</option> <replaceable>band</replaceable></term>
+ <listitem>
+ <para>
+ End band sequence number
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-bndnodata</option> <replaceable>band</replaceable></term>
+ <term><option>--bndnodata</option> <replaceable>band</replaceable></term>
+ <listitem>
+ <para>
+ Band(s) in input image to check if pixel is valid
+ (used for srcnodata)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-srcnodata</option> <replaceable>value</replaceable></term>
+ <term><option>--srcnodata</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Invalid value(s) for input image
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-bn</option> <replaceable>attribute</replaceable></term>
+ <term><option>--bname</option> <replaceable>attribute</replaceable></term>
+ <listitem>
+ <para>
+ For single band input data, this extra attribute name will
+ correspond to the raster values.
+ For multi-band input data, multiple attributes with this prefix
+ will be added (e.g. b0, b1, b2, etc.)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-cn</option> <replaceable>attribute</replaceable></term>
+ <term><option>--cname</option> <replaceable>attribute</replaceable></term>
+ <listitem>
+ <para>
+ Name of the class label in the output vector dataset
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-down</option> <replaceable>value</replaceable></term>
+ <term><option>--down</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Down sampling factor
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option> <replaceable>level</replaceable></term>
+ <term><option>--verbose</option> <replaceable>level</replaceable></term>
+ <listitem>
+ <para>
+ Verbose mode if > 0
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
+</refentry>
diff --git a/debian/man/pkextract.1.xml b/debian/man/pkextractogr.1.xml
similarity index 52%
rename from debian/man/pkextract.1.xml
rename to debian/man/pkextractogr.1.xml
index 1f6c43d..7c6baba 100644
--- a/debian/man/pkextract.1.xml
+++ b/debian/man/pkextractogr.1.xml
@@ -1,20 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
-<refentry id='pkextract'>
+<refentry id='pkextractogr'>
<refmeta>
- <refentrytitle>pkextract</refentrytitle>
+ <refentrytitle>pkextractogr</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
- <refname>pkextract</refname>
+ <refname>pkextractogr</refname>
<refpurpose>extract pixel values from raster image from a (vector or raster) sample</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
- <command>pkextract</command>
+ <command>pkextractogr</command>
<arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg>
<group>
<arg choice='opt'><option>-s</option> <replaceable>sample</replaceable></arg>
@@ -23,14 +23,13 @@
</group>
<arg choice='plain'><option>-o</option> <replaceable>output</replaceable></arg>
<arg choice='opt'><replaceable>options</replaceable></arg>
- <arg choice='opt'><replaceable>advanced options</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
- <command>pkextract</command> extracts pixel values from an input raster
+ <command>pkextractogr</command> extracts pixel values from an input raster
dataset, based on the locations you provide via a sample file.
Alternatively, a random sample or systematic grid of points can also be
extracted.
@@ -45,17 +44,7 @@
three attributes are created (b0, b1 and b2).
</para>
<para>
- Instead of a vector dataset, the sample can also be a raster dataset with
- categorical values.
- The typical use case is a land cover map that overlaps the input raster
- dataset.
- The utility then extracts pixels from the input raster for the respective
- land cover classes.
- To select a random subset of the sample raster dataset you can set the
- threshold option <option>-t</option> with a percentage value.
- </para>
- <para>
- A typical usage of <command>pkextract</command> is to prepare a training
+ A typical usage of <command>pkextractogr</command> is to prepare a training
sample for one of the classifiers implemented in pktools.
</para>
<para>
@@ -74,6 +63,10 @@
<entry>Extract all pixel values covered by the polygon (option <option>-polygon</option> not set) or extract a pixel on the surface option (<option>-polygon</option> set).</entry>
</row>
<row>
+ <entry>allpoints</entry>
+ <entry>Extract all pixel values covered by the polygon.</entry>
+ </row>
+ <row>
<entry>centroid</entry>
<entry>Extract pixel value at the centroid of the polygon.</entry>
</row>
@@ -150,6 +143,16 @@
</varlistentry>
<varlistentry>
+ <term><option>-ln</option> <replaceable>layer</replaceable></term>
+ <term><option>--ln</option> <replaceable>layer</replaceable></term>
+ <listitem>
+ <para>
+ Layer name(s) in sample (leave empty to select all)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-rand</option> <replaceable>number</replaceable></term>
<term><option>--random</option> <replaceable>number</replaceable></term>
<listitem>
@@ -182,16 +185,6 @@
</varlistentry>
<varlistentry>
- <term><option>-ln</option> <replaceable>layer</replaceable></term>
- <term><option>--ln</option> <replaceable>layer</replaceable></term>
- <listitem>
- <para>
- Layer name(s) in sample (leave empty to select all)
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term><option>-c</option> <replaceable>class</replaceable></term>
<term><option>--class</option> <replaceable>class</replaceable></term>
<listitem>
@@ -221,6 +214,16 @@
</varlistentry>
<varlistentry>
+ <term><option>-perc</option> <replaceable>percentile</replaceable></term>
+ <term><option>--perc</option> <replaceable>percentile</replaceable></term>
+ <listitem>
+ <para>
+ Percentile value used for rule percentile
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-f</option> <replaceable>format</replaceable></term>
<term><option>--f</option> <replaceable>format</replaceable></term>
<listitem>
@@ -251,16 +254,6 @@
</varlistentry>
<varlistentry>
- <term><option>-polygon</option></term>
- <term><option>--polygon</option></term>
- <listitem>
- <para>
- Create OGRPolygon as geometry instead of OGRPoint.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term><option>-b</option> <replaceable>band</replaceable></term>
<term><option>--band</option> <replaceable>band</replaceable></term>
<listitem>
@@ -306,21 +299,6 @@
</varlistentry>
<varlistentry>
- <term><option>-v</option> <replaceable>level</replaceable></term>
- <term><option>--verbose</option> <replaceable>level</replaceable></term>
- <listitem>
- <para>
- Verbose mode if > 0
- </para>
- </listitem>
- </varlistentry>
-
- </variablelist>
-
- <para>Advanced options</para>
- <variablelist>
-
- <varlistentry>
<term><option>-bndnodata</option> <replaceable>band</replaceable></term>
<term><option>--bndnodata</option> <replaceable>band</replaceable></term>
<listitem>
@@ -352,60 +330,6 @@
</varlistentry>
<varlistentry>
- <term><option>-test</option> <replaceable>testSample</replaceable></term>
- <term><option>--test</option> <replaceable>testSample</replaceable></term>
- <listitem>
- <para>
- Test sample dataset (use this option in combination with
- threshold<100 to create a training (output) and test set
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-bn</option> <replaceable>attribute</replaceable></term>
- <term><option>--bname</option> <replaceable>attribute</replaceable></term>
- <listitem>
- <para>
- For single band input data, this extra attribute name will
- correspond to the raster values.
- For multi-band input data, multiple attributes with this prefix
- will be added (e.g. b0, b1, b2, etc.)
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-cn</option> <replaceable>attribute</replaceable></term>
- <term><option>--cname</option> <replaceable>attribute</replaceable></term>
- <listitem>
- <para>
- Name of the class label in the output vector dataset
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-geo</option> <replaceable>value</replaceable></term>
- <term><option>--geo</option> <replaceable>value</replaceable></term>
- <listitem>
- <para>
- Use geo coordinates (set to 0 to use image coordinates)
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-down</option> <replaceable>value</replaceable></term>
- <term><option>--down</option> <replaceable>value</replaceable></term>
- <listitem>
- <para>
- Down sampling factor (for raster sample datasets only).
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term><option>-buf</option> <replaceable>value</replaceable></term>
<term><option>--buffer</option> <replaceable>value</replaceable></term>
<listitem>
@@ -427,154 +351,17 @@
</listitem>
</varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1 id='example'>
- <title>EXAMPLE</title>
-
- <example>
- <title>Using vector samples</title>
-
- <para>
- Extract all points for all layers read in
- <replaceable>points.sqlite</replaceable> from
- <replaceable>input.tif</replaceable>.
- Create a new point vector dataset named
- <replaceable>extracted.sqlite</replaceable>,
- where each point will contain an attribute for the individual input bands
- in <replaceable>input.tif</replaceable>.
- Notice that the default vector format is Spatialite (.sqlite).
- </para>
- <screen>
-<command>pkextract</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-s</option> <replaceable>points.sqlite</replaceable> <option>-o</option> <replaceable>extracted.sqlite</replaceable>
- </screen>
-
- <para>
- Same example as above, but only extract the points for the layer in
- <replaceable>points.sqlite</replaceable> named "valid"
- </para>
- <screen>
-<command>pkextract</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-s</option> <replaceable>points.sqlite</replaceable> <option>-ln</option> <replaceable>valid</replaceable> <option>-o</option> <replaceable>extracted.sqlite</replaceable>
- </screen>
-
- <para>
- Extract points and write output in ESRI Shapefile format
- </para>
- <screen>
-<command>pkextract</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-s</option> <replaceable>points.shp</replaceable> <option>-f</option> <replaceable>"ESRI Shapefile"</replaceable> <option>-o</option> <replaceable>extracted.sqlite</replaceable>
- </screen>
-
- <para>
- Extract the standard deviation for each input band in a 3 by 3 window,
- centered around the points in the sample vector dataset
- <replaceable> points.sqlite</replaceable>.
- The output vector dataset will contain polygon features defined by the
- buffered points (3x3 window).
- Use the option <option>-circ</option> to define a circular buffer.
- </para>
- <screen>
-<command>pkextract</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-s</option> <replaceable>points.sqlite</replaceable> <option>-o</option> <replaceable>extracted.sqlite</replaceable> <option>-r</option> <replaceable>stdev</replaceable> <option>-buf</option> <replaceable>3</replaceable> <option>-polygon</option>
- </screen>
-
- <para>
- Extract all pixels from <replaceable>input.tif</replaceable> covered by
- the polygons in <replaceable>locations.sqlite</replaceable>.
- Each polygon can thus result in multiple point features with attributes
- for each input band.
- Write the extracted points to a point vector dataset
- <replaceable>training.sqlite</replaceable>.
- </para>
- <screen>
-<command>pkextract</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-s</option> <replaceable>polygons.sqlite</replaceable> <option>-o</option> <replaceable>training.sqlite</replaceable> <option>-r</option> <replaceable>point</replaceable>
- </screen>
-
- <para>
- Extract the first band from <replaceable>input.tif</replaceable> at the
- centroids of the polygons in vector dataset
- <replaceable>polygons.sqlite</replaceable>.
- Assign the extracted point value to a new attribute of the polygon and
- write to the vector dataset <replaceable>extracted.sqlite</replaceable>.
- </para>
- <screen>
-<command>pkextract</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-b</option> <replaceable>0</replaceable> <option>-s</option> <replaceable>polygons.sqlite</replaceable> <option>-r</option> <replaceable>centroid</replaceable> <option>-o</option> <replaceable>extracted.sqlite</replaceable> <option>-polygon</option>
- </screen>
-
- <para>
- Extract the mean values for the second band in
- <replaceable>input.tif</replaceable> covered by each polygon in
- <replaceable>polygons.sqlite</replaceable>.
- The mean values are written to a copy of the polygons in output vector
- dataset <replaceable>extracted.sqlite</replaceable>
- </para>
- <screen>
-<command>pkextract</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-b</option> <replaceable>1</replaceable> <option>-s</option> <replaceable>polygons.sqlite</replaceable> <option>-r</option> <replaceable>mean</replaceable> <option>-o</option> <replaceable>extracted.sqlite</replaceable> <option>-polygon</option>
- </screen>
-
- <para>
- Extract the majority class in each polygon for the input land cover map.
- The land cover map contains five valid classes, labeled 1-5.
- Other class values (e.g., labeled as 0) are not taken into account in
- the voting.
- </para>
- <screen>
-<command>pkextract</command> <option>-i</option> <replaceable>landcover.tif</replaceable> <option>-s</option> <replaceable>polygons.sqlite</replaceable> <option>-r</option> <replaceable>maxvote</replaceable> <option>-o</option> <replaceable>majority.sqlite</replaceable> <option>-polygon</option> <option>-c</option> <replaceable>1</replaceable> <option>-c</option> <replaceable>2</replaceable> <option>-c</option> <replaceable>3</replaceable> <option>-c</option> <replaceable>4</replaceable> [...]
- </screen>
- </example>
-
- <example>
- <title>Using random and grid samples</title>
-
- <para>
- Extract 100 sample units following a simple random sampling design.
- For each sample unit, the median value is extracted from the input
- raster dataset in a window of 3 by 3 pixels and written to an attribute
- of the output vector dataset.
- The output vector dataset contains polygon features defined by the
- windows centered at the random selected sample units.
- </para>
- <screen>
-<command>pkextract</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>random.sqlite</replaceable> <option>-rand</option> <replaceable>100</replaceable> <option>-median</option> <option>-buf</option> <replaceable>3</replaceable> <option>-polygon</option>
- </screen>
-
- <para>
- Extract points following a systematic grid with grid cell size of
- 100 m.
- Discard pixels that have a value 0 in the input raster dataset.
- </para>
- <screen>
-<command>pkextract</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>systematic.sqlite</replaceable> <option>-grid</option> <replaceable>100</replaceable> <option>-srcnodata</option> <replaceable>0</replaceable>
- </screen>
- </example>
-
- <example>
- <title>Using raster samples</title>
-
- <para>
- Typical use where pixels are extracted based on a land cover map
- (<replaceable>sample.tif</replaceable>).
- Extract all bands for a random sample of 10 percent of the pixels in
- the land cover map <replaceable>sample.tif</replaceable> where the
- land cover classes are either 1,2 or 3 (class values).
- Write output to the point vector dataset
- <replaceable>extracted.sqlite</replaceable>.
- </para>
- <screen>
-<command>pkextract</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-s</option> <replaceable>sample.tif</replaceable> <option>-o</option> <replaceable>extracted.sqlite</replaceable> <option>-t</option> <replaceable>10</replaceable> <option>-c</option> <replaceable>1</replaceable> <option>-c</option> <replaceable>2</replaceable> <option>-c</option> <replaceable>3</replaceable>
- </screen>
+ <varlistentry>
+ <term><option>-v</option> <replaceable>level</replaceable></term>
+ <term><option>--verbose</option> <replaceable>level</replaceable></term>
+ <listitem>
+ <para>
+ Verbose mode if > 0
+ </para>
+ </listitem>
+ </varlistentry>
- <para>
- Extract all bands for the first 5000 pixels encountered in
- <replaceable>sample.tif</replaceable> where pixels have a
- value equal to 1.
- Write output to point vector dataset
- <replaceable>extracted.sqlite</replaceable>.
- </para>
- <screen>
-<command>pkextract</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-s</option> <replaceable>sample.tif</replaceable> <option>-o</option> <replaceable>extracted.sqlite</replaceable> <option>-t</option> <replaceable>-5000</replaceable> <option>-c</option> <replaceable>1</replaceable>
- </screen>
- </example>
+ </variablelist>
</refsect1>
diff --git a/debian/man/pktools-config.1.xml b/debian/man/pktools-config.1.xml
new file mode 100644
index 0000000..4318224
--- /dev/null
+++ b/debian/man/pktools-config.1.xml
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<refentry id='pktools-config'>
+
+ <refmeta>
+ <refentrytitle>pktools-config</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pktools-config</refname>
+ <refpurpose>query pktools build options</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pktools-config</command>
+ <arg choice='opt'><option>--prefix</option></arg>
+ <arg choice='opt'><option>--version</option></arg>
+ <arg choice='opt'><option>--libs</option></arg>
+ <arg choice='opt'><option>--cflags</option></arg>
+ <arg choice='opt'><option>--ld</option></arg>
+ <arg choice='opt'><option>--includes</option></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>pktools-config</command> allows querying the options used to
+ build the PDAL library.
+ </para>
+ </refsect1>
+
+ <refsect1 id='options'>
+ <title>OPTIONS</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>--prefix</option></term>
+ <listitem>
+ <para>Installation prefix</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--version</option></term>
+ <listitem>
+ <para>Library version</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--libs</option></term>
+ <listitem>
+ <para>Libraries</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--cflags</option></term>
+ <listitem>
+ <para>Compiler flags</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--ldflags</option></term>
+ <listitem>
+ <para>Linker flags</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--includes</option></term>
+ <listitem>
+ <para>Compiler includes</para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+</refentry>
diff --git a/debian/pktools-dev.manpages b/debian/pktools-dev.manpages
index aa97a2f..d5a9850 100644
--- a/debian/pktools-dev.manpages
+++ b/debian/pktools-dev.manpages
@@ -1 +1 @@
-#debian/man/pktools-config.1
+debian/man/pktools-config.1
diff --git a/debian/pktools.manpages b/debian/pktools.manpages
index d7d235b..21190c7 100644
--- a/debian/pktools.manpages
+++ b/debian/pktools.manpages
@@ -9,8 +9,8 @@ debian/man/pkdsm2shadow.1
debian/man/pkdumpimg.1
debian/man/pkdumpogr.1
debian/man/pkegcs.1
-#debian/man/pkextractimg.1
-#debian/man/pkextractogr.1
+debian/man/pkextractimg.1
+debian/man/pkextractogr.1
debian/man/pkfillnodata.1
debian/man/pkfilter.1
debian/man/pkfilterascii.1
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/pktools.git
More information about the Pkg-grass-devel
mailing list