[pktools] 02/04: Add manpage for pkstatprofile.
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 7022328e5163366a1eebc63f20af6279354b884c
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Fri Dec 18 15:06:32 2015 +0100
Add manpage for pkstatprofile.
---
debian/changelog | 1 +
debian/man/pkstatprofile.1.xml | 255 +++++++++++++++++++++++++++++++++++++++++
2 files changed, 256 insertions(+)
diff --git a/debian/changelog b/debian/changelog
index e8aec0f..6b64451 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -4,6 +4,7 @@ pktools (2.6.5-1) UNRELEASED; urgency=medium
* Update libgsl-dev dependency for pktools-dev too.
* Drop gdal-2.0.patch, applied upstream.
* Update symbols for amd64.
+ * Add manpage for pkstatprofile.
-- Bas Couwenberg <sebastic at debian.org> Fri, 18 Dec 2015 02:55:14 +0100
diff --git a/debian/man/pkstatprofile.1.xml b/debian/man/pkstatprofile.1.xml
new file mode 100644
index 0000000..bf43c5a
--- /dev/null
+++ b/debian/man/pkstatprofile.1.xml
@@ -0,0 +1,255 @@
+<?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='pkstatprofile'>
+
+ <refmeta>
+ <refentrytitle>pkstatprofile</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pkstatprofile</refname>
+ <refpurpose>program to calculate statistics in temporal or spectral profile</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pkstatprofile</command>
+ <arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg>
+ <arg choice='plain'><option>-o</option> <replaceable>output</replaceable></arg>
+ <arg choice='opt'><option>-f</option> <replaceable>function</replaceable></arg>
+ <arg choice='opt'><replaceable>options</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>pkstatprofile</command> calculates statistics for a temporal
+ (time series) or spectral profile.
+ </para>
+ <para>
+ <informaltable frame='none'>
+ <tgroup cols='2'>
+ <thead>
+ <row>
+ <entry>Function</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>mean</entry>
+ <entry>calculate mean 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>stdev</entry>
+ <entry>calculate standard deviation 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>mode</entry>
+ <entry>calculate mode of all values</entry>
+ </row>
+ <row>
+ <entry>ismin</entry>
+ <entry>1 if value is minimum, else 0</entry>
+ </row>
+ <row>
+ <entry>ismax</entry>
+ <entry>1 if value is maximum, else 0</entry>
+ </row>
+ <row>
+ <entry>per</entry>
+ <entry>calculate percentile in time series (provide percentage value as argument)</entry>
+ </row>
+ <row>
+ <entry>prop</entry>
+ <entry>calculate proportion</entry>
+ </row>
+ <row>
+ <entry>nvalid</entry>
+ <entry>report number of valid observations</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </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>
+ Input image file.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o</option> <replaceable>filename</replaceable></term>
+ <term><option>--output</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Output image file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f</option> <replaceable>function</replaceable></term>
+ <term><option>--function</option> <replaceable>function</replaceable></term>
+ <listitem>
+ <para>
+ Statistics function (mean, median, var, stdev, min, max, sum,
+ mode (provide classes), ismin, ismax, proportion (provide classes),
+ percentile, nvalid
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-perc</option> <replaceable>percentile</replaceable></term>
+ <term><option>--perc</option> <replaceable>percentile</replaceable></term>
+ <listitem>
+ <para>
+ Percentile value(s) used for rule percentile
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-class</option> <replaceable>class</replaceable></term>
+ <term><option>--class</option> <replaceable>class</replaceable></term>
+ <listitem>
+ <para>
+ class value(s) to use for mode, proportion
+ </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>-ot</option> <replaceable>type</replaceable></term>
+ <term><option>--otype</option> <replaceable>type</replaceable></term>
+ <listitem>
+ <para>
+ 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>
+
+ <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>-ct</option> <replaceable>filename</replaceable></term>
+ <term><option>--ct</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Color table (file with 5 columns:
+ id R G B ALFA (0: transparent, 255: solid).
+ Use none to ommit color table.
+ </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>-d</option> <replaceable>value</replaceable></term>
+ <term><option>--down</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Down sampling factor.
+ Use value 1 for no downsampling.
+ Use value n>1 for downsampling (aggregation).
+ </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>
+
+ <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>
--
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