aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2014-03-26 17:48:47 +0100
committerThomas White <taw@physics.org>2014-03-26 17:48:47 +0100
commitfddfbb4fd069d914865afc53053574b87ba2d552 (patch)
tree6523ca8cd5d9c1c65d4064b433e4197f41aad8ac /doc
parent372c7db873ffbc538591d66ff1c7a1fc5d390a65 (diff)
indexamajig: Don't check SNR with --peaks=hdf5 unless given --check-hdf5-snr
Diffstat (limited to 'doc')
-rw-r--r--doc/man/indexamajig.17
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/man/indexamajig.1 b/doc/man/indexamajig.1
index cb24e916..c0ddd41f 100644
--- a/doc/man/indexamajig.1
+++ b/doc/man/indexamajig.1
@@ -315,7 +315,12 @@ Normally, peaks which contain one or more pixels above max_adu (defined in the d
.PD 0
.IP \fB--no-revalidate\fR
.PD
-When using \fB--peaks=hdf5\fR, the peaks will be put through the same checks as if you were using \fB--peaks=zaef\fR. These checks reject peaks which are too close to panel edges, are saturated (unless you use \fB--use-saturated\fR), fall short of the minimum SNR value given by \fB--min-snr\fR, have other nearby peaks (closer than twice the inner integration radius, see \fB--int-radius\fR), or have any part in a bad region. Using this option skips this validation step, and uses the peaks directly.
+When using \fB--peaks=hdf5\fR, the peaks will be put through some of the same checks as if you were using \fB--peaks=zaef\fR. These checks reject peaks which are too close to panel edges, are saturated (unless you use \fB--use-saturated\fR), have other nearby peaks (closer than twice the inner integration radius, see \fB--int-radius\fR), or have any part in a bad region. Using this option skips this validation step, and uses the peaks directly.
+
+.PD 0
+.IP \fB--check-hdf5-snr\fR
+.PD
+With this option with \fB--peaks=hdf5\fR, the peaks will additionally be checked to see that they satisfy the minimum SNR specified with \fB--min-snr\fR.
.PD 0
.IP \fB--no-peaks-in-stream\fR