This is an automated email from the git hooks/post-receive script. sebastic pushed a commit to branch master in repository pktools.
commit 4ebd73c48d1022e5c0db7c81e18584111ed1c0d8 Author: Bas Couwenberg <sebas...@xs4all.nl> Date: Sun Mar 8 16:20:26 2015 +0100 Add man pages for pkstat & pkkalman. --- debian/changelog | 1 + debian/man/pkkalman.1.xml | 365 ++++++++++++++++++++++++++++++++++++++++++ debian/man/pkstat.1.xml | 397 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 763 insertions(+) diff --git a/debian/changelog b/debian/changelog index 0b77d5e..f0808fb 100644 --- a/debian/changelog +++ b/debian/changelog @@ -4,6 +4,7 @@ pktools (2.6.3-1~exp1) UNRELEASED; urgency=medium * Update copyright years in copyright file. * Update man pages for upstream changes. * Drop deprecated-noinst.patch, applied upstream. + * Add man pages for pkstat & pkkalman. -- Bas Couwenberg <sebas...@debian.org> Sun, 08 Mar 2015 13:01:56 +0100 diff --git a/debian/man/pkkalman.1.xml b/debian/man/pkkalman.1.xml new file mode 100644 index 0000000..89d6f4b --- /dev/null +++ b/debian/man/pkkalman.1.xml @@ -0,0 +1,365 @@ +<?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='pkkalman'> + + <refmeta> + <refentrytitle>pkkalman</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>pkkalman</refname> + <refpurpose>kalman raster images: median, min/max, morphological, kalmaning</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>pkkalman</command> + <arg choice='opt'><replaceable>options</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>pkkalman</command> is a utility for kalman raster images: + median, min/max, morphological, kalmaning. + </para> + </refsect1> + + <refsect1 id='options'> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>-dir</option> <replaceable>forward|backward|smooth</replaceable></term> + <term><option>--direction</option> <replaceable>forward|backward|smooth</replaceable></term> + <listitem> + <para> + direction to run model (forward|backward|smooth) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-mod</option> <replaceable>filename</replaceable></term> + <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.) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-obs</option> <replaceable>filename</replaceable></term> + <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.) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-tmod</option> <replaceable>number</replaceable></term> + <term><option>--tmodel</option> <replaceable>number</replaceable></term> + <listitem> + <para> + time sequence of model input. + Sequence must have exact same length as model input. + Leave empty to have default sequence 0,1,2,etc. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-tobs</option> <replaceable>number</replaceable></term> + <term><option>--tobservation</option> <replaceable>number</replaceable></term> + <listitem> + <para> + time sequence of observation input. + Sequence must have exact same length as observation input + </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> + <para> + Override the projection for the output file + (leave blank to copy from input file, use epsg:3035 to use + European projection and force to European grid) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-ofw</option> <replaceable>filename</replaceable></term> + <term><option>--outputfw</option> <replaceable>filename</replaceable></term> + <listitem> + <para> + 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> + <para> + 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> + <para> + 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> + <para> + invalid value for model input + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-obsnodata</option> <replaceable>value</replaceable></term> + <term><option>--obsnodata</option> <replaceable>value</replaceable></term> + <listitem> + <para> + invalid value for observation input + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-modoffset</option> <replaceable>value</replaceable></term> + <term><option>--modoffset</option> <replaceable>value</replaceable></term> + <listitem> + <para> + offset used to read model input dataset + (value=offset+scale*readValue) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-obsoffset</option> <replaceable>value</replaceable></term> + <term><option>--obsoffset</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) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-eps</option> <replaceable>value</replaceable></term> + <term><option>--eps</option> <replaceable>value</replaceable></term> + <listitem> + <para> + epsilon for non zero division. + Default: 0.00001 + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-um</option> <replaceable>value</replaceable></term> + <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 + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-uo</option> <replaceable>value</replaceable></term> + <term><option>--uncertobs</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Uncertainty of valid observations + </para> + </listitem> + </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> + <listitem> + <para> + Set optional regression for sensor difference + (model \- observation). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-down</option> <replaceable>number</replaceable></term> + <term><option>--down</option> <replaceable>number</replaceable></term> + <listitem> + <para> + Downsampling factor for reading model data to calculate regression + </para> + </listitem> + </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> + <listitem> + <para> + window size for calculating regression (use 0 for global) + </para> + </listitem> + </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>-co</option> <replaceable>NAME=VALUE</replaceable></term> + <term><option>--co</option> <replaceable>NAME=VALUE</replaceable></term> + <listitem> + <para> + Creation option for output file. + Multiple options can be specified. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-v</option> <replaceable>level</replaceable></term> + <term><option>--verbose</option> <replaceable>level</replaceable></term> + <listitem> + <para> + verbose mode when positive + </para> + </listitem> + </varlistentry> + + </variablelist> + </refsect1> + +</refentry> diff --git a/debian/man/pkstat.1.xml b/debian/man/pkstat.1.xml new file mode 100644 index 0000000..867bf33 --- /dev/null +++ b/debian/man/pkstat.1.xml @@ -0,0 +1,397 @@ +<?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='pkstat'> + + <refmeta> + <refentrytitle>pkstat</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>pkstat</refname> + <refpurpose>calculate basic statistics from raster dataset</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>pkstat</command> + <arg choice='opt'><replaceable>options</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>pkstat</command> is utility to calculate basic statistics from + a raster dataset. + </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> + name of the input raster dataset + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-b</option> <replaceable>band</replaceable></term> + <term><option>--band</option> <replaceable>band</replaceable></term> + <listitem> + <para> + band(s) on which to calculate statistics + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-f</option></term> + <term><option>--filename</option></term> + <listitem> + <para> + Shows image filename + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-stats</option></term> + <term><option>--statistics</option></term> + <listitem> + <para> + Shows basic statistics + (min,max, mean and stdDev of the raster datasets) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-ulx</option> <replaceable>value</replaceable></term> + <term><option>--ulx</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Upper left x value bounding box + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-uly</option> <replaceable>value</replaceable></term> + <term><option>--uly</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Upper left y value bounding box + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-lrx</option> <replaceable>value</replaceable></term> + <term><option>--lrx</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Lower right x value bounding box + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-lry</option> <replaceable>value</replaceable></term> + <term><option>--lry</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Lower right y value bounding box + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-nodata</option> <replaceable>value</replaceable></term> + <term><option>--nodata</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Set nodata value(s) + </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). + Can be used to create grid points. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-rnd</option> <replaceable>number</replaceable></term> + <term><option>--rnd</option> <replaceable>number</replaceable></term> + <listitem> + <para> + generate random numbers + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-mean</option></term> + <term><option>--mean</option></term> + <listitem> + <para> + calculate mean + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-median</option></term> + <term><option>--median</option></term> + <listitem> + <para> + calculate median + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-var</option></term> + <term><option>--var</option></term> + <listitem> + <para> + calculate variance + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-skew</option></term> + <term><option>--skewness</option></term> + <listitem> + <para> + calculate skewness + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-kurt</option></term> + <term><option>--kurtosis</option></term> + <listitem> + <para> + calculate kurtosis + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-stdev</option></term> + <term><option>--stdev</option></term> + <listitem> + <para> + calculate standard deviation + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-sum</option></term> + <term><option>--sum</option></term> + <listitem> + <para> + calculate sum of column + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-mm</option></term> + <term><option>--minmax</option></term> + <listitem> + <para> + calculate minimum and maximum value + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-min</option></term> + <term><option>--min</option></term> + <listitem> + <para> + calculate minimum value + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-max</option></term> + <term><option>--max</option></term> + <listitem> + <para> + calculate maximum value + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-src_min</option> <replaceable>value</replaceable></term> + <term><option>--src_min</option> <replaceable>value</replaceable></term> + <listitem> + <para> + start reading source from this minimum value + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-src_max</option> <replaceable>value</replaceable></term> + <term><option>--src_max</option> <replaceable>value</replaceable></term> + <listitem> + <para> + stop reading source from this maximum value + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-hist</option></term> + <term><option>--hist</option></term> + <listitem> + <para> + calculate histogram + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-hist2d</option></term> + <term><option>--hist2d</option></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-nbin</option> <replaceable>value</replaceable></term> + <term><option>--nbin</option> <replaceable>value</replaceable></term> + <listitem> + <para> + number of bins to calculate histogram + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-rel</option></term> + <term><option>--relative</option></term> + <listitem> + <para> + use percentiles for histogram to calculate histogram + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-kde</option></term> + <term><option>--kde</option></term> + <listitem> + <para> + Use Kernel density estimation when producing histogram. + The standard deviation is estimated based on Silverman's rule of thumb. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-cor</option></term> + <term><option>--correlation</option></term> + <listitem> + <para> + calculate Pearson produc-moment correlation coefficient between + two raster datasets (defined by + <option>-c</option> <replaceable>col1</replaceable> + <option>-c</option> <replaceable>col2</replaceable>) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-rmse</option></term> + <term><option>--rmse</option></term> + <listitem> + <para> + calculate root mean square error between two raster datasets + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-reg</option></term> + <term><option>--regression</option></term> + <listitem> + <para> + calculate linear regression between two raster datasets and get + correlation coefficient + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-regerr</option></term> + <term><option>--regerr</option></term> + <listitem> + <para> + calculate linear regression between two raster datasets and get + root mean square error + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-preg</option></term> + <term><option>--preg</option></term> + <listitem> + <para> + calculate perpendicular regression between two raster datasets and + get correlation coefficient + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-pregerr</option></term> + <term><option>--pregerr</option></term> + <listitem> + <para> + calculate perpendicular regression between two raster datasets and + get root mean square error + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-v</option> <replaceable>level</replaceable></term> + <term><option>--verbose</option> <replaceable>level</replaceable></term> + <listitem> + <para> + verbose mode when positive + </para> + </listitem> + </varlistentry> + + </variablelist> + </refsect1> + +</refentry> -- Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/pktools.git _______________________________________________ Pkg-grass-devel mailing list Pkg-grass-devel@lists.alioth.debian.org http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-grass-devel