aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2023-02-09 14:28:59 +0100
committerThomas White <taw@physics.org>2023-02-09 14:33:38 +0100
commit5d267fe61871e88a5f69c8e5e5d4217fc70f58c6 (patch)
tree47cab6f4af7bf69fd48fad9640025ec76266f663 /doc
parent48d9961f1b59a4011c4f7e5204c8a2e5f7ccf19d (diff)
pattern_sim: Fix up behaviour after DataTemplate
Analogous fixes to those done for partial_sim in 0effb5f83daf0317aa97a1cd10e7708551a25201.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/pattern_sim.116
1 files changed, 2 insertions, 14 deletions
diff --git a/doc/man/pattern_sim.1 b/doc/man/pattern_sim.1
index 02854040..36287162 100644
--- a/doc/man/pattern_sim.1
+++ b/doc/man/pattern_sim.1
@@ -27,6 +27,8 @@ pattern_sim -g mydetector.geom -p my.pdb -r -i myintensities.hkl
The unit cell geometry will be taken from the unit cell file you provide, and the intensities of the reflections will be interpolated from the reflection list file you provide. The reflection list format is the same as that output by process_hkl and handled by get_hkl. You also need a geometry description file (-g). See `man crystfel_geometry' for details of how to create a geometry file. Examples of both files can be found in the installation directory, which is normally /usr/local/share/doc/crystfel.
+Set the incident radiation wavelength and bandwidth in the geometry file. Beam divergence is not taken into account. See \fBman crystfel_geometry\fR for information about CrystFEL geometry description files.
+
The result will be written to an HDF5 file in the current directory with the name `sim.h5'.
.SH OPTIONS
@@ -140,20 +142,6 @@ Suppress the subsidiary maxima of the shape transforms by setting I_latt(q) to z
.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.
-.PD
-Note: When using the two-colour or SASE spectrum, the spectrum calculation actually takes this value to be the bandwidth applying to the photon energies instead of the wavelengths. For small bandwidths, the difference should be very small. Sorry for the horrifying inconsistency.
-
-.PD 0
-.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.
-
-.PD 0
-.B
.IP "\fB--nphotons=\fIval\fR"
.PD
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.