This is an automated email from the git hooks/post-receive script. sebastic-guest pushed a commit to branch master in repository pktools.
commit f990fb3f35f4a1a67a2bd8a8b48cda9c8ab065f2 Author: Bas Couwenberg <sebas...@xs4all.nl> Date: Sun Dec 7 02:41:05 2014 +0100 Add man page for pkgetmask. --- debian/changelog | 3 +- debian/man/pkgetmask.1.xml | 217 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 219 insertions(+), 1 deletion(-) diff --git a/debian/changelog b/debian/changelog index 6683a43..b51e89e 100644 --- a/debian/changelog +++ b/debian/changelog @@ -5,7 +5,8 @@ pktools (2.6.1-1) UNRELEASED; urgency=medium * Remove libbase package, library no longer installed. * Add man page for pkann, pkascii2img, pkascii2ogr, pkcomposite, pkcreatect, pkcrop, pkdiff, pkdsm2shadow, pkdumpimg, pkdumpogr, pkegcs, pkextract, - pkfillnodata, pkfilter, pkfilterascii, pkfilterdem, pkfsann, pkfssvm. + pkfillnodata, pkfilter, pkfilterascii, pkfilterdem, pkfsann, pkfssvm, + pkgetmask. -- Bas Couwenberg <sebas...@xs4all.nl> Wed, 03 Dec 2014 21:16:31 +0100 diff --git a/debian/man/pkgetmask.1.xml b/debian/man/pkgetmask.1.xml new file mode 100644 index 0000000..bc5fd8e --- /dev/null +++ b/debian/man/pkgetmask.1.xml @@ -0,0 +1,217 @@ +<?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='pkgetmask'> + + <refmeta> + <refentrytitle>pkgetmask</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>pkgetmask</refname> + <refpurpose>program to create mask image based on values in input raster image</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>pkgetmask</command> + <arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg> + <arg choice='plain'><option>-o</option> <replaceable>output</replaceable></arg> + <arg choice='opt'><replaceable>options</replaceable></arg> + <arg choice='opt'><replaceable>advanced options</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + <command>pkgetmask</command> creates a mask raster dataset from an input + raster dataset. + Values smaller than the minimum value (<option>-min</option>) or larger + than the maximum value (<option>-max</option>) will result in a + <option>-nodata</option> value in the mask. + </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 mask file + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-min</option> <replaceable>value</replaceable></term> + <term><option>--min</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Values smaller than min threshold(s) are masked as invalid. + Use one threshold for each band + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-max</option> <replaceable>value</replaceable></term> + <term><option>--max</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Values greater than max threshold(s) are masked as invalid. + Use one threshold for each band + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-data</option> <replaceable>value</replaceable></term> + <term><option>--data</option> <replaceable>value</replaceable></term> + <listitem> + <para> + value(s) for valid pixels: between min and max + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-nodata</option> <replaceable>value</replaceable></term> + <term><option>--nodata</option> <replaceable>value</replaceable></term> + <listitem> + <para> + value(s) for invalid pixels: not between min and max + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-v</option> <replaceable>level</replaceable></term> + <term><option>--verbose</option> <replaceable>level</replaceable></term> + <listitem> + <para> + verbose + </para> + </listitem> + </varlistentry> + + </variablelist> + + <para>Advanced options</para> + <variablelist> + + <varlistentry> + <term><option>-b</option> <replaceable>band</replaceable></term> + <term><option>--band</option> <replaceable>band</replaceable></term> + <listitem> + <para> + band(s) used for mask + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-p</option> <replaceable>AND|OR</replaceable></term> + <term><option>--operator</option> <replaceable>AND|OR</replaceable></term> + <listitem> + <para> + Operator: [AND,OR]. + </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>colortable</replaceable></term> + <term><option>--ct</option> <replaceable>colortable</replaceable></term> + <listitem> + <para> + color table (file with 5 columns: + id R G B ALFA (0: transparent, 255: solid)). + </para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + + <refsect1 id='example'> + <title>EXAMPLE</title> + + <example> + <para> + create mask, setting all negative values to 0 (rest to 1) + </para> + <screen> +<command>pkgetmask</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>output.tif</replaceable> <option>-min</option> <replaceable>0</replaceable> <option>-nodata</option> <replaceable>0</replaceable> <option>-data</option> <replaceable>1</replaceable> + </screen> + </example> + + <example> + <para> + create mask. + Mask is set to 0 (default value for <option>-nodata</option>) if either + band 0 is not between 0 and 10 OR (default operator) band 1 is not + between 0 and 250. + Else mask is set to 1 (default value for <option>-data</option>) + </para> + <screen> +<command>pkgetmask</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-o</option> <replaceable>output.tif</replaceable> <option>-min</option> <replaceable>0</replaceable> <option>-max</option> <replaceable>10</replaceable> <option>-max</option> <replaceable>0</replaceable> <option>-max</option> <replaceable>250</replaceable> <option>-b</option> <replaceable>0</replaceable> <option>-b</option> <replaceable>1</replaceable> + </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