aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2014-03-21 16:50:43 +0100
committerThomas White <taw@physics.org>2014-03-24 12:05:55 +0100
commit774b310375715d665586aaa16d0aca7faf9a561f (patch)
treec4f343078d9e100bb37203f1ca1c731c7a055c06 /doc/man
parent8c40793e3b648d6c0709b0e080ab523db69fabe0 (diff)
partial_sim: Update documentation
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/partial_sim.118
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/man/partial_sim.1 b/doc/man/partial_sim.1
index 7321b9ff..9e74b97b 100644
--- a/doc/man/partial_sim.1
+++ b/doc/man/partial_sim.1
@@ -1,7 +1,7 @@
.\"
.\" partial_sim man page
.\"
-.\" Copyright © 2012-2013 Thomas White <taw@physics.org>
+.\" Copyright © 2012-2014 Thomas White <taw@physics.org>
.\"
.\" Part of CrystFEL - crystallography with a FEL
.\"
@@ -44,7 +44,7 @@ for information about CrystFEL geometry description files.
Take the fully integrated reflection intensities from \fIfile.hkl\fR, instead of generating them randomly.
.B
-.IP -n \fIn\fR
+.IP \fB-n\fR \fIn\fR
Specify the number of different orientations to simulate. Default: 2.
.PD 0
@@ -87,7 +87,7 @@ Set the standard deviation of the distribution of overall scaling factors to \fI
.B
.IP "\fB--full-stddev=\fR\fIval\fR
.PD
-Set the standard deviation of the distribution of randomly generated full intensities to \fIval\fR. The distribution will be Gaussian, centered on zero, and the absolute value will be taken (i.e. there will be no negative values). The default is \fB--full-stddev=1000.0\fR. This option has no effect if you also use \fB-i\fR or \fR--input\fB.
+Set the standard deviation of the distribution of randomly generated full intensities to \fIval\fR. The distribution will be Gaussian, centered on zero, and the absolute value will be taken (i.e. there will be no negative values). The default is \fB--full-stddev=1000.0\fR. This option has no effect if you also use \fB-i\fR or \fB--input\fR.
.PD 0
.B
@@ -95,6 +95,18 @@ Set the standard deviation of the distribution of randomly generated full intens
.PD
Set the standard deviation of the noise added to the partial intensities to \fIval\fR. The noise will be Gaussian, and the same for all reflections. The default is \fB--noise-stddev=20.0\fR.
+.PD 0
+.B
+.IP "\fB-j\fR \fIn\fR"
+.PD
+Use \fIn\fR threads for simulation. Default: 1.
+
+.PD 0
+.B
+.IP "\fB--images=\fR\fIprefix\fR
+.PD
+For each chunk in the output stream, write an image in HDF5 format to \fIprefix\fR\fB/sim-\fR\fINNN\fR\fB.h5\fR, where \fINNN\fR is the sequence number of the chunk in the output stream. This option is incompatible with \fB-j\fR.
+
.SH AUTHOR
This page was written by Thomas White.