Make the two geometry examples more similar

2 files changed, 38 insertions, 9 deletions

diff --git a/doc/examples/cspad-cxiformat.geom b/doc/examples/cspad-cxiformat.geom
index 7c1baf14..6ca27e69 100644
--- a/doc/examples/cspad-cxiformat.geom
+++ b/doc/examples/cspad-cxiformat.geom
@@ -1,10 +1,18 @@
 ; Example of a geometry file for CSPAD data output by Cheetah in CXI format
-
-photon_energy = /LCLS/photon_energy_eV
-clen = /LCLS/detector_1/EncoderValue
-coffset = 0.573224
-adu_per_eV = 0.00338
-res = 9097.53
+;
+
+; The following lines define some basic parameters of the detector and beamline
+
+adu_per_eV = 0.00338                   ; correct value for CSPAD 1.2 (i.e. new versions only)
+                                       ; for older versions (earlier than about 2013), use 0.00105 instead
+res = 9090.91                          ; detector resolution in pixels per metre
+clen = /LCLS/detector_1/EncoderValue   ; location of camera length (in mm) in file
+coffset = 0.573224                     ; adjustment to camera length, in m, from HDF5 file
+                                       ; (position given above is actually "encoder position",
+				       ;  a value from -500 (fully forward) to 0 (fully back
+				       ;  from sample.  Therefore we add 0.5 m plus a calibration
+				       ;  offset)
+photon_energy = /LCLS/photon_energy_eV ; photon energy (in eV) from HDF5 file
 
 
 ; The following lines define how to interpret the three-dimensional data array
diff --git a/doc/examples/cspad-single.geom b/doc/examples/cspad-single.geom
index b850ca20..5ed5fb52 100644
--- a/doc/examples/cspad-single.geom
+++ b/doc/examples/cspad-single.geom
@@ -1,15 +1,36 @@
 ; Example of a CrystFEL geometry file for CSPAD data in single-event HDF5
 ; format, with the panel data arranged as by Cheetah
 
+; The following lines define some basic parameters of the detector and beamline
+
 adu_per_eV = 0.00105                   ; correct value for CSPAD 1.0 (i.e. old versions only)
                                        ; for newer versions (since about 2013), use 0.00338 instead
-res = 9090.91                          ; pixels per metre
-clen = /LCLS/detectorPosition          ; camera length from HDF5 file
-coffset = 0.0                          ; no adjustment to camera length from HDF5 file
+res = 9090.91                          ; detector resolution in pixels per metre
+clen = /LCLS/detectorPosition          ; location of camera length (in mm) in file
+coffset = 0.573224                     ; adjustment to camera length, in m, from HDF5 file
+                                       ; (position given above is actually "encoder position",
+				       ;  a value from -500 (fully forward) to 0 (fully back
+				       ;  from sample.  Therefore we add 0.5 m plus a calibration
+				       ;  offset)
 photon_energy = /LCLS/photon_energy_eV ; photon energy (in eV) from HDF5 file
+
+
+; The following line defines where to get the image data from
+
 data = /data/rawdata                   ; where to find the image data in the HDF5 file
 
 
+
+
+
+; These following lines define where to find a "bad pixel mask" for each event,
+; and how to interpret its contents.
+
+mask = /processing/hitfinder/pixelmasks
+mask_good = 0x0000
+mask_bad = 0xffff
+
+
 ; The following lines define "rigid groups" which express the physical
 ; construction of the detector.  This is used when refining the detector
 ; geometry.