[pktools] 347/375: added examples usages for documentation

[Bas Couwenberg]

This is an automated email from the git hooks/post-receive script.

sebastic-guest pushed a commit to branch upstream-master
in repository pktools.

commit 046b4cb4d4864aab7f47d39c3b8a483eaf4f7b8c
Author: Pieter Kempeneers <kempenep at gmail.com>
Date:   Sat Nov 8 21:19:17 2014 +0100

    added examples usages for documentation
---
 doc/examples_pkann.dox       | 15 +++++++++++
 doc/examples_pkascii2img.dox | 64 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 79 insertions(+)

diff --git a/doc/examples_pkann.dox b/doc/examples_pkann.dox
new file mode 100644
index 0000000..3ea589f
--- /dev/null
+++ b/doc/examples_pkann.dox
@@ -0,0 +1,15 @@
+\section examples_pkann Examples of pkann
+
+Classify input image input.tif with an Artificial Neural Network using one hidden layer with 5 neurons. A training sample that is provided as an OGR vector dataset. It contains all features (same dimensionality as input.tif) in its fields (please check \ref pkextract "pkextract" on how to obtain such a file from a "clean" vector file containing locations only). A two-fold cross validation (cv) is performed (output on screen).
+
+\code
+pkann -i input.tif -t training.sqlite -o output.tif --nneuron 5 -cv 2
+\endcode
+
+Same example as above, but use two hidden layers with 15 and 5 neurons respectively
+
+\code
+pkann -i input.tif -t training.sqlite -o output.tif --nneuron 15 --neuron 5 -cv 2
+\endcode
+
+
diff --git a/doc/examples_pkascii2img.dox b/doc/examples_pkascii2img.dox
new file mode 100644
index 0000000..887417e
--- /dev/null
+++ b/doc/examples_pkascii2img.dox
@@ -0,0 +1,64 @@
+\section examples_pkascii2img Examples of pkascii2img
+
+We create a 5x5 raster dataset containing all 0 values except for its center (value=1)
+
+\code
+cat input.txt
+
+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
+\endcode
+
+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:
+
+\code
+pkascii2img -i input.txt -o output.tif -of GTiff -a_srs epsg:3035 -dx 25 -dy 25 -ulx 1000000 -uly 1000000
+\endcode
+
+We check the output GeoTIFF using gdalinfo :
+
+\code
+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
+\endcode
\ No newline at end of file

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/pktools.git