aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2014-11-10 02:01:05 +0100
committerThomas White <taw@physics.org>2014-11-10 02:01:05 +0100
commit44fa1b1c46f9cd52fb0f0842a09b1d499e3cf08c (patch)
tree7d38e34619c512d0ed1ced9b50889c91a7fd10ad
parentecce96b99c98c2b5efadbf186d2085115dbc142a (diff)
Update docs
-rw-r--r--doc/man/partial_sim.12
-rw-r--r--doc/man/pattern_sim.114
-rw-r--r--src/pattern_sim.c4
3 files changed, 6 insertions, 14 deletions
diff --git a/doc/man/partial_sim.1 b/doc/man/partial_sim.1
index 1521b410..a06c4577 100644
--- a/doc/man/partial_sim.1
+++ b/doc/man/partial_sim.1
@@ -142,7 +142,7 @@ Set the radius of the scattering density surrounding each reciprocal lattice poi
.B
.IP "\fB--photon-energy=\fIval\fR"
.PD
-Set the central photon energy, in eV, for the incident beam. The default is \fB--photon-energy=9000\fR, i.e. 9 keV X-rays.\fR.
+Set the central photon energy, in eV, for the incident beam. The default is \fB--photon-energy=9000\fR, i.e. 9 keV X-rays.
.SH AUTHOR
This page was written by Thomas White.
diff --git a/doc/man/pattern_sim.1 b/doc/man/pattern_sim.1
index b709ed3e..72c8a766 100644
--- a/doc/man/pattern_sim.1
+++ b/doc/man/pattern_sim.1
@@ -140,12 +140,6 @@ Suppress the subsidiary maxima of the shape transforms by setting I_latt(q) to z
.PD 0
.B
-.IP "\fB--beam-divergence=\fIval\fR"
-.PD
-Set the convergence angle (the full angle, not "half-angle"/"semi-angle") for the incident beam. The default is \fB--beam-divergence=0.001\fR, i.e. 1 mrad.\fR.
-
-.PD 0
-.B
.IP "\fB--beam-bandwidth=\fIval\fR"
.PD
Set the bandwidth, expressed as a decimal fraction applying to to wavelengths (not the photon energies), for the incident beam. The default is \fB--beam-bandwidth=0.01\fR, i.e. 1%.\fR.
@@ -154,15 +148,15 @@ Note: When using the two-colour or SASE spectrum, the spectrum calculation actua
.PD 0
.B
-.IP "\fB--profile-radius=\fIval\fR"
+.IP "\fB--photon-energy=\fIval\fR"
.PD
-Set the radius of the scattering density surrounding each reciprocal lattice point, in m^-1. The default is \fB--profile-radius=0.001e9\fR m^-1.
+Set the central photon energy, in eV, for the incident beam. The default is \fB--photon-energy=9000\fR, i.e. 9 keV X-rays.
.PD 0
.B
-.IP "\fB--photon-energy=\fIval\fR"
+.IP "\fB--nphotons=\fIval\fR"
.PD
-Set the central photon energy, in eV, for the incident beam. The default is \fB--photon-energy=9000\fR, i.e. 9 keV X-rays.\fR.
+Set the number of photons per X-ray pulse. The default is \fB--nphotons=1e12\fR. A physically reasonable value is such that the pulse energy (number of photons multiplied by photon energy) is about 1 mJ.
.SH REFLECTION LISTS
diff --git a/src/pattern_sim.c b/src/pattern_sim.c
index f60319a6..41f136bb 100644
--- a/src/pattern_sim.c
+++ b/src/pattern_sim.c
@@ -94,11 +94,9 @@ static void show_help(const char *s)
" --background=<N> Add N photons of Poisson background (default 0).\n"
" --template=<file> Take orientations from stream <file>.\n"
" --no-fringes Exclude the side maxima of Bragg peaks.\n"
-" --beam-divergence Beam divergence in radians. Default 1 mrad.\n"
" --beam-bandwidth Beam bandwidth as a fraction. Default 1%%.\n"
-" --profile-radius Reciprocal space reflection profile radius in m^-1.\n"
-" Default 0.001e9 m^-1\n"
" --photon-energy Photon energy in eV. Default 9000.\n"
+" --nphotons Number of photons per X-ray pulse. Default 1e12.\n"
);
}