aboutsummaryrefslogtreecommitdiff
path: root/doc/man/partial_sim.1
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2014-09-19 16:07:24 +0200
committerThomas White <taw@physics.org>2014-09-19 16:23:39 +0200
commit6a6cb3b4d7f15c234a79ff8421a0ae5c1a1dcb2a (patch)
tree00f6e0da9a8d086af18b0b1f34433bc115c9f206 /doc/man/partial_sim.1
parent2c959daa7a46b99a10dd5a1998b62ccb8def97de (diff)
Introduce CrystFEL unit cell files
Diffstat (limited to 'doc/man/partial_sim.1')
-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 2af472e9..0c30ba73 100644
--- a/doc/man/partial_sim.1
+++ b/doc/man/partial_sim.1
@@ -25,7 +25,7 @@ partial_sim \- calculate partial reflections
partial_sim calculates the intensities of idealised partial reflections from crystals in random orientations, which is useful for testing the convergence of Monte Carlo integration or scaling/post-refinement techniques.
.P
-You need to provide a CrystFEL geometry file (with \fB--geometry=\fR\fImy.geom\fR or \fB-g\fR \fImy.geom\fR), a beam description file (with \fB--beam=\fR\fImy.beam\fR or \fB-b\fR \fImy.beam\fR), a PDB file containing at least a CRYST1 line specifying the unit cell to use for the simulation (with \fB--pdb=\fR\fImy.pdb\fR or \fB-p\fR \fImy.pdb\fR), and an output filename with \fB--output=\fR\fImy.stream\fR or \fB-o\fR \fImy.stream\fR.
+You need to provide a CrystFEL geometry file (with \fB--geometry=\fR\fImy.geom\fR or \fB-g\fR \fImy.geom\fR), a beam description file (with \fB--beam=\fR\fImy.beam\fR or \fB-b\fR \fImy.beam\fR), a file containing the unit cell to use for the simulation (with \fB--pdb=\fR\fImy.pdb\fR or \fB-p\fR \fImy.pdb\fR), and an output filename with \fB--output=\fR\fImy.stream\fR or \fB-o\fR \fImy.stream\fR.
For each randomly generated orientation, partial_sim calculates which reflections would appear on the detector with the specified beam parameters. It calculates the partiality for each reflection and multiplies it by the fully integrated intensity to produce a partial intensity. The fully integrated intensities can be taken from a file you provide (see below), otherwise they will be randomly generated (by taking the absolute value of a Gaussian random number, mean zero and standard deviation 1000). All the partial intensities for the orientation are multiplied by an overall scaling factor, which is randomly generated with a Gaussian distribution with mean 1 and standard deviation 0.3. The partial intensities are written to the output stream, and the process repeated for as many different orientations as you ask for (see below, default: 2).
@@ -48,6 +48,13 @@ Take the fully integrated reflection intensities from \fIfile.hkl\fR, instead of
Specify the number of different orientations to simulate. Default: 2.
.PD 0
+.IP "\fB-p\fR \fIunitcell.cell\fR"
+.IP "\fB-p\fR \fIunitcell.pdb\fR"
+.IP \fB--pdb=\fR\fIunitcell.pdb\fR
+.PD
+Specify the name of the file containing unit cell information, in PDB or CrystFEL format.
+
+.PD 0
.B
.IP "-r \fIrandom.hkl\fR"
.B