'\" -*- coding: UTF-8 -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH pkfilterascii 1 "06 December 2020" "" ""
.SH NAME
pkfilterascii \- program to filter data in an ASCII file
.SH SYNOPSIS
'nh
.fi
.ad l
\fBpkfilterascii\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
\fB-i\fR \fIinput\fR [\fB-ic\fR \fIcolumn\fR] [\fIoptions\fR] [\fIadvanced options\fR]
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
\fBpkfilterascii\fR filters the columns defined by the
option \*(T<\fB\-ic\fR\*(T>.
A varietey of filters can be selected from with the option
\*(T<\fB\-f\fR\*(T>.
The kernel size is defined with the option \*(T<\fB\-dz\fR\*(T>.
Alternatively, you can define your own filter tap values (use the option
\*(T<\fB\-tapz\fR\*(T> for each tap).
In case of spectral filtering, define the full width half max values
(\*(T<\fB\-fwhm\fR\*(T> value) or spectral response functions in ASCII
files (\*(T<\fB\-srf\fR\*(T> filename).
.SH OPTIONS
.TP 
\*(T<\fB\-i\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-input\fR\*(T> \fIfilename\fR
input ASCII file
.TP 
\*(T<\fB\-o\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-output\fR\*(T> \fIfilename\fR
Output ASCII file
.TP 
\*(T<\fB\-ic\fR\*(T> \fIcolumn\fR, \*(T<\fB\-\-inputCols\fR\*(T> \fIcolumn\fR
input columns (e.g., for three dimensional input data in first
three columns use: \*(T<\fB\-ic\fR\*(T> \fI0\fR
\*(T<\fB\-ic\fR\*(T> \fI1\fR
\*(T<\fB\-ic\fR\*(T> \fI2\fR)
.TP 
\*(T<\fB\-f\fR\*(T> \fIfilter\fR, \*(T<\fB\-\-filter\fR\*(T> \fIfilter\fR
filter function (to be implemented: dwt, dwti,dwt_cut)
.TP 
\*(T<\fB\-dz\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-dz\fR\*(T> \fIvalue\fR
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
.TP 
\*(T<\fB\-t\fR\*(T>, \*(T<\fB\-\-transpose\fR\*(T>
transpose output with samples in rows and wavelengths in cols
.TP 
\*(T<\fB\-v\fR\*(T> \fIlevel\fR, \*(T<\fB\-\-verbose\fR\*(T> \fIlevel\fR
verbose
.PP
Advanced options
.TP 
\*(T<\fB\-tapz\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-tapz\fR\*(T> \fIvalue\fR
taps used for spectral filtering
.TP 
\*(T<\fB\-fwhm\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-fwhm\fR\*(T> \fIvalue\fR
list of full width half to apply spectral filtering
(\*(T<\fB\-fwhm\fR\*(T> \fIband1\fR
\*(T<\fB\-fwhm\fR\*(T> \fIband2\fR ...)
.TP 
\*(T<\fB\-srf\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-srf\fR\*(T> \fIfilename\fR
list of ASCII files containing spectral response functions
(two columns: wavelength response)
.TP 
\*(T<\fB\-win\fR\*(T> \fIcol\fR, \*(T<\fB\-\-wavelengthIn\fR\*(T> \fIcol\fR
column number of input ASCII file containing wavelengths
.TP 
\*(T<\fB\-wout\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-wavelengthOut\fR\*(T> \fIvalue\fR
list of wavelengths in output spectrum
(\*(T<\fB\-wout\fR\*(T> \fIband1\fR
\*(T<\fB\-wout\fR\*(T> \fIband2\fR ...)
.TP 
\*(T<\fB\-interp\fR\*(T> \fItype\fR, \*(T<\fB\-\-interp\fR\*(T> \fItype\fR
type of interpolation for spectral filtering (see
http://www.gnu.org/software/gsl/manual/html_node/Interpolation-Types.html)
.TP 
\*(T<\fB\-wt\fR\*(T> \fItype\fR, \*(T<\fB\-\-wavelet\fR\*(T> \fItype\fR
wavelet type: daubechies,daubechies_centered, haar, haar_centered,
bspline, bspline_centered
.TP 
\*(T<\fB\-wf\fR\*(T> \fIfamily\fR, \*(T<\fB\-\-wf\fR\*(T> \fIfamily\fR
wavelet family (vanishing moment, see also
http://www.gnu.org/software/gsl/manual/html_node/DWT-Initialization.html)
.TP 
\*(T<\fB\-cut\fR\*(T> \fIthreshold\fR, \*(T<\fB\-\-cut\fR\*(T> \fIthreshold\fR
threshold to cut dwt coefficients.
Use 0 to keep all.