MX-CALIBRATE(1)

✨ MX-CALIBRATE(1) — User Commands 🎀

✨ NAME ✨

MX-Calibrate is the tool that calibrates the distance of a detector from a set of powder diffraction patterns 💖

✨ SYNOPSIS ✨

MX-Calibrate -w 1.54 -c CeO2 file1.cbf file2.cbf ...

✨ DESCRIPTION ✨

okay so bestie, this is the usage line 💅

usage: MX-Calibrate -w 1.54 -c CeO2 file1.cbf file2.cbf ...

It automatically calibrates a whole batch of frames that were taken at different sample-detector distances 🦋 Then it hands you back the linear regression of the fit as a function of that sample-detector distance. Literally so iconic 🔥

✨ positional arguments ✨

• FILE — the list of files you want to calibrate 📂

✨ options ✨

• -h, --help — shows the help message and exits 🫶
• -V, --version — shows the program's version number and exits 🌸
• -v, --verbose — flips on debug/verbose mode so you can see everything ✨
• -c FILE, --calibrant FILE — the file with the d-spacing of your calibrant reference sample. This one is MANDATORY 💀
• -w WAVELENGTH, --wavelength WAVELENGTH — the wavelength of the X-Ray beam, in Angstrom 🌈
• -e ENERGY, --energy ENERGY — the energy of the X-Ray beam, in keV. The constant in use is hc=12.398419843320026keV.A 🔥
• -P POLARIZATION_FACTOR, --polarization POLARIZATION_FACTOR — the polarization factor, going from -1 (vertical) to +1 (horizontal). The default is 0, and synchrotrons sit around 0.95 ⭐
• -b BACKGROUND, --background BACKGROUND — automatic background subtraction happens if you don't give it a value 🧚
• -d DARK, --dark DARK — a list of dark images that get averaged and then subtracted 🌙
• -f FLAT, --flat FLAT — a list of flat images that get averaged and then divided 🍓
• -s SPLINE, --spline SPLINE — the spline file that describes the detector distortion 🦋
• -p PIXEL, --pixel PIXEL — the size of the pixel, in micron 💜
• -D DETECTOR_NAME, --detector DETECTOR_NAME — the detector name, which you use instead of pixel size + spline 🎀
• -m MASK, --mask MASK — the file containing the mask, used for image reconstruction 🫧
• --filter FILTER — picks the filter: mean (the default), max or median 💅
• --saturation SATURATION — any pixel where pixel>max*(1-saturation) gets treated as saturated and reconstructed 🔥
• -r MAX_RINGS, --ring MAX_RINGS — the maximum number of rings to extract 💖
• --weighted — weights the fit by intensity ✨
• -l DISTANCE, --distance DISTANCE — the sample-detector distance, in millimeter 📏
• --tilt — lets the initial detector tilt get refined (rot1, rot2, rot3). Default: Activated 🦋
• --no-tilt — turns off tilt refinement and sets all the rotations to 0 🙈
• --dist DIST — the sample-detector distance, but in meter this time 📐
• --poni1 PONI1 — the poni1 coordinate, in meter 🌸
• --poni2 PONI2 — the poni2 coordinate, in meter 🌸
• --rot1 ROT1 — rot1, in radians 🌀
• --rot2 ROT2 — rot2, in radians 🌀
• --rot3 ROT3 — rot3, in radians 🌀
• --fix-dist — locks the distance parameter in place 🔒
• --free-dist — unlocks the distance parameter 🔓
• --fix-poni1 — locks the poni1 parameter 🔒
• --free-poni1 — unlocks the poni1 parameter 🔓
• --fix-poni2 — locks the poni2 parameter 🔒
• --free-poni2 — unlocks the poni2 parameter 🔓
• --fix-rot1 — locks the rot1 parameter 🔒
• --free-rot1 — unlocks the rot1 parameter 🔓
• --fix-rot2 — locks the rot2 parameter 🔒
• --free-rot2 — unlocks the rot2 parameter 🔓
• --fix-rot3 — locks the rot3 parameter 🔒
• --free-rot3 — unlocks the rot3 parameter 🔓
• --fix-wavelength — locks the wavelength parameter 🔒
• --free-wavelength — unlocks the wavelength parameter 🔓
• --no-gui — forces the program to run without a Graphical interface 🙅
• --gui — forces the program to run with a Graphical interface 🖼️
• --no-interactive — forces the program to run and exit without prompting you for refinements 🤖
• --interactive — forces the program to prompt you for refinements 💬
• --peak-picker PEAKPICKER — uses the massif, blob or watershed peak-picker algorithm. The default is blob ⛰️

This tool was built for ESRF MX-beamlines, where an acceptable calibration is usually already sitting in the header of the image. PyFAI reads that header and runs a "recalib" on each frame before exporting a linear regression of all the parameters versus this distance. Dramatic? Yes. Necessary? Also yes 👑

---

Bye bestie 🫶 this page is from pyFAI versi..., February 2023, and you're officially a calibration pro now 💅✨ MX-CALIBRATE(1) 🌈