Scroll to navigation

PYFAI-AVERAGE(1) User Commands PYFAI-AVERAGE(1)

NAME

pyFAI-average - utility that averages out a serie of files

DESCRIPTION

usage: pyFAI-average [options] [options] -o output.edf file1.edf file2.edf ...

This tool can be used to average out a set of dark current images using mean or median filter (along the image stack). One can also reject outliers be specifying a cutoff (remove cosmic rays / zingers from dark)

positional arguments:

Files to be processed

optional arguments:

show this help message and exit
show program's version number and exit
Output/ destination of average image
Method used for averaging, can be 'mean' (default) or 'min', 'max', 'median', 'sum', 'quantiles' , 'cutoff', 'std'. Multiple filters can be defined with ',' separator.
Take the mean of the average +/- cutoff * std_dev.
Output file/image format (by default EDF)
Dark noise to be subtracted
Flat field correction
switch to verbose/debug mode
average out between two quantiles -q 0.20-0.90
Name of the monitor in the header of each input files. If defined the contribution of each input file is divided by the monitor. If the header does not contain or contains a wrong value, the contribution of the input file is ignored. On EDF files, values from 'counter_pos' can accessed by using the expected mnemonic. For example 'counter/bmon'.
Only error messages are printed out

It can also be used to merge many images from the same sample when using a small beam and reduce the spotty-ness of Debye-Sherrer rings. In this case the "max-filter" is usually recommended.

March 2022 pyFAI-average version 0.21.3 from 03/02/2022