[pktools] 04/07: Update manpages for upstream changes.
Sebastiaan Couwenberg
sebastic at moszumanska.debian.org
Fri Jan 22 12:08:19 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 498cc14a2cb45aa747f0b904e07151eaac54c976
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Fri Jan 22 12:16:24 2016 +0100
Update manpages for upstream changes.
---
debian/changelog | 1 +
debian/man/pkann.1.xml | 3 +-
debian/man/pkcomposite.1.xml | 10 ++++
debian/man/pkcrop.1.xml | 10 ++++
debian/man/pkkalman.1.xml | 116 +++++++++++++++++++++++++++++++++++++++----
debian/man/pksvm.1.xml | 3 +-
6 files changed, 129 insertions(+), 14 deletions(-)
diff --git a/debian/changelog b/debian/changelog
index d792b5a..5d46535 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,6 +1,7 @@
pktools (2.6.6-1) UNRELEASED; urgency=medium
* New upstream release.
+ * Update manpages for upstream changes.
-- Bas Couwenberg <sebastic at debian.org> Fri, 22 Jan 2016 11:48:31 +0100
diff --git a/debian/man/pkann.1.xml b/debian/man/pkann.1.xml
index a969ccc..6b5d97a 100644
--- a/debian/man/pkann.1.xml
+++ b/debian/man/pkann.1.xml
@@ -152,8 +152,7 @@
<term><option>--msknodata</option> <replaceable>value</replaceable></term>
<listitem>
<para>
- mask value(s) not to consider for classification (use negative
- values if only these values should be taken into account).
+ mask value(s) not to consider for classification.
Values will be taken over in classification image.
Default is 0.
</para>
diff --git a/debian/man/pkcomposite.1.xml b/debian/man/pkcomposite.1.xml
index 99ad5e5..e511826 100644
--- a/debian/man/pkcomposite.1.xml
+++ b/debian/man/pkcomposite.1.xml
@@ -369,6 +369,16 @@
</varlistentry>
<varlistentry>
+ <term><option>-align</option></term>
+ <term><option>--align</option></term>
+ <listitem>
+ <para>
+ Align output bounding box to first input image
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-d</option> <replaceable>description</replaceable></term>
<term><option>--description</option> <replaceable>description</replaceable></term>
<listitem>
diff --git a/debian/man/pkcrop.1.xml b/debian/man/pkcrop.1.xml
index 419f83f..32c6588 100644
--- a/debian/man/pkcrop.1.xml
+++ b/debian/man/pkcrop.1.xml
@@ -396,6 +396,16 @@
</varlistentry>
<varlistentry>
+ <term><option>-align</option></term>
+ <term><option>--align</option></term>
+ <listitem>
+ <para>
+ Align output bounding box to input image
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-d</option> <replaceable>description</replaceable></term>
<term><option>--description</option> <replaceable>description</replaceable></term>
<listitem>
diff --git a/debian/man/pkkalman.1.xml b/debian/man/pkkalman.1.xml
index 0adb2ac..1119383 100644
--- a/debian/man/pkkalman.1.xml
+++ b/debian/man/pkkalman.1.xml
@@ -22,8 +22,24 @@
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
- <command>pkkalman</command> is a utility for kalman raster images:
- median, min/max, morphological, kalmaning.
+ <command>pkkalman</command> will complement a time series of observations
+ (option <option>-obs</option>) at fine spatial resolution.
+ A data assimilation technique based on a Kalman filter is hereby used.
+ The data at fine spatial resolution are assimilated with coarse spatial
+ resolution time series at a finer temporal resolution, referred to as a
+ model (option <option>-mod</option>).
+ The time series for both observation and model can either be provided as
+ multi-band raster datasets or as multiple single band datasets.
+ Missing data in the observations are predicted by the algorithm.
+ The model must cover at least the spatial coverage of the observation.
+ The missing data must be provided either as nodata values in the input
+ (using option <option>-obsnodata</option>) or as an external mask (using
+ option <option>-obsmask</option>).
+ The time sequence for the model and observation should be provided via
+ the options <option>-tmod</option> and <option>-tobs</option>.
+ Tuning parameters for the algorithm are process noise (option
+ <option>-q</option>) and the weights for uncertainty of valid
+ observations (<option>-uo</option>) and the model (<option>-um</option>).
</para>
</refsect1>
@@ -46,10 +62,24 @@
<term><option>--model</option> <replaceable>filename</replaceable></term>
<listitem>
<para>
- model input datasets, e.g., MODIS (use:
- <option>-mod</option> <replaceable>model1</replaceable>
- <option>-mod</option> <replaceable>model2</replaceable>
- etc.)
+ coarse spatial resolution input datasets(s) used as model.
+ Use either multi-band input (<option>-model</option>
+ <replaceable>multiband_model.tif</replaceable>) or multiple
+ single-band inputs
+ (<option>-mod</option> <replaceable>model1</replaceable>
+ <option>-mod</option> <replaceable>model2</replaceable> etc.)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-modmask</option> <replaceable>filename</replaceable></term>
+ <term><option>--modmask</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ model mask datasets(s).
+ Must have same dimension as model input.
+ Use either multi-band input or multiple single-band inputs
</para>
</listitem>
</varlistentry>
@@ -59,10 +89,24 @@
<term><option>--observation</option> <replaceable>filename</replaceable></term>
<listitem>
<para>
- observation input datasets, e.g., landsat (use:
- <option>-obs</option> <replaceable>obs1</replaceable>
- <option>-obs</option> <replaceable>obs2</replaceable>
- etc.)
+ fine spatial resolution input dataset(s) used as observation.
+ Use either multi-band input (<option>-obs</option>
+ <replaceable>multiband_obs.tif</replaceable>) or multiple
+ single-band inputs (<option>-obs</option>
+ <replaceable>obs1</replaceable> <option>-obs</option>
+ <replaceable>obs2</replaceable> etc.)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-obsmask</option> <replaceable>filename</replaceable></term>
+ <term><option>--obsmask</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ observation mask dataset(s).
+ Must have same dimension as observation input
+ (use multi-band input or multiple single-band inputs)
</para>
</listitem>
</varlistentry>
@@ -113,6 +157,16 @@
</varlistentry>
<varlistentry>
+ <term><option>-u_ofw</option> <replaceable>filename</replaceable></term>
+ <term><option>--u_outputfw</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Uncertainty output raster dataset for forward model
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-obw</option> <replaceable>filename</replaceable></term>
<term><option>--outputbw</option> <replaceable>filename</replaceable></term>
<listitem>
@@ -123,6 +177,16 @@
</varlistentry>
<varlistentry>
+ <term><option>-u_obw</option> <replaceable>filename</replaceable></term>
+ <term><option>--u_outputbw</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Uncertainty output raster dataset for backward model
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-ofb</option> <replaceable>filename</replaceable></term>
<term><option>--outputfb</option> <replaceable>filename</replaceable></term>
<listitem>
@@ -133,6 +197,16 @@
</varlistentry>
<varlistentry>
+ <term><option>-u_ofb</option> <replaceable>filename</replaceable></term>
+ <term><option>--u_outputfb</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Uncertainty output raster dataset for smooth model
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-modnodata</option> <replaceable>value</replaceable></term>
<term><option>--modnodata</option> <replaceable>value</replaceable></term>
<listitem>
@@ -153,6 +227,26 @@
</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
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-mskband</option> <replaceable>value</replaceable></term>
+ <term><option>--mskband</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Mask band to read (0 indexed)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-obsmin</option> <replaceable>value</replaceable></term>
<term><option>--obsmin</option> <replaceable>value</replaceable></term>
<listitem>
@@ -230,6 +324,8 @@
<listitem>
<para>
Downsampling factor for reading model data to calculate regression
+ (default is ratio between coarse (model) and fine (obs) resolution
+ raster datasets)
</para>
</listitem>
</varlistentry>
diff --git a/debian/man/pksvm.1.xml b/debian/man/pksvm.1.xml
index 3dbd1d5..58133ee 100644
--- a/debian/man/pksvm.1.xml
+++ b/debian/man/pksvm.1.xml
@@ -235,8 +235,7 @@
<term><option>--msknodata</option> <replaceable>value</replaceable></term>
<listitem>
<para>
- Mask value(s) not to consider for classification (use negative
- values if only these values should be taken into account).
+ Mask value(s) not to consider for classification.
Values will be taken over in classification image.
</para>
</listitem>
--
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