[pktools] 05/06: Add man page for pkcreatect.
Bas Couwenberg
sebastic at xs4all.nl
Fri Dec 5 23:19:33 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 5e2909945143e15c0aa43f6db5c7d960cd59ad03
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Fri Dec 5 23:02:36 2014 +0100
Add man page for pkcreatect.
---
debian/changelog | 2 +-
debian/man/pkcreatect.1.xml | 241 ++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 242 insertions(+), 1 deletion(-)
diff --git a/debian/changelog b/debian/changelog
index 412d757..43ebebb 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -3,7 +3,7 @@ pktools (2.6.1-1) UNRELEASED; urgency=medium
* New upstream release.
* Refresh patches.
* Remove libbase package, library no longer installed.
- * Add man page for pkann, pkascii2img, pkascii2ogr, pkcomposite.
+ * Add man page for pkann, pkascii2img, pkascii2ogr, pkcomposite, pkcreatect.
-- Bas Couwenberg <sebastic at xs4all.nl> Wed, 03 Dec 2014 21:16:31 +0100
diff --git a/debian/man/pkcreatect.1.xml b/debian/man/pkcreatect.1.xml
new file mode 100644
index 0000000..e92f81a
--- /dev/null
+++ b/debian/man/pkcreatect.1.xml
@@ -0,0 +1,241 @@
+<?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='pkcreatect'>
+
+ <refmeta>
+ <refentrytitle>pkcreatect</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pkcreatect</refname>
+ <refpurpose>program to create and import colour table to GTiff image</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pkcreatect</command>
+ <arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg>
+ <arg choice='plain'><option>-o</option> <replaceable>output</replaceable></arg>
+ <group>
+ <arg choice='plain'><option>-ct</option> <replaceable>colortable</replaceable></arg>
+ <arg choice='plain'><option>-min</option> <replaceable>value</replaceable> <option>-max</option> <replaceable>value</replaceable></arg>
+ </group>
+ <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>pkcreatect</command> is a utility to include a color table to a
+ raster dataset.
+ You can either define an existing color table (ASCII text file) with the
+ option <option>-ct</option> or define a minimum (<option>-min</option>)
+ and maximum (<option>-max</option>) value.
+ </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
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o</option> <replaceable>filename</replaceable></term>
+ <term><option>--output</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ output classification image
+ </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>-min</option> <replaceable>number</replaceable></term>
+ <term><option>--min</option> <replaceable>number</replaceable></term>
+ <listitem>
+ <para>
+ minimum value
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-max</option> <replaceable>number</replaceable></term>
+ <term><option>--max</option> <replaceable>number</replaceable></term>
+ <listitem>
+ <para>
+ maximum value
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>options</para>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-g</option></term>
+ <term><option>--grey</option></term>
+ <listitem>
+ <para>
+ grey scale
+ </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>-d</option> <replaceable>description</replaceable></term>
+ <term><option>--description</option> <replaceable>description</replaceable></term>
+ <listitem>
+ <para>
+ Set image description
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option></term>
+ <term><option>--verbose</option></term>
+ <listitem>
+ <para>
+ verbose
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ <para>Advanced options</para>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-l</option> <replaceable>filename</replaceable></term>
+ <term><option>--filename</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Create legend as png file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-dim</option> <replaceable>cols</replaceable> <option>-dim</option> <replaceable>rows</replaceable></term>
+ <term><option>--dim</option> <replaceable>cols</replaceable> <option>--dim</option> <replaceable>rows</replaceable></term>
+ <listitem>
+ <para>
+ number of columns and rows in legend.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
+ <refsect1 id='example'>
+ <title>EXAMPLE</title>
+
+ <example>
+ <para>
+ Attach a color table to image with values between 0 and 50
+ </para>
+
+ <screen>
+<command>pkcreatect</command> <option>-i</option> <replaceable>image.tif</replaceable> <option>-o</option> <replaceable>image_ct.tif</replaceable> <option>-min</option> <replaceable>0</replaceable> <option>-max</option> <replaceable>50</replaceable>
+ </screen>
+ </example>
+
+ <example>
+ <para>
+ Attach a grey scale "color" table to image with values
+ between 0 and 100 and create a legend image
+ (annotation needs to be drawn manually)
+ </para>
+
+ <screen>
+<command>pkcreatect</command> <option>-i</option> <replaceable>image.tif</replaceable> <option>-o</option> <replaceable>image_ct.tif</replaceable> <option>-min</option> <replaceable>0</replaceable> <option>-max</option> <replaceable>100</replaceable> <option>-l</option> <replaceable>legend.tif</replaceable> <option>-g</option>
+ </screen>
+ </example>
+
+ <example>
+ <para>
+ Attach a predefined color table to <filename>image.tif</filename>.
+ The colortable has 5 entries for the values
+ 0 (black), 1 (red), 2 (green), 3 (blue) and 4 (grey)
+ </para>
+
+ <screen>
+<command>cat</command> <filename>colortable.txt</filename>
+
+0 0 0 0 255
+1 255 0 0 255
+2 0 255 0 255
+3 0 0 255 255
+4 100 100 100 255
+
+<command>pkcreatect</command> <option>-i</option> <replaceable>image.tif</replaceable> <option>-o</option> <replaceable>image_ct.tif</replaceable> <option>-ct</option> <filename>colortable.txt</filename>
+ </screen>
+ </example>
+
+ <example>
+ <para>
+ Remove the color table from an image
+ </para>
+
+ <screen>
+<command>pkcreatect</command> <option>-i</option> <replaceable>image.tif</replaceable> <option>-o</option> <replaceable>image_noct.tif</replaceable> <option>-ct</option> <literal>none</literal>
+ </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