This is an automated email from the git hooks/post-receive script. sebastic-guest pushed a commit to branch master in repository pktools.
commit b759bdd474356ef389c8c091592d415359a08ff8 Author: Bas Couwenberg <sebas...@xs4all.nl> Date: Sat Dec 6 16:49:20 2014 +0100 Add man page for pkdiff. --- debian/changelog | 2 +- debian/man/pkdiff.1.xml | 317 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 318 insertions(+), 1 deletion(-) diff --git a/debian/changelog b/debian/changelog index 2a26192..253fa4b 100644 --- a/debian/changelog +++ b/debian/changelog @@ -4,7 +4,7 @@ pktools (2.6.1-1) UNRELEASED; urgency=medium * Refresh patches. * Remove libbase package, library no longer installed. * Add man page for pkann, pkascii2img, pkascii2ogr, pkcomposite, pkcreatect, - pkcrop. + pkcrop, pkdiff. -- Bas Couwenberg <sebas...@xs4all.nl> Wed, 03 Dec 2014 21:16:31 +0100 diff --git a/debian/man/pkdiff.1.xml b/debian/man/pkdiff.1.xml new file mode 100644 index 0000000..95c47ed --- /dev/null +++ b/debian/man/pkdiff.1.xml @@ -0,0 +1,317 @@ +<?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='pkdiff'> + + <refmeta> + <refentrytitle>pkdiff</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>pkdiff</refname> + <refpurpose>program to compare two raster image files</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>pkdiff</command> + <arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg> + <arg choice='plain'><option>-ref</option> <replaceable>reference</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>pkdiff</command> compares two datasets. + The reference can either be a raster or a vector, but the input must be + a raster dataset. + In case the reference is a raster dataset, a pixel by pixel comparison is + performed. + With no further options, the utility reports if the rasters are identical + or different. + If required, an output raster dataset can be written with a qualitative + information per pixel: + 0 (input=reference), 1 (input>reference) or 2 (input<reference). + If, however, the reference is a vector dataset, it must consist of point + features. + Polygon features are automatically converted to the centroid points + before analyzing. + </para> + <para> + A typical use of the utility is to assess the accuracy of an input raster + land cover map, based on a reference vector dataset. + The reference dataset must contain an attribute (label) for each class. + A confusion matrix is produced if the option + <option>-cm</option>|<option>--confusion</option> is set. + Here too, an output dataset can be written, which will be a vector + dataset in this case. + It contains the reference feature points with the extracted data value of + the raster input dataset as a new attribute. + </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 raster dataset. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-ref</option> <replaceable>filename</replaceable></term> + <term><option>--reference</option> <replaceable>filename</replaceable></term> + <listitem> + <para> + Reference (raster or vector) dataset + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-ln</option> <replaceable>layer</replaceable></term> + <term><option>--ln</option> <replaceable>layer</replaceable></term> + <listitem> + <para> + Layer name(s) in sample. + Leave empty to select all (for vector reference datasets only) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-b</option> <replaceable>band</replaceable></term> + <term><option>--band</option> <replaceable>band</replaceable></term> + <listitem> + <para> + Input raster band + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-cm</option></term> + <term><option>--confusion</option></term> + <listitem> + <para> + Create confusion matrix (to stdout) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-lr</option> <replaceable>attribute</replaceable></term> + <term><option>--lref</option> <replaceable>attribute</replaceable></term> + <listitem> + <para> + Attribute name of the reference label + (for vector reference datasets only) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-c</option> <replaceable>name</replaceable></term> + <term><option>--class</option> <replaceable>name</replaceable></term> + <listitem> + <para> + List of class names. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-r</option> <replaceable>value</replaceable></term> + <term><option>--reclass</option> <replaceable>value</replaceable></term> + <listitem> + <para> + List of class values (use same order as in classname option). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-nodata</option> <replaceable>value</replaceable></term> + <term><option>--nodata</option> <replaceable>value</replaceable></term> + <listitem> + <para> + No data value(s) in input or reference dataset are ignored + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-m</option> <replaceable>mask</replaceable></term> + <term><option>--mask</option> <replaceable>mask</replaceable></term> + <listitem> + <para> + Use the first band of the specified file as a validity mask. + Nodata values can be set with the option + <option>--msknodata</option>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-msknodata</option> <replaceable>value</replaceable></term> + <term><option>--msknodata</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Mask value(s) where image is invalid. + Use negative value for valid data + (example: use <option>-t</option> <literal>-1</literal>: + if only <literal>-1</literal> is valid value) + </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> + + <para>Advanced options</para> + <variablelist> + + <varlistentry> + <term><option>-o</option> <replaceable>output</replaceable></term> + <term><option>--output</option> <replaceable>output</replaceable></term> + <listitem> + <para> + Output dataset (optional) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-f</option> <replaceable>OGRformat</replaceable></term> + <term><option>--f</option> <replaceable>OGRformat</replaceable></term> + <listitem> + <para> + OGR format for output vector (for vector reference datasets only) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-lc</option> <replaceable>attribute</replaceable></term> + <term><option>--lclass</option> <replaceable>attribute</replaceable></term> + <listitem> + <para> + Attribute name of the classified label + (for vector reference datasets only) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--commission</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Value for commission errors: input label < reference label + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-bnd</option> <replaceable>value</replaceable></term> + <term><option>--boundary</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Boundary for selecting the sample + (for vector reference datasets only) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-hom</option></term> + <term><option>--homogeneous</option></term> + <listitem> + <para> + Only take regions with homogeneous boundary into account + (for reference datasets only) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-circ</option></term> + <term><option>--circular</option></term> + <listitem> + <para> + Use circular boundary (for vector reference datasets only) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-ct</option> <replaceable>colortable</replaceable></term> + <term><option>--ct</option> <replaceable>colortable</replaceable></term> + <listitem> + <para> + Color table in ASCII format having 5 columns: + id R G B ALFA (0: transparent, 255: solid). + </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> + + </variablelist> + + </refsect1> + + <refsect1 id='example'> + <title>EXAMPLE</title> + + <example> + <para> + Check if two raster images are different (reports only if images are + different or not) + </para> + + <screen> +<command>pkdiff</command> <option>-i</option> <replaceable>input.tif</replaceable> <option>-ref</option> <replaceable>reference.tif</replaceable> + </screen> + </example> + + <example> + <para> + Validate a classification map using points from a reference sample and + report confusion matrix + </para> + + <screen> +<command>pkdiff</command> <option>-i</option> <replaceable>classificationMap.tif</replaceable> <option>-ref</option> <replaceable>referencePoints.tif</replaceable> <option>-cm</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