Private
Public Access
11
1

Update Config_Detector

2022-10-18 17:36:42 +02:00
parent d9a638be23
commit 653c051dcb

@@ -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**::<BR>
&emsp;Integer value that defines if the detector should be used (value of 1) or ignored (value of 0). <BR>
@@ -9,4 +9,54 @@ Definitions of the set of detector hardware available.
**type**::<BR>
&emsp;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 };`
`enum Type { Base, Counter, Analog, Interferometer, Orchestra, Epics, Tcp, Zmq };`
**subType**::<BR>
&emsp;String value that defines how the detector. <BR>
&emsp;**Default**: empty string
**nexus_name**::<BR>
&emsp;String value defines the label string to be used in NeXus files, since these must conform to a specific naming scheme. <BR>
&emsp;**Default**: detector name string
**unit**::<BR>
&emsp;String value that defines the unit of the physical quantity being measured by the detector. <BR>
&emsp;**Default**: empty string
**hardwareUnitFactor**::<BR>
&emsp;Double value that defines conversion factor between values used by the controller and by _Pixelator_. <BR>
&emsp;**Default**: 1.0
**hardwareUnitOffset**::<BR>
&emsp;Double value that defines offset between values used by the controller and by _Pixelator_. <BR>
&emsp;**Default**: 0.0
**autoRecord**::<BR>
&emsp;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. <BR>
&emsp;**Default**: 0
**monitor**::<BR>
&emsp;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). <BR>
&emsp;**Default**: 0
**asynchronous**::<BR>
&emsp;Boolean value that indicates that a detector communicates the measured values asynchronously. <BR>
&emsp;**Default**: 0
**detailedDataDimensions**::<BR>
&emsp;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.
****::<BR>
&emsp;Integer value that defines if . <BR>
&emsp;**Default**: ?
****::<BR>
&emsp;Integer value that defines if . <BR>
&emsp;**Default**: ?
****::<BR>
&emsp;Integer value that defines if . <BR>
&emsp;**Default**: ?