pkfilterascii(1)

💖 pkfilterascii(1) 💖

okay so bestie, pull up a chair, because pkfilterascii is one of those lil command-line girlies from the pkfilterascii manual (section 1, the user-commands section, iykyk) and she is so good at what she does 🫶

---

✨ NAME ✨

pkfilterascii — a program to filter data in an ASCII file 🎀

---

🌸 SYNOPSIS 🌸

pkfilterascii -i input [-ic column] [options] [advanced options]

---

🦋 DESCRIPTION 🦋

okay so the whole vibe of pkfilterascii is: it filters the columns you tell it about with the option -ic. ✨

and like, you've got a whole menu of filters to pick from, and you choose with the option -f. the kernel size? that's the option -dz, she sets the vibe. 💅

or, plot twist, you can be your own filter designer and define your own filter tap values — just use the option -tapz for each tap, one at a time, no skips. 👑

and if you're doing spectral filtering? then it's time to define the full width half max values (-fwhm value) or else drop in some spectral response functions as ASCII files (-srf filename). literally pick your fighter. 🌈

---

💜 OPTIONS 💜

• -i filename, --input filename — the input ASCII file, aka the main character you're feeding in 🍓
• -o filename, --output filename — the output ASCII file, where the filtered glow-up gets written 💖
• -ic column, --inputCols column — input columns, bestie. like for three dimensional input data sitting in the first three columns you'd go: -ic 0 -ic 1 -ic 2 ✨
• -f filter, --filter filter — the filter function. heads up though, these ones are still to be implemented: dwt, dwti, dwt_cut 🙈
• -dz value, --dz value — filter kernel size in z (that's the band or spectral dimension, for the uninitiated). it must be odd (example: 3). and set dz>0 if a 1-D filter must be used in the band domain ⭐
• -t, --transpose — transposes the output so samples are in rows and wavelengths are in cols. a lil flip, a lil rearrangement, slay 🔥
• -v level, --verbose level — verbose. she talks more 💅

👑 Advanced options 👑

• -tapz value, --tapz value — the taps used for spectral filtering 🎀
• -fwhm value, --fwhm value — list of full width half to apply spectral filtering (-fwhm band1 -fwhm band2 ...) 🌸
• -srf filename, --srf filename — list of ASCII files containing spectral response functions (two columns: wavelength response) 🧚
• -win col, --wavelengthIn col — the column number of the input ASCII file that's holding the wavelengths 👑
• -wout value, --wavelengthOut value — list of wavelengths in the output spectrum (-wout band1 -wout band2 ...) ✨
• -interp type, --interp type — the type of interpolation for spectral filtering (go peek at http://www.gnu.org/software/gsl/manual/html_node/Interpolation-Types.html) 💖
• -wt type, --wavelet type — the wavelet type. your choices are: daubechies, daubechies_centered, haar, haar_centered, bspline, bspline_centered 🌈
• -wf family, --wf family — the wavelet family (vanishing moment, see also http://www.gnu.org/software/gsl/manual/html_node/DWT-Initialization.html) ⭐
• -cut threshold, --cut threshold — the threshold to cut dwt coefficients. use 0 to keep all of them 🫶

---

ok real talk though bestie — -dz must be odd, that is not a suggestion, that is the law 💀 and those -f filter functions (dwt, dwti, dwt_cut) are still marked to be implemented, so don't come for me if they're not ready 🙈

---

and that's the whole page, no cap. this lil beauty is dated 01 January 2025 and she lives in the pkfilterascii(1) manual — go forth and filter, you absolute icon 💅✨👑