diff options
| author | Valerio Mariani <valerio.mariani@desy.de> | 2014-03-27 15:31:51 +0100 |
|---|---|---|
| committer | Thomas White <taw@physics.org> | 2014-09-05 18:03:03 +0200 |
| commit | 226bc13d46dfe690525653063ac166d72190b4ab (patch) | |
| tree | aa52c497e2bff69c83c868d446bbde166bd24c67 /doc | |
| parent | c4135f7e8655e28ae3132d50540267e8d2b0a5cf (diff) | |
Updated geometry man page
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/crystfel_geometry.5 | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/doc/man/crystfel_geometry.5 b/doc/man/crystfel_geometry.5 index 963cff19..eda1b153 100644 --- a/doc/man/crystfel_geometry.5 +++ b/doc/man/crystfel_geometry.5 @@ -75,12 +75,17 @@ Lines which should be ignored start with a semicolon. The properties which can be set are: .PD 0 +.IP \fBdata\fR +.PD +The location in the HDF5 file of the data block that contains the panel's data. If this property is not set, the first 2-dimensional data block in the file hierarchy will be used as data source. + +.PD 0 .IP \fBmin_fs\fR .IP \fBmin_ss\fR .IP \fBmax_fs\fR .IP \fBmax_ss\fR .PD -The range of pixels in the HDF5 file which correspond to the panel, in fast scan/slow scan coordinates, specified \fBinclusively\fR. +The range of pixels in the data block specified by the 'data' property that corresponds to the panel, in fast scan/slow scan coordinates, specified \fBinclusively\fR. .PD 0 .IP \fBadu_per_eV\fR @@ -125,19 +130,18 @@ The corner of this panel, defined as the first point in the panel to appear in t The maximum value, in ADU, before the pixel will be considered as bad. That is, the saturation value for the panel. .PD 0 -.IP \fBno_index\fR -Set this to 1 or "true" to ignore this panel completely. +.IP \fBmask\fR +If you have a bad pixel mask, you can include it in the HDF5 file as data blocks with the same structure and size as the panel data. You need to specify the location of each panel's mask data block using this property, and two bitmasks (see below). .PD 0 -.IP \fBrigid_group\fR -You can assign any value you like to this. If multiple panels have the same value for \fBrigid_group\fR, their positions relative to one another will be considered fixed by (for example) hdfsee's "calibration mode". +.IP \fBno_index\fR +Set this to 1 or "true" to ignore this panel completely. .PD 0 -.IP \fBmask\fR .IP \fBmask_good\fR .IP \fBmask_bad\fR .PD -If you have a bad pixel mask, you can include it in the HDF5 file as an unsigned 16-bit integer array of the same size as the data. You need to give its path within each HDF5 file, and two bitmasks. The pixel is considered good if all of the bits which are set in \fBmask_good\fR are set, \fIand\fR if none of the bits which are set in \fBmask_bad\fR are set. Example: +Bitmasks for bad pixel masks. The pixel is considered good if all of the bits which are set in \fBmask_good\fR are set, \fIand\fR if none of the bits which are set in \fBmask_bad\fR are set. Example: .br mask = /processing/hitfinder/masks .br |