.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.5.
.TH PYFAI-WAXS "1" "November 2021" "pyFAI-waxs version 0.20.0 from 21/01/2021" "User Commands"
.SH NAME
pyFAI-waxs \- Integrate 2D images into powder diffraction patterns
.SH DESCRIPTION
usage: pyFAI\-waxs [options] \fB\-p\fR ponifile file1.edf file2.edf ...
.PP
Azimuthal integration for powder diffraction.
.SS "positional arguments:"
.TP
FILE
Image files to integrate
.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\-p\fR PONIFILE
PyFAI parameter file (.poni)
.TP
\fB\-n\fR NPT, \fB\-\-npt\fR NPT
Number of points in radial dimension
.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.398419843320026keV.A)
.TP
\fB\-u\fR DUMMY, \fB\-\-dummy\fR DUMMY
dummy value for dead pixels
.TP
\fB\-U\fR DELTA_DUMMY, \fB\-\-delta_dummy\fR DELTA_DUMMY
delta dummy value
.TP
\fB\-m\fR MASK, \fB\-\-mask\fR MASK
name of the file containing the mask image
.TP
\fB\-d\fR DARK, \fB\-\-dark\fR DARK
name of the file containing the dark current
.TP
\fB\-f\fR FLAT, \fB\-\-flat\fR FLAT
name of the file containing the flat field
.TP
\fB\-P\fR POLARIZATION_FACTOR, \fB\-\-polarization\fR POLARIZATION_FACTOR
Polarization factor, from \fB\-1\fR (vertical) to +1
(horizontal), default is None for no correction,
synchrotrons are around 0.95
.TP
\fB\-\-error\-model\fR ERROR_MODEL
Error model to use. Currently on 'poisson' is
implemented
.TP
\fB\-\-unit\fR UNIT
unit for the radial dimension: can be q_nm^\-1, q_A^\-1,
2th_deg, 2th_rad or r_mm
.TP
\fB\-\-ext\fR EXT
extension of the regrouped filename (.xy)
.TP
\fB\-\-method\fR METHOD
Integration method
.TP
\fB\-\-multi\fR
Average out all frame in a file before integrating
extracting variance, otherwise treat every single
frame
.TP
\fB\-\-average\fR AVERAGE
Method for averaging out: can be 'mean' (default),
\&'min', 'max' or 'median
.TP
\fB\-\-do\-2D\fR
Perform 2D integration in addition to 1D
.PP
pyFAI\-waxs is the script of pyFAI that allows data reduction (azimuthal
integration) for Wide Angle Scattering to produce X\-Ray Powder Diffraction
Pattern with output axis in 2\-theta space.