diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/geoptimiser.1 | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/man/geoptimiser.1 b/doc/man/geoptimiser.1 index 369a36f1..3caba9c2 100644 --- a/doc/man/geoptimiser.1 +++ b/doc/man/geoptimiser.1 @@ -27,8 +27,10 @@ For a complete description of the optimization algorithm, see the following pape O. Yefanov, V. Mariani, C. Gati, T. A. White, H. N. Chapman, and A. Barty. "Accurate determination of segmented X-ray detector geometry". Optics Express 23 (2015) 28459. doi:10.1364/OE.23.028459. .PP -For minimal basic use, you need to provide a stream file with diffraction patterns, a geometry file to optimize, a filename for the output optimized geometry, and -the name of two rigid group collections defined in the geometry file: one describing which panels in the detector are physically connected (and hence whose geometry should be optimized as if they were a single panel), and one to describe which panels are attached to the same underlying support (whose position and orientation are likely to be correlated). +For minimal basic use, you need to provide a stream file with diffraction patterns, a geometry file to optimize, a filename for the output optimized geometry, and the name of two rigid group collections defined in the geometry file: one describing which panels in the detector are physically connected (and hence whose geometry should be optimized as if they were a single panel), and one to describe which panels are attached to the same underlying support (whose position and orientation are likely to be correlated). + +.PP +If you leave out the \fB-g\fR option, the geometry file from the stream's audit information will be used. This is usually what you want. .PP See \fBman crystfel_geometry\fR for information on how to create a file describing the detector geometry, and guidelines to define the required rigid groups and rigid groups collections. @@ -49,7 +51,7 @@ Give the filename of the stream from which to read the indexed patterns. .IP "\fB-g\fR \fIfilename\fR" .IP \fB--geometry=\fR\fIfilename\fR .PD -Read the detector geometry to optimize from the \fIfilename\fR file. +Read the detector geometry to optimize from \fIfilename\fR. If this option is omitted, the geometry file from the stream's header will be used (see \fB--input\fR), if present. .PD 0 .IP "\fB-o\fR \fIfilename\fR" @@ -139,7 +141,7 @@ This page was written by Valerio Mariani, Oleksandr Yefanov and Thomas White. Report bugs to <taw@physics.org>, or visit <http://www.desy.de/~twhite/crystfel>. .SH COPYRIGHT AND DISCLAIMER -Copyright © 2014-2018 Deutsches Elektronen-Synchrotron DESY, a research centre of the Helmholtz Association. +Copyright © 2014-2019 Deutsches Elektronen-Synchrotron DESY, a research centre of the Helmholtz Association. .P geoptimiser, and this manual, are part of CrystFEL. .P |