PYFAI-AVERAGE(1)

💖 PYFAI-AVERAGE 💖

okay bestie, welcome to pyFAI-average, a manual page for the utility that averages out a serie of files 🎀 (yes, "serie", the tool said what it said, we respect it).

---

✨ NAME ✨

pyFAI-average — utility that averages out a serie of files 💅

---

🌸 DESCRIPTION 🌸

so like. here's the vibe:

usage: pyFAI-average [options] [options] -o output.edf file1.edf file2.edf ...

This tool can be used to average out a set of dark current images using mean or median filter (along the image stack). 🦋 One can also reject outliers be specifying a cutoff (remove cosmic rays / zingers from dark). no cap, it really does both.

---

🎀 positional arguments:

• FILE — Files to be processed. that's it, that's the whole job, just hand over the files bestie 💖

---

💅 options:

• -h, --help — show this help message and exit ✨
• -V, --version — show program's version number and exit 👑
• -o OUTPUT, --output OUTPUT — Output/ destination of average image 🌈
• -m METHOD, --method METHOD — Method used for averaging, can be 'mean' (default) or 'min', 'max', 'median', 'sum', 'quantiles' , 'cutoff', 'std'. Multiple filters can be defined with , separator. 🔥 yes you can stack them, main character energy fr fr
• -c CUTOFF, --cutoff CUTOFF — Take the mean of the average +/- cutoff * std_dev. 🧚
• -F FORMAT, --format FORMAT — Output file/image format (by default EDF) 🍓
• -d DARK, --dark DARK — Dark noise to be subtracted 💜
• -f FLAT, --flat FLAT — Flat field correction 🌸
• -v, --verbose — switch to verbose/debug mode 🔍
• -q QUANTILES, --quantiles QUANTILES — average out between two quantiles - -q 0.20-0.90 ✨
• --monitor-name MONITOR_KEY — Name of the monitor in the header of each input files. If defined the contribution of each input file is divided by the monitor. If the header does not contain or contains a wrong value, the contribution of the input file is ignored. On EDF files, values from 'counter_pos' can accessed by using the expected mnemonic. For example 'counter/bmon'. 👀 (read that twice, it's giving very specific and very on purpose)
• --quiet — Only error messages are printed out 🤫

⚠️ heads up bestie: with --monitor-name, if the header doesn't contain the monitor or contains a wrong value, the contribution of the input file is ignored. that's not a suggestion, that's what happens. 💀

It can also be used to merge many images from the same sample when using a small beam and reduce the spotty-ness of Debye-Sherrer rings. In this case the "max-filter" is usually recommended. 🦋✨

---

and that's the whole page, you ate it, periodt 💅

this was pyFAI-average version 0.21.3, dated February 2023 🎀 mwah, love u, go average something iconic 💖🌈👑