This is an automated email from the git hooks/post-receive script. sebastic-guest pushed a commit to branch master in repository pktools.
commit a3cb60470b9dc2800c6785960ea1539c8943a1e1 Author: Bas Couwenberg <sebas...@xs4all.nl> Date: Sun Dec 7 13:40:54 2014 +0100 Add man page for pkinfo. --- debian/changelog | 2 +- debian/man/pkinfo.1.xml | 553 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 554 insertions(+), 1 deletion(-) diff --git a/debian/changelog b/debian/changelog index b51e89e..6b431f2 100644 --- a/debian/changelog +++ b/debian/changelog @@ -6,7 +6,7 @@ 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. + pkgetmask, pkinfo. -- Bas Couwenberg <sebas...@xs4all.nl> Wed, 03 Dec 2014 21:16:31 +0100 diff --git a/debian/man/pkinfo.1.xml b/debian/man/pkinfo.1.xml new file mode 100644 index 0000000..133103c --- /dev/null +++ b/debian/man/pkinfo.1.xml @@ -0,0 +1,553 @@ +<?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='pkinfo'> + + <refmeta> + <refentrytitle>pkinfo</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>pkinfo</refname> + <refpurpose>Report basic information from raster datasets</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>pkinfo</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>pkinfo</command> retrieves basic information about a raster + data set (similar to + <citerefentry> + <refentrytitle>gdalinfo</refentrytitle> + <manvolnum>1</manvolnum> + </citerefentry>). + An important difference with <command>gdalinfo</command> is that + <command>pkinfo</command> only reports the information that is requested + via the corresponding command line option, whereas + <command>gdalinfo</command> provides all basic information at once. + The reported information is in a format that can be used as input for + other pktools utilities. + This mechanism facilitates command substitution in the bash scripting + language. + </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>-bb</option></term> + <term><option>--bbox</option></term> + <listitem> + <para> + Shows bounding box + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-te</option></term> + <term><option>--te</option></term> + <listitem> + <para> + Shows bounding box in GDAL format: xmin ymin xmax ymax + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-c</option></term> + <term><option>--center</option></term> + <listitem> + <para> + Image center in projected X,Y coordinates + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-ct</option></term> + <term><option>--colortable</option></term> + <listitem> + <para> + Shows colour table + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-ns</option></term> + <term><option>--nsample</option></term> + <listitem> + <para> + Number of samples in image + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-nl</option></term> + <term><option>--nline</option></term> + <listitem> + <para> + Number of lines in image + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-nb</option></term> + <term><option>--nband</option></term> + <listitem> + <para> + Show number of bands in image + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-b</option> <replaceable>band</replaceable></term> + <term><option>--band</option> <replaceable>band</replaceable></term> + <listitem> + <para> + Band specific information + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-dx</option></term> + <term><option>--dx</option></term> + <listitem> + <para> + Gets resolution in x (in m) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-dy</option></term> + <term><option>--dy</option></term> + <listitem> + <para> + Gets resolution in y (in m) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-mm</option></term> + <term><option>--minmax</option></term> + <listitem> + <para> + Shows min and max value of the image + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-min</option></term> + <term><option>--minimum</option></term> + <listitem> + <para> + Shows min value of the image + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-max</option></term> + <term><option>--maximum</option></term> + <listitem> + <para> + Shows max value of the image + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-stats</option></term> + <term><option>--statistics</option></term> + <listitem> + <para> + Shows statistics (min,max, mean and stdDev of the image) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-src_min</option> <replaceable>value</replaceable></term> + <term><option>--src_min</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Sets minimum for histogram (does not calculate min value: + use <option>-mm</option> instead) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-src_max</option> <replaceable>value</replaceable></term> + <term><option>--src_max</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Sets maximum for histogram (does not calculate min value: + use <option>-mm</option> instead) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-rel</option></term> + <term><option>--relative</option></term> + <listitem> + <para> + Calculates relative histogram in percentage + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-a_srs</option></term> + <term><option>--a_srs</option></term> + <listitem> + <para> + Shows projection of the image + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-geo</option></term> + <term><option>--geo</option></term> + <listitem> + <para> + Gets geotransform + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-il</option></term> + <term><option>--interleave</option></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-f</option></term> + <term><option>--filename</option></term> + <listitem> + <para> + Shows image filename + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-cover</option></term> + <term><option>--cover</option></term> + <listitem> + <para> + Print filename to STDOUT if current image covers the provided + coordinates via bounding box, (x y) coordinates or extent of + vector file + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-x</option> <replaceable>value</replaceable></term> + <term><option>--xpos</option> <replaceable>value</replaceable></term> + <listitem> + <para> + x pos + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-y</option> <replaceable>value</replaceable></term> + <term><option>--ypos</option> <replaceable>value</replaceable></term> + <listitem> + <para> + y pos + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-r</option></term> + <term><option>--read</option></term> + <listitem> + <para> + Reads row y (in projected coordinates if geo option is set, + otherwise in image coordinates, 0 based) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-ref</option></term> + <term><option>--reference</option></term> + <listitem> + <para> + Gets reference pixel + (lower left corner of center of gravity pixel) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-of</option></term> + <term><option>--oformat</option></term> + <listitem> + <para> + Gets driver description + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-e</option> <replaceable>filename</replaceable></term> + <term><option>--extent</option> <replaceable>filename</replaceable></term> + <listitem> + <para> + Gets boundary from vector file + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-ulx</option> <replaceable>ULX</replaceable></term> + <term><option>--ulx</option> <replaceable>ULX</replaceable></term> + <listitem> + <para> + Upper left x value bounding box + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-uly</option> <replaceable>ULY</replaceable></term> + <term><option>--uly</option> <replaceable>ULY</replaceable></term> + <listitem> + <para> + Upper left y value bounding box + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-lrx</option> <replaceable>LRX</replaceable></term> + <term><option>--lrx</option> <replaceable>LRX</replaceable></term> + <listitem> + <para> + Lower right x value bounding box + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-lry</option> <replaceable>LRY</replaceable></term> + <term><option>--lry</option> <replaceable>LRY</replaceable></term> + <listitem> + <para> + Lower right y value bounding box + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-hist</option></term> + <term><option>--histogram</option></term> + <listitem> + <para> + Calculates histogram. Use <option>--rel</option> for a relative + histogram output. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-nbin</option> <replaceable>number</replaceable></term> + <term><option>--nbin</option> <replaceable>number</replaceable></term> + <listitem> + <para> + Number of bins used in histogram. + Use 0 for all input values as integers + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-ot</option></term> + <term><option>--otype</option></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-d</option></term> + <term><option>--description</option></term> + <listitem> + <para> + Returns image description + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-meta</option></term> + <term><option>--meta</option></term> + <listitem> + <para> + Shows meta data + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-nodata</option> <replaceable>value</replaceable></term> + <term><option>--nodata</option> <replaceable>value</replaceable></term> + <listitem> + <para> + Sets no data value(s) for calculations + (nodata values in input image) + </para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + + <refsect1 id='example'> + <title>EXAMPLE</title> + + <example> + <para> + show number of bands in raster <replaceable>image.tif</replaceable> + </para> + <screen> +<command>pkinfo</command> <option>-i</option> <replaceable>image.tif</replaceable> <option>-nb</option> + </screen> + </example> + + <example> + <para> + show maximum value of band 1 (starting from 0) of raster + <replaceable>image.tif</replaceable> + </para> + <screen> +<command>pkinfo</command> <option>-i</option> <replaceable>image.tif</replaceable> <option>-max</option> <option>-b</option> <replaceable>1</replaceable> + </screen> + </example> + + <example> + <para> + read (dump) upper left pixel value for bands 3,2,1 + </para> + <screen> +<command>pkinfo</command> <option>-i</option> <replaceable>image.tif</replaceable> <option>-x</option> <replaceable>0</replaceable> <option>-y</option> <replaceable>0</replaceable> <option>-r</option> <option>-b</option> <replaceable>3</replaceable> <option>-b</option> <replaceable>2</replaceable> <option>-b</option> <replaceable>1</replaceable> + </screen> + </example> + + <example> + <para> + read (dump) pixel value at this geographic location (x,y) for bands 3,2,1 + </para> + <screen> +<command>pkinfo</command> <option>-i</option> <replaceable>image.tif</replaceable> <option>-x</option> <replaceable>3528120</replaceable> <option>-y</option> <replaceable>4329681</replaceable> <option>-geo</option> <option>-r</option> <option>-b</option> <replaceable>3</replaceable> <option>-b</option> <replaceable>2</replaceable> <option>-b</option> <replaceable>1</replaceable> + </screen> + </example> + + <example> + <para> + show bounding box (<option>-ulx</option> <option>-uly</option> + <option>-lrx</option> <option>-lry</option>) in geo coordinates for + <replaceable>image1.tif</replaceable> + </para> + <screen> +<command>pkinfo</command> <option>-i</option> <replaceable>image1.tif</replaceable> <option>-b</option> + </screen> + </example> + + <example> + <para> + show bounding box (<option>-ulx</option> <option>-uly</option> + <option>-lrx</option> <option>-lry</option>) in geo coordinates for + each image (and union and intersect) + </para> + <screen> +<command>pkinfo</command> <option>-i</option> <replaceable>image1.tif</replaceable> <option>-i</option> <replaceable>image2.tif</replaceable> <option>-i</option> <replaceable>image3.tif</replaceable> <option>-b</option> + </screen> + </example> + + <example> + <para> + show the refence pixel (centre of gravity) for + <replaceable>image1.tif</replaceable>, treating 0 and 255 as NO VALUE + </para> + <screen> +<command>pkinfo</command> <option>-i</option> <replaceable>image1.tif</replaceable> <option>--mask</option> <replaceable>0</replaceable> <option>--mask</option> <replaceable>255</replaceable> <option>-ref</option> + </screen> + </example> + + <example> + <para> + read (dump) pixel value at image centre for band 0 + </para> + <screen> +<command>pkinfo</command> <option>-i</option> <replaceable>image.tif</replaceable> $(<command>pkinfo</command> <option>-i</option> <replaceable>image.tif</replaceable> <option>-c</option>) <option>-geo</option> <option>-r</option> + </screen> + </example> + + <example> + <para> + read (dump) pixel value in band 0 (default) for all images in current + directory that cover this geographic location + </para> + <screen> +<command>pkinfo</command> $(for IMAGE in <replaceable>modis_2010*.tif</replaceable>; do <command>pkinfo</command> <option>-i</option> <replaceable>$IMAGE</replaceable> <option>--cover</option> <option>-x</option> <replaceable>4215500</replaceable> <option>-y</option> <replaceable>2534000</replaceable>; done) <option>-x</option> <replaceable>4215500</replaceable> <option>-y</option> <replaceable>253400</replaceable> + </screen> + </example> + + </refsect1> + + <refsect1 id='see-also'> + <title>SEE ALSO</title> + + <citerefentry> + <refentrytitle>gdalinfo</refentrytitle> + <manvolnum>1</manvolnum> + </citerefentry> + + </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