aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2013-03-15 11:44:22 +0100
committerThomas White <taw@physics.org>2013-04-17 17:33:49 +0200
commit9436a03fd02a464b1440f0b54cf9f3aaca5b2ded (patch)
tree17ec9ce2e590ca0c368724424e8c711bd6818b52 /doc
parent101aa5f9f8290b1d180d04d6ab5ff7eac934c148 (diff)
partial_sim: Add --full-stddev and --noise-stddev
Diffstat (limited to 'doc')
-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 9f3436ea..7321b9ff 100644
--- a/doc/man/partial_sim.1
+++ b/doc/man/partial_sim.1
@@ -1,7 +1,7 @@
.\"
.\" partial_sim man page
.\"
-.\" Copyright © 2012 Thomas White <taw@physics.org>
+.\" Copyright © 2012-2013 Thomas White <taw@physics.org>
.\"
.\" Part of CrystFEL - crystallography with a FEL
.\"
@@ -81,7 +81,19 @@ Save a table of values to \fIfilename\fR containing, in resolution shells, the f
.B
.IP "\fB--osf-stddev=\fR\fIval\fR
.PD
-Set the standard deviation of the distribution of overall scaling factors to \fIval\fR. The distribution will be cut at zero, i.e. negative or zero scaling factors are not allowed. The distribution will be centered on 1. The default is \fB--osf-stddev=2.0\fR.
+Set the standard deviation of the distribution of overall scaling factors to \fIval\fR. The distribution will be cut at zero, i.e. negative or zero scaling factors are not allowed. The distribution will be Gaussian centered on 1. The default is \fB--osf-stddev=2.0\fR.
+
+.PD 0
+.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.
+
+.PD 0
+.B
+.IP "\fB--noise-stddev=\fR\fIval\fR
+.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.
.SH AUTHOR
This page was written by Thomas White.
@@ -90,7 +102,7 @@ This page was written by Thomas White.
Report bugs to <taw@physics.org>, or visit <http://www.desy.de/~twhite/crystfel>.
.SH COPYRIGHT AND DISCLAIMER
-Copyright © 2012 Deutsches Elektronen-Synchrotron DESY, a research centre of the Helmholtz Association.
+Copyright © 2012-2013 Deutsches Elektronen-Synchrotron DESY, a research centre of the Helmholtz Association.
.P
partial_sim, and this manaul, are part of CrystFEL.
.P