[pktools] 04/05: Update man pages with changes in upstream docs.
Bas Couwenberg
sebastic at xs4all.nl
Wed Jan 28 23:26:54 UTC 2015
This is an automated email from the git hooks/post-receive script.
sebastic-guest pushed a commit to branch master
in repository pktools.
commit 424575afb7f066be27579205e454f7701d65c10d
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Wed Jan 28 23:04:41 2015 +0100
Update man pages with changes in upstream docs.
---
debian/changelog | 1 +
debian/man/pkcomposite.1.xml | 15 +++----
debian/man/pkfilter.1.xml | 103 ++++++++++++++++++++++++++-----------------
3 files changed, 71 insertions(+), 48 deletions(-)
diff --git a/debian/changelog b/debian/changelog
index 809cbc5..45922ef 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,6 +1,7 @@
pktools (2.6.2-1) UNRELEASED; urgency=medium
* New upstream release.
+ * Update man pages with changes in upstream docs.
-- Bas Couwenberg <sebastic at xs4all.nl> Wed, 28 Jan 2015 09:24:30 +0100
diff --git a/debian/man/pkcomposite.1.xml b/debian/man/pkcomposite.1.xml
index d4c8723..ddeda78 100644
--- a/debian/man/pkcomposite.1.xml
+++ b/debian/man/pkcomposite.1.xml
@@ -433,24 +433,23 @@
</para>
<para>
A1. For individual invalid value(s) in input image, use
- <option>-t</option> (<option>--invalid</option>)
+ <option>-srcnodata</option>
</para>
<para>
Usage: use unique value for each invalid bands set in
- <option>-vb</option> (<option>--bndnodata</option>) or use a single
- value that will be applied to all invalid bands
+ <option>--bndnodata</option> or use a single value that
+ will be applied to all invalid bands
</para>
<para>
Example:
<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>-t</option> <replaceable>0</replaceable> <option>-t</option> <replaceable>255</replaceable> <option>-vb</option> <replaceable>0</replaceable> <option>-vb</option> <replaceable>1</replaceable>
+<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>-srcnodata</option> <replaceable>0</replaceable> <option>-srcnodata</option> <replaceable>255</replaceable> <option>-bndnodata</option> <replaceable>0</replaceable> <option>-bndnodata</option> <replaceable>1</replaceable>
</screen>
will consider 0 in band 0 and 255 in band 1 of input images as no value
</para>
<para>
<screen>
-pkcomposite -i input1.tif -i input2.tif -o output.tif -t 0 -vb 0 -vb 1
-<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>-t</option> <replaceable>0</replaceable> <option>-vb</option> <replaceable>0</replaceable> <option>-vb</option> <replaceable>1</replaceable>
+<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>-srcnodata</option> <replaceable>0</replaceable> <option>-bndnodata</option> <replaceable>0</replaceable> <option>-bndnodata</option> <replaceable>1</replaceable>
</screen>
will consider 0 in both bands 0 and 1 of input images as no value
</para>
@@ -459,12 +458,12 @@ pkcomposite -i input1.tif -i input2.tif -o output.tif -t 0 -vb 0 -vb 1
<option>-min</option> (<option>--min</option>) and
<option>-max</option> (<option>--max</option>)
Usage: use unique range set for each invalid bands set in
- <option>-vb</option> (<option>--bndnodata</option>)
+ <option>-bndnodata</option>
</para>
<para>
Example:
<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>-min</option> <replaceable>0</replaceable> <option>-max</option> <replaceable>200</replaceable> <option>-min</option> <replaceable>0</replaceable> <option>-max</option> <replaceable>2</replaceable> <option>-vb</option> <replaceable>0</replaceable> <option>-vb</option> <replaceab [...]
+<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>-min</option> <replaceable>0</replaceable> <option>-max</option> <replaceable>200</replaceable> <option>-min</option> <replaceable>0</replaceable> <option>-max</option> <replaceable>2</replaceable> <option>-bndnodata</option> <replaceable>0</replaceable> <option>-bndnodata</opti [...]
</screen>
will consider all negative values in band 0 and 1 of input images as
invalid.
diff --git a/debian/man/pkfilter.1.xml b/debian/man/pkfilter.1.xml
index 2bebec6..3f01b86 100644
--- a/debian/man/pkfilter.1.xml
+++ b/debian/man/pkfilter.1.xml
@@ -17,6 +17,15 @@
<command>pkfilter</command>
<arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg>
<arg choice='plain'><option>-o</option> <replaceable>output</replaceable></arg>
+ <group>
+ <arg choice='plain'><option>-f</option> <replaceable>filter</replaceable></arg>
+ <arg choice='plain'><option>-srf</option> <replaceable>file</replaceable>
+ <arg choice='opt' rep='repeat'><option>-srf</option> <replaceable>file</replaceable></arg>
+ </arg>
+ <arg choice='plain'><option>-fwhm</option> <replaceable>value</replaceable>
+ <arg choice='opt' rep='repeat'><option>-fwhm</option> <replaceable>value</replaceable></arg>
+ </arg>
+ </group>
<arg choice='opt'><replaceable>options</replaceable></arg>
<arg choice='opt'><replaceable>advanced options</replaceable></arg>
</cmdsynopsis>
@@ -33,7 +42,8 @@
(3, 5, 7, ...).
You can set the window sizes in X and Y directions separately with the
options <option>-dx</option> and <option>-dy</option>.
- A circular kernel (disc) is applied if option <option>-c</option> is set.
+ A circular kernel (disc) is applied if option <option>-circ</option> is
+ set.
An overview of the supported filters (option
<option>-f</option>|<option>--filter</option>) is given below.
You can create customized filters by defining your own filter taps
@@ -91,71 +101,81 @@
</varlistentry>
<varlistentry>
- <term><option>-v</option> <replaceable>level</replaceable></term>
- <term><option>--verbose</option> <replaceable>level</replaceable></term>
+ <term><option>-dx</option> <replaceable>value</replaceable></term>
+ <term><option>--dx</option> <replaceable>value</replaceable></term>
<listitem>
<para>
- verbose mode if > 0
+ filter kernel size in x,
+ better use odd value to avoid image shift
</para>
</listitem>
</varlistentry>
- </variablelist>
-
- <para>Advanced options</para>
- <variablelist>
+ <varlistentry>
+ <term><option>-dy</option> <replaceable>value</replaceable></term>
+ <term><option>--dy</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ filter kernel size in y,
+ better use odd value to avoid image shift
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
- <term><option>-circ</option></term>
- <term><option>--circular</option></term>
+ <term><option>-dz</option> <replaceable>value</replaceable></term>
+ <term><option>--dz</option> <replaceable>value</replaceable></term>
<listitem>
<para>
- circular disc kernel for dilation and erosion
+ filter kernel size in z (band or spectral dimension),
+ must be odd (example: 3).
+ Set dz>0 if 1-D filter must be used in band domain
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-r</option> <replaceable>method</replaceable></term>
- <term><option>--resampling-method</option> <replaceable>method</replaceable></term>
+ <term><option>-nodata</option> <replaceable>value</replaceable></term>
+ <term><option>--nodata</option> <replaceable>value</replaceable></term>
<listitem>
<para>
- Resampling method for shifting operation (near: nearest neighbour,
- bilinear: bi-linear interpolation).
+ nodata value(s) (used for smoothnodata filter)
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-dx</option> <replaceable>value</replaceable></term>
- <term><option>--dx</option> <replaceable>value</replaceable></term>
+ <term><option>-v</option> <replaceable>level</replaceable></term>
+ <term><option>--verbose</option> <replaceable>level</replaceable></term>
<listitem>
<para>
- filter kernel size in x,
- better use odd value to avoid image shift
+ verbose mode if > 0
</para>
</listitem>
</varlistentry>
+ </variablelist>
+
+ <para>Advanced options</para>
+ <variablelist>
+
<varlistentry>
- <term><option>-dy</option> <replaceable>value</replaceable></term>
- <term><option>--dy</option> <replaceable>value</replaceable></term>
+ <term><option>-circ</option></term>
+ <term><option>--circular</option></term>
<listitem>
<para>
- filter kernel size in y,
- better use odd value to avoid image shift
+ circular disc kernel for dilation and erosion
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-dz</option> <replaceable>value</replaceable></term>
- <term><option>--dz</option> <replaceable>value</replaceable></term>
+ <term><option>-r</option> <replaceable>method</replaceable></term>
+ <term><option>--resampling-method</option> <replaceable>method</replaceable></term>
<listitem>
<para>
- filter kernel size in z (band or spectral dimension),
- must be odd (example: 3).
- Set dz>0 if 1-D filter must be used in band domain
+ Resampling method for shifting operation (near: nearest neighbour,
+ bilinear: bi-linear interpolation).
</para>
</listitem>
</varlistentry>
@@ -217,16 +237,6 @@
</varlistentry>
<varlistentry>
- <term><option>-nodata</option> <replaceable>value</replaceable></term>
- <term><option>--nodata</option> <replaceable>value</replaceable></term>
- <listitem>
- <para>
- nodata value(s) (used for smoothnodata filter)
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term><option>-tap</option> <replaceable>filename</replaceable></term>
<term><option>--tap</option> <replaceable>filename</replaceable></term>
<listitem>
@@ -434,7 +444,7 @@
Use a circular kernel (instead of rectangular) of size 3x3.
</para>
<screen>
-<command>pkfilter</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>filter.tif</replaceable> <option>-dx</option> <replaceable>3</replaceable> <option>-dy</option> <replaceable>3</replaceable> <option>-f</option> <replaceable>dilate</replaceable> <option>-c</option>
+<command>pkfilter</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>filter.tif</replaceable> <option>-dx</option> <replaceable>3</replaceable> <option>-dy</option> <replaceable>3</replaceable> <option>-f</option> <replaceable>dilate</replaceable> <option>-circ</option>
</screen>
<para>
@@ -444,7 +454,7 @@
dilate cloud values in input image that are flagged as 255
</para>
<screen>
-<command>pkfilter</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>filter.tif</replaceable> <option>-dx</option> <replaceable>3</replaceable> <option>-dy</option> <replaceable>3</replaceable> <option>-class</option> <replaceable>255</replaceable> <option>-f</option> <replaceable>dilate</replaceable> <option>-c</option>
+<command>pkfilter</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>filter.tif</replaceable> <option>-dx</option> <replaceable>3</replaceable> <option>-dy</option> <replaceable>3</replaceable> <option>-class</option> <replaceable>255</replaceable> <option>-f</option> <replaceable>dilate</replaceable> <option>-circ</option>
</screen>
</example>
@@ -472,6 +482,19 @@
<screen>
<command>pkfilter</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>filter_stdev.tif</replaceable> <option>-dz</option> <replaceable>1</replaceable> <option>-f</option> <replaceable>stdev</replaceable>
</screen>
+
+ <para>
+ "Smooth" (interpolate) nodata in spectral/temporal domain
+ (<option>-dz</option> 1), using a linear interpolation.
+ The following interpolation types are supported:
+ akima (default), linear, polynomial, cspline, cspline_periodic,
+ akima_periodic (please check
+ <ulink url="http://www.gnu.org/software/gsl/manual/html_node/Interpolation-Types.html">gsl</ulink>
+ page for more information on the interpolation types).
+ </para>
+ <screen>
+<command>pkfilter</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>input_smoothed.tif</replaceable> <option>-dz</option> <replaceable>1</replaceable> <option>-f</option> <replaceable>smoothnodata</replaceable> <option>-interp</option> <replaceable>linear</replaceable>
+ </screen>
</example>
</refsect1>
--
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