Reference

pyFAI-saxs(1)

Integrate 2D images into SAXS patterns. Also used in PDF measurements

NAME

PyFAI-saxs - Integrate 2D images into SAXS patterns. Also used in PDF measurements

DESCRIPTION

usage: pyFAI-saxs [options] -n 1000 -p ponifile file1.edf file2.edf ...

Azimuthal integration for SAXS users.

positional arguments:

FILE

Image files to integrate

optional arguments:

-h, --help

show this help message and exit

-v, --version

show program's version number and exit

-p PONIFILE

PyFAI parameter file (.poni)

-n NPT, --npt NPT

Number of points in radial dimension

-w WAVELENGTH, --wavelength WAVELENGTH

wavelength of the X-Ray beam in Angstrom

-e ENERGY, --energy ENERGY

energy of the X-Ray beam in keV (hc=12.398419843320026keV.A)

-u DUMMY, --dummy DUMMY

dummy value for dead pixels

-U DELTA_DUMMY, --delta_dummy DELTA_DUMMY

delta dummy value

-m MASK, --mask MASK

name of the file containing the mask image

-d DARK, --dark DARK

name of the file containing the dark current

-f FLAT, --flat FLAT

name of the file containing the flat field

-P POLARIZATION_FACTOR, --polarization POLARIZATION_FACTOR

Polarization factor, from -1 (vertical) to +1 (horizontal), default is None for no correction, synchrotrons are around 0.95

--error-model ERROR_MODEL

Error model to use. Currently on 'poisson' is implemented

--unit UNIT

unit for the radial dimension: can be q_nm^-1, q_A^-1, 2th_deg, 2th_rad or r_mm

--ext EXT

extension of the regrouped filename (.dat)

--method METHOD

Integration method

pyFAI-saxs is the SAXS script of pyFAI that allows data reduction (azimuthal integration) for Small Angle Scattering with output axis in q space.

History

--dark since Debian 8 (Jessie); --delta_dummy since Debian 8 (Jessie); --dummy since Debian 8 (Jessie); --energy since Debian 8 (Jessie); --error-model since Debian 8 (Jessie); --ext since Debian 8 (Jessie); --flat since Debian 8 (Jessie); --help since Debian 8 (Jessie); --mask since Debian 8 (Jessie); --method since Debian 9 (Stretch); --npt since Debian 9 (Stretch); --polarization since Debian 8 (Jessie); --unit since Debian 8 (Jessie); --version since Debian 8 (Jessie); --wavelength since Debian 8 (Jessie); -P since Debian 8 (Jessie); -U since Debian 8 (Jessie); -e since Debian 8 (Jessie); -f since Debian 8 (Jessie); -m since Debian 8 (Jessie); -n since Debian 8 (Jessie); -u since Debian 8 (Jessie); -v since Debian 8 (Jessie).

-background until Debian 7 (Wheezy); -dark until Debian 7 (Wheezy); -dd until Debian 7 (Wheezy); -flat until Debian 7 (Wheezy); -mask until Debian 7 (Wheezy).