diff options
| author | Thomas White <taw@physics.org> | 2021-07-05 12:12:27 +0200 |
|---|---|---|
| committer | Thomas White <taw@physics.org> | 2021-07-05 12:12:47 +0200 |
| commit | 7de725cd220aee0adee42b8295c4b48aedaa5127 (patch) | |
| tree | b1c3055d5934ad9d8cdd4e59c6a96c5147cd01c7 /doc/man | |
| parent | ffbb75c869cc8197e3bfa5228252dd286a0e511b (diff) | |
indexamajig(1): Clarify --min-peaks default value
Diffstat (limited to 'doc/man')
| -rw-r--r-- | doc/man/indexamajig.1 | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/man/indexamajig.1 b/doc/man/indexamajig.1 index 7045d8de..d3ed3091 100644 --- a/doc/man/indexamajig.1 +++ b/doc/man/indexamajig.1 @@ -254,7 +254,7 @@ these. The default is to use the same values as for \fB--int-radius\fR. .PD 0 .IP \fB--min-peaks=\fIn\fR .PD -Do not try to index frames with fewer than \fIn\fR peaks. These frames will still be described in the output stream. To exclude them, use \fB--no-non-hits-in-stream\fR. +Do not try to index frames with fewer than \fIn\fR peaks. These frames will still be described in the output stream. To exclude them, use \fB--no-non-hits-in-stream\fR. The default is \fB--min-peaks=0\fR, which means that \fIall\fR frames will be considered hits, even if they have no peaks at all. .PD 0 .IP \fB--hdf5-peaks=\fR\fIpath\fR @@ -526,7 +526,7 @@ Over-predict reflections. This is needed to provide a buffer zone when using po .PD 0 .IP \fB--no-non-hits-in-stream\fR .PD -Completely exclude 'non-hit' frames in the stream. When this option is given, frames with fewer than the number of peaks given to \fB--min-peaks\fR will not have chunks written to the stream at all. +Completely exclude 'non-hit' frames in the stream. When this option is given, frames with fewer than the number of peaks given to \fB--min-peaks\fR will not have chunks written to the stream at all. Note that the default value for \fB--min-peaks\fR is zero, which means \fIall\fR frames will be written to the stream, even if they have no peaks at all. .PD 0 .IP \fB--copy-hdf5-field=\fR\fIpath\fR |