[pktools] 07/15: Add man page for pksieve.
Bas Couwenberg
sebastic at xs4all.nl
Fri Dec 12 16:05:18 UTC 2014
This is an automated email from the git hooks/post-receive script.
sebastic-guest pushed a commit to branch master
in repository pktools.
commit 17015dd43f9fbea22c37be1d9bfa612407b57360
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Fri Dec 12 01:57:16 2014 +0100
Add man page for pksieve.
---
debian/changelog | 3 +-
debian/man/pksieve.1.xml | 185 +++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 187 insertions(+), 1 deletion(-)
diff --git a/debian/changelog b/debian/changelog
index d9b4a5e..0b13eb0 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -6,7 +6,8 @@ pktools (2.6.1-1) UNRELEASED; urgency=medium
* Add man page for pkann, pkascii2img, pkascii2ogr, pkcomposite, pkcreatect,
pkcrop, pkdiff, pkdsm2shadow, pkdumpimg, pkdumpogr, pkegcs, pkextract,
pkfillnodata, pkfilter, pkfilterascii, pkfilterdem, pkfsann, pkfssvm,
- pkgetmask, pkinfo, pklas2img, pkoptsvm, pkpolygonize, pkregann, pksetmask.
+ pkgetmask, pkinfo, pklas2img, pkoptsvm, pkpolygonize, pkregann, pksetmask,
+ pksieve.
-- Bas Couwenberg <sebastic at xs4all.nl> Wed, 03 Dec 2014 21:16:31 +0100
diff --git a/debian/man/pksieve.1.xml b/debian/man/pksieve.1.xml
new file mode 100644
index 0000000..d7ce175
--- /dev/null
+++ b/debian/man/pksieve.1.xml
@@ -0,0 +1,185 @@
+<?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='pksieve'>
+
+ <refmeta>
+ <refentrytitle>pksieve</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pksieve</refname>
+ <refpurpose>program to sieve filter raster image</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pksieve</command>
+ <arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg>
+ <arg choice='opt'><option>-s</option> <replaceable>size</replaceable></arg>
+ <arg choice='plain'><option>-o</option> <replaceable>output</replaceable></arg>
+ <arg choice='opt'><replaceable>options</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>pksieve</command> filters small objects (maximum size defined
+ with the option <option>-s</option>) in a raster by replacing them to
+ the largest neighbor object.
+ In this context, objects are defined as pixels of the same value that
+ are also connected.
+ The connection can be defined in four directions (N-S and W-E:
+ set option <option>-c</option> 4) or eight directions (N-S, W-E and
+ diagonals NW-SE, NE-SW: set option <option>-c</option> 8).
+ </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>-s</option> <replaceable>size</replaceable></term>
+ <term><option>--size</option> <replaceable>size</replaceable></term>
+ <listitem>
+ <para>
+ raster polygons with sizes smaller than this will be merged into
+ their largest neighbour.
+ No sieve is performed if size = 0
+ </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 Output image file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-c</option> <replaceable>4|8</replaceable></term>
+ <term><option>--connect</option> <replaceable>4|8</replaceable></term>
+ <listitem>
+ <para>
+ the connectedness: 4 directions or 8 directions
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-b</option> <replaceable>band</replaceable></term>
+ <term><option>--band</option> <replaceable>band</replaceable></term>
+ <listitem>
+ <para>
+ the band to be used from input file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-m</option> <replaceable>filename</replaceable></term>
+ <term><option>--mask</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Use the first band of the specified file as a validity mask
+ (zero is invalid, non-zero is valid).
+ </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>).
+ Empty string: inherit from input image
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-co</option> <replaceable>option</replaceable></term>
+ <term><option>--co</option> <replaceable>option</replaceable></term>
+ <listitem>
+ <para>
+ Creation option for output file.
+ Multiple options can be specified.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ct</option> <replaceable>filename</replaceable></term>
+ <term><option>--ct</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ colour table in ASCII format having 5 columns: id R G B ALFA
+ (0: transparent, 255: solid)
+ </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>
+ merge all patches smaller than 5 pixels into bigger classes,
+ using 8 connectivity (horizontal, vertical and diagonal)
+ </para>
+
+ <screen>
+<command>pksieve</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-c</option> <replaceable>8</replaceable> <option>-c</option> <replaceable>5</replaceable> <option>-o</option> <replaceable>output.shp</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