.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.38.2.
.TH PYFAI-AVERAGE "1" "October 2014" "PyFAI" "User Commands"
.SH NAME
pyFAI-average \- pyFAI-average
.SH DESCRIPTION
usage: 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 "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\-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
\&'median', 'min' or 'max'
.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
.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.