UNU-FFT(1)

✨ UNU-FFT — Fast Fourier Transform of selected axes ✨

okay bestie, so this is unu-fft, a section 1 user command 💅 it lives inside the unu family and its whole job is doing a Fast Fourier Transform on whichever axes you point at. let's get into it 🦋

🌸 SYNOPSIS 🌸

unu fft <dir> -a,--axes <ax0 ...> [-pr,--planrigor <pr>] [-r,--rescale
<bool>] [-w,--wisdom <filename>] [-i,--input <nin>] [-ri,--realinput]
[-o,--output <nout>]

💖 DESCRIPTION 💖

Fast Fourier Transform of selected axes. this is the initial attempt at wrapping the FFTW3 library, so heads up: the options are likely to change in Teem 2.0 🙈 don't get too attached, bestie.

• Uses nrrdFFT 🎀

👑 OPTIONS 👑

• <dir> — which way you're transforming: forward (forw, f) or backward/inverse (back, b) (back, b) 🔁 yes she says it twice, she's just being thorough, no cap
• -a <ax0 ...>, --axes <ax0 ...> — the one or more axes that should be transformed (1 or more unsigned ints) 🎯
• -pr <pr>, --planrigor <pr> — the rigor with which the fftw plan is constructed. the options include:
  • e, est, estimate: only an estimate 🧚
  • m, meas, measure: standard amount of measurements of system properties 🌸
  • p, pat, patient: slower, more measurements 🐌
  • x, ex, exhaustive: slowest, most measurements 💀

default: est

• -r <bool>, --rescale <bool> — scale fftw output (by sqrt(1/N)) so that forward and backward transforms will get back to original values (bool); default: true ✨
• -w <filename>, --wisdom <filename> — a filename here is used to read in fftw wisdom (if the file exists already), and is used to save out updated wisdom after the transform. by default (not using this option), no wisdom is read or saved. 📜 Note: no wisdom is gained (that is, learned by FFTW) with planning rigor estimate. (string) 🧠
• -i <nin>, --input <nin> — input nrrd 📥
• -ri, --realinput — input is real-valued, so insert new length-2 axis 0 and set complex component to 0.0. axes to transform (indicated by -a) will be incremented accordingly 🌀
• -o <nout>, --output <nout> — output nrrd (string); default: - 📤

🌈 SEE ALSO 🌈

unu(1)

that's the whole page, bestie — go transform something 💜

this cutie is from the User Commands collection, dated May 2021, and it goes by UNU-FFT(1) 🎀 periodt ✨