This is an automated email from the git hooks/post-receive script.
sebastic-guest pushed a commit to branch master
in repository pktools.
commit 11140c3b48d010457c5df33f3ab4dc45bf4cfa8e
Author: Bas Couwenberg <sebas...@xs4all.nl>
Date: Fri Dec 12 03:06:54 2014 +0100
Add man page for pkstatogr.
---
debian/changelog | 2 +-
debian/man/pkstatogr.1.xml | 258 +++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 259 insertions(+), 1 deletion(-)
diff --git a/debian/changelog b/debian/changelog
index 4cb977b..ab5ad98 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -7,7 +7,7 @@ pktools (2.6.1-1) UNRELEASED; urgency=medium
pkcrop, pkdiff, pkdsm2shadow, pkdumpimg, pkdumpogr, pkegcs, pkextract,
pkfillnodata, pkfilter, pkfilterascii, pkfilterdem, pkfsann, pkfssvm,
pkgetmask, pkinfo, pklas2img, pkoptsvm, pkpolygonize, pkregann, pksetmask,
- pksieve, pkstatascii.
+ pksieve, pkstatascii, pkstatogr.
-- Bas Couwenberg <sebas...@xs4all.nl> Wed, 03 Dec 2014 21:16:31 +0100
diff --git a/debian/man/pkstatogr.1.xml b/debian/man/pkstatogr.1.xml
new file mode 100644
index 0000000..8adb3d3
--- /dev/null
+++ b/debian/man/pkstatogr.1.xml
@@ -0,0 +1,258 @@
+<?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='pkstatogr'>
+
+ <refmeta>
+ <refentrytitle>pkstatogr</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pkstatogr</refname>
+ <refpurpose>program to calculate basic statistics from vector
file</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pkstatogr</command>
+ <arg choice='plain'><option>-i</option>
<replaceable>input</replaceable></arg>
+ <arg choice='opt'><replaceable>options</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>pkstatogr</command> calculates basic statistics on attributes
+ of a vector file.
+ Examples of the basic statistics include: minimum, maximum, median, mean
+ and standard deviation.
+ Histograms (in percentage or absolute values) can also be calculated.
+ The attribute of interest can be selected using the option
+ <option>-n</option>|<option>--fname</option>.
+ Values defined by the <option>-nodata</option> option, or not within the
+ limits set by the options <option>-src_min</option> and
+ <option>-src_max</option> are ignored for the statistics.
+ </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(s).
+ If input contains multiple images, a multi-band output is created
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ln</option> <replaceable>layer</replaceable></term>
+ <term><option>--lname</option> <replaceable>layer</replaceable></term>
+ <listitem>
+ <para>
+ Layer name(s) in sample (leave empty to select all)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-n</option> <replaceable>attribute</replaceable></term>
+ <term><option>--fname</option>
<replaceable>attribute</replaceable></term>
+ <listitem>
+ <para>
+ Fields on which to calculate statistics
+ </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>-src_min</option> <replaceable>value</replaceable></term>
+ <term><option>--src_min</option>
<replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Set minimum value for histogram
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-src_max</option> <replaceable>value</replaceable></term>
+ <term><option>--src_max</option>
<replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Set maximum value for histogram
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-s</option></term>
+ <term><option>--size</option></term>
+ <listitem>
+ <para>
+ Sample size (number of points)
+ </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>-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>-stdev</option></term>
+ <term><option>--stdev</option></term>
+ <listitem>
+ <para>
+ Calculate standard deviation
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-hist</option></term>
+ <term><option>--hist</option></term>
+ <listitem>
+ <para>
+ Calculate histogram
+ </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
+ <ulink
url="http://pktools.nongnu.org/html/classKernel.html";>Kernel</ulink>
+ density estimation when producing histogram.
+ The standard deviation is estimated based on Silverman's rule of
+ thumb
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option> <replaceable>level</replaceable></term>
+ <term><option>--verbose</option>
<replaceable>level</replaceable></term>
+ <listitem>
+ <para>
+ Verbose level
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
+ <refsect1 id='example'>
+ <title>EXAMPLE</title>
+
+ <example>
+ <para>
+ report histogram of values in FIELDID (to standard output)
+ </para>
+
+ <screen>
+<command>pkstatogr</command> <option>-i</option>
<replaceable>input.shp</replaceable> <option>-f</option>
<replaceable>FIELDID</replaceable> <option>-n</option>
<replaceable>100</replaceable>
+ </screen>
+ </example>
+
+ <example>
+ <para>
+ report min, max, mean and standard deviation of values in FIELDID
+ (to standard output)
+ </para>
+
+ <screen>
+<command>pkstatogr</command> <option>-i</option>
<replaceable>input.shp</replaceable> <option>-f</option>
<replaceable>FIELDID</replaceable> <option>-min</option> <option>-max</option>
<option>-mean</option> <option>-stdev</option>
+ </screen>
+ </example>
+
+ </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
