[pktools] 362/375: worked on descriptions

[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 de87e5f688f83a17c975837bae486df8022bbfd9
Author: Pieter <kempenep at gmail.com>
Date:   Fri Nov 21 18:27:32 2014 +0000

    worked on descriptions
---
 doc/createappsdox.sh              |  2 +-
 doc/description_pkdumpogr.dox     |  1 -
 doc/description_pkfillnodata.dox  | 14 ++++++++++++++
 doc/description_pkfilterascii.dox | 14 ++++++++++++++
 doc/description_pkgetmask.dox     | 14 ++++++++++++++
 5 files changed, 43 insertions(+), 2 deletions(-)

diff --git a/doc/createappsdox.sh b/doc/createappsdox.sh
index 76044b4..fc60cd5 100755
--- a/doc/createappsdox.sh
+++ b/doc/createappsdox.sh
@@ -50,7 +50,7 @@ done >> ../doc/apps.dox
 #remove depricated utilities and those not ready to publish"
 
 for TOOL in pkeditogr pkenhance pkkalman pkndvi pkreclass; do 
-    rm ../doc/${TOOL}.dox ../html/md_doc_${TOOL}.html ../html/${TOOL}_8cc_source.html
+    rm -f ../doc/${TOOL}.dox ../html/md_doc_${TOOL}.html ../html/${TOOL}_8cc_source.html
     sed -i "/${TOOL}/d" ../doc/apps.dox
 done
 echo "Savannah repository for homepage can only be maintained via cvs"
diff --git a/doc/description_pkdumpogr.dox b/doc/description_pkdumpogr.dox
index db5f61a..d25d77b 100644
--- a/doc/description_pkdumpogr.dox
+++ b/doc/description_pkdumpogr.dox
@@ -3,7 +3,6 @@
 <code>
   Usage: pkdumpogr -i input.txt [-o output]
 
-  
   Options: [-ln layername] [-n attribute]* [-pos] [-transpose]
 
   Advanced options:
diff --git a/doc/description_pkfillnodata.dox b/doc/description_pkfillnodata.dox
index e69de29..030372a 100644
--- a/doc/description_pkfillnodata.dox
+++ b/doc/description_pkfillnodata.dox
@@ -0,0 +1,14 @@
+## SYNOPSIS
+
+<code>
+  Usage: pkfillnodata -i input.txt -m mask -o output 
+  
+  Options: [-b band]* [-n attribute]* [-pos] [-transpose]
+
+  Advanced options: [-d distance] [-it iterations]
+
+</code>
+
+\section pkfillnodata_description Description
+
+The utility pkfillnodata fills nodata values in a raster dataset. Nodata values are defined as 0 values in the mask raster dataset. You can use the input file as the mask image if 0 values in the input raster have to be filled. Per default, all bands are filled. Use the option -b to fill individual band(s) in a multiband raster input image.
diff --git a/doc/description_pkfilterascii.dox b/doc/description_pkfilterascii.dox
index e69de29..daa8c3b 100644
--- a/doc/description_pkfilterascii.dox
+++ b/doc/description_pkfilterascii.dox
@@ -0,0 +1,14 @@
+## SYNOPSIS
+
+<code>
+  Usage: pkfilterascii -i input.txt [-ic column]*
+  
+  Options: [-f filter] [-dz value] [-t]
+
+  Advanced options: [-tapz value]* [-fwhm value]* [-srf filename]* [-win col] [-wout value]* [-interp type] [-wt type] [-wf family] [-cut threshold] 
+
+</code>
+
+\section pkfilterascii_description Description
+
+The utility pkfilterascii filters the columns defined by the option -ic. A varietey of filters can be selected from with the option -f. The kernel size is defined with the option -dz. Alternatively, you can define your own filter tap values (use the option -tapz for each tap). In case of spectral filtering, define the full width half max values (-fwhm value) or spectral response functions in ASCII files (-srf filename).
\ No newline at end of file
diff --git a/doc/description_pkgetmask.dox b/doc/description_pkgetmask.dox
index e69de29..8545483 100644
--- a/doc/description_pkgetmask.dox
+++ b/doc/description_pkgetmask.dox
@@ -0,0 +1,14 @@
+## SYNOPSIS
+
+<code>
+  Usage: pkgetmask -i input -o output
+  
+  Options: [-min value]* [-max value]* [-data value]* [-nodata value]*
+ 
+  Advanced options: [-b band]* [-operator AND|OR] [-ot type] [-of format] [-co option]* [-ct table] 
+
+</code>
+
+\section pkgetmask_description Description
+
+The utility pkgetmask creates a mask raster dataset from an input raster dataset. Values smaller than the minimum value (-min) or larger than the maximum value (-max) will result in a -nodata value in the mask.
\ No newline at end of file

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