.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH PYFAI-AVERAGE "1" "February 2023" "pyFAI-average version 0.21.3 from 03/02/2022" "User Commands"
.SH NAME
pyFAI-average \- utility that averages out a serie of files
.SH DESCRIPTION
usage: pyFAI\-average [options] [options] \fB\-o\fR output.edf file1.edf file2.edf ...
.PP
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)
.SS "positional arguments:"
.TP
FILE
Files to be processed
.SS "options:"
.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\-o\fR OUTPUT, \fB\-\-output\fR OUTPUT
Output/ destination of average image
.TP
\fB\-m\fR METHOD, \fB\-\-method\fR METHOD
Method used for averaging, can be 'mean' (default) or
\&'min', 'max', 'median', 'sum', 'quantiles' , 'cutoff',
\&'std'. Multiple filters can be defined with ','
separator.
.TP
\fB\-c\fR CUTOFF, \fB\-\-cutoff\fR CUTOFF
Take the mean of the average +/\- cutoff * std_dev.
.TP
\fB\-F\fR FORMAT, \fB\-\-format\fR FORMAT
Output file/image format (by default EDF)
.TP
\fB\-d\fR DARK, \fB\-\-dark\fR DARK
Dark noise to be subtracted
.TP
\fB\-f\fR FLAT, \fB\-\-flat\fR FLAT
Flat field correction
.TP
\fB\-v\fR, \fB\-\-verbose\fR
switch to verbose/debug mode
.TP
\fB\-q\fR QUANTILES, \fB\-\-quantiles\fR QUANTILES
average out between two quantiles \fB\-q\fR 0.20\-0.90
.TP
\fB\-\-monitor\-name\fR MONITOR_KEY
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'.
.TP
\fB\-\-quiet\fR
Only error messages are printed out
.PP
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.