diff --git a/Config_Detector.md b/Config_Detector.md index 5eb0a3d..257a794 100644 --- a/Config_Detector.md +++ b/Config_Detector.md @@ -1,5 +1,5 @@ # Detector -Definitions of the set of detector hardware available. +Definitions of the set of detector hardware available. The file contains a JSON structure listing a set of fields that correspond to detector instances. The field name defines the detector name and the field value is another JSON structure declaring the configuration parameters. Note that _Pixelator_ expects detectors that measure multiple values for each scan point (e.g. area detector) to also return a single value summarizing the measurement at each scan point. **active**::
 Integer value that defines if the detector should be used (value of 1) or ignored (value of 0).
@@ -9,4 +9,54 @@ Definitions of the set of detector hardware available. **type**::
 String value that identifies which hardware interface will handle the detector behaviour. The set of allowed values is listed near the beginning of [`Detector.h`](https://gitlab.psi.ch/microspectro/pixelator/-/blob/master/PixelatorController/src/Detector.h#L23), for example: -`enum Type { Base, Counter, Analog, Interferometer, Orchestra, Epics, Tcp, Zmq };` \ No newline at end of file +`enum Type { Base, Counter, Analog, Interferometer, Orchestra, Epics, Tcp, Zmq };` + + **subType**::
+ String value that defines how the detector.
+ **Default**: empty string + + **nexus_name**::
+ String value defines the label string to be used in NeXus files, since these must conform to a specific naming scheme.
+ **Default**: detector name string +  + **unit**::
+ String value that defines the unit of the physical quantity being measured by the detector.
+ **Default**: empty string + + **hardwareUnitFactor**::
+ Double value that defines conversion factor between values used by the controller and by _Pixelator_.
+ **Default**: 1.0 + + **hardwareUnitOffset**::
+ Double value that defines offset between values used by the controller and by _Pixelator_.
+ **Default**: 0.0 + + **autoRecord**::
+ Boolean value that defines if the detector is to be silently (no selection option present to the user) recorded in the _/entry*/instrument/_ section of the nexus file.
+ **Default**: 0 + + **monitor**::
+ Boolean value that defines if the detector is to be treated as a [monitor](https://manual.nexusformat.org/datarules.html?highlight=monitor#monitors-are-special) and recorded in the NeXus file as an [NXmonitor](https://manual.nexusformat.org/classes/base_classes/NXmonitor.html).
+ **Default**: 0 + + **asynchronous**::
+ Boolean value that indicates that a detector communicates the measured values asynchronously.
+ **Default**: 0 + + **detailedDataDimensions**::
+ Array that defines the size of the size and shape (per scan point) of the extra _data_detail_ values to be recorded in _/entry*/instrument/detector/data_detail_, alongside the standard detector data. When this optional property is not defined, no _data_detail_ dataset is recorded. For example, a declaration of `"detailedDataDimensions" : [2],` would result in a _data_detail_ dataset array of size [N,2], where N is the number of scan points. + +Further configuration parameters are type-dependent. + + ****::
+ Integer value that defines if .
+ **Default**: ? + + ****::
+ Integer value that defines if .
+ **Default**: ? + + ****::
+ Integer value that defines if .
+ **Default**: ? +