table of contents
other versions
- bookworm 0.14.0+dfsg-2
EIGER2CBF(1) | User Commands | EIGER2CBF(1) |
NAME¶
eiger2cbf - Portable image converter based on FabIO library to export Eiger frames (including te one from LIMA) to CBF and mimic the header from Dectris Pilatus.
DESCRIPTION¶
usage: eiger2cbf [-h] [-V] [-v] [--debug] [-o OUTPUT] [-m MASK] [-O OFFSET]
- [-D DUMMY] [--pilatus] [--dry-run] [-e ENERGY] [-w WAVELENGTH] [-d DISTANCE] [-b BEAM BEAM] [--alpha ALPHA] [--kappa KAPPA] [--chi CHI] [--phi PHI] [--omega OMEGA] [--rotation ROTATION] [--transpose] [--flip-ud] [--flip-lr] [IMAGE ...]
Portable image converter based on FabIO library to export Eiger frames (including te one from LIMA) to CBF and mimic the header from Dectris Pilatus.
positional arguments:¶
- IMAGE
- File with input images
options:¶
- -h, --help
- show this help message and exit
- -V, --version
- output version and exit
- -v, --verbose
- show information for each conversions
- --debug
- show debug information
main arguments:¶
- -o OUTPUT, --output OUTPUT
- output directory and filename template: eiger2cbf/frame_{index:04d}.cbf
- -m MASK, --mask MASK
- Read masked pixel from this file
- -O OFFSET, --offset OFFSET
- index offset, CrysalisPro likes indexes to start at 1, Python starts at 0
- -D DUMMY, --dummy DUMMY
- Set masked values to this dummy value
- --pilatus
- Select an image shape similar to Pilatus detectors for compatibiliy with Crysalis
optional behaviour arguments:¶
- --dry-run
- do everything except modifying the file system
Experimental setup options:¶
- -e ENERGY, --energy ENERGY
- Energy of the incident beam in keV
- -w WAVELENGTH, --wavelength WAVELENGTH
- Wavelength of the incident beam in ??
- -d DISTANCE, --distance DISTANCE
- Detector distance in meters
- -b BEAM BEAM, --beam BEAM BEAM
- Direct beam in pixels x, y
Goniometer setup:¶
- --alpha ALPHA
- Goniometer angle alpha value in deg.
- --kappa KAPPA
- Goniometer angle kappa value in deg.
- --chi CHI
- Goniometer angle chi value in deg. or formula f(index)
- --phi PHI
- Goniometer angle phi value in deg. or formula f(index)
- --omega OMEGA
- Goniometer angle omega value in deg. or formula f(index) like '-180+index*0.1
Image preprocessing (Important: applied in this order!):¶
- --rotation ROTATION
- Rotate the initial image by this value in degrees. Must be a multiple of 90??.
- --transpose
- Flip the x/y axis
- --flip-ud
- Flip the image upside-down
- --flip-lr
- Flip the image left-right
return codes: 0 means a success. 1 means the conversion contains a failure, 2 means there was an error in the arguments
November 2022 | eiger2cbf 0.14.0 |