aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2014-04-29 13:57:31 +0200
committerThomas White <taw@physics.org>2014-04-29 13:57:31 +0200
commitedb11fb700e8f6a17e03b54e203e13c26cf5ab3c (patch)
tree9f2db2f4cfa16a792ed04800868cf1da5f5961ea /doc/man
parentb64bb055ea6f49a3f01a77f92148a9ca5e8767db (diff)
partial_sim: Add --background
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/partial_sim.19
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/man/partial_sim.1 b/doc/man/partial_sim.1
index b3e5c9a2..2af472e9 100644
--- a/doc/man/partial_sim.1
+++ b/doc/man/partial_sim.1
@@ -105,7 +105,14 @@ Use \fIn\fR threads for simulation. Default: 1.
.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.
+For each chunk in the output stream, write a 'sketch' 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. The intensities in the peaks in the sketches will have th
+
+.PD 0
+.B
+.IP "\fB--background=\fIval\fR"
+.PD
+Add a Poisson-distributed background with \fIval\fR photons to the sketches (see \fB--images\fR). The default is \fB--background=3000\fR.\fR.
+
.SH AUTHOR
This page was written by Thomas White.