[pktools] 02/07: Add man page for pkfilterascii.
Bas Couwenberg
sebastic at xs4all.nl
Sun Dec 7 01:42:20 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 c5d7e04e69c4dca88abde792bad3143ebb1486ce
Author: Bas Couwenberg <sebastic at xs4all.nl>
Date: Sat Dec 6 22:52:00 2014 +0100
Add man page for pkfilterascii.
---
debian/changelog | 2 +-
debian/man/pkfilterascii.1.xml | 228 +++++++++++++++++++++++++++++++++++++++++
2 files changed, 229 insertions(+), 1 deletion(-)
diff --git a/debian/changelog b/debian/changelog
index 691dd7f..42ee1f5 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -5,7 +5,7 @@ pktools (2.6.1-1) UNRELEASED; urgency=medium
* Remove libbase package, library no longer installed.
* Add man page for pkann, pkascii2img, pkascii2ogr, pkcomposite, pkcreatect,
pkcrop, pkdiff, pkdsm2shadow, pkdumpimg, pkdumpogr, pkegcs, pkextract,
- pkfillnodata.
+ pkfillnodata, pkfilterascii.
-- Bas Couwenberg <sebastic at xs4all.nl> Wed, 03 Dec 2014 21:16:31 +0100
diff --git a/debian/man/pkfilterascii.1.xml b/debian/man/pkfilterascii.1.xml
new file mode 100644
index 0000000..c42001e
--- /dev/null
+++ b/debian/man/pkfilterascii.1.xml
@@ -0,0 +1,228 @@
+<?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='pkfilterascii'>
+
+ <refmeta>
+ <refentrytitle>pkfilterascii</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>pkfilterascii</refname>
+ <refpurpose>program to filter data in an ASCII file</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>pkfilterascii</command>
+ <arg choice='plain'><option>-i</option> <replaceable>input</replaceable></arg>
+ <arg choice='opt'><option>-ic</option> <replaceable>column</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>pkfilterascii</command> filters the columns defined by the
+ option <option>-ic</option>.
+ A varietey of filters can be selected from with the option
+ <option>-f</option>.
+ The kernel size is defined with the option <option>-dz</option>.
+ Alternatively, you can define your own filter tap values (use the option
+ <option>-tapz</option> for each tap).
+ In case of spectral filtering, define the full width half max values
+ (<option>-fwhm</option> value) or spectral response functions in ASCII
+ files (<option>-srf</option> filename).
+ </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 ASCII file
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-ic</option> <replaceable>column</replaceable></term>
+ <term><option>--inputCols</option> <replaceable>column</replaceable></term>
+ <listitem>
+ <para>
+ input columns (e.g., for three dimensional input data in first
+ three columns use: <option>-ic</option> <replaceable>0</replaceable>
+ <option>-ic</option> <replaceable>1</replaceable>
+ <option>-ic</option> <replaceable>2</replaceable>)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f</option> <replaceable>filter</replaceable></term>
+ <term><option>--filter</option> <replaceable>filter</replaceable></term>
+ <listitem>
+ <para>
+ filter function (to be implemented: dwt, dwti,dwt_cut)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-dz</option> <replaceable>value</replaceable></term>
+ <term><option>--dz</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ filter kernel size in z (band or spectral dimension),
+ must be odd (example: 3).
+ Set dz>0 if 1-D filter must be used in band domain
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-t</option></term>
+ <term><option>--transpose</option></term>
+ <listitem>
+ <para>
+ transpose output with samples in rows and wavelengths in cols
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option> <replaceable>level</replaceable></term>
+ <term><option>--verbose</option> <replaceable>level</replaceable></term>
+ <listitem>
+ <para>
+ verbose
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ <para>Advanced options</para>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-tapz</option> <replaceable>value</replaceable></term>
+ <term><option>--tapz</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ taps used for spectral filtering
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-fwhm</option> <replaceable>value</replaceable></term>
+ <term><option>--fwhm</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ list of full width half to apply spectral filtering
+ (<option>-fwhm</option> <replaceable>band1</replaceable>
+ <option>-fwhm</option> <replaceable>band2</replaceable> ...)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-srf</option> <replaceable>filename</replaceable></term>
+ <term><option>--srf</option> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ list of ASCII files containing spectral response functions
+ (two columns: wavelength response)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-win</option> <replaceable>col</replaceable></term>
+ <term><option>--wavelengthIn</option> <replaceable>col</replaceable></term>
+ <listitem>
+ <para>
+ column number of input ASCII file containing wavelengths
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-wout</option> <replaceable>value</replaceable></term>
+ <term><option>--wavelengthOut</option> <replaceable>value</replaceable></term>
+ <listitem>
+ <para>
+ list of wavelengths in output spectrum
+ (<option>-wout</option> <replaceable>band1</replaceable>
+ <option>-wout</option> <replaceable>band2</replaceable> ...)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-interp</option> <replaceable>type</replaceable></term>
+ <term><option>--interp</option> <replaceable>type</replaceable></term>
+ <listitem>
+ <para>
+ type of interpolation for spectral filtering (see
+ http://www.gnu.org/software/gsl/manual/html_node/Interpolation-Types.html)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-wt</option> <replaceable>type</replaceable></term>
+ <term><option>--wavelet</option> <replaceable>type</replaceable></term>
+ <listitem>
+ <para>
+ wavelet type: daubechies,daubechies_centered, haar, haar_centered,
+ bspline, bspline_centered
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-wf</option> <replaceable>family</replaceable></term>
+ <term><option>--wf</option> <replaceable>family</replaceable></term>
+ <listitem>
+ <para>
+ wavelet family (vanishing moment, see also
+ http://www.gnu.org/software/gsl/manual/html_node/DWT-Initialization.html)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-cut</option> <replaceable>threshold</replaceable></term>
+ <term><option>--cut</option> <replaceable>threshold</replaceable></term>
+ <listitem>
+ <para>
+ threshold to cut dwt coefficients.
+ Use 0 to keep all.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </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