[pktools] 02/06: Add man page for pkdsm2shadow.
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 17da1dd05e688702ae78599bf78dc945c337c2ea
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Sat Dec 6 18:37:13 2014 +0100
Add man page for pkdsm2shadow.
---
debian/changelog | 2 +-
debian/man/pkdsm2shadow.1.xml | 198 ++++++++++++++++++++++++++++++++++++++++++
2 files changed, 199 insertions(+), 1 deletion(-)
diff --git a/debian/changelog b/debian/changelog
index 253fa4b..e6aa25e 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.
+ pkcrop, pkdiff, pkdsm2shadow.
-- Bas Couwenberg <sebastic at xs4all.nl> Wed, 03 Dec 2014 21:16:31 +0100
diff --git a/debian/man/pkdsm2shadow.1.xml b/debian/man/pkdsm2shadow.1.xml
new file mode 100644
index 0000000..d1b2ea9
--- /dev/null
+++ b/debian/man/pkdsm2shadow.1.xml
@@ -0,0 +1,198 @@
+<?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='pkdsm2shadow'>
+
+ <refmeta>
+ <refentrytitle>pkdsm2shadow</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pkdsm2shadow</refname>
+ <refpurpose>program to calculate sun shadow based on digital surface model and sun angles</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pkdsm2shadow</command>
+ <arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg>
+ <arg choice='plain'><option>-o</option> <replaceable>output</replaceable></arg>
+ <arg choice='opt'><option>-sza</option> <replaceable>angle</replaceable></arg>
+ <arg choice='opt'><option>-saa</option> <replaceable>angle</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>pkdsm2shadow</command> is a utility to create a binary shadow
+ mask from a digital surface model, based on Sun zenith
+ (<option>-sza</option>) and azimuth angles (<option>-saa</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 image file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-sza</option> <replaceable>angle</replaceable></term>
+ <term><option>--sza</option> <replaceable>angle</replaceable></term>
+ <listitem>
+ <para>
+ Sun zenith angle.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-saa</option> <replaceable>angle</replaceable></term>
+ <term><option>--saa</option> <replaceable>angle</replaceable></term>
+ <listitem>
+ <para>
+ Sun azimuth angle (N=0 E=90 S=180 W=270).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f</option> <replaceable>value</replaceable></term>
+ <term><option>--flag</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Flag to put in image if pixel shadow
+ </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>GDALformat</replaceable></term>
+ <term><option>--oformat</option> <replaceable>GDALformat</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>-ct</option> <replaceable>filename</replaceable></term>
+ <term><option>--ct</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ color table (file with 5 columns:
+ id R G B ALFA (0: transparent, 255: solid)
+ </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>-v</option> <replaceable>level</replaceable></term>
+ <term><option>--verbose</option> <replaceable>level</replaceable></term>
+ <listitem>
+ <para>
+ verbose mode if > 0
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ <para>Advanced options</para>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-s</option> <replaceable>value</replaceable></term>
+ <term><option>--scale</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ scale used for input dsm:
+ height=scale*input+offset
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-off</option> <replaceable>value</replaceable></term>
+ <term><option>--offset</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ offset used for input dsm:
+ height=scale*input+offset
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
+ <refsect1 id='example'>
+ <title>EXAMPLE</title>
+
+ <example>
+ <para>
+ Create a shadow mask for the input raster dataset
+ <filename>dsm.tif</filename>, using Sun zenith angle of 10 degrees and
+ a Sun azimuth angle of 135 degrees (South-South-East).
+ All shadow pixels are set to a value of 1.
+ </para>
+
+ <screen>
+<command>pkdsm2shadow</command> <option>-i</option> <replaceable>dsm.tif</replaceable> <option>-sza</option> <replaceable>10</replaceable> <option>-saa</option> <replaceable>170</replaceable> <option>-f</option> <replaceable>1</replaceable> <option>-o</option> <replaceable>shadow.tif</replaceable>
+ </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