aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2012-03-09 16:15:05 +0100
committerThomas White <taw@physics.org>2012-03-09 16:15:05 +0100
commitf523fa66c4e316f396a3c793a4f9e3d1fd37bd2b (patch)
tree833b2b47dc2e61d8684dd7c67f27d15c6ea0f531 /doc
parent603d5c90bba95e36fe5c59e03b1e463b0174e013 (diff)
Update get_hkl manpage
Diffstat (limited to 'doc')
-rw-r--r--doc/man/get_hkl.127
1 files changed, 14 insertions, 13 deletions
diff --git a/doc/man/get_hkl.1 b/doc/man/get_hkl.1
index 5db321c9..d16b42e7 100644
--- a/doc/man/get_hkl.1
+++ b/doc/man/get_hkl.1
@@ -24,46 +24,47 @@ The input filename should be specified with \fB-i\fR \fIfilename\fR or \fB--inpu
.PD 0
.IP "\fB-e\fR \fIpointgroup\fR"
.IP \fB--expand=\fR\fIpointgroup\fR
-.PD 1
-.PP
+.PD
The reflections will be expanded out, according to the symmetry of the input reflections, to fill the asymmetric unit of \fIpointgroup\fR.
.SH REDUCING REFLECTIONS INTO A POINT GROUP OF HIGHER SYMMETRY
.PD 0
.IP "\fB-w\fR \fIpointgroup\fR"
.IP \fB--twin=\fR\fIpointgroup\fR
-.PD 1
-.PP
+.PD
Reflections in the list which are equivalent according to \fIpointgroup\fR will have their intensities summed. The output reflection list will contain the summed intensities in the asymmetric unit for \fIpointgroup\fR. Reflections for which any of the 'twin mates' are missing will not be written out.
.SH ADDING NOISE
.PD 0
.IP \fB--poisson\fR
.IP \fB--noise\fR
-.PD 1
-.PP
-Add either 10% flat random noise (with \fB--noise\fR) or generate Poisson noise (with \fB--poisson\fR). If Poisson noise is to be generated, the reflection intensities will be assumed to be measured in arbitrary units, and the conversion factor to photons will come from the adu_per_photon field of the beam description file provided with \fB-b\fR \fIfilename\fR or \fB--beam=\fR\fIfilename\fR.
+.PD
+Add either 10% flat random noise (with \fB--noise\fR) or generate Poisson noise (with \fB--poisson\fR). If Poisson noise is to be generated, the reflection intensities will be assumed to be measured in arbitrary units, and the conversion factor to photons must be given using \fB--adu-per-photon=\fR\fIn\fR, where
+\fIn\fR is the conversion factor.
+
+.PD 0
+.IP \fB--adu-per-photon=\fR\fIn\fR
+.PD
+See \fB--poisson\fR.
+
.SH REMOVING DUPLICATED REFLECTIONS
.PD 0
.IP \fB--trim-centrics\fR
-.PD 1
-.PP
+.PD
Reflections which are duplicated, according to the symmetry of the input reflection list, will be removed. This is sometimes useful when importing data from other programs.
.SH RESTRICTING REFLECTIONS ACCORDING TO A TEMPLATE
.PD 0
.IP "\fB-t\fR \fIfilename\fR"
.IP \fB--template=\fR\fIfilename\fR
-.PD 1
-.PP
+.PD
Only reflections in the input list which also appear in \fIfilename\fR will be written to the output.
.SH MULTIPLICITY
.PD 0
.IP \fB--multiplicity\fR
-.PD 1
-.PP
+.PD
The intensities of the reflections will be multiplied by their symmetric multiplicities according to the point group of the input list.
.SH AUTHOR