diff --git a/broker/gen/model/Grid_scan.h b/broker/gen/model/Grid_scan.h
index 79a3e98bb..b21d28bd3 100644
--- a/broker/gen/model/Grid_scan.h
+++ b/broker/gen/model/Grid_scan.h
@@ -12,7 +12,7 @@
 /*
  * Grid_scan.h
  *
- * Definition of a grid scan. May be combined with a goniometer axis: a grid is often collected at a particular head position, and a stationary axis records where that was. 
+ * Definition of a grid scan. Combine it with a goniometer axis to state the angle the spindle stood at: send `goniometer` with `step` 0 and the `start` angle of the grid scan, and that angle is written per image into the NXmx sample transformation chain. Without one the spindle is recorded at 0, which says that nobody stated an angle rather than that the spindle stood at 0. 
  */
 
 #ifndef Grid_scan_H_
@@ -25,7 +25,7 @@ namespace org::openapitools::server::model
 {
 
 /// <summary>
-/// Definition of a grid scan. May be combined with a goniometer axis: a grid is often collected at a particular head position, and a stationary axis records where that was. 
+/// Definition of a grid scan. Combine it with a goniometer axis to state the angle the spindle stood at: send &#x60;goniometer&#x60; with &#x60;step&#x60; 0 and the &#x60;start&#x60; angle of the grid scan, and that angle is written per image into the NXmx sample transformation chain. Without one the spindle is recorded at 0, which says that nobody stated an angle rather than that the spindle stood at 0. 
 /// </summary>
 class  Grid_scan
 {
diff --git a/broker/gen/model/Rotation_axis.h b/broker/gen/model/Rotation_axis.h
index 9352cacc8..237066870 100644
--- a/broker/gen/model/Rotation_axis.h
+++ b/broker/gen/model/Rotation_axis.h
@@ -67,7 +67,7 @@ public:
     bool nameIsSet() const;
     void unsetName();
     /// <summary>
-    /// Angle step (per image) in degrees
+    /// Angle step (per image) in degrees. 0 for an axis that does not turn: the axis then records the angle the spindle stood at, which is how a grid scan or a set of stills states its head position. 
     /// </summary>
     float getStep() const;
     void setStep(float const value);
diff --git a/broker/jfjoch_api.yaml b/broker/jfjoch_api.yaml
index 6da578e5a..7b3fe7587 100644
--- a/broker/jfjoch_api.yaml
+++ b/broker/jfjoch_api.yaml
@@ -241,8 +241,11 @@ components:
   schemas:
     grid_scan:
       description: |
-        Definition of a grid scan. May be combined with a goniometer axis: a grid is often collected
-        at a particular head position, and a stationary axis records where that was.
+        Definition of a grid scan. Combine it with a goniometer axis to state the angle the spindle
+        stood at: send `goniometer` with `step` 0 and the `start` angle of the grid scan, and that
+        angle is written per image into the NXmx sample transformation chain. Without one the
+        spindle is recorded at 0, which says that nobody stated an angle rather than that the
+        spindle stood at 0.
       type: object
       required:
         - n_fast
@@ -298,7 +301,10 @@ components:
           type: number
           format: float
           example: 0.1
-          description: Angle step (per image) in degrees
+          description: |
+            Angle step (per image) in degrees. 0 for an axis that does not turn: the axis then
+            records the angle the spindle stood at, which is how a grid scan or a set of stills
+            states its head position.
         start:
           type: number
           format: float
diff --git a/broker/redoc-static.html b/broker/redoc-static.html
index 0ca215c18..5c88781ce 100644
--- a/broker/redoc-static.html
+++ b/broker/redoc-static.html
@@ -472,8 +472,11 @@ the full width of a slit-defined one. [um]</p>
 </div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="beam_size_y_um"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">beam_size_y_um</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-Nxspf sc-cfxfcM cXxAXt jrGEaR"></span><span class="sc-Nxspf sc-gFAWRd cXxAXt dYzdDr">number</span><span class="sc-Nxspf sc-gFAWRd cXxAXt dYzdDr"> <!-- -->&lt;<!-- -->float<!-- -->&gt;<!-- --> </span><span> <span class="sc-Nxspf sc-fxwrCY cXxAXt eMVOei"> <!-- -->&gt;= 0<!-- --> </span></span></div> <div><div class="sc-eeDRCY sc-eBMEME gTGgei fbXBig"><p>Second element of /entry/instrument/beam/incident_beam_size in NXmx
 Vertical size of the X-ray beam where it meets the sample. [um]</p>
 </div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv sc-hCPjZK hZbWKe jXkfaY GCgeS" kind="field" title="goniometer"><span class="sc-gFqAkR eRqgPI"></span><button aria-label="expand goniometer"><span class="property-name">goniometer</span><svg class="sc-cwHptR ivsSRP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-Nxspf sc-cfxfcM cXxAXt jrGEaR"></span><span class="sc-Nxspf sc-gFAWRd cXxAXt dYzdDr">object</span><span class="sc-Nxspf sc-gmPhUn cXxAXt hjnRRA"> (<!-- -->rotation_axis<!-- -->) </span></div> <div><div class="sc-eeDRCY sc-eBMEME gTGgei fbXBig"><p>Definition of a crystal rotation axis</p>
-</div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv sc-hCPjZK hZbWKe jXkfaY GCgeS" kind="field" title="grid_scan"><span class="sc-gFqAkR eRqgPI"></span><button aria-label="expand grid_scan"><span class="property-name">grid_scan</span><svg class="sc-cwHptR ivsSRP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-Nxspf sc-cfxfcM cXxAXt jrGEaR"></span><span class="sc-Nxspf sc-gFAWRd cXxAXt dYzdDr">object</span><span class="sc-Nxspf sc-gmPhUn cXxAXt hjnRRA"> (<!-- -->grid_scan<!-- -->) </span></div> <div><div class="sc-eeDRCY sc-eBMEME gTGgei fbXBig"><p>Definition of a grid scan. May be combined with a goniometer axis: a grid is often collected
-at a particular head position, and a stationary axis records where that was.</p>
+</div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv sc-hCPjZK hZbWKe jXkfaY GCgeS" kind="field" title="grid_scan"><span class="sc-gFqAkR eRqgPI"></span><button aria-label="expand grid_scan"><span class="property-name">grid_scan</span><svg class="sc-cwHptR ivsSRP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-Nxspf sc-cfxfcM cXxAXt jrGEaR"></span><span class="sc-Nxspf sc-gFAWRd cXxAXt dYzdDr">object</span><span class="sc-Nxspf sc-gmPhUn cXxAXt hjnRRA"> (<!-- -->grid_scan<!-- -->) </span></div> <div><div class="sc-eeDRCY sc-eBMEME gTGgei fbXBig"><p>Definition of a grid scan. Combine it with a goniometer axis to state the angle the spindle
+stood at: send <code>goniometer</code> with <code>step</code> 0 and the <code>start</code> angle of the grid scan, and that
+angle is written per image into the NXmx sample transformation chain. Without one the
+spindle is recorded at 0, which says that nobody stated an angle rather than that the
+spindle stood at 0.</p>
 </div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="header_appendix"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">header_appendix</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-Nxspf sc-cfxfcM cXxAXt jrGEaR"></span><span class="sc-Nxspf sc-gFAWRd cXxAXt dYzdDr">any</span></div> <div><div class="sc-eeDRCY sc-eBMEME gTGgei fbXBig"><p>Header appendix, added as user_data/user to start ZeroMQ message (can be any valid JSON)
 In general, it is not saved in HDF5 file.</p>
 <p>However, if values are placed in &quot;hdf5&quot; object, <code>jfjoch_writer</code> will write them in /entry/user of the HDF5 file. 
@@ -993,7 +996,7 @@ then image might be replaced in the buffer between calling /images and /image.cb
 </div></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-ejfMa-d bNUPQg"><button class="sc-EgOXT cFEcOl"><span type="get" class="sc-eZYNyq qGfV http-verb get">get</span><span class="sc-iEXKAA gUNSDu">/version</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dlWCHZ kWacYr"><div class="sc-hHOBiw cndTNO"><div class="sc-eeDRCY sc-eBMEME gTGgei fbXBig"><p>Test Jungfraujoch system</p>
 </div><div tabindex="0" role="button"><div class="sc-kWtpeL gEncxT"><span>http://localhost:5232</span>/version</div></div></div></div></div></div></div></div></div><div class="sc-dExYaf gZbfaQ"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.3","info":{"title":"Jungfraujoch","description":"API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland).\nJungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU.\nJungfraujoch uses FPGA boards to acquire data at high data rates.\n\n# License Clarification\n\nWhile this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply**\nwhen this file is used solely to generate OpenAPI clients or when implementing applications that\ninteract with the API. Generated client code and applications using this API definition are not\nsubject to the GPL license requirements and may be distributed under terms of your choosing.\n\nThis exception is similar in spirit to the Linux Kernel's approach to userspace API headers and\nthe GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that\nuser programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not\nderivative works of the kernel and are not subject to the terms of the GPL.\n\nThis exception is intended to allow wider use of this API specification without imposing GPL\nrequirements on applications that merely interact with the API, regardless of whether they\ncommunicate through network calls or other mechanisms.\n","version":"1.0.0-rc.166","contact":{"name":"Filip Leonarski (Paul Scherrer Institute)","email":"filip.leonarski@psi.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.html"}},"servers":[{"url":"http://localhost:5232","description":"Test Jungfraujoch system"}],"components":{"parameters":{"binning":{"in":"query","name":"binning","required":false,"schema":{"default":1,"type":"integer"},"description":"Binning of frames for the plot (0 = default binning)"},"experimental_coord":{"in":"query","name":"experimental_coord","required":false,"schema":{"type":"boolean","default":false},"description":"If measurement has goniometer axis defined, plot X-axis will represent rotation angle\nIf measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value\nFor still measurement the number is ignored\n"},"azint_unit":{"in":"query","name":"azint_unit","required":false,"schema":{"type":"string","enum":["Q_recipA","d_A","two_theta_deg"],"default":"Q_recipA"},"description":"Unit used for azim int.\n"},"fill_value":{"in":"query","name":"fill","required":false,"schema":{"type":"number","format":"float"},"description":"Fill value for elements that were missed during data collection\n"},"plot_type":{"in":"query","name":"type","required":true,"description":"Type of requested plot","schema":{"type":"string","enum":["bkg_estimate","azint","azint_1d","spot_count","spot_count_low_res","spot_count_indexed","spot_count_ice","indexing_rate","indexing_lattice_count","indexing_unit_cell_length","indexing_unit_cell_angle","profile_radius","mosaicity","b_factor","error_pixels","saturated_pixels","image_collection_efficiency","receiver_delay","receiver_free_send_buf","strong_pixels","roi_sum","roi_mean","roi_max_count","roi_pixels","roi_weighted_x","roi_weighted_y","packets_received","max_pixel_value","resolution_estimate","pixel_sum","processing_time","beam_center_x","beam_center_y","integrated_reflections","image_scale_factor","image_scale_cc","compression_ratio","ice_ring_score"]}},"roi":{"in":"query","name":"roi","required":false,"schema":{"type":"string","minLength":1},"description":"Name of ROI for which plot is requested"},"image_id":{"in":"query","name":"id","required":false,"schema":{"type":"integer","format":"int64","default":-1,"minimum":-2},"description":"Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer"},"saturation":{"in":"query","name":"saturation","required":false,"schema":{"type":"number","format":"float","minimum":-32767,"maximum":32767},"description":"Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used"},"background":{"in":"query","name":"background","required":false,"schema":{"type":"number","format":"float","default":0,"minimum":-32767,"maximum":32767},"description":"Background value to set contrast in the preview image"},"show_spots":{"in":"query","name":"show_spots","schema":{"type":"boolean","default":true},"description":"Show spot finding results on the image"},"show_predictions":{"in":"query","name":"show_predictions","schema":{"type":"boolean","default":false},"description":"Show Bragg spot predictions on the image (if available for the image)"},"show_beam_center":{"in":"query","name":"show_beam_center","schema":{"type":"boolean","default":true},"description":"Show beam center on the image"},"show_roi":{"in":"query","name":"show_roi","schema":{"type":"boolean","default":false},"description":"Show ROI areas on the image"},"jpeg_quality":{"in":"query","name":"jpeg_quality","description":"Quality of JPEG image (100 - highest; 0 - lowest)","schema":{"type":"integer","format":"int64","default":100,"minimum":0,"maximum":100}},"show_user_mask":{"in":"query","name":"show_user_mask","schema":{"type":"boolean","default":false},"description":"Show user mask"},"resolution_ring":{"in":"query","name":"show_res_ring","description":"Show resolution ring, provided in Angstrom","schema":{"type":"number","format":"float","default":0.1,"minimum":0.1,"maximum":100}},"resolution_estimate":{"in":"query","name":"show_res_est","description":"Show resolution estimation as a ring","schema":{"type":"boolean","default":false}},"color_scale":{"in":"query","name":"color","description":"Color scale for preview image","schema":{"type":"string","enum":["indigo","viridis","bw","wb","green","heat","magma","inferno"],"default":"indigo"}}},"schemas":{"grid_scan":{"description":"Definition of a grid scan. May be combined with a goniometer axis: a grid is often collected\nat a particular head position, and a stationary axis records where that was.\n","type":"object","required":["n_fast","step_x_um","step_y_um"],"properties":{"n_fast":{"type":"integer","format":"int64","minimum":1,"example":20,"description":"Number of elements in the fast direction"},"step_x_um":{"type":"number","format":"float","example":5,"description":"Step in grid along the fast direction. Can be negative. \nPositive number: left to right\nNegative number: right to left\n"},"step_y_um":{"type":"number","format":"float","example":-3,"description":"Step in grid along the slow direction. Can be negative. \nPositive number: top to bottom\nNegative number: bottom to top\n"},"vertical":{"type":"boolean","default":false,"description":"If disabled: fast direction = X, slow direction = Y\nIf enabled: fast direction = Y, slow direction = X\n"},"snake":{"type":"boolean","default":false,"description":"Flip fast direction for every second row\n"}}},"rotation_axis":{"description":"Definition of a crystal rotation axis","type":"object","required":["step","vector"],"properties":{"name":{"type":"string","default":"omega","minLength":1,"description":"Name of rotation axis (e.g., omega, phi)"},"step":{"type":"number","format":"float","example":0.1,"description":"Angle step (per image) in degrees"},"start":{"type":"number","format":"float","example":50,"description":"Start angle in degrees","default":0},"vector":{"type":"array","description":"Rotation axis","example":[1,0,0],"items":{"type":"number","format":"float"},"minItems":3,"maxItems":3},"helical_step_um":{"type":"array","description":"Translation (per image) for helical scan","example":[-5,-2,0],"items":{"type":"number","format":"float"},"minItems":3,"maxItems":3},"screening_wedge_deg":{"type":"number","format":"float","description":"Wedge angle value; used if rotation per image is smaller than increment between images (so particularly in screening)"}}},"indexing_algorithm":{"type":"string","description":"Selection of an indexing algorithm used by Jungfraujoch\n","enum":["FFBIDX","FFT","FFTW","Auto","None"],"default":"FFBIDX"},"geom_refinement_algorithm":{"type":"string","description":"Selection of an post-indexing least-square diffraction geometry refinement algorithm used by Jungfraujoch.\nBeamCenter - This option is refining both beam center and lattice (restricted to a chosen/detected Bravais lattice).\nOrientationOnly - This option is refining only orientation of the lattice.\nFlex - Tries all per-image refinements and keeps whichever indexes the most spots, letting the pipeline decide (the rugnux flex mode).\n","enum":["BeamCenter","OrientationOnly","Flex","None"]},"integration_model":{"type":"string","description":"Bragg spot integration model.\nProfileGaussian - profile fit with a measured-width Gaussian (Kabsch-style), the default; more\n  accurate intensities than box summation.\nProfileEmpirical - profile fit with a per-resolution-shell empirical profile learned from strong spots.\nBoxSum - classical uniform box summation minus a ring-mean background; the simpler, faster fallback.\n","enum":["ProfileGaussian","ProfileEmpirical","BoxSum"],"default":"ProfileGaussian"},"dataset_settings":{"type":"object","required":["beam_x_pxl","beam_y_pxl","detector_distance_mm","incident_energy_keV"],"properties":{"images_per_trigger":{"type":"integer","format":"int64","minimum":1,"default":1,"description":"For standard synchrotron data collection - this is number of images collected per one TTL trigger\nFor XFEL (pulsed source) - this number is ignored and set to 1\nFor storage cell mode - this number is ignored and set to number of storage cells\n"},"ntrigger":{"type":"integer","format":"int64","default":1,"minimum":1,"description":"Number of TTL trigger that the detector is expected to receive during data collection\n"},"image_time_us":{"type":"integer","format":"int64","minimum":0,"description":"Image time. \nIf not provided (or zero value) the frame time is assumed as default.\nFor JUNGFRAU image time must be multiple of frame time and max value is 256 * frame_time.            \nIn XFEL mode: summation happens for frames collected with multiple triggers.\nIgnored for storage cells and if raw data are saved.\n"},"beam_x_pxl":{"type":"number","format":"float","description":"/entry/detector/beam_center_x in NXmx\nBeam center in X direction [pixels]\n"},"beam_y_pxl":{"type":"number","format":"float","description":"/entry/detector/beam_center_y in NXmx\nBeam center in X direction [pixels]\n"},"detector_distance_mm":{"type":"number","format":"float","minimum":0,"description":"/entry/detector/distance in NXmx Detector distance [mm]"},"incident_energy_keV":{"type":"number","format":"float","minimum":0.001,"maximum":500,"description":"Used to calculate /entry/beam/incident_wavelength in NXmx\nIncident particle (photon, electron) energy in keV\n"},"file_prefix":{"type":"string","default":"","description":"Prefix for filenames. If left empty, no file will be saved."},"images_per_file":{"type":"integer","format":"int64","minimum":1,"description":"Number of images in a single HDF5 data file, taken literally when given.\nIf omitted, it is chosen from the acquisition: a rotation sweep of at most 20000 images\ngoes into a single data file, so the dataset stays readable by programs that follow only\nthe first data file of a legacy master; a grid scan is split on a whole number of fast-axis\nrows; anything else (stills, serial) uses 1000.\n"},"space_group_number":{"type":"integer","format":"int64","minimum":1,"maximum":230,"description":"Number of space group for the crystal. Currently used solely as metadata, not relevant for image processing done in Jungfraujoch."},"sample_name":{"type":"string","default":"","description":"/entry/sample/name in NXmx\nSample name\n"},"compression":{"type":"string","enum":["bslz4","bszstd","bszstd_rle","bszstd_rlehuf","none"],"default":"bslz4","description":"Compression type for the images transferred over ZeroMQ and saved to HDF5 file.\n"},"total_flux":{"type":"number","format":"float","description":"/entry/beam/total_flux in NXmx\nFlux incident on beam plane in photons per second. In other words this is the flux integrated over area. [photons/s]\n"},"transmission":{"type":"number","format":"float","minimum":0,"maximum":1,"description":"/entry/instrument/attenuator/attenuator_transmission\nTransmission of attenuator (filter) [no units]\n"},"beam_size_x_um":{"type":"number","format":"float","minimum":0,"description":"First element of /entry/instrument/beam/incident_beam_size in NXmx\nHorizontal size of the X-ray beam where it meets the sample - the FWHM of a focused beam,\nthe full width of a slit-defined one. [um]\n"},"beam_size_y_um":{"type":"number","format":"float","minimum":0,"description":"Second element of /entry/instrument/beam/incident_beam_size in NXmx\nVertical size of the X-ray beam where it meets the sample. [um]\n"},"goniometer":{"$ref":"#/components/schemas/rotation_axis"},"grid_scan":{"$ref":"#/components/schemas/grid_scan"},"header_appendix":{"description":"Header appendix, added as user_data/user to start ZeroMQ message (can be any valid JSON)\nIn general, it is not saved in HDF5 file.\n\nHowever, if values are placed in \"hdf5\" object, `jfjoch_writer` will write them in /entry/user of the HDF5 file. \nThis applies solely to string and number (double floating-point). No arrays/sub-objects is allowed.\nFor example {\"hdf5\": {\"val1\":1, \"val2\":\"xyz\"}}, will write /entry/user/val1 and /entry/user/val2.\n"},"image_appendix":{"description":"Image appendix, added as user_data to image ZeroMQ message (can be any valid JSON)\nNot saved in HDF5 file\n"},"data_reduction_factor_serialmx":{"type":"number","format":"float","default":1,"minimum":0,"maximum":1,"description":"Rate at which non-indexed images are accepted to be forwarded to writer. \nValue of 1.0 (default) means that all images are written.\nValues below zero mean that non-indexed images will be accepted with a given probability.\n"},"pixel_value_low_threshold":{"type":"integer","format":"int64","minimum":0,"description":"Set all counts lower than the value to zero. \nWhen the value is set, negative numbers other than error pixel value are always set to zero.\nSetting to zero is equivalent to turning the option off.\n"},"run_number":{"type":"integer","format":"int64","minimum":0,"description":"Number of run within an experimental session. \nTransferred over CBOR stream as \"series ID\", though not saved in HDF5 file.\nIt is highly recommended to keep this number unique for each data collection during experimental series.\nIf not provided, the number will be automatically incremented.\n"},"run_name":{"type":"string","description":"Unique ID of run.\nTransferred over CBOR stream as \"unique series ID\", though not saved in HDF5 file.\nIt is highly recommended to keep this name unique for each data collection during experimental series.\nIf not provided, the name will be automatically generated as number + colon + file_prefix.\n"},"experiment_group":{"type":"string","description":"Name of group owning the data (e.g. p-group or proposal number). \nTransferred over CBOR stream, though not saved in HDF5 file.\n"},"poisson_compression":{"type":"integer","format":"int64","minimum":0,"maximum":16,"description":"Enable lossy compression of pixel values that preserves Poisson statistics. \nRequires to provide a numerical factor SQ.\nPixel value P will be transformed to round(sqrt(P) * SQ), with rounding to the closest integer.\nCompression is turned off if the value is missing or it is set to zero.\n"},"write_nxmx_hdf5_master":{"type":"boolean","default":true,"description":"Write NXmx formatted HDF5 master file. Recommended to use for macromolecular crystallography experiments\nand to turn off for other experiments.\n"},"save_calibration":{"type":"boolean","description":"Forward image calibration (at the moment pedestal and pedestal RMS for JUNGFRAU) using the ZeroMQ stream to writer.\nIf parameter is not provided calibration will be saved only if more than 4 images are recorded.\n"},"polarization_factor":{"type":"number","description":"Polarization factor for integration; 1.0 is horizontal polarization; -1.0 is vertical polarization","format":"float","minimum":-1,"maximum":1},"ring_current_mA":{"type":"number","format":"float","description":"Ring current at the beginning of the data collection","minimum":0},"sample_temperature_K":{"type":"number","format":"float","description":"Sample temperature in Kelvin","minimum":0},"poni_rot1_rad":{"type":"number","description":"PONI angle rot1 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"poni_rot2_rad":{"type":"number","description":"PONI angle rot2 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"poni_rot3_rad":{"type":"number","description":"PONI angle rot3 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"unit_cell":{"$ref":"#/components/schemas/unit_cell"},"spot_finding":{"type":"boolean","description":"Enable spot finding and save spots","default":true},"smargon":{"type":"object","description":"Geometry of Smargon goniometer at SLS 2.0 / MX beamlines. \nAssuming that Smargon is used as static positioner and not moving during the scan, allowing to reconstruct geometry.\n","required":["phi_deg","chi_deg"],"properties":{"phi_deg":{"type":"number","format":"float","description":"Phi angle in degrees"},"chi_deg":{"type":"number","format":"float","description":"Chi angle in degrees"},"phi_axis":{"type":"array","description":"Phi rotation axis","default":[1,0,0],"example":[1,0,0],"items":{"type":"number","format":"float"},"minItems":3,"maxItems":3},"chi_axis":{"type":"array","description":"Chi rotation axis","default":[0,0,1],"example":[0,0,1],"items":{"type":"number","format":"float"},"minItems":3,"maxItems":3}}},"max_spot_count":{"type":"integer","minimum":10,"maximum":2000,"default":250,"description":"Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected"},"detect_ice_rings":{"type":"boolean","description":"Flag spots as ice rings and reduce their effect on indexing"},"async_start":{"type":"boolean","default":false,"description":"When set to true, `/start` will not wait for detector and Jungfraujoch to be ready for the measurement."},"xray_fluorescence_spectrum":{"type":"object","required":["energy_eV","data"],"properties":{"energy_eV":{"type":"array","items":{"type":"number","format":"float"},"description":"X-ray fluorescence scan energy for each measurement point"},"data":{"type":"array","items":{"type":"number","format":"float"},"description":"X-ray fluorescence scan result in arbitrary units; must be exactly the same length, as energy_eV"}}}}},"crystal_lattice":{"type":"array","items":{"type":"number","format":"float"},"minItems":9,"maxItems":9,"description":"Real-space crystal lattice 3D vectors in Angstrom.\nOrder is 1st vector (x,y,z), 2nd vector (x,y,z) and 3rd vector (x,y,z)\n"},"unit_cell":{"type":"object","description":"Unit cell parameters. Necessary to run indexing. Units of angstrom and degree","required":["a","b","c","alpha","beta","gamma"],"properties":{"a":{"type":"number","format":"float","example":37,"minimum":0},"b":{"type":"number","format":"float","example":37,"minimum":0},"c":{"type":"number","format":"float","example":78,"minimum":0},"alpha":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360},"beta":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360},"gamma":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360}}},"file_writer_format":{"type":"string","enum":["NXmxOnlyData","NXmxLegacy","NXmxVDS","NXmxIntegrated","CBF","TIFF","NoFileWritten"],"default":"NXmxVDS","description":"NoFileWritten - no files are written at all\nNXmxOnlyData - only data files are written, no master file\nNXmxLegacy - legacy format with soft links to data files in the master file; necessary for DECTRIS Albula 4.0 and DECTRIS Neggia\nNXmxVDS - newer format with virtual dataset linking data files in the master file, also includes better metadata handling\nNXmxIntegrated - single HDF5 per dataset\nCBF - DEPRECATED, no longer supported; kept for back compatibility only. Requests using this value are rejected. Only HDF5 formats are written.\nTIFF - DEPRECATED, no longer supported; kept for back compatibility only. Requests using this value are rejected. Only HDF5 formats are written.\n"},"file_writer_settings":{"type":"object","properties":{"overwrite":{"type":"boolean","default":false,"description":"Inform jfjoch_write to overwrite existing files. Otherwise files would be saved with .h5.{timestamp}.tmp suffix.\n"},"format":{"$ref":"#/components/schemas/file_writer_format"}}},"pixel_mask_statistics":{"type":"object","properties":{"user_mask":{"description":"Number of pixels masked using the user mask","type":"integer","format":"int64","minimum":0},"too_high_pedestal_rms":{"description":"Number of pixels with G0 pedestal RMS higher than provided threshold","type":"integer","format":"int64","minimum":0},"wrong_gain":{"description":"Number of pixels that show wrong gain level during the pedestal procedure","type":"integer","format":"int64","minimum":0}}},"image_buffer_status":{"type":"object","required":["image_numbers","total_slots","in_preparation_slots","in_sending_slots","available_slots","max_image_number","min_image_number"],"properties":{"min_image_number":{"type":"integer","format":"int64","minimum":0,"description":"Smallest image number available in the buffer"},"max_image_number":{"type":"integer","format":"int64","minimum":0,"description":"Largest image number available in the buffer"},"image_numbers":{"type":"array","description":"Image numbers currently present in the buffer.","items":{"type":"integer","format":"int64"}},"total_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer. This number, compared to number of images in data collection and\nframe rate will determine \"retention\" rate of the image buffer.\n"},"available_slots":{"type":"integer","format":"int64","description":"Slots available for the data collection"},"in_preparation_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer that are currently in preparation for sending.\n"},"in_sending_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer that are currently sending/writing data.\n"},"current_counter":{"type":"integer","format":"int64","description":"Counter of changes in the image buffer - either new start message or new image added.\nFor optimization one can only load new images/datasets from the HTTP if this value changes.\nCounter is optional as it was not implemented in older versions to avoid breaking change\n"}}},"image_format_settings":{"type":"object","required":["summation","jungfrau_conversion","geometry_transform","mask_chip_edges","mask_module_edges","apply_mask"],"properties":{"summation":{"type":"boolean","description":"Enable summation of images to a given image_time\nIf disabled images are saved according to original detector speed, but image count is adjusted\n"},"geometry_transform":{"type":"boolean","description":"Place module read-out into their location on composed detector and extend multipixels\n"},"jungfrau_conversion":{"type":"boolean","description":"Convert pixel value in ADU to photon counts/energy\nOnly affects JUNGFRAU detector\n"},"jungfrau_conversion_factor_keV":{"type":"number","format":"float","minimum":0.001,"maximum":500,"description":"Used to convert energy deposited into pixel to counts\nIf not provided incident_energy_keV is used\n"},"bit_depth_image":{"type":"integer","format":"int64","enum":[8,16,32],"description":"Bit depth of resulting image (it doesn't affect the detector read-out value)\nIf not provided value is adjusted automatically\n"},"signed_output":{"type":"boolean","description":"Controls if pixels have signed output\nIf not provided value is adjusted automatically\n"},"mask_module_edges":{"type":"boolean","default":true,"description":"Mask 1 pixel on the module boundary\n"},"mask_chip_edges":{"type":"boolean","default":true,"description":"Mask multipixels on chip boundary\n"},"jungfrau_mask_pixels_without_g0":{"type":"boolean","default":true,"description":"JUNGFRAU: mask pixels that don't operate in G0, but do operate in G1 and G1.\nThis should be turned off for cases, where detector is operated at room temperature with long exposure time.\n"},"apply_mask":{"type":"boolean","default":false,"description":"Masked pixels are set to special value in the images produced by Jungfraujoch\n"},"jungfrau_pedestal_g0_rms_limit":{"type":"integer","format":"int64","default":100,"minimum":0,"description":"Pixels with pedestal G0 RMS above the threshold are marked as masked pixels"}}},"detector_power_state":{"type":"string","description":"Power on of ASICs","enum":["PowerOn","PowerOff","Partial"]},"detector_state":{"type":"string","description":"Current state of the detector","enum":["Idle","Waiting","Busy","Error","Not connected"]},"detector_status":{"type":"object","required":["state","powerchip","server_version","number_of_triggers_left","fpga_temp_degC","high_voltage_V"],"properties":{"state":{"$ref":"#/components/schemas/detector_state"},"powerchip":{"$ref":"#/components/schemas/detector_power_state"},"server_version":{"type":"string","description":"Detector server (on read-out boards) version"},"number_of_triggers_left":{"type":"integer","format":"int64","description":"Remaining triggers to the detector (max of all modules)"},"fpga_temp_degC":{"type":"array","description":"Temperature of detector FPGAs","items":{"type":"integer","format":"int64"}},"high_voltage_V":{"type":"array","description":"High voltage for detector modules","items":{"type":"integer","format":"int64"}}}},"detector_timing":{"type":"string","enum":["auto","trigger","burst","gated"],"default":"trigger"},"detector_settings":{"type":"object","required":["frame_time_us"],"properties":{"frame_time_us":{"type":"integer","description":"Interval between consecutive frames.\nThis is internal frame time for the JUNGFRAU detector, image time has to be integer multiply of this number.\nFor EIGER detector this is default frame time, not used otherwise\n","format":"int64","minimum":1},"count_time_us":{"type":"integer","description":"Integration time of the detector. \nIf not provided count time will be set to maximum value for a given frame time.\n","format":"int64"},"internal_frame_generator":{"type":"boolean","default":false,"description":"Use internal frame generator in FPGA instead of getting data from a real detector"},"internal_frame_generator_images":{"type":"integer","format":"int64","default":1,"minimum":1,"maximum":64,"description":"Number of images stored in the internal frame generator."},"detector_trigger_delay_ns":{"type":"integer","format":"int64","minimum":0,"default":0,"description":"Delay between TTL trigger and acquisition start [ns]"},"timing":{"$ref":"#/components/schemas/detector_timing"},"eiger_threshold_keV":{"type":"number","format":"float","minimum":1,"maximum":100,"description":"Threshold for the PSI EIGER detector and all DECTRIS detectors.\nIf value is provided, it will be used for all subsequent acquisitions, irrespective of beam energy.\nIf value is not provided, threshold will be determined on start of acquisition as half of incident energy. \nThis might lead to increased start time.\n"},"eiger_bit_depth":{"type":"integer","format":"int64","enum":[8,16,32],"description":"Bit depth of PSI EIGER read-out. This is  \nIf value is not provided, depth will be determined based on the image time:\n* Exposure time < 500 microseconds depth of 8 bit will be used,\n* 500 <= exposure time < 2622 microseconds depth of 16 bit will be used\n* Exposure time >= 2622 microseconds depth of 32 bit will be used.\n"},"jungfrau_pedestal_g0_frames":{"type":"integer","format":"int64","default":2000,"minimum":0},"jungfrau_pedestal_g1_frames":{"type":"integer","format":"int64","default":300,"minimum":0},"jungfrau_pedestal_g2_frames":{"type":"integer","format":"int64","default":300,"minimum":0},"jungfrau_pedestal_min_image_count":{"type":"integer","format":"int64","default":128,"minimum":32,"description":"Minimum number of collected images for pedestal to consider it viable"},"jungfrau_storage_cell_count":{"type":"integer","format":"int64","default":1,"minimum":1,"maximum":16},"jungfrau_storage_cell_delay_ns":{"type":"integer","format":"int64","minimum":2100,"default":5000,"description":"Delay between two storage cells [ns]"},"jungfrau_fixed_gain_g1":{"type":"boolean","default":false,"description":"Fix gain to G1 (can be useful for storage cells)"},"jungfrau_use_gain_hg0":{"type":"boolean","default":false,"description":"Use high G0 (for low energy applications)"}}},"spot_finding_settings":{"type":"object","required":["enable","indexing","signal_to_noise_threshold","photon_count_threshold","max_pix_per_spot","min_pix_per_spot","quick_integration","high_resolution_limit_for_spot_count_low_res","ice_ring_width_q_recipA"],"properties":{"enable":{"type":"boolean","default":true,"description":"Enable spot finding. This is temporary setting, i.e. can be changed anytime during data collection. \nEven if disabled spot finding information will still be send and written, though always with zero spots.\n"},"indexing":{"type":"boolean","default":true,"description":"Enable indexing. This is temporary setting, i.e. can be changed anytime during data collection.\n"},"signal_to_noise_threshold":{"type":"number","format":"float","minimum":0},"photon_count_threshold":{"type":"integer","format":"int64","minimum":0},"min_pix_per_spot":{"type":"integer","format":"int64","minimum":1},"max_pix_per_spot":{"type":"integer","format":"int64","minimum":1},"high_resolution_limit":{"type":"number","format":"float","description":"High resolution limit for spot finding [Angstrom]. Optional: if omitted, spot finding extends\nas far as the detector reaches, i.e. the detection is not clipped in resolution.\n"},"low_resolution_limit":{"type":"number","format":"float","description":"Low resolution limit for spot finding [Angstrom]. Optional: if omitted, spot finding is not\nclipped at the low-resolution end. A value of 0 is accepted and means the same thing.\n"},"high_resolution_limit_for_spot_count_low_res":{"type":"number","format":"float","description":"High resolution threshold to consider spot \"low resolution\" [Angstrom]","minimum":2,"maximum":8},"quick_integration":{"type":"boolean","default":false,"description":"Quick integration of Bragg spots in diffraction images.\nIf enabled it will likely reduce performance of Jungfraujoch for datasets with a very high indexing rate.\n(experimental feature)\n"},"ice_ring_width_q_recipA":{"type":"number","format":"float","minimum":0,"maximum":1,"default":0.03,"description":"Half-width of the ice ring band in q (1/A). Matches the offline default in image_analysis/spot_finding/SpotFindingSettings.h, which was set from a measured ring FWHM of ~0.06; the two must agree or the same data gets a narrower ice band online."},"high_res_gap_Q_recipA":{"type":"number","format":"float","minimum":0.1,"maximum":5,"default":1.5,"description":"This parameter is used to remove spurious spots at a very high resolution, that sometimes appear due to very low background close to the edge of the detector.\nIf there is a gap in (1/d)-space between spots of at least this size, spots on the side of the gap with high resolution will be discarded. This is optional parameter.\nThis option should be turned OFF for small molecule datasets or for crystals with very low mosaicity, when it is expected to see only few spots in any case.\n"},"adaptive_threshold":{"type":"boolean","default":false,"description":"Self-calibrating spot detection: replace the fixed photon_count_threshold by a per-resolution-ring\nthreshold derived from each image's own noise, so the same setting works across datasets without\nper-dataset tuning. photon_count_threshold is then ignored and false_pixels_per_frame sets the\noperating point instead.\nOnly available on detectors whose images are analysed in software (the DECTRIS/SIMPLON workflow).\nThe JUNGFRAU and EIGER workflows find spots on the FPGA, which applies its own fixed threshold,\nso enabling this there is rejected rather than silently ignored.\n"},"false_pixels_per_frame":{"type":"number","format":"float","minimum":1,"maximum":100000,"default":100,"description":"Operating point of the adaptive threshold: the number of noise pixels tolerated per frame.\nAbout 100 suits a multi-megapixel detector. Ignored unless adaptive_threshold is set.\n"}}},"azim_int_settings":{"type":"object","required":["solid_angle_corr","polarization_corr","low_q_recipA","q_spacing"],"properties":{"polarization_corr":{"type":"boolean","description":"Apply polarization correction for azimuthal integration (polarization factor must be configured in dataset settings)","default":true},"solid_angle_corr":{"type":"boolean","description":"Apply solid angle correction for azimuthal integration","default":true},"high_q_recipA":{"type":"number","minimum":0.00002,"maximum":10,"format":"float","description":"Upper q limit of the azimuthal integration [1/Angstrom]. Optional: if omitted, the integration\n(and the adaptive spot detection that shares these q bins) extends to the highest q the\ndetector reaches.\n"},"low_q_recipA":{"type":"number","format":"float","minimum":0.00001,"maximum":10},"q_spacing":{"type":"number","format":"float","minimum":0.00001},"azimuthal_bins":{"type":"integer","format":"int64","minimum":1,"maximum":512,"default":1,"description":"Numer of azimuthal (phi) bins; 1 = standard 1D azimuthal integration"},"force_cpu":{"type":"boolean","default":false,"description":"Force CPU processing of azimuthal integration in the FPGA data acquisition workflow.\nThis allows to extend number of azimuthal integration bins, as well as to calculate standard deviation\nof the azimuthal integration results.\n"}}},"detector_list_element":{"type":"object","required":["id","nmodules","description","width","height","serial_number","base_ipv4_addr","udp_interface_count","readout_time_ns","min_frame_time_ns","min_count_time_ns"],"properties":{"id":{"type":"integer","format":"int64","minimum":0},"description":{"type":"string","example":"JUNGFRAU 4 Mpixel"},"serial_number":{"type":"string","example":"JF17T16V01"},"base_ipv4_addr":{"type":"string","example":"10.10.10.1"},"udp_interface_count":{"type":"integer","format":"int64","example":2,"description":"Number of UDP interfaces per detector module"},"nmodules":{"type":"integer","format":"int64","example":18},"width":{"type":"integer","format":"int64","example":2068},"height":{"type":"integer","format":"int64","example":2164},"pixel_size_mm":{"type":"number","format":"float","example":0.075},"readout_time_ns":{"type":"integer","format":"int64"},"min_frame_time_ns":{"type":"integer","format":"int64"},"min_count_time_ns":{"type":"integer","format":"int64"},"type":{"$ref":"#/components/schemas/detector_type"}}},"detector_list":{"type":"object","required":["detectors","current_id"],"properties":{"detectors":{"type":"array","items":{"$ref":"#/components/schemas/detector_list_element"}},"current_id":{"type":"integer","format":"int64","example":0}}},"detector_selection":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","example":1}}},"measurement_statistics":{"type":"object","properties":{"file_prefix":{"type":"string"},"run_number":{"type":"integer","format":"int64","description":"Number of data collection run. This can be either automatically incremented or provided externally for each data collection.\n"},"experiment_group":{"type":"string","description":"Name of group owning the data (e.g. p-group or proposal number).\n"},"images_expected":{"type":"integer","format":"int64"},"images_collected":{"type":"integer","format":"int64","description":"Images collected by the receiver. This number will be lower than images expected if there were issues with data collection performance.\n"},"images_sent":{"type":"integer","format":"int64","description":"Images sent to the writer. \nThe value does not include images discarded by lossy compression filter and images not forwarded due to full ZeroMQ queue.\n"},"images_written":{"type":"integer","format":"int64","description":"Images successfully written to disk.\nThe value is live updated for TCP/IP socket and direct HDF5 writer, while for ZeroMQ it is only updated at the end of experiment.\n"},"images_discarded_lossy_compression":{"type":"integer","format":"int64","description":"Images discarded by the lossy compression filter"},"max_image_number_sent":{"type":"integer","format":"int64"},"collection_efficiency":{"type":"number","format":"float","example":1,"minimum":0,"maximum":1},"compression_ratio":{"type":"number","format":"float","example":5.3,"minimum":0},"cancelled":{"type":"boolean"},"max_receiver_delay":{"type":"integer","format":"int64"},"indexing_rate":{"type":"number","format":"float"},"detector_width":{"type":"integer","format":"int64"},"detector_height":{"type":"integer","format":"int64"},"detector_pixel_depth":{"type":"integer","format":"int64","enum":[2,4]},"bkg_estimate":{"type":"number","format":"float"},"unit_cell":{"type":"string"},"error_pixels":{"type":"number","format":"float","description":"Moving average of 1000 images counting number of error pixels on the detector"},"saturated_pixels":{"type":"number","format":"float","description":"Moving average of 1000 images counting number of saturated pixels on the detector"},"roi_beam_pixels":{"type":"number","format":"float","description":"If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images\nfor number of valid pixels within this ROI\n"},"roi_beam_sum":{"type":"number","format":"float","description":"If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images\nfor sum of valid pixels within this ROI\n"}}},"fpga_status":{"type":"array","items":{"type":"object","required":["pci_dev_id","serial_number","base_mac_addr","eth_link_status","eth_link_count","eth_link_speed","power_usage_W","fpga_temp_C","hbm_temp_C","packets_sls","packets_udp","idle","fw_version","pcie_link_speed","pcie_link_width"],"properties":{"pci_dev_id":{"type":"string"},"serial_number":{"type":"string"},"fw_version":{"type":"string"},"base_mac_addr":{"type":"string"},"eth_link_count":{"type":"integer","format":"int64"},"eth_link_status":{"type":"integer","format":"int64"},"power_usage_W":{"type":"number","format":"float"},"fpga_temp_C":{"type":"number","format":"float"},"hbm_temp_C":{"type":"number","format":"float"},"packets_udp":{"type":"integer","format":"int64"},"packets_sls":{"type":"integer","format":"int64"},"idle":{"type":"boolean"},"pcie_link_speed":{"type":"integer","format":"int64","description":"PCIe link speed measured by generation (expected value is 4 == PCIe Gen4)"},"pcie_link_width":{"type":"integer","format":"int64","description":"PCIe link width (expected value is 8 == x8)"}}}},"broker_status":{"type":"object","required":["state"],"properties":{"state":{"type":"string","enum":["Inactive","Idle","Busy","Measuring","Pedestal","Error"]},"progress":{"type":"number","format":"float","description":"Progress of data collection (only available if receiving is running)","example":1,"minimum":0,"maximum":1},"message":{"type":"string","description":"Message to display besides state of the jfjoch_broker; mostly used for errors and warnings\nThis matters especially for async functions (start/initialize), where API won't return reason\nfor the error during async operation.\n"},"message_severity":{"type":"string","enum":["success","info","warning","error"],"default":"error","description":"Level of the message to display"},"gpu_count":{"type":"integer","format":"int32","description":"Number of installed GPUs"},"broker_version":{"type":"string","description":"Version of the jfjoch_broker","example":"1.0.0-rc.128"}}},"image_pusher_status":{"type":"object","required":["pusher_type","addr","connected_writers"],"description":"Informs about status of the image pusher.\n","properties":{"pusher_type":{"$ref":"#/components/schemas/image_pusher_type"},"addr":{"type":"array","items":{"type":"string"},"example":["tcp://1.2.3.4:5000","tcp://1.2.3.4:5001"],"description":"List of addresses of image pushers.\nFor HDF5 socket - no addresses will be returned.\nFor ZeroMQ - list of addresses for each socket will be provided.\nFor TCP/IP - single address to connect all writers will be provided.\n"},"connected_writers":{"type":"integer","format":"int64","minimum":0,"description":"Number of connected writers \nFor ZeroMQ image socket: number is constant\nFor TCP/IP image socket: number is updated live during operation\n"},"images_written":{"type":"integer","format":"int64","minimum":0,"description":"Number of images written to the image socket.\nThis number is updated live during operation for TCP/IP image socket and direct HDF5 writer.\nIt is updated at the end of experiment for ZeroMQ image socket.\n"},"images_write_error":{"type":"integer","format":"int64","minimum":0,"description":"Number of images that could not be written to the image socket.\nThis number is updated live during operation for TCP/IP image socket.\nNo other socket use it.\n"},"writer_fifo_utilization":{"type":"array","items":{"type":"integer","format":"int64","minimum":0},"description":"Utilization of internal writer FIFO.\nThis number is updated live during operation for TCP/IP image socket.\nNo other socket use it.\n"}}},"plot":{"type":"object","required":["x","y","title"],"description":"x and y coordinates for plotting, it is OK to assume that both arrays have the same size; layout is optimized for Plotly","properties":{"title":{"type":"string","default":""},"x":{"type":"array","items":{"type":"number","format":"float"}},"y":{"type":"array","items":{"type":"number","format":"float","nullable":true}},"z":{"type":"array","items":{"type":"number","format":"float","nullable":true}}}},"plot_unit_x":{"type":"string","enum":["image_number","q_recipA","d_A","angle_deg","ADU","grid_um"],"default":"image_number"},"plots":{"type":"object","required":["plot","unit_x"],"properties":{"title":{"type":"string"},"unit_x":{"$ref":"#/components/schemas/plot_unit_x"},"size_x":{"type":"number","format":"float","description":"Max X range of the plot"},"size_y":{"type":"number","format":"float","description":"Max Y range of the plot"},"plot":{"type":"array","items":{"$ref":"#/components/schemas/plot"}}}},"scan_result":{"type":"object","description":"Results of a scan","required":["images"],"properties":{"file_prefix":{"type":"string"},"rotation_unit_cell":{"$ref":"#/components/schemas/unit_cell"},"rotation_crystal_lattice":{"$ref":"#/components/schemas/crystal_lattice"},"rotation_bravais":{"type":"string","description":"Bravais lattice type of the global rotation-indexing solution: crystal-system\nletter + centering, e.g. \"tP\", \"oC\", \"cF\", \"hR\", \"mP\". Empty if not determined.\n"},"images":{"type":"array","items":{"type":"object","required":["efficiency","number"],"properties":{"efficiency":{"type":"number","format":"float"},"number":{"type":"integer","format":"int64","description":"Detector image number for a given cell"},"nx":{"type":"integer","format":"int64","description":"Cell position in X for grid scan"},"ny":{"type":"integer","format":"int64","description":"Cell position in Y for grid scan"},"angle":{"type":"number","format":"float","description":"Rotation angle associated with the image"},"bkg":{"type":"number","format":"float","description":"Background estimate"},"spots":{"type":"integer","format":"int64","description":"Spot count"},"spots_low_res":{"type":"integer","format":"int64","description":"Spot count in low resolution range"},"spots_indexed":{"type":"integer","format":"int64","description":"Spot count within indexing tolerance"},"spots_ice":{"type":"integer","format":"int64","description":"Spot count within common ice ring resolutions"},"ice":{"type":"number","format":"float","description":"Strongest hexagonal-ice ring intensity over the smooth radial background (1 = no ice)"},"index":{"type":"integer","format":"int64","description":"Indexing solution"},"latt_count":{"type":"integer","format":"int64","description":"Indexing lattice count"},"pr":{"type":"number","format":"float","description":"Profile radius, i.e. how far reflections are from the Ewald sphere"},"b":{"type":"number","format":"float","description":"B-Factor estimate"},"uc":{"$ref":"#/components/schemas/unit_cell"},"xfel_pulseid":{"type":"integer","format":"int64","description":"XFEL pulse ID"},"pixel_sum":{"type":"integer","format":"int64","description":"Total sum of all pixels"},"max":{"type":"integer","format":"int64","description":"Max viable pixel"},"sat":{"type":"integer","format":"int64","description":"Number of saturated pixels"},"err":{"type":"integer","format":"int64","description":"Number of error pixels"},"res":{"type":"number","format":"float","description":"Diffraction resolution estimate"}}}}}},"powder_calibration_fit_sigma":{"type":"object","description":"What the powder ring fit knows about its own answer, from the covariance of the converged\nproblem. Each sigma is in its parameter's own unit and is scaled by the residual scatter of\nthat fit, so it is the usual \"how far could this move before the fit got visibly worse\".\nThe two correlations are the ones that matter: a tilt and a beam-centre shift both displace a\nring's radius as cos(phi) and are told apart only by how that amplitude grows with the ring's\nradius, so as the rings run out the pair stops being separable and these approach 1.\nThe rotation sigmas and the correlations are absent when the tilt was not a free parameter.\n","properties":{"beam_x_pxl":{"type":"number","format":"float","description":"Standard error of the fitted PONI x [pixels]"},"beam_y_pxl":{"type":"number","format":"float","description":"Standard error of the fitted PONI y [pixels]"},"detector_distance_mm":{"type":"number","format":"float","description":"Standard error of the fitted detector distance [mm]"},"poni_rot1_rad":{"type":"number","format":"float","description":"Standard error of the fitted rot1 [rad]"},"poni_rot2_rad":{"type":"number","format":"float","description":"Standard error of the fitted rot2 [rad]"},"correlation_beam_x_rot1":{"type":"number","format":"float","description":"Correlation between the fitted PONI x and rot1, -1 to 1"},"correlation_beam_y_rot2":{"type":"number","format":"float","description":"Correlation between the fitted PONI y and rot2, -1 to 1"}}},"powder_calibration_spot_check":{"type":"object","description":"Where the circle through the found spots puts the beam, and how far that is from the geometry\nactually fitted. An independent cross-check: it reads nothing from the file's own geometry, so\nit holds where the summed azimuthal profile does not - a profile binned about a badly wrong\ncentre shows each ring smeared across its sectors, and a fit on it converges on the wrong\nanswer without saying so. Two methods sharing no assumption, so the disagreement is the\nstatement. Absent when no spots were available.\n","properties":{"beam_x_pxl":{"type":"number","format":"float","description":"Beam centre x the spots vote for [pixels]"},"beam_y_pxl":{"type":"number","format":"float","description":"Beam centre y the spots vote for [pixels]"},"detector_distance_mm":{"type":"number","format":"float","description":"Detector distance the spots imply [mm]"},"disagreement_pxl":{"type":"number","format":"float","description":"Distance between the spots' beam centre and the fitted one [pixels]"}}},"powder_calibration_quality":{"type":"object","description":"What a powder calibration knows about the geometry it produced. A calibration that has gone\nwrong - the wrong standard named, a header too far out for the rings to be found - looks\nexactly like one that has not until these are read.\n","properties":{"converged":{"type":"boolean","description":"Whether the geometry beside this is a measurement of the data at all. False means at least\none of its parameters was carried over from the input file rather than fitted - which looks\nexactly like a good fit in every other field here - and see not_converged_reason for which.\nrugnux --mode calibration writes no .poni file in that case, a PONI file having no field in\nwhich to say it, and exits non-zero.\n"},"not_converged_reason":{"type":"string","description":"What made converged false, in words. Absent when the calibration converged."},"calibrant":{"type":"string","description":"The powder standard the rings were fitted to, or the unit cell given in its place"},"method":{"type":"string","description":"How the rings were measured. rings fits the arcs of the run-summed (q x azimuth) azimuthal\nprofile; spots fits the pooled per-image spot lists.\n","enum":["rings","spots"]},"ring_points":{"type":"integer","format":"int64","description":"Ring measurements the fit used"},"rms_radial_pxl":{"type":"number","format":"float","description":"Scatter of those measurements about the fitted rings, as a radial distance [pixels]. The\nsingle number that separates a calibration that worked from one that did not.\n"},"beam_sigma_pxl":{"type":"number","format":"float","description":"Standard error the scatter implies on the beam centre [pixels], for a ring of that many\npoints. See powder_calibration_fit_sigma for what the fit itself says, which is not the same and\nis the larger of the two whenever the tilt is poorly separated.\n"},"direct_beam_x_pxl":{"type":"number","format":"float","description":"Where the direct beam lands [pixels]. NOT dataset_settings.beam_x_pxl, which is the PONI:\nthe two part company by distance*tan(tilt)/pixel as soon as the detector is tilted.\n"},"direct_beam_y_pxl":{"type":"number","format":"float","description":"Where the direct beam lands, y [pixels]"},"header_distance_mm":{"type":"number","format":"float","description":"The detector distance the input file declared, for comparison [mm]"},"ring_seed_distance_mm":{"type":"number","format":"float","description":"The distance measured from the ring radii before the fit ran [mm]. It is taken from the\nradii, the wavelength and the pixel size alone, so a large gap from header_distance_mm is\nthe answer to the question the calibration was run to ask. Absent when the profile showed\ntoo few rings to fix a scale.\n"},"tilt_refined":{"type":"boolean","description":"Whether the reported rot1/rot2 were measured by this fit. False means they were declined\nand pinned at the input file's values, because the rings could not separate a tilt from a\nshift of the beam centre.\n"},"tilt_significance":{"type":"number","format":"float","description":"How many of its own sigmas the fitted tilt stands from zero. Below about 3 it is not a\nmeasurement of a tilt but of a beam-centre shift, and the tilt is declined. Passing does\nnot certify a tilt: that estimator is limited by systematics rather than by this sigma.\n"},"fit_sigma":{"$ref":"#/components/schemas/powder_calibration_fit_sigma"},"spot_cross_check":{"$ref":"#/components/schemas/powder_calibration_spot_check"}}},"powder_calibration_output":{"type":"object","required":["dataset_settings"],"description":"The result of a powder-ring detector calibration - what rugnux --mode calibration writes as\n<prefix>.json, and what a calibration run over the image buffer would return.\n\ndataset_settings holds the geometry and nothing else, under the property names this API gives\nthem, so it can be POSTed or merged without translating a field. Its beam_x_pxl/beam_y_pxl is\nthe PONI, the foot of the perpendicular from the sample; where the beam actually lands is\ncalibration.direct_beam_x_pxl. The poni_rot*_rad are present whenever any of them is non-zero\nand absent when all are zero, since a body omitting them states a FLAT detector rather than an\nunstated one.\n","properties":{"dataset_settings":{"$ref":"#/components/schemas/dataset_settings"},"calibration":{"$ref":"#/components/schemas/powder_calibration_quality"},"jfjoch_version":{"type":"string","description":"Version of the program that produced this"}}},"calibration_statistics":{"type":"array","items":{"required":["module_number","storage_cell_number","pedestal_g0_mean","pedestal_g1_mean","pedestal_g2_mean","gain_g0_mean","gain_g1_mean","gain_g2_mean","masked_pixels"],"type":"object","properties":{"module_number":{"type":"integer","format":"int64"},"storage_cell_number":{"type":"integer","format":"int64"},"pedestal_g0_mean":{"type":"number","format":"float"},"pedestal_g1_mean":{"type":"number","format":"float"},"pedestal_g2_mean":{"type":"number","format":"float"},"gain_g0_mean":{"type":"number","format":"float"},"gain_g1_mean":{"type":"number","format":"float"},"gain_g2_mean":{"type":"number","format":"float"},"masked_pixels":{"type":"integer","format":"int64"}}}},"jfjoch_statistics":{"type":"object","description":"Pool statistics for Jungfraujoch to reduce transfers between frontend and jfjoch_broker","properties":{"detector":{"$ref":"#/components/schemas/detector_status"},"detector_list":{"$ref":"#/components/schemas/detector_list"},"detector_settings":{"$ref":"#/components/schemas/detector_settings"},"image_format_settings":{"$ref":"#/components/schemas/image_format_settings"},"instrument_metadata":{"$ref":"#/components/schemas/instrument_metadata"},"file_writer_settings":{"$ref":"#/components/schemas/file_writer_settings"},"data_processing_settings":{"$ref":"#/components/schemas/spot_finding_settings"},"measurement":{"$ref":"#/components/schemas/measurement_statistics"},"broker":{"$ref":"#/components/schemas/broker_status"},"fpga":{"$ref":"#/components/schemas/fpga_status"},"calibration":{"$ref":"#/components/schemas/calibration_statistics"},"zeromq_preview":{"$ref":"#/components/schemas/zeromq_preview_settings"},"zeromq_metadata":{"$ref":"#/components/schemas/zeromq_metadata_settings"},"dark_mask":{"$ref":"#/components/schemas/dark_mask_settings"},"pixel_mask":{"$ref":"#/components/schemas/pixel_mask_statistics"},"roi":{"$ref":"#/components/schemas/roi_definitions"},"az_int":{"$ref":"#/components/schemas/azim_int_settings"},"buffer":{"$ref":"#/components/schemas/image_buffer_status"},"indexing":{"$ref":"#/components/schemas/indexing_settings"},"bragg_integration":{"$ref":"#/components/schemas/bragg_integration_settings"},"image_pusher":{"$ref":"#/components/schemas/image_pusher_status"}}},"error_message":{"type":"object","required":["msg","reason"],"properties":{"msg":{"type":"string","description":"Human readable message","example":"Detector in wrong state"},"reason":{"type":"string","description":"Enumerate field for automated analysis","enum":["WrongDAQState","Other"]}}},"roi_azimuthal":{"type":"object","description":"ROI as Q-range (or resolution range), optionally restricted to an azimuthal-angle sector","required":["name","q_min_recipA","q_max_recipA"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"q_min_recipA":{"type":"number","format":"float","minimum":0.00001,"description":"Minimum Q-range for the ROI"},"q_max_recipA":{"type":"number","format":"float","minimum":0.00001,"description":"Maximum Q-range for the ROI"},"phi_min_deg":{"type":"number","format":"float","description":"Lower azimuthal-angle bound of the sector [degrees]. Optional: provide both phi_min_deg and phi_max_deg to restrict the ROI to an angular sector, or omit both for a full ring. A sector with phi_min_deg > phi_max_deg wraps across 0.\n"},"phi_max_deg":{"type":"number","format":"float","description":"Upper azimuthal-angle bound of the sector [degrees]. Optional; see phi_min_deg.\n"}}},"roi_circle":{"type":"object","description":"Circular ROI","required":["name","center_x_pxl","center_y_pxl","radius_pxl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"center_x_pxl":{"type":"number","format":"float","description":"X coordinate of center of the circle [pixels]"},"center_y_pxl":{"type":"number","format":"float","description":"Y coordinate of center of the circle [pixels]"},"radius_pxl":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"Radius of the circle [pixels]"}}},"roi_box":{"type":"object","description":"Box ROI","required":["name","min_x_pxl","max_x_pxl","min_y_pxl","max_y_pxl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"min_x_pxl":{"type":"integer","format":"int64","description":"Lower bound (inclusive) in X coordinate for the box","minimum":0},"max_x_pxl":{"type":"integer","format":"int64","description":"Upper bound (inclusive) in X coordinate for the box","minimum":0},"min_y_pxl":{"type":"integer","format":"int64","description":"Lower bound (inclusive) in Y coordinate for the box","minimum":0},"max_y_pxl":{"type":"integer","format":"int64","description":"Upper bound (inclusive) in Y coordinate for the box","minimum":0}}},"roi_circle_list":{"type":"object","description":"List of circular ROIs","required":["rois"],"properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_circle"}}}},"roi_box_list":{"type":"object","description":"List of box ROIs","properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_box"}}}},"roi_azim_list":{"type":"object","description":"List of azimuthal ROIs","properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_azimuthal"}}}},"roi_definitions":{"type":"object","required":["box","circle","azim"],"description":"ROI defintions","properties":{"box":{"$ref":"#/components/schemas/roi_box_list"},"circle":{"$ref":"#/components/schemas/roi_circle_list"},"azim":{"$ref":"#/components/schemas/roi_azim_list"}}},"dark_mask_settings":{"type":"object","description":"Settings for collection of dark images to be used for mask calculation","required":["detector_threshold_keV","frame_threshold_keV","max_allowed_pixel_count","max_frames_with_signal","frame_time_us","number_of_frames"],"properties":{"detector_threshold_keV":{"type":"number","format":"float","description":"Energy threshold for dark image collection","minimum":2.5,"default":3.5,"maximum":100},"frame_time_us":{"type":"integer","format":"int64","description":"Time between frames for dark image collection","minimum":500,"default":10000,"maximum":100000},"number_of_frames":{"type":"integer","format":"int64","description":"Number of frames for dark image collection; zero means no dark collection","minimum":0,"default":1000},"max_allowed_pixel_count":{"type":"integer","format":"int64","description":"Maximum count in a pixel considered normal (not-masked)","minimum":0,"default":1},"max_frames_with_signal":{"type":"integer","format":"int64","description":"Maximum number of frames with signal in a pixel considered normal (not-masked)","minimum":0,"default":10}}},"indexing_settings":{"type":"object","description":"Settings for crystallography indexing","required":["algorithm","geom_refinement_algorithm","fft_high_resolution_A","fft_max_unit_cell_A","fft_min_unit_cell_A","fft_num_vectors","tolerance","thread_count","unit_cell_dist_tolerance","index_ice_rings","viable_cell_min_spots","rotation_indexing","rotation_indexing_min_angular_range_deg","rotation_indexing_angular_stride_deg","blocking"],"properties":{"algorithm":{"$ref":"#/components/schemas/indexing_algorithm"},"fft_max_unit_cell_A":{"type":"number","format":"float","default":250,"maximum":500,"minimum":50,"description":"Largest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT"},"fft_min_unit_cell_A":{"type":"number","format":"float","default":10,"minimum":5,"maximum":40,"description":"Smallest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT"},"fft_high_resolution_A":{"type":"number","format":"float","default":2,"minimum":0.5,"maximum":6,"description":"Sets how finely the FFT samples each search direction: it fixes the extent of the projection\nhistogram, and with it the transform size, so it affects execution time and memory of FFT.\nIt does NOT filter spots - every spot is projected whatever its resolution, so raising it\ndoes not make the transform see a coarser subset of the data.\nThere is also correlation between smallest unit cell and this value, which need to be checked for very small systems.\n"},"fft_num_vectors":{"type":"integer","format":"int64","minimum":128,"default":16384,"description":"Number of search directions for the FFT algorithm; parameter value affects execution time of FFT."},"tolerance":{"type":"number","format":"float","minimum":0,"maximum":0.5,"description":"Acceptance tolerance for spots after the indexing run - the larger the number, the more spots will be accepted"},"thread_count":{"type":"integer","format":"int64","minimum":1,"maximum":64,"description":"Thread count for indexing algorithm"},"geom_refinement_algorithm":{"$ref":"#/components/schemas/geom_refinement_algorithm"},"unit_cell_dist_tolerance":{"type":"number","format":"float","minimum":0.0001,"maximum":0.2001,"default":0.05,"description":"Relative distance tolerance for unit cell vs. reference; Lattices outside given tolerance will be ignored"},"viable_cell_min_spots":{"type":"integer","format":"int64","minimum":5,"default":10,"description":"Minimum number of indexed spots required for a cell to be considered viable"},"index_ice_rings":{"type":"boolean","default":false,"description":"Include spots marked as ice rings in the indexing run. \nIf `dataset_settings` doesn't have `detect_ice_rings` on, this option will have no effect on processing.\n"},"rotation_indexing":{"type":"boolean","default":false},"rotation_indexing_min_angular_range_deg":{"type":"number","format":"float","default":20,"minimum":1},"rotation_indexing_angular_stride_deg":{"type":"number","format":"float","default":0.5,"minimum":0},"blocking":{"type":"boolean","default":true,"description":"Indexing in Jungfraujoch goes with a dedicated thread pool.\nIf set to false, the thread pool is non-blocking, i.e. if there are no threads available, image indexing will be skipped. This option is recommended for real-time processing at high frame rates.\nIf set to true, the thread pool will block until a thread is available.\n"}}},"instrument_metadata":{"type":"object","description":"Metadata for a measurement instrument","required":["source_name","instrument_name"],"properties":{"source_name":{"type":"string","example":"Swiss Light Source"},"source_type":{"type":"string","description":"Type of radiation source. NXmx gives a fixed dictionary, though Jungfraujoch is not enforcing compliance. \nhttps://manual.nexusformat.org/classes/base_classes/NXsource.html#nxsource\nNXsource allows the following:\n\nSpallation Neutron Source\nPulsed Reactor Neutron Source\nReactor Neutron Source\nSynchrotron X-ray Source\nPulsed Muon Source\nRotating Anode X-ray\nFixed Tube X-ray\nUV Laser\nFree-Electron Laser\nOptical Laser\nIon Source\nUV Plasma Source\nMetal Jet X-ray\n","example":"Synchrotron X-ray Source","default":""},"instrument_name":{"type":"string","example":"CristallinaMX"},"pulsed_source":{"type":"boolean","description":"Settings specific to XFEL (e.g., every image has to come from TTL trigger, save pulse ID and event code)\n","default":false},"electron_source":{"type":"boolean","description":"Settings specific to electron source (e.g., wavelength definition)\n","default":false}}},"detector_module_direction":{"type":"string","enum":["Xp","Xn","Yp","Yn"]},"detector_type":{"type":"string","enum":["EIGER","JUNGFRAU","DECTRIS"]},"image_pusher_type":{"type":"string","default":"None","enum":["ZeroMQ","HDF5","CBOR","TCP","None"]},"standard_detector_geometry":{"type":"object","description":"Regular rectangular geometry, first module is in the bottom left corner of the detector","required":["nmodules"],"properties":{"nmodules":{"type":"integer","minimum":1,"description":"Number of modules in the detector"},"gap_x":{"type":"integer","default":8,"minimum":0,"description":"Gap size in X direction [pixels]"},"gap_y":{"type":"integer","minimum":0,"default":36,"description":"Gap size in Y direction [pixels]"},"modules_in_row":{"type":"integer","minimum":1,"default":1,"description":"Number of modules in one row"}}},"detector_module":{"type":"object","required":["x0","y0","fast_axis","slow_axis"],"properties":{"x0":{"type":"number"},"y0":{"type":"number"},"fast_axis":{"$ref":"#/components/schemas/detector_module_direction"},"slow_axis":{"$ref":"#/components/schemas/detector_module_direction"}}},"detector":{"type":"object","required":["description"],"properties":{"description":{"type":"string","minLength":1},"serial_number":{"type":"string","default":"Unknown","minLength":1},"type":{"$ref":"#/components/schemas/detector_type"},"high_voltage_V":{"type":"integer","format":"int64","minimum":0,"maximum":200,"default":0},"udp_interface_count":{"type":"integer","format":"int64","minimum":1,"maximum":2,"default":1},"module_sync":{"type":"boolean","default":true,"description":"Use module 0 as master for timing. Only applies to JUNGFRAU detector (this cannot be turned off for EIGER)."},"sensor_thickness_um":{"type":"number","format":"float","minimum":0,"default":320},"readout_time_ns":{"type":"integer","format":"int64","minimum":1,"description":"Minimum difference between frame time and count time in microseconds\nDefaults are 3'000 ns for EIGER and 20'000 ns for JUNGFRAU\n"},"min_count_time_ns":{"type":"integer","format":"int64","minimum":0,"description":"Minimum count time available for the detector."},"min_frame_time_ns":{"type":"integer","format":"int64","minimum":0,"description":"Minimum frame time available for the detector."},"calibration_file":{"type":"array","description":"Can be empty for all detectors - default calibration used.\nFor JUNGFRAU: list of gain files, one entry per module.\nFor EIGER: one directory (with detector settings) or list of trim bit files, one entry per half-module.\n","items":{"type":"string"}},"trim_energies_eV":{"type":"array","description":"List of energies at which trimming calibration is provided.\nOnly needed for PSI EIGER and compulsory in this case\n","items":{"type":"integer","format":"int32","minimum":100}},"hostname":{"type":"array","description":"Hostname for detector module. One entry per module\nOne entry per module. Either empty or number of module entries.\n","items":{"type":"string"}},"sensor_material":{"type":"string","default":"Si"},"tx_delay":{"type":"array","items":{"type":"integer","format":"int64"}},"base_data_ipv4_address":{"type":"string","example":"10.10.10.50"},"standard_geometry":{"$ref":"#/components/schemas/standard_detector_geometry"},"custom_geometry":{"type":"array","items":{"$ref":"#/components/schemas/detector_module"}},"roi_mode":{"type":"string","default":"","description":"ROI setting for DECTRIS detectors"},"mirror_y":{"type":"boolean","default":true,"description":"Mirror detector in Y direction to account for MX convention of (0,0) point in top left corner"},"temp_thresold_degC":{"type":"integer","format":"int64","description":"Temperature threshold for JUNGFRAU detector modules","minimum":40,"maximum":70,"default":55},"default_settings":{"$ref":"#/components/schemas/detector_settings"}}},"zeromq_settings":{"type":"object","description":"ZeroMQ configuration for Jungfraujoch software.\nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","properties":{"send_watermark":{"type":"integer","format":"int64","minimum":2,"maximum":16384,"default":100,"description":"Watermark for ZeroMQ send queue (number of outstanding messages queued on Jungfraujoch server per queue)"},"send_buffer_size":{"type":"integer","format":"int64","description":"Send buffer size for ZeroMQ socket"},"image_socket":{"type":"array","items":{"type":"string"},"example":["tcp://1.2.3.4:5000","tcp://1.2.3.4:5001"],"description":"PUSH ZeroMQ socket for images. In case multiple sockets are provided, images are streamed over multiple sockets.  \nImages are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"},"writer_notification_socket":{"type":"string","example":"tcp://1.3.4.6:7000","description":"PULL ZeroMQ socket for notifications from writer that it finished operation. \nThis allows Jungfraujoch to operate in a synchronous manner, with end of acquisition being also end of writing.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address should be avoided, as this socket address is forwarded to the writer process via START ZerOMQ message and in case of multiple ineterfaces the address might be ambigous.\nUsing * (star) instead of port number is allowed and it means a random free port number.\n"}}},"tcp_settings":{"type":"object","description":"TCP image stream configuration for Jungfraujoch software.\nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","required":["addr"],"properties":{"send_buffer_size":{"type":"integer","format":"int64","description":"Send buffer size for TCP/IP socket"},"image_socket":{"type":"string","example":"tcp://1.2.3.4:5000","description":"tcp://<IP address>:<port>\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces\n"},"nwriters":{"type":"integer","format":"int64","minimum":1,"maximum":100,"default":32,"description":"Number of TCP/IP writers to be used for streaming images"},"peer_liveness_timeout_ms":{"type":"integer","format":"int64","description":"Max time (in milliseconds) a send may block with no sign of life from the\nwriter (no BUSY heartbeat or ACK) before the connection is declared dead.\nOptional; the built-in default is used when unset.\n"},"max_backpressure_timeout_ms":{"type":"integer","format":"int64","description":"Hard upper bound (in milliseconds) on backpressure: if no bytes can be sent to\nthe writer for this long the connection is declared dead even while the writer\nkeeps heartbeating, so a wedged writer cannot block the run or its\nfinalization. Optional; the built-in default is used when unset.\n"}}},"pcie_devices":{"type":"array","minLength":1,"items":{"type":"object","required":["block_device"],"properties":{"blk":{"type":"string","example":"/dev/jfjoch0","description":"Block device name"},"ipv4":{"type":"string","example":"10.1.1.7","description":"IPv4 address of the block device"}}}},"bragg_integration_settings":{"type":"object","description":"Settings for Bragg spot integration","required":["integration_model"],"properties":{"integration_model":{"$ref":"#/components/schemas/integration_model"},"max_hkl":{"type":"integer","minimum":1,"maximum":511,"default":100,"description":"How far the Bragg predictor walks the lattice: reflections with |h|,|k|,|l| above this are\nnever predicted. An axis is truncated once a/d_min exceeds it, so a long axis - or a short\none taken to high resolution - loses its outermost reflections. The cost grows as the cube\n(2n+1)^3 of candidates per image, which is why online keeps a fixed, predictable value\ninstead of taking it from whichever crystal is mounted.\n\nOmitting the field selects the default above; it is never interpreted as \"choose per\ncrystal\". The offline tools (rugnux, viewer) do derive it from the refined cell when it is\nleft unset there, but that is their own default and is not reachable through this API.\n"}}},"jfjoch_settings":{"type":"object","required":["detector","frontend_directory","image_pusher"],"description":"Default settings for Jungfraujoch software. \nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","properties":{"pcie":{"$ref":"#/components/schemas/pcie_devices"},"zeromq":{"$ref":"#/components/schemas/zeromq_settings"},"tcp":{"$ref":"#/components/schemas/tcp_settings"},"instrument":{"$ref":"#/components/schemas/instrument_metadata"},"file_writer":{"$ref":"#/components/schemas/file_writer_settings"},"detector":{"type":"array","minLength":1,"items":{"$ref":"#/components/schemas/detector"}},"indexing":{"$ref":"#/components/schemas/indexing_settings"},"bragg_integration":{"$ref":"#/components/schemas/bragg_integration_settings"},"detector_settings":{"$ref":"#/components/schemas/detector_settings"},"azim_int":{"$ref":"#/components/schemas/azim_int_settings"},"image_format":{"$ref":"#/components/schemas/image_format_settings"},"image_buffer_MiB":{"type":"integer","minimum":128,"default":2048,"description":"Size of internal buffer in MiB for images before they are sent to a stream"},"verbose":{"type":"boolean","default":false,"description":"Print extra debug information"},"receiver_threads":{"type":"integer","minimum":1,"maximum":512,"default":64,"description":"Number of threads used by the receiver"},"numa_policy":{"type":"string","deprecated":true,"description":"Ignored value"},"frontend_directory":{"type":"string","description":"Location of built JavaScript web frontend"},"spot_finding":{"$ref":"#/components/schemas/spot_finding_settings"},"image_pusher":{"$ref":"#/components/schemas/image_pusher_type"},"zeromq_preview":{"$ref":"#/components/schemas/zeromq_preview_settings"},"zeromq_metadata":{"$ref":"#/components/schemas/zeromq_metadata_settings"},"dark_mask":{"$ref":"#/components/schemas/dark_mask_settings"}}},"zeromq_metadata_settings":{"type":"object","required":["enabled","period_ms"],"properties":{"enabled":{"type":"boolean","default":true,"description":"ZeroMQ metadata socket is enabled."},"period_ms":{"type":"integer","format":"int64","minimum":1,"default":1000,"description":"Period for generating metadata package sent to the ZeroMQ interface in milliseconds.\n"},"socket_address":{"type":"string","description":"PUB ZeroMQ socket for image metadata information.\nImage metadata are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"}}},"zeromq_preview_settings":{"type":"object","required":["enabled","period_ms"],"properties":{"enabled":{"type":"boolean","default":true,"description":"ZeroMQ preview socket is enabled."},"period_ms":{"type":"integer","format":"int64","default":1000,"description":"Period for generating preview image sent to the ZeroMQ interface in milliseconds. Default is 1 second. \nIf set to zero, all images will be sent ZeroMQ (should be used only in case of relatively slow data collection).\nThis has no effect on HTTP based preview, which updates always at rate of 1 second.\n"},"socket_address":{"type":"string","description":"PUB ZeroMQ socket for preview images. This socket operates at a reduced frame rate.\nImages are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"}}}}},"paths":{"/initialize":{"post":{"summary":"Initialize detector and data acquisition","description":"Should be used in two cases:\n  - Detector is in `Inactive` state\n  - Detector is in `Error` state\nX-ray shutter must be closed. \nThis operation will reconfigure network interface of the detector. \nDuring operation of the detector it is recommended to use the `POST /pedestal` operation instead.\nIf storage cells are used, the execution time might be few minutes.\n\nThis is async function - one needs to use `POST /wait_till_done` to ensure operation is done.\n","responses":{"200":{"description":"Initialization started"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/pedestal":{"post":{"summary":"Collect dark current for the detector","description":"Updates calibration of the JUNGFRAU detector. Must be in `Idle` state.\n\nX-ray shutter must be closed. Recommended to run once per hour for long integration times (> 100 us).\n\nThis is async function - one needs to use `POST /wait_till_done` to ensure operation is done.\n","responses":{"200":{"description":"Everything OK"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/start":{"post":{"summary":"Start detector","description":"Start data acquisition.\nDetector must be in `Idle` state.\nDefault behavior is for the call to block until detector is ready to accept soft/TTL triggers.\nHowever, this behavior can be changed by settings `async_start` to true in the request body, \nin which case the call will return immediately and one needs to use `/wait_until_running` to ensure detector is ready to run.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/wait_until_running":{"post":{"summary":"Wait for acquisition running","parameters":[{"in":"query","name":"timeout","required":false,"schema":{"type":"integer","default":60,"minimum":0,"maximum":3600},"description":"Timeout in seconds (0 == immediate response)"}],"description":"Block execution of external script till detector and Jungfraujoch are ready to collect data.\nTo not block web server for a indefinite period of time, the procedure is provided with a timeout.\nExtending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.\n","responses":{"200":{"description":"Detector in `Measuring` state"},"400":{"description":"Timeout parameter out of bounds"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}},"502":{"description":"Detector is inactive mode"},"504":{"description":"Timeout reached, need to restart operation"}}}},"/wait_till_done":{"post":{"summary":"Wait for acquisition done","parameters":[{"in":"query","name":"timeout","required":false,"schema":{"type":"integer","default":60,"minimum":0,"maximum":3600},"description":"Timeout in seconds (0 == immediate response)"}],"description":"Block execution of external script till initialization, data collection or pedestal is finished.\nRunning this command does not affect (cancel) running data collection, it is only to ensure synchronous execution of other software.\n\nTo not block web server for a indefinite period of time, the procedure is provided with a timeout.\nExtending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.\n","responses":{"200":{"description":"Detector in `Idle` state, another data collection can start immediately.\nThe operation that finished either succeeded, was cancelled, or ended with a warning.\n"},"400":{"description":"Timeout parameter out of bounds"},"500":{"description":"Error within Jungfraujoch code, or the operation that finished ended in an error -\nmissing packets, or a writer that could not write - see output message.\nA cancelled data collection is not an error.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}},"502":{"description":"Detector is inactive mode"},"504":{"description":"Timeout reached, need to restart operation"}}}},"/trigger":{"post":{"summary":"Send soft trigger to the detector","description":"Generate soft trigger","responses":{"200":{"description":"Trigger sent"}}}},"/cancel":{"post":{"summary":"Cancel running data collection","description":"Command will inform FPGA network card to stop pedestal or data collection at the current stage.\nAny frame that is currently being processed by CPU will be finished and sent to writer.\nGiven the command is making sure to gracefully stop data acquisition and detector, it might take some time to switch back after command finished to `Idle` state.\n\nIf data collection is not running, the command has no effect.\n","responses":{"200":{"description":"Cancel request sent to FPGAs (or ignored, as data collection is not running)"}}}},"/deactivate":{"post":{"summary":"Prepare detector to turn off","description":"Should be in `Idle` or `Error` state.\nCommand deactivates data acquisition and turns off detector high voltage and ASIC.\nShould be used always before turning off power from the detector.\n","responses":{"200":{"description":"Detector ready to turn off"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/config/detector":{"put":{"summary":"Change detector configuration","description":"Detector settings are ones that have effect on calibration, i.e., pedestal has to be collected again after changing these settings.\nThis can only be done when detector is `Idle`, `Error` or `Inactive` states.\nIf detector is in `Idle` state , pedestal procedure will be executed automatically - there must be no X-rays on the detector during the operation.\nIf detector is in `Inactive` or `Error` states, new settings will be saved, but no calibration will be executed.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get detector configuration","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_settings"}}}}}}},"/config/indexing":{"put":{"summary":"Change indexing algorithm settings","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/indexing_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get indexing configuration","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/indexing_settings"}}}}}}},"/config/bragg_integration":{"put":{"summary":"Change Bragg integration settings","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bragg_integration_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get Bragg integration configuration","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bragg_integration_settings"}}}}}}},"/config/file_writer":{"put":{"summary":"Change file writer settings","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/file_writer_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get file writer settings","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file_writer_settings"}}}}}}},"/config/instrument":{"put":{"summary":"Change instrument metadata","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/instrument_metadata"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get instrument metadata","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/instrument_metadata"}}}}}}},"/config/image_format":{"put":{"summary":"Change image output format","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_format_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get image output format","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_format_settings"}}}}}}},"/config/image_format/raw":{"post":{"summary":"Configure format for raw data collection","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","responses":{"200":{"description":"Everything OK"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/config/image_format/conversion":{"post":{"summary":"Configure format for data collection with full conversion","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","responses":{"200":{"description":"Everything OK"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/config/spot_finding":{"put":{"summary":"Configure spot finding","description":"Can be done anytime, also while data collection is running","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spot_finding_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}},"get":{"summary":"Get data processing configuration","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/spot_finding_settings"}}}}}}},"/config/azim_int":{"put":{"summary":"Configure azimuthal integration","description":"Can be done when detector is Inactive or Idle","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/azim_int_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get azimuthal integration configuration","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/azim_int_settings"}}}}}}},"/config/internal_generator_image":{"put":{"summary":"Load binary image for internal FPGA generator","description":"Load image for internal FPGA generator. This can only happen in Idle state of the detector.\nRequires binary blob with 16-bit integer numbers of size of detector in raw/converted coordinates \n(depending on detector settings).\n","parameters":[{"name":"id","in":"query","description":"Image id to upload","required":false,"schema":{"type":"integer","format":"int64","minimum":0,"maximum":127}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/config/internal_generator_image.tiff":{"put":{"summary":"Load TIFF image for internal FPGA generator","description":"Load image for internal FPGA generator. This can only happen in Idle state of the detector.\nRequires TIFF with 16-bit integer numbers of size of detector in raw/converted coordinates \n(depending on detector settings).\n","parameters":[{"in":"query","name":"id","description":"Image ID to upload","required":false,"schema":{"type":"integer","minimum":0,"maximum":127}}],"requestBody":{"content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/config/select_detector":{"put":{"summary":"Select detector","description":"Jungfraujoch allows to control multiple detectors and/or region-of-interests.\nThe command allows to choose one detector from the list (ID has to be consistent with one provided by GET response).\nChanging detector will set detector to `Inactive` state and will require reinitialization.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_selection"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"List available detectors","description":"Configured detectors that can be selected by used","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_list"}}}}}}},"/config/zeromq_preview":{"put":{"summary":"Set ZeroMQ preview settings","description":"Jungfraujoch can generate preview message stream on ZeroMQ SUB socket.\nHere settings of the socket can be adjusted.\nWhile the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request.\nOptions set with this PUT request have no effect on HTTP based preview.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zeromq_preview_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get ZeroMQ preview settings","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zeromq_preview_settings"}}}}}}},"/config/zeromq_metadata":{"put":{"summary":"Set ZeroMQ metadata settings","description":"Jungfraujoch can generate metadata message stream on ZeroMQ PUB socket. This stream covers all images.\nHere settings of the socket can be adjusted.\nWhile the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zeromq_metadata_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get ZeroMQ metadata socket settings","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zeromq_metadata_settings"}}}}}}},"/config/dark_mask":{"put":{"summary":"Set configuration for dark data collection to calculate mask","description":"This is only possible when operating DECTRIS detectors at the moment; it will be also available for PSI EIGER at some point.\nThis can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dark_mask_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get settings for dark data collection to calculate mask","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dark_mask_settings"}}}}}}},"/status":{"get":{"summary":"Get Jungfraujoch status","description":"Status of the data acquisition","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/broker_status"}}}}}}},"/fpga_status":{"get":{"summary":"Get status of FPGA devices","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fpga_status"}}}}}}},"/xfel/pulse_id":{"get":{"summary":"Return XFEL pulse IDs for the current data acquisition","description":"Return array of XFEL pulse IDs - (-1) if image not recorded","responses":{"200":{"description":"Pulse ID collected","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}}},"404":{"description":"Not in XFEL mode or no acquisition recorded"}}}},"/xfel/event_code":{"get":{"summary":"Return XFEL event codes for the current data acquisition","description":"Return array of XFEL event codes","responses":{"200":{"description":"Event codes collected","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}}},"404":{"description":"Not in XFEL mode or no acquisition recorded"}}}},"/image_pusher/status":{"get":{"summary":"Get status of image pusher","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_pusher_status"}}}},"500":{"description":"Error encountered when trying to read status","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/detector/status":{"get":{"summary":"Get detector status","description":"Status of the JUNGFRAU detector","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_status"}}}},"404":{"description":"Running in \"simulator\" mode - no detector present"},"500":{"description":"Error encountered when trying to read status","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/config/roi":{"get":{"summary":"Get ROI definitions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roi_definitions"}}}}}},"put":{"summary":"Upload ROI definitions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/roi_definitions"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/statistics":{"get":{"summary":"Get general statistics","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jfjoch_statistics"}}}}}}},"/statistics/data_collection":{"get":{"summary":"Get data collection statistics","description":"Results of the last data collection","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/measurement_statistics"}}}},"404":{"description":"No data collection performed so far"}}}},"/statistics/calibration":{"get":{"summary":"Get calibration statistics","description":"Statistics are provided for each module/storage cell separately","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calibration_statistics"}}}}}}},"/config/mask":{"get":{"summary":"Get mask of the detector (binary)","description":"Detector must be Initialized.\nGet full pixel mask of the detector.\nSee NXmx standard for meaning of pixel values.\n","responses":{"200":{"description":"Binary array (4 byte; unsigned)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}},"/config/user_mask":{"get":{"summary":"Detector must be Initialized.\nGet user mask of the detector (binary)\n","description":"Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked","responses":{"200":{"description":"User mask in binary format (4 byte; unsigned)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"summary":"Upload user mask of the detector (binary)","description":"Should be in `Idle` state.\nUpload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.\nIf detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.\nIn the latter case - module gaps are ignored and don't need to be assigned value.\nMask is expected as binary array (4-byte; unsigned).\n0 - good pixel, other value - masked\nUser mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.\n","requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"All good"},"400":{"description":"Mask is not 4-byte unsigned integer array or empty body"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/config/mask.tiff":{"get":{"summary":"Get mask of the detector (TIFF)","description":"Should be in `Idle` state.\nGet full pixel mask of the detector\nSee NXmx standard for meaning of pixel values\n","responses":{"200":{"description":"Pixel mask in TIFF format (4 byte; unsigned)","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}}}}},"/config/user_mask.tiff":{"get":{"summary":"Detector must be Initialized.\nGet user mask of the detector (TIFF)\n","description":"Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked","responses":{"200":{"description":"User mask in TIFF format (4 byte; unsigned)","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"summary":"Upload user mask of the detector","description":"Should be in `Idle` state.\nUpload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.\nIf detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.\nIn the latter case - module gaps are ignored and don't need to be assigned value.\nMask is expected as a single-channel TIFF (8-, 16- or 32-bit integer, signed or unsigned).\n0 - good pixel, other value - masked\nUser mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.\nUser mask is not automatically applied - i.e. pixels with user mask will have a valid pixel value in the images.\n","requestBody":{"content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"All good"},"400":{"description":"Not a valid single-channel TIFF or size doesn't match the detector"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/preview/pedestal.tiff":{"get":{"parameters":[{"in":"query","name":"gain_level","required":true,"schema":{"type":"integer"},"description":"Gain level (0, 1, 2)"},{"in":"query","name":"sc","schema":{"type":"integer"},"description":"Storage cell number"}],"summary":"Get pedestal in TIFF format","responses":{"200":{"description":"Calibration image","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid gain level or storage cell number"},"404":{"description":"No calibration recorded so far"}}}},"/preview/plot":{"get":{"summary":"Generate 1D plot from Jungfraujoch","parameters":[{"$ref":"#/components/parameters/binning"},{"$ref":"#/components/parameters/plot_type"},{"$ref":"#/components/parameters/fill_value"},{"$ref":"#/components/parameters/experimental_coord"},{"$ref":"#/components/parameters/azint_unit"}],"responses":{"200":{"description":"Everything OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/plots"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/preview/plot.bin":{"get":{"summary":"Generate 1D plot from Jungfraujoch and send in raw binary format.\nData are provided as (32-bit) float binary array.\nThis format doesn't transmit information about X-axis, only values, so it is of limited use for azimuthal integration.\n","parameters":[{"$ref":"#/components/parameters/plot_type"},{"$ref":"#/components/parameters/roi"}],"responses":{"200":{"description":"Everything OK.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/result/scan":{"get":{"summary":"Get full scan result","responses":{"200":{"description":"Everything OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scan_result"}}}},"404":{"description":"No grid scan recorded"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/start.cbor":{"get":{"summary":"Get Start message in CBOR format","description":"Contains metadata for a dataset (e.g., experimental geometry)","responses":{"200":{"description":"Return start message","content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No measurement so far"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.cbor":{"get":{"summary":"Get image message in CBOR format","description":"Contains full image data and metadata. The image must come from the latest data collection.","parameters":[{"$ref":"#/components/parameters/image_id"}],"responses":{"200":{"description":"Return image message","content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Image not present in the buffer - either not yet measured or already replaced by a next image."},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.jpeg":{"get":{"summary":"Get preview image in JPEG format using custom settings","parameters":[{"$ref":"#/components/parameters/image_id"},{"$ref":"#/components/parameters/show_user_mask"},{"$ref":"#/components/parameters/show_roi"},{"$ref":"#/components/parameters/show_spots"},{"$ref":"#/components/parameters/show_predictions"},{"$ref":"#/components/parameters/show_beam_center"},{"$ref":"#/components/parameters/saturation"},{"$ref":"#/components/parameters/jpeg_quality"},{"$ref":"#/components/parameters/resolution_ring"},{"$ref":"#/components/parameters/color_scale"},{"$ref":"#/components/parameters/resolution_estimate"}],"responses":{"200":{"description":"Preview image","content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"404":{"description":"Image not present in the buffer - either not yet measured or already replaced by a next image."},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.tiff":{"get":{"summary":"Get preview image in TIFF format","parameters":[{"$ref":"#/components/parameters/image_id"}],"responses":{"200":{"description":"Preview image","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No preview image recorded so far"}}}},"/image_buffer/clear":{"post":{"summary":"Clear image buffer","description":"Turns off image buffer for the last data collection. Can be only run when Jungfraujoch is not collecting data.","responses":{"200":{"description":"Done"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/status":{"get":{"summary":"Get status of the image buffers","description":"Can be run at any stage of Jungfraujoch operation, including during data collection.\nThe status of the image buffer is volatile during data collection - if data collection goes for more images than available buffer slots,\nthen image might be replaced in the buffer between calling /images and /image.cbor.\n","responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_buffer_status"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/version":{"get":{"summary":"Get Jungfraujoch version of jfjoch_broker","responses":{"200":{"description":"Release number of Jungfraujoch","content":{"text/plain":{"schema":{"type":"string","example":"1.0.0-rc.25"}}}}}}}}}},"searchIndex":{"store":["section/License-Clarification","/paths/~1initialize/post","/paths/~1pedestal/post","/paths/~1start/post","/paths/~1wait_until_running/post","/paths/~1wait_till_done/post","/paths/~1trigger/post","/paths/~1cancel/post","/paths/~1deactivate/post","/paths/~1config~1detector/put","/paths/~1config~1detector/get","/paths/~1config~1indexing/put","/paths/~1config~1indexing/get","/paths/~1config~1bragg_integration/put","/paths/~1config~1bragg_integration/get","/paths/~1config~1file_writer/put","/paths/~1config~1file_writer/get","/paths/~1config~1instrument/put","/paths/~1config~1instrument/get","/paths/~1config~1image_format/put","/paths/~1config~1image_format/get","/paths/~1config~1image_format~1raw/post","/paths/~1config~1image_format~1conversion/post","/paths/~1config~1spot_finding/put","/paths/~1config~1spot_finding/get","/paths/~1config~1azim_int/put","/paths/~1config~1azim_int/get","/paths/~1config~1internal_generator_image/put","/paths/~1config~1internal_generator_image.tiff/put","/paths/~1config~1select_detector/put","/paths/~1config~1select_detector/get","/paths/~1config~1zeromq_preview/put","/paths/~1config~1zeromq_preview/get","/paths/~1config~1zeromq_metadata/put","/paths/~1config~1zeromq_metadata/get","/paths/~1config~1dark_mask/put","/paths/~1config~1dark_mask/get","/paths/~1status/get","/paths/~1fpga_status/get","/paths/~1xfel~1pulse_id/get","/paths/~1xfel~1event_code/get","/paths/~1image_pusher~1status/get","/paths/~1detector~1status/get","/paths/~1config~1roi/get","/paths/~1config~1roi/put","/paths/~1statistics/get","/paths/~1statistics~1data_collection/get","/paths/~1statistics~1calibration/get","/paths/~1config~1mask/get","/paths/~1config~1user_mask/get","/paths/~1config~1user_mask/put","/paths/~1config~1mask.tiff/get","/paths/~1config~1user_mask.tiff/get","/paths/~1config~1user_mask.tiff/put","/paths/~1preview~1pedestal.tiff/get","/paths/~1preview~1plot/get","/paths/~1preview~1plot.bin/get","/paths/~1result~1scan/get","/paths/~1image_buffer~1start.cbor/get","/paths/~1image_buffer~1image.cbor/get","/paths/~1image_buffer~1image.jpeg/get","/paths/~1image_buffer~1image.tiff/get","/paths/~1image_buffer~1clear/post","/paths/~1image_buffer~1status/get","/paths/~1version/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.111,1,4.753]],["description/0",[0,1.805,2,4.17,3,2.159,4,2.087,5,1.193,6,3.337,7,1.193,8,1.193,9,1.032,10,0.926,11,1.621,12,1.193,13,0.963,14,1.193,15,1.619,16,1.193,17,2.781,18,2.087,19,0.926,20,2.087,21,1.278,22,1.193,23,2.087,24,1.032,25,2.781,26,1.193,27,1.193,28,2.087,29,1.193,30,1.193,31,1.193,32,1.193,33,1.193,34,1.193,35,1.193,36,2.781,37,1.193,38,1.193,39,0.354,40,0.611,41,1.193,42,2.087,43,1.032,44,1.193,45,1.193,46,1.193,47,1.193,48,1.193,49,1.193,50,1.032,51,1.193,52,1.193,53,1.193,54,1.193,55,1.193,56,1.193,57,1.193,58,1.193,59,0.926,60,0.926,61,1.193]],["title/1",[62,2.314,63,0.416,64,0.989,65,1.935]],["description/1",[11,2.226,39,0.937,43,1.688,59,1.515,62,1.195,63,0.505,66,1.952,67,1.385,68,2.042,69,0.858,70,0.901,71,1.515,72,1.688,73,1.385,74,3.01,75,1.952,76,1.515,77,1.688,78,2.735,79,1.195,80,1.952,81,1.952,82,1.688,83,1.385,84,1.281,85,1.952,86,1.952,87,1.688,88,1.688,89,1.281,90,1.281,91,1.515,92,1.281,93,0.555]],["title/2",[63,0.416,94,1.384,95,2.932,96,2.681]],["description/2",[11,1.242,39,0.758,63,0.282,68,2.004,71,1.984,72,2.212,73,1.814,74,1.679,77,2.212,78,2.212,79,1.566,84,1.679,87,2.212,88,2.212,89,1.679,90,1.679,91,1.984,92,1.679,93,0.727,97,2.557,98,1.984,99,2.212,100,0.824,101,1.31,102,2.557,103,2.557,104,2.557,105,2.557,106,1.385,107,2.557]],["title/3",[63,0.524,108,3.688]],["description/3",[11,1.132,39,0.691,60,2.827,63,0.494,64,0.61,65,1.194,67,1.654,89,1.531,90,1.531,92,1.531,100,0.751,101,1.194,108,2.827,109,2.331,110,3.642,111,1.809,112,2.331,113,3.15,114,2.331,115,2.331,116,1.809,117,1.076,118,0.783,119,2.331,120,2.331,121,1.809,122,2.331,123,1.531,124,2.331,125,2.016]],["title/4",[65,2.156,101,2.156,126,3.641]],["description/4",[15,1.984,21,1.566,63,0.282,64,0.67,73,1.814,83,1.814,84,1.679,92,1.679,94,0.937,111,3.036,113,2.212,125,2.212,127,2.212,128,2.212,129,2.212,130,1.242,131,2.212,132,2.212,133,2.212,134,2.212,135,1.984,136,1.679,137,3.384,138,2.212,139,1.984,140,2.212,141,3.384,142,2.212]],["title/5",[65,2.156,93,1.197,126,3.641]],["description/5",[15,1.636,21,1.291,62,1.291,64,0.881,73,1.496,79,1.291,83,2.387,84,1.384,91,1.636,92,2.209,94,1.232,101,1.723,111,2.61,127,1.823,128,1.823,129,1.823,131,1.823,132,1.823,133,1.823,134,1.823,135,1.636,136,1.384,137,2.909,138,1.823,139,1.636,140,1.823,141,2.909,142,1.823,143,1.823,144,1.496,145,2.107,146,1.636,147,2.107,148,2.107]],["title/6",[63,0.416,116,2.932,149,3.268,150,3.268]],["description/6",[13,2.476,116,5.063,150,4.639]],["title/7",[64,0.989,94,1.384,101,1.935,146,2.932]],["description/7",[39,0.625,59,1.636,63,0.232,64,1.099,65,1.079,79,1.291,84,1.384,94,1.232,96,2.387,100,0.679,101,1.079,143,2.909,144,3.4,146,1.636,151,1.823,152,1.291,153,2.107,154,2.61,155,1.823,156,2.107,157,2.107,158,1.823,159,2.107,160,2.107,161,1.636,162,2.107,163,2.107,164,2.107,165,2.107,166,2.107,167,2.107,168,2.107,169,1.636]],["title/8",[63,0.464,170,4.21,171,3.267]],["description/8",[11,1.618,39,0.987,63,0.524,64,0.872,65,1.706,70,1.538,100,1.073,144,2.364,171,3.693,172,4.759,173,3.331,174,3.331,175,3.331,176,3.331,177,3.331,178,3.331]],["title/9",[63,0.464,117,1.944,179,1.851]],["description/9",[39,1.271,63,0.586,68,1.768,69,1.518,70,1.594,71,1.69,74,1.429,76,1.69,79,2.114,83,2.449,89,1.429,93,0.619,94,0.797,98,2.679,100,1.112,117,1.005,118,1.441,135,1.69,169,1.69,180,1.883,181,2.177,182,1.883,183,2.177,184,2.177,185,1.883]],["title/10",[63,0.524,179,2.09]],["description/10",[93,1.59,185,4.835,186,2.863]],["title/11",[117,1.745,118,1.27,187,3.268,188,3.778]],["description/11",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,189,4.135]],["title/12",[179,2.09,187,4.111]],["description/12",[93,1.59,186,2.863,189,4.835]],["title/13",[106,2.046,117,1.745,118,1.27,190,3.268]],["description/13",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,191,4.135]],["title/14",[106,2.28,179,1.851,190,3.641]],["description/14",[93,1.59,186,2.863,191,4.835]],["title/15",[10,2.932,117,1.745,118,1.27,161,2.932]],["description/15",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,192,4.135]],["title/16",[10,3.267,118,1.415,161,3.267]],["description/16",[93,1.59,186,2.863,192,4.835]],["title/17",[117,1.944,193,3.641,194,2.419]],["description/17",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,195,4.135]],["title/18",[193,4.111,194,2.731]],["description/18",[93,1.59,186,2.863,195,4.835]],["title/19",[117,1.745,196,1.27,197,3.268,198,1.835]],["description/19",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,199,4.135]],["title/20",[196,1.415,197,3.641,198,2.045]],["description/20",[93,1.59,186,2.863,199,4.835]],["title/21",[64,0.897,94,1.255,179,1.507,198,1.665,200,2.432]],["description/21",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,201,4.78]],["title/22",[64,0.821,94,1.149,179,1.379,198,1.523,202,2.059,203,2.433]],["description/22",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,204,4.78]],["title/23",[179,1.851,205,3.267,206,3.267]],["description/23",[64,1.299,93,1.41,94,1.817,101,2.54,186,2.54,207,4.29]],["title/24",[64,1.102,158,3.641,179,1.851]],["description/24",[93,1.59,186,2.863,207,4.835]],["title/25",[106,2.28,179,1.851,208,2.764]],["description/25",[63,0.568,69,2.266,93,1.465,100,1.66,209,4.458]],["title/26",[106,2.28,179,1.851,208,2.764]],["description/26",[93,1.59,186,2.863,209,4.835]],["title/27",[13,1.448,152,1.92,196,1.054,210,2.225,211,1.802,212,2.225]],["description/27",[13,1.397,21,1.853,39,0.897,63,0.579,100,0.975,118,1.017,152,1.853,196,1.017,210,2.147,211,1.739,212,2.147,213,2.617,214,3.026,215,2.617,216,2.348,217,2.617,218,2.617,219,2.617,220,1.853,221,2.617,222,3.026]],["title/28",[13,1.448,152,1.92,196,1.054,210,2.225,212,2.225,223,1.802]],["description/28",[13,1.43,21,1.897,39,0.918,63,0.587,100,0.998,118,1.041,152,1.897,196,1.041,210,2.198,212,2.198,213,2.679,215,2.679,216,2.403,217,2.679,218,2.679,219,2.679,220,1.897,221,2.679,223,1.78,224,3.097]],["title/29",[63,0.524,225,4.111]],["description/29",[21,1.698,24,2.397,39,0.821,50,3.597,63,0.611,69,1.219,89,2.731,117,1.28,118,0.932,130,1.346,136,1.82,144,1.967,226,2.771,227,2.771,228,2.771,229,2.771,230,2.397,231,2.151,232,2.771,233,2.771,234,2.771,235,2.397]],["title/30",[63,0.464,230,3.641,236,3.267]],["description/30",[11,2.503,63,0.568,179,2.266,225,4.458,235,4.458]],["title/31",[118,1.747,237,2.314,238,2.481]],["description/31",[13,1.181,64,0.67,117,1.181,118,1.315,121,3.036,130,1.242,169,1.984,237,1.566,238,2.569,239,1.814,240,2.212,241,2.557,242,3.036,243,2.212,244,2.212,245,2.212,246,1.814,247,2.212,248,2.212,249,3.384,250,1.814,251,3.384,252,2.557,253,2.557,254,2.212]],["title/32",[118,1.415,237,2.579,238,2.764]],["description/32",[254,5.283]],["title/33",[118,1.747,194,2.171,237,2.314]],["description/33",[13,1.307,64,0.741,117,1.307,118,0.951,121,2.197,130,1.375,194,1.627,196,0.951,237,1.734,239,2.009,240,3.655,242,3.279,243,2.449,244,2.449,245,2.449,246,2.009,247,2.449,248,2.449,249,2.449,250,2.009,251,2.449,255,2.831,256,2.831,257,2.449]],["title/34",[118,1.27,194,2.171,237,2.314,242,2.932]],["description/34",[257,5.283]],["title/35",[64,0.757,94,1.059,95,2.243,118,0.971,179,1.271,258,2.5,259,1.157]],["description/35",[39,1.068,63,0.554,69,1.585,70,1.664,74,2.367,93,1.025,100,1.161,139,2.797,236,2.797,260,3.604,261,3.604,262,3.604,263,3.604,264,3.604,265,3.118]],["title/36",[64,0.821,94,1.149,95,2.433,118,1.054,258,2.712,259,1.256]],["description/36",[265,5.283]],["title/37",[130,2.309,266,2.574]],["description/37",[64,1.404,65,2.747,266,3.533]],["title/38",[152,2.579,266,2.28,267,4.21]],["description/38",[268,6.108]],["title/39",[64,0.757,65,1.48,96,2.051,123,1.897,231,2.243,269,2.051,270,2.5]],["description/39",[68,2.208,123,2.831,196,1.449,231,3.346,269,3.06,270,3.729,271,3.06,272,3.346,273,4.311,274,4.311]],["title/40",[19,2.243,64,0.757,65,1.48,96,2.051,123,1.897,269,2.051,275,2.5]],["description/40",[19,3.849,123,3.257,269,3.52,271,3.52,275,4.29,276,4.959]],["title/41",[196,1.415,266,2.28,277,4.21]],["description/41",[278,6.108]],["title/42",[63,0.524,266,2.574]],["description/42",[63,0.591,99,4.639,266,2.905,279,5.363]],["title/43",[3,3.688,280,4.111]],["description/43",[281,5.283]],["title/44",[3,3.267,280,3.641,282,2.764]],["description/44",[281,5.283]],["title/45",[13,2.194,283,3.121]],["description/45",[283,4.011]],["title/46",[64,1.102,94,1.542,283,2.764]],["description/46",[64,1.349,94,1.888,284,4.458,285,4.458,286,5.153]],["title/47",[98,3.688,283,3.121]],["description/47",[82,4.135,136,3.139,283,3.139,287,4.78,288,4.78,289,4.78,290,4.78]],["title/48",[63,0.464,211,2.419,259,1.686]],["description/48",[62,2.405,63,0.588,202,2.578,259,1.572,291,3.268,292,3.396,293,2.786,294,3.396,295,3.396,296,2.578,297,3.926]],["title/49",[40,1.606,62,1.92,63,0.502,211,1.802,259,1.256]],["description/49",[40,1.898,63,0.565,68,2.627,220,2.27,259,2.054,272,2.876,291,3.141,298,3.205,299,2.63,300,2.63,301,3.205]],["title/50",[40,1.755,63,0.378,211,1.969,259,1.372,282,2.25]],["description/50",[11,0.767,39,0.468,40,1.359,63,0.292,67,1.12,68,2.061,90,1.036,100,0.508,106,0.855,154,1.225,200,1.12,203,1.225,205,1.225,206,1.225,208,1.036,211,0.907,220,0.967,250,1.12,259,1.947,271,1.12,282,1.036,291,1.625,293,1.12,296,1.742,299,1.12,300,1.12,301,1.365,302,1.365,303,1.365,304,1.365,305,1.365,306,1.365,307,1.365,308,1.365,309,1.365,310,1.365,311,1.365,312,2.295,313,1.365,314,1.365,315,1.365,316,1.365,317,1.365,318,1.365,319,1.578,320,1.365,321,1.365,322,1.365,323,1.365,324,1.365]],["title/51",[63,0.464,223,2.419,259,1.686]],["description/51",[39,1.164,63,0.433,100,1.265,202,2.578,259,1.572,291,3.268,292,3.396,293,2.786,294,3.396,295,3.396,296,2.578,325,3.926]],["title/52",[40,1.606,62,1.92,63,0.502,223,1.802,259,1.256]],["description/52",[40,1.898,63,0.565,68,2.627,220,2.27,259,2.054,272,2.876,291,3.141,298,3.205,299,2.63,300,2.63,326,3.205]],["title/53",[40,1.935,63,0.416,259,1.513,282,2.481]],["description/53",[9,1.134,11,0.637,39,0.389,40,1.825,63,0.25,67,0.931,68,2.06,90,0.861,100,0.423,106,0.71,154,1.018,180,1.134,182,1.134,196,0.441,200,0.931,203,1.018,205,1.018,206,1.018,208,0.861,216,1.018,220,0.803,223,0.754,250,0.931,259,1.998,282,0.861,291,2.182,293,0.931,296,1.964,299,0.931,300,0.931,302,1.134,303,1.134,304,1.134,305,1.134,306,1.134,307,1.134,308,1.134,309,1.134,310,1.134,311,1.134,312,1.96,313,1.134,314,1.134,315,1.134,316,1.134,317,1.134,318,1.134,320,1.134,321,1.134,322,1.134,323,1.96,324,1.134,326,1.134,327,1.311,328,1.311,329,1.134,330,1.311,331,1.311]],["title/54",[79,2.579,198,2.045,223,2.419]],["description/54",[332,6.108]],["title/55",[13,1.745,130,1.835,333,3.268,334,3.268]],["description/55",[335,6.108]],["title/56",[11,0.602,13,0.572,64,0.324,106,0.671,130,0.602,136,0.813,149,1.072,151,1.072,198,1.048,200,0.879,208,0.813,211,1.239,271,0.879,296,0.813,329,1.072,333,1.072,334,1.072,336,1.239,337,1.239,338,1.239,339,1.239,340,1.239]],["description/56",[341,6.108]],["title/57",[202,2.764,284,3.641,342,4.21]],["description/57",[343,6.108]],["title/58",[108,2.932,198,1.835,239,2.681,344,3.268]],["description/58",[194,2.747,246,3.392,345,4.78,346,4.78,347,4.78,348,4.78,349,4.78]],["title/59",[196,1.27,198,1.835,239,2.681,344,3.268]],["description/59",[64,1.456,94,1.529,194,2.399,196,1.869,202,2.741,246,2.963,350,4.175,351,4.175,352,4.175]],["title/60",[11,1.404,118,0.971,196,0.971,198,1.404,238,1.897,353,2.89,354,2.89]],["description/60",[355,6.108]],["title/61",[196,1.27,198,1.835,223,2.171,238,2.481]],["description/61",[356,6.108]],["title/62",[196,1.415,357,4.21,358,2.988]],["description/62",[64,1.456,94,2.037,101,2.138,130,2.028,171,3.24,196,1.403,285,3.611,358,2.963,359,4.175]],["title/63",[196,1.415,266,2.28,358,2.988]],["description/63",[60,1.946,64,1.23,68,1.285,74,1.647,76,2.992,94,1.72,101,1.285,130,1.218,155,2.169,196,1.771,236,1.946,266,1.358,358,3.332,360,2.508,361,2.508,362,2.508,363,2.508,364,2.508,365,2.508,366,2.508,367,2.508,368,2.508]],["title/64",[130,2.045,369,3.641,370,4.21]],["description/64",[369,5.283]]],"invertedIndex":[["",{"_index":68,"title":{},"description":{"1":{},"2":{},"9":{},"39":{},"49":{},"50":{},"52":{},"53":{},"63":{}}}],["0",{"_index":299,"title":{},"description":{"49":{},"50":{},"52":{},"53":{}}}],["1",{"_index":272,"title":{},"description":{"39":{},"49":{},"52":{}}}],["100",{"_index":107,"title":{},"description":{"2":{}}}],["1024x512",{"_index":310,"title":{},"description":{"50":{},"53":{}}}],["16",{"_index":328,"title":{},"description":{"53":{}}}],["16-bit",{"_index":215,"title":{},"description":{"27":{},"28":{}}}],["1d",{"_index":333,"title":{"55":{},"56":{}},"description":{}}],["32-bit",{"_index":329,"title":{"56":{}},"description":{"53":{}}}],["4-byte",{"_index":319,"title":{},"description":{"50":{}}}],["8",{"_index":323,"title":{},"description":{"50":{},"53":{}}}],["accept",{"_index":114,"title":{},"description":{"3":{}}}],["account",{"_index":303,"title":{},"description":{"50":{},"53":{}}}],["acquisit",{"_index":65,"title":{"1":{},"4":{},"5":{},"39":{},"40":{}},"description":{"3":{},"7":{},"8":{},"37":{}}}],["actual",{"_index":298,"title":{},"description":{"49":{},"52":{}}}],["adjust",{"_index":244,"title":{},"description":{"31":{},"33":{}}}],["affect",{"_index":145,"title":{},"description":{"5":{}}}],["again",{"_index":181,"title":{},"description":{"9":{}}}],["algorithm",{"_index":188,"title":{"11":{}},"description":{}}],["allow",{"_index":50,"title":{},"description":{"0":{},"29":{}}}],["alway",{"_index":176,"title":{},"description":{"8":{}}}],["and/or",{"_index":228,"title":{},"description":{"29":{}}}],["anytim",{"_index":186,"title":{},"description":{"10":{},"12":{},"14":{},"16":{},"18":{},"20":{},"23":{},"24":{},"26":{}}}],["api",{"_index":2,"title":{},"description":{"0":{}}}],["appli",{"_index":9,"title":{},"description":{"0":{},"53":{}}}],["applic",{"_index":17,"title":{},"description":{"0":{}}}],["approach",{"_index":30,"title":{},"description":{"0":{}}}],["array",{"_index":271,"title":{"56":{}},"description":{"39":{},"40":{},"50":{}}}],["asic",{"_index":175,"title":{},"description":{"8":{}}}],["assign",{"_index":317,"title":{},"description":{"50":{},"53":{}}}],["async",{"_index":87,"title":{},"description":{"1":{},"2":{}}}],["async_start",{"_index":119,"title":{},"description":{"3":{}}}],["automat",{"_index":182,"title":{},"description":{"9":{},"53":{}}}],["avail",{"_index":236,"title":{"30":{}},"description":{"35":{},"63":{}}}],["azimuth",{"_index":208,"title":{"25":{},"26":{},"56":{}},"description":{"50":{},"53":{}}}],["back",{"_index":168,"title":{},"description":{"7":{}}}],["base",{"_index":253,"title":{},"description":{"31":{}}}],["be",{"_index":157,"title":{},"description":{"7":{}}}],["beam",{"_index":304,"title":{},"description":{"50":{},"53":{}}}],["befor",{"_index":177,"title":{},"description":{"8":{}}}],["behavior",{"_index":110,"title":{},"description":{"3":{}}}],["between",{"_index":366,"title":{},"description":{"63":{}}}],["binari",{"_index":211,"title":{"27":{},"48":{},"49":{},"50":{},"56":{}},"description":{"27":{},"50":{}}}],["bit",{"_index":322,"title":{},"description":{"50":{},"53":{}}}],["blob",{"_index":214,"title":{},"description":{"27":{}}}],["block",{"_index":111,"title":{},"description":{"3":{},"4":{},"5":{}}}],["bodi",{"_index":122,"title":{},"description":{"3":{}}}],["both",{"_index":309,"title":{},"description":{"50":{},"53":{}}}],["bragg",{"_index":190,"title":{"13":{},"14":{}},"description":{}}],["buffer",{"_index":358,"title":{"62":{},"63":{}},"description":{"62":{},"63":{}}}],["calcul",{"_index":258,"title":{"35":{},"36":{}},"description":{}}],["calibr",{"_index":98,"title":{"47":{}},"description":{"2":{},"9":{}}}],["call",{"_index":60,"title":{},"description":{"0":{},"3":{},"63":{}}}],["cancel",{"_index":146,"title":{"7":{}},"description":{"5":{},"7":{}}}],["card",{"_index":153,"title":{},"description":{"7":{}}}],["case",{"_index":67,"title":{},"description":{"1":{},"3":{},"50":{},"53":{}}}],["cbor",{"_index":344,"title":{"58":{},"59":{}},"description":{}}],["cell",{"_index":82,"title":{},"description":{"1":{},"47":{}}}],["chang",{"_index":117,"title":{"9":{},"11":{},"13":{},"15":{},"17":{},"19":{}},"description":{"3":{},"9":{},"29":{},"31":{},"33":{}}}],["choos",{"_index":24,"title":{},"description":{"0":{},"29":{}}}],["clarif",{"_index":1,"title":{"0":{}},"description":{}}],["clear",{"_index":357,"title":{"62":{}},"description":{}}],["client",{"_index":15,"title":{},"description":{"0":{},"4":{},"5":{}}}],["close",{"_index":73,"title":{},"description":{"1":{},"2":{},"4":{},"5":{}}}],["code",{"_index":19,"title":{"40":{}},"description":{"0":{},"40":{}}}],["collect",{"_index":94,"title":{"2":{},"7":{},"21":{},"22":{},"35":{},"36":{},"46":{}},"description":{"4":{},"5":{},"7":{},"9":{},"23":{},"46":{},"59":{},"62":{},"63":{}}}],["come",{"_index":350,"title":{},"description":{"59":{}}}],["command",{"_index":144,"title":{},"description":{"5":{},"7":{},"8":{},"29":{}}}],["commun",{"_index":57,"title":{},"description":{"0":{}}}],["config/azim_int",{"_index":209,"title":{},"description":{"25":{},"26":{}}}],["config/bragg_integr",{"_index":191,"title":{},"description":{"13":{},"14":{}}}],["config/dark_mask",{"_index":265,"title":{},"description":{"35":{},"36":{}}}],["config/detector",{"_index":185,"title":{},"description":{"9":{},"10":{}}}],["config/file_writ",{"_index":192,"title":{},"description":{"15":{},"16":{}}}],["config/image_format",{"_index":199,"title":{},"description":{"19":{},"20":{}}}],["config/image_format/convers",{"_index":204,"title":{},"description":{"22":{}}}],["config/image_format/raw",{"_index":201,"title":{},"description":{"21":{}}}],["config/index",{"_index":189,"title":{},"description":{"11":{},"12":{}}}],["config/instru",{"_index":195,"title":{},"description":{"17":{},"18":{}}}],["config/internal_generator_imag",{"_index":222,"title":{},"description":{"27":{}}}],["config/internal_generator_image.tiff",{"_index":224,"title":{},"description":{"28":{}}}],["config/mask",{"_index":297,"title":{},"description":{"48":{}}}],["config/mask.tiff",{"_index":325,"title":{},"description":{"51":{}}}],["config/roi",{"_index":281,"title":{},"description":{"43":{},"44":{}}}],["config/select_detector",{"_index":235,"title":{},"description":{"29":{},"30":{}}}],["config/spot_find",{"_index":207,"title":{},"description":{"23":{},"24":{}}}],["config/user_mask",{"_index":301,"title":{},"description":{"49":{},"50":{}}}],["config/user_mask.tiff",{"_index":326,"title":{},"description":{"52":{},"53":{}}}],["config/zeromq_metadata",{"_index":257,"title":{},"description":{"33":{},"34":{}}}],["config/zeromq_preview",{"_index":254,"title":{},"description":{"31":{},"32":{}}}],["configur",{"_index":179,"title":{"9":{},"10":{},"12":{},"14":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"35":{}},"description":{"30":{}}}],["connect",{"_index":141,"title":{},"description":{"4":{},"5":{}}}],["consist",{"_index":232,"title":{},"description":{"29":{}}}],["contain",{"_index":246,"title":{},"description":{"31":{},"33":{},"58":{},"59":{}}}],["control",{"_index":226,"title":{},"description":{"29":{}}}],["convers",{"_index":203,"title":{"22":{}},"description":{"50":{},"53":{}}}],["convert",{"_index":313,"title":{},"description":{"50":{},"53":{}}}],["coordin",{"_index":220,"title":{},"description":{"27":{},"28":{},"49":{},"50":{},"52":{},"53":{}}}],["copyleft",{"_index":7,"title":{},"description":{"0":{}}}],["cover",{"_index":256,"title":{},"description":{"33":{}}}],["cpu",{"_index":159,"title":{},"description":{"7":{}}}],["current",{"_index":96,"title":{"2":{},"39":{},"40":{}},"description":{"7":{}}}],["custom",{"_index":354,"title":{"60":{}},"description":{}}],["dark",{"_index":95,"title":{"2":{},"35":{},"36":{}},"description":{}}],["data",{"_index":64,"title":{"1":{},"7":{},"21":{},"22":{},"24":{},"35":{},"36":{},"39":{},"40":{},"46":{},"56":{}},"description":{"3":{},"4":{},"5":{},"7":{},"8":{},"23":{},"31":{},"33":{},"37":{},"46":{},"59":{},"62":{},"63":{}}}],["dataset",{"_index":345,"title":{},"description":{"58":{}}}],["deactiv",{"_index":172,"title":{},"description":{"8":{}}}],["dectri",{"_index":260,"title":{},"description":{"35":{}}}],["default",{"_index":109,"title":{},"description":{"3":{}}}],["definit",{"_index":3,"title":{"43":{},"44":{}},"description":{"0":{}}}],["depend",{"_index":221,"title":{},"description":{"27":{},"28":{}}}],["deriv",{"_index":47,"title":{},"description":{"0":{}}}],["detector",{"_index":63,"title":{"1":{},"2":{},"3":{},"6":{},"8":{},"9":{},"10":{},"29":{},"30":{},"42":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{}},"description":{"1":{},"2":{},"3":{},"4":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"21":{},"22":{},"25":{},"27":{},"28":{},"29":{},"30":{},"35":{},"42":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{}}}],["detector/statu",{"_index":279,"title":{},"description":{"42":{}}}],["develop",{"_index":37,"title":{},"description":{"0":{}}}],["devic",{"_index":267,"title":{"38":{}},"description":{}}],["distribut",{"_index":22,"title":{},"description":{"0":{}}}],["doesn't",{"_index":337,"title":{"56":{}},"description":{}}],["don't",{"_index":316,"title":{},"description":{"50":{},"53":{}}}],["done",{"_index":93,"title":{"5":{}},"description":{"1":{},"2":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"35":{}}}],["dure",{"_index":76,"title":{},"description":{"1":{},"9":{},"63":{}}}],["e.g",{"_index":346,"title":{},"description":{"58":{}}}],["each",{"_index":287,"title":{},"description":{"47":{}}}],["effect",{"_index":169,"title":{},"description":{"7":{},"9":{},"31":{}}}],["eiger",{"_index":263,"title":{},"description":{"35":{}}}],["ensur",{"_index":92,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{}}}],["error",{"_index":70,"title":{},"description":{"1":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"21":{},"22":{},"35":{}}}],["etc",{"_index":46,"title":{},"description":{"0":{}}}],["event",{"_index":275,"title":{"40":{}},"description":{"40":{}}}],["exampl",{"_index":302,"title":{},"description":{"50":{},"53":{}}}],["except",{"_index":25,"title":{},"description":{"0":{}}}],["execut",{"_index":83,"title":{},"description":{"1":{},"4":{},"5":{},"9":{}}}],["expect",{"_index":318,"title":{},"description":{"50":{},"53":{}}}],["experiment",{"_index":347,"title":{},"description":{"58":{}}}],["explicitli",{"_index":38,"title":{},"description":{"0":{}}}],["extend",{"_index":138,"title":{},"description":{"4":{},"5":{}}}],["extern",{"_index":127,"title":{},"description":{"4":{},"5":{}}}],["few",{"_index":85,"title":{},"description":{"1":{}}}],["file",{"_index":10,"title":{"15":{},"16":{}},"description":{"0":{}}}],["find",{"_index":206,"title":{"23":{}},"description":{"50":{},"53":{}}}],["finish",{"_index":143,"title":{},"description":{"5":{},"7":{}}}],["float",{"_index":336,"title":{"56":{}},"description":{}}],["format",{"_index":198,"title":{"19":{},"20":{},"21":{},"22":{},"54":{},"56":{},"58":{},"59":{},"60":{},"61":{}},"description":{}}],["fpga",{"_index":152,"title":{"27":{},"28":{},"38":{}},"description":{"7":{},"27":{},"28":{}}}],["fpga_statu",{"_index":268,"title":{},"description":{"38":{}}}],["frame",{"_index":156,"title":{},"description":{"7":{}}}],["full",{"_index":202,"title":{"22":{},"57":{}},"description":{"48":{},"51":{},"59":{}}}],["function",{"_index":88,"title":{},"description":{"1":{},"2":{}}}],["gap",{"_index":315,"title":{},"description":{"50":{},"53":{}}}],["gcc",{"_index":33,"title":{},"description":{"0":{}}}],["gener",{"_index":13,"title":{"27":{},"28":{},"45":{},"55":{},"56":{}},"description":{"0":{},"6":{},"27":{},"28":{},"31":{},"33":{}}}],["geometri",{"_index":348,"title":{},"description":{"58":{}}}],["given",{"_index":162,"title":{},"description":{"7":{}}}],["goe",{"_index":362,"title":{},"description":{"63":{}}}],["good",{"_index":300,"title":{},"description":{"49":{},"50":{},"52":{},"53":{}}}],["gpl",{"_index":6,"title":{},"description":{"0":{}}}],["gpl-3.0",{"_index":5,"title":{},"description":{"0":{}}}],["gracefulli",{"_index":165,"title":{},"description":{"7":{}}}],["happen",{"_index":213,"title":{},"description":{"27":{},"28":{}}}],["header",{"_index":32,"title":{},"description":{"0":{}}}],["here",{"_index":243,"title":{},"description":{"31":{},"33":{}}}],["high",{"_index":173,"title":{},"description":{"8":{}}}],["hour",{"_index":104,"title":{},"description":{"2":{}}}],["http",{"_index":249,"title":{},"description":{"31":{},"33":{}}}],["i.",{"_index":180,"title":{},"description":{"9":{},"53":{}}}],["id",{"_index":231,"title":{"39":{}},"description":{"29":{},"39":{}}}],["idl",{"_index":100,"title":{},"description":{"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"21":{},"22":{},"25":{},"27":{},"28":{},"35":{},"50":{},"51":{},"53":{}}}],["ignor",{"_index":250,"title":{},"description":{"31":{},"33":{},"50":{},"53":{}}}],["imag",{"_index":196,"title":{"19":{},"20":{},"27":{},"28":{},"41":{},"59":{},"60":{},"61":{},"62":{},"63":{}},"description":{"27":{},"28":{},"33":{},"39":{},"53":{},"59":{},"62":{},"63":{}}}],["image.cbor",{"_index":367,"title":{},"description":{"63":{}}}],["image_buffer/clear",{"_index":359,"title":{},"description":{"62":{}}}],["image_buffer/image.cbor",{"_index":352,"title":{},"description":{"59":{}}}],["image_buffer/image.jpeg",{"_index":355,"title":{},"description":{"60":{}}}],["image_buffer/image.tiff",{"_index":356,"title":{},"description":{"61":{}}}],["image_buffer/start.cbor",{"_index":349,"title":{},"description":{"58":{}}}],["image_buffer/statu",{"_index":368,"title":{},"description":{"63":{}}}],["image_pusher/statu",{"_index":278,"title":{},"description":{"41":{}}}],["immedi",{"_index":124,"title":{},"description":{"3":{}}}],["implement",{"_index":16,"title":{},"description":{"0":{}}}],["impos",{"_index":54,"title":{},"description":{"0":{}}}],["inact",{"_index":69,"title":{},"description":{"1":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"21":{},"22":{},"25":{},"29":{},"35":{}}}],["includ",{"_index":360,"title":{},"description":{"63":{}}}],["indefinit",{"_index":133,"title":{},"description":{"4":{},"5":{}}}],["index",{"_index":187,"title":{"11":{},"12":{}},"description":{}}],["inform",{"_index":151,"title":{"56":{}},"description":{"7":{}}}],["initi",{"_index":62,"title":{"1":{},"49":{},"52":{}},"description":{"1":{},"5":{},"48":{}}}],["instead",{"_index":80,"title":{},"description":{"1":{}}}],["instrument",{"_index":193,"title":{"17":{},"18":{}},"description":{}}],["integ",{"_index":216,"title":{},"description":{"27":{},"28":{},"53":{}}}],["integr",{"_index":106,"title":{"13":{},"14":{},"25":{},"26":{},"56":{}},"description":{"2":{},"50":{},"53":{}}}],["intend",{"_index":49,"title":{},"description":{"0":{}}}],["interact",{"_index":18,"title":{},"description":{"0":{}}}],["interfac",{"_index":43,"title":{},"description":{"0":{},"1":{}}}],["intern",{"_index":212,"title":{"27":{},"28":{}},"description":{"27":{},"28":{}}}],["ioctl",{"_index":45,"title":{},"description":{"0":{}}}],["jfjoch_brok",{"_index":370,"title":{"64":{}},"description":{}}],["jpeg",{"_index":353,"title":{"60":{}},"description":{}}],["jungfrau",{"_index":99,"title":{},"description":{"2":{},"42":{}}}],["jungfraujoch",{"_index":130,"title":{"37":{},"55":{},"56":{},"64":{}},"description":{"4":{},"29":{},"31":{},"33":{},"62":{},"63":{}}}],["kernel",{"_index":36,"title":{},"description":{"0":{}}}],["kernel'",{"_index":29,"title":{},"description":{"0":{}}}],["last",{"_index":285,"title":{},"description":{"46":{},"62":{}}}],["latest",{"_index":351,"title":{},"description":{"59":{}}}],["latter",{"_index":314,"title":{},"description":{"50":{},"53":{}}}],["librari",{"_index":35,"title":{},"description":{"0":{}}}],["licens",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["limit",{"_index":340,"title":{"56":{}},"description":{}}],["linux",{"_index":28,"title":{},"description":{"0":{}}}],["list",{"_index":230,"title":{"30":{}},"description":{"29":{}}}],["load",{"_index":210,"title":{"27":{},"28":{}},"description":{"27":{},"28":{}}}],["long",{"_index":105,"title":{},"description":{"2":{}}}],["make",{"_index":163,"title":{},"description":{"7":{}}}],["mask",{"_index":259,"title":{"35":{},"36":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{}},"description":{"48":{},"49":{},"50":{},"51":{},"52":{},"53":{}}}],["mean",{"_index":295,"title":{},"description":{"48":{},"51":{}}}],["mechan",{"_index":61,"title":{},"description":{"0":{}}}],["mere",{"_index":42,"title":{},"description":{"0":{}}}],["messag",{"_index":239,"title":{"58":{},"59":{}},"description":{"31":{},"33":{}}}],["metadata",{"_index":194,"title":{"17":{},"18":{},"33":{},"34":{}},"description":{"33":{},"58":{},"59":{}}}],["minut",{"_index":86,"title":{},"description":{"1":{}}}],["misbehav",{"_index":306,"title":{},"description":{"50":{},"53":{}}}],["mode",{"_index":308,"title":{},"description":{"50":{},"53":{}}}],["modul",{"_index":312,"title":{},"description":{"50":{},"53":{}}}],["module/storag",{"_index":288,"title":{},"description":{"47":{}}}],["moment",{"_index":261,"title":{},"description":{"35":{}}}],["more",{"_index":363,"title":{},"description":{"63":{}}}],["multipl",{"_index":227,"title":{},"description":{"29":{}}}],["need",{"_index":90,"title":{},"description":{"1":{},"2":{},"3":{},"50":{},"53":{}}}],["network",{"_index":59,"title":{},"description":{"0":{},"1":{},"7":{}}}],["new",{"_index":183,"title":{},"description":{"9":{}}}],["number",{"_index":217,"title":{},"description":{"27":{},"28":{}}}],["nxmx",{"_index":293,"title":{},"description":{"48":{},"50":{},"51":{},"53":{}}}],["on",{"_index":89,"title":{},"description":{"1":{},"2":{},"3":{},"9":{},"29":{}}}],["onc",{"_index":102,"title":{},"description":{"2":{}}}],["openapi",{"_index":14,"title":{},"description":{"0":{}}}],["oper",{"_index":74,"title":{},"description":{"1":{},"2":{},"9":{},"35":{},"63":{}}}],["option",{"_index":252,"title":{},"description":{"31":{}}}],["output",{"_index":197,"title":{"19":{},"20":{}},"description":{}}],["pedest",{"_index":79,"title":{"54":{}},"description":{"1":{},"2":{},"5":{},"7":{},"9":{}}}],["per",{"_index":103,"title":{},"description":{"2":{}}}],["period",{"_index":134,"title":{},"description":{"4":{},"5":{}}}],["pixel",{"_index":291,"title":{},"description":{"48":{},"49":{},"50":{},"51":{},"52":{},"53":{}}}],["plot",{"_index":334,"title":{"55":{},"56":{}},"description":{}}],["point",{"_index":264,"title":{},"description":{"35":{}}}],["possibl",{"_index":139,"title":{},"description":{"4":{},"5":{},"35":{}}}],["post",{"_index":78,"title":{},"description":{"1":{},"2":{}}}],["power",{"_index":178,"title":{},"description":{"8":{}}}],["prepar",{"_index":170,"title":{"8":{}},"description":{}}],["preview",{"_index":238,"title":{"31":{},"32":{},"60":{},"61":{}},"description":{"31":{}}}],["preview/pedestal.tiff",{"_index":332,"title":{},"description":{"54":{}}}],["preview/plot",{"_index":335,"title":{},"description":{"55":{}}}],["preview/plot.bin",{"_index":341,"title":{},"description":{"56":{}}}],["procedur",{"_index":135,"title":{},"description":{"4":{},"5":{},"9":{}}}],["process",{"_index":158,"title":{"24":{}},"description":{"7":{}}}],["program",{"_index":41,"title":{},"description":{"0":{}}}],["provid",{"_index":136,"title":{"56":{}},"description":{"4":{},"5":{},"29":{},"47":{}}}],["provis",{"_index":8,"title":{},"description":{"0":{}}}],["psi",{"_index":262,"title":{},"description":{"35":{}}}],["pub",{"_index":255,"title":{},"description":{"33":{}}}],["puls",{"_index":270,"title":{"39":{}},"description":{"39":{}}}],["pusher",{"_index":277,"title":{"41":{}},"description":{}}],["put",{"_index":251,"title":{},"description":{"31":{},"33":{}}}],["raw",{"_index":200,"title":{"21":{},"56":{}},"description":{"50":{},"53":{}}}],["raw/convert",{"_index":219,"title":{},"description":{"27":{},"28":{}}}],["readi",{"_index":113,"title":{},"description":{"3":{},"4":{}}}],["recommend",{"_index":77,"title":{},"description":{"1":{},"2":{}}}],["reconfigur",{"_index":75,"title":{},"description":{"1":{}}}],["record",{"_index":273,"title":{},"description":{"39":{}}}],["regardless",{"_index":55,"title":{},"description":{"0":{}}}],["region",{"_index":307,"title":{},"description":{"50":{},"53":{}}}],["region-of-interest",{"_index":229,"title":{},"description":{"29":{}}}],["reiniti",{"_index":234,"title":{},"description":{"29":{}}}],["replac",{"_index":365,"title":{},"description":{"63":{}}}],["request",{"_index":121,"title":{},"description":{"3":{},"31":{},"33":{}}}],["requir",{"_index":21,"title":{},"description":{"0":{},"4":{},"5":{},"27":{},"28":{},"29":{}}}],["respons",{"_index":233,"title":{},"description":{"29":{}}}],["result",{"_index":284,"title":{"57":{}},"description":{"46":{}}}],["result/scan",{"_index":343,"title":{},"description":{"57":{}}}],["retri",{"_index":142,"title":{},"description":{"4":{},"5":{}}}],["return",{"_index":123,"title":{"39":{},"40":{}},"description":{"3":{},"39":{},"40":{}}}],["roi",{"_index":280,"title":{"43":{},"44":{}},"description":{}}],["run",{"_index":101,"title":{"4":{},"7":{}},"description":{"2":{},"3":{},"5":{},"7":{},"23":{},"62":{},"63":{}}}],["runtim",{"_index":34,"title":{},"description":{"0":{}}}],["safeti",{"_index":140,"title":{},"description":{"4":{},"5":{}}}],["save",{"_index":184,"title":{},"description":{"9":{}}}],["scan",{"_index":342,"title":{"57":{}},"description":{}}],["script",{"_index":128,"title":{},"description":{"4":{},"5":{}}}],["see",{"_index":292,"title":{},"description":{"48":{},"51":{}}}],["select",{"_index":225,"title":{"29":{}},"description":{"30":{}}}],["send",{"_index":149,"title":{"6":{},"56":{}},"description":{}}],["sent",{"_index":160,"title":{},"description":{"7":{}}}],["separ",{"_index":289,"title":{},"description":{"47":{}}}],["server",{"_index":132,"title":{},"description":{"4":{},"5":{}}}],["set",{"_index":118,"title":{"11":{},"13":{},"15":{},"16":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"60":{}},"description":{"3":{},"9":{},"27":{},"28":{},"29":{},"31":{},"33":{}}}],["shadow",{"_index":305,"title":{},"description":{"50":{},"53":{}}}],["shutter",{"_index":72,"title":{},"description":{"1":{},"2":{}}}],["sign",{"_index":330,"title":{},"description":{"53":{}}}],["similar",{"_index":26,"title":{},"description":{"0":{}}}],["single-channel",{"_index":327,"title":{},"description":{"53":{}}}],["size",{"_index":218,"title":{},"description":{"27":{},"28":{}}}],["slot",{"_index":364,"title":{},"description":{"63":{}}}],["socket",{"_index":242,"title":{"34":{}},"description":{"31":{},"33":{}}}],["socket_address",{"_index":247,"title":{},"description":{"31":{},"33":{}}}],["soft",{"_index":150,"title":{"6":{}},"description":{"6":{}}}],["soft/ttl",{"_index":115,"title":{},"description":{"3":{}}}],["softwar",{"_index":148,"title":{},"description":{"5":{}}}],["sole",{"_index":12,"title":{},"description":{"0":{}}}],["specif",{"_index":52,"title":{},"description":{"0":{}}}],["spirit",{"_index":27,"title":{},"description":{"0":{}}}],["spot",{"_index":205,"title":{"23":{}},"description":{"50":{},"53":{}}}],["stack",{"_index":311,"title":{},"description":{"50":{},"53":{}}}],["stage",{"_index":155,"title":{},"description":{"7":{},"63":{}}}],["standard",{"_index":294,"title":{},"description":{"48":{},"51":{}}}],["start",{"_index":108,"title":{"3":{},"58":{}},"description":{"3":{}}}],["state",{"_index":39,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"21":{},"22":{},"27":{},"28":{},"29":{},"35":{},"50":{},"51":{},"53":{}}}],["statist",{"_index":283,"title":{"45":{},"46":{},"47":{}},"description":{"45":{},"47":{}}}],["statistics/calibr",{"_index":290,"title":{},"description":{"47":{}}}],["statistics/data_collect",{"_index":286,"title":{},"description":{"46":{}}}],["statu",{"_index":266,"title":{"37":{},"38":{},"41":{},"42":{},"63":{}},"description":{"37":{},"42":{},"63":{}}}],["stop",{"_index":154,"title":{},"description":{"7":{},"50":{},"53":{}}}],["storag",{"_index":81,"title":{},"description":{"1":{}}}],["store",{"_index":321,"title":{},"description":{"50":{},"53":{}}}],["stream",{"_index":240,"title":{},"description":{"31":{},"33":{}}}],["structur",{"_index":245,"title":{},"description":{"31":{},"33":{}}}],["sub",{"_index":241,"title":{},"description":{"31":{}}}],["subject",{"_index":20,"title":{},"description":{"0":{}}}],["sure",{"_index":164,"title":{},"description":{"7":{}}}],["switch",{"_index":167,"title":{},"description":{"7":{}}}],["synchron",{"_index":147,"title":{},"description":{"5":{}}}],["syscal",{"_index":44,"title":{},"description":{"0":{}}}],["take",{"_index":166,"title":{},"description":{"7":{}}}],["term",{"_index":23,"title":{},"description":{"0":{}}}],["through",{"_index":58,"title":{},"description":{"0":{}}}],["tiff",{"_index":223,"title":{"28":{},"51":{},"52":{},"54":{},"61":{}},"description":{"28":{},"53":{}}}],["till",{"_index":129,"title":{},"description":{"4":{},"5":{}}}],["time",{"_index":84,"title":{},"description":{"1":{},"2":{},"4":{},"5":{},"7":{}}}],["timeout",{"_index":137,"title":{},"description":{"4":{},"5":{}}}],["transmit",{"_index":338,"title":{"56":{}},"description":{}}],["trigger",{"_index":116,"title":{"6":{}},"description":{"3":{},"6":{}}}],["true",{"_index":120,"title":{},"description":{"3":{}}}],["turn",{"_index":171,"title":{"8":{}},"description":{"8":{},"62":{}}}],["two",{"_index":66,"title":{},"description":{"1":{}}}],["under",{"_index":4,"title":{},"description":{"0":{}}}],["unsign",{"_index":320,"title":{},"description":{"50":{},"53":{}}}],["until",{"_index":112,"title":{},"description":{"3":{}}}],["updat",{"_index":97,"title":{},"description":{"2":{}}}],["upload",{"_index":282,"title":{"44":{},"50":{},"53":{}},"description":{"50":{},"53":{}}}],["us",{"_index":11,"title":{"56":{},"60":{}},"description":{"0":{},"1":{},"2":{},"3":{},"8":{},"30":{},"50":{},"53":{}}}],["user",{"_index":40,"title":{"49":{},"50":{},"52":{},"53":{}},"description":{"0":{},"49":{},"50":{},"52":{},"53":{}}}],["userspac",{"_index":31,"title":{},"description":{"0":{}}}],["valid",{"_index":331,"title":{},"description":{"53":{}}}],["valu",{"_index":296,"title":{"56":{}},"description":{"48":{},"50":{},"51":{},"53":{}}}],["version",{"_index":369,"title":{"64":{}},"description":{"64":{}}}],["via",{"_index":248,"title":{},"description":{"31":{},"33":{}}}],["volatil",{"_index":361,"title":{},"description":{"63":{}}}],["voltag",{"_index":174,"title":{},"description":{"8":{}}}],["wait",{"_index":126,"title":{"4":{},"5":{}},"description":{}}],["wait_till_don",{"_index":91,"title":{},"description":{"1":{},"2":{},"5":{}}}],["wait_until_run",{"_index":125,"title":{},"description":{"3":{},"4":{}}}],["web",{"_index":131,"title":{},"description":{"4":{},"5":{}}}],["well",{"_index":324,"title":{},"description":{"50":{},"53":{}}}],["whether",{"_index":56,"title":{},"description":{"0":{}}}],["wider",{"_index":51,"title":{},"description":{"0":{}}}],["without",{"_index":53,"title":{},"description":{"0":{}}}],["work",{"_index":48,"title":{},"description":{"0":{}}}],["writer",{"_index":161,"title":{"15":{},"16":{}},"description":{"7":{}}}],["x-axi",{"_index":339,"title":{"56":{}},"description":{}}],["x-ray",{"_index":71,"title":{},"description":{"1":{},"2":{},"9":{}}}],["xfel",{"_index":269,"title":{"39":{},"40":{}},"description":{"39":{},"40":{}}}],["xfel/event_cod",{"_index":276,"title":{},"description":{"40":{}}}],["xfel/pulse_id",{"_index":274,"title":{},"description":{"39":{}}}],["zeromq",{"_index":237,"title":{"31":{},"32":{},"33":{},"34":{}},"description":{"31":{},"33":{}}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.3","info":{"title":"Jungfraujoch","description":"API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland).\nJungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU.\nJungfraujoch uses FPGA boards to acquire data at high data rates.\n\n# License Clarification\n\nWhile this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply**\nwhen this file is used solely to generate OpenAPI clients or when implementing applications that\ninteract with the API. Generated client code and applications using this API definition are not\nsubject to the GPL license requirements and may be distributed under terms of your choosing.\n\nThis exception is similar in spirit to the Linux Kernel's approach to userspace API headers and\nthe GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that\nuser programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not\nderivative works of the kernel and are not subject to the terms of the GPL.\n\nThis exception is intended to allow wider use of this API specification without imposing GPL\nrequirements on applications that merely interact with the API, regardless of whether they\ncommunicate through network calls or other mechanisms.\n","version":"1.0.0-rc.166","contact":{"name":"Filip Leonarski (Paul Scherrer Institute)","email":"filip.leonarski@psi.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.html"}},"servers":[{"url":"http://localhost:5232","description":"Test Jungfraujoch system"}],"components":{"parameters":{"binning":{"in":"query","name":"binning","required":false,"schema":{"default":1,"type":"integer"},"description":"Binning of frames for the plot (0 = default binning)"},"experimental_coord":{"in":"query","name":"experimental_coord","required":false,"schema":{"type":"boolean","default":false},"description":"If measurement has goniometer axis defined, plot X-axis will represent rotation angle\nIf measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value\nFor still measurement the number is ignored\n"},"azint_unit":{"in":"query","name":"azint_unit","required":false,"schema":{"type":"string","enum":["Q_recipA","d_A","two_theta_deg"],"default":"Q_recipA"},"description":"Unit used for azim int.\n"},"fill_value":{"in":"query","name":"fill","required":false,"schema":{"type":"number","format":"float"},"description":"Fill value for elements that were missed during data collection\n"},"plot_type":{"in":"query","name":"type","required":true,"description":"Type of requested plot","schema":{"type":"string","enum":["bkg_estimate","azint","azint_1d","spot_count","spot_count_low_res","spot_count_indexed","spot_count_ice","indexing_rate","indexing_lattice_count","indexing_unit_cell_length","indexing_unit_cell_angle","profile_radius","mosaicity","b_factor","error_pixels","saturated_pixels","image_collection_efficiency","receiver_delay","receiver_free_send_buf","strong_pixels","roi_sum","roi_mean","roi_max_count","roi_pixels","roi_weighted_x","roi_weighted_y","packets_received","max_pixel_value","resolution_estimate","pixel_sum","processing_time","beam_center_x","beam_center_y","integrated_reflections","image_scale_factor","image_scale_cc","compression_ratio","ice_ring_score"]}},"roi":{"in":"query","name":"roi","required":false,"schema":{"type":"string","minLength":1},"description":"Name of ROI for which plot is requested"},"image_id":{"in":"query","name":"id","required":false,"schema":{"type":"integer","format":"int64","default":-1,"minimum":-2},"description":"Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer"},"saturation":{"in":"query","name":"saturation","required":false,"schema":{"type":"number","format":"float","minimum":-32767,"maximum":32767},"description":"Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used"},"background":{"in":"query","name":"background","required":false,"schema":{"type":"number","format":"float","default":0,"minimum":-32767,"maximum":32767},"description":"Background value to set contrast in the preview image"},"show_spots":{"in":"query","name":"show_spots","schema":{"type":"boolean","default":true},"description":"Show spot finding results on the image"},"show_predictions":{"in":"query","name":"show_predictions","schema":{"type":"boolean","default":false},"description":"Show Bragg spot predictions on the image (if available for the image)"},"show_beam_center":{"in":"query","name":"show_beam_center","schema":{"type":"boolean","default":true},"description":"Show beam center on the image"},"show_roi":{"in":"query","name":"show_roi","schema":{"type":"boolean","default":false},"description":"Show ROI areas on the image"},"jpeg_quality":{"in":"query","name":"jpeg_quality","description":"Quality of JPEG image (100 - highest; 0 - lowest)","schema":{"type":"integer","format":"int64","default":100,"minimum":0,"maximum":100}},"show_user_mask":{"in":"query","name":"show_user_mask","schema":{"type":"boolean","default":false},"description":"Show user mask"},"resolution_ring":{"in":"query","name":"show_res_ring","description":"Show resolution ring, provided in Angstrom","schema":{"type":"number","format":"float","default":0.1,"minimum":0.1,"maximum":100}},"resolution_estimate":{"in":"query","name":"show_res_est","description":"Show resolution estimation as a ring","schema":{"type":"boolean","default":false}},"color_scale":{"in":"query","name":"color","description":"Color scale for preview image","schema":{"type":"string","enum":["indigo","viridis","bw","wb","green","heat","magma","inferno"],"default":"indigo"}}},"schemas":{"grid_scan":{"description":"Definition of a grid scan. Combine it with a goniometer axis to state the angle the spindle\nstood at: send `goniometer` with `step` 0 and the `start` angle of the grid scan, and that\nangle is written per image into the NXmx sample transformation chain. Without one the\nspindle is recorded at 0, which says that nobody stated an angle rather than that the\nspindle stood at 0.\n","type":"object","required":["n_fast","step_x_um","step_y_um"],"properties":{"n_fast":{"type":"integer","format":"int64","minimum":1,"example":20,"description":"Number of elements in the fast direction"},"step_x_um":{"type":"number","format":"float","example":5,"description":"Step in grid along the fast direction. Can be negative. \nPositive number: left to right\nNegative number: right to left\n"},"step_y_um":{"type":"number","format":"float","example":-3,"description":"Step in grid along the slow direction. Can be negative. \nPositive number: top to bottom\nNegative number: bottom to top\n"},"vertical":{"type":"boolean","default":false,"description":"If disabled: fast direction = X, slow direction = Y\nIf enabled: fast direction = Y, slow direction = X\n"},"snake":{"type":"boolean","default":false,"description":"Flip fast direction for every second row\n"}}},"rotation_axis":{"description":"Definition of a crystal rotation axis","type":"object","required":["step","vector"],"properties":{"name":{"type":"string","default":"omega","minLength":1,"description":"Name of rotation axis (e.g., omega, phi)"},"step":{"type":"number","format":"float","example":0.1,"description":"Angle step (per image) in degrees. 0 for an axis that does not turn: the axis then\nrecords the angle the spindle stood at, which is how a grid scan or a set of stills\nstates its head position.\n"},"start":{"type":"number","format":"float","example":50,"description":"Start angle in degrees","default":0},"vector":{"type":"array","description":"Rotation axis","example":[1,0,0],"items":{"type":"number","format":"float"},"minItems":3,"maxItems":3},"helical_step_um":{"type":"array","description":"Translation (per image) for helical scan","example":[-5,-2,0],"items":{"type":"number","format":"float"},"minItems":3,"maxItems":3},"screening_wedge_deg":{"type":"number","format":"float","description":"Wedge angle value; used if rotation per image is smaller than increment between images (so particularly in screening)"}}},"indexing_algorithm":{"type":"string","description":"Selection of an indexing algorithm used by Jungfraujoch\n","enum":["FFBIDX","FFT","FFTW","Auto","None"],"default":"FFBIDX"},"geom_refinement_algorithm":{"type":"string","description":"Selection of an post-indexing least-square diffraction geometry refinement algorithm used by Jungfraujoch.\nBeamCenter - This option is refining both beam center and lattice (restricted to a chosen/detected Bravais lattice).\nOrientationOnly - This option is refining only orientation of the lattice.\nFlex - Tries all per-image refinements and keeps whichever indexes the most spots, letting the pipeline decide (the rugnux flex mode).\n","enum":["BeamCenter","OrientationOnly","Flex","None"]},"integration_model":{"type":"string","description":"Bragg spot integration model.\nProfileGaussian - profile fit with a measured-width Gaussian (Kabsch-style), the default; more\n  accurate intensities than box summation.\nProfileEmpirical - profile fit with a per-resolution-shell empirical profile learned from strong spots.\nBoxSum - classical uniform box summation minus a ring-mean background; the simpler, faster fallback.\n","enum":["ProfileGaussian","ProfileEmpirical","BoxSum"],"default":"ProfileGaussian"},"dataset_settings":{"type":"object","required":["beam_x_pxl","beam_y_pxl","detector_distance_mm","incident_energy_keV"],"properties":{"images_per_trigger":{"type":"integer","format":"int64","minimum":1,"default":1,"description":"For standard synchrotron data collection - this is number of images collected per one TTL trigger\nFor XFEL (pulsed source) - this number is ignored and set to 1\nFor storage cell mode - this number is ignored and set to number of storage cells\n"},"ntrigger":{"type":"integer","format":"int64","default":1,"minimum":1,"description":"Number of TTL trigger that the detector is expected to receive during data collection\n"},"image_time_us":{"type":"integer","format":"int64","minimum":0,"description":"Image time. \nIf not provided (or zero value) the frame time is assumed as default.\nFor JUNGFRAU image time must be multiple of frame time and max value is 256 * frame_time.            \nIn XFEL mode: summation happens for frames collected with multiple triggers.\nIgnored for storage cells and if raw data are saved.\n"},"beam_x_pxl":{"type":"number","format":"float","description":"/entry/detector/beam_center_x in NXmx\nBeam center in X direction [pixels]\n"},"beam_y_pxl":{"type":"number","format":"float","description":"/entry/detector/beam_center_y in NXmx\nBeam center in X direction [pixels]\n"},"detector_distance_mm":{"type":"number","format":"float","minimum":0,"description":"/entry/detector/distance in NXmx Detector distance [mm]"},"incident_energy_keV":{"type":"number","format":"float","minimum":0.001,"maximum":500,"description":"Used to calculate /entry/beam/incident_wavelength in NXmx\nIncident particle (photon, electron) energy in keV\n"},"file_prefix":{"type":"string","default":"","description":"Prefix for filenames. If left empty, no file will be saved."},"images_per_file":{"type":"integer","format":"int64","minimum":1,"description":"Number of images in a single HDF5 data file, taken literally when given.\nIf omitted, it is chosen from the acquisition: a rotation sweep of at most 20000 images\ngoes into a single data file, so the dataset stays readable by programs that follow only\nthe first data file of a legacy master; a grid scan is split on a whole number of fast-axis\nrows; anything else (stills, serial) uses 1000.\n"},"space_group_number":{"type":"integer","format":"int64","minimum":1,"maximum":230,"description":"Number of space group for the crystal. Currently used solely as metadata, not relevant for image processing done in Jungfraujoch."},"sample_name":{"type":"string","default":"","description":"/entry/sample/name in NXmx\nSample name\n"},"compression":{"type":"string","enum":["bslz4","bszstd","bszstd_rle","bszstd_rlehuf","none"],"default":"bslz4","description":"Compression type for the images transferred over ZeroMQ and saved to HDF5 file.\n"},"total_flux":{"type":"number","format":"float","description":"/entry/beam/total_flux in NXmx\nFlux incident on beam plane in photons per second. In other words this is the flux integrated over area. [photons/s]\n"},"transmission":{"type":"number","format":"float","minimum":0,"maximum":1,"description":"/entry/instrument/attenuator/attenuator_transmission\nTransmission of attenuator (filter) [no units]\n"},"beam_size_x_um":{"type":"number","format":"float","minimum":0,"description":"First element of /entry/instrument/beam/incident_beam_size in NXmx\nHorizontal size of the X-ray beam where it meets the sample - the FWHM of a focused beam,\nthe full width of a slit-defined one. [um]\n"},"beam_size_y_um":{"type":"number","format":"float","minimum":0,"description":"Second element of /entry/instrument/beam/incident_beam_size in NXmx\nVertical size of the X-ray beam where it meets the sample. [um]\n"},"goniometer":{"$ref":"#/components/schemas/rotation_axis"},"grid_scan":{"$ref":"#/components/schemas/grid_scan"},"header_appendix":{"description":"Header appendix, added as user_data/user to start ZeroMQ message (can be any valid JSON)\nIn general, it is not saved in HDF5 file.\n\nHowever, if values are placed in \"hdf5\" object, `jfjoch_writer` will write them in /entry/user of the HDF5 file. \nThis applies solely to string and number (double floating-point). No arrays/sub-objects is allowed.\nFor example {\"hdf5\": {\"val1\":1, \"val2\":\"xyz\"}}, will write /entry/user/val1 and /entry/user/val2.\n"},"image_appendix":{"description":"Image appendix, added as user_data to image ZeroMQ message (can be any valid JSON)\nNot saved in HDF5 file\n"},"data_reduction_factor_serialmx":{"type":"number","format":"float","default":1,"minimum":0,"maximum":1,"description":"Rate at which non-indexed images are accepted to be forwarded to writer. \nValue of 1.0 (default) means that all images are written.\nValues below zero mean that non-indexed images will be accepted with a given probability.\n"},"pixel_value_low_threshold":{"type":"integer","format":"int64","minimum":0,"description":"Set all counts lower than the value to zero. \nWhen the value is set, negative numbers other than error pixel value are always set to zero.\nSetting to zero is equivalent to turning the option off.\n"},"run_number":{"type":"integer","format":"int64","minimum":0,"description":"Number of run within an experimental session. \nTransferred over CBOR stream as \"series ID\", though not saved in HDF5 file.\nIt is highly recommended to keep this number unique for each data collection during experimental series.\nIf not provided, the number will be automatically incremented.\n"},"run_name":{"type":"string","description":"Unique ID of run.\nTransferred over CBOR stream as \"unique series ID\", though not saved in HDF5 file.\nIt is highly recommended to keep this name unique for each data collection during experimental series.\nIf not provided, the name will be automatically generated as number + colon + file_prefix.\n"},"experiment_group":{"type":"string","description":"Name of group owning the data (e.g. p-group or proposal number). \nTransferred over CBOR stream, though not saved in HDF5 file.\n"},"poisson_compression":{"type":"integer","format":"int64","minimum":0,"maximum":16,"description":"Enable lossy compression of pixel values that preserves Poisson statistics. \nRequires to provide a numerical factor SQ.\nPixel value P will be transformed to round(sqrt(P) * SQ), with rounding to the closest integer.\nCompression is turned off if the value is missing or it is set to zero.\n"},"write_nxmx_hdf5_master":{"type":"boolean","default":true,"description":"Write NXmx formatted HDF5 master file. Recommended to use for macromolecular crystallography experiments\nand to turn off for other experiments.\n"},"save_calibration":{"type":"boolean","description":"Forward image calibration (at the moment pedestal and pedestal RMS for JUNGFRAU) using the ZeroMQ stream to writer.\nIf parameter is not provided calibration will be saved only if more than 4 images are recorded.\n"},"polarization_factor":{"type":"number","description":"Polarization factor for integration; 1.0 is horizontal polarization; -1.0 is vertical polarization","format":"float","minimum":-1,"maximum":1},"ring_current_mA":{"type":"number","format":"float","description":"Ring current at the beginning of the data collection","minimum":0},"sample_temperature_K":{"type":"number","format":"float","description":"Sample temperature in Kelvin","minimum":0},"poni_rot1_rad":{"type":"number","description":"PONI angle rot1 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"poni_rot2_rad":{"type":"number","description":"PONI angle rot2 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"poni_rot3_rad":{"type":"number","description":"PONI angle rot3 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"unit_cell":{"$ref":"#/components/schemas/unit_cell"},"spot_finding":{"type":"boolean","description":"Enable spot finding and save spots","default":true},"smargon":{"type":"object","description":"Geometry of Smargon goniometer at SLS 2.0 / MX beamlines. \nAssuming that Smargon is used as static positioner and not moving during the scan, allowing to reconstruct geometry.\n","required":["phi_deg","chi_deg"],"properties":{"phi_deg":{"type":"number","format":"float","description":"Phi angle in degrees"},"chi_deg":{"type":"number","format":"float","description":"Chi angle in degrees"},"phi_axis":{"type":"array","description":"Phi rotation axis","default":[1,0,0],"example":[1,0,0],"items":{"type":"number","format":"float"},"minItems":3,"maxItems":3},"chi_axis":{"type":"array","description":"Chi rotation axis","default":[0,0,1],"example":[0,0,1],"items":{"type":"number","format":"float"},"minItems":3,"maxItems":3}}},"max_spot_count":{"type":"integer","minimum":10,"maximum":2000,"default":250,"description":"Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected"},"detect_ice_rings":{"type":"boolean","description":"Flag spots as ice rings and reduce their effect on indexing"},"async_start":{"type":"boolean","default":false,"description":"When set to true, `/start` will not wait for detector and Jungfraujoch to be ready for the measurement."},"xray_fluorescence_spectrum":{"type":"object","required":["energy_eV","data"],"properties":{"energy_eV":{"type":"array","items":{"type":"number","format":"float"},"description":"X-ray fluorescence scan energy for each measurement point"},"data":{"type":"array","items":{"type":"number","format":"float"},"description":"X-ray fluorescence scan result in arbitrary units; must be exactly the same length, as energy_eV"}}}}},"crystal_lattice":{"type":"array","items":{"type":"number","format":"float"},"minItems":9,"maxItems":9,"description":"Real-space crystal lattice 3D vectors in Angstrom.\nOrder is 1st vector (x,y,z), 2nd vector (x,y,z) and 3rd vector (x,y,z)\n"},"unit_cell":{"type":"object","description":"Unit cell parameters. Necessary to run indexing. Units of angstrom and degree","required":["a","b","c","alpha","beta","gamma"],"properties":{"a":{"type":"number","format":"float","example":37,"minimum":0},"b":{"type":"number","format":"float","example":37,"minimum":0},"c":{"type":"number","format":"float","example":78,"minimum":0},"alpha":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360},"beta":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360},"gamma":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360}}},"file_writer_format":{"type":"string","enum":["NXmxOnlyData","NXmxLegacy","NXmxVDS","NXmxIntegrated","CBF","TIFF","NoFileWritten"],"default":"NXmxVDS","description":"NoFileWritten - no files are written at all\nNXmxOnlyData - only data files are written, no master file\nNXmxLegacy - legacy format with soft links to data files in the master file; necessary for DECTRIS Albula 4.0 and DECTRIS Neggia\nNXmxVDS - newer format with virtual dataset linking data files in the master file, also includes better metadata handling\nNXmxIntegrated - single HDF5 per dataset\nCBF - DEPRECATED, no longer supported; kept for back compatibility only. Requests using this value are rejected. Only HDF5 formats are written.\nTIFF - DEPRECATED, no longer supported; kept for back compatibility only. Requests using this value are rejected. Only HDF5 formats are written.\n"},"file_writer_settings":{"type":"object","properties":{"overwrite":{"type":"boolean","default":false,"description":"Inform jfjoch_write to overwrite existing files. Otherwise files would be saved with .h5.{timestamp}.tmp suffix.\n"},"format":{"$ref":"#/components/schemas/file_writer_format"}}},"pixel_mask_statistics":{"type":"object","properties":{"user_mask":{"description":"Number of pixels masked using the user mask","type":"integer","format":"int64","minimum":0},"too_high_pedestal_rms":{"description":"Number of pixels with G0 pedestal RMS higher than provided threshold","type":"integer","format":"int64","minimum":0},"wrong_gain":{"description":"Number of pixels that show wrong gain level during the pedestal procedure","type":"integer","format":"int64","minimum":0}}},"image_buffer_status":{"type":"object","required":["image_numbers","total_slots","in_preparation_slots","in_sending_slots","available_slots","max_image_number","min_image_number"],"properties":{"min_image_number":{"type":"integer","format":"int64","minimum":0,"description":"Smallest image number available in the buffer"},"max_image_number":{"type":"integer","format":"int64","minimum":0,"description":"Largest image number available in the buffer"},"image_numbers":{"type":"array","description":"Image numbers currently present in the buffer.","items":{"type":"integer","format":"int64"}},"total_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer. This number, compared to number of images in data collection and\nframe rate will determine \"retention\" rate of the image buffer.\n"},"available_slots":{"type":"integer","format":"int64","description":"Slots available for the data collection"},"in_preparation_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer that are currently in preparation for sending.\n"},"in_sending_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer that are currently sending/writing data.\n"},"current_counter":{"type":"integer","format":"int64","description":"Counter of changes in the image buffer - either new start message or new image added.\nFor optimization one can only load new images/datasets from the HTTP if this value changes.\nCounter is optional as it was not implemented in older versions to avoid breaking change\n"}}},"image_format_settings":{"type":"object","required":["summation","jungfrau_conversion","geometry_transform","mask_chip_edges","mask_module_edges","apply_mask"],"properties":{"summation":{"type":"boolean","description":"Enable summation of images to a given image_time\nIf disabled images are saved according to original detector speed, but image count is adjusted\n"},"geometry_transform":{"type":"boolean","description":"Place module read-out into their location on composed detector and extend multipixels\n"},"jungfrau_conversion":{"type":"boolean","description":"Convert pixel value in ADU to photon counts/energy\nOnly affects JUNGFRAU detector\n"},"jungfrau_conversion_factor_keV":{"type":"number","format":"float","minimum":0.001,"maximum":500,"description":"Used to convert energy deposited into pixel to counts\nIf not provided incident_energy_keV is used\n"},"bit_depth_image":{"type":"integer","format":"int64","enum":[8,16,32],"description":"Bit depth of resulting image (it doesn't affect the detector read-out value)\nIf not provided value is adjusted automatically\n"},"signed_output":{"type":"boolean","description":"Controls if pixels have signed output\nIf not provided value is adjusted automatically\n"},"mask_module_edges":{"type":"boolean","default":true,"description":"Mask 1 pixel on the module boundary\n"},"mask_chip_edges":{"type":"boolean","default":true,"description":"Mask multipixels on chip boundary\n"},"jungfrau_mask_pixels_without_g0":{"type":"boolean","default":true,"description":"JUNGFRAU: mask pixels that don't operate in G0, but do operate in G1 and G1.\nThis should be turned off for cases, where detector is operated at room temperature with long exposure time.\n"},"apply_mask":{"type":"boolean","default":false,"description":"Masked pixels are set to special value in the images produced by Jungfraujoch\n"},"jungfrau_pedestal_g0_rms_limit":{"type":"integer","format":"int64","default":100,"minimum":0,"description":"Pixels with pedestal G0 RMS above the threshold are marked as masked pixels"}}},"detector_power_state":{"type":"string","description":"Power on of ASICs","enum":["PowerOn","PowerOff","Partial"]},"detector_state":{"type":"string","description":"Current state of the detector","enum":["Idle","Waiting","Busy","Error","Not connected"]},"detector_status":{"type":"object","required":["state","powerchip","server_version","number_of_triggers_left","fpga_temp_degC","high_voltage_V"],"properties":{"state":{"$ref":"#/components/schemas/detector_state"},"powerchip":{"$ref":"#/components/schemas/detector_power_state"},"server_version":{"type":"string","description":"Detector server (on read-out boards) version"},"number_of_triggers_left":{"type":"integer","format":"int64","description":"Remaining triggers to the detector (max of all modules)"},"fpga_temp_degC":{"type":"array","description":"Temperature of detector FPGAs","items":{"type":"integer","format":"int64"}},"high_voltage_V":{"type":"array","description":"High voltage for detector modules","items":{"type":"integer","format":"int64"}}}},"detector_timing":{"type":"string","enum":["auto","trigger","burst","gated"],"default":"trigger"},"detector_settings":{"type":"object","required":["frame_time_us"],"properties":{"frame_time_us":{"type":"integer","description":"Interval between consecutive frames.\nThis is internal frame time for the JUNGFRAU detector, image time has to be integer multiply of this number.\nFor EIGER detector this is default frame time, not used otherwise\n","format":"int64","minimum":1},"count_time_us":{"type":"integer","description":"Integration time of the detector. \nIf not provided count time will be set to maximum value for a given frame time.\n","format":"int64"},"internal_frame_generator":{"type":"boolean","default":false,"description":"Use internal frame generator in FPGA instead of getting data from a real detector"},"internal_frame_generator_images":{"type":"integer","format":"int64","default":1,"minimum":1,"maximum":64,"description":"Number of images stored in the internal frame generator."},"detector_trigger_delay_ns":{"type":"integer","format":"int64","minimum":0,"default":0,"description":"Delay between TTL trigger and acquisition start [ns]"},"timing":{"$ref":"#/components/schemas/detector_timing"},"eiger_threshold_keV":{"type":"number","format":"float","minimum":1,"maximum":100,"description":"Threshold for the PSI EIGER detector and all DECTRIS detectors.\nIf value is provided, it will be used for all subsequent acquisitions, irrespective of beam energy.\nIf value is not provided, threshold will be determined on start of acquisition as half of incident energy. \nThis might lead to increased start time.\n"},"eiger_bit_depth":{"type":"integer","format":"int64","enum":[8,16,32],"description":"Bit depth of PSI EIGER read-out. This is  \nIf value is not provided, depth will be determined based on the image time:\n* Exposure time < 500 microseconds depth of 8 bit will be used,\n* 500 <= exposure time < 2622 microseconds depth of 16 bit will be used\n* Exposure time >= 2622 microseconds depth of 32 bit will be used.\n"},"jungfrau_pedestal_g0_frames":{"type":"integer","format":"int64","default":2000,"minimum":0},"jungfrau_pedestal_g1_frames":{"type":"integer","format":"int64","default":300,"minimum":0},"jungfrau_pedestal_g2_frames":{"type":"integer","format":"int64","default":300,"minimum":0},"jungfrau_pedestal_min_image_count":{"type":"integer","format":"int64","default":128,"minimum":32,"description":"Minimum number of collected images for pedestal to consider it viable"},"jungfrau_storage_cell_count":{"type":"integer","format":"int64","default":1,"minimum":1,"maximum":16},"jungfrau_storage_cell_delay_ns":{"type":"integer","format":"int64","minimum":2100,"default":5000,"description":"Delay between two storage cells [ns]"},"jungfrau_fixed_gain_g1":{"type":"boolean","default":false,"description":"Fix gain to G1 (can be useful for storage cells)"},"jungfrau_use_gain_hg0":{"type":"boolean","default":false,"description":"Use high G0 (for low energy applications)"}}},"spot_finding_settings":{"type":"object","required":["enable","indexing","signal_to_noise_threshold","photon_count_threshold","max_pix_per_spot","min_pix_per_spot","quick_integration","high_resolution_limit_for_spot_count_low_res","ice_ring_width_q_recipA"],"properties":{"enable":{"type":"boolean","default":true,"description":"Enable spot finding. This is temporary setting, i.e. can be changed anytime during data collection. \nEven if disabled spot finding information will still be send and written, though always with zero spots.\n"},"indexing":{"type":"boolean","default":true,"description":"Enable indexing. This is temporary setting, i.e. can be changed anytime during data collection.\n"},"signal_to_noise_threshold":{"type":"number","format":"float","minimum":0},"photon_count_threshold":{"type":"integer","format":"int64","minimum":0},"min_pix_per_spot":{"type":"integer","format":"int64","minimum":1},"max_pix_per_spot":{"type":"integer","format":"int64","minimum":1},"high_resolution_limit":{"type":"number","format":"float","description":"High resolution limit for spot finding [Angstrom]. Optional: if omitted, spot finding extends\nas far as the detector reaches, i.e. the detection is not clipped in resolution.\n"},"low_resolution_limit":{"type":"number","format":"float","description":"Low resolution limit for spot finding [Angstrom]. Optional: if omitted, spot finding is not\nclipped at the low-resolution end. A value of 0 is accepted and means the same thing.\n"},"high_resolution_limit_for_spot_count_low_res":{"type":"number","format":"float","description":"High resolution threshold to consider spot \"low resolution\" [Angstrom]","minimum":2,"maximum":8},"quick_integration":{"type":"boolean","default":false,"description":"Quick integration of Bragg spots in diffraction images.\nIf enabled it will likely reduce performance of Jungfraujoch for datasets with a very high indexing rate.\n(experimental feature)\n"},"ice_ring_width_q_recipA":{"type":"number","format":"float","minimum":0,"maximum":1,"default":0.03,"description":"Half-width of the ice ring band in q (1/A). Matches the offline default in image_analysis/spot_finding/SpotFindingSettings.h, which was set from a measured ring FWHM of ~0.06; the two must agree or the same data gets a narrower ice band online."},"high_res_gap_Q_recipA":{"type":"number","format":"float","minimum":0.1,"maximum":5,"default":1.5,"description":"This parameter is used to remove spurious spots at a very high resolution, that sometimes appear due to very low background close to the edge of the detector.\nIf there is a gap in (1/d)-space between spots of at least this size, spots on the side of the gap with high resolution will be discarded. This is optional parameter.\nThis option should be turned OFF for small molecule datasets or for crystals with very low mosaicity, when it is expected to see only few spots in any case.\n"},"adaptive_threshold":{"type":"boolean","default":false,"description":"Self-calibrating spot detection: replace the fixed photon_count_threshold by a per-resolution-ring\nthreshold derived from each image's own noise, so the same setting works across datasets without\nper-dataset tuning. photon_count_threshold is then ignored and false_pixels_per_frame sets the\noperating point instead.\nOnly available on detectors whose images are analysed in software (the DECTRIS/SIMPLON workflow).\nThe JUNGFRAU and EIGER workflows find spots on the FPGA, which applies its own fixed threshold,\nso enabling this there is rejected rather than silently ignored.\n"},"false_pixels_per_frame":{"type":"number","format":"float","minimum":1,"maximum":100000,"default":100,"description":"Operating point of the adaptive threshold: the number of noise pixels tolerated per frame.\nAbout 100 suits a multi-megapixel detector. Ignored unless adaptive_threshold is set.\n"}}},"azim_int_settings":{"type":"object","required":["solid_angle_corr","polarization_corr","low_q_recipA","q_spacing"],"properties":{"polarization_corr":{"type":"boolean","description":"Apply polarization correction for azimuthal integration (polarization factor must be configured in dataset settings)","default":true},"solid_angle_corr":{"type":"boolean","description":"Apply solid angle correction for azimuthal integration","default":true},"high_q_recipA":{"type":"number","minimum":0.00002,"maximum":10,"format":"float","description":"Upper q limit of the azimuthal integration [1/Angstrom]. Optional: if omitted, the integration\n(and the adaptive spot detection that shares these q bins) extends to the highest q the\ndetector reaches.\n"},"low_q_recipA":{"type":"number","format":"float","minimum":0.00001,"maximum":10},"q_spacing":{"type":"number","format":"float","minimum":0.00001},"azimuthal_bins":{"type":"integer","format":"int64","minimum":1,"maximum":512,"default":1,"description":"Numer of azimuthal (phi) bins; 1 = standard 1D azimuthal integration"},"force_cpu":{"type":"boolean","default":false,"description":"Force CPU processing of azimuthal integration in the FPGA data acquisition workflow.\nThis allows to extend number of azimuthal integration bins, as well as to calculate standard deviation\nof the azimuthal integration results.\n"}}},"detector_list_element":{"type":"object","required":["id","nmodules","description","width","height","serial_number","base_ipv4_addr","udp_interface_count","readout_time_ns","min_frame_time_ns","min_count_time_ns"],"properties":{"id":{"type":"integer","format":"int64","minimum":0},"description":{"type":"string","example":"JUNGFRAU 4 Mpixel"},"serial_number":{"type":"string","example":"JF17T16V01"},"base_ipv4_addr":{"type":"string","example":"10.10.10.1"},"udp_interface_count":{"type":"integer","format":"int64","example":2,"description":"Number of UDP interfaces per detector module"},"nmodules":{"type":"integer","format":"int64","example":18},"width":{"type":"integer","format":"int64","example":2068},"height":{"type":"integer","format":"int64","example":2164},"pixel_size_mm":{"type":"number","format":"float","example":0.075},"readout_time_ns":{"type":"integer","format":"int64"},"min_frame_time_ns":{"type":"integer","format":"int64"},"min_count_time_ns":{"type":"integer","format":"int64"},"type":{"$ref":"#/components/schemas/detector_type"}}},"detector_list":{"type":"object","required":["detectors","current_id"],"properties":{"detectors":{"type":"array","items":{"$ref":"#/components/schemas/detector_list_element"}},"current_id":{"type":"integer","format":"int64","example":0}}},"detector_selection":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","example":1}}},"measurement_statistics":{"type":"object","properties":{"file_prefix":{"type":"string"},"run_number":{"type":"integer","format":"int64","description":"Number of data collection run. This can be either automatically incremented or provided externally for each data collection.\n"},"experiment_group":{"type":"string","description":"Name of group owning the data (e.g. p-group or proposal number).\n"},"images_expected":{"type":"integer","format":"int64"},"images_collected":{"type":"integer","format":"int64","description":"Images collected by the receiver. This number will be lower than images expected if there were issues with data collection performance.\n"},"images_sent":{"type":"integer","format":"int64","description":"Images sent to the writer. \nThe value does not include images discarded by lossy compression filter and images not forwarded due to full ZeroMQ queue.\n"},"images_written":{"type":"integer","format":"int64","description":"Images successfully written to disk.\nThe value is live updated for TCP/IP socket and direct HDF5 writer, while for ZeroMQ it is only updated at the end of experiment.\n"},"images_discarded_lossy_compression":{"type":"integer","format":"int64","description":"Images discarded by the lossy compression filter"},"max_image_number_sent":{"type":"integer","format":"int64"},"collection_efficiency":{"type":"number","format":"float","example":1,"minimum":0,"maximum":1},"compression_ratio":{"type":"number","format":"float","example":5.3,"minimum":0},"cancelled":{"type":"boolean"},"max_receiver_delay":{"type":"integer","format":"int64"},"indexing_rate":{"type":"number","format":"float"},"detector_width":{"type":"integer","format":"int64"},"detector_height":{"type":"integer","format":"int64"},"detector_pixel_depth":{"type":"integer","format":"int64","enum":[2,4]},"bkg_estimate":{"type":"number","format":"float"},"unit_cell":{"type":"string"},"error_pixels":{"type":"number","format":"float","description":"Moving average of 1000 images counting number of error pixels on the detector"},"saturated_pixels":{"type":"number","format":"float","description":"Moving average of 1000 images counting number of saturated pixels on the detector"},"roi_beam_pixels":{"type":"number","format":"float","description":"If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images\nfor number of valid pixels within this ROI\n"},"roi_beam_sum":{"type":"number","format":"float","description":"If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images\nfor sum of valid pixels within this ROI\n"}}},"fpga_status":{"type":"array","items":{"type":"object","required":["pci_dev_id","serial_number","base_mac_addr","eth_link_status","eth_link_count","eth_link_speed","power_usage_W","fpga_temp_C","hbm_temp_C","packets_sls","packets_udp","idle","fw_version","pcie_link_speed","pcie_link_width"],"properties":{"pci_dev_id":{"type":"string"},"serial_number":{"type":"string"},"fw_version":{"type":"string"},"base_mac_addr":{"type":"string"},"eth_link_count":{"type":"integer","format":"int64"},"eth_link_status":{"type":"integer","format":"int64"},"power_usage_W":{"type":"number","format":"float"},"fpga_temp_C":{"type":"number","format":"float"},"hbm_temp_C":{"type":"number","format":"float"},"packets_udp":{"type":"integer","format":"int64"},"packets_sls":{"type":"integer","format":"int64"},"idle":{"type":"boolean"},"pcie_link_speed":{"type":"integer","format":"int64","description":"PCIe link speed measured by generation (expected value is 4 == PCIe Gen4)"},"pcie_link_width":{"type":"integer","format":"int64","description":"PCIe link width (expected value is 8 == x8)"}}}},"broker_status":{"type":"object","required":["state"],"properties":{"state":{"type":"string","enum":["Inactive","Idle","Busy","Measuring","Pedestal","Error"]},"progress":{"type":"number","format":"float","description":"Progress of data collection (only available if receiving is running)","example":1,"minimum":0,"maximum":1},"message":{"type":"string","description":"Message to display besides state of the jfjoch_broker; mostly used for errors and warnings\nThis matters especially for async functions (start/initialize), where API won't return reason\nfor the error during async operation.\n"},"message_severity":{"type":"string","enum":["success","info","warning","error"],"default":"error","description":"Level of the message to display"},"gpu_count":{"type":"integer","format":"int32","description":"Number of installed GPUs"},"broker_version":{"type":"string","description":"Version of the jfjoch_broker","example":"1.0.0-rc.128"}}},"image_pusher_status":{"type":"object","required":["pusher_type","addr","connected_writers"],"description":"Informs about status of the image pusher.\n","properties":{"pusher_type":{"$ref":"#/components/schemas/image_pusher_type"},"addr":{"type":"array","items":{"type":"string"},"example":["tcp://1.2.3.4:5000","tcp://1.2.3.4:5001"],"description":"List of addresses of image pushers.\nFor HDF5 socket - no addresses will be returned.\nFor ZeroMQ - list of addresses for each socket will be provided.\nFor TCP/IP - single address to connect all writers will be provided.\n"},"connected_writers":{"type":"integer","format":"int64","minimum":0,"description":"Number of connected writers \nFor ZeroMQ image socket: number is constant\nFor TCP/IP image socket: number is updated live during operation\n"},"images_written":{"type":"integer","format":"int64","minimum":0,"description":"Number of images written to the image socket.\nThis number is updated live during operation for TCP/IP image socket and direct HDF5 writer.\nIt is updated at the end of experiment for ZeroMQ image socket.\n"},"images_write_error":{"type":"integer","format":"int64","minimum":0,"description":"Number of images that could not be written to the image socket.\nThis number is updated live during operation for TCP/IP image socket.\nNo other socket use it.\n"},"writer_fifo_utilization":{"type":"array","items":{"type":"integer","format":"int64","minimum":0},"description":"Utilization of internal writer FIFO.\nThis number is updated live during operation for TCP/IP image socket.\nNo other socket use it.\n"}}},"plot":{"type":"object","required":["x","y","title"],"description":"x and y coordinates for plotting, it is OK to assume that both arrays have the same size; layout is optimized for Plotly","properties":{"title":{"type":"string","default":""},"x":{"type":"array","items":{"type":"number","format":"float"}},"y":{"type":"array","items":{"type":"number","format":"float","nullable":true}},"z":{"type":"array","items":{"type":"number","format":"float","nullable":true}}}},"plot_unit_x":{"type":"string","enum":["image_number","q_recipA","d_A","angle_deg","ADU","grid_um"],"default":"image_number"},"plots":{"type":"object","required":["plot","unit_x"],"properties":{"title":{"type":"string"},"unit_x":{"$ref":"#/components/schemas/plot_unit_x"},"size_x":{"type":"number","format":"float","description":"Max X range of the plot"},"size_y":{"type":"number","format":"float","description":"Max Y range of the plot"},"plot":{"type":"array","items":{"$ref":"#/components/schemas/plot"}}}},"scan_result":{"type":"object","description":"Results of a scan","required":["images"],"properties":{"file_prefix":{"type":"string"},"rotation_unit_cell":{"$ref":"#/components/schemas/unit_cell"},"rotation_crystal_lattice":{"$ref":"#/components/schemas/crystal_lattice"},"rotation_bravais":{"type":"string","description":"Bravais lattice type of the global rotation-indexing solution: crystal-system\nletter + centering, e.g. \"tP\", \"oC\", \"cF\", \"hR\", \"mP\". Empty if not determined.\n"},"images":{"type":"array","items":{"type":"object","required":["efficiency","number"],"properties":{"efficiency":{"type":"number","format":"float"},"number":{"type":"integer","format":"int64","description":"Detector image number for a given cell"},"nx":{"type":"integer","format":"int64","description":"Cell position in X for grid scan"},"ny":{"type":"integer","format":"int64","description":"Cell position in Y for grid scan"},"angle":{"type":"number","format":"float","description":"Rotation angle associated with the image"},"bkg":{"type":"number","format":"float","description":"Background estimate"},"spots":{"type":"integer","format":"int64","description":"Spot count"},"spots_low_res":{"type":"integer","format":"int64","description":"Spot count in low resolution range"},"spots_indexed":{"type":"integer","format":"int64","description":"Spot count within indexing tolerance"},"spots_ice":{"type":"integer","format":"int64","description":"Spot count within common ice ring resolutions"},"ice":{"type":"number","format":"float","description":"Strongest hexagonal-ice ring intensity over the smooth radial background (1 = no ice)"},"index":{"type":"integer","format":"int64","description":"Indexing solution"},"latt_count":{"type":"integer","format":"int64","description":"Indexing lattice count"},"pr":{"type":"number","format":"float","description":"Profile radius, i.e. how far reflections are from the Ewald sphere"},"b":{"type":"number","format":"float","description":"B-Factor estimate"},"uc":{"$ref":"#/components/schemas/unit_cell"},"xfel_pulseid":{"type":"integer","format":"int64","description":"XFEL pulse ID"},"pixel_sum":{"type":"integer","format":"int64","description":"Total sum of all pixels"},"max":{"type":"integer","format":"int64","description":"Max viable pixel"},"sat":{"type":"integer","format":"int64","description":"Number of saturated pixels"},"err":{"type":"integer","format":"int64","description":"Number of error pixels"},"res":{"type":"number","format":"float","description":"Diffraction resolution estimate"}}}}}},"powder_calibration_fit_sigma":{"type":"object","description":"What the powder ring fit knows about its own answer, from the covariance of the converged\nproblem. Each sigma is in its parameter's own unit and is scaled by the residual scatter of\nthat fit, so it is the usual \"how far could this move before the fit got visibly worse\".\nThe two correlations are the ones that matter: a tilt and a beam-centre shift both displace a\nring's radius as cos(phi) and are told apart only by how that amplitude grows with the ring's\nradius, so as the rings run out the pair stops being separable and these approach 1.\nThe rotation sigmas and the correlations are absent when the tilt was not a free parameter.\n","properties":{"beam_x_pxl":{"type":"number","format":"float","description":"Standard error of the fitted PONI x [pixels]"},"beam_y_pxl":{"type":"number","format":"float","description":"Standard error of the fitted PONI y [pixels]"},"detector_distance_mm":{"type":"number","format":"float","description":"Standard error of the fitted detector distance [mm]"},"poni_rot1_rad":{"type":"number","format":"float","description":"Standard error of the fitted rot1 [rad]"},"poni_rot2_rad":{"type":"number","format":"float","description":"Standard error of the fitted rot2 [rad]"},"correlation_beam_x_rot1":{"type":"number","format":"float","description":"Correlation between the fitted PONI x and rot1, -1 to 1"},"correlation_beam_y_rot2":{"type":"number","format":"float","description":"Correlation between the fitted PONI y and rot2, -1 to 1"}}},"powder_calibration_spot_check":{"type":"object","description":"Where the circle through the found spots puts the beam, and how far that is from the geometry\nactually fitted. An independent cross-check: it reads nothing from the file's own geometry, so\nit holds where the summed azimuthal profile does not - a profile binned about a badly wrong\ncentre shows each ring smeared across its sectors, and a fit on it converges on the wrong\nanswer without saying so. Two methods sharing no assumption, so the disagreement is the\nstatement. Absent when no spots were available.\n","properties":{"beam_x_pxl":{"type":"number","format":"float","description":"Beam centre x the spots vote for [pixels]"},"beam_y_pxl":{"type":"number","format":"float","description":"Beam centre y the spots vote for [pixels]"},"detector_distance_mm":{"type":"number","format":"float","description":"Detector distance the spots imply [mm]"},"disagreement_pxl":{"type":"number","format":"float","description":"Distance between the spots' beam centre and the fitted one [pixels]"}}},"powder_calibration_quality":{"type":"object","description":"What a powder calibration knows about the geometry it produced. A calibration that has gone\nwrong - the wrong standard named, a header too far out for the rings to be found - looks\nexactly like one that has not until these are read.\n","properties":{"converged":{"type":"boolean","description":"Whether the geometry beside this is a measurement of the data at all. False means at least\none of its parameters was carried over from the input file rather than fitted - which looks\nexactly like a good fit in every other field here - and see not_converged_reason for which.\nrugnux --mode calibration writes no .poni file in that case, a PONI file having no field in\nwhich to say it, and exits non-zero.\n"},"not_converged_reason":{"type":"string","description":"What made converged false, in words. Absent when the calibration converged."},"calibrant":{"type":"string","description":"The powder standard the rings were fitted to, or the unit cell given in its place"},"method":{"type":"string","description":"How the rings were measured. rings fits the arcs of the run-summed (q x azimuth) azimuthal\nprofile; spots fits the pooled per-image spot lists.\n","enum":["rings","spots"]},"ring_points":{"type":"integer","format":"int64","description":"Ring measurements the fit used"},"rms_radial_pxl":{"type":"number","format":"float","description":"Scatter of those measurements about the fitted rings, as a radial distance [pixels]. The\nsingle number that separates a calibration that worked from one that did not.\n"},"beam_sigma_pxl":{"type":"number","format":"float","description":"Standard error the scatter implies on the beam centre [pixels], for a ring of that many\npoints. See powder_calibration_fit_sigma for what the fit itself says, which is not the same and\nis the larger of the two whenever the tilt is poorly separated.\n"},"direct_beam_x_pxl":{"type":"number","format":"float","description":"Where the direct beam lands [pixels]. NOT dataset_settings.beam_x_pxl, which is the PONI:\nthe two part company by distance*tan(tilt)/pixel as soon as the detector is tilted.\n"},"direct_beam_y_pxl":{"type":"number","format":"float","description":"Where the direct beam lands, y [pixels]"},"header_distance_mm":{"type":"number","format":"float","description":"The detector distance the input file declared, for comparison [mm]"},"ring_seed_distance_mm":{"type":"number","format":"float","description":"The distance measured from the ring radii before the fit ran [mm]. It is taken from the\nradii, the wavelength and the pixel size alone, so a large gap from header_distance_mm is\nthe answer to the question the calibration was run to ask. Absent when the profile showed\ntoo few rings to fix a scale.\n"},"tilt_refined":{"type":"boolean","description":"Whether the reported rot1/rot2 were measured by this fit. False means they were declined\nand pinned at the input file's values, because the rings could not separate a tilt from a\nshift of the beam centre.\n"},"tilt_significance":{"type":"number","format":"float","description":"How many of its own sigmas the fitted tilt stands from zero. Below about 3 it is not a\nmeasurement of a tilt but of a beam-centre shift, and the tilt is declined. Passing does\nnot certify a tilt: that estimator is limited by systematics rather than by this sigma.\n"},"fit_sigma":{"$ref":"#/components/schemas/powder_calibration_fit_sigma"},"spot_cross_check":{"$ref":"#/components/schemas/powder_calibration_spot_check"}}},"powder_calibration_output":{"type":"object","required":["dataset_settings"],"description":"The result of a powder-ring detector calibration - what rugnux --mode calibration writes as\n<prefix>.json, and what a calibration run over the image buffer would return.\n\ndataset_settings holds the geometry and nothing else, under the property names this API gives\nthem, so it can be POSTed or merged without translating a field. Its beam_x_pxl/beam_y_pxl is\nthe PONI, the foot of the perpendicular from the sample; where the beam actually lands is\ncalibration.direct_beam_x_pxl. The poni_rot*_rad are present whenever any of them is non-zero\nand absent when all are zero, since a body omitting them states a FLAT detector rather than an\nunstated one.\n","properties":{"dataset_settings":{"$ref":"#/components/schemas/dataset_settings"},"calibration":{"$ref":"#/components/schemas/powder_calibration_quality"},"jfjoch_version":{"type":"string","description":"Version of the program that produced this"}}},"calibration_statistics":{"type":"array","items":{"required":["module_number","storage_cell_number","pedestal_g0_mean","pedestal_g1_mean","pedestal_g2_mean","gain_g0_mean","gain_g1_mean","gain_g2_mean","masked_pixels"],"type":"object","properties":{"module_number":{"type":"integer","format":"int64"},"storage_cell_number":{"type":"integer","format":"int64"},"pedestal_g0_mean":{"type":"number","format":"float"},"pedestal_g1_mean":{"type":"number","format":"float"},"pedestal_g2_mean":{"type":"number","format":"float"},"gain_g0_mean":{"type":"number","format":"float"},"gain_g1_mean":{"type":"number","format":"float"},"gain_g2_mean":{"type":"number","format":"float"},"masked_pixels":{"type":"integer","format":"int64"}}}},"jfjoch_statistics":{"type":"object","description":"Pool statistics for Jungfraujoch to reduce transfers between frontend and jfjoch_broker","properties":{"detector":{"$ref":"#/components/schemas/detector_status"},"detector_list":{"$ref":"#/components/schemas/detector_list"},"detector_settings":{"$ref":"#/components/schemas/detector_settings"},"image_format_settings":{"$ref":"#/components/schemas/image_format_settings"},"instrument_metadata":{"$ref":"#/components/schemas/instrument_metadata"},"file_writer_settings":{"$ref":"#/components/schemas/file_writer_settings"},"data_processing_settings":{"$ref":"#/components/schemas/spot_finding_settings"},"measurement":{"$ref":"#/components/schemas/measurement_statistics"},"broker":{"$ref":"#/components/schemas/broker_status"},"fpga":{"$ref":"#/components/schemas/fpga_status"},"calibration":{"$ref":"#/components/schemas/calibration_statistics"},"zeromq_preview":{"$ref":"#/components/schemas/zeromq_preview_settings"},"zeromq_metadata":{"$ref":"#/components/schemas/zeromq_metadata_settings"},"dark_mask":{"$ref":"#/components/schemas/dark_mask_settings"},"pixel_mask":{"$ref":"#/components/schemas/pixel_mask_statistics"},"roi":{"$ref":"#/components/schemas/roi_definitions"},"az_int":{"$ref":"#/components/schemas/azim_int_settings"},"buffer":{"$ref":"#/components/schemas/image_buffer_status"},"indexing":{"$ref":"#/components/schemas/indexing_settings"},"bragg_integration":{"$ref":"#/components/schemas/bragg_integration_settings"},"image_pusher":{"$ref":"#/components/schemas/image_pusher_status"}}},"error_message":{"type":"object","required":["msg","reason"],"properties":{"msg":{"type":"string","description":"Human readable message","example":"Detector in wrong state"},"reason":{"type":"string","description":"Enumerate field for automated analysis","enum":["WrongDAQState","Other"]}}},"roi_azimuthal":{"type":"object","description":"ROI as Q-range (or resolution range), optionally restricted to an azimuthal-angle sector","required":["name","q_min_recipA","q_max_recipA"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"q_min_recipA":{"type":"number","format":"float","minimum":0.00001,"description":"Minimum Q-range for the ROI"},"q_max_recipA":{"type":"number","format":"float","minimum":0.00001,"description":"Maximum Q-range for the ROI"},"phi_min_deg":{"type":"number","format":"float","description":"Lower azimuthal-angle bound of the sector [degrees]. Optional: provide both phi_min_deg and phi_max_deg to restrict the ROI to an angular sector, or omit both for a full ring. A sector with phi_min_deg > phi_max_deg wraps across 0.\n"},"phi_max_deg":{"type":"number","format":"float","description":"Upper azimuthal-angle bound of the sector [degrees]. Optional; see phi_min_deg.\n"}}},"roi_circle":{"type":"object","description":"Circular ROI","required":["name","center_x_pxl","center_y_pxl","radius_pxl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"center_x_pxl":{"type":"number","format":"float","description":"X coordinate of center of the circle [pixels]"},"center_y_pxl":{"type":"number","format":"float","description":"Y coordinate of center of the circle [pixels]"},"radius_pxl":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"Radius of the circle [pixels]"}}},"roi_box":{"type":"object","description":"Box ROI","required":["name","min_x_pxl","max_x_pxl","min_y_pxl","max_y_pxl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"min_x_pxl":{"type":"integer","format":"int64","description":"Lower bound (inclusive) in X coordinate for the box","minimum":0},"max_x_pxl":{"type":"integer","format":"int64","description":"Upper bound (inclusive) in X coordinate for the box","minimum":0},"min_y_pxl":{"type":"integer","format":"int64","description":"Lower bound (inclusive) in Y coordinate for the box","minimum":0},"max_y_pxl":{"type":"integer","format":"int64","description":"Upper bound (inclusive) in Y coordinate for the box","minimum":0}}},"roi_circle_list":{"type":"object","description":"List of circular ROIs","required":["rois"],"properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_circle"}}}},"roi_box_list":{"type":"object","description":"List of box ROIs","properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_box"}}}},"roi_azim_list":{"type":"object","description":"List of azimuthal ROIs","properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_azimuthal"}}}},"roi_definitions":{"type":"object","required":["box","circle","azim"],"description":"ROI defintions","properties":{"box":{"$ref":"#/components/schemas/roi_box_list"},"circle":{"$ref":"#/components/schemas/roi_circle_list"},"azim":{"$ref":"#/components/schemas/roi_azim_list"}}},"dark_mask_settings":{"type":"object","description":"Settings for collection of dark images to be used for mask calculation","required":["detector_threshold_keV","frame_threshold_keV","max_allowed_pixel_count","max_frames_with_signal","frame_time_us","number_of_frames"],"properties":{"detector_threshold_keV":{"type":"number","format":"float","description":"Energy threshold for dark image collection","minimum":2.5,"default":3.5,"maximum":100},"frame_time_us":{"type":"integer","format":"int64","description":"Time between frames for dark image collection","minimum":500,"default":10000,"maximum":100000},"number_of_frames":{"type":"integer","format":"int64","description":"Number of frames for dark image collection; zero means no dark collection","minimum":0,"default":1000},"max_allowed_pixel_count":{"type":"integer","format":"int64","description":"Maximum count in a pixel considered normal (not-masked)","minimum":0,"default":1},"max_frames_with_signal":{"type":"integer","format":"int64","description":"Maximum number of frames with signal in a pixel considered normal (not-masked)","minimum":0,"default":10}}},"indexing_settings":{"type":"object","description":"Settings for crystallography indexing","required":["algorithm","geom_refinement_algorithm","fft_high_resolution_A","fft_max_unit_cell_A","fft_min_unit_cell_A","fft_num_vectors","tolerance","thread_count","unit_cell_dist_tolerance","index_ice_rings","viable_cell_min_spots","rotation_indexing","rotation_indexing_min_angular_range_deg","rotation_indexing_angular_stride_deg","blocking"],"properties":{"algorithm":{"$ref":"#/components/schemas/indexing_algorithm"},"fft_max_unit_cell_A":{"type":"number","format":"float","default":250,"maximum":500,"minimum":50,"description":"Largest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT"},"fft_min_unit_cell_A":{"type":"number","format":"float","default":10,"minimum":5,"maximum":40,"description":"Smallest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT"},"fft_high_resolution_A":{"type":"number","format":"float","default":2,"minimum":0.5,"maximum":6,"description":"Sets how finely the FFT samples each search direction: it fixes the extent of the projection\nhistogram, and with it the transform size, so it affects execution time and memory of FFT.\nIt does NOT filter spots - every spot is projected whatever its resolution, so raising it\ndoes not make the transform see a coarser subset of the data.\nThere is also correlation between smallest unit cell and this value, which need to be checked for very small systems.\n"},"fft_num_vectors":{"type":"integer","format":"int64","minimum":128,"default":16384,"description":"Number of search directions for the FFT algorithm; parameter value affects execution time of FFT."},"tolerance":{"type":"number","format":"float","minimum":0,"maximum":0.5,"description":"Acceptance tolerance for spots after the indexing run - the larger the number, the more spots will be accepted"},"thread_count":{"type":"integer","format":"int64","minimum":1,"maximum":64,"description":"Thread count for indexing algorithm"},"geom_refinement_algorithm":{"$ref":"#/components/schemas/geom_refinement_algorithm"},"unit_cell_dist_tolerance":{"type":"number","format":"float","minimum":0.0001,"maximum":0.2001,"default":0.05,"description":"Relative distance tolerance for unit cell vs. reference; Lattices outside given tolerance will be ignored"},"viable_cell_min_spots":{"type":"integer","format":"int64","minimum":5,"default":10,"description":"Minimum number of indexed spots required for a cell to be considered viable"},"index_ice_rings":{"type":"boolean","default":false,"description":"Include spots marked as ice rings in the indexing run. \nIf `dataset_settings` doesn't have `detect_ice_rings` on, this option will have no effect on processing.\n"},"rotation_indexing":{"type":"boolean","default":false},"rotation_indexing_min_angular_range_deg":{"type":"number","format":"float","default":20,"minimum":1},"rotation_indexing_angular_stride_deg":{"type":"number","format":"float","default":0.5,"minimum":0},"blocking":{"type":"boolean","default":true,"description":"Indexing in Jungfraujoch goes with a dedicated thread pool.\nIf set to false, the thread pool is non-blocking, i.e. if there are no threads available, image indexing will be skipped. This option is recommended for real-time processing at high frame rates.\nIf set to true, the thread pool will block until a thread is available.\n"}}},"instrument_metadata":{"type":"object","description":"Metadata for a measurement instrument","required":["source_name","instrument_name"],"properties":{"source_name":{"type":"string","example":"Swiss Light Source"},"source_type":{"type":"string","description":"Type of radiation source. NXmx gives a fixed dictionary, though Jungfraujoch is not enforcing compliance. \nhttps://manual.nexusformat.org/classes/base_classes/NXsource.html#nxsource\nNXsource allows the following:\n\nSpallation Neutron Source\nPulsed Reactor Neutron Source\nReactor Neutron Source\nSynchrotron X-ray Source\nPulsed Muon Source\nRotating Anode X-ray\nFixed Tube X-ray\nUV Laser\nFree-Electron Laser\nOptical Laser\nIon Source\nUV Plasma Source\nMetal Jet X-ray\n","example":"Synchrotron X-ray Source","default":""},"instrument_name":{"type":"string","example":"CristallinaMX"},"pulsed_source":{"type":"boolean","description":"Settings specific to XFEL (e.g., every image has to come from TTL trigger, save pulse ID and event code)\n","default":false},"electron_source":{"type":"boolean","description":"Settings specific to electron source (e.g., wavelength definition)\n","default":false}}},"detector_module_direction":{"type":"string","enum":["Xp","Xn","Yp","Yn"]},"detector_type":{"type":"string","enum":["EIGER","JUNGFRAU","DECTRIS"]},"image_pusher_type":{"type":"string","default":"None","enum":["ZeroMQ","HDF5","CBOR","TCP","None"]},"standard_detector_geometry":{"type":"object","description":"Regular rectangular geometry, first module is in the bottom left corner of the detector","required":["nmodules"],"properties":{"nmodules":{"type":"integer","minimum":1,"description":"Number of modules in the detector"},"gap_x":{"type":"integer","default":8,"minimum":0,"description":"Gap size in X direction [pixels]"},"gap_y":{"type":"integer","minimum":0,"default":36,"description":"Gap size in Y direction [pixels]"},"modules_in_row":{"type":"integer","minimum":1,"default":1,"description":"Number of modules in one row"}}},"detector_module":{"type":"object","required":["x0","y0","fast_axis","slow_axis"],"properties":{"x0":{"type":"number"},"y0":{"type":"number"},"fast_axis":{"$ref":"#/components/schemas/detector_module_direction"},"slow_axis":{"$ref":"#/components/schemas/detector_module_direction"}}},"detector":{"type":"object","required":["description"],"properties":{"description":{"type":"string","minLength":1},"serial_number":{"type":"string","default":"Unknown","minLength":1},"type":{"$ref":"#/components/schemas/detector_type"},"high_voltage_V":{"type":"integer","format":"int64","minimum":0,"maximum":200,"default":0},"udp_interface_count":{"type":"integer","format":"int64","minimum":1,"maximum":2,"default":1},"module_sync":{"type":"boolean","default":true,"description":"Use module 0 as master for timing. Only applies to JUNGFRAU detector (this cannot be turned off for EIGER)."},"sensor_thickness_um":{"type":"number","format":"float","minimum":0,"default":320},"readout_time_ns":{"type":"integer","format":"int64","minimum":1,"description":"Minimum difference between frame time and count time in microseconds\nDefaults are 3'000 ns for EIGER and 20'000 ns for JUNGFRAU\n"},"min_count_time_ns":{"type":"integer","format":"int64","minimum":0,"description":"Minimum count time available for the detector."},"min_frame_time_ns":{"type":"integer","format":"int64","minimum":0,"description":"Minimum frame time available for the detector."},"calibration_file":{"type":"array","description":"Can be empty for all detectors - default calibration used.\nFor JUNGFRAU: list of gain files, one entry per module.\nFor EIGER: one directory (with detector settings) or list of trim bit files, one entry per half-module.\n","items":{"type":"string"}},"trim_energies_eV":{"type":"array","description":"List of energies at which trimming calibration is provided.\nOnly needed for PSI EIGER and compulsory in this case\n","items":{"type":"integer","format":"int32","minimum":100}},"hostname":{"type":"array","description":"Hostname for detector module. One entry per module\nOne entry per module. Either empty or number of module entries.\n","items":{"type":"string"}},"sensor_material":{"type":"string","default":"Si"},"tx_delay":{"type":"array","items":{"type":"integer","format":"int64"}},"base_data_ipv4_address":{"type":"string","example":"10.10.10.50"},"standard_geometry":{"$ref":"#/components/schemas/standard_detector_geometry"},"custom_geometry":{"type":"array","items":{"$ref":"#/components/schemas/detector_module"}},"roi_mode":{"type":"string","default":"","description":"ROI setting for DECTRIS detectors"},"mirror_y":{"type":"boolean","default":true,"description":"Mirror detector in Y direction to account for MX convention of (0,0) point in top left corner"},"temp_thresold_degC":{"type":"integer","format":"int64","description":"Temperature threshold for JUNGFRAU detector modules","minimum":40,"maximum":70,"default":55},"default_settings":{"$ref":"#/components/schemas/detector_settings"}}},"zeromq_settings":{"type":"object","description":"ZeroMQ configuration for Jungfraujoch software.\nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","properties":{"send_watermark":{"type":"integer","format":"int64","minimum":2,"maximum":16384,"default":100,"description":"Watermark for ZeroMQ send queue (number of outstanding messages queued on Jungfraujoch server per queue)"},"send_buffer_size":{"type":"integer","format":"int64","description":"Send buffer size for ZeroMQ socket"},"image_socket":{"type":"array","items":{"type":"string"},"example":["tcp://1.2.3.4:5000","tcp://1.2.3.4:5001"],"description":"PUSH ZeroMQ socket for images. In case multiple sockets are provided, images are streamed over multiple sockets.  \nImages are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"},"writer_notification_socket":{"type":"string","example":"tcp://1.3.4.6:7000","description":"PULL ZeroMQ socket for notifications from writer that it finished operation. \nThis allows Jungfraujoch to operate in a synchronous manner, with end of acquisition being also end of writing.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address should be avoided, as this socket address is forwarded to the writer process via START ZerOMQ message and in case of multiple ineterfaces the address might be ambigous.\nUsing * (star) instead of port number is allowed and it means a random free port number.\n"}}},"tcp_settings":{"type":"object","description":"TCP image stream configuration for Jungfraujoch software.\nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","required":["addr"],"properties":{"send_buffer_size":{"type":"integer","format":"int64","description":"Send buffer size for TCP/IP socket"},"image_socket":{"type":"string","example":"tcp://1.2.3.4:5000","description":"tcp://<IP address>:<port>\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces\n"},"nwriters":{"type":"integer","format":"int64","minimum":1,"maximum":100,"default":32,"description":"Number of TCP/IP writers to be used for streaming images"},"peer_liveness_timeout_ms":{"type":"integer","format":"int64","description":"Max time (in milliseconds) a send may block with no sign of life from the\nwriter (no BUSY heartbeat or ACK) before the connection is declared dead.\nOptional; the built-in default is used when unset.\n"},"max_backpressure_timeout_ms":{"type":"integer","format":"int64","description":"Hard upper bound (in milliseconds) on backpressure: if no bytes can be sent to\nthe writer for this long the connection is declared dead even while the writer\nkeeps heartbeating, so a wedged writer cannot block the run or its\nfinalization. Optional; the built-in default is used when unset.\n"}}},"pcie_devices":{"type":"array","minLength":1,"items":{"type":"object","required":["block_device"],"properties":{"blk":{"type":"string","example":"/dev/jfjoch0","description":"Block device name"},"ipv4":{"type":"string","example":"10.1.1.7","description":"IPv4 address of the block device"}}}},"bragg_integration_settings":{"type":"object","description":"Settings for Bragg spot integration","required":["integration_model"],"properties":{"integration_model":{"$ref":"#/components/schemas/integration_model"},"max_hkl":{"type":"integer","minimum":1,"maximum":511,"default":100,"description":"How far the Bragg predictor walks the lattice: reflections with |h|,|k|,|l| above this are\nnever predicted. An axis is truncated once a/d_min exceeds it, so a long axis - or a short\none taken to high resolution - loses its outermost reflections. The cost grows as the cube\n(2n+1)^3 of candidates per image, which is why online keeps a fixed, predictable value\ninstead of taking it from whichever crystal is mounted.\n\nOmitting the field selects the default above; it is never interpreted as \"choose per\ncrystal\". The offline tools (rugnux, viewer) do derive it from the refined cell when it is\nleft unset there, but that is their own default and is not reachable through this API.\n"}}},"jfjoch_settings":{"type":"object","required":["detector","frontend_directory","image_pusher"],"description":"Default settings for Jungfraujoch software. \nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","properties":{"pcie":{"$ref":"#/components/schemas/pcie_devices"},"zeromq":{"$ref":"#/components/schemas/zeromq_settings"},"tcp":{"$ref":"#/components/schemas/tcp_settings"},"instrument":{"$ref":"#/components/schemas/instrument_metadata"},"file_writer":{"$ref":"#/components/schemas/file_writer_settings"},"detector":{"type":"array","minLength":1,"items":{"$ref":"#/components/schemas/detector"}},"indexing":{"$ref":"#/components/schemas/indexing_settings"},"bragg_integration":{"$ref":"#/components/schemas/bragg_integration_settings"},"detector_settings":{"$ref":"#/components/schemas/detector_settings"},"azim_int":{"$ref":"#/components/schemas/azim_int_settings"},"image_format":{"$ref":"#/components/schemas/image_format_settings"},"image_buffer_MiB":{"type":"integer","minimum":128,"default":2048,"description":"Size of internal buffer in MiB for images before they are sent to a stream"},"verbose":{"type":"boolean","default":false,"description":"Print extra debug information"},"receiver_threads":{"type":"integer","minimum":1,"maximum":512,"default":64,"description":"Number of threads used by the receiver"},"numa_policy":{"type":"string","deprecated":true,"description":"Ignored value"},"frontend_directory":{"type":"string","description":"Location of built JavaScript web frontend"},"spot_finding":{"$ref":"#/components/schemas/spot_finding_settings"},"image_pusher":{"$ref":"#/components/schemas/image_pusher_type"},"zeromq_preview":{"$ref":"#/components/schemas/zeromq_preview_settings"},"zeromq_metadata":{"$ref":"#/components/schemas/zeromq_metadata_settings"},"dark_mask":{"$ref":"#/components/schemas/dark_mask_settings"}}},"zeromq_metadata_settings":{"type":"object","required":["enabled","period_ms"],"properties":{"enabled":{"type":"boolean","default":true,"description":"ZeroMQ metadata socket is enabled."},"period_ms":{"type":"integer","format":"int64","minimum":1,"default":1000,"description":"Period for generating metadata package sent to the ZeroMQ interface in milliseconds.\n"},"socket_address":{"type":"string","description":"PUB ZeroMQ socket for image metadata information.\nImage metadata are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"}}},"zeromq_preview_settings":{"type":"object","required":["enabled","period_ms"],"properties":{"enabled":{"type":"boolean","default":true,"description":"ZeroMQ preview socket is enabled."},"period_ms":{"type":"integer","format":"int64","default":1000,"description":"Period for generating preview image sent to the ZeroMQ interface in milliseconds. Default is 1 second. \nIf set to zero, all images will be sent ZeroMQ (should be used only in case of relatively slow data collection).\nThis has no effect on HTTP based preview, which updates always at rate of 1 second.\n"},"socket_address":{"type":"string","description":"PUB ZeroMQ socket for preview images. This socket operates at a reduced frame rate.\nImages are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"}}}}},"paths":{"/initialize":{"post":{"summary":"Initialize detector and data acquisition","description":"Should be used in two cases:\n  - Detector is in `Inactive` state\n  - Detector is in `Error` state\nX-ray shutter must be closed. \nThis operation will reconfigure network interface of the detector. \nDuring operation of the detector it is recommended to use the `POST /pedestal` operation instead.\nIf storage cells are used, the execution time might be few minutes.\n\nThis is async function - one needs to use `POST /wait_till_done` to ensure operation is done.\n","responses":{"200":{"description":"Initialization started"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/pedestal":{"post":{"summary":"Collect dark current for the detector","description":"Updates calibration of the JUNGFRAU detector. Must be in `Idle` state.\n\nX-ray shutter must be closed. Recommended to run once per hour for long integration times (> 100 us).\n\nThis is async function - one needs to use `POST /wait_till_done` to ensure operation is done.\n","responses":{"200":{"description":"Everything OK"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/start":{"post":{"summary":"Start detector","description":"Start data acquisition.\nDetector must be in `Idle` state.\nDefault behavior is for the call to block until detector is ready to accept soft/TTL triggers.\nHowever, this behavior can be changed by settings `async_start` to true in the request body, \nin which case the call will return immediately and one needs to use `/wait_until_running` to ensure detector is ready to run.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/wait_until_running":{"post":{"summary":"Wait for acquisition running","parameters":[{"in":"query","name":"timeout","required":false,"schema":{"type":"integer","default":60,"minimum":0,"maximum":3600},"description":"Timeout in seconds (0 == immediate response)"}],"description":"Block execution of external script till detector and Jungfraujoch are ready to collect data.\nTo not block web server for a indefinite period of time, the procedure is provided with a timeout.\nExtending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.\n","responses":{"200":{"description":"Detector in `Measuring` state"},"400":{"description":"Timeout parameter out of bounds"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}},"502":{"description":"Detector is inactive mode"},"504":{"description":"Timeout reached, need to restart operation"}}}},"/wait_till_done":{"post":{"summary":"Wait for acquisition done","parameters":[{"in":"query","name":"timeout","required":false,"schema":{"type":"integer","default":60,"minimum":0,"maximum":3600},"description":"Timeout in seconds (0 == immediate response)"}],"description":"Block execution of external script till initialization, data collection or pedestal is finished.\nRunning this command does not affect (cancel) running data collection, it is only to ensure synchronous execution of other software.\n\nTo not block web server for a indefinite period of time, the procedure is provided with a timeout.\nExtending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.\n","responses":{"200":{"description":"Detector in `Idle` state, another data collection can start immediately.\nThe operation that finished either succeeded, was cancelled, or ended with a warning.\n"},"400":{"description":"Timeout parameter out of bounds"},"500":{"description":"Error within Jungfraujoch code, or the operation that finished ended in an error -\nmissing packets, or a writer that could not write - see output message.\nA cancelled data collection is not an error.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}},"502":{"description":"Detector is inactive mode"},"504":{"description":"Timeout reached, need to restart operation"}}}},"/trigger":{"post":{"summary":"Send soft trigger to the detector","description":"Generate soft trigger","responses":{"200":{"description":"Trigger sent"}}}},"/cancel":{"post":{"summary":"Cancel running data collection","description":"Command will inform FPGA network card to stop pedestal or data collection at the current stage.\nAny frame that is currently being processed by CPU will be finished and sent to writer.\nGiven the command is making sure to gracefully stop data acquisition and detector, it might take some time to switch back after command finished to `Idle` state.\n\nIf data collection is not running, the command has no effect.\n","responses":{"200":{"description":"Cancel request sent to FPGAs (or ignored, as data collection is not running)"}}}},"/deactivate":{"post":{"summary":"Prepare detector to turn off","description":"Should be in `Idle` or `Error` state.\nCommand deactivates data acquisition and turns off detector high voltage and ASIC.\nShould be used always before turning off power from the detector.\n","responses":{"200":{"description":"Detector ready to turn off"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/config/detector":{"put":{"summary":"Change detector configuration","description":"Detector settings are ones that have effect on calibration, i.e., pedestal has to be collected again after changing these settings.\nThis can only be done when detector is `Idle`, `Error` or `Inactive` states.\nIf detector is in `Idle` state , pedestal procedure will be executed automatically - there must be no X-rays on the detector during the operation.\nIf detector is in `Inactive` or `Error` states, new settings will be saved, but no calibration will be executed.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get detector configuration","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_settings"}}}}}}},"/config/indexing":{"put":{"summary":"Change indexing algorithm settings","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/indexing_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get indexing configuration","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/indexing_settings"}}}}}}},"/config/bragg_integration":{"put":{"summary":"Change Bragg integration settings","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bragg_integration_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get Bragg integration configuration","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bragg_integration_settings"}}}}}}},"/config/file_writer":{"put":{"summary":"Change file writer settings","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/file_writer_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get file writer settings","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file_writer_settings"}}}}}}},"/config/instrument":{"put":{"summary":"Change instrument metadata","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/instrument_metadata"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get instrument metadata","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/instrument_metadata"}}}}}}},"/config/image_format":{"put":{"summary":"Change image output format","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_format_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get image output format","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_format_settings"}}}}}}},"/config/image_format/raw":{"post":{"summary":"Configure format for raw data collection","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","responses":{"200":{"description":"Everything OK"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/config/image_format/conversion":{"post":{"summary":"Configure format for data collection with full conversion","description":"This can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","responses":{"200":{"description":"Everything OK"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/config/spot_finding":{"put":{"summary":"Configure spot finding","description":"Can be done anytime, also while data collection is running","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spot_finding_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}},"get":{"summary":"Get data processing configuration","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/spot_finding_settings"}}}}}}},"/config/azim_int":{"put":{"summary":"Configure azimuthal integration","description":"Can be done when detector is Inactive or Idle","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/azim_int_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get azimuthal integration configuration","description":"Can be done anytime","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/azim_int_settings"}}}}}}},"/config/internal_generator_image":{"put":{"summary":"Load binary image for internal FPGA generator","description":"Load image for internal FPGA generator. This can only happen in Idle state of the detector.\nRequires binary blob with 16-bit integer numbers of size of detector in raw/converted coordinates \n(depending on detector settings).\n","parameters":[{"name":"id","in":"query","description":"Image id to upload","required":false,"schema":{"type":"integer","format":"int64","minimum":0,"maximum":127}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/config/internal_generator_image.tiff":{"put":{"summary":"Load TIFF image for internal FPGA generator","description":"Load image for internal FPGA generator. This can only happen in Idle state of the detector.\nRequires TIFF with 16-bit integer numbers of size of detector in raw/converted coordinates \n(depending on detector settings).\n","parameters":[{"in":"query","name":"id","description":"Image ID to upload","required":false,"schema":{"type":"integer","minimum":0,"maximum":127}}],"requestBody":{"content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/config/select_detector":{"put":{"summary":"Select detector","description":"Jungfraujoch allows to control multiple detectors and/or region-of-interests.\nThe command allows to choose one detector from the list (ID has to be consistent with one provided by GET response).\nChanging detector will set detector to `Inactive` state and will require reinitialization.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_selection"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"List available detectors","description":"Configured detectors that can be selected by used","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_list"}}}}}}},"/config/zeromq_preview":{"put":{"summary":"Set ZeroMQ preview settings","description":"Jungfraujoch can generate preview message stream on ZeroMQ SUB socket.\nHere settings of the socket can be adjusted.\nWhile the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request.\nOptions set with this PUT request have no effect on HTTP based preview.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zeromq_preview_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get ZeroMQ preview settings","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zeromq_preview_settings"}}}}}}},"/config/zeromq_metadata":{"put":{"summary":"Set ZeroMQ metadata settings","description":"Jungfraujoch can generate metadata message stream on ZeroMQ PUB socket. This stream covers all images.\nHere settings of the socket can be adjusted.\nWhile the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zeromq_metadata_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get ZeroMQ metadata socket settings","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zeromq_metadata_settings"}}}}}}},"/config/dark_mask":{"put":{"summary":"Set configuration for dark data collection to calculate mask","description":"This is only possible when operating DECTRIS detectors at the moment; it will be also available for PSI EIGER at some point.\nThis can only be done when detector is `Idle`, `Error` or `Inactive` states.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dark_mask_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}},"get":{"summary":"Get settings for dark data collection to calculate mask","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dark_mask_settings"}}}}}}},"/status":{"get":{"summary":"Get Jungfraujoch status","description":"Status of the data acquisition","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/broker_status"}}}}}}},"/fpga_status":{"get":{"summary":"Get status of FPGA devices","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fpga_status"}}}}}}},"/xfel/pulse_id":{"get":{"summary":"Return XFEL pulse IDs for the current data acquisition","description":"Return array of XFEL pulse IDs - (-1) if image not recorded","responses":{"200":{"description":"Pulse ID collected","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}}},"404":{"description":"Not in XFEL mode or no acquisition recorded"}}}},"/xfel/event_code":{"get":{"summary":"Return XFEL event codes for the current data acquisition","description":"Return array of XFEL event codes","responses":{"200":{"description":"Event codes collected","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}}},"404":{"description":"Not in XFEL mode or no acquisition recorded"}}}},"/image_pusher/status":{"get":{"summary":"Get status of image pusher","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_pusher_status"}}}},"500":{"description":"Error encountered when trying to read status","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/detector/status":{"get":{"summary":"Get detector status","description":"Status of the JUNGFRAU detector","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_status"}}}},"404":{"description":"Running in \"simulator\" mode - no detector present"},"500":{"description":"Error encountered when trying to read status","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/config/roi":{"get":{"summary":"Get ROI definitions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roi_definitions"}}}}}},"put":{"summary":"Upload ROI definitions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/roi_definitions"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/statistics":{"get":{"summary":"Get general statistics","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jfjoch_statistics"}}}}}}},"/statistics/data_collection":{"get":{"summary":"Get data collection statistics","description":"Results of the last data collection","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/measurement_statistics"}}}},"404":{"description":"No data collection performed so far"}}}},"/statistics/calibration":{"get":{"summary":"Get calibration statistics","description":"Statistics are provided for each module/storage cell separately","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calibration_statistics"}}}}}}},"/config/mask":{"get":{"summary":"Get mask of the detector (binary)","description":"Detector must be Initialized.\nGet full pixel mask of the detector.\nSee NXmx standard for meaning of pixel values.\n","responses":{"200":{"description":"Binary array (4 byte; unsigned)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}},"/config/user_mask":{"get":{"summary":"Detector must be Initialized.\nGet user mask of the detector (binary)\n","description":"Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked","responses":{"200":{"description":"User mask in binary format (4 byte; unsigned)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"summary":"Upload user mask of the detector (binary)","description":"Should be in `Idle` state.\nUpload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.\nIf detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.\nIn the latter case - module gaps are ignored and don't need to be assigned value.\nMask is expected as binary array (4-byte; unsigned).\n0 - good pixel, other value - masked\nUser mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.\n","requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"All good"},"400":{"description":"Mask is not 4-byte unsigned integer array or empty body"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/config/mask.tiff":{"get":{"summary":"Get mask of the detector (TIFF)","description":"Should be in `Idle` state.\nGet full pixel mask of the detector\nSee NXmx standard for meaning of pixel values\n","responses":{"200":{"description":"Pixel mask in TIFF format (4 byte; unsigned)","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}}}}},"/config/user_mask.tiff":{"get":{"summary":"Detector must be Initialized.\nGet user mask of the detector (TIFF)\n","description":"Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked","responses":{"200":{"description":"User mask in TIFF format (4 byte; unsigned)","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"summary":"Upload user mask of the detector","description":"Should be in `Idle` state.\nUpload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.\nIf detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.\nIn the latter case - module gaps are ignored and don't need to be assigned value.\nMask is expected as a single-channel TIFF (8-, 16- or 32-bit integer, signed or unsigned).\n0 - good pixel, other value - masked\nUser mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.\nUser mask is not automatically applied - i.e. pixels with user mask will have a valid pixel value in the images.\n","requestBody":{"content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"All good"},"400":{"description":"Not a valid single-channel TIFF or size doesn't match the detector"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/preview/pedestal.tiff":{"get":{"parameters":[{"in":"query","name":"gain_level","required":true,"schema":{"type":"integer"},"description":"Gain level (0, 1, 2)"},{"in":"query","name":"sc","schema":{"type":"integer"},"description":"Storage cell number"}],"summary":"Get pedestal in TIFF format","responses":{"200":{"description":"Calibration image","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid gain level or storage cell number"},"404":{"description":"No calibration recorded so far"}}}},"/preview/plot":{"get":{"summary":"Generate 1D plot from Jungfraujoch","parameters":[{"$ref":"#/components/parameters/binning"},{"$ref":"#/components/parameters/plot_type"},{"$ref":"#/components/parameters/fill_value"},{"$ref":"#/components/parameters/experimental_coord"},{"$ref":"#/components/parameters/azint_unit"}],"responses":{"200":{"description":"Everything OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/plots"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/preview/plot.bin":{"get":{"summary":"Generate 1D plot from Jungfraujoch and send in raw binary format.\nData are provided as (32-bit) float binary array.\nThis format doesn't transmit information about X-axis, only values, so it is of limited use for azimuthal integration.\n","parameters":[{"$ref":"#/components/parameters/plot_type"},{"$ref":"#/components/parameters/roi"}],"responses":{"200":{"description":"Everything OK.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/result/scan":{"get":{"summary":"Get full scan result","responses":{"200":{"description":"Everything OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scan_result"}}}},"404":{"description":"No grid scan recorded"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/start.cbor":{"get":{"summary":"Get Start message in CBOR format","description":"Contains metadata for a dataset (e.g., experimental geometry)","responses":{"200":{"description":"Return start message","content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No measurement so far"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.cbor":{"get":{"summary":"Get image message in CBOR format","description":"Contains full image data and metadata. The image must come from the latest data collection.","parameters":[{"$ref":"#/components/parameters/image_id"}],"responses":{"200":{"description":"Return image message","content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Image not present in the buffer - either not yet measured or already replaced by a next image."},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.jpeg":{"get":{"summary":"Get preview image in JPEG format using custom settings","parameters":[{"$ref":"#/components/parameters/image_id"},{"$ref":"#/components/parameters/show_user_mask"},{"$ref":"#/components/parameters/show_roi"},{"$ref":"#/components/parameters/show_spots"},{"$ref":"#/components/parameters/show_predictions"},{"$ref":"#/components/parameters/show_beam_center"},{"$ref":"#/components/parameters/saturation"},{"$ref":"#/components/parameters/jpeg_quality"},{"$ref":"#/components/parameters/resolution_ring"},{"$ref":"#/components/parameters/color_scale"},{"$ref":"#/components/parameters/resolution_estimate"}],"responses":{"200":{"description":"Preview image","content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"404":{"description":"Image not present in the buffer - either not yet measured or already replaced by a next image."},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.tiff":{"get":{"summary":"Get preview image in TIFF format","parameters":[{"$ref":"#/components/parameters/image_id"}],"responses":{"200":{"description":"Preview image","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No preview image recorded so far"}}}},"/image_buffer/clear":{"post":{"summary":"Clear image buffer","description":"Turns off image buffer for the last data collection. Can be only run when Jungfraujoch is not collecting data.","responses":{"200":{"description":"Done"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/status":{"get":{"summary":"Get status of the image buffers","description":"Can be run at any stage of Jungfraujoch operation, including during data collection.\nThe status of the image buffer is volatile during data collection - if data collection goes for more images than available buffer slots,\nthen image might be replaced in the buffer between calling /images and /image.cbor.\n","responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_buffer_status"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/version":{"get":{"summary":"Get Jungfraujoch version of jfjoch_broker","responses":{"200":{"description":"Release number of Jungfraujoch","content":{"text/plain":{"schema":{"type":"string","example":"1.0.0-rc.25"}}}}}}}}}},"searchIndex":{"store":["section/License-Clarification","/paths/~1initialize/post","/paths/~1pedestal/post","/paths/~1start/post","/paths/~1wait_until_running/post","/paths/~1wait_till_done/post","/paths/~1trigger/post","/paths/~1cancel/post","/paths/~1deactivate/post","/paths/~1config~1detector/put","/paths/~1config~1detector/get","/paths/~1config~1indexing/put","/paths/~1config~1indexing/get","/paths/~1config~1bragg_integration/put","/paths/~1config~1bragg_integration/get","/paths/~1config~1file_writer/put","/paths/~1config~1file_writer/get","/paths/~1config~1instrument/put","/paths/~1config~1instrument/get","/paths/~1config~1image_format/put","/paths/~1config~1image_format/get","/paths/~1config~1image_format~1raw/post","/paths/~1config~1image_format~1conversion/post","/paths/~1config~1spot_finding/put","/paths/~1config~1spot_finding/get","/paths/~1config~1azim_int/put","/paths/~1config~1azim_int/get","/paths/~1config~1internal_generator_image/put","/paths/~1config~1internal_generator_image.tiff/put","/paths/~1config~1select_detector/put","/paths/~1config~1select_detector/get","/paths/~1config~1zeromq_preview/put","/paths/~1config~1zeromq_preview/get","/paths/~1config~1zeromq_metadata/put","/paths/~1config~1zeromq_metadata/get","/paths/~1config~1dark_mask/put","/paths/~1config~1dark_mask/get","/paths/~1status/get","/paths/~1fpga_status/get","/paths/~1xfel~1pulse_id/get","/paths/~1xfel~1event_code/get","/paths/~1image_pusher~1status/get","/paths/~1detector~1status/get","/paths/~1config~1roi/get","/paths/~1config~1roi/put","/paths/~1statistics/get","/paths/~1statistics~1data_collection/get","/paths/~1statistics~1calibration/get","/paths/~1config~1mask/get","/paths/~1config~1user_mask/get","/paths/~1config~1user_mask/put","/paths/~1config~1mask.tiff/get","/paths/~1config~1user_mask.tiff/get","/paths/~1config~1user_mask.tiff/put","/paths/~1preview~1pedestal.tiff/get","/paths/~1preview~1plot/get","/paths/~1preview~1plot.bin/get","/paths/~1result~1scan/get","/paths/~1image_buffer~1start.cbor/get","/paths/~1image_buffer~1image.cbor/get","/paths/~1image_buffer~1image.jpeg/get","/paths/~1image_buffer~1image.tiff/get","/paths/~1image_buffer~1clear/post","/paths/~1image_buffer~1status/get","/paths/~1version/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.111,1,4.753]],["description/0",[0,1.805,2,4.17,3,2.159,4,2.087,5,1.193,6,3.337,7,1.193,8,1.193,9,1.032,10,0.926,11,1.621,12,1.193,13,0.963,14,1.193,15,1.619,16,1.193,17,2.781,18,2.087,19,0.926,20,2.087,21,1.278,22,1.193,23,2.087,24,1.032,25,2.781,26,1.193,27,1.193,28,2.087,29,1.193,30,1.193,31,1.193,32,1.193,33,1.193,34,1.193,35,1.193,36,2.781,37,1.193,38,1.193,39,0.354,40,0.611,41,1.193,42,2.087,43,1.032,44,1.193,45,1.193,46,1.193,47,1.193,48,1.193,49,1.193,50,1.032,51,1.193,52,1.193,53,1.193,54,1.193,55,1.193,56,1.193,57,1.193,58,1.193,59,0.926,60,0.926,61,1.193]],["title/1",[62,2.314,63,0.416,64,0.989,65,1.935]],["description/1",[11,2.226,39,0.937,43,1.688,59,1.515,62,1.195,63,0.505,66,1.952,67,1.385,68,2.042,69,0.858,70,0.901,71,1.515,72,1.688,73,1.385,74,3.01,75,1.952,76,1.515,77,1.688,78,2.735,79,1.195,80,1.952,81,1.952,82,1.688,83,1.385,84,1.281,85,1.952,86,1.952,87,1.688,88,1.688,89,1.281,90,1.281,91,1.515,92,1.281,93,0.555]],["title/2",[63,0.416,94,1.384,95,2.932,96,2.681]],["description/2",[11,1.242,39,0.758,63,0.282,68,2.004,71,1.984,72,2.212,73,1.814,74,1.679,77,2.212,78,2.212,79,1.566,84,1.679,87,2.212,88,2.212,89,1.679,90,1.679,91,1.984,92,1.679,93,0.727,97,2.557,98,1.984,99,2.212,100,0.824,101,1.31,102,2.557,103,2.557,104,2.557,105,2.557,106,1.385,107,2.557]],["title/3",[63,0.524,108,3.688]],["description/3",[11,1.132,39,0.691,60,2.827,63,0.494,64,0.61,65,1.194,67,1.654,89,1.531,90,1.531,92,1.531,100,0.751,101,1.194,108,2.827,109,2.331,110,3.642,111,1.809,112,2.331,113,3.15,114,2.331,115,2.331,116,1.809,117,1.076,118,0.783,119,2.331,120,2.331,121,1.809,122,2.331,123,1.531,124,2.331,125,2.016]],["title/4",[65,2.156,101,2.156,126,3.641]],["description/4",[15,1.984,21,1.566,63,0.282,64,0.67,73,1.814,83,1.814,84,1.679,92,1.679,94,0.937,111,3.036,113,2.212,125,2.212,127,2.212,128,2.212,129,2.212,130,1.242,131,2.212,132,2.212,133,2.212,134,2.212,135,1.984,136,1.679,137,3.384,138,2.212,139,1.984,140,2.212,141,3.384,142,2.212]],["title/5",[65,2.156,93,1.197,126,3.641]],["description/5",[15,1.636,21,1.291,62,1.291,64,0.881,73,1.496,79,1.291,83,2.387,84,1.384,91,1.636,92,2.209,94,1.232,101,1.723,111,2.61,127,1.823,128,1.823,129,1.823,131,1.823,132,1.823,133,1.823,134,1.823,135,1.636,136,1.384,137,2.909,138,1.823,139,1.636,140,1.823,141,2.909,142,1.823,143,1.823,144,1.496,145,2.107,146,1.636,147,2.107,148,2.107]],["title/6",[63,0.416,116,2.932,149,3.268,150,3.268]],["description/6",[13,2.476,116,5.063,150,4.639]],["title/7",[64,0.989,94,1.384,101,1.935,146,2.932]],["description/7",[39,0.625,59,1.636,63,0.232,64,1.099,65,1.079,79,1.291,84,1.384,94,1.232,96,2.387,100,0.679,101,1.079,143,2.909,144,3.4,146,1.636,151,1.823,152,1.291,153,2.107,154,2.61,155,1.823,156,2.107,157,2.107,158,1.823,159,2.107,160,2.107,161,1.636,162,2.107,163,2.107,164,2.107,165,2.107,166,2.107,167,2.107,168,2.107,169,1.636]],["title/8",[63,0.464,170,4.21,171,3.267]],["description/8",[11,1.618,39,0.987,63,0.524,64,0.872,65,1.706,70,1.538,100,1.073,144,2.364,171,3.693,172,4.759,173,3.331,174,3.331,175,3.331,176,3.331,177,3.331,178,3.331]],["title/9",[63,0.464,117,1.944,179,1.851]],["description/9",[39,1.271,63,0.586,68,1.768,69,1.518,70,1.594,71,1.69,74,1.429,76,1.69,79,2.114,83,2.449,89,1.429,93,0.619,94,0.797,98,2.679,100,1.112,117,1.005,118,1.441,135,1.69,169,1.69,180,1.883,181,2.177,182,1.883,183,2.177,184,2.177,185,1.883]],["title/10",[63,0.524,179,2.09]],["description/10",[93,1.59,185,4.835,186,2.863]],["title/11",[117,1.745,118,1.27,187,3.268,188,3.778]],["description/11",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,189,4.135]],["title/12",[179,2.09,187,4.111]],["description/12",[93,1.59,186,2.863,189,4.835]],["title/13",[106,2.046,117,1.745,118,1.27,190,3.268]],["description/13",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,191,4.135]],["title/14",[106,2.28,179,1.851,190,3.641]],["description/14",[93,1.59,186,2.863,191,4.835]],["title/15",[10,2.932,117,1.745,118,1.27,161,2.932]],["description/15",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,192,4.135]],["title/16",[10,3.267,118,1.415,161,3.267]],["description/16",[93,1.59,186,2.863,192,4.835]],["title/17",[117,1.944,193,3.641,194,2.419]],["description/17",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,195,4.135]],["title/18",[193,4.111,194,2.731]],["description/18",[93,1.59,186,2.863,195,4.835]],["title/19",[117,1.745,196,1.27,197,3.268,198,1.835]],["description/19",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,199,4.135]],["title/20",[196,1.415,197,3.641,198,2.045]],["description/20",[93,1.59,186,2.863,199,4.835]],["title/21",[64,0.897,94,1.255,179,1.507,198,1.665,200,2.432]],["description/21",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,201,4.78]],["title/22",[64,0.821,94,1.149,179,1.379,198,1.523,202,2.059,203,2.433]],["description/22",[39,1.417,63,0.527,69,2.102,70,2.207,93,1.359,100,1.54,204,4.78]],["title/23",[179,1.851,205,3.267,206,3.267]],["description/23",[64,1.299,93,1.41,94,1.817,101,2.54,186,2.54,207,4.29]],["title/24",[64,1.102,158,3.641,179,1.851]],["description/24",[93,1.59,186,2.863,207,4.835]],["title/25",[106,2.28,179,1.851,208,2.764]],["description/25",[63,0.568,69,2.266,93,1.465,100,1.66,209,4.458]],["title/26",[106,2.28,179,1.851,208,2.764]],["description/26",[93,1.59,186,2.863,209,4.835]],["title/27",[13,1.448,152,1.92,196,1.054,210,2.225,211,1.802,212,2.225]],["description/27",[13,1.397,21,1.853,39,0.897,63,0.579,100,0.975,118,1.017,152,1.853,196,1.017,210,2.147,211,1.739,212,2.147,213,2.617,214,3.026,215,2.617,216,2.348,217,2.617,218,2.617,219,2.617,220,1.853,221,2.617,222,3.026]],["title/28",[13,1.448,152,1.92,196,1.054,210,2.225,212,2.225,223,1.802]],["description/28",[13,1.43,21,1.897,39,0.918,63,0.587,100,0.998,118,1.041,152,1.897,196,1.041,210,2.198,212,2.198,213,2.679,215,2.679,216,2.403,217,2.679,218,2.679,219,2.679,220,1.897,221,2.679,223,1.78,224,3.097]],["title/29",[63,0.524,225,4.111]],["description/29",[21,1.698,24,2.397,39,0.821,50,3.597,63,0.611,69,1.219,89,2.731,117,1.28,118,0.932,130,1.346,136,1.82,144,1.967,226,2.771,227,2.771,228,2.771,229,2.771,230,2.397,231,2.151,232,2.771,233,2.771,234,2.771,235,2.397]],["title/30",[63,0.464,230,3.641,236,3.267]],["description/30",[11,2.503,63,0.568,179,2.266,225,4.458,235,4.458]],["title/31",[118,1.747,237,2.314,238,2.481]],["description/31",[13,1.181,64,0.67,117,1.181,118,1.315,121,3.036,130,1.242,169,1.984,237,1.566,238,2.569,239,1.814,240,2.212,241,2.557,242,3.036,243,2.212,244,2.212,245,2.212,246,1.814,247,2.212,248,2.212,249,3.384,250,1.814,251,3.384,252,2.557,253,2.557,254,2.212]],["title/32",[118,1.415,237,2.579,238,2.764]],["description/32",[254,5.283]],["title/33",[118,1.747,194,2.171,237,2.314]],["description/33",[13,1.307,64,0.741,117,1.307,118,0.951,121,2.197,130,1.375,194,1.627,196,0.951,237,1.734,239,2.009,240,3.655,242,3.279,243,2.449,244,2.449,245,2.449,246,2.009,247,2.449,248,2.449,249,2.449,250,2.009,251,2.449,255,2.831,256,2.831,257,2.449]],["title/34",[118,1.27,194,2.171,237,2.314,242,2.932]],["description/34",[257,5.283]],["title/35",[64,0.757,94,1.059,95,2.243,118,0.971,179,1.271,258,2.5,259,1.157]],["description/35",[39,1.068,63,0.554,69,1.585,70,1.664,74,2.367,93,1.025,100,1.161,139,2.797,236,2.797,260,3.604,261,3.604,262,3.604,263,3.604,264,3.604,265,3.118]],["title/36",[64,0.821,94,1.149,95,2.433,118,1.054,258,2.712,259,1.256]],["description/36",[265,5.283]],["title/37",[130,2.309,266,2.574]],["description/37",[64,1.404,65,2.747,266,3.533]],["title/38",[152,2.579,266,2.28,267,4.21]],["description/38",[268,6.108]],["title/39",[64,0.757,65,1.48,96,2.051,123,1.897,231,2.243,269,2.051,270,2.5]],["description/39",[68,2.208,123,2.831,196,1.449,231,3.346,269,3.06,270,3.729,271,3.06,272,3.346,273,4.311,274,4.311]],["title/40",[19,2.243,64,0.757,65,1.48,96,2.051,123,1.897,269,2.051,275,2.5]],["description/40",[19,3.849,123,3.257,269,3.52,271,3.52,275,4.29,276,4.959]],["title/41",[196,1.415,266,2.28,277,4.21]],["description/41",[278,6.108]],["title/42",[63,0.524,266,2.574]],["description/42",[63,0.591,99,4.639,266,2.905,279,5.363]],["title/43",[3,3.688,280,4.111]],["description/43",[281,5.283]],["title/44",[3,3.267,280,3.641,282,2.764]],["description/44",[281,5.283]],["title/45",[13,2.194,283,3.121]],["description/45",[283,4.011]],["title/46",[64,1.102,94,1.542,283,2.764]],["description/46",[64,1.349,94,1.888,284,4.458,285,4.458,286,5.153]],["title/47",[98,3.688,283,3.121]],["description/47",[82,4.135,136,3.139,283,3.139,287,4.78,288,4.78,289,4.78,290,4.78]],["title/48",[63,0.464,211,2.419,259,1.686]],["description/48",[62,2.405,63,0.588,202,2.578,259,1.572,291,3.268,292,3.396,293,2.786,294,3.396,295,3.396,296,2.578,297,3.926]],["title/49",[40,1.606,62,1.92,63,0.502,211,1.802,259,1.256]],["description/49",[40,1.898,63,0.565,68,2.627,220,2.27,259,2.054,272,2.876,291,3.141,298,3.205,299,2.63,300,2.63,301,3.205]],["title/50",[40,1.755,63,0.378,211,1.969,259,1.372,282,2.25]],["description/50",[11,0.767,39,0.468,40,1.359,63,0.292,67,1.12,68,2.061,90,1.036,100,0.508,106,0.855,154,1.225,200,1.12,203,1.225,205,1.225,206,1.225,208,1.036,211,0.907,220,0.967,250,1.12,259,1.947,271,1.12,282,1.036,291,1.625,293,1.12,296,1.742,299,1.12,300,1.12,301,1.365,302,1.365,303,1.365,304,1.365,305,1.365,306,1.365,307,1.365,308,1.365,309,1.365,310,1.365,311,1.365,312,2.295,313,1.365,314,1.365,315,1.365,316,1.365,317,1.365,318,1.365,319,1.578,320,1.365,321,1.365,322,1.365,323,1.365,324,1.365]],["title/51",[63,0.464,223,2.419,259,1.686]],["description/51",[39,1.164,63,0.433,100,1.265,202,2.578,259,1.572,291,3.268,292,3.396,293,2.786,294,3.396,295,3.396,296,2.578,325,3.926]],["title/52",[40,1.606,62,1.92,63,0.502,223,1.802,259,1.256]],["description/52",[40,1.898,63,0.565,68,2.627,220,2.27,259,2.054,272,2.876,291,3.141,298,3.205,299,2.63,300,2.63,326,3.205]],["title/53",[40,1.935,63,0.416,259,1.513,282,2.481]],["description/53",[9,1.134,11,0.637,39,0.389,40,1.825,63,0.25,67,0.931,68,2.06,90,0.861,100,0.423,106,0.71,154,1.018,180,1.134,182,1.134,196,0.441,200,0.931,203,1.018,205,1.018,206,1.018,208,0.861,216,1.018,220,0.803,223,0.754,250,0.931,259,1.998,282,0.861,291,2.182,293,0.931,296,1.964,299,0.931,300,0.931,302,1.134,303,1.134,304,1.134,305,1.134,306,1.134,307,1.134,308,1.134,309,1.134,310,1.134,311,1.134,312,1.96,313,1.134,314,1.134,315,1.134,316,1.134,317,1.134,318,1.134,320,1.134,321,1.134,322,1.134,323,1.96,324,1.134,326,1.134,327,1.311,328,1.311,329,1.134,330,1.311,331,1.311]],["title/54",[79,2.579,198,2.045,223,2.419]],["description/54",[332,6.108]],["title/55",[13,1.745,130,1.835,333,3.268,334,3.268]],["description/55",[335,6.108]],["title/56",[11,0.602,13,0.572,64,0.324,106,0.671,130,0.602,136,0.813,149,1.072,151,1.072,198,1.048,200,0.879,208,0.813,211,1.239,271,0.879,296,0.813,329,1.072,333,1.072,334,1.072,336,1.239,337,1.239,338,1.239,339,1.239,340,1.239]],["description/56",[341,6.108]],["title/57",[202,2.764,284,3.641,342,4.21]],["description/57",[343,6.108]],["title/58",[108,2.932,198,1.835,239,2.681,344,3.268]],["description/58",[194,2.747,246,3.392,345,4.78,346,4.78,347,4.78,348,4.78,349,4.78]],["title/59",[196,1.27,198,1.835,239,2.681,344,3.268]],["description/59",[64,1.456,94,1.529,194,2.399,196,1.869,202,2.741,246,2.963,350,4.175,351,4.175,352,4.175]],["title/60",[11,1.404,118,0.971,196,0.971,198,1.404,238,1.897,353,2.89,354,2.89]],["description/60",[355,6.108]],["title/61",[196,1.27,198,1.835,223,2.171,238,2.481]],["description/61",[356,6.108]],["title/62",[196,1.415,357,4.21,358,2.988]],["description/62",[64,1.456,94,2.037,101,2.138,130,2.028,171,3.24,196,1.403,285,3.611,358,2.963,359,4.175]],["title/63",[196,1.415,266,2.28,358,2.988]],["description/63",[60,1.946,64,1.23,68,1.285,74,1.647,76,2.992,94,1.72,101,1.285,130,1.218,155,2.169,196,1.771,236,1.946,266,1.358,358,3.332,360,2.508,361,2.508,362,2.508,363,2.508,364,2.508,365,2.508,366,2.508,367,2.508,368,2.508]],["title/64",[130,2.045,369,3.641,370,4.21]],["description/64",[369,5.283]]],"invertedIndex":[["",{"_index":68,"title":{},"description":{"1":{},"2":{},"9":{},"39":{},"49":{},"50":{},"52":{},"53":{},"63":{}}}],["0",{"_index":299,"title":{},"description":{"49":{},"50":{},"52":{},"53":{}}}],["1",{"_index":272,"title":{},"description":{"39":{},"49":{},"52":{}}}],["100",{"_index":107,"title":{},"description":{"2":{}}}],["1024x512",{"_index":310,"title":{},"description":{"50":{},"53":{}}}],["16",{"_index":328,"title":{},"description":{"53":{}}}],["16-bit",{"_index":215,"title":{},"description":{"27":{},"28":{}}}],["1d",{"_index":333,"title":{"55":{},"56":{}},"description":{}}],["32-bit",{"_index":329,"title":{"56":{}},"description":{"53":{}}}],["4-byte",{"_index":319,"title":{},"description":{"50":{}}}],["8",{"_index":323,"title":{},"description":{"50":{},"53":{}}}],["accept",{"_index":114,"title":{},"description":{"3":{}}}],["account",{"_index":303,"title":{},"description":{"50":{},"53":{}}}],["acquisit",{"_index":65,"title":{"1":{},"4":{},"5":{},"39":{},"40":{}},"description":{"3":{},"7":{},"8":{},"37":{}}}],["actual",{"_index":298,"title":{},"description":{"49":{},"52":{}}}],["adjust",{"_index":244,"title":{},"description":{"31":{},"33":{}}}],["affect",{"_index":145,"title":{},"description":{"5":{}}}],["again",{"_index":181,"title":{},"description":{"9":{}}}],["algorithm",{"_index":188,"title":{"11":{}},"description":{}}],["allow",{"_index":50,"title":{},"description":{"0":{},"29":{}}}],["alway",{"_index":176,"title":{},"description":{"8":{}}}],["and/or",{"_index":228,"title":{},"description":{"29":{}}}],["anytim",{"_index":186,"title":{},"description":{"10":{},"12":{},"14":{},"16":{},"18":{},"20":{},"23":{},"24":{},"26":{}}}],["api",{"_index":2,"title":{},"description":{"0":{}}}],["appli",{"_index":9,"title":{},"description":{"0":{},"53":{}}}],["applic",{"_index":17,"title":{},"description":{"0":{}}}],["approach",{"_index":30,"title":{},"description":{"0":{}}}],["array",{"_index":271,"title":{"56":{}},"description":{"39":{},"40":{},"50":{}}}],["asic",{"_index":175,"title":{},"description":{"8":{}}}],["assign",{"_index":317,"title":{},"description":{"50":{},"53":{}}}],["async",{"_index":87,"title":{},"description":{"1":{},"2":{}}}],["async_start",{"_index":119,"title":{},"description":{"3":{}}}],["automat",{"_index":182,"title":{},"description":{"9":{},"53":{}}}],["avail",{"_index":236,"title":{"30":{}},"description":{"35":{},"63":{}}}],["azimuth",{"_index":208,"title":{"25":{},"26":{},"56":{}},"description":{"50":{},"53":{}}}],["back",{"_index":168,"title":{},"description":{"7":{}}}],["base",{"_index":253,"title":{},"description":{"31":{}}}],["be",{"_index":157,"title":{},"description":{"7":{}}}],["beam",{"_index":304,"title":{},"description":{"50":{},"53":{}}}],["befor",{"_index":177,"title":{},"description":{"8":{}}}],["behavior",{"_index":110,"title":{},"description":{"3":{}}}],["between",{"_index":366,"title":{},"description":{"63":{}}}],["binari",{"_index":211,"title":{"27":{},"48":{},"49":{},"50":{},"56":{}},"description":{"27":{},"50":{}}}],["bit",{"_index":322,"title":{},"description":{"50":{},"53":{}}}],["blob",{"_index":214,"title":{},"description":{"27":{}}}],["block",{"_index":111,"title":{},"description":{"3":{},"4":{},"5":{}}}],["bodi",{"_index":122,"title":{},"description":{"3":{}}}],["both",{"_index":309,"title":{},"description":{"50":{},"53":{}}}],["bragg",{"_index":190,"title":{"13":{},"14":{}},"description":{}}],["buffer",{"_index":358,"title":{"62":{},"63":{}},"description":{"62":{},"63":{}}}],["calcul",{"_index":258,"title":{"35":{},"36":{}},"description":{}}],["calibr",{"_index":98,"title":{"47":{}},"description":{"2":{},"9":{}}}],["call",{"_index":60,"title":{},"description":{"0":{},"3":{},"63":{}}}],["cancel",{"_index":146,"title":{"7":{}},"description":{"5":{},"7":{}}}],["card",{"_index":153,"title":{},"description":{"7":{}}}],["case",{"_index":67,"title":{},"description":{"1":{},"3":{},"50":{},"53":{}}}],["cbor",{"_index":344,"title":{"58":{},"59":{}},"description":{}}],["cell",{"_index":82,"title":{},"description":{"1":{},"47":{}}}],["chang",{"_index":117,"title":{"9":{},"11":{},"13":{},"15":{},"17":{},"19":{}},"description":{"3":{},"9":{},"29":{},"31":{},"33":{}}}],["choos",{"_index":24,"title":{},"description":{"0":{},"29":{}}}],["clarif",{"_index":1,"title":{"0":{}},"description":{}}],["clear",{"_index":357,"title":{"62":{}},"description":{}}],["client",{"_index":15,"title":{},"description":{"0":{},"4":{},"5":{}}}],["close",{"_index":73,"title":{},"description":{"1":{},"2":{},"4":{},"5":{}}}],["code",{"_index":19,"title":{"40":{}},"description":{"0":{},"40":{}}}],["collect",{"_index":94,"title":{"2":{},"7":{},"21":{},"22":{},"35":{},"36":{},"46":{}},"description":{"4":{},"5":{},"7":{},"9":{},"23":{},"46":{},"59":{},"62":{},"63":{}}}],["come",{"_index":350,"title":{},"description":{"59":{}}}],["command",{"_index":144,"title":{},"description":{"5":{},"7":{},"8":{},"29":{}}}],["commun",{"_index":57,"title":{},"description":{"0":{}}}],["config/azim_int",{"_index":209,"title":{},"description":{"25":{},"26":{}}}],["config/bragg_integr",{"_index":191,"title":{},"description":{"13":{},"14":{}}}],["config/dark_mask",{"_index":265,"title":{},"description":{"35":{},"36":{}}}],["config/detector",{"_index":185,"title":{},"description":{"9":{},"10":{}}}],["config/file_writ",{"_index":192,"title":{},"description":{"15":{},"16":{}}}],["config/image_format",{"_index":199,"title":{},"description":{"19":{},"20":{}}}],["config/image_format/convers",{"_index":204,"title":{},"description":{"22":{}}}],["config/image_format/raw",{"_index":201,"title":{},"description":{"21":{}}}],["config/index",{"_index":189,"title":{},"description":{"11":{},"12":{}}}],["config/instru",{"_index":195,"title":{},"description":{"17":{},"18":{}}}],["config/internal_generator_imag",{"_index":222,"title":{},"description":{"27":{}}}],["config/internal_generator_image.tiff",{"_index":224,"title":{},"description":{"28":{}}}],["config/mask",{"_index":297,"title":{},"description":{"48":{}}}],["config/mask.tiff",{"_index":325,"title":{},"description":{"51":{}}}],["config/roi",{"_index":281,"title":{},"description":{"43":{},"44":{}}}],["config/select_detector",{"_index":235,"title":{},"description":{"29":{},"30":{}}}],["config/spot_find",{"_index":207,"title":{},"description":{"23":{},"24":{}}}],["config/user_mask",{"_index":301,"title":{},"description":{"49":{},"50":{}}}],["config/user_mask.tiff",{"_index":326,"title":{},"description":{"52":{},"53":{}}}],["config/zeromq_metadata",{"_index":257,"title":{},"description":{"33":{},"34":{}}}],["config/zeromq_preview",{"_index":254,"title":{},"description":{"31":{},"32":{}}}],["configur",{"_index":179,"title":{"9":{},"10":{},"12":{},"14":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"35":{}},"description":{"30":{}}}],["connect",{"_index":141,"title":{},"description":{"4":{},"5":{}}}],["consist",{"_index":232,"title":{},"description":{"29":{}}}],["contain",{"_index":246,"title":{},"description":{"31":{},"33":{},"58":{},"59":{}}}],["control",{"_index":226,"title":{},"description":{"29":{}}}],["convers",{"_index":203,"title":{"22":{}},"description":{"50":{},"53":{}}}],["convert",{"_index":313,"title":{},"description":{"50":{},"53":{}}}],["coordin",{"_index":220,"title":{},"description":{"27":{},"28":{},"49":{},"50":{},"52":{},"53":{}}}],["copyleft",{"_index":7,"title":{},"description":{"0":{}}}],["cover",{"_index":256,"title":{},"description":{"33":{}}}],["cpu",{"_index":159,"title":{},"description":{"7":{}}}],["current",{"_index":96,"title":{"2":{},"39":{},"40":{}},"description":{"7":{}}}],["custom",{"_index":354,"title":{"60":{}},"description":{}}],["dark",{"_index":95,"title":{"2":{},"35":{},"36":{}},"description":{}}],["data",{"_index":64,"title":{"1":{},"7":{},"21":{},"22":{},"24":{},"35":{},"36":{},"39":{},"40":{},"46":{},"56":{}},"description":{"3":{},"4":{},"5":{},"7":{},"8":{},"23":{},"31":{},"33":{},"37":{},"46":{},"59":{},"62":{},"63":{}}}],["dataset",{"_index":345,"title":{},"description":{"58":{}}}],["deactiv",{"_index":172,"title":{},"description":{"8":{}}}],["dectri",{"_index":260,"title":{},"description":{"35":{}}}],["default",{"_index":109,"title":{},"description":{"3":{}}}],["definit",{"_index":3,"title":{"43":{},"44":{}},"description":{"0":{}}}],["depend",{"_index":221,"title":{},"description":{"27":{},"28":{}}}],["deriv",{"_index":47,"title":{},"description":{"0":{}}}],["detector",{"_index":63,"title":{"1":{},"2":{},"3":{},"6":{},"8":{},"9":{},"10":{},"29":{},"30":{},"42":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{}},"description":{"1":{},"2":{},"3":{},"4":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"21":{},"22":{},"25":{},"27":{},"28":{},"29":{},"30":{},"35":{},"42":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{}}}],["detector/statu",{"_index":279,"title":{},"description":{"42":{}}}],["develop",{"_index":37,"title":{},"description":{"0":{}}}],["devic",{"_index":267,"title":{"38":{}},"description":{}}],["distribut",{"_index":22,"title":{},"description":{"0":{}}}],["doesn't",{"_index":337,"title":{"56":{}},"description":{}}],["don't",{"_index":316,"title":{},"description":{"50":{},"53":{}}}],["done",{"_index":93,"title":{"5":{}},"description":{"1":{},"2":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"35":{}}}],["dure",{"_index":76,"title":{},"description":{"1":{},"9":{},"63":{}}}],["e.g",{"_index":346,"title":{},"description":{"58":{}}}],["each",{"_index":287,"title":{},"description":{"47":{}}}],["effect",{"_index":169,"title":{},"description":{"7":{},"9":{},"31":{}}}],["eiger",{"_index":263,"title":{},"description":{"35":{}}}],["ensur",{"_index":92,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{}}}],["error",{"_index":70,"title":{},"description":{"1":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"21":{},"22":{},"35":{}}}],["etc",{"_index":46,"title":{},"description":{"0":{}}}],["event",{"_index":275,"title":{"40":{}},"description":{"40":{}}}],["exampl",{"_index":302,"title":{},"description":{"50":{},"53":{}}}],["except",{"_index":25,"title":{},"description":{"0":{}}}],["execut",{"_index":83,"title":{},"description":{"1":{},"4":{},"5":{},"9":{}}}],["expect",{"_index":318,"title":{},"description":{"50":{},"53":{}}}],["experiment",{"_index":347,"title":{},"description":{"58":{}}}],["explicitli",{"_index":38,"title":{},"description":{"0":{}}}],["extend",{"_index":138,"title":{},"description":{"4":{},"5":{}}}],["extern",{"_index":127,"title":{},"description":{"4":{},"5":{}}}],["few",{"_index":85,"title":{},"description":{"1":{}}}],["file",{"_index":10,"title":{"15":{},"16":{}},"description":{"0":{}}}],["find",{"_index":206,"title":{"23":{}},"description":{"50":{},"53":{}}}],["finish",{"_index":143,"title":{},"description":{"5":{},"7":{}}}],["float",{"_index":336,"title":{"56":{}},"description":{}}],["format",{"_index":198,"title":{"19":{},"20":{},"21":{},"22":{},"54":{},"56":{},"58":{},"59":{},"60":{},"61":{}},"description":{}}],["fpga",{"_index":152,"title":{"27":{},"28":{},"38":{}},"description":{"7":{},"27":{},"28":{}}}],["fpga_statu",{"_index":268,"title":{},"description":{"38":{}}}],["frame",{"_index":156,"title":{},"description":{"7":{}}}],["full",{"_index":202,"title":{"22":{},"57":{}},"description":{"48":{},"51":{},"59":{}}}],["function",{"_index":88,"title":{},"description":{"1":{},"2":{}}}],["gap",{"_index":315,"title":{},"description":{"50":{},"53":{}}}],["gcc",{"_index":33,"title":{},"description":{"0":{}}}],["gener",{"_index":13,"title":{"27":{},"28":{},"45":{},"55":{},"56":{}},"description":{"0":{},"6":{},"27":{},"28":{},"31":{},"33":{}}}],["geometri",{"_index":348,"title":{},"description":{"58":{}}}],["given",{"_index":162,"title":{},"description":{"7":{}}}],["goe",{"_index":362,"title":{},"description":{"63":{}}}],["good",{"_index":300,"title":{},"description":{"49":{},"50":{},"52":{},"53":{}}}],["gpl",{"_index":6,"title":{},"description":{"0":{}}}],["gpl-3.0",{"_index":5,"title":{},"description":{"0":{}}}],["gracefulli",{"_index":165,"title":{},"description":{"7":{}}}],["happen",{"_index":213,"title":{},"description":{"27":{},"28":{}}}],["header",{"_index":32,"title":{},"description":{"0":{}}}],["here",{"_index":243,"title":{},"description":{"31":{},"33":{}}}],["high",{"_index":173,"title":{},"description":{"8":{}}}],["hour",{"_index":104,"title":{},"description":{"2":{}}}],["http",{"_index":249,"title":{},"description":{"31":{},"33":{}}}],["i.",{"_index":180,"title":{},"description":{"9":{},"53":{}}}],["id",{"_index":231,"title":{"39":{}},"description":{"29":{},"39":{}}}],["idl",{"_index":100,"title":{},"description":{"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"21":{},"22":{},"25":{},"27":{},"28":{},"35":{},"50":{},"51":{},"53":{}}}],["ignor",{"_index":250,"title":{},"description":{"31":{},"33":{},"50":{},"53":{}}}],["imag",{"_index":196,"title":{"19":{},"20":{},"27":{},"28":{},"41":{},"59":{},"60":{},"61":{},"62":{},"63":{}},"description":{"27":{},"28":{},"33":{},"39":{},"53":{},"59":{},"62":{},"63":{}}}],["image.cbor",{"_index":367,"title":{},"description":{"63":{}}}],["image_buffer/clear",{"_index":359,"title":{},"description":{"62":{}}}],["image_buffer/image.cbor",{"_index":352,"title":{},"description":{"59":{}}}],["image_buffer/image.jpeg",{"_index":355,"title":{},"description":{"60":{}}}],["image_buffer/image.tiff",{"_index":356,"title":{},"description":{"61":{}}}],["image_buffer/start.cbor",{"_index":349,"title":{},"description":{"58":{}}}],["image_buffer/statu",{"_index":368,"title":{},"description":{"63":{}}}],["image_pusher/statu",{"_index":278,"title":{},"description":{"41":{}}}],["immedi",{"_index":124,"title":{},"description":{"3":{}}}],["implement",{"_index":16,"title":{},"description":{"0":{}}}],["impos",{"_index":54,"title":{},"description":{"0":{}}}],["inact",{"_index":69,"title":{},"description":{"1":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"21":{},"22":{},"25":{},"29":{},"35":{}}}],["includ",{"_index":360,"title":{},"description":{"63":{}}}],["indefinit",{"_index":133,"title":{},"description":{"4":{},"5":{}}}],["index",{"_index":187,"title":{"11":{},"12":{}},"description":{}}],["inform",{"_index":151,"title":{"56":{}},"description":{"7":{}}}],["initi",{"_index":62,"title":{"1":{},"49":{},"52":{}},"description":{"1":{},"5":{},"48":{}}}],["instead",{"_index":80,"title":{},"description":{"1":{}}}],["instrument",{"_index":193,"title":{"17":{},"18":{}},"description":{}}],["integ",{"_index":216,"title":{},"description":{"27":{},"28":{},"53":{}}}],["integr",{"_index":106,"title":{"13":{},"14":{},"25":{},"26":{},"56":{}},"description":{"2":{},"50":{},"53":{}}}],["intend",{"_index":49,"title":{},"description":{"0":{}}}],["interact",{"_index":18,"title":{},"description":{"0":{}}}],["interfac",{"_index":43,"title":{},"description":{"0":{},"1":{}}}],["intern",{"_index":212,"title":{"27":{},"28":{}},"description":{"27":{},"28":{}}}],["ioctl",{"_index":45,"title":{},"description":{"0":{}}}],["jfjoch_brok",{"_index":370,"title":{"64":{}},"description":{}}],["jpeg",{"_index":353,"title":{"60":{}},"description":{}}],["jungfrau",{"_index":99,"title":{},"description":{"2":{},"42":{}}}],["jungfraujoch",{"_index":130,"title":{"37":{},"55":{},"56":{},"64":{}},"description":{"4":{},"29":{},"31":{},"33":{},"62":{},"63":{}}}],["kernel",{"_index":36,"title":{},"description":{"0":{}}}],["kernel'",{"_index":29,"title":{},"description":{"0":{}}}],["last",{"_index":285,"title":{},"description":{"46":{},"62":{}}}],["latest",{"_index":351,"title":{},"description":{"59":{}}}],["latter",{"_index":314,"title":{},"description":{"50":{},"53":{}}}],["librari",{"_index":35,"title":{},"description":{"0":{}}}],["licens",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["limit",{"_index":340,"title":{"56":{}},"description":{}}],["linux",{"_index":28,"title":{},"description":{"0":{}}}],["list",{"_index":230,"title":{"30":{}},"description":{"29":{}}}],["load",{"_index":210,"title":{"27":{},"28":{}},"description":{"27":{},"28":{}}}],["long",{"_index":105,"title":{},"description":{"2":{}}}],["make",{"_index":163,"title":{},"description":{"7":{}}}],["mask",{"_index":259,"title":{"35":{},"36":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{}},"description":{"48":{},"49":{},"50":{},"51":{},"52":{},"53":{}}}],["mean",{"_index":295,"title":{},"description":{"48":{},"51":{}}}],["mechan",{"_index":61,"title":{},"description":{"0":{}}}],["mere",{"_index":42,"title":{},"description":{"0":{}}}],["messag",{"_index":239,"title":{"58":{},"59":{}},"description":{"31":{},"33":{}}}],["metadata",{"_index":194,"title":{"17":{},"18":{},"33":{},"34":{}},"description":{"33":{},"58":{},"59":{}}}],["minut",{"_index":86,"title":{},"description":{"1":{}}}],["misbehav",{"_index":306,"title":{},"description":{"50":{},"53":{}}}],["mode",{"_index":308,"title":{},"description":{"50":{},"53":{}}}],["modul",{"_index":312,"title":{},"description":{"50":{},"53":{}}}],["module/storag",{"_index":288,"title":{},"description":{"47":{}}}],["moment",{"_index":261,"title":{},"description":{"35":{}}}],["more",{"_index":363,"title":{},"description":{"63":{}}}],["multipl",{"_index":227,"title":{},"description":{"29":{}}}],["need",{"_index":90,"title":{},"description":{"1":{},"2":{},"3":{},"50":{},"53":{}}}],["network",{"_index":59,"title":{},"description":{"0":{},"1":{},"7":{}}}],["new",{"_index":183,"title":{},"description":{"9":{}}}],["number",{"_index":217,"title":{},"description":{"27":{},"28":{}}}],["nxmx",{"_index":293,"title":{},"description":{"48":{},"50":{},"51":{},"53":{}}}],["on",{"_index":89,"title":{},"description":{"1":{},"2":{},"3":{},"9":{},"29":{}}}],["onc",{"_index":102,"title":{},"description":{"2":{}}}],["openapi",{"_index":14,"title":{},"description":{"0":{}}}],["oper",{"_index":74,"title":{},"description":{"1":{},"2":{},"9":{},"35":{},"63":{}}}],["option",{"_index":252,"title":{},"description":{"31":{}}}],["output",{"_index":197,"title":{"19":{},"20":{}},"description":{}}],["pedest",{"_index":79,"title":{"54":{}},"description":{"1":{},"2":{},"5":{},"7":{},"9":{}}}],["per",{"_index":103,"title":{},"description":{"2":{}}}],["period",{"_index":134,"title":{},"description":{"4":{},"5":{}}}],["pixel",{"_index":291,"title":{},"description":{"48":{},"49":{},"50":{},"51":{},"52":{},"53":{}}}],["plot",{"_index":334,"title":{"55":{},"56":{}},"description":{}}],["point",{"_index":264,"title":{},"description":{"35":{}}}],["possibl",{"_index":139,"title":{},"description":{"4":{},"5":{},"35":{}}}],["post",{"_index":78,"title":{},"description":{"1":{},"2":{}}}],["power",{"_index":178,"title":{},"description":{"8":{}}}],["prepar",{"_index":170,"title":{"8":{}},"description":{}}],["preview",{"_index":238,"title":{"31":{},"32":{},"60":{},"61":{}},"description":{"31":{}}}],["preview/pedestal.tiff",{"_index":332,"title":{},"description":{"54":{}}}],["preview/plot",{"_index":335,"title":{},"description":{"55":{}}}],["preview/plot.bin",{"_index":341,"title":{},"description":{"56":{}}}],["procedur",{"_index":135,"title":{},"description":{"4":{},"5":{},"9":{}}}],["process",{"_index":158,"title":{"24":{}},"description":{"7":{}}}],["program",{"_index":41,"title":{},"description":{"0":{}}}],["provid",{"_index":136,"title":{"56":{}},"description":{"4":{},"5":{},"29":{},"47":{}}}],["provis",{"_index":8,"title":{},"description":{"0":{}}}],["psi",{"_index":262,"title":{},"description":{"35":{}}}],["pub",{"_index":255,"title":{},"description":{"33":{}}}],["puls",{"_index":270,"title":{"39":{}},"description":{"39":{}}}],["pusher",{"_index":277,"title":{"41":{}},"description":{}}],["put",{"_index":251,"title":{},"description":{"31":{},"33":{}}}],["raw",{"_index":200,"title":{"21":{},"56":{}},"description":{"50":{},"53":{}}}],["raw/convert",{"_index":219,"title":{},"description":{"27":{},"28":{}}}],["readi",{"_index":113,"title":{},"description":{"3":{},"4":{}}}],["recommend",{"_index":77,"title":{},"description":{"1":{},"2":{}}}],["reconfigur",{"_index":75,"title":{},"description":{"1":{}}}],["record",{"_index":273,"title":{},"description":{"39":{}}}],["regardless",{"_index":55,"title":{},"description":{"0":{}}}],["region",{"_index":307,"title":{},"description":{"50":{},"53":{}}}],["region-of-interest",{"_index":229,"title":{},"description":{"29":{}}}],["reiniti",{"_index":234,"title":{},"description":{"29":{}}}],["replac",{"_index":365,"title":{},"description":{"63":{}}}],["request",{"_index":121,"title":{},"description":{"3":{},"31":{},"33":{}}}],["requir",{"_index":21,"title":{},"description":{"0":{},"4":{},"5":{},"27":{},"28":{},"29":{}}}],["respons",{"_index":233,"title":{},"description":{"29":{}}}],["result",{"_index":284,"title":{"57":{}},"description":{"46":{}}}],["result/scan",{"_index":343,"title":{},"description":{"57":{}}}],["retri",{"_index":142,"title":{},"description":{"4":{},"5":{}}}],["return",{"_index":123,"title":{"39":{},"40":{}},"description":{"3":{},"39":{},"40":{}}}],["roi",{"_index":280,"title":{"43":{},"44":{}},"description":{}}],["run",{"_index":101,"title":{"4":{},"7":{}},"description":{"2":{},"3":{},"5":{},"7":{},"23":{},"62":{},"63":{}}}],["runtim",{"_index":34,"title":{},"description":{"0":{}}}],["safeti",{"_index":140,"title":{},"description":{"4":{},"5":{}}}],["save",{"_index":184,"title":{},"description":{"9":{}}}],["scan",{"_index":342,"title":{"57":{}},"description":{}}],["script",{"_index":128,"title":{},"description":{"4":{},"5":{}}}],["see",{"_index":292,"title":{},"description":{"48":{},"51":{}}}],["select",{"_index":225,"title":{"29":{}},"description":{"30":{}}}],["send",{"_index":149,"title":{"6":{},"56":{}},"description":{}}],["sent",{"_index":160,"title":{},"description":{"7":{}}}],["separ",{"_index":289,"title":{},"description":{"47":{}}}],["server",{"_index":132,"title":{},"description":{"4":{},"5":{}}}],["set",{"_index":118,"title":{"11":{},"13":{},"15":{},"16":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"60":{}},"description":{"3":{},"9":{},"27":{},"28":{},"29":{},"31":{},"33":{}}}],["shadow",{"_index":305,"title":{},"description":{"50":{},"53":{}}}],["shutter",{"_index":72,"title":{},"description":{"1":{},"2":{}}}],["sign",{"_index":330,"title":{},"description":{"53":{}}}],["similar",{"_index":26,"title":{},"description":{"0":{}}}],["single-channel",{"_index":327,"title":{},"description":{"53":{}}}],["size",{"_index":218,"title":{},"description":{"27":{},"28":{}}}],["slot",{"_index":364,"title":{},"description":{"63":{}}}],["socket",{"_index":242,"title":{"34":{}},"description":{"31":{},"33":{}}}],["socket_address",{"_index":247,"title":{},"description":{"31":{},"33":{}}}],["soft",{"_index":150,"title":{"6":{}},"description":{"6":{}}}],["soft/ttl",{"_index":115,"title":{},"description":{"3":{}}}],["softwar",{"_index":148,"title":{},"description":{"5":{}}}],["sole",{"_index":12,"title":{},"description":{"0":{}}}],["specif",{"_index":52,"title":{},"description":{"0":{}}}],["spirit",{"_index":27,"title":{},"description":{"0":{}}}],["spot",{"_index":205,"title":{"23":{}},"description":{"50":{},"53":{}}}],["stack",{"_index":311,"title":{},"description":{"50":{},"53":{}}}],["stage",{"_index":155,"title":{},"description":{"7":{},"63":{}}}],["standard",{"_index":294,"title":{},"description":{"48":{},"51":{}}}],["start",{"_index":108,"title":{"3":{},"58":{}},"description":{"3":{}}}],["state",{"_index":39,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"21":{},"22":{},"27":{},"28":{},"29":{},"35":{},"50":{},"51":{},"53":{}}}],["statist",{"_index":283,"title":{"45":{},"46":{},"47":{}},"description":{"45":{},"47":{}}}],["statistics/calibr",{"_index":290,"title":{},"description":{"47":{}}}],["statistics/data_collect",{"_index":286,"title":{},"description":{"46":{}}}],["statu",{"_index":266,"title":{"37":{},"38":{},"41":{},"42":{},"63":{}},"description":{"37":{},"42":{},"63":{}}}],["stop",{"_index":154,"title":{},"description":{"7":{},"50":{},"53":{}}}],["storag",{"_index":81,"title":{},"description":{"1":{}}}],["store",{"_index":321,"title":{},"description":{"50":{},"53":{}}}],["stream",{"_index":240,"title":{},"description":{"31":{},"33":{}}}],["structur",{"_index":245,"title":{},"description":{"31":{},"33":{}}}],["sub",{"_index":241,"title":{},"description":{"31":{}}}],["subject",{"_index":20,"title":{},"description":{"0":{}}}],["sure",{"_index":164,"title":{},"description":{"7":{}}}],["switch",{"_index":167,"title":{},"description":{"7":{}}}],["synchron",{"_index":147,"title":{},"description":{"5":{}}}],["syscal",{"_index":44,"title":{},"description":{"0":{}}}],["take",{"_index":166,"title":{},"description":{"7":{}}}],["term",{"_index":23,"title":{},"description":{"0":{}}}],["through",{"_index":58,"title":{},"description":{"0":{}}}],["tiff",{"_index":223,"title":{"28":{},"51":{},"52":{},"54":{},"61":{}},"description":{"28":{},"53":{}}}],["till",{"_index":129,"title":{},"description":{"4":{},"5":{}}}],["time",{"_index":84,"title":{},"description":{"1":{},"2":{},"4":{},"5":{},"7":{}}}],["timeout",{"_index":137,"title":{},"description":{"4":{},"5":{}}}],["transmit",{"_index":338,"title":{"56":{}},"description":{}}],["trigger",{"_index":116,"title":{"6":{}},"description":{"3":{},"6":{}}}],["true",{"_index":120,"title":{},"description":{"3":{}}}],["turn",{"_index":171,"title":{"8":{}},"description":{"8":{},"62":{}}}],["two",{"_index":66,"title":{},"description":{"1":{}}}],["under",{"_index":4,"title":{},"description":{"0":{}}}],["unsign",{"_index":320,"title":{},"description":{"50":{},"53":{}}}],["until",{"_index":112,"title":{},"description":{"3":{}}}],["updat",{"_index":97,"title":{},"description":{"2":{}}}],["upload",{"_index":282,"title":{"44":{},"50":{},"53":{}},"description":{"50":{},"53":{}}}],["us",{"_index":11,"title":{"56":{},"60":{}},"description":{"0":{},"1":{},"2":{},"3":{},"8":{},"30":{},"50":{},"53":{}}}],["user",{"_index":40,"title":{"49":{},"50":{},"52":{},"53":{}},"description":{"0":{},"49":{},"50":{},"52":{},"53":{}}}],["userspac",{"_index":31,"title":{},"description":{"0":{}}}],["valid",{"_index":331,"title":{},"description":{"53":{}}}],["valu",{"_index":296,"title":{"56":{}},"description":{"48":{},"50":{},"51":{},"53":{}}}],["version",{"_index":369,"title":{"64":{}},"description":{"64":{}}}],["via",{"_index":248,"title":{},"description":{"31":{},"33":{}}}],["volatil",{"_index":361,"title":{},"description":{"63":{}}}],["voltag",{"_index":174,"title":{},"description":{"8":{}}}],["wait",{"_index":126,"title":{"4":{},"5":{}},"description":{}}],["wait_till_don",{"_index":91,"title":{},"description":{"1":{},"2":{},"5":{}}}],["wait_until_run",{"_index":125,"title":{},"description":{"3":{},"4":{}}}],["web",{"_index":131,"title":{},"description":{"4":{},"5":{}}}],["well",{"_index":324,"title":{},"description":{"50":{},"53":{}}}],["whether",{"_index":56,"title":{},"description":{"0":{}}}],["wider",{"_index":51,"title":{},"description":{"0":{}}}],["without",{"_index":53,"title":{},"description":{"0":{}}}],["work",{"_index":48,"title":{},"description":{"0":{}}}],["writer",{"_index":161,"title":{"15":{},"16":{}},"description":{"7":{}}}],["x-axi",{"_index":339,"title":{"56":{}},"description":{}}],["x-ray",{"_index":71,"title":{},"description":{"1":{},"2":{},"9":{}}}],["xfel",{"_index":269,"title":{"39":{},"40":{}},"description":{"39":{},"40":{}}}],["xfel/event_cod",{"_index":276,"title":{},"description":{"40":{}}}],["xfel/pulse_id",{"_index":274,"title":{},"description":{"39":{}}}],["zeromq",{"_index":237,"title":{"31":{},"32":{},"33":{},"34":{}},"description":{"31":{},"33":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/common/DiffractionExperiment.cpp b/common/DiffractionExperiment.cpp
index da698cf65..19cc77b5c 100644
--- a/common/DiffractionExperiment.cpp
+++ b/common/DiffractionExperiment.cpp
@@ -1535,8 +1535,10 @@ std::vector<DetectorTransformation> DiffractionExperiment::BuildTransformationCh
             axis.Value(goniometer->GetStart_deg());
         add(std::move(axis));
     } else if (GetGridScan().has_value()) {
-        // A grid scan still sits on a spindle that simply does not turn. NXmx cannot say "there is no
-        // rotation", and a sample chain of translations alone is not something readers accept.
+        // A grid scan still sits on a spindle that simply does not turn, and 0 is a placeholder for
+        // an angle nobody told us: send the axis with step 0 and the position it really stood at is
+        // written instead. NXmx does allow a sample with no goniometer at all (depends_on "."), but
+        // a sample chain of translations alone is not something readers accept - dxtbx raises on it.
         add(DetectorTransformation("omega", TransformationType::Rotation, {-1, 0, 0}).Value(0.0f));
     }
 
diff --git a/docs/CBOR.md b/docs/CBOR.md
index f467af4d6..095c256a8 100644
--- a/docs/CBOR.md
+++ b/docs/CBOR.md
@@ -59,7 +59,7 @@ There are minor differences at the moment:
 | - - axis                         | Array(float)         | Vector for the rotation axis                                                                                                                   |                           |
 | - - helical_step                 | Array(float)         | Translation for helical scan for 1 image \[m\]                                                                                                 |                           |
 | - - screening_wedge              | Array(float)         | Wedge for screening \[deg\] (increment would correspond to difference between screening points)                                                |                           |
-| grid_scan                        | object               | Grid scan definition (optional). May be sent together with `goniometer`: a grid is often collected at a given head position, recorded as a stationary axis (step 0)                |                           |
+| grid_scan                        | object               | Grid scan definition (optional). Send `goniometer` with it, `increment` 0, to state the angle the spindle stood at; without one the spindle is recorded at 0, meaning "nobody said"                |                           |
 | - n_fast                         | uint64               | Number of elements along fast axis                                                                                                             |                           |
 | - n_slow                         | uint64               | Number of elements along slow axis                                                                                                             |                           |
 | - step_x_axis                    | float                | Step along X axis, can be negative \[m\]                                                                                                       |                           |
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
index b491bb452..7b6a77718 100644
--- a/docs/CHANGELOG.md
+++ b/docs/CHANGELOG.md
@@ -30,6 +30,7 @@
 * `dataset_settings` takes `beam_size_x_um`/`beam_size_y_um`, the size of the X-ray beam at the sample, and `jfjoch_writer` writes them as `incident_beam_size` in the HDF5 master.
 * `dataset_settings` accepts any `smargon.chi_deg`, which was restricted to 0-90 degrees.
 * `jfjoch_viewer` reads PILATUS miniCBF sweeps natively, and draws grid scan cells in the proportion of the scan steps.
+* The HDF5 and API documentation say how a grid scan records the angle its spindle stood at: send the goniometer axis with a step of 0.
 * The rugnux manual is reorganised into task pages with a run overview, and gains worked phenix / REFMAC5 / POINTLESS-AIMLESS / careless examples.
 * `jfjoch_viewer` labels the merge-statistics plot over the range the axis is drawn on, so the CC1/2 curve is no longer read against tick labels covering only part of it.
 
diff --git a/docs/HDF5.md b/docs/HDF5.md
index 00934aa3c..1bd2c6ebb 100644
--- a/docs/HDF5.md
+++ b/docs/HDF5.md
@@ -275,6 +275,14 @@ the one nearest the sample. It may hold, in that order: the grid-scan translatio
 `grid_scan_y`, the spindle, and a Smargon head's `chi` and `phi`. A grid scan and a goniometer axis
 are **not** alternatives; both can be present.
 
+A **grid scan is collected at a stationary spindle, and the angle it stood at is stated by sending
+the goniometer axis with a step of 0** — in `dataset_settings.goniometer`, or as the `goniometer`
+map of the CBOR start message. The angle is then written per image as `omega` (or whatever the axis
+is named) in the chain above, and read back by `reader/`. Send no axis and the spindle is still
+recorded, at 0: NXmx would allow a sample with no goniometer at all (`depends_on = "."`), but a
+sample chain of translations alone is not something readers accept, so the placeholder is written
+whether or not the angle is known. **A 0 there means "nobody said", not "the spindle was at 0".**
+
 A **Smargon head position is told apart from the spindle** by the `equipment_component` attribute,
 which is `"smargon"` on `chi` and `phi` and absent on the spindle. This is load-bearing: a spindle can
 itself be named `phi`, and without the attribute a reader would take a head position for the scan
diff --git a/docs/python_client/docs/GridScan.md b/docs/python_client/docs/GridScan.md
index c47a8a46d..fdcb803e3 100644
--- a/docs/python_client/docs/GridScan.md
+++ b/docs/python_client/docs/GridScan.md
@@ -1,6 +1,6 @@
 # GridScan
 
-Definition of a grid scan. May be combined with a goniometer axis: a grid is often collected at a particular head position, and a stationary axis records where that was. 
+Definition of a grid scan. Combine it with a goniometer axis to state the angle the spindle stood at: send `goniometer` with `step` 0 and the `start` angle of the grid scan, and that angle is written per image into the NXmx sample transformation chain. Without one the spindle is recorded at 0, which says that nobody stated an angle rather than that the spindle stood at 0. 
 
 ## Properties
 
diff --git a/docs/python_client/docs/RotationAxis.md b/docs/python_client/docs/RotationAxis.md
index a78b26ba2..ce026df29 100644
--- a/docs/python_client/docs/RotationAxis.md
+++ b/docs/python_client/docs/RotationAxis.md
@@ -7,7 +7,7 @@ Definition of a crystal rotation axis
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **str** | Name of rotation axis (e.g., omega, phi) | [optional] [default to 'omega']
-**step** | **float** | Angle step (per image) in degrees | 
+**step** | **float** | Angle step (per image) in degrees. 0 for an axis that does not turn: the axis then records the angle the spindle stood at, which is how a grid scan or a set of stills states its head position.  | 
 **start** | **float** | Start angle in degrees | [optional] [default to 0]
 **vector** | **List[float]** | Rotation axis | 
 **helical_step_um** | **List[float]** | Translation (per image) for helical scan | [optional] 
diff --git a/frontend/src/client/types.gen.ts b/frontend/src/client/types.gen.ts
index f8e10bf88..812ee65da 100644
--- a/frontend/src/client/types.gen.ts
+++ b/frontend/src/client/types.gen.ts
@@ -5,8 +5,11 @@ export type ClientOptions = {
 };
 
 /**
- * Definition of a grid scan. May be combined with a goniometer axis: a grid is often collected
- * at a particular head position, and a stationary axis records where that was.
+ * Definition of a grid scan. Combine it with a goniometer axis to state the angle the spindle
+ * stood at: send `goniometer` with `step` 0 and the `start` angle of the grid scan, and that
+ * angle is written per image into the NXmx sample transformation chain. Without one the
+ * spindle is recorded at 0, which says that nobody stated an angle rather than that the
+ * spindle stood at 0.
  *
  */
 export type grid_scan = {
@@ -50,7 +53,10 @@ export type rotation_axis = {
      */
     name?: string;
     /**
-     * Angle step (per image) in degrees
+     * Angle step (per image) in degrees. 0 for an axis that does not turn: the axis then
+     * records the angle the spindle stood at, which is how a grid scan or a set of stills
+     * states its head position.
+     *
      */
     step: number;
     /**
diff --git a/frontend/src/client/zod.gen.ts b/frontend/src/client/zod.gen.ts
index 97f073f41..da9254f7f 100644
--- a/frontend/src/client/zod.gen.ts
+++ b/frontend/src/client/zod.gen.ts
@@ -3,8 +3,11 @@
 import * as z from 'zod';
 
 /**
- * Definition of a grid scan. May be combined with a goniometer axis: a grid is often collected
- * at a particular head position, and a stationary axis records where that was.
+ * Definition of a grid scan. Combine it with a goniometer axis to state the angle the spindle
+ * stood at: send `goniometer` with `step` 0 and the `start` angle of the grid scan, and that
+ * angle is written per image into the NXmx sample transformation chain. Without one the
+ * spindle is recorded at 0, which says that nobody stated an angle rather than that the
+ * spindle stood at 0.
  *
  */
 export const zGridScan = z.object({
diff --git a/tests/CBORTest.cpp b/tests/CBORTest.cpp
index 80c8addfa..4c36ea360 100644
--- a/tests/CBORTest.cpp
+++ b/tests/CBORTest.cpp
@@ -233,6 +233,32 @@ TEST_CASE("CBORSerialize_Start_GridScan", "[CBOR]") {
     CHECK(output_message.grid_scan->GetGridElemSlow_um() == Catch::Approx(grid.GetGridElemSlow_um()));
 }
 
+// A grid scan and a goniometer axis travel together on the wire: the axis with increment 0 is how
+// the angle the spindle stood at reaches the file.
+TEST_CASE("CBORSerialize_Start_GridScanAtStationaryAxis", "[CBOR]") {
+    GridScanSettings grid(20, 5.0, 5.0, false, false);
+    GoniometerAxis axis("omega", 90.0f, 0.0f, Coord(-1, 0, 0), {});
+    StartMessage message{
+        .grid_scan = grid,
+        .goniometer = axis
+    };
+    std::vector<uint8_t> buffer(8 * 1024 * 1024);
+    CBORStream2Serializer serializer(buffer.data(), buffer.size());
+    REQUIRE_NOTHROW(serializer.SerializeSequenceStart(message));
+
+    auto deserialized = CBORStream2Deserialize(buffer.data(), serializer.GetBufferSize());
+    REQUIRE(deserialized);
+    REQUIRE(deserialized->start_message);
+    StartMessage &output_message = *deserialized->start_message;
+
+    REQUIRE(output_message.grid_scan.has_value());
+    CHECK(output_message.grid_scan->GetNFast() == grid.GetNFast());
+    REQUIRE(output_message.goniometer.has_value());
+    CHECK(output_message.goniometer->GetName() == "omega");
+    CHECK(!output_message.goniometer->IsScanning());
+    CHECK(output_message.goniometer->GetStart_deg() == Catch::Approx(90.0f));
+}
+
 TEST_CASE("CBORSerialize_Start_ThresholdEnergy", "[CBOR]") {
     std::vector<uint8_t> buffer(8 * 1024 * 1024);
     CBORStream2Serializer serializer(buffer.data(), buffer.size());
diff --git a/tests/DiffractionExperimentTest.cpp b/tests/DiffractionExperimentTest.cpp
index 1002c173f..930bc9ad1 100644
--- a/tests/DiffractionExperimentTest.cpp
+++ b/tests/DiffractionExperimentTest.cpp
@@ -8,7 +8,9 @@
 #include "../common/NetworkAddressConvert.h"
 
 #include <nlohmann/json.hpp>
+#include "Dataset_settings.h"
 #include "Dataset_settings_smargon.h"
+#include "../broker/OpenAPIConvert.h"
 
 using namespace std::literals::chrono_literals;
 
@@ -1238,3 +1240,25 @@ TEST_CASE("DiffractionExperiment_SmargonChiReadoutNoise", "[DiffractionExperimen
     REQUIRE(noisy.GetValues().size() == zero.GetValues().size());
     CHECK(noisy.GetValues().at(0) == Catch::Approx(zero.GetValues().at(0)).margin(1e-6));
 }
+
+// A grid scan and a goniometer axis are not alternatives: a grid is collected at a stationary
+// spindle, and the axis sent with step 0 is what states the angle it stood at. The request used to
+// drop the grid scan whenever an axis was present, and nothing pinned it.
+TEST_CASE("DiffractionExperiment_GridScanAtStationaryAxis", "[DiffractionExperiment]") {
+    org::openapitools::server::model::Dataset_settings model;
+    from_json(nlohmann::json::parse(R"({
+        "images_per_trigger": 12,
+        "beam_x_pxl": 512.0, "beam_y_pxl": 256.0,
+        "detector_distance_mm": 150.0, "incident_energy_keV": 12.4,
+        "grid_scan": {"n_fast": 4, "step_x_um": 20.0, "step_y_um": 20.0},
+        "goniometer": {"name": "omega", "start": 90.0, "step": 0.0, "vector": [-1, 0, 0]}
+    })"), model);
+
+    const auto settings = Convert(model);
+    REQUIRE(settings.GetGridScan().has_value());
+    CHECK(settings.GetGridScan()->GetNFast() == 4);
+    REQUIRE(settings.GetGoniometer().has_value());
+    CHECK(settings.GetGoniometer()->GetName() == "omega");
+    CHECK(!settings.GetGoniometer()->IsScanning());
+    CHECK(settings.GetGoniometer()->GetStart_deg() == Catch::Approx(90.0f));
+}
diff --git a/tests/JFJochReaderTest.cpp b/tests/JFJochReaderTest.cpp
index 937c55537..1b3e422b5 100644
--- a/tests/JFJochReaderTest.cpp
+++ b/tests/JFJochReaderTest.cpp
@@ -3365,6 +3365,24 @@ TEST_CASE("JFJochReader_AxisRecovery", "[HDF5][Full]") {
         cleanup("test_ax_grid");
     }
 
+    // A grid scan is taken at a stationary spindle, and the angle it stood at is what relates one
+    // grid to another taken elsewhere on the circle. It is stated by sending the axis with step 0;
+    // send nothing and the spindle is recorded at 0, which says only that nobody told us.
+    SECTION("a grid scan at a stationary head position") {
+        DiffractionExperiment x(DetJF(1));
+        x.ImagesPerTrigger(6).GridScan(GridScanSettings(3, 10.0f, 20.0f, false, false).ImageNum(6))
+                .Goniometer(GoniometerAxis("omega", 90.0f, 0.0f, Coord(-1,0,0), {}));
+        const auto out = round_trip(x, "test_ax_gridstill");
+        REQUIRE(out.GetGridScan().has_value());
+        CHECK(out.GetGridScan()->GetNFast() == 3);
+        REQUIRE(out.GetGoniometer().has_value());
+        CHECK(out.GetGoniometer()->GetName() == "omega");
+        CHECK(!out.GetGoniometer()->IsScanning());
+        CHECK(out.GetGoniometer()->GetStart_deg() == Catch::Approx(90).margin(1e-3));
+        CHECK(out.GetGoniometer()->GetAxis() == Coord(-1,0,0));
+        cleanup("test_ax_gridstill");
+    }
+
     SECTION("a grid scan under a turning spindle") {
         DiffractionExperiment x(DetJF(1));
         x.ImagesPerTrigger(6).GridScan(GridScanSettings(3, 10.0f, 20.0f, false, false).ImageNum(6))
diff --git a/writer/HDF5NXmx.cpp b/writer/HDF5NXmx.cpp
index b5b12f9fe..a9c5cbdd9 100644
--- a/writer/HDF5NXmx.cpp
+++ b/writer/HDF5NXmx.cpp
@@ -959,10 +959,13 @@ void NXmx::Sample(const StartMessage &start, const EndMessage &end) {
             depends_on = "/entry/sample/transformations/" + start.goniometer->GetName();
         } else if (write_grid_scan) {
             // No axis was given, but the sample still sits on a spindle - it simply does not turn.
-            // Say so: NXmx cannot express "no rotation", and a chain of translations alone is not
-            // something readers accept (dxtbx raises on it outright). At 0 degrees the rotation is
-            // the identity whatever the axis points along, so the conventional vector below carries
-            // no geometric claim.
+            // Say so: a chain of translations alone is not something readers accept (dxtbx raises on
+            // it outright, in get_dxtbx_goniometer). NXmx itself would allow a sample with no
+            // goniometer, depends_on ".", so this is a reader constraint and not a standard one. At
+            // 0 degrees the rotation is the identity whatever the axis points along, so the
+            // conventional vector below carries no geometric claim - but 0 is a placeholder for an
+            // angle nobody told us. Send the axis with step 0 and the angle the spindle really stood
+            // at is written instead, which is how a grid scan records its head position.
             //
             // One entry per image, for the reason write_smargon gives: a reader takes the image
             // count from the innermost axis of the chain, and with no goniometer and no Smargon head