[pktools] 03/04: Update manpages for upstream changes.
Sebastiaan Couwenberg
sebastic at moszumanska.debian.org
Sat Dec 19 01:15:42 UTC 2015
This is an automated email from the git hooks/post-receive script.
sebastic pushed a commit to branch master
in repository pktools.
commit 7d7bde518a9087ae96145608f5f7207e30631b03
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Sat Dec 19 01:34:28 2015 +0100
Update manpages for upstream changes.
---
debian/changelog | 1 +
debian/man/pkann.1.xml | 16 +-
debian/man/pkcomposite.1.xml | 26 ++++
debian/man/pkcreatect.1.xml | 1 -
debian/man/pkcrop.1.xml | 57 ++++++--
debian/man/pkdiff.1.xml | 15 ++
debian/man/pkdsm2shadow.1.xml | 1 -
debian/man/pkextract.1.xml | 88 ++++++++++-
debian/man/pkfilter.1.xml | 322 +++++++++++++++++++++++++++++++++++++++--
debian/man/pkfilterdem.1.xml | 1 -
debian/man/pkfsann.1.xml | 13 +-
debian/man/pkfssvm.1.xml | 13 +-
debian/man/pkgetmask.1.xml | 1 -
debian/man/pkkalman.1.xml | 109 ++------------
debian/man/pklas2img.1.xml | 30 +++-
debian/man/pkoptsvm.1.xml | 13 +-
debian/man/pkreclass.1.xml | 14 ++
debian/man/pksetmask.1.xml | 1 -
debian/man/pkstat.1.xml | 12 ++
debian/man/pkstatprofile.1.xml | 22 +--
debian/man/pksvm.1.xml | 20 +--
21 files changed, 597 insertions(+), 179 deletions(-)
diff --git a/debian/changelog b/debian/changelog
index 6b64451..a3b90e1 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -5,6 +5,7 @@ pktools (2.6.5-1) UNRELEASED; urgency=medium
* Drop gdal-2.0.patch, applied upstream.
* Update symbols for amd64.
* Add manpage for pkstatprofile.
+ * Update manpages for upstream changes.
-- Bas Couwenberg <sebastic at debian.org> Fri, 18 Dec 2015 02:55:14 +0100
diff --git a/debian/man/pkann.1.xml b/debian/man/pkann.1.xml
index 16e178b..a969ccc 100644
--- a/debian/man/pkann.1.xml
+++ b/debian/man/pkann.1.xml
@@ -140,8 +140,8 @@
<term><option>--mask</option> <replaceable>filename</replaceable></term>
<listitem>
<para>
- Use the first band of the specified file as a validity mask.
- Nodata values can be set with the option
+ Only classify within specified mask (vector or raster).
+ For raster mask, set nodata values with the option
<option>--msknodata</option>.
</para>
</listitem>
@@ -311,8 +311,8 @@
</varlistentry>
<varlistentry>
- <term><option>-s</option> <replaceable>band</replaceable></term>
- <term><option>--start</option> <replaceable>band</replaceable></term>
+ <term><option>-sband</option> <replaceable>band</replaceable></term>
+ <term><option>--startband</option> <replaceable>band</replaceable></term>
<listitem>
<para>
start band sequence number
@@ -322,16 +322,17 @@
</varlistentry>
<varlistentry>
- <term><option>-e</option> <replaceable>band</replaceable></term>
- <term><option>--end</option> <replaceable>band</replaceable></term>
+ <term><option>-eband</option> <replaceable>band</replaceable></term>
+ <term><option>--endband</option> <replaceable>band</replaceable></term>
<listitem>
<para>
- end band sequence number (set to 0 to include bands)
+ end band sequence number
</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-offset</option> <replaceable>value</replaceable></term>
<term><option>--offset</option> <replaceable>value</replaceable></term>
<listitem>
<para>
@@ -342,6 +343,7 @@
</varlistentry>
<varlistentry>
+ <term><option>-scale</option> <replaceable>value</replaceable></term>
<term><option>--scale</option> <replaceable>value</replaceable></term>
<listitem>
<para>
diff --git a/debian/man/pkcomposite.1.xml b/debian/man/pkcomposite.1.xml
index 767a14e..99ad5e5 100644
--- a/debian/man/pkcomposite.1.xml
+++ b/debian/man/pkcomposite.1.xml
@@ -36,6 +36,32 @@
a composite step.
Input datasets can have different bounding boxes and spatial resolutions.
</para>
+ <example>
+ <para>
+ Example: Calculate the maximum NDVI composite of two multispectral
+ input images (e.g., red is band 0 and near infrared is band 1)
+ </para>
+ <screen>
+<command>pkcomposite</command> <option>-i</option> <replaceable>input1.tif</replaceable> <option>-i</option> <replaceable>input2.tif</replaceable> <option>-o</option> <replaceable>output.tif</replaceable> <option>-cr</option> <replaceable>maxndvi</replaceable> <option>-cb</option> <replaceable>0</replaceable> <option>-cb</option> <replaceable>1</replaceable>
+ </screen>
+ </example>
+ <example>
+ <para>
+ Example: Calculate the minimum nadir composite of two input images,
+ where the forth band (b=3) contains the view zenith angle
+ </para>
+ <screen>
+<command>pkcomposite</command> <option>-i</option> <replaceable>input1.tif</replaceable> <option>-i</option> <replaceable>input2.tif</replaceable> <option>-o</option> <replaceable>minzenith.tif</replaceable> <option>-cr</option> <replaceable>minband</replaceable> <option>-cb</option> <replaceable>3</replaceable>
+ </screen>
+ </example>
+ <example>
+ <para>
+ Example: Calculate the minimum of two input images in all bands
+ </para>
+ <screen>
+<command>pkcomposite</command> <option>-i</option> <replaceable>input1.tif</replaceable> <option>-i</option> <replaceable>input2.tif</replaceable> <option>-o</option> <replaceable>minimum.tif</replaceable> <option>-cr</option> <replaceable>minallbands</replaceable>
+ </screen>
+ </example>
</refsect1>
<refsect1 id='options'>
diff --git a/debian/man/pkcreatect.1.xml b/debian/man/pkcreatect.1.xml
index e92f81a..476ae26 100644
--- a/debian/man/pkcreatect.1.xml
+++ b/debian/man/pkcreatect.1.xml
@@ -116,7 +116,6 @@
<refentrytitle>gdal_translate</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>).
- Empty string: inherit from input image
</para>
</listitem>
</varlistentry>
diff --git a/debian/man/pkcrop.1.xml b/debian/man/pkcrop.1.xml
index 05371f7..419f83f 100644
--- a/debian/man/pkcrop.1.xml
+++ b/debian/man/pkcrop.1.xml
@@ -115,7 +115,27 @@
<term><option>--band</option> <replaceable>band</replaceable></term>
<listitem>
<para>
- band index to crop (leave empty to retain all bands)
+ Band index to crop (leave empty to retain 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>
@@ -231,17 +251,32 @@
</varlistentry>
<varlistentry>
- <term><option>-m</option></term>
- <term><option>--mask</option></term>
+ <term><option>-m</option> <replaceable>file</replaceable></term>
+ <term><option>--mask</option> <replaceable>file</replaceable></term>
+ <listitem>
+ <para>
+ Use the specified file as a validity mask (0 is nodata)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-msknodata</option> <replaceable>value</replaceable></term>
+ <term><option>--msknodata</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Mask value not to consider for crop
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-mskband</option> <replaceable>value</replaceable></term>
+ <term><option>--mskband</option> <replaceable>value</replaceable></term>
<listitem>
<para>
- mask values out of polygon in extent file to flag option
- (tip: for better performance, use <command>gdal_rasterize</command>
- <option>-i</option> <option>-burn</option> <literal>0</literal>
- <option>-l</option> <literal>extent</literal>
- <filename>extent.shp</filename> <replaceable>output</replaceable>
- (with <replaceable>output</replaceable> the result of
- <command>pkcrop</command>))
+ Mask band to read (0 indexed).
+ Provide band for each mask.
</para>
</listitem>
</varlistentry>
@@ -330,7 +365,7 @@
</varlistentry>
<varlistentry>
- <term><option>-s</option> <replaceable>scale</replaceable></term>
+ <term><option>-scale</option> <replaceable>scale</replaceable></term>
<term><option>--scale</option> <replaceable>scale</replaceable></term>
<listitem>
<para>
diff --git a/debian/man/pkdiff.1.xml b/debian/man/pkdiff.1.xml
index 95c47ed..38047ae 100644
--- a/debian/man/pkdiff.1.xml
+++ b/debian/man/pkdiff.1.xml
@@ -210,6 +210,21 @@
</varlistentry>
<varlistentry>
+ <term><option>-of</option> <replaceable>GDALformat</replaceable></term>
+ <term><option>--oformat</option> <replaceable>GDALformat</replaceable></term>
+ <listitem>
+ <para>
+ Output image format (see also
+ <citerefentry>
+ <refentrytitle>gdal_translate</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>).
+ Empty string: inherit from input image
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-lc</option> <replaceable>attribute</replaceable></term>
<term><option>--lclass</option> <replaceable>attribute</replaceable></term>
<listitem>
diff --git a/debian/man/pkdsm2shadow.1.xml b/debian/man/pkdsm2shadow.1.xml
index dacfa0a..6e1b165 100644
--- a/debian/man/pkdsm2shadow.1.xml
+++ b/debian/man/pkdsm2shadow.1.xml
@@ -109,7 +109,6 @@
<refentrytitle>gdal_translate</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>).
- Empty string: inherit from input image
</para>
</listitem>
</varlistentry>
diff --git a/debian/man/pkextract.1.xml b/debian/man/pkextract.1.xml
index a70bf6f..b386099 100644
--- a/debian/man/pkextract.1.xml
+++ b/debian/man/pkextract.1.xml
@@ -58,6 +58,69 @@
A typical usage of <command>pkextract</command> is to prepare a training
sample for one of the classifiers implemented in pktools.
</para>
+ <para>
+ Overview of the possible extraction rules:
+ <informaltable frame='none'>
+ <tgroup cols='2'>
+ <thead>
+ <row>
+ <entry>Extraction rule</entry>
+ <entry>Output features</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>point</entry>
+ <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>centroid</entry>
+ <entry>Extract pixel value at the centroid of the polygon.</entry>
+ </row>
+ <row>
+ <entry>mean</entry>
+ <entry>Extract average of all pixel values within the polygon.</entry>
+ </row>
+ <row>
+ <entry>stdev</entry>
+ <entry>Extract standard deviation of all pixel values within the polygon.</entry>
+ </row>
+ <row>
+ <entry>median</entry>
+ <entry>Extract median of all pixel values within the polygon.</entry>
+ </row>
+ <row>
+ <entry>min</entry>
+ <entry>Extract minimum value of all pixels within the polygon.</entry>
+ </row>
+ <row>
+ <entry>max</entry>
+ <entry>Extract maximum value of all pixels within the polygon.</entry>
+ </row>
+ <row>
+ <entry>sum</entry>
+ <entry>Extract sum of the values of all pixels within the polygon.</entry>
+ </row>
+ <row>
+ <entry>mode</entry>
+ <entry>Extract the mode of classes within the polygon (classes must be set with the option class).</entry>
+ </row>
+ <row>
+ <entry>proportion</entry>
+ <entry>Extract proportion of class(es) within the polygon (classes must be set with the option class).</entry>
+ </row>
+ <row>
+ <entry>count</entry>
+ <entry>Extract count of class(es) within the polygon (classes must be set with the option class).</entry>
+ </row>
+ <row>
+ <entry>percentile</entry>
+ <entry>Extract percentile as defined by option perc (e.g, 95th percentile of values covered by polygon).</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
</refsect1>
<refsect1 id='options'>
@@ -135,7 +198,7 @@
<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 or proportion
+ Make sure to set classes if rule is set to mode, proportion or count.
</para>
</listitem>
</varlistentry>
@@ -209,6 +272,26 @@
</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>-r</option> <replaceable>rule</replaceable></term>
<term><option>--rule</option> <replaceable>rule</replaceable></term>
<listitem>
@@ -216,7 +299,8 @@
Rule how to report image information per feature
(only for vector sample).
point (value at each point or at centroid if polygon),
- centroid, mean, stdev, median, proportion, min, max, mode, sum.
+ centroid, mean, stdev, median, proportion, count, min, max,
+ mode, sum, percentile.
</para>
</listitem>
</varlistentry>
diff --git a/debian/man/pkfilter.1.xml b/debian/man/pkfilter.1.xml
index 3f01b86..8373a25 100644
--- a/debian/man/pkfilter.1.xml
+++ b/debian/man/pkfilter.1.xml
@@ -54,6 +54,302 @@
The kernel filter size can be set with the option <option>-dz</option>
(use odd values only).
</para>
+ <refsect2 id='pkfilter_functions_1'>
+ <title>Filters in spatial (dx, dy) and spectral/temporal (dz) domain</title>
+
+ <refsect3 id='pkfilter_functions_1_1'>
+ <title>Implemented as moving window: choose dx, dy or dz > 1 and odd (3, 5, 7, etc.)</title>
+ <para>
+ The number of output bands equals number of input bands
+ <informaltable frame='none'>
+ <tgroup cols='2'>
+ <thead>
+ <row>
+ <entry>Filter</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>dilate</entry>
+ <entry>morphological dilation</entry>
+ </row>
+ <row>
+ <entry>erode</entry>
+ <entry>morphological erosion</entry>
+ </row>
+ <row>
+ <entry>close</entry>
+ <entry>morpholigical closing (dilate+erode)</entry>
+ </row>
+ <row>
+ <entry>open</entry>
+ <entry>morpholigical opening (erode+dilate)</entry>
+ </row>
+ <row>
+ <entry>smoothnodata values</entry>
+ <entry>smooth nodata values (set <option>--nodata</option> option!)</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ <para>
+ Example: "Smooth" (interpolate) nodata in spectral/temporal domain
+ (<option>-dz</option> <replaceable>1</replaceable>), using a linear interpolation
+ <screen>
+<command>pkfilter</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>smoothed.tif</replaceable> <option>-dz</option> <replaceable>1</replaceable> <option>-f</option> <replaceable>smoothnodata</replaceable> <option>-interp</option> <replaceable>linear</replaceable>
+ </screen>
+ </para>
+ <para>
+ Example: Filter <replaceable>input.tif</replaceable> in spatial
+ domain with morphological dilation filter with kernel size 3x3.
+ <screen>
+<command>pkfilter</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>dilated.tif</replaceable> <option>-dx</option> <replaceable>3</replaceable> <option>-dy</option> <replaceable>3</replaceable> <option>-f</option> <replaceable>dilate</replaceable>
+ </screen>
+ </para>
+ </refsect3>
+ <refsect3 id='pkfilter_functions_1_2'>
+ <title>Implemented as either moving window or statistical function in spectral/temporal domain (choose dz=1).</title>
+ <para>
+ In case of moving window, the number of output bands equals number
+ of input bands.
+ In case dz=1, the single output band is calculated as the result of
+ the statistical function applied to all bands.
+ <informaltable frame='none'>
+ <tgroup cols='2'>
+ <thead>
+ <row>
+ <entry>Filter</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>nvalid</entry>
+ <entry>report number of valid (not nodata) values in window</entry>
+ </row>
+ <row>
+ <entry>median</entry>
+ <entry>perform a median filter in spatial (dx, dy) or spectral/temporal (dz) domain</entry>
+ </row>
+ <row>
+ <entry>var</entry>
+ <entry>calculate variance in window</entry>
+ </row>
+ <row>
+ <entry>min</entry>
+ <entry>calculate minimum in window</entry>
+ </row>
+ <row>
+ <entry>max</entry>
+ <entry>calculate maximum in window</entry>
+ </row>
+ <row>
+ <entry>sum</entry>
+ <entry>calculate sum in window</entry>
+ </row>
+ <row>
+ <entry>mean</entry>
+ <entry>calculate mean in window</entry>
+ </row>
+ <row>
+ <entry>stdev</entry>
+ <entry>calculate standard deviation in window</entry>
+ </row>
+ <row>
+ <entry>savgolay</entry>
+ <entry>Savitzky-Golay filter (check examples page!)</entry>
+ </row>
+ <row>
+ <entry>percentile</entry>
+ <entry>calculate percentile value in window</entry>
+ </row>
+ <row>
+ <entry>proportion</entry>
+ <entry>calculate proportion in window</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ <para>
+ Example: Median filter in spatial domain
+ <screen>
+<command>pkfilter</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>median.tif</replaceable> <option>-dx</option> <replaceable>3</replaceable> <option>-dy</option> <replaceable>3</replaceable> <option>-f</option> <replaceable>median</replaceable>
+ </screen>
+ </para>
+ <para>
+ Example: Calculate statistical variance in spectral/temporal domain
+ (single output band)
+ <screen>
+<command>pkfilter</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>var.tif</replaceable> <option>-dz</option> <replaceable>1</replaceable> <option>-f</option> <replaceable>var</replaceable>
+ </screen>
+ </para>
+ </refsect3>
+ </refsect2>
+ <refsect2 id='pkfilter_functions_2'>
+ <title>Wavelet filters</title>
+
+ <refsect3 id='pkfilter_functions_2_1'>
+ <title>Wavelet filter in in spatial or spectral/temporal (set dz = 1) domain.</title>
+ <para>
+ The number of output bands equals number of input bands
+ <informaltable frame='none'>
+ <tgroup cols='2'>
+ <thead>
+ <row>
+ <entry>Filter</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>dwt</entry>
+ <entry>discrete wavelet transform</entry>
+ </row>
+ <row>
+ <entry>dwti</entry>
+ <entry>discrete inverse wavelet transform</entry>
+ </row>
+ <row>
+ <entry>dwt_cut</entry>
+ <entry>discrete wavelet + inverse transform, using threshold option to cut percentile of coefficients</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ <para>
+ Example: Calculate discrete wavelet in spatial domain
+ <screen>
+<command>pkfilter</command> <option>-i</option> <replaceable>lena.tif</replaceable> <option>-o</option> <replaceable>lena_dwt.tif</replaceable> <option>-f</option> <replaceable>dwt</replaceable>
+ </screen>
+ </para>
+ <para>
+ Example: Calculate discrete wavelet in spectral/temporal domain
+ <screen>
+<command>pkfilter</command> <option>-i</option> <replaceable>timeseries.tif</replaceable> <option>-o</option> <replaceable>dwt.tif</replaceable> <option>-f</option> <replaceable>dwt</replaceable> <option>-dz</option> <replaceable>1</replaceable>
+ </screen>
+ </para>
+ </refsect3>
+ <refsect3 id='pkfilter_functions_2_2'>
+ <title>Wavelet filter implemented in spectral/temporal domain only.</title>
+ <para>
+ The number of output bands equals number of input bands
+ <informaltable frame='none'>
+ <tgroup cols='2'>
+ <thead>
+ <row>
+ <entry>Filter</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>dwt_cut_from</entry>
+ <entry>discrete wavelet + inverse transform, setting all high frequence coefficients to zero (scale >= threshold)</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ <para>
+ Example: Calculate low frequency time series based on discrete
+ wavelet + inverse transform in spectral/temporal domain,
+ retaining only coefficients until scale 3.
+ <screen>
+<command>pkfilter</command> <option>-i</option> <replaceable>timeseries.tif</replaceable> <option>-o</option> <replaceable>lowfrequency.tif</replaceable> <option>-f</option> <replaceable>dwt_cut_from</replaceable> <option>-dz</option> <replaceable>1</replaceable> <option>-t</option> <replaceable>4</replaceable>
+ </screen>
+ </para>
+ </refsect3>
+ </refsect2>
+ <refsect2 id='pkfilter_functions_3'>
+ <title>Filters in spatial domain only (dx, dy > 1 and odd).</title>
+
+ <para>
+ The number of output bands equals number of input bands.
+ <informaltable frame='none'>
+ <tgroup cols='2'>
+ <thead>
+ <row>
+ <entry>Filter</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>mrf</entry>
+ <entry>Markov random field</entry>
+ </row>
+ <row>
+ <entry>ismin</entry>
+ <entry>pixel is minimum?</entry>
+ </row>
+ <row>
+ <entry>ismax</entry>
+ <entry>pixel is maximum?</entry>
+ </row>
+ <row>
+ <entry>shift</entry>
+ <entry>perform a pixel shift in spatial window</entry>
+ </row>
+ <row>
+ <entry>scramble</entry>
+ <entry>scramble pixels in a spatial window</entry>
+ </row>
+ <row>
+ <entry>mode (majority voting)</entry>
+ <entry>perform a majority voring (set <option>--class</option> option)</entry>
+ </row>
+ <row>
+ <entry>sobelx</entry>
+ <entry>horizontal edge detection</entry>
+ </row>
+ <row>
+ <entry>sobely</entry>
+ <entry>vertical edge detection</entry>
+ </row>
+ <row>
+ <entry>sobelxy</entry>
+ <entry>diagonal edge detection (NE-SW)</entry>
+ </row>
+ <row>
+ <entry>sobelyx</entry>
+ <entry>diagonal edge detection (NW-SE)</entry>
+ </row>
+ <row>
+ <entry>countid</entry>
+ <entry>count digital numbers in window</entry>
+ </row>
+ <row>
+ <entry>order</entry>
+ <entry>rank pixels in order</entry>
+ </row>
+ <row>
+ <entry>density</entry>
+ <entry>calculated the density</entry>
+ </row>
+ <row>
+ <entry>homog</entry>
+ <entry>central pixel must be identical to all other pixels within window</entry>
+ </row>
+ <row>
+ <entry>heterog</entry>
+ <entry>central pixel must be different than all other pixels within window</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ <para>
+ Example: Sobel edge detection in horizontal direction
+ <screen>
+<command>pkfilter</command> <option>-i</option> <replaceable>lena.tif</replaceable> <option>-o</option> <replaceable>sobelx.tif</replaceable> <option>-f</option> <replaceable>solbelx</replaceable> <option>-dx</option> <replaceable>5</replaceable> <option>-dy</option> <replaceable>5</replaceable>
+ </screen>
+ </para>
+ </refsect2>
+
</refsect1>
<refsect1 id='options'>
@@ -85,17 +381,16 @@
<term><option>--filter</option> <replaceable>filter</replaceable></term>
<listitem>
<para>
- filter function (median, var, min, max, sum, mean, dilate, erode,
- close, open, homog (central pixel must be identical to all other
- pixels within window), heterog, sobelx (horizontal edge detection),
- sobely (vertical edge detection), sobelxy (diagonal edge detection
- NE-SW), sobelyx (diagonal edge detection NW-SE), smooth, density,
- countid, mode (majority voting, only for classes), smoothnodata
- (smooth nodata values only) values, threshold local filtering,
- ismin, ismax, heterogeneous (central pixel must be different than
- all other pixels within window), order (rank pixels in order),
- stdev, mrf, dwt, dwti, dwt_cut, dwt_cut_from, scramble, shift,
- linearfeature)
+ filter function (nvalid, median, var, min, max, sum, mean, dilate,
+ erode, close, open, homog (central pixel must be identical to all
+ other pixels within window), heterog (central pixel must be
+ different than all other pixels within window), sobelx (horizontal
+ edge detection), sobely (vertical edge detection), sobelxy
+ (diagonal edge detection NE-SW),sobelyx (diagonal edge detection
+ NW-SE), density, countid, mode (majority voting, only for classes),
+ smoothnodata (smooth nodata values only) values, ismin, ismax,
+ order (rank pixels in order), stdev, mrf, dwt, dwti, dwt_cut,
+ dwt_cut_from, scramble, shift, savgolay, percentile, proportion)
</para>
</listitem>
</varlistentry>
@@ -106,7 +401,7 @@
<listitem>
<para>
filter kernel size in x,
- better use odd value to avoid image shift
+ use odd values only
</para>
</listitem>
</varlistentry>
@@ -117,7 +412,7 @@
<listitem>
<para>
filter kernel size in y,
- better use odd value to avoid image shift
+ use odd values only
</para>
</listitem>
</varlistentry>
@@ -412,7 +707,6 @@
<refentrytitle>gdal_translate</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>).
- Empty string: inherit from input image
</para>
</listitem>
</varlistentry>
diff --git a/debian/man/pkfilterdem.1.xml b/debian/man/pkfilterdem.1.xml
index 5873841..7efc484 100644
--- a/debian/man/pkfilterdem.1.xml
+++ b/debian/man/pkfilterdem.1.xml
@@ -105,7 +105,6 @@
<refentrytitle>gdal_translate</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>).
- Empty string: inherit from input image
</para>
</listitem>
</varlistentry>
diff --git a/debian/man/pkfsann.1.xml b/debian/man/pkfsann.1.xml
index b34d789..c34097e 100644
--- a/debian/man/pkfsann.1.xml
+++ b/debian/man/pkfsann.1.xml
@@ -167,27 +167,27 @@
</varlistentry>
<varlistentry>
- <term><option>-s</option> <replaceable>band</replaceable></term>
- <term><option>--start</option> <replaceable>band</replaceable></term>
+ <term><option>-sband</option> <replaceable>band</replaceable></term>
+ <term><option>--startband</option> <replaceable>band</replaceable></term>
<listitem>
<para>
start band sequence number
- (default: 0)
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-e</option> <replaceable>band</replaceable></term>
- <term><option>--end</option> <replaceable>band</replaceable></term>
+ <term><option>-eband</option> <replaceable>band</replaceable></term>
+ <term><option>--endband</option> <replaceable>band</replaceable></term>
<listitem>
<para>
- end band sequence number (set to 0 to include bands)
+ end band sequence number
</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-offset</option> <replaceable>value</replaceable></term>
<term><option>--offset</option> <replaceable>value</replaceable></term>
<listitem>
<para>
@@ -198,6 +198,7 @@
</varlistentry>
<varlistentry>
+ <term><option>-scale</option> <replaceable>value</replaceable></term>
<term><option>--scale</option> <replaceable>value</replaceable></term>
<listitem>
<para>
diff --git a/debian/man/pkfssvm.1.xml b/debian/man/pkfssvm.1.xml
index f31e8af..454dce4 100644
--- a/debian/man/pkfssvm.1.xml
+++ b/debian/man/pkfssvm.1.xml
@@ -166,27 +166,27 @@
</varlistentry>
<varlistentry>
- <term><option>-s</option> <replaceable>band</replaceable></term>
- <term><option>--start</option> <replaceable>band</replaceable></term>
+ <term><option>-sband</option> <replaceable>band</replaceable></term>
+ <term><option>--startband</option> <replaceable>band</replaceable></term>
<listitem>
<para>
start band sequence number
- (default: 0)
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-e</option> <replaceable>band</replaceable></term>
- <term><option>--end</option> <replaceable>band</replaceable></term>
+ <term><option>-eband</option> <replaceable>band</replaceable></term>
+ <term><option>--endband</option> <replaceable>band</replaceable></term>
<listitem>
<para>
- end band sequence number (set to 0 to include bands)
+ end band sequence number
</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-offset</option> <replaceable>value</replaceable></term>
<term><option>--offset</option> <replaceable>value</replaceable></term>
<listitem>
<para>
@@ -197,6 +197,7 @@
</varlistentry>
<varlistentry>
+ <term><option>-scale</option> <replaceable>value</replaceable></term>
<term><option>--scale</option> <replaceable>value</replaceable></term>
<listitem>
<para>
diff --git a/debian/man/pkgetmask.1.xml b/debian/man/pkgetmask.1.xml
index 377ebc6..addcd0c 100644
--- a/debian/man/pkgetmask.1.xml
+++ b/debian/man/pkgetmask.1.xml
@@ -156,7 +156,6 @@
<refentrytitle>gdal_translate</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>).
- Empty string: inherit from input image
</para>
</listitem>
</varlistentry>
diff --git a/debian/man/pkkalman.1.xml b/debian/man/pkkalman.1.xml
index 89d6f4b..0adb2ac 100644
--- a/debian/man/pkkalman.1.xml
+++ b/debian/man/pkkalman.1.xml
@@ -153,45 +153,21 @@
</varlistentry>
<varlistentry>
- <term><option>-modoffset</option> <replaceable>value</replaceable></term>
- <term><option>--modoffset</option> <replaceable>value</replaceable></term>
+ <term><option>-obsmin</option> <replaceable>value</replaceable></term>
+ <term><option>--obsmin</option> <replaceable>value</replaceable></term>
<listitem>
<para>
- offset used to read model input dataset
- (value=offset+scale*readValue)
+ Minimum value for observation data
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-obsoffset</option> <replaceable>value</replaceable></term>
- <term><option>--obsoffset</option> <replaceable>value</replaceable></term>
+ <term><option>-obsmax</option> <replaceable>value</replaceable></term>
+ <term><option>--obsmax</option> <replaceable>value</replaceable></term>
<listitem>
<para>
- offset used to read observation input dataset
- (value=offset+scale*readValue)
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-modscale</option> <replaceable>value</replaceable></term>
- <term><option>--modscale</option> <replaceable>value</replaceable></term>
- <listitem>
- <para>
- scale used to read model input dataset
- (value=offset+scale*readValue)
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-obsscale</option> <replaceable>value</replaceable></term>
- <term><option>--obsscale</option> <replaceable>value</replaceable></term>
- <listitem>
- <para>
- scale used to read observation input dataset
- (value=offset+scale*readValue)
+ Maximum value for observation data
</para>
</listitem>
</varlistentry>
@@ -212,9 +188,7 @@
<term><option>--uncertmodel</option> <replaceable>value</replaceable></term>
<listitem>
<para>
- Multiply this value with std dev of first model image to obtain
- uncertainty of model.
- Default: 2
+ Uncertainty of the model
</para>
</listitem>
</varlistentry>
@@ -230,54 +204,22 @@
</varlistentry>
<varlistentry>
- <term><option>-w</option> <replaceable>value</replaceable></term>
- <term><option>--weight</option> <replaceable>value</replaceable></term>
- <listitem>
- <para>
- Set observation uncertainty as weighted difference between
- observation and model (use <option>-w</option> 0 to use a constant
- observation uncertainty, use <option>-w</option> value >> 1
- to penalize low observation values with respect to model, use
- <option>-w</option> value << 0 to penalize a high observation
- values with respect to model
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-dobs</option> <replaceable>value</replaceable></term>
- <term><option>--deltaobs</option> <replaceable>value</replaceable></term>
- <listitem>
- <para>
- Lower and upper thresholds for relative pixel differences
- (in percentage): (observation-model)/model.
- For instance to force the observation within a +/- 10 % interval,
- use: <option>-dobs</option> <literal>-10</literal>
- <option>-dobs</option> <literal>10</literal>
- (equivalent to <option>-dobs</option> <literal>10</literal>).
- Leave empty to always update on observation
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term><option>-unodata</option> <replaceable>value</replaceable></term>
<term><option>--uncertnodata</option> <replaceable>value</replaceable></term>
<listitem>
<para>
Uncertainty in case of no-data values in observation.
- Default: 10000
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-rs</option></term>
- <term><option>--regsensor</option></term>
+ <term><option>-q</option> <replaceable>value</replaceable></term>
+ <term><option>--q</option> <replaceable>value</replaceable></term>
<listitem>
<para>
- Set optional regression for sensor difference
- (model \- observation).
+ Process noise: expresses instability (variance) of proportions of
+ fine res pixels within a moderate resolution pixel
</para>
</listitem>
</varlistentry>
@@ -293,32 +235,13 @@
</varlistentry>
<varlistentry>
- <term><option>-th</option> <replaceable>value</replaceable></term>
- <term><option>--threshold</option> <replaceable>value</replaceable></term>
- <listitem>
- <para>
- threshold for selecting samples (randomly).
- Provide probability in percentage (>0) or absolute (<0).
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-minreg</option> <replaceable>number</replaceable></term>
- <term><option>--minreg</option> <replaceable>number</replaceable></term>
- <listitem>
- <para>
- Minimum number of pixels to take into account for regression
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-win</option> <replaceable>value</replaceable></term>
- <term><option>--window</option> <replaceable>value</replaceable></term>
+ <term><option>-ot</option> <replaceable>type</replaceable></term>
+ <term><option>--otype</option> <replaceable>type</replaceable></term>
<listitem>
<para>
- window size for calculating regression (use 0 for global)
+ Data type for output image
+ ({Byte / Int16 / UInt16 / UInt32 / Int32 / Float32 / Float64 / CInt16 / CInt32 / CFloat32 / CFloat64}).
+ Empty string: inherit type from input image
</para>
</listitem>
</varlistentry>
diff --git a/debian/man/pklas2img.1.xml b/debian/man/pklas2img.1.xml
index 9b0551d..78584de 100644
--- a/debian/man/pklas2img.1.xml
+++ b/debian/man/pklas2img.1.xml
@@ -33,9 +33,10 @@
set.
The composite rule for multiple returns within a single grid cell can be
set with the option <option>-comp</option>.
- The default attribute is z (heiht), but can also be intensity
- (if available), the return number (<option>-n</option> return) or the
- total number of returns in that grid cell (<option>-n</option> nreturn).
+ The default attribute is z (height), but can also be intensity
+ (if available), the scan angle rank (<option>-n</option> angle), the
+ return number (<option>-n</option> return) or the total number of returns
+ in that grid cell (<option>-n</option> nreturn).
To select specific returns only, set the option <option>-fir</option>
(first, last, single, multiple, or all).
</para>
@@ -70,7 +71,7 @@
<term><option>--name</option> <replaceable>attribute</replaceable></term>
<listitem>
<para>
- names of the attribute to select: intensity, return, nreturn, z
+ names of the attribute to select: intensity, angle, return, nreturn, z
</para>
</listitem>
</varlistentry>
@@ -99,6 +100,26 @@
</varlistentry>
<varlistentry>
+ <term><option>-angle_min</option> <replaceable>value</replaceable></term>
+ <term><option>--angle_min</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ minimum scan angle to read points.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-angle_max</option> <replaceable>value</replaceable></term>
+ <term><option>--angle_max</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ maximum scan angle to read points.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-a_srs</option> <replaceable>EPSG:number</replaceable></term>
<term><option>--a_srs</option> <replaceable>EPSG:number</replaceable></term>
<listitem>
@@ -199,7 +220,6 @@
<refentrytitle>gdal_translate</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>).
- Empty string: inherit from input image
</para>
</listitem>
</varlistentry>
diff --git a/debian/man/pkoptsvm.1.xml b/debian/man/pkoptsvm.1.xml
index 4fbc430..cf0e0db 100644
--- a/debian/man/pkoptsvm.1.xml
+++ b/debian/man/pkoptsvm.1.xml
@@ -192,27 +192,27 @@
</varlistentry>
<varlistentry>
- <term><option>-s</option> <replaceable>band</replaceable></term>
- <term><option>--start</option> <replaceable>band</replaceable></term>
+ <term><option>-sband</option> <replaceable>band</replaceable></term>
+ <term><option>--startband</option> <replaceable>band</replaceable></term>
<listitem>
<para>
start band sequence number
- (default: 0)
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-e</option> <replaceable>band</replaceable></term>
- <term><option>--end</option> <replaceable>band</replaceable></term>
+ <term><option>-eband</option> <replaceable>band</replaceable></term>
+ <term><option>--endband</option> <replaceable>band</replaceable></term>
<listitem>
<para>
- end band sequence number (set to 0 to include bands)
+ end band sequence number
</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-offset</option> <replaceable>value</replaceable></term>
<term><option>--offset</option> <replaceable>value</replaceable></term>
<listitem>
<para>
@@ -223,6 +223,7 @@
</varlistentry>
<varlistentry>
+ <term><option>-scale</option> <replaceable>value</replaceable></term>
<term><option>--scale</option> <replaceable>value</replaceable></term>
<listitem>
<para>
diff --git a/debian/man/pkreclass.1.xml b/debian/man/pkreclass.1.xml
index aa21cd4..9d1039c 100644
--- a/debian/man/pkreclass.1.xml
+++ b/debian/man/pkreclass.1.xml
@@ -142,6 +142,20 @@
</varlistentry>
<varlistentry>
+ <term><option>-of</option> <replaceable>format</replaceable></term>
+ <term><option>--oformat</option> <replaceable>format</replaceable></term>
+ <listitem>
+ <para>
+ Output image format (see also
+ <citerefentry>
+ <refentrytitle>gdal_translate</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-b</option> <replaceable>band</replaceable></term>
<term><option>--band</option> <replaceable>band</replaceable></term>
<listitem>
diff --git a/debian/man/pksetmask.1.xml b/debian/man/pksetmask.1.xml
index 5101cb5..b192e04 100644
--- a/debian/man/pksetmask.1.xml
+++ b/debian/man/pksetmask.1.xml
@@ -141,7 +141,6 @@
<refentrytitle>gdal_translate</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>).
- Empty string: inherit from input image
</para>
</listitem>
</varlistentry>
diff --git a/debian/man/pkstat.1.xml b/debian/man/pkstat.1.xml
index 867bf33..14d0cb3 100644
--- a/debian/man/pkstat.1.xml
+++ b/debian/man/pkstat.1.xml
@@ -67,6 +67,18 @@
<listitem>
<para>
Shows basic statistics
+ (calculate in memory)
+ (min,max, mean and stdDev of the raster datasets)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-fstats</option></term>
+ <term><option>--fstatistics</option></term>
+ <listitem>
+ <para>
+ Shows basic statistics using GDAL computeStatistics
(min,max, mean and stdDev of the raster datasets)
</para>
</listitem>
diff --git a/debian/man/pkstatprofile.1.xml b/debian/man/pkstatprofile.1.xml
index bf43c5a..5589bda 100644
--- a/debian/man/pkstatprofile.1.xml
+++ b/debian/man/pkstatprofile.1.xml
@@ -94,6 +94,13 @@
</tgroup>
</informaltable>
</para>
+ <para>
+ Calculate min and max NDVI in time series
+ <screen>
+<command>pkstatprofile</command> <option>-i</option> <replaceable>modis_ndvi_2010.tif</replaceable> <option>-o</option> <replaceable>modis_stats_2010.tif</replaceable> <option>-f</option> <replaceable>min</replaceable> <option>-f</option> <replaceable>max</replaceable>
+ </screen>
+ </para>
+
</refsect1>
<refsect1 id='options'>
@@ -237,19 +244,4 @@
</refsect1>
- <refsect1 id='example'>
- <title>EXAMPLE</title>
-
- <example>
- <para>
- Calculate min and max NDVI in time series
- </para>
-
- <screen>
-<command>pkstatprofile</command> <option>-i</option> <replaceable>modis_ndvi_2010.tif</replaceable> <option>-o</option> <replaceable>modis_stats_2010.tif</replaceable> <option>-f</option> <replaceable>min</replaceable> <option>-f</option> <replaceable>max</replaceable>
- </screen>
- </example>
-
- </refsect1>
-
</refentry>
diff --git a/debian/man/pksvm.1.xml b/debian/man/pksvm.1.xml
index 42f9b6b..3dbd1d5 100644
--- a/debian/man/pksvm.1.xml
+++ b/debian/man/pksvm.1.xml
@@ -138,7 +138,6 @@
<refentrytitle>gdal_translate</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>).
- Empty string: inherit from input image
</para>
</listitem>
</varlistentry>
@@ -224,8 +223,8 @@
<term><option>--mask</option> <replaceable>filename</replaceable></term>
<listitem>
<para>
- Use the first band of the specified file as a validity mask.
- Nodata values can be set with the option
+ Only classify within specified mask (vector or raster).
+ For raster mask, set nodata values with the option
<option>--msknodata</option>.
</para>
</listitem>
@@ -274,14 +273,15 @@
<listitem>
<para>
Band index (starting from 0, either use <option>--band</option>
- option or use <option>--start</option> to <option>--end</option>)
+ option or use <option>--startband</option> to
+ <option>--endband</option>)
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-s</option> <replaceable>band</replaceable></term>
- <term><option>--start</option> <replaceable>band</replaceable></term>
+ <term><option>-sband</option> <replaceable>band</replaceable></term>
+ <term><option>--startband</option> <replaceable>band</replaceable></term>
<listitem>
<para>
Start band sequence number
@@ -290,11 +290,11 @@
</varlistentry>
<varlistentry>
- <term><option>-e</option> <replaceable>band</replaceable></term>
- <term><option>--end</option> <replaceable>band</replaceable></term>
+ <term><option>-eband</option> <replaceable>band</replaceable></term>
+ <term><option>--endband</option> <replaceable>band</replaceable></term>
<listitem>
<para>
- End band sequence number (set to 0 to include all bands)
+ End band sequence number
</para>
</listitem>
</varlistentry>
@@ -375,6 +375,7 @@
</varlistentry>
<varlistentry>
+ <term><option>-offset</option> <replaceable>value</replaceable></term>
<term><option>--offset</option> <replaceable>value</replaceable></term>
<listitem>
<para>
@@ -385,6 +386,7 @@
</varlistentry>
<varlistentry>
+ <term><option>-scale</option> <replaceable>value</replaceable></term>
<term><option>--scale</option> <replaceable>value</replaceable></term>
<listitem>
<para>
--
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