diff --git a/documentation/pilatusDoc.html b/documentation/pilatusDoc.html index dcb5007..ccaa8b3 100755 --- a/documentation/pilatusDoc.html +++ b/documentation/pilatusDoc.html @@ -10,7 +10,7 @@

areaDetector Pilatus driver

- May 15, 2010

+ March 25, 2011

Mark Rivers

@@ -41,9 +41,9 @@ Dectris.

- The camserver program saves the data to disk as TIFF or CBF files. The areaDetector software - reads these disk files in order to read the data, because camserver does not provide - another mechanism to access the data. + The camserver program saves the data to disk as TIFF or CBF files. The areaDetector + software reads these disk files in order to read the data, because camserver does + not provide another mechanism to access the data.

This driver inherits from ADDriver. @@ -99,9 +99,9 @@ - ADExposureTime + ADAcquireTime - $(P)$(R)ExposureTime + $(P)$(R)AcquireTime In External Enable mode this value is not used by camserver. However, it should be set larger than the maximum time exposure time from the external source, so that @@ -119,9 +119,9 @@ - ADExposurePeriod + ADAcquirePeriod - $(P)$(R)ExposurePeriod + $(P)$(R)AcquirePeriod Controls the exposure period in seconds. It applies only in Internal or External Trigger modes when NumImages >1. @@ -164,10 +164,10 @@ $(P)$(R)FileTemplate camserver uses the file extension to determine what format to save the files in. - The areaDetector Pilatus driver only supports TIFF and CBF files, so the extension should - be .tif or .cbf. When saving multiple images (NImages>1) camserver has its own rules for - creating the names of the individual files. The rules are as follows. The name constructed - using the algorithm described for NDFileTemplate under + The areaDetector Pilatus driver only supports TIFF and CBF files, so the extension + should be .tif or .cbf. When saving multiple images (NImages>1) camserver has its + own rules for creating the names of the individual files. The rules are as follows. + The name constructed using the algorithm described for NDFileTemplate under File Saving Parameters is used as a basename. The following examples show the interpretation of the basename.

Basename            Files produced
@@ -308,11 +308,11 @@ test6_2_0035.tif    test6_2_0035.tif, test6_2_0036.tif, ...
         
           r/w
         
-          Timeout in seconds when reading a TIFF or CBF file. It should be set to several seconds,
-          because there can be delays for various reasons. One reason is that there is sometimes
-          a delay between when an External Enable acquisition is started and when the first
-          external pulse occurs. Another is that it can take some time for camserver processes
-          to finish writing the files.
+          Timeout in seconds when reading a TIFF or CBF file. It should be set to several
+          seconds, because there can be delays for various reasons. One reason is that there
+          is sometimes a delay between when an External Enable acquisition is started and
+          when the first external pulse occurs. Another is that it can take some time for
+          camserver processes to finish writing the files.
         
           IMAGE_FILE_TMOT
         
@@ -389,14 +389,14 @@ badX2,badY2 replacementX2,replacementY2
         
           Name of a file to be used to correct for the flat field. If this record does not
           point to a valid flat field file then no flat field correction is performed. The
-          flat field file is simply a TIFF or CBF file collected by the Pilatus that is used to correct
-          for spatial non-uniformity in the response of the detector. It should be collected
-          with a spatially uniform intensity on the detector at roughly the same energy as
-          the measurements being corrected. When the flat field file is read, the average
-          pixel value (averageFlatField) is computed using all pixels with intensities >PilatusMinFlatField.
-          All pixels with intensity <PilatusMinFlatField in the flat field are replaced
-          with averageFlatField. When images are collected before the NDArray callbacks are
-          performed the following per-pixel correction is applied:
+          flat field file is simply a TIFF or CBF file collected by the Pilatus that is used
+          to correct for spatial non-uniformity in the response of the detector. It should
+          be collected with a spatially uniform intensity on the detector at roughly the same
+          energy as the measurements being corrected. When the flat field file is read, the
+          average pixel value (averageFlatField) is computed using all pixels with intensities
+          >PilatusMinFlatField. All pixels with intensity <PilatusMinFlatField in the
+          flat field are replaced with averageFlatField. When images are collected before
+          the NDArray callbacks are performed the following per-pixel correction is applied:
           
ImageData[i] = 
     (averageFlatField * 
     ImageData[i])/flatField[i];
@@ -608,7 +608,9 @@ badX2,badY2 replacementX2,replacementY2
         
           r/w
         
-          MX start angle to write to CBF and TIFF image header.  When saving multiple images (ADNumImages>1) camserver will automatically increment the field in the image header by PilatusAngleIncr for each image.
+          MX start angle to write to CBF and TIFF image header. When saving multiple images
+          (ADNumImages>1) camserver will automatically increment the field in the image
+          header by PilatusAngleIncr for each image.
         
           START_ANGLE
         
@@ -625,7 +627,9 @@ badX2,badY2 replacementX2,replacementY2
         
           r/w
         
-          MX angle increment to write to CBF and TIFF image header.  When saving multiple images (ADNumImages>1) camserver will automatically increment the field corresponding to PilatusStartAngle in the image header by this value for each image.
+          MX angle increment to write to CBF and TIFF image header. When saving multiple images
+          (ADNumImages>1) camserver will automatically increment the field corresponding
+          to PilatusStartAngle in the image header by this value for each image.
         
           ANGLE_INCR
         
@@ -744,7 +748,8 @@ badX2,badY2 replacementX2,replacementY2
         
           r/w
         
-          MX oscillation axis text, up to 18 characters in length, to write to CBF and TIFF image header.
+          MX oscillation axis text, up to 18 characters in length, to write to CBF and TIFF
+          image header.
         
           OSCILL_AXIS
         
@@ -1099,19 +1104,19 @@ def user_getcounts '{
     Trigger pulses

The Pilatus supports 3 types of external triggering. In External Trigger mode (the - camserver ExtTrigger command) the Pilatus uses the programmed values of ExposureTime, - ExposurePeriod, NImages and NExposures. It waits for a single external trigger, - then waits for Delay seconds and then collects the entire sequence. It is very similar + camserver ExtTrigger command) the Pilatus uses the programmed values of AcquireTime, + AcquirePeriod, NImages and NExposures. It waits for a single external trigger, then + waits for Delay seconds and then collects the entire sequence. It is very similar to Internal mode with NImages>1, except that it waits for a trigger to begin collecting the sequence.

In External Enable mode (the camserver ExtEnable command) the Pilatus uses the external - signal to control acquisition. Only NImages and NExposures are used, ExposureTime - and ExposurePeriod are not used. When the signal is high the detector counts, and + signal to control acquisition. Only NImages and NExposures are used, AcquireTime + and AcquirePeriod are not used. When the signal is high the detector counts, and on the transition to low it begins its readout.

In External MultiTrigger Mode (the camserver ExtMTrigger command) the Pilatus uses - the programmed ExposureTime, in addition to NImages and NExposures. Each external + the programmed AcquireTime, in addition to NImages and NExposures. Each external trigger pulse causes the Pilatus to collect one image at the programmed exposure time. This mode works well with a trigger source like the Newport motor controllers or the SIS380x multichannel scaler, that put out a short trigger pulse for each @@ -1174,11 +1179,12 @@ def user_getcounts '{

The following are some current restrictions of the areaDetector Pilatus driver: