aboutsummaryrefslogtreecommitdiff
path: root/doc/man/list_events.1
blob: d1e080e3b14dc7831be77d2af2f5354dd97f46b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
.\"
.\" list_events man page
.\"
.\" Copyright © 2015 Thomas White <taw@physics.org>
.\"
.\" Part of CrystFEL - crystallography with a FEL
.\"

.TH LIST_EVENTS 1
.SH NAME
list_events \- generate event lists
.SH SYNOPSIS
.PP
\fBlist_events -i \fIfiles.lst \fB-o \fIevents.lst \fB-g \fIgeometry.geom
.PP
\fBlist_events --help\fI

.SH DESCRIPTION
list_events expands a list of filenames, where each file contains events in a multi-event format (e.g. the CXI format, http://www.cxidb.org/), into a list of individual events.

.SH OPTIONS

.IP "\fB-i \fIfilename\fR"
.IP \fB--input=\fIfilename\fR
.PD
Read the list of input filenames from \fIfilename\fR.

.IP "\fB-g \fIfilename\fR"
.IP \fB--geometry=\fIfilename\fR
.PD
Read the data layout (and detector geometry) from \fIfilename\fR.

.IP "\fB-o \fIfilename\fR"
.IP \fB--output=\fIfilename\fR
.PD
Write the list of events to \fIfilename\fR.

.SH AUTHOR
This page was written by Thomas White.

.SH REPORTING BUGS
Report bugs to <taw@physics.org>, or visit <http://www.desy.de/~twhite/crystfel>.

.SH COPYRIGHT AND DISCLAIMER
Copyright © 2015 Deutsches Elektronen-Synchrotron DESY, a research centre of the Helmholtz Association.
.P
list_events, and this manual, are part of CrystFEL.
.P
CrystFEL is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
.P
CrystFEL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
.P
You should have received a copy of the GNU General Public License along with CrystFEL.  If not, see <http://www.gnu.org/licenses/>.

.SH SEE ALSO
.BR crystfel (7),
.BR indexamajig (1),
.BR crystfel_geometry (5)