aboutsummaryrefslogtreecommitdiff
path: root/doc/man/process_hkl.1
blob: ea1a77d5aab7abec96b0d8ec858166a69b771174 (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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.\"
.\" process_hkl man page
.\"
.\" Copyright © 2012 Thomas White <taw@physics.org>
.\"
.\" Part of CrystFEL - crystallography with a FEL
.\"

.TH PROCESS\_HKL 1
.SH NAME
process\_hkl \- Monte Carlo merging of Bragg intensities
.SH SYNOPSIS
.PP
.B process\_hkl
-i mypatterns.stream -o mydata.hkl -y mypointgroup [options]

.SH DESCRIPTION
process_hkl takes a data stream from "indexamajig" and merges the many individual intensities together to form a single list of reflection intensities which are useful for crystallography.

Typical usage is of the form:
.PP
$ process_hkl -i mypatterns.stream -o mydata.hkl -y mypointgroup

.SH CHOICE OF POINT GROUP FOR MERGING

One of the main features of serial crystallography is that the orientations of
individual crystals are random.  That means that the orientation of each
crystal must be determined independently, with no information about its
relationship to the orientation of crystals in other patterns (as would be the
case for a rotation series of patterns).

Some Laue classes are merohedral.  This means that the orientation will have an
ambiguity, but this time more serious.  The two (or more) possible
orientations could be called "twins", but the mechanism of their formation is
somewhat different to the conventional use of the term.  In these cases, you
will need to merge according to the point group corresponding holohedral Laue
class.

You can also tell process_hkl the "apparent" symmetry, which is the symmetry as
far as whatever produced the stream was concerned.  In the case of most indexing
algorithms, this will be the corresponding holohedral point group (not the
Laue class nor the holohedral Laue class).  If you use the "-a" option to give
this information, process_hkl will try to resolve the remaining orientational
ambiguities to get from the apparent symmetry to the true symmetry (given with
"-y").  Currently, it won't do a very good job of it.

The document twin-calculator.pdf contains more detailed information about this
issue, as well as tables which contain all the required information.

.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 © 2012 Thomas White <taw@physics.org>
.P
indexamajig is 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 (5),
.BR compare_hkl (1),
.BR check_hkl (1),
.BR render_hkl (1),
.BR partialator (1)