[pktools] 03/06: Add man page for pkdumpimg.
Bas Couwenberg
sebastic at xs4all.nl
Sat Dec 6 19:57:50 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 26afbcf4dcae8554f57b816056971cf4415d9a8f
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Sat Dec 6 18:59:30 2014 +0100
Add man page for pkdumpimg.
---
debian/changelog | 2 +-
debian/man/pkdumpimg.1.xml | 262 +++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 263 insertions(+), 1 deletion(-)
diff --git a/debian/changelog b/debian/changelog
index e6aa25e..8cecb08 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, pkdiff, pkdsm2shadow.
+ pkcrop, pkdiff, pkdsm2shadow, pkdumpimg.
-- Bas Couwenberg <sebastic at xs4all.nl> Wed, 03 Dec 2014 21:16:31 +0100
diff --git a/debian/man/pkdumpimg.1.xml b/debian/man/pkdumpimg.1.xml
new file mode 100644
index 0000000..832765e
--- /dev/null
+++ b/debian/man/pkdumpimg.1.xml
@@ -0,0 +1,262 @@
+<?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='pkdumpimg'>
+
+ <refmeta>
+ <refentrytitle>pkdumpimg</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pkdumpimg</refname>
+ <refpurpose>program to dump image content to ASCII or STDOUT</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pkdumpimg</command>
+ <arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg>
+ <arg choice='opt'><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>pkdumpimg</command> dumps the content of a raster dataset to
+ (standard) output (screen or filename).
+ The default is to dump the output in matrix format.
+ Use <option>-of</option> line to dump each pixel value on a separate line,
+ preceded by its position (x and y value).
+ You can specify a bounding box to dump with either the extent of an OGR
+ vector dataset or via the options
+ <option>-ulx</option> <option>-uly</option>
+ <option>-lrx</option> and <option>-lry</option>.
+ </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 ASCII file (Default is empty: use STDOUT)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-of</option> <replaceable>matrix|line</replaceable></term>
+ <term><option>--oformat</option> <replaceable>matrix|line</replaceable></term>
+ <listitem>
+ <para>
+ Output format (matrix form or list (x,y,z) form).
+ Default is matrix form
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-b</option> <replaceable>band</replaceable></term>
+ <term><option>--band</option> <replaceable>band</replaceable></term>
+ <listitem>
+ <para>
+ band index to crop
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-e</option> <replaceable>vector</replaceable></term>
+ <term><option>--extent</option> <replaceable>vector</replaceable></term>
+ <listitem>
+ <para>
+ get boundary from extent from polygons in vector file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ulx</option> <replaceable>value</replaceable></term>
+ <term><option>--ulx</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Upper left x value bounding box
+ (in geocoordinates if georef is true)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-uly</option> <replaceable>value</replaceable></term>
+ <term><option>--uly</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Upper left y value bounding box
+ (in geocoordinates if georef is true)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-lrx</option> <replaceable>value</replaceable></term>
+ <term><option>--lrx</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Lower left x value bounding box
+ (in geocoordinates if georef is true)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-lry</option> <replaceable>value</replaceable></term>
+ <term><option>--lry</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Lower left y value bounding box
+ (in geocoordinates if georef is true)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option> <replaceable>level</replaceable></term>
+ <term><option>--verbose</option> <replaceable>level</replaceable></term>
+ <listitem>
+ <para>
+ verbose (Default: 0)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ <para>Advanced options</para>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-dx</option> <replaceable>value</replaceable></term>
+ <term><option>--dx</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Output resolution in x (in meter)
+ (0.0: keep original resolution)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-dy</option> <replaceable>value</replaceable></term>
+ <term><option>--dy</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Output resolution in y (in meter)
+ (0.0: keep original resolution)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-r</option> <replaceable>resampling</replaceable></term>
+ <term><option>--resampling-method</option> <replaceable>resampling</replaceable></term>
+ <listitem>
+ <para>
+ Resampling method (near: nearest neighbour,
+ bilinear: bi-linear interpolation).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-srcnodata</option> <replaceable>value</replaceable></term>
+ <term><option>--srcnodata</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ set no data value(s) for input image
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-dstnodata</option> <replaceable>value</replaceable></term>
+ <term><option>--dstnodata</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ nodata value for output if out of bounds.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
+ <refsect1 id='example'>
+ <title>EXAMPLE</title>
+
+ <example>
+ <para>
+ We create a 5x5 raster dataset containing all 0 values
+ except for its center (value=1)
+ </para>
+ <screen>
+<command>cat</command> <replaceable>input.txt</replaceable>
+
+0 0 0 0 0
+0 0 0 0 0
+0 0 1 0 0
+0 0 0 0 0
+0 0 0 0 0
+ </screen>
+
+ <para>
+ Use
+ <citerefentry>
+ <refentrytitle>pkascii2img</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>
+ to create an raster dataset from <replaceable>input.txt</replaceable>
+ </para>
+ <screen>
+<command>pkascii2img</command> <option>-i</option> <replaceable>input.txt</replaceable> <option>-o</option> <replaceable>output.tif</replaceable> <option>-of</option> <replaceable>GTiff</replaceable> <option>-a_srs</option> <replaceable>epsg:3035</replaceable> <option>-dx</option> <replaceable>25</replaceable> <option>-dy</option> <replaceable>25</replaceable> <option>-ulx</option> <replaceable>1000000</replaceable> <option>-uly</option> <replaceable>1000000</replaceable>
+ </screen>
+
+ <para>
+ Dump the image content of <replaceable>output.tif</replaceable>
+ to screen
+ </para>
+ <screen>
+<command>pkdumpimg</command> <option>-i</option> <replaceable>output.tif</replaceable>
+ </screen>
+ </example>
+
+ </refsect1>
+
+ <refsect1 id='see-also'>
+ <title>SEE ALSO</title>
+
+ <citerefentry>
+ <refentrytitle>pkascii2img</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
More information about the Pkg-grass-devel
mailing list