diff options
| author | Thomas White <taw@physics.org> | 2016-03-18 16:24:36 +0100 |
|---|---|---|
| committer | Thomas White <taw@physics.org> | 2016-03-18 16:24:36 +0100 |
| commit | e52d4a865e26fbb089371e2a2e3fe3ef69de26ce (patch) | |
| tree | ff4dbc7717afaf4dc26ccc34e5e864bbcd8b9f0b /doc | |
| parent | e207734a6b50831c8d6a5ebe4b36c64720871fab (diff) | |
Update docs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/crystfel_geometry.5 | 8 | ||||
| -rw-r--r-- | doc/man/indexamajig.1 | 2 |
2 files changed, 9 insertions, 1 deletions
diff --git a/doc/man/crystfel_geometry.5 b/doc/man/crystfel_geometry.5 index 074fbc8f..021d4493 100644 --- a/doc/man/crystfel_geometry.5 +++ b/doc/man/crystfel_geometry.5 @@ -182,6 +182,14 @@ If you have a bad pixel mask, you can include it in the HDF5 file as data blocks Use this option to specify that the bad pixel mask should be read from a different file to the image data. The \fBmask\fR field, if it contains placeholders, will be expanded in exactly the same way as normal, it's just that the data will be read from the file you specify instead of the image data file. The \fBmask_file\fR may be specified as an absolute filename, or relative to the working directory. .PD 0 +.IP \fBsaturation_map\fR +This specifies the location of the per-pixel saturation map in the HDF5 file. This works just like \fBmask\fR in that it can come from the current file or a separate one (see \fBsaturation_map_file\fR). Reflections will be rejected if they contain any pixel above the per-pixel values, \fBin addition\fR to the other checks (see \fBmax_adu\fR). + +.PD +.IP \fBsaturation_map_file\fR +Specifies that the saturation map should come from the HDF5 file named here, instead of the HDF5 file being processed. It can be an absolute filename or relative to the working directory. + +.PD 0 .IP \fBmask_good\fR .IP \fBmask_bad\fR .PD diff --git a/doc/man/indexamajig.1 b/doc/man/indexamajig.1 index 9b5873bb..2690e039 100644 --- a/doc/man/indexamajig.1 +++ b/doc/man/indexamajig.1 @@ -93,7 +93,7 @@ Check linear combinations of the unit cell basis vectors to see if a cell can be .IP \fB-retry\fR .PD -If indexing fails, delete some of the weakest peaks and try again. This increases the indexing yield, but decreases the speed. The opposite is \fB-noretry\fR, which prevents indexing from being retried. \fB-retry\R is the default for all indexing methods. +If indexing fails, delete some of the weakest peaks and try again. This increases the indexing yield, but decreases the speed. The opposite is \fB-noretry\fR, which prevents indexing from being retried. \fB-retry\fR is the default for all indexing methods. .IP \fB-multi\fR .PD |