[pktools] 02/06: Add man page for pkascii2img.
Bas Couwenberg
sebastic at xs4all.nl
Fri Dec 5 23:19:32 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 f427ea5d2c0228117d151de04f87e1c1623425ad
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Fri Dec 5 16:36:53 2014 +0100
Add man page for pkascii2img.
---
debian/changelog | 2 +-
debian/man/pkascii2img.1.xml | 325 +++++++++++++++++++++++++++++++++++++++++++
2 files changed, 326 insertions(+), 1 deletion(-)
diff --git a/debian/changelog b/debian/changelog
index 28c9889..9f8840d 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.
+ * Add man page for pkann, pkascii2img.
-- Bas Couwenberg <sebastic at xs4all.nl> Wed, 03 Dec 2014 21:16:31 +0100
diff --git a/debian/man/pkascii2img.1.xml b/debian/man/pkascii2img.1.xml
new file mode 100644
index 0000000..508e362
--- /dev/null
+++ b/debian/man/pkascii2img.1.xml
@@ -0,0 +1,325 @@
+<?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='pkascii2img'>
+
+ <refmeta>
+ <refentrytitle>pkascii2img</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pkascii2img</refname>
+ <refpurpose>program to create raster image based on ascii file</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pkascii2img</command>
+ <arg choice='opt'><option>-i</option> <replaceable>input</replaceable></arg>
+ <arg choice='opt'><option>-o</option> <replaceable>output</replaceable></arg>
+ <arg choice='opt'><option>-ot</option> <replaceable>type</replaceable></arg>
+ <arg choice='opt'><option>-of</option> <replaceable>GDALformat</replaceable></arg>
+ <arg choice='opt'><option>-co</option> <replaceable>NAME=VALUE</replaceable></arg>
+ <arg choice='opt'><option>-dx</option> <replaceable>value</replaceable></arg>
+ <arg choice='opt'><option>-dy</option> <replaceable>value</replaceable></arg>
+ <arg choice='opt'><option>-ulx</option> <replaceable>value</replaceable></arg>
+ <arg choice='opt'><option>-uly</option> <replaceable>value</replaceable></arg>
+ <arg choice='opt'><option>-ct</option> <replaceable>filename</replaceable></arg>
+ <arg choice='opt'><option>-a_srs</option> <replaceable>EPSG:number</replaceable></arg>
+ <arg choice='opt'><option>-d</option> <replaceable>description</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>
+ <command>pkascii2img</command> creates a raster dataset from an ASCII
+ textfile.
+ The textfile is in matrix format (rows and columns).
+ The dimensions in x and y are defined by the number of columns and rows
+ respectively.
+ The georeferencing can be defined by providing the options for cell size
+ (<option>-dx</option> <option>-dy</option>), upper left position
+ (<option>-ulx</option> <option>-uly</option>) and the projection
+ (<option>-a_srs</option>).
+ Some dataset formats can also store a description (<option>-d</option>)
+ and a color table (<option>-ct</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 ASCII 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>-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>-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>
+
+ <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>-dx</option> <replaceable>value</replaceable></term>
+ <term><option>--dx</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ Output resolution in x (in meter)
+ </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)
+ </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>-a_srs</option> <replaceable>EPSG:number</replaceable></term>
+ <term><option>--a_srs</option> <replaceable>EPSG:number</replaceable></term>
+ <listitem>
+ <para>
+ Override the projection for the output file
+ </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>
+
+ </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>
+ We define a pixel size of 25 by 25 m and and a projected in the
+ European projection system ETS89/LAEA.
+ The location of the upper left pixel is also set:
+ </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>
+ We check the output GeoTIFF using <command>gdalinfo</command>:
+ </para>
+ <screen>
+<command>gdalinfo</command> <replaceable>output.tif</replaceable>
+
+Driver: GTiff/GeoTIFF
+Files: output.tif
+Size is 5, 5
+Coordinate System is:
+PROJCS["ETRS89 / LAEA Europe",
+GEOGCS["ETRS89",
+DATUM["European_Terrestrial_Reference_System_1989",
+SPHEROID["GRS 1980",6378137,298.2572221010042,
+AUTHORITY["EPSG","7019"]],
+TOWGS84[0,0,0,0,0,0,0],
+AUTHORITY["EPSG","6258"]],
+PRIMEM["Greenwich",0],
+UNIT["degree",0.0174532925199433],
+AUTHORITY["EPSG","4258"]],
+PROJECTION["Lambert_Azimuthal_Equal_Area"],
+PARAMETER["latitude_of_center",52],
+PARAMETER["longitude_of_center",10],
+PARAMETER["false_easting",4321000],
+PARAMETER["false_northing",3210000],
+UNIT["metre",1,
+AUTHORITY["EPSG","9001"]],
+AUTHORITY["EPSG","3035"]]
+Origin = (1000000.000000000000000,1000000.000000000000000)
+Pixel Size = (25.000000000000000,-25.000000000000000)
+Metadata:
+AREA_OR_POINT=Area
+TIFFTAG_DATETIME=2014:11:08 11:33:52
+TIFFTAG_DOCUMENTNAME=output.tif
+TIFFTAG_SOFTWARE=pktools 2.5.4 by Pieter Kempeneers
+Image Structure Metadata:
+INTERLEAVE=BAND
+Corner Coordinates:
+Upper Left ( 1000000.000, 1000000.000) ( 23d13' 9.44"W, 25d30'21.01"N)
+Lower Left ( 1000000.000, 999875.000) ( 23d13' 8.02"W, 25d30'17.24"N)
+Upper Right ( 1000125.000, 1000000.000) ( 23d13' 5.27"W, 25d30'22.72"N)
+Lower Right ( 1000125.000, 999875.000) ( 23d13' 3.85"W, 25d30'18.95"N)
+Center ( 1000062.500, 999937.500) ( 23d13' 6.65"W, 25d30'19.98"N)
+Band 1 Block=5x5 Type=Byte, ColorInterp=Gray
+gdalinfo output.tif
+Driver: GTiff/GeoTIFF
+Files: output.tif
+Size is 5, 5
+Coordinate System is:
+PROJCS["ETRS89 / LAEA Europe",
+GEOGCS["ETRS89",
+DATUM["European_Terrestrial_Reference_System_1989",
+SPHEROID["GRS 1980",6378137,298.2572221010042,
+AUTHORITY["EPSG","7019"]],
+TOWGS84[0,0,0,0,0,0,0],
+AUTHORITY["EPSG","6258"]],
+PRIMEM["Greenwich",0],
+UNIT["degree",0.0174532925199433],
+AUTHORITY["EPSG","4258"]],
+PROJECTION["Lambert_Azimuthal_Equal_Area"],
+PARAMETER["latitude_of_center",52],
+PARAMETER["longitude_of_center",10],
+PARAMETER["false_easting",4321000],
+PARAMETER["false_northing",3210000],
+UNIT["metre",1,
+AUTHORITY["EPSG","9001"]],
+AUTHORITY["EPSG","3035"]]
+Origin = (1000000.000000000000000,1000000.000000000000000)
+Pixel Size = (25.000000000000000,-25.000000000000000)
+Metadata:
+AREA_OR_POINT=Area
+TIFFTAG_DATETIME=2014:11:08 11:33:52
+TIFFTAG_DOCUMENTNAME=output.tif
+TIFFTAG_SOFTWARE=pktools 2.5.4 by Pieter Kempeneers
+Image Structure Metadata:
+INTERLEAVE=BAND
+Corner Coordinates:
+Upper Left ( 1000000.000, 1000000.000) ( 23d13' 9.44"W, 25d30'21.01"N)
+Lower Left ( 1000000.000, 999875.000) ( 23d13' 8.02"W, 25d30'17.24"N)
+Upper Right ( 1000125.000, 1000000.000) ( 23d13' 5.27"W, 25d30'22.72"N)
+Lower Right ( 1000125.000, 999875.000) ( 23d13' 3.85"W, 25d30'18.95"N)
+Center ( 1000062.500, 999937.500) ( 23d13' 6.65"W, 25d30'19.98"N)
+Band 1 Block=5x5 Type=Byte, ColorInterp=Gray
+ </screen>
+
+ </example>
+
+ </refsect1>
+
+ <refsect1 id='see-also'>
+ <title>SEE ALSO</title>
+
+ <citerefentry>
+ <refentrytitle> pkascii2ogr</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