aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2013-11-11 17:08:06 +0100
committerThomas White <taw@physics.org>2013-11-11 17:08:06 +0100
commit4d8a9262b356b7f1df53d3f9f83204faa37d7a21 (patch)
treefd5ffee3d8f3cd96039b73624246e64e841b0e43 /doc
parent156dc5382ac1a7ec3cd38daf49b1c47653749baf (diff)
process_hkl: Add warnings about --min-snr
Diffstat (limited to 'doc')
-rw-r--r--doc/man/process_hkl.14
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/man/process_hkl.1 b/doc/man/process_hkl.1
index e4189ad2..d32d8b8f 100644
--- a/doc/man/process_hkl.1
+++ b/doc/man/process_hkl.1
@@ -105,7 +105,9 @@ Include a reflection in the output only if it appears at least least \fIn\fR tim
.PD 0
.IP \fB--min-snr=\fR\fIn\fR
.PD
-Use a particular individual reflection intensity measurement only if it exceeds its estimated standard error by at least \fIn\fR. The default -infinity, i.e. no cutoff.
+Use a particular individual reflection intensity measurement only if it exceeds its estimated standard error by at least \fIn\fR. The default is -infinity, i.e. no cutoff.
+.IP
+\fBWARNING:\fR think very carefully before using this option. It will bias reflections towards more positive values, even where no signal exists, leading to a data set dominated by the background. This can invalidate some of the figures of merit for the merit for data quality while severely compromising the actual quality.
.SH CHOICE OF POINT GROUP FOR MERGING