.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH MX-CALIBRATE "1" "February 2018" "MX-Calibrate from pyFAI version 0.15.0: 30/01/2018" "User Commands"
.SH NAME
MX-Calibrate \- manual page for MX-Calibrate from pyFAI version 0.15.0: 30/01/2018
.SH DESCRIPTION
usage: MX\-Calibrate \fB\-w\fR 1.54 \fB\-c\fR CeO2 file1.cbf file2.cbf ...
.PP
Calibrate automatically a set of frames taken at various sample\-detector
distance. Return the linear regression of the fit in funtion of the samplesetector distance.
.SS "positional arguments:"
.TP
FILE
List of files to calibrate
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-V\fR, \fB\-\-version\fR
show program's version number and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
switch to debug/verbose mode
.TP
\fB\-c\fR FILE, \fB\-\-calibrant\fR FILE
file containing d\-spacing of the calibrant reference
sample (MANDATORY)
.TP
\fB\-w\fR WAVELENGTH, \fB\-\-wavelength\fR WAVELENGTH
wavelength of the X\-Ray beam in Angstrom
.TP
\fB\-e\fR ENERGY, \fB\-\-energy\fR ENERGY
energy of the X\-Ray beam in keV
(hc=12.398419739640717keV.A)
.TP
\fB\-P\fR POLARIZATION_FACTOR, \fB\-\-polarization\fR POLARIZATION_FACTOR
polarization factor, from \fB\-1\fR (vertical) to +1
(horizontal), default is 0, synchrotrons are around
0.95
.TP
\fB\-b\fR BACKGROUND, \fB\-\-background\fR BACKGROUND
Automatic background subtraction if no value are
provided
.TP
\fB\-d\fR DARK, \fB\-\-dark\fR DARK
list of dark images to average and subtract
.TP
\fB\-f\fR FLAT, \fB\-\-flat\fR FLAT
list of flat images to average and divide
.TP
\fB\-s\fR SPLINE, \fB\-\-spline\fR SPLINE
spline file describing the detector distortion
.TP
\fB\-p\fR PIXEL, \fB\-\-pixel\fR PIXEL
size of the pixel in micron
.TP
\fB\-D\fR DETECTOR_NAME, \fB\-\-detector\fR DETECTOR_NAME
Detector name (instead of pixel size+spline)
.TP
\fB\-m\fR MASK, \fB\-\-mask\fR MASK
file containing the mask (for image reconstruction)
.TP
\fB\-\-filter\fR FILTER
select the filter, either mean(default), max or median
.TP
\fB\-\-saturation\fR SATURATION
consider all pixel>max*(1\-saturation) as saturated and
reconstruct them
.TP
\fB\-r\fR MAX_RINGS, \fB\-\-ring\fR MAX_RINGS
maximum number of rings to extract
.TP
\fB\-\-weighted\fR
weight fit by intensity
.TP
\fB\-l\fR DISTANCE, \fB\-\-distance\fR DISTANCE
sample\-detector distance in millimeter
.TP
\fB\-\-tilt\fR
Allow initially detector tilt to be refined (rot1,
rot2, rot3). Default: Activated
.TP
\fB\-\-no\-tilt\fR
Deactivated tilt refinement and set all rotation to 0
.TP
\fB\-\-dist\fR DIST
sample\-detector distance in meter
.TP
\fB\-\-poni1\fR PONI1
poni1 coordinate in meter
.TP
\fB\-\-poni2\fR PONI2
poni2 coordinate in meter
.TP
\fB\-\-rot1\fR ROT1
rot1 in radians
.TP
\fB\-\-rot2\fR ROT2
rot2 in radians
.TP
\fB\-\-rot3\fR ROT3
rot3 in radians
.TP
\fB\-\-fix\-dist\fR
fix the distance parameter
.TP
\fB\-\-free\-dist\fR
free the distance parameter
.TP
\fB\-\-fix\-poni1\fR
fix the poni1 parameter
.TP
\fB\-\-free\-poni1\fR
free the poni1 parameter
.TP
\fB\-\-fix\-poni2\fR
fix the poni2 parameter
.TP
\fB\-\-free\-poni2\fR
free the poni2 parameter
.TP
\fB\-\-fix\-rot1\fR
fix the rot1 parameter
.TP
\fB\-\-free\-rot1\fR
free the rot1 parameter
.TP
\fB\-\-fix\-rot2\fR
fix the rot2 parameter
.TP
\fB\-\-free\-rot2\fR
free the rot2 parameter
.TP
\fB\-\-fix\-rot3\fR
fix the rot3 parameter
.TP
\fB\-\-free\-rot3\fR
free the rot3 parameter
.TP
\fB\-\-fix\-wavelength\fR
fix the wavelength parameter
.TP
\fB\-\-free\-wavelength\fR
free the wavelength parameter
.TP
\fB\-\-no\-gui\fR
force the program to run without a Graphical interface
.TP
\fB\-\-gui\fR
force the program to run with a Graphical interface
.TP
\fB\-\-no\-interactive\fR
force the program to run and exit without prompting
for refinements
.TP
\fB\-\-interactive\fR
force the program to prompt for refinements
.TP
\fB\-\-peak\-picker\fR PEAKPICKER
Uses the 'massif', 'blob' or 'watershed' peak\-picker
algorithm (default: blob)
.PP
This tool has been developed for ESRF MX\-beamlines where an acceptable
calibration is usually present is the header of the image. PyFAI reads it and
does a "recalib" on each of them before exporting a linear regression of all
parameters versus this distance.
.SH "SEE ALSO"
The full documentation for
.B MX-Calibrate
is maintained as a Texinfo manual.  If the
.B info
and
.B MX-Calibrate
programs are properly installed at your site, the command
.IP
.B info MX-Calibrate
.PP
should give you access to the complete manual.