diff --git a/broker/JFJochBrokerHttp.cpp b/broker/JFJochBrokerHttp.cpp
index a444f354..9f10ae74 100644
--- a/broker/JFJochBrokerHttp.cpp
+++ b/broker/JFJochBrokerHttp.cpp
@@ -478,6 +478,7 @@ void JFJochBrokerHttp::image_buffer_image_jpeg_get(const std::optional<int64_t>
                                                    const std::optional<int64_t> &jpegQuality,
                                                    const std::optional<float> &showResRing,
                                                    const std::optional<std::string> &color,
+                                                   const std::optional<bool> &showResEst,
                                                    Pistache::Http::ResponseWriter &response)  {
     int64_t image_id = id.value_or(ImageBuffer::MaxImage);
     PreviewImageSettings settings{};
@@ -485,7 +486,8 @@ void JFJochBrokerHttp::image_buffer_image_jpeg_get(const std::optional<int64_t>
     settings.show_user_mask = showUserMask.value_or(true);
     settings.show_roi = showRoi.value_or(false);
     settings.show_spots = showSpots.value_or(true);
-    settings.saturation_value = saturation.value_or(10);
+    settings.saturation_value = saturation;
+    settings.background_value = 0.0;
     settings.jpeg_quality = jpegQuality.value_or(100);
     settings.resolution_ring = showResRing;
     settings.scale = ConvertColorScale(color);
diff --git a/broker/JFJochBrokerHttp.h b/broker/JFJochBrokerHttp.h
index 30d710a1..52428bb2 100644
--- a/broker/JFJochBrokerHttp.h
+++ b/broker/JFJochBrokerHttp.h
@@ -147,6 +147,7 @@ class JFJochBrokerHttp : public org::openapitools::server::api::DefaultApi {
 
     void image_buffer_image_cbor_get(const std::optional<int64_t> &id,
                                      Pistache::Http::ResponseWriter &response) override;
+
     void image_buffer_image_jpeg_get(const std::optional<int64_t> &id,
                                      const std::optional<bool> &showUserMask,
                                      const std::optional<bool> &showRoi,
@@ -156,6 +157,7 @@ class JFJochBrokerHttp : public org::openapitools::server::api::DefaultApi {
                                      const std::optional<int64_t> &jpegQuality,
                                      const std::optional<float> &showResRing,
                                      const std::optional<std::string> &color,
+                                     const std::optional<bool> &showResEst,
                                      Pistache::Http::ResponseWriter &response) override;
 
     void image_buffer_image_tiff_get(const std::optional<int64_t> &id, Pistache::Http::ResponseWriter &response) override;
diff --git a/broker/gen/api/DefaultApi.cpp b/broker/gen/api/DefaultApi.cpp
index bed52937..a6839454 100644
--- a/broker/gen/api/DefaultApi.cpp
+++ b/broker/gen/api/DefaultApi.cpp
@@ -1114,9 +1114,17 @@ void DefaultApi::image_buffer_image_jpeg_get_handler(const Pistache::Rest::Reque
             color = valueQuery_instance;
         }
     }
+    auto showResEstQuery = request.query().get("show_res_est");
+    std::optional<bool> showResEst;
+    if(showResEstQuery.has_value()){
+        bool valueQuery_instance;
+        if(fromStringValue(showResEstQuery.value(), valueQuery_instance)){
+            showResEst = valueQuery_instance;
+        }
+    }
     
     try {
-        this->image_buffer_image_jpeg_get(id, showUserMask, showRoi, showSpots, showBeamCenter, saturation, jpegQuality, showResRing, color, response);
+        this->image_buffer_image_jpeg_get(id, showUserMask, showRoi, showSpots, showBeamCenter, saturation, jpegQuality, showResRing, color, showResEst, response);
     } catch (Pistache::Http::HttpError &e) {
         response.send(static_cast<Pistache::Http::Code>(e.code()), e.what());
         return;
diff --git a/broker/gen/api/DefaultApi.h b/broker/gen/api/DefaultApi.h
index 2352955e..3e03c074 100644
--- a/broker/gen/api/DefaultApi.h
+++ b/broker/gen/api/DefaultApi.h
@@ -462,11 +462,12 @@ private:
     /// <param name="showRoi">Show ROI areas on the image (optional, default to false)</param>
     /// <param name="showSpots">Show spot finding results on the image (optional, default to true)</param>
     /// <param name="showBeamCenter">Show beam center on the image (optional, default to true)</param>
-    /// <param name="saturation">Saturation value to set contrast in the preview image (optional, default to 10.0f)</param>
+    /// <param name="saturation">Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used (optional, default to 0.0f)</param>
     /// <param name="jpegQuality">Quality of JPEG image (100 - highest; 0 - lowest) (optional, default to 100L)</param>
     /// <param name="showResRing">Show resolution ring, provided in Angstrom (optional, default to 0.1f)</param>
     /// <param name="color">Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat (optional, default to &quot;indigo&quot;)</param>
-    virtual void image_buffer_image_jpeg_get(const std::optional<int64_t> &id, const std::optional<bool> &showUserMask, const std::optional<bool> &showRoi, const std::optional<bool> &showSpots, const std::optional<bool> &showBeamCenter, const std::optional<float> &saturation, const std::optional<int64_t> &jpegQuality, const std::optional<float> &showResRing, const std::optional<std::string> &color, Pistache::Http::ResponseWriter &response) = 0;
+    /// <param name="showResEst">Show resolution estimation as a ring (optional, default to false)</param>
+    virtual void image_buffer_image_jpeg_get(const std::optional<int64_t> &id, const std::optional<bool> &showUserMask, const std::optional<bool> &showRoi, const std::optional<bool> &showSpots, const std::optional<bool> &showBeamCenter, const std::optional<float> &saturation, const std::optional<int64_t> &jpegQuality, const std::optional<float> &showResRing, const std::optional<std::string> &color, const std::optional<bool> &showResEst, Pistache::Http::ResponseWriter &response) = 0;
     /// <summary>
     /// Get preview image in TIFF format
     /// </summary>
diff --git a/broker/jfjoch_api.yaml b/broker/jfjoch_api.yaml
index b68561ca..13b9e1f8 100644
--- a/broker/jfjoch_api.yaml
+++ b/broker/jfjoch_api.yaml
@@ -143,16 +143,17 @@ components:
     saturation:
       in: query
       name: saturation
+      required: false
       schema:
         type: number
         format: float
-        default: 10
         minimum: -32767
         maximum: 32767
-      description: "Saturation value to set contrast in the preview image"
+      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
@@ -208,6 +209,13 @@ components:
         default: 0.1
         minimum: 0.1
         maximum: 100.0
+    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
@@ -3166,6 +3174,7 @@ paths:
         - $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
diff --git a/broker/redoc-static.html b/broker/redoc-static.html
index 3fc8d7ff..3f9432d2 100644
--- a/broker/redoc-static.html
+++ b/broker/redoc-static.html
@@ -1351,14 +1351,16 @@ For still measurement the number is ignored</p>
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Show spot finding results on the image</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="show_beam_center" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">show_beam_center</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">boolean</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">true</span></div> <div><div html="&lt;p&gt;Show beam center on the image&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Show beam center on the image</p>
-</div></div></div></td></tr><tr class=""><td kind="field" title="saturation" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">saturation</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">number</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- -->&lt;<!-- -->float<!-- -->&gt;<!-- --> </span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- -->[ -32767 .. 32767 ]<!-- --> </span></span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">10</span></div> <div><div html="&lt;p&gt;Saturation value to set contrast in the preview image&lt;/p&gt;
-" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Saturation value to set contrast in the preview image</p>
+</div></div></div></td></tr><tr class=""><td kind="field" title="saturation" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">saturation</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">number</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- -->&lt;<!-- -->float<!-- -->&gt;<!-- --> </span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- -->[ -32767 .. 32767 ]<!-- --> </span></span></div> <div><div html="&lt;p&gt;Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used&lt;/p&gt;
+" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="jpeg_quality" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">jpeg_quality</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- -->&lt;<!-- -->int64<!-- -->&gt;<!-- --> </span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- -->[ 0 .. 100 ]<!-- --> </span></span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">100</span></div> <div><div html="&lt;p&gt;Quality of JPEG image (100 - highest; 0 - lowest)&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Quality of JPEG image (100 - highest; 0 - lowest)</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="show_res_ring" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">show_res_ring</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">number</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- -->&lt;<!-- -->float<!-- -->&gt;<!-- --> </span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- -->[ 0.1 .. 100 ]<!-- --> </span></span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">0.1</span></div> <div><div html="&lt;p&gt;Show resolution ring, provided in Angstrom&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Show resolution ring, provided in Angstrom</p>
-</div></div></div></td></tr><tr class="last "><td kind="field" title="color" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">color</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">&quot;indigo&quot;</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Enum<!-- -->:</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">&quot;indigo&quot;</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">&quot;viridis&quot;</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">&quot;bw&quot;</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">&quot;heat&quot;</span> </div> <div><div html="&lt;p&gt;Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat&lt;/p&gt;
+</div></div></div></td></tr><tr class=""><td kind="field" title="color" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">color</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">&quot;indigo&quot;</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Enum<!-- -->:</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">&quot;indigo&quot;</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">&quot;viridis&quot;</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">&quot;bw&quot;</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">&quot;heat&quot;</span> </div> <div><div html="&lt;p&gt;Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat</p>
+</div></div></div></td></tr><tr class="last "><td kind="field" title="show_res_est" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">show_res_est</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">boolean</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">false</span></div> <div><div html="&lt;p&gt;Show resolution estimation as a ring&lt;/p&gt;
+" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Show resolution estimation as a ring</p>
 </div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" 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><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="&lt;p&gt;Preview image&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Preview image</p>
 </div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" 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><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="&lt;p&gt;Input parsing or validation error&lt;/p&gt;
@@ -1403,7 +1405,7 @@ then image might be replaced in the buffer between calling /images and /image.cb
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Test Jungfraujoch system</p>
 </div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span>http://localhost:5232</span>/version</div></div></div></div></div></div></div></div></div><div class="sc-evkzZa iZqpqg"></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.110","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":{"type":"integer"},"description":"Binning of frames for the plot (0 = default binning)"},"compression":{"in":"query","name":"compression","required":false,"schema":{"type":"boolean","default":false},"description":"Enable DEFLATE compression of output data."},"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_time","indexing_unit_cell_length","indexing_unit_cell_angle","profile_radius","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"]}},"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","schema":{"type":"number","format":"float","default":10,"minimum":-32767,"maximum":32767},"description":"Saturation value to set contrast in the preview image"},"background":{"in":"query","name":"background","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_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}},"color_scale":{"in":"query","name":"color","description":"Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat","schema":{"type":"string","enum":["indigo","viridis","bw","heat"],"default":"indigo"}}},"schemas":{"grid_scan":{"description":"Definition of a grid scan (mutually exclusive with `rotation_axis`)","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 detector geometry refinement algorithm used by Jungfraujoch.\nThis option is using non-linear least squares optimization to find unit cell and beam center.\n","enum":["BeamCenter","None"]},"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":0,"default":1000,"description":"Number of files in a single HDF5 data file (0 = write all images to a single data file)."},"space_group_number":{"type":"integer","format":"int64","minimum":1,"maximum":194,"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","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"},"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/data 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},"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"},"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"}}}}},"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":["None","NXmxLegacy","NXmxVDS","CBF","TIFF","NoFileWritten"],"default":"NXmxLegacy","description":"None - no master file written\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\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","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"}}},"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","high_resolution_limit","low_resolution_limit","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]"},"low_resolution_limit":{"type":"number","format":"float","description":"Low resolution limit for spot finding [Angstrom]"},"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.02,"description":"Width of ice ring in q-space in reciprocal space"},"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"}}},"azim_int_settings":{"type":"object","required":["solid_angle_corr","polarization_corr","high_q_recipA","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","format":"float"},"low_q_recipA":{"type":"number","format":"float"},"q_spacing":{"type":"number","format":"float"},"azimuthal_bins":{"type":"integer","format":"int64","minimum":1,"maximum":256,"default":1,"description":"Numer of azimuthal (phi) bins; 1 = standard 1D azimuthal integration"}}},"detector_list_element":{"type":"object","required":["id","nmodules","description","width","height","serial_number","base_ipv4_addr","udp_interface_count","readout_time_us","min_frame_time_us","min_count_time_us"],"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_us":{"type":"integer","format":"int64"},"min_frame_time_us":{"type":"integer","format":"int64"},"min_count_time_us":{"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_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"}}},"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"}},"z":{"type":"array","items":{"type":"number","format":"float"}}}},"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"},"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"},"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"},"index":{"type":"integer","format":"int64","description":"Indexing solution"},"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"}}}}}},"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"}}},"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)","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"}}},"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"],"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":"Highest resolution of spots used for FFT algorithm; parameter value affects execution time of FFT.\nThere is also correlation between smallest unit cell and max resolution, 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"}}},"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","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_us":{"type":"integer","format":"int64","minimum":1,"description":"Minimum difference between frame time and count time in microseconds\nDefaults are 3 us for EIGER and 20 us for JUNGFRAU\n"},"minimum_count_time_us":{"type":"integer","format":"int64","minimum":0,"description":"Minimum count time available for the detector."},"minimum_frame_time_us":{"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"}},"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"}}},"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"}}}},"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"},"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"},"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","description":"NUMA policy to bind CPUs"},"frontend_directory":{"type":"string","description":"Location of built JavaScript web frontend"},"ssl":{"type":"object","required":["certificate","key"],"properties":{"certificate":{"type":"string","minLength":1,"example":"server.crt"},"key":{"type":"string","minLength":1,"example":"server.key"}}},"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.\nDoesn't run calibration procedure.\nWhen the function returns, detector is ready to accept soft/TTL triggers.\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_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"},"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"}}}},"/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/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"}}}},"/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","parameters":[{"$ref":"#/components/parameters/compression"}],"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"},"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 TIFF (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. \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"},"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"}}}},"404":{"description":"No calibration recorded so far"}}}},"/preview/plot":{"get":{"summary":"Generate 1D plot from Jungfraujoch","parameters":[{"$ref":"#/components/parameters/binning"},{"$ref":"#/components/parameters/compression"},{"$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"}}}}}}},"/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_beam_center"},{"$ref":"#/components/parameters/saturation"},{"$ref":"#/components/parameters/jpeg_quality"},{"$ref":"#/components/parameters/resolution_ring"},{"$ref":"#/components/parameters/color_scale"}],"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_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~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/~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/~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,3.934,1,4.563]],["description/0",[0,1.769,2,4.095,3,2.109,4,2.052,5,1.174,6,3.279,7,1.174,8,1.174,9,1.012,10,0.905,11,1.744,12,1.174,13,0.974,14,1.174,15,1.769,16,1.174,17,2.734,18,2.052,19,0.905,20,2.052,21,1.333,22,1.174,23,2.052,24,1.012,25,2.734,26,1.174,27,1.174,28,2.052,29,1.174,30,1.174,31,1.174,32,1.174,33,1.174,34,1.174,35,1.174,36,2.734,37,1.174,38,1.174,39,0.345,40,0.589,41,1.174,42,2.052,43,1.012,44,1.174,45,1.174,46,1.174,47,1.174,48,1.174,49,1.174,50,1.012,51,1.174,52,1.174,53,1.174,54,1.174,55,1.174,56,1.174,57,1.174,58,1.174,59,0.905,60,1.012,61,1.174]],["title/1",[62,2.167,63,0.373,64,0.965,65,1.908]],["description/1",[11,2.393,39,0.914,43,1.655,59,1.48,62,1.16,63,0.468,66,1.919,67,1.48,68,1.964,69,0.864,70,0.911,71,1.48,72,1.655,73,1.48,74,2.921,75,1.919,76,1.48,77,1.655,78,2.679,79,1.16,80,1.919,81,1.919,82,1.655,83,1.48,84,1.35,85,1.919,86,1.919,87,1.655,88,1.48,89,1.35,90,1.35,91,1.48,92,1.48,93,0.565]],["title/2",[63,0.373,94,1.326,95,2.766,96,2.523]],["description/2",[11,1.336,39,0.739,63,0.261,68,1.928,71,1.938,72,2.166,73,1.938,74,1.632,77,2.166,78,2.166,79,1.518,84,1.768,87,2.166,88,1.938,89,1.768,90,1.768,91,1.938,92,1.938,93,0.739,97,2.513,98,1.768,99,2.166,100,0.809,101,1.336,102,2.513,103,2.513,104,2.513,105,2.513,106,1.632,107,2.513]],["title/3",[63,0.474,108,3.52]],["description/3",[39,0.988,63,0.494,64,0.903,65,1.785,88,2.589,98,2.361,100,1.081,101,1.785,108,3.668,109,3.356,110,2.589,111,2.179,112,3.356,113,3.356,114,3.356,115,2.589]],["title/4",[65,2.136,93,1.182,116,4.016]],["description/4",[15,1.786,21,1.346,62,1.252,64,0.889,73,1.598,79,1.252,83,2.549,84,1.458,91,1.598,92,2.549,94,1.222,101,1.757,110,1.598,117,3.304,118,2.072,119,2.072,120,2.072,121,1.786,122,1.458,123,2.072,124,1.598,125,2.072,126,2.072,127,2.072,128,2.072,129,2.072,130,2.072,131,1.598,132,3.304,133,2.072,134,1.786,135,2.072,136,3.304,137,2.072]],["title/5",[63,0.373,115,2.766,138,3.586,139,3.092]],["description/5",[13,2.496,115,4.93,139,4.532]],["title/6",[64,0.965,94,1.326,101,1.908,124,2.766]],["description/6",[39,0.61,59,1.598,63,0.215,64,1.109,65,1.102,79,1.252,84,1.458,94,1.222,96,2.325,100,0.667,101,1.102,121,2.849,122,3.308,124,1.598,140,2.072,141,1.252,142,2.072,143,2.549,144,1.786,145,2.072,146,2.072,147,1.786,148,2.072,149,2.072,150,1.598,151,2.072,152,2.072,153,2.072,154,2.072,155,2.072,156,2.072,157,2.072,158,1.598]],["title/7",[63,0.417,159,4.016,160,3.098]],["description/7",[11,1.74,39,0.963,63,0.485,64,0.881,65,1.74,70,1.554,100,1.053,122,2.302,160,3.602,161,4.669,162,3.272,163,3.272,164,3.272,165,3.272,166,3.272,167,3.272]],["title/8",[63,0.417,168,2.016,169,1.808]],["description/8",[39,1.239,63,0.543,68,1.702,69,1.527,70,1.61,71,1.651,74,1.39,76,1.651,79,2.049,83,2.615,89,1.506,93,0.63,94,0.791,98,2.385,100,1.092,110,1.651,158,1.651,168,1.074,170,1.486,171,1.845,172,2.14,173,1.845,174,2.14,175,2.14,176,1.845]],["title/9",[63,0.474,169,2.055]],["description/9",[93,1.612,176,4.723,177,2.914]],["title/10",[168,1.8,170,1.266,178,3.092,179,3.586]],["description/10",[39,1.38,63,0.487,69,2.111,70,2.226,93,1.38,100,1.509,180,4.041]],["title/11",[169,2.055,178,3.934]],["description/11",[93,1.612,177,2.914,180,4.723]],["title/12",[10,2.766,150,2.766,168,1.8,170,1.266]],["description/12",[39,1.38,63,0.487,69,2.111,70,2.226,93,1.38,100,1.509,181,4.041]],["title/13",[10,3.098,150,3.098,170,1.417]],["description/13",[93,1.612,177,2.914,181,4.723]],["title/14",[168,2.016,182,3.463,183,2.272]],["description/14",[39,1.38,63,0.487,69,2.111,70,2.226,93,1.38,100,1.509,184,4.041]],["title/15",[182,3.934,183,2.581]],["description/15",[93,1.612,177,2.914,184,4.723]],["title/16",[168,1.8,185,1.209,186,3.092,187,1.8]],["description/16",[39,1.38,63,0.487,69,2.111,70,2.226,93,1.38,100,1.509,188,4.041]],["title/17",[185,1.353,186,3.463,187,2.016]],["description/17",[93,1.612,177,2.914,188,4.723]],["title/18",[64,0.872,94,1.198,169,1.459,187,1.626,189,2.499]],["description/18",[39,1.38,63,0.487,69,2.111,70,2.226,93,1.38,100,1.509,190,4.688]],["title/19",[64,0.795,94,1.092,169,1.33,187,1.483,191,1.918,192,2.279]],["description/19",[39,1.38,63,0.487,69,2.111,70,2.226,93,1.38,100,1.509,193,4.688]],["title/20",[169,1.808,194,3.098,195,3.098]],["description/20",[64,1.309,93,1.431,94,1.798,101,2.587,177,2.587,196,4.193]],["title/21",[64,1.081,147,3.463,169,1.808]],["description/21",[93,1.612,177,2.914,196,4.723]],["title/22",[106,2.608,169,1.808,197,2.825]],["description/22",[63,0.525,69,2.275,93,1.487,100,1.627,198,4.356]],["title/23",[106,2.608,169,1.808,197,2.825]],["description/23",[93,1.612,177,2.914,198,4.723]],["title/24",[13,1.403,141,1.785,185,0.996,199,2.078,200,1.785,201,2.078]],["description/24",[13,1.411,21,1.93,39,0.875,63,0.536,100,0.957,141,1.796,170,1.049,185,1.002,199,2.091,200,1.796,201,2.091,202,2.563,203,2.972,204,2.563,205,2.563,206,2.563,207,2.563,208,2.563,209,1.796,210,2.563,211,2.972]],["title/25",[13,1.403,141,1.785,185,0.996,199,2.078,201,2.078,212,1.671]],["description/25",[13,1.444,21,1.975,39,0.895,63,0.543,100,0.979,141,1.838,170,1.073,185,1.025,199,2.14,201,2.14,202,2.623,204,2.623,205,2.623,206,2.623,207,2.623,208,2.623,209,1.838,210,2.623,212,1.721,213,3.042]],["title/26",[63,0.474,214,3.934]],["description/26",[21,1.768,24,2.348,39,0.801,50,3.52,63,0.566,69,1.226,89,2.872,122,1.916,131,2.101,168,1.367,170,0.961,215,1.448,216,2.723,217,2.723,218,2.723,219,2.723,220,2.348,221,2.101,222,2.723,223,2.723,224,2.723,225,2.348]],["title/27",[63,0.417,220,3.463,226,3.098]],["description/27",[11,2.687,63,0.525,169,2.275,214,4.356,225,4.356]],["title/28",[170,1.758,227,2.167,228,2.329]],["description/28",[13,1.193,64,0.676,158,1.938,168,1.261,170,1.355,215,1.336,227,1.518,228,2.494,229,1.768,230,2.166,231,2.513,232,2.963,233,2.166,234,2.166,235,2.166,236,1.768,237,2.166,238,2.166,239,3.312,240,1.768,241,3.312,242,3.312,243,2.513,244,2.513,245,2.166]],["title/29",[170,1.417,227,2.427,228,2.608]],["description/29",[245,5.157]],["title/30",[170,1.758,183,2.029,227,2.167]],["description/30",[13,1.321,64,0.749,168,1.396,170,0.982,183,1.573,185,0.937,215,1.479,227,1.681,229,1.957,230,3.576,232,3.199,233,2.398,234,2.398,235,2.398,236,1.957,237,2.398,238,2.398,239,2.398,240,1.957,241,2.398,242,2.398,246,2.782,247,2.782,248,2.398]],["title/31",[170,1.266,183,2.029,227,2.167,232,2.766]],["description/31",[248,5.157]],["title/32",[64,0.731,94,1.004,95,2.094,169,1.222,170,0.958,249,2.341,250,1.053]],["description/32",[39,1.041,63,0.513,69,1.594,70,1.68,74,2.298,93,1.041,100,1.14,134,3.051,226,2.73,251,3.539,252,3.539,253,3.539,254,3.539,255,3.539,256,3.051]],["title/33",[64,0.795,94,1.092,95,2.279,170,1.042,249,2.547,250,1.145]],["description/33",[256,5.157]],["title/34",[215,2.427,257,2.581]],["description/34",[64,1.415,65,2.796,257,3.615]],["title/35",[141,2.427,257,2.272,258,4.016]],["description/35",[259,5.982]],["title/36",[64,0.731,65,1.444,96,1.91,111,1.763,221,2.094,260,1.91,261,2.341]],["description/36",[68,2.123,111,2.747,185,1.425,221,3.263,260,2.976,261,3.647,262,3.263,263,3.263,264,4.23,265,4.23]],["title/37",[19,2.094,64,0.731,65,1.444,96,1.91,111,1.763,260,1.91,266,2.341]],["description/37",[19,3.751,111,3.158,260,3.421,262,3.751,266,4.193,267,4.863]],["title/38",[63,0.474,257,2.581]],["description/38",[63,0.546,99,4.532,257,2.973,268,5.256]],["title/39",[3,3.52,269,3.934]],["description/39",[270,5.157]],["title/40",[3,3.098,269,3.463,271,2.608]],["description/40",[270,5.157]],["title/41",[13,2.167,272,2.963]],["description/41",[272,3.884]],["title/42",[64,1.081,94,1.485,272,2.608]],["description/42",[64,1.36,94,1.868,273,4.356,274,4.356,275,5.052]],["title/43",[98,3.21,272,2.963]],["description/43",[82,4.041,131,3.616,272,3.044,276,4.688,277,4.688,278,4.688,279,4.688]],["title/44",[63,0.417,200,2.427,250,1.557]],["description/44",[62,2.329,63,0.544,191,2.502,250,1.494,280,3.162,281,3.322,282,2.711,283,3.322,284,3.322,285,2.711,286,3.854]],["title/45",[40,1.483,62,1.785,63,0.451,200,1.785,250,1.145]],["description/45",[40,1.826,63,0.523,68,2.525,209,2.198,250,1.951,263,2.806,280,3.04,287,3.136,288,2.559,289,2.559,290,3.136]],["title/46",[40,1.626,63,0.337,200,1.958,250,1.256,271,2.104]],["description/46",[11,0.826,39,0.457,40,1.309,63,0.271,67,1.197,68,1.983,90,1.092,100,0.5,106,1.008,143,1.197,189,1.197,192,1.197,194,1.197,195,1.197,197,1.092,200,0.938,209,0.938,240,1.092,250,1.85,262,1.197,271,1.008,280,1.576,282,1.092,285,1.835,288,1.092,289,1.092,290,1.338,291,1.338,292,1.338,293,1.338,294,1.338,295,1.338,296,1.338,297,1.338,298,1.338,299,1.338,300,1.338,301,2.249,302,1.338,303,1.338,304,1.338,305,1.338,306,1.338,307,1.338,308,1.338,309,1.338,310,1.338,311,1.338,312,1.338,313,1.338]],["title/47",[63,0.417,212,2.272,250,1.557]],["description/47",[39,1.134,63,0.401,100,1.241,191,2.502,250,1.494,280,3.162,281,3.322,282,2.711,283,3.322,284,3.322,285,2.711,314,3.854]],["title/48",[40,1.483,62,1.785,63,0.451,212,1.671,250,1.145]],["description/48",[40,1.826,63,0.523,68,2.525,209,2.198,250,1.951,263,2.806,280,3.04,287,3.136,288,2.559,289,2.559,315,3.136]],["title/49",[40,1.8,63,0.373,250,1.391,271,2.329]],["description/49",[9,1.171,11,0.722,39,0.4,40,1.817,63,0.242,67,1.047,68,2.045,90,0.955,100,0.437,106,0.882,143,1.047,171,1.171,173,1.171,185,0.458,189,1.047,192,1.047,194,1.047,195,1.047,197,0.955,209,0.82,212,0.768,240,0.955,250,1.945,271,0.882,280,2.188,282,0.955,285,2.15,288,0.955,289,0.955,291,1.171,292,1.171,293,1.171,294,1.171,295,1.171,296,1.171,297,1.171,298,1.171,299,1.171,300,1.171,301,2.007,302,1.171,303,1.171,304,1.171,305,1.171,306,1.171,307,1.171,308,1.171,309,1.171,310,1.171,311,1.171,312,1.171,313,1.171,315,1.171,316,1.358]],["title/50",[79,2.427,187,2.016,212,2.272]],["description/50",[317,5.982]],["title/51",[13,1.703,215,1.908,318,3.586,319,3.586]],["description/51",[320,5.982]],["title/52",[191,2.608,273,3.463,321,4.016]],["description/52",[322,5.982]],["title/53",[108,2.766,187,1.8,229,2.523,323,3.092]],["description/53",[183,2.652,236,3.298,324,4.688,325,4.688,326,4.688,327,4.688,328,4.688]],["title/54",[185,1.209,187,1.8,229,2.523,323,3.092]],["description/54",[64,1.468,94,1.515,183,2.317,185,1.838,191,2.66,236,2.882,329,4.097,330,4.097,331,4.097]],["title/55",[11,1.444,170,0.958,185,0.915,187,1.362,228,1.763,332,2.715,333,2.715]],["description/55",[334,5.982]],["title/56",[185,1.209,187,1.8,212,2.029,228,2.329]],["description/56",[335,5.982]],["title/57",[185,1.353,336,4.016,337,2.825]],["description/57",[64,1.468,94,2.016,101,2.179,160,3.16,185,1.381,215,2.179,274,3.532,337,2.882,338,4.097]],["title/58",[185,1.353,257,2.272,337,2.825]],["description/58",[60,2.125,64,1.24,68,1.237,74,1.601,76,2.92,94,1.704,101,1.311,144,2.125,185,1.742,215,1.311,226,1.901,257,1.394,337,3.242,339,2.465,340,2.465,341,2.465,342,2.465,343,2.465,344,2.465,345,2.465,346,2.465,347,2.465]],["title/59",[215,2.136,348,3.463,349,4.016]],["description/59",[348,5.157]]],"invertedIndex":[["",{"_index":68,"title":{},"description":{"1":{},"2":{},"8":{},"36":{},"45":{},"46":{},"48":{},"49":{},"58":{}}}],["0",{"_index":288,"title":{},"description":{"45":{},"46":{},"48":{},"49":{}}}],["1",{"_index":263,"title":{},"description":{"36":{},"45":{},"48":{}}}],["100",{"_index":107,"title":{},"description":{"2":{}}}],["1024x512",{"_index":299,"title":{},"description":{"46":{},"49":{}}}],["16-bit",{"_index":204,"title":{},"description":{"24":{},"25":{}}}],["1d",{"_index":318,"title":{"51":{}},"description":{}}],["4-byte",{"_index":308,"title":{},"description":{"46":{},"49":{}}}],["8",{"_index":312,"title":{},"description":{"46":{},"49":{}}}],["accept",{"_index":113,"title":{},"description":{"3":{}}}],["account",{"_index":292,"title":{},"description":{"46":{},"49":{}}}],["acquisit",{"_index":65,"title":{"1":{},"4":{},"36":{},"37":{}},"description":{"3":{},"6":{},"7":{},"34":{}}}],["actual",{"_index":287,"title":{},"description":{"45":{},"48":{}}}],["adjust",{"_index":234,"title":{},"description":{"28":{},"30":{}}}],["affect",{"_index":123,"title":{},"description":{"4":{}}}],["again",{"_index":172,"title":{},"description":{"8":{}}}],["algorithm",{"_index":179,"title":{"10":{}},"description":{}}],["allow",{"_index":50,"title":{},"description":{"0":{},"26":{}}}],["alway",{"_index":165,"title":{},"description":{"7":{}}}],["and/or",{"_index":218,"title":{},"description":{"26":{}}}],["anytim",{"_index":177,"title":{},"description":{"9":{},"11":{},"13":{},"15":{},"17":{},"20":{},"21":{},"23":{}}}],["api",{"_index":2,"title":{},"description":{"0":{}}}],["appli",{"_index":9,"title":{},"description":{"0":{},"49":{}}}],["applic",{"_index":17,"title":{},"description":{"0":{}}}],["approach",{"_index":30,"title":{},"description":{"0":{}}}],["array",{"_index":262,"title":{},"description":{"36":{},"37":{},"46":{}}}],["asic",{"_index":164,"title":{},"description":{"7":{}}}],["assign",{"_index":306,"title":{},"description":{"46":{},"49":{}}}],["async",{"_index":87,"title":{},"description":{"1":{},"2":{}}}],["automat",{"_index":173,"title":{},"description":{"8":{},"49":{}}}],["avail",{"_index":226,"title":{"27":{}},"description":{"32":{},"58":{}}}],["azimuth",{"_index":197,"title":{"22":{},"23":{}},"description":{"46":{},"49":{}}}],["back",{"_index":157,"title":{},"description":{"6":{}}}],["base",{"_index":244,"title":{},"description":{"28":{}}}],["be",{"_index":146,"title":{},"description":{"6":{}}}],["beam",{"_index":293,"title":{},"description":{"46":{},"49":{}}}],["befor",{"_index":166,"title":{},"description":{"7":{}}}],["between",{"_index":345,"title":{},"description":{"58":{}}}],["binari",{"_index":200,"title":{"24":{},"44":{},"45":{},"46":{}},"description":{"24":{},"46":{}}}],["bit",{"_index":311,"title":{},"description":{"46":{},"49":{}}}],["blob",{"_index":203,"title":{},"description":{"24":{}}}],["block",{"_index":117,"title":{},"description":{"4":{}}}],["both",{"_index":298,"title":{},"description":{"46":{},"49":{}}}],["buffer",{"_index":337,"title":{"57":{},"58":{}},"description":{"57":{},"58":{}}}],["calcul",{"_index":249,"title":{"32":{},"33":{}},"description":{}}],["calibr",{"_index":98,"title":{"43":{}},"description":{"2":{},"3":{},"8":{}}}],["call",{"_index":60,"title":{},"description":{"0":{},"58":{}}}],["cancel",{"_index":124,"title":{"6":{}},"description":{"4":{},"6":{}}}],["card",{"_index":142,"title":{},"description":{"6":{}}}],["case",{"_index":67,"title":{},"description":{"1":{},"46":{},"49":{}}}],["cbor",{"_index":323,"title":{"53":{},"54":{}},"description":{}}],["cell",{"_index":82,"title":{},"description":{"1":{},"43":{}}}],["chang",{"_index":168,"title":{"8":{},"10":{},"12":{},"14":{},"16":{}},"description":{"8":{},"26":{},"28":{},"30":{}}}],["choos",{"_index":24,"title":{},"description":{"0":{},"26":{}}}],["clarif",{"_index":1,"title":{"0":{}},"description":{}}],["clear",{"_index":336,"title":{"57":{}},"description":{}}],["client",{"_index":15,"title":{},"description":{"0":{},"4":{}}}],["close",{"_index":73,"title":{},"description":{"1":{},"2":{},"4":{}}}],["code",{"_index":19,"title":{"37":{}},"description":{"0":{},"37":{}}}],["collect",{"_index":94,"title":{"2":{},"6":{},"18":{},"19":{},"32":{},"33":{},"42":{}},"description":{"4":{},"6":{},"8":{},"20":{},"42":{},"54":{},"57":{},"58":{}}}],["come",{"_index":329,"title":{},"description":{"54":{}}}],["command",{"_index":122,"title":{},"description":{"4":{},"6":{},"7":{},"26":{}}}],["commun",{"_index":57,"title":{},"description":{"0":{}}}],["config/azim_int",{"_index":198,"title":{},"description":{"22":{},"23":{}}}],["config/dark_mask",{"_index":256,"title":{},"description":{"32":{},"33":{}}}],["config/detector",{"_index":176,"title":{},"description":{"8":{},"9":{}}}],["config/file_writ",{"_index":181,"title":{},"description":{"12":{},"13":{}}}],["config/image_format",{"_index":188,"title":{},"description":{"16":{},"17":{}}}],["config/image_format/convers",{"_index":193,"title":{},"description":{"19":{}}}],["config/image_format/raw",{"_index":190,"title":{},"description":{"18":{}}}],["config/index",{"_index":180,"title":{},"description":{"10":{},"11":{}}}],["config/instru",{"_index":184,"title":{},"description":{"14":{},"15":{}}}],["config/internal_generator_imag",{"_index":211,"title":{},"description":{"24":{}}}],["config/internal_generator_image.tiff",{"_index":213,"title":{},"description":{"25":{}}}],["config/mask",{"_index":286,"title":{},"description":{"44":{}}}],["config/mask.tiff",{"_index":314,"title":{},"description":{"47":{}}}],["config/roi",{"_index":270,"title":{},"description":{"39":{},"40":{}}}],["config/select_detector",{"_index":225,"title":{},"description":{"26":{},"27":{}}}],["config/spot_find",{"_index":196,"title":{},"description":{"20":{},"21":{}}}],["config/user_mask",{"_index":290,"title":{},"description":{"45":{},"46":{}}}],["config/user_mask.tiff",{"_index":315,"title":{},"description":{"48":{},"49":{}}}],["config/zeromq_metadata",{"_index":248,"title":{},"description":{"30":{},"31":{}}}],["config/zeromq_preview",{"_index":245,"title":{},"description":{"28":{},"29":{}}}],["configur",{"_index":169,"title":{"8":{},"9":{},"11":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"32":{}},"description":{"27":{}}}],["connect",{"_index":136,"title":{},"description":{"4":{}}}],["consist",{"_index":222,"title":{},"description":{"26":{}}}],["contain",{"_index":236,"title":{},"description":{"28":{},"30":{},"53":{},"54":{}}}],["control",{"_index":216,"title":{},"description":{"26":{}}}],["convers",{"_index":192,"title":{"19":{}},"description":{"46":{},"49":{}}}],["convert",{"_index":302,"title":{},"description":{"46":{},"49":{}}}],["coordin",{"_index":209,"title":{},"description":{"24":{},"25":{},"45":{},"46":{},"48":{},"49":{}}}],["copyleft",{"_index":7,"title":{},"description":{"0":{}}}],["cover",{"_index":247,"title":{},"description":{"30":{}}}],["cpu",{"_index":148,"title":{},"description":{"6":{}}}],["current",{"_index":96,"title":{"2":{},"36":{},"37":{}},"description":{"6":{}}}],["custom",{"_index":333,"title":{"55":{}},"description":{}}],["dark",{"_index":95,"title":{"2":{},"32":{},"33":{}},"description":{}}],["data",{"_index":64,"title":{"1":{},"6":{},"18":{},"19":{},"21":{},"32":{},"33":{},"36":{},"37":{},"42":{}},"description":{"3":{},"4":{},"6":{},"7":{},"20":{},"28":{},"30":{},"34":{},"42":{},"54":{},"57":{},"58":{}}}],["dataset",{"_index":324,"title":{},"description":{"53":{}}}],["deactiv",{"_index":161,"title":{},"description":{"7":{}}}],["dectri",{"_index":251,"title":{},"description":{"32":{}}}],["definit",{"_index":3,"title":{"39":{},"40":{}},"description":{"0":{}}}],["depend",{"_index":210,"title":{},"description":{"24":{},"25":{}}}],["deriv",{"_index":47,"title":{},"description":{"0":{}}}],["detector",{"_index":63,"title":{"1":{},"2":{},"3":{},"5":{},"7":{},"8":{},"9":{},"26":{},"27":{},"38":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{}},"description":{"1":{},"2":{},"3":{},"6":{},"7":{},"8":{},"10":{},"12":{},"14":{},"16":{},"18":{},"19":{},"22":{},"24":{},"25":{},"26":{},"27":{},"32":{},"38":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{}}}],["detector/statu",{"_index":268,"title":{},"description":{"38":{}}}],["develop",{"_index":37,"title":{},"description":{"0":{}}}],["devic",{"_index":258,"title":{"35":{}},"description":{}}],["distribut",{"_index":22,"title":{},"description":{"0":{}}}],["doesn't",{"_index":109,"title":{},"description":{"3":{}}}],["don't",{"_index":305,"title":{},"description":{"46":{},"49":{}}}],["done",{"_index":93,"title":{"4":{}},"description":{"1":{},"2":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"32":{}}}],["dure",{"_index":76,"title":{},"description":{"1":{},"8":{},"58":{}}}],["e.g",{"_index":325,"title":{},"description":{"53":{}}}],["each",{"_index":276,"title":{},"description":{"43":{}}}],["effect",{"_index":158,"title":{},"description":{"6":{},"8":{},"28":{}}}],["eiger",{"_index":254,"title":{},"description":{"32":{}}}],["ensur",{"_index":92,"title":{},"description":{"1":{},"2":{},"4":{}}}],["error",{"_index":70,"title":{},"description":{"1":{},"7":{},"8":{},"10":{},"12":{},"14":{},"16":{},"18":{},"19":{},"32":{}}}],["etc",{"_index":46,"title":{},"description":{"0":{}}}],["event",{"_index":266,"title":{"37":{}},"description":{"37":{}}}],["exampl",{"_index":291,"title":{},"description":{"46":{},"49":{}}}],["except",{"_index":25,"title":{},"description":{"0":{}}}],["execut",{"_index":83,"title":{},"description":{"1":{},"4":{},"8":{}}}],["expect",{"_index":307,"title":{},"description":{"46":{},"49":{}}}],["experiment",{"_index":326,"title":{},"description":{"53":{}}}],["explicitli",{"_index":38,"title":{},"description":{"0":{}}}],["extend",{"_index":133,"title":{},"description":{"4":{}}}],["extern",{"_index":118,"title":{},"description":{"4":{}}}],["few",{"_index":85,"title":{},"description":{"1":{}}}],["file",{"_index":10,"title":{"12":{},"13":{}},"description":{"0":{}}}],["find",{"_index":195,"title":{"20":{}},"description":{"46":{},"49":{}}}],["finish",{"_index":121,"title":{},"description":{"4":{},"6":{}}}],["format",{"_index":187,"title":{"16":{},"17":{},"18":{},"19":{},"50":{},"53":{},"54":{},"55":{},"56":{}},"description":{}}],["fpga",{"_index":141,"title":{"24":{},"25":{},"35":{}},"description":{"6":{},"24":{},"25":{}}}],["fpga_statu",{"_index":259,"title":{},"description":{"35":{}}}],["frame",{"_index":145,"title":{},"description":{"6":{}}}],["full",{"_index":191,"title":{"19":{},"52":{}},"description":{"44":{},"47":{},"54":{}}}],["function",{"_index":88,"title":{},"description":{"1":{},"2":{},"3":{}}}],["gap",{"_index":304,"title":{},"description":{"46":{},"49":{}}}],["gcc",{"_index":33,"title":{},"description":{"0":{}}}],["gener",{"_index":13,"title":{"24":{},"25":{},"41":{},"51":{}},"description":{"0":{},"5":{},"24":{},"25":{},"28":{},"30":{}}}],["geometri",{"_index":327,"title":{},"description":{"53":{}}}],["given",{"_index":151,"title":{},"description":{"6":{}}}],["goe",{"_index":341,"title":{},"description":{"58":{}}}],["good",{"_index":289,"title":{},"description":{"45":{},"46":{},"48":{},"49":{}}}],["gpl",{"_index":6,"title":{},"description":{"0":{}}}],["gpl-3.0",{"_index":5,"title":{},"description":{"0":{}}}],["gracefulli",{"_index":154,"title":{},"description":{"6":{}}}],["happen",{"_index":202,"title":{},"description":{"24":{},"25":{}}}],["header",{"_index":32,"title":{},"description":{"0":{}}}],["here",{"_index":233,"title":{},"description":{"28":{},"30":{}}}],["high",{"_index":162,"title":{},"description":{"7":{}}}],["hour",{"_index":104,"title":{},"description":{"2":{}}}],["http",{"_index":239,"title":{},"description":{"28":{},"30":{}}}],["i.",{"_index":171,"title":{},"description":{"8":{},"49":{}}}],["id",{"_index":221,"title":{"36":{}},"description":{"26":{},"36":{}}}],["idl",{"_index":100,"title":{},"description":{"2":{},"3":{},"6":{},"7":{},"8":{},"10":{},"12":{},"14":{},"16":{},"18":{},"19":{},"22":{},"24":{},"25":{},"32":{},"46":{},"47":{},"49":{}}}],["ignor",{"_index":240,"title":{},"description":{"28":{},"30":{},"46":{},"49":{}}}],["imag",{"_index":185,"title":{"16":{},"17":{},"24":{},"25":{},"54":{},"55":{},"56":{},"57":{},"58":{}},"description":{"24":{},"25":{},"30":{},"36":{},"49":{},"54":{},"57":{},"58":{}}}],["image.cbor",{"_index":346,"title":{},"description":{"58":{}}}],["image_buffer/clear",{"_index":338,"title":{},"description":{"57":{}}}],["image_buffer/image.cbor",{"_index":331,"title":{},"description":{"54":{}}}],["image_buffer/image.jpeg",{"_index":334,"title":{},"description":{"55":{}}}],["image_buffer/image.tiff",{"_index":335,"title":{},"description":{"56":{}}}],["image_buffer/start.cbor",{"_index":328,"title":{},"description":{"53":{}}}],["image_buffer/statu",{"_index":347,"title":{},"description":{"58":{}}}],["implement",{"_index":16,"title":{},"description":{"0":{}}}],["impos",{"_index":54,"title":{},"description":{"0":{}}}],["inact",{"_index":69,"title":{},"description":{"1":{},"8":{},"10":{},"12":{},"14":{},"16":{},"18":{},"19":{},"22":{},"26":{},"32":{}}}],["includ",{"_index":339,"title":{},"description":{"58":{}}}],["indefinit",{"_index":129,"title":{},"description":{"4":{}}}],["index",{"_index":178,"title":{"10":{},"11":{}},"description":{}}],["inform",{"_index":140,"title":{},"description":{"6":{}}}],["initi",{"_index":62,"title":{"1":{},"45":{},"48":{}},"description":{"1":{},"4":{},"44":{}}}],["instead",{"_index":80,"title":{},"description":{"1":{}}}],["instrument",{"_index":182,"title":{"14":{},"15":{}},"description":{}}],["integ",{"_index":205,"title":{},"description":{"24":{},"25":{}}}],["integr",{"_index":106,"title":{"22":{},"23":{}},"description":{"2":{},"46":{},"49":{}}}],["intend",{"_index":49,"title":{},"description":{"0":{}}}],["interact",{"_index":18,"title":{},"description":{"0":{}}}],["interfac",{"_index":43,"title":{},"description":{"0":{},"1":{}}}],["intern",{"_index":201,"title":{"24":{},"25":{}},"description":{"24":{},"25":{}}}],["ioctl",{"_index":45,"title":{},"description":{"0":{}}}],["jfjoch_brok",{"_index":349,"title":{"59":{}},"description":{}}],["jpeg",{"_index":332,"title":{"55":{}},"description":{}}],["jungfrau",{"_index":99,"title":{},"description":{"2":{},"38":{}}}],["jungfraujoch",{"_index":215,"title":{"34":{},"51":{},"59":{}},"description":{"26":{},"28":{},"30":{},"57":{},"58":{}}}],["kernel",{"_index":36,"title":{},"description":{"0":{}}}],["kernel'",{"_index":29,"title":{},"description":{"0":{}}}],["last",{"_index":274,"title":{},"description":{"42":{},"57":{}}}],["latest",{"_index":330,"title":{},"description":{"54":{}}}],["latter",{"_index":303,"title":{},"description":{"46":{},"49":{}}}],["librari",{"_index":35,"title":{},"description":{"0":{}}}],["licens",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["linux",{"_index":28,"title":{},"description":{"0":{}}}],["list",{"_index":220,"title":{"27":{}},"description":{"26":{}}}],["load",{"_index":199,"title":{"24":{},"25":{}},"description":{"24":{},"25":{}}}],["long",{"_index":105,"title":{},"description":{"2":{}}}],["make",{"_index":152,"title":{},"description":{"6":{}}}],["mask",{"_index":250,"title":{"32":{},"33":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{}},"description":{"44":{},"45":{},"46":{},"47":{},"48":{},"49":{}}}],["mean",{"_index":284,"title":{},"description":{"44":{},"47":{}}}],["mechan",{"_index":61,"title":{},"description":{"0":{}}}],["mere",{"_index":42,"title":{},"description":{"0":{}}}],["messag",{"_index":229,"title":{"53":{},"54":{}},"description":{"28":{},"30":{}}}],["metadata",{"_index":183,"title":{"14":{},"15":{},"30":{},"31":{}},"description":{"30":{},"53":{},"54":{}}}],["minut",{"_index":86,"title":{},"description":{"1":{}}}],["misbehav",{"_index":295,"title":{},"description":{"46":{},"49":{}}}],["mode",{"_index":297,"title":{},"description":{"46":{},"49":{}}}],["modul",{"_index":301,"title":{},"description":{"46":{},"49":{}}}],["module/storag",{"_index":277,"title":{},"description":{"43":{}}}],["moment",{"_index":252,"title":{},"description":{"32":{}}}],["more",{"_index":342,"title":{},"description":{"58":{}}}],["multipl",{"_index":217,"title":{},"description":{"26":{}}}],["need",{"_index":90,"title":{},"description":{"1":{},"2":{},"46":{},"49":{}}}],["network",{"_index":59,"title":{},"description":{"0":{},"1":{},"6":{}}}],["new",{"_index":174,"title":{},"description":{"8":{}}}],["number",{"_index":206,"title":{},"description":{"24":{},"25":{}}}],["nxmx",{"_index":282,"title":{},"description":{"44":{},"46":{},"47":{},"49":{}}}],["on",{"_index":89,"title":{},"description":{"1":{},"2":{},"8":{},"26":{}}}],["onc",{"_index":102,"title":{},"description":{"2":{}}}],["openapi",{"_index":14,"title":{},"description":{"0":{}}}],["oper",{"_index":74,"title":{},"description":{"1":{},"2":{},"8":{},"32":{},"58":{}}}],["option",{"_index":243,"title":{},"description":{"28":{}}}],["output",{"_index":186,"title":{"16":{},"17":{}},"description":{}}],["pedest",{"_index":79,"title":{"50":{}},"description":{"1":{},"2":{},"4":{},"6":{},"8":{}}}],["per",{"_index":103,"title":{},"description":{"2":{}}}],["period",{"_index":130,"title":{},"description":{"4":{}}}],["pixel",{"_index":280,"title":{},"description":{"44":{},"45":{},"46":{},"47":{},"48":{},"49":{}}}],["plot",{"_index":319,"title":{"51":{}},"description":{}}],["point",{"_index":255,"title":{},"description":{"32":{}}}],["possibl",{"_index":134,"title":{},"description":{"4":{},"32":{}}}],["post",{"_index":78,"title":{},"description":{"1":{},"2":{}}}],["power",{"_index":167,"title":{},"description":{"7":{}}}],["prepar",{"_index":159,"title":{"7":{}},"description":{}}],["preview",{"_index":228,"title":{"28":{},"29":{},"55":{},"56":{}},"description":{"28":{}}}],["preview/pedestal.tiff",{"_index":317,"title":{},"description":{"50":{}}}],["preview/plot",{"_index":320,"title":{},"description":{"51":{}}}],["procedur",{"_index":110,"title":{},"description":{"3":{},"4":{},"8":{}}}],["process",{"_index":147,"title":{"21":{}},"description":{"6":{}}}],["program",{"_index":41,"title":{},"description":{"0":{}}}],["provid",{"_index":131,"title":{},"description":{"4":{},"26":{},"43":{}}}],["provis",{"_index":8,"title":{},"description":{"0":{}}}],["psi",{"_index":253,"title":{},"description":{"32":{}}}],["pub",{"_index":246,"title":{},"description":{"30":{}}}],["puls",{"_index":261,"title":{"36":{}},"description":{"36":{}}}],["put",{"_index":241,"title":{},"description":{"28":{},"30":{}}}],["raw",{"_index":189,"title":{"18":{}},"description":{"46":{},"49":{}}}],["raw/convert",{"_index":208,"title":{},"description":{"24":{},"25":{}}}],["readi",{"_index":112,"title":{},"description":{"3":{}}}],["recommend",{"_index":77,"title":{},"description":{"1":{},"2":{}}}],["reconfigur",{"_index":75,"title":{},"description":{"1":{}}}],["record",{"_index":264,"title":{},"description":{"36":{}}}],["regardless",{"_index":55,"title":{},"description":{"0":{}}}],["region",{"_index":296,"title":{},"description":{"46":{},"49":{}}}],["region-of-interest",{"_index":219,"title":{},"description":{"26":{}}}],["reiniti",{"_index":224,"title":{},"description":{"26":{}}}],["replac",{"_index":344,"title":{},"description":{"58":{}}}],["request",{"_index":242,"title":{},"description":{"28":{},"30":{}}}],["requir",{"_index":21,"title":{},"description":{"0":{},"4":{},"24":{},"25":{},"26":{}}}],["respons",{"_index":223,"title":{},"description":{"26":{}}}],["result",{"_index":273,"title":{"52":{}},"description":{"42":{}}}],["result/scan",{"_index":322,"title":{},"description":{"52":{}}}],["retri",{"_index":137,"title":{},"description":{"4":{}}}],["return",{"_index":111,"title":{"36":{},"37":{}},"description":{"3":{},"36":{},"37":{}}}],["roi",{"_index":269,"title":{"39":{},"40":{}},"description":{}}],["run",{"_index":101,"title":{"6":{}},"description":{"2":{},"3":{},"4":{},"6":{},"20":{},"57":{},"58":{}}}],["runtim",{"_index":34,"title":{},"description":{"0":{}}}],["safeti",{"_index":135,"title":{},"description":{"4":{}}}],["save",{"_index":175,"title":{},"description":{"8":{}}}],["scan",{"_index":321,"title":{"52":{}},"description":{}}],["script",{"_index":119,"title":{},"description":{"4":{}}}],["see",{"_index":281,"title":{},"description":{"44":{},"47":{}}}],["select",{"_index":214,"title":{"26":{}},"description":{"27":{}}}],["send",{"_index":138,"title":{"5":{}},"description":{}}],["sent",{"_index":149,"title":{},"description":{"6":{}}}],["separ",{"_index":278,"title":{},"description":{"43":{}}}],["server",{"_index":128,"title":{},"description":{"4":{}}}],["set",{"_index":170,"title":{"10":{},"12":{},"13":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"55":{}},"description":{"8":{},"24":{},"25":{},"26":{},"28":{},"30":{}}}],["shadow",{"_index":294,"title":{},"description":{"46":{},"49":{}}}],["shutter",{"_index":72,"title":{},"description":{"1":{},"2":{}}}],["similar",{"_index":26,"title":{},"description":{"0":{}}}],["size",{"_index":207,"title":{},"description":{"24":{},"25":{}}}],["slot",{"_index":343,"title":{},"description":{"58":{}}}],["socket",{"_index":232,"title":{"31":{}},"description":{"28":{},"30":{}}}],["socket_address",{"_index":237,"title":{},"description":{"28":{},"30":{}}}],["soft",{"_index":139,"title":{"5":{}},"description":{"5":{}}}],["soft/ttl",{"_index":114,"title":{},"description":{"3":{}}}],["softwar",{"_index":126,"title":{},"description":{"4":{}}}],["sole",{"_index":12,"title":{},"description":{"0":{}}}],["specif",{"_index":52,"title":{},"description":{"0":{}}}],["spirit",{"_index":27,"title":{},"description":{"0":{}}}],["spot",{"_index":194,"title":{"20":{}},"description":{"46":{},"49":{}}}],["stack",{"_index":300,"title":{},"description":{"46":{},"49":{}}}],["stage",{"_index":144,"title":{},"description":{"6":{},"58":{}}}],["standard",{"_index":283,"title":{},"description":{"44":{},"47":{}}}],["start",{"_index":108,"title":{"3":{},"53":{}},"description":{"3":{}}}],["state",{"_index":39,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"6":{},"7":{},"8":{},"10":{},"12":{},"14":{},"16":{},"18":{},"19":{},"24":{},"25":{},"26":{},"32":{},"46":{},"47":{},"49":{}}}],["statist",{"_index":272,"title":{"41":{},"42":{},"43":{}},"description":{"41":{},"43":{}}}],["statistics/calibr",{"_index":279,"title":{},"description":{"43":{}}}],["statistics/data_collect",{"_index":275,"title":{},"description":{"42":{}}}],["statu",{"_index":257,"title":{"34":{},"35":{},"38":{},"58":{}},"description":{"34":{},"38":{},"58":{}}}],["stop",{"_index":143,"title":{},"description":{"6":{},"46":{},"49":{}}}],["storag",{"_index":81,"title":{},"description":{"1":{}}}],["store",{"_index":310,"title":{},"description":{"46":{},"49":{}}}],["stream",{"_index":230,"title":{},"description":{"28":{},"30":{}}}],["structur",{"_index":235,"title":{},"description":{"28":{},"30":{}}}],["sub",{"_index":231,"title":{},"description":{"28":{}}}],["subject",{"_index":20,"title":{},"description":{"0":{}}}],["sure",{"_index":153,"title":{},"description":{"6":{}}}],["switch",{"_index":156,"title":{},"description":{"6":{}}}],["synchron",{"_index":125,"title":{},"description":{"4":{}}}],["syscal",{"_index":44,"title":{},"description":{"0":{}}}],["take",{"_index":155,"title":{},"description":{"6":{}}}],["term",{"_index":23,"title":{},"description":{"0":{}}}],["through",{"_index":58,"title":{},"description":{"0":{}}}],["tiff",{"_index":212,"title":{"25":{},"47":{},"48":{},"50":{},"56":{}},"description":{"25":{},"49":{}}}],["till",{"_index":120,"title":{},"description":{"4":{}}}],["time",{"_index":84,"title":{},"description":{"1":{},"2":{},"4":{},"6":{}}}],["timeout",{"_index":132,"title":{},"description":{"4":{}}}],["trigger",{"_index":115,"title":{"5":{}},"description":{"3":{},"5":{}}}],["turn",{"_index":160,"title":{"7":{}},"description":{"7":{},"57":{}}}],["two",{"_index":66,"title":{},"description":{"1":{}}}],["under",{"_index":4,"title":{},"description":{"0":{}}}],["unsign",{"_index":309,"title":{},"description":{"46":{},"49":{}}}],["updat",{"_index":97,"title":{},"description":{"2":{}}}],["upload",{"_index":271,"title":{"40":{},"46":{},"49":{}},"description":{"46":{},"49":{}}}],["us",{"_index":11,"title":{"55":{}},"description":{"0":{},"1":{},"2":{},"7":{},"27":{},"46":{},"49":{}}}],["user",{"_index":40,"title":{"45":{},"46":{},"48":{},"49":{}},"description":{"0":{},"45":{},"46":{},"48":{},"49":{}}}],["userspac",{"_index":31,"title":{},"description":{"0":{}}}],["valid",{"_index":316,"title":{},"description":{"49":{}}}],["valu",{"_index":285,"title":{},"description":{"44":{},"46":{},"47":{},"49":{}}}],["version",{"_index":348,"title":{"59":{}},"description":{"59":{}}}],["via",{"_index":238,"title":{},"description":{"28":{},"30":{}}}],["volatil",{"_index":340,"title":{},"description":{"58":{}}}],["voltag",{"_index":163,"title":{},"description":{"7":{}}}],["wait",{"_index":116,"title":{"4":{}},"description":{}}],["wait_till_don",{"_index":91,"title":{},"description":{"1":{},"2":{},"4":{}}}],["web",{"_index":127,"title":{},"description":{"4":{}}}],["well",{"_index":313,"title":{},"description":{"46":{},"49":{}}}],["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":150,"title":{"12":{},"13":{}},"description":{"6":{}}}],["x-ray",{"_index":71,"title":{},"description":{"1":{},"2":{},"8":{}}}],["xfel",{"_index":260,"title":{"36":{},"37":{}},"description":{"36":{},"37":{}}}],["xfel/event_cod",{"_index":267,"title":{},"description":{"37":{}}}],["xfel/pulse_id",{"_index":265,"title":{},"description":{"36":{}}}],["zeromq",{"_index":227,"title":{"28":{},"29":{},"30":{},"31":{}},"description":{"28":{},"30":{}}}]],"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.110","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":{"type":"integer"},"description":"Binning of frames for the plot (0 = default binning)"},"compression":{"in":"query","name":"compression","required":false,"schema":{"type":"boolean","default":false},"description":"Enable DEFLATE compression of output data."},"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_time","indexing_unit_cell_length","indexing_unit_cell_angle","profile_radius","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"]}},"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_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: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat","schema":{"type":"string","enum":["indigo","viridis","bw","heat"],"default":"indigo"}}},"schemas":{"grid_scan":{"description":"Definition of a grid scan (mutually exclusive with `rotation_axis`)","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 detector geometry refinement algorithm used by Jungfraujoch.\nThis option is using non-linear least squares optimization to find unit cell and beam center.\n","enum":["BeamCenter","None"]},"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":0,"default":1000,"description":"Number of files in a single HDF5 data file (0 = write all images to a single data file)."},"space_group_number":{"type":"integer","format":"int64","minimum":1,"maximum":194,"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","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"},"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/data 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},"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"},"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"}}}}},"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":["None","NXmxLegacy","NXmxVDS","CBF","TIFF","NoFileWritten"],"default":"NXmxLegacy","description":"None - no master file written\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\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","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"}}},"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","high_resolution_limit","low_resolution_limit","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]"},"low_resolution_limit":{"type":"number","format":"float","description":"Low resolution limit for spot finding [Angstrom]"},"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.02,"description":"Width of ice ring in q-space in reciprocal space"},"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"}}},"azim_int_settings":{"type":"object","required":["solid_angle_corr","polarization_corr","high_q_recipA","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","format":"float"},"low_q_recipA":{"type":"number","format":"float"},"q_spacing":{"type":"number","format":"float"},"azimuthal_bins":{"type":"integer","format":"int64","minimum":1,"maximum":256,"default":1,"description":"Numer of azimuthal (phi) bins; 1 = standard 1D azimuthal integration"}}},"detector_list_element":{"type":"object","required":["id","nmodules","description","width","height","serial_number","base_ipv4_addr","udp_interface_count","readout_time_us","min_frame_time_us","min_count_time_us"],"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_us":{"type":"integer","format":"int64"},"min_frame_time_us":{"type":"integer","format":"int64"},"min_count_time_us":{"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_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"}}},"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"}},"z":{"type":"array","items":{"type":"number","format":"float"}}}},"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"},"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"},"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"},"index":{"type":"integer","format":"int64","description":"Indexing solution"},"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"}}}}}},"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"}}},"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)","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"}}},"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"],"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":"Highest resolution of spots used for FFT algorithm; parameter value affects execution time of FFT.\nThere is also correlation between smallest unit cell and max resolution, 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"}}},"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","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_us":{"type":"integer","format":"int64","minimum":1,"description":"Minimum difference between frame time and count time in microseconds\nDefaults are 3 us for EIGER and 20 us for JUNGFRAU\n"},"minimum_count_time_us":{"type":"integer","format":"int64","minimum":0,"description":"Minimum count time available for the detector."},"minimum_frame_time_us":{"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"}},"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"}}},"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"}}}},"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"},"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"},"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","description":"NUMA policy to bind CPUs"},"frontend_directory":{"type":"string","description":"Location of built JavaScript web frontend"},"ssl":{"type":"object","required":["certificate","key"],"properties":{"certificate":{"type":"string","minLength":1,"example":"server.crt"},"key":{"type":"string","minLength":1,"example":"server.key"}}},"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.\nDoesn't run calibration procedure.\nWhen the function returns, detector is ready to accept soft/TTL triggers.\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_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"},"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"}}}},"/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/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"}}}},"/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","parameters":[{"$ref":"#/components/parameters/compression"}],"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"},"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 TIFF (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. \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"},"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"}}}},"404":{"description":"No calibration recorded so far"}}}},"/preview/plot":{"get":{"summary":"Generate 1D plot from Jungfraujoch","parameters":[{"$ref":"#/components/parameters/binning"},{"$ref":"#/components/parameters/compression"},{"$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"}}}}}}},"/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_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_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~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/~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/~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,3.934,1,4.563]],["description/0",[0,1.769,2,4.095,3,2.109,4,2.052,5,1.174,6,3.279,7,1.174,8,1.174,9,1.012,10,0.905,11,1.744,12,1.174,13,0.974,14,1.174,15,1.769,16,1.174,17,2.734,18,2.052,19,0.905,20,2.052,21,1.333,22,1.174,23,2.052,24,1.012,25,2.734,26,1.174,27,1.174,28,2.052,29,1.174,30,1.174,31,1.174,32,1.174,33,1.174,34,1.174,35,1.174,36,2.734,37,1.174,38,1.174,39,0.345,40,0.589,41,1.174,42,2.052,43,1.012,44,1.174,45,1.174,46,1.174,47,1.174,48,1.174,49,1.174,50,1.012,51,1.174,52,1.174,53,1.174,54,1.174,55,1.174,56,1.174,57,1.174,58,1.174,59,0.905,60,1.012,61,1.174]],["title/1",[62,2.167,63,0.373,64,0.965,65,1.908]],["description/1",[11,2.393,39,0.914,43,1.655,59,1.48,62,1.16,63,0.468,66,1.919,67,1.48,68,1.964,69,0.864,70,0.911,71,1.48,72,1.655,73,1.48,74,2.921,75,1.919,76,1.48,77,1.655,78,2.679,79,1.16,80,1.919,81,1.919,82,1.655,83,1.48,84,1.35,85,1.919,86,1.919,87,1.655,88,1.48,89,1.35,90,1.35,91,1.48,92,1.48,93,0.565]],["title/2",[63,0.373,94,1.326,95,2.766,96,2.523]],["description/2",[11,1.336,39,0.739,63,0.261,68,1.928,71,1.938,72,2.166,73,1.938,74,1.632,77,2.166,78,2.166,79,1.518,84,1.768,87,2.166,88,1.938,89,1.768,90,1.768,91,1.938,92,1.938,93,0.739,97,2.513,98,1.768,99,2.166,100,0.809,101,1.336,102,2.513,103,2.513,104,2.513,105,2.513,106,1.632,107,2.513]],["title/3",[63,0.474,108,3.52]],["description/3",[39,0.988,63,0.494,64,0.903,65,1.785,88,2.589,98,2.361,100,1.081,101,1.785,108,3.668,109,3.356,110,2.589,111,2.179,112,3.356,113,3.356,114,3.356,115,2.589]],["title/4",[65,2.136,93,1.182,116,4.016]],["description/4",[15,1.786,21,1.346,62,1.252,64,0.889,73,1.598,79,1.252,83,2.549,84,1.458,91,1.598,92,2.549,94,1.222,101,1.757,110,1.598,117,3.304,118,2.072,119,2.072,120,2.072,121,1.786,122,1.458,123,2.072,124,1.598,125,2.072,126,2.072,127,2.072,128,2.072,129,2.072,130,2.072,131,1.598,132,3.304,133,2.072,134,1.786,135,2.072,136,3.304,137,2.072]],["title/5",[63,0.373,115,2.766,138,3.586,139,3.092]],["description/5",[13,2.496,115,4.93,139,4.532]],["title/6",[64,0.965,94,1.326,101,1.908,124,2.766]],["description/6",[39,0.61,59,1.598,63,0.215,64,1.109,65,1.102,79,1.252,84,1.458,94,1.222,96,2.325,100,0.667,101,1.102,121,2.849,122,3.308,124,1.598,140,2.072,141,1.252,142,2.072,143,2.549,144,1.786,145,2.072,146,2.072,147,1.786,148,2.072,149,2.072,150,1.598,151,2.072,152,2.072,153,2.072,154,2.072,155,2.072,156,2.072,157,2.072,158,1.598]],["title/7",[63,0.417,159,4.016,160,3.098]],["description/7",[11,1.74,39,0.963,63,0.485,64,0.881,65,1.74,70,1.554,100,1.053,122,2.302,160,3.602,161,4.669,162,3.272,163,3.272,164,3.272,165,3.272,166,3.272,167,3.272]],["title/8",[63,0.417,168,2.016,169,1.808]],["description/8",[39,1.239,63,0.543,68,1.702,69,1.527,70,1.61,71,1.651,74,1.39,76,1.651,79,2.049,83,2.615,89,1.506,93,0.63,94,0.791,98,2.385,100,1.092,110,1.651,158,1.651,168,1.074,170,1.486,171,1.845,172,2.14,173,1.845,174,2.14,175,2.14,176,1.845]],["title/9",[63,0.474,169,2.055]],["description/9",[93,1.612,176,4.723,177,2.914]],["title/10",[168,1.8,170,1.266,178,3.092,179,3.586]],["description/10",[39,1.38,63,0.487,69,2.111,70,2.226,93,1.38,100,1.509,180,4.041]],["title/11",[169,2.055,178,3.934]],["description/11",[93,1.612,177,2.914,180,4.723]],["title/12",[10,2.766,150,2.766,168,1.8,170,1.266]],["description/12",[39,1.38,63,0.487,69,2.111,70,2.226,93,1.38,100,1.509,181,4.041]],["title/13",[10,3.098,150,3.098,170,1.417]],["description/13",[93,1.612,177,2.914,181,4.723]],["title/14",[168,2.016,182,3.463,183,2.272]],["description/14",[39,1.38,63,0.487,69,2.111,70,2.226,93,1.38,100,1.509,184,4.041]],["title/15",[182,3.934,183,2.581]],["description/15",[93,1.612,177,2.914,184,4.723]],["title/16",[168,1.8,185,1.209,186,3.092,187,1.8]],["description/16",[39,1.38,63,0.487,69,2.111,70,2.226,93,1.38,100,1.509,188,4.041]],["title/17",[185,1.353,186,3.463,187,2.016]],["description/17",[93,1.612,177,2.914,188,4.723]],["title/18",[64,0.872,94,1.198,169,1.459,187,1.626,189,2.499]],["description/18",[39,1.38,63,0.487,69,2.111,70,2.226,93,1.38,100,1.509,190,4.688]],["title/19",[64,0.795,94,1.092,169,1.33,187,1.483,191,1.918,192,2.279]],["description/19",[39,1.38,63,0.487,69,2.111,70,2.226,93,1.38,100,1.509,193,4.688]],["title/20",[169,1.808,194,3.098,195,3.098]],["description/20",[64,1.309,93,1.431,94,1.798,101,2.587,177,2.587,196,4.193]],["title/21",[64,1.081,147,3.463,169,1.808]],["description/21",[93,1.612,177,2.914,196,4.723]],["title/22",[106,2.608,169,1.808,197,2.825]],["description/22",[63,0.525,69,2.275,93,1.487,100,1.627,198,4.356]],["title/23",[106,2.608,169,1.808,197,2.825]],["description/23",[93,1.612,177,2.914,198,4.723]],["title/24",[13,1.403,141,1.785,185,0.996,199,2.078,200,1.785,201,2.078]],["description/24",[13,1.411,21,1.93,39,0.875,63,0.536,100,0.957,141,1.796,170,1.049,185,1.002,199,2.091,200,1.796,201,2.091,202,2.563,203,2.972,204,2.563,205,2.563,206,2.563,207,2.563,208,2.563,209,1.796,210,2.563,211,2.972]],["title/25",[13,1.403,141,1.785,185,0.996,199,2.078,201,2.078,212,1.671]],["description/25",[13,1.444,21,1.975,39,0.895,63,0.543,100,0.979,141,1.838,170,1.073,185,1.025,199,2.14,201,2.14,202,2.623,204,2.623,205,2.623,206,2.623,207,2.623,208,2.623,209,1.838,210,2.623,212,1.721,213,3.042]],["title/26",[63,0.474,214,3.934]],["description/26",[21,1.768,24,2.348,39,0.801,50,3.52,63,0.566,69,1.226,89,2.872,122,1.916,131,2.101,168,1.367,170,0.961,215,1.448,216,2.723,217,2.723,218,2.723,219,2.723,220,2.348,221,2.101,222,2.723,223,2.723,224,2.723,225,2.348]],["title/27",[63,0.417,220,3.463,226,3.098]],["description/27",[11,2.687,63,0.525,169,2.275,214,4.356,225,4.356]],["title/28",[170,1.758,227,2.167,228,2.329]],["description/28",[13,1.193,64,0.676,158,1.938,168,1.261,170,1.355,215,1.336,227,1.518,228,2.494,229,1.768,230,2.166,231,2.513,232,2.963,233,2.166,234,2.166,235,2.166,236,1.768,237,2.166,238,2.166,239,3.312,240,1.768,241,3.312,242,3.312,243,2.513,244,2.513,245,2.166]],["title/29",[170,1.417,227,2.427,228,2.608]],["description/29",[245,5.157]],["title/30",[170,1.758,183,2.029,227,2.167]],["description/30",[13,1.321,64,0.749,168,1.396,170,0.982,183,1.573,185,0.937,215,1.479,227,1.681,229,1.957,230,3.576,232,3.199,233,2.398,234,2.398,235,2.398,236,1.957,237,2.398,238,2.398,239,2.398,240,1.957,241,2.398,242,2.398,246,2.782,247,2.782,248,2.398]],["title/31",[170,1.266,183,2.029,227,2.167,232,2.766]],["description/31",[248,5.157]],["title/32",[64,0.731,94,1.004,95,2.094,169,1.222,170,0.958,249,2.341,250,1.053]],["description/32",[39,1.041,63,0.513,69,1.594,70,1.68,74,2.298,93,1.041,100,1.14,134,3.051,226,2.73,251,3.539,252,3.539,253,3.539,254,3.539,255,3.539,256,3.051]],["title/33",[64,0.795,94,1.092,95,2.279,170,1.042,249,2.547,250,1.145]],["description/33",[256,5.157]],["title/34",[215,2.427,257,2.581]],["description/34",[64,1.415,65,2.796,257,3.615]],["title/35",[141,2.427,257,2.272,258,4.016]],["description/35",[259,5.982]],["title/36",[64,0.731,65,1.444,96,1.91,111,1.763,221,2.094,260,1.91,261,2.341]],["description/36",[68,2.123,111,2.747,185,1.425,221,3.263,260,2.976,261,3.647,262,3.263,263,3.263,264,4.23,265,4.23]],["title/37",[19,2.094,64,0.731,65,1.444,96,1.91,111,1.763,260,1.91,266,2.341]],["description/37",[19,3.751,111,3.158,260,3.421,262,3.751,266,4.193,267,4.863]],["title/38",[63,0.474,257,2.581]],["description/38",[63,0.546,99,4.532,257,2.973,268,5.256]],["title/39",[3,3.52,269,3.934]],["description/39",[270,5.157]],["title/40",[3,3.098,269,3.463,271,2.608]],["description/40",[270,5.157]],["title/41",[13,2.167,272,2.963]],["description/41",[272,3.884]],["title/42",[64,1.081,94,1.485,272,2.608]],["description/42",[64,1.36,94,1.868,273,4.356,274,4.356,275,5.052]],["title/43",[98,3.21,272,2.963]],["description/43",[82,4.041,131,3.616,272,3.044,276,4.688,277,4.688,278,4.688,279,4.688]],["title/44",[63,0.417,200,2.427,250,1.557]],["description/44",[62,2.329,63,0.544,191,2.502,250,1.494,280,3.162,281,3.322,282,2.711,283,3.322,284,3.322,285,2.711,286,3.854]],["title/45",[40,1.483,62,1.785,63,0.451,200,1.785,250,1.145]],["description/45",[40,1.826,63,0.523,68,2.525,209,2.198,250,1.951,263,2.806,280,3.04,287,3.136,288,2.559,289,2.559,290,3.136]],["title/46",[40,1.626,63,0.337,200,1.958,250,1.256,271,2.104]],["description/46",[11,0.826,39,0.457,40,1.309,63,0.271,67,1.197,68,1.983,90,1.092,100,0.5,106,1.008,143,1.197,189,1.197,192,1.197,194,1.197,195,1.197,197,1.092,200,0.938,209,0.938,240,1.092,250,1.85,262,1.197,271,1.008,280,1.576,282,1.092,285,1.835,288,1.092,289,1.092,290,1.338,291,1.338,292,1.338,293,1.338,294,1.338,295,1.338,296,1.338,297,1.338,298,1.338,299,1.338,300,1.338,301,2.249,302,1.338,303,1.338,304,1.338,305,1.338,306,1.338,307,1.338,308,1.338,309,1.338,310,1.338,311,1.338,312,1.338,313,1.338]],["title/47",[63,0.417,212,2.272,250,1.557]],["description/47",[39,1.134,63,0.401,100,1.241,191,2.502,250,1.494,280,3.162,281,3.322,282,2.711,283,3.322,284,3.322,285,2.711,314,3.854]],["title/48",[40,1.483,62,1.785,63,0.451,212,1.671,250,1.145]],["description/48",[40,1.826,63,0.523,68,2.525,209,2.198,250,1.951,263,2.806,280,3.04,287,3.136,288,2.559,289,2.559,315,3.136]],["title/49",[40,1.8,63,0.373,250,1.391,271,2.329]],["description/49",[9,1.171,11,0.722,39,0.4,40,1.817,63,0.242,67,1.047,68,2.045,90,0.955,100,0.437,106,0.882,143,1.047,171,1.171,173,1.171,185,0.458,189,1.047,192,1.047,194,1.047,195,1.047,197,0.955,209,0.82,212,0.768,240,0.955,250,1.945,271,0.882,280,2.188,282,0.955,285,2.15,288,0.955,289,0.955,291,1.171,292,1.171,293,1.171,294,1.171,295,1.171,296,1.171,297,1.171,298,1.171,299,1.171,300,1.171,301,2.007,302,1.171,303,1.171,304,1.171,305,1.171,306,1.171,307,1.171,308,1.171,309,1.171,310,1.171,311,1.171,312,1.171,313,1.171,315,1.171,316,1.358]],["title/50",[79,2.427,187,2.016,212,2.272]],["description/50",[317,5.982]],["title/51",[13,1.703,215,1.908,318,3.586,319,3.586]],["description/51",[320,5.982]],["title/52",[191,2.608,273,3.463,321,4.016]],["description/52",[322,5.982]],["title/53",[108,2.766,187,1.8,229,2.523,323,3.092]],["description/53",[183,2.652,236,3.298,324,4.688,325,4.688,326,4.688,327,4.688,328,4.688]],["title/54",[185,1.209,187,1.8,229,2.523,323,3.092]],["description/54",[64,1.468,94,1.515,183,2.317,185,1.838,191,2.66,236,2.882,329,4.097,330,4.097,331,4.097]],["title/55",[11,1.444,170,0.958,185,0.915,187,1.362,228,1.763,332,2.715,333,2.715]],["description/55",[334,5.982]],["title/56",[185,1.209,187,1.8,212,2.029,228,2.329]],["description/56",[335,5.982]],["title/57",[185,1.353,336,4.016,337,2.825]],["description/57",[64,1.468,94,2.016,101,2.179,160,3.16,185,1.381,215,2.179,274,3.532,337,2.882,338,4.097]],["title/58",[185,1.353,257,2.272,337,2.825]],["description/58",[60,2.125,64,1.24,68,1.237,74,1.601,76,2.92,94,1.704,101,1.311,144,2.125,185,1.742,215,1.311,226,1.901,257,1.394,337,3.242,339,2.465,340,2.465,341,2.465,342,2.465,343,2.465,344,2.465,345,2.465,346,2.465,347,2.465]],["title/59",[215,2.136,348,3.463,349,4.016]],["description/59",[348,5.157]]],"invertedIndex":[["",{"_index":68,"title":{},"description":{"1":{},"2":{},"8":{},"36":{},"45":{},"46":{},"48":{},"49":{},"58":{}}}],["0",{"_index":288,"title":{},"description":{"45":{},"46":{},"48":{},"49":{}}}],["1",{"_index":263,"title":{},"description":{"36":{},"45":{},"48":{}}}],["100",{"_index":107,"title":{},"description":{"2":{}}}],["1024x512",{"_index":299,"title":{},"description":{"46":{},"49":{}}}],["16-bit",{"_index":204,"title":{},"description":{"24":{},"25":{}}}],["1d",{"_index":318,"title":{"51":{}},"description":{}}],["4-byte",{"_index":308,"title":{},"description":{"46":{},"49":{}}}],["8",{"_index":312,"title":{},"description":{"46":{},"49":{}}}],["accept",{"_index":113,"title":{},"description":{"3":{}}}],["account",{"_index":292,"title":{},"description":{"46":{},"49":{}}}],["acquisit",{"_index":65,"title":{"1":{},"4":{},"36":{},"37":{}},"description":{"3":{},"6":{},"7":{},"34":{}}}],["actual",{"_index":287,"title":{},"description":{"45":{},"48":{}}}],["adjust",{"_index":234,"title":{},"description":{"28":{},"30":{}}}],["affect",{"_index":123,"title":{},"description":{"4":{}}}],["again",{"_index":172,"title":{},"description":{"8":{}}}],["algorithm",{"_index":179,"title":{"10":{}},"description":{}}],["allow",{"_index":50,"title":{},"description":{"0":{},"26":{}}}],["alway",{"_index":165,"title":{},"description":{"7":{}}}],["and/or",{"_index":218,"title":{},"description":{"26":{}}}],["anytim",{"_index":177,"title":{},"description":{"9":{},"11":{},"13":{},"15":{},"17":{},"20":{},"21":{},"23":{}}}],["api",{"_index":2,"title":{},"description":{"0":{}}}],["appli",{"_index":9,"title":{},"description":{"0":{},"49":{}}}],["applic",{"_index":17,"title":{},"description":{"0":{}}}],["approach",{"_index":30,"title":{},"description":{"0":{}}}],["array",{"_index":262,"title":{},"description":{"36":{},"37":{},"46":{}}}],["asic",{"_index":164,"title":{},"description":{"7":{}}}],["assign",{"_index":306,"title":{},"description":{"46":{},"49":{}}}],["async",{"_index":87,"title":{},"description":{"1":{},"2":{}}}],["automat",{"_index":173,"title":{},"description":{"8":{},"49":{}}}],["avail",{"_index":226,"title":{"27":{}},"description":{"32":{},"58":{}}}],["azimuth",{"_index":197,"title":{"22":{},"23":{}},"description":{"46":{},"49":{}}}],["back",{"_index":157,"title":{},"description":{"6":{}}}],["base",{"_index":244,"title":{},"description":{"28":{}}}],["be",{"_index":146,"title":{},"description":{"6":{}}}],["beam",{"_index":293,"title":{},"description":{"46":{},"49":{}}}],["befor",{"_index":166,"title":{},"description":{"7":{}}}],["between",{"_index":345,"title":{},"description":{"58":{}}}],["binari",{"_index":200,"title":{"24":{},"44":{},"45":{},"46":{}},"description":{"24":{},"46":{}}}],["bit",{"_index":311,"title":{},"description":{"46":{},"49":{}}}],["blob",{"_index":203,"title":{},"description":{"24":{}}}],["block",{"_index":117,"title":{},"description":{"4":{}}}],["both",{"_index":298,"title":{},"description":{"46":{},"49":{}}}],["buffer",{"_index":337,"title":{"57":{},"58":{}},"description":{"57":{},"58":{}}}],["calcul",{"_index":249,"title":{"32":{},"33":{}},"description":{}}],["calibr",{"_index":98,"title":{"43":{}},"description":{"2":{},"3":{},"8":{}}}],["call",{"_index":60,"title":{},"description":{"0":{},"58":{}}}],["cancel",{"_index":124,"title":{"6":{}},"description":{"4":{},"6":{}}}],["card",{"_index":142,"title":{},"description":{"6":{}}}],["case",{"_index":67,"title":{},"description":{"1":{},"46":{},"49":{}}}],["cbor",{"_index":323,"title":{"53":{},"54":{}},"description":{}}],["cell",{"_index":82,"title":{},"description":{"1":{},"43":{}}}],["chang",{"_index":168,"title":{"8":{},"10":{},"12":{},"14":{},"16":{}},"description":{"8":{},"26":{},"28":{},"30":{}}}],["choos",{"_index":24,"title":{},"description":{"0":{},"26":{}}}],["clarif",{"_index":1,"title":{"0":{}},"description":{}}],["clear",{"_index":336,"title":{"57":{}},"description":{}}],["client",{"_index":15,"title":{},"description":{"0":{},"4":{}}}],["close",{"_index":73,"title":{},"description":{"1":{},"2":{},"4":{}}}],["code",{"_index":19,"title":{"37":{}},"description":{"0":{},"37":{}}}],["collect",{"_index":94,"title":{"2":{},"6":{},"18":{},"19":{},"32":{},"33":{},"42":{}},"description":{"4":{},"6":{},"8":{},"20":{},"42":{},"54":{},"57":{},"58":{}}}],["come",{"_index":329,"title":{},"description":{"54":{}}}],["command",{"_index":122,"title":{},"description":{"4":{},"6":{},"7":{},"26":{}}}],["commun",{"_index":57,"title":{},"description":{"0":{}}}],["config/azim_int",{"_index":198,"title":{},"description":{"22":{},"23":{}}}],["config/dark_mask",{"_index":256,"title":{},"description":{"32":{},"33":{}}}],["config/detector",{"_index":176,"title":{},"description":{"8":{},"9":{}}}],["config/file_writ",{"_index":181,"title":{},"description":{"12":{},"13":{}}}],["config/image_format",{"_index":188,"title":{},"description":{"16":{},"17":{}}}],["config/image_format/convers",{"_index":193,"title":{},"description":{"19":{}}}],["config/image_format/raw",{"_index":190,"title":{},"description":{"18":{}}}],["config/index",{"_index":180,"title":{},"description":{"10":{},"11":{}}}],["config/instru",{"_index":184,"title":{},"description":{"14":{},"15":{}}}],["config/internal_generator_imag",{"_index":211,"title":{},"description":{"24":{}}}],["config/internal_generator_image.tiff",{"_index":213,"title":{},"description":{"25":{}}}],["config/mask",{"_index":286,"title":{},"description":{"44":{}}}],["config/mask.tiff",{"_index":314,"title":{},"description":{"47":{}}}],["config/roi",{"_index":270,"title":{},"description":{"39":{},"40":{}}}],["config/select_detector",{"_index":225,"title":{},"description":{"26":{},"27":{}}}],["config/spot_find",{"_index":196,"title":{},"description":{"20":{},"21":{}}}],["config/user_mask",{"_index":290,"title":{},"description":{"45":{},"46":{}}}],["config/user_mask.tiff",{"_index":315,"title":{},"description":{"48":{},"49":{}}}],["config/zeromq_metadata",{"_index":248,"title":{},"description":{"30":{},"31":{}}}],["config/zeromq_preview",{"_index":245,"title":{},"description":{"28":{},"29":{}}}],["configur",{"_index":169,"title":{"8":{},"9":{},"11":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"32":{}},"description":{"27":{}}}],["connect",{"_index":136,"title":{},"description":{"4":{}}}],["consist",{"_index":222,"title":{},"description":{"26":{}}}],["contain",{"_index":236,"title":{},"description":{"28":{},"30":{},"53":{},"54":{}}}],["control",{"_index":216,"title":{},"description":{"26":{}}}],["convers",{"_index":192,"title":{"19":{}},"description":{"46":{},"49":{}}}],["convert",{"_index":302,"title":{},"description":{"46":{},"49":{}}}],["coordin",{"_index":209,"title":{},"description":{"24":{},"25":{},"45":{},"46":{},"48":{},"49":{}}}],["copyleft",{"_index":7,"title":{},"description":{"0":{}}}],["cover",{"_index":247,"title":{},"description":{"30":{}}}],["cpu",{"_index":148,"title":{},"description":{"6":{}}}],["current",{"_index":96,"title":{"2":{},"36":{},"37":{}},"description":{"6":{}}}],["custom",{"_index":333,"title":{"55":{}},"description":{}}],["dark",{"_index":95,"title":{"2":{},"32":{},"33":{}},"description":{}}],["data",{"_index":64,"title":{"1":{},"6":{},"18":{},"19":{},"21":{},"32":{},"33":{},"36":{},"37":{},"42":{}},"description":{"3":{},"4":{},"6":{},"7":{},"20":{},"28":{},"30":{},"34":{},"42":{},"54":{},"57":{},"58":{}}}],["dataset",{"_index":324,"title":{},"description":{"53":{}}}],["deactiv",{"_index":161,"title":{},"description":{"7":{}}}],["dectri",{"_index":251,"title":{},"description":{"32":{}}}],["definit",{"_index":3,"title":{"39":{},"40":{}},"description":{"0":{}}}],["depend",{"_index":210,"title":{},"description":{"24":{},"25":{}}}],["deriv",{"_index":47,"title":{},"description":{"0":{}}}],["detector",{"_index":63,"title":{"1":{},"2":{},"3":{},"5":{},"7":{},"8":{},"9":{},"26":{},"27":{},"38":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{}},"description":{"1":{},"2":{},"3":{},"6":{},"7":{},"8":{},"10":{},"12":{},"14":{},"16":{},"18":{},"19":{},"22":{},"24":{},"25":{},"26":{},"27":{},"32":{},"38":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{}}}],["detector/statu",{"_index":268,"title":{},"description":{"38":{}}}],["develop",{"_index":37,"title":{},"description":{"0":{}}}],["devic",{"_index":258,"title":{"35":{}},"description":{}}],["distribut",{"_index":22,"title":{},"description":{"0":{}}}],["doesn't",{"_index":109,"title":{},"description":{"3":{}}}],["don't",{"_index":305,"title":{},"description":{"46":{},"49":{}}}],["done",{"_index":93,"title":{"4":{}},"description":{"1":{},"2":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"32":{}}}],["dure",{"_index":76,"title":{},"description":{"1":{},"8":{},"58":{}}}],["e.g",{"_index":325,"title":{},"description":{"53":{}}}],["each",{"_index":276,"title":{},"description":{"43":{}}}],["effect",{"_index":158,"title":{},"description":{"6":{},"8":{},"28":{}}}],["eiger",{"_index":254,"title":{},"description":{"32":{}}}],["ensur",{"_index":92,"title":{},"description":{"1":{},"2":{},"4":{}}}],["error",{"_index":70,"title":{},"description":{"1":{},"7":{},"8":{},"10":{},"12":{},"14":{},"16":{},"18":{},"19":{},"32":{}}}],["etc",{"_index":46,"title":{},"description":{"0":{}}}],["event",{"_index":266,"title":{"37":{}},"description":{"37":{}}}],["exampl",{"_index":291,"title":{},"description":{"46":{},"49":{}}}],["except",{"_index":25,"title":{},"description":{"0":{}}}],["execut",{"_index":83,"title":{},"description":{"1":{},"4":{},"8":{}}}],["expect",{"_index":307,"title":{},"description":{"46":{},"49":{}}}],["experiment",{"_index":326,"title":{},"description":{"53":{}}}],["explicitli",{"_index":38,"title":{},"description":{"0":{}}}],["extend",{"_index":133,"title":{},"description":{"4":{}}}],["extern",{"_index":118,"title":{},"description":{"4":{}}}],["few",{"_index":85,"title":{},"description":{"1":{}}}],["file",{"_index":10,"title":{"12":{},"13":{}},"description":{"0":{}}}],["find",{"_index":195,"title":{"20":{}},"description":{"46":{},"49":{}}}],["finish",{"_index":121,"title":{},"description":{"4":{},"6":{}}}],["format",{"_index":187,"title":{"16":{},"17":{},"18":{},"19":{},"50":{},"53":{},"54":{},"55":{},"56":{}},"description":{}}],["fpga",{"_index":141,"title":{"24":{},"25":{},"35":{}},"description":{"6":{},"24":{},"25":{}}}],["fpga_statu",{"_index":259,"title":{},"description":{"35":{}}}],["frame",{"_index":145,"title":{},"description":{"6":{}}}],["full",{"_index":191,"title":{"19":{},"52":{}},"description":{"44":{},"47":{},"54":{}}}],["function",{"_index":88,"title":{},"description":{"1":{},"2":{},"3":{}}}],["gap",{"_index":304,"title":{},"description":{"46":{},"49":{}}}],["gcc",{"_index":33,"title":{},"description":{"0":{}}}],["gener",{"_index":13,"title":{"24":{},"25":{},"41":{},"51":{}},"description":{"0":{},"5":{},"24":{},"25":{},"28":{},"30":{}}}],["geometri",{"_index":327,"title":{},"description":{"53":{}}}],["given",{"_index":151,"title":{},"description":{"6":{}}}],["goe",{"_index":341,"title":{},"description":{"58":{}}}],["good",{"_index":289,"title":{},"description":{"45":{},"46":{},"48":{},"49":{}}}],["gpl",{"_index":6,"title":{},"description":{"0":{}}}],["gpl-3.0",{"_index":5,"title":{},"description":{"0":{}}}],["gracefulli",{"_index":154,"title":{},"description":{"6":{}}}],["happen",{"_index":202,"title":{},"description":{"24":{},"25":{}}}],["header",{"_index":32,"title":{},"description":{"0":{}}}],["here",{"_index":233,"title":{},"description":{"28":{},"30":{}}}],["high",{"_index":162,"title":{},"description":{"7":{}}}],["hour",{"_index":104,"title":{},"description":{"2":{}}}],["http",{"_index":239,"title":{},"description":{"28":{},"30":{}}}],["i.",{"_index":171,"title":{},"description":{"8":{},"49":{}}}],["id",{"_index":221,"title":{"36":{}},"description":{"26":{},"36":{}}}],["idl",{"_index":100,"title":{},"description":{"2":{},"3":{},"6":{},"7":{},"8":{},"10":{},"12":{},"14":{},"16":{},"18":{},"19":{},"22":{},"24":{},"25":{},"32":{},"46":{},"47":{},"49":{}}}],["ignor",{"_index":240,"title":{},"description":{"28":{},"30":{},"46":{},"49":{}}}],["imag",{"_index":185,"title":{"16":{},"17":{},"24":{},"25":{},"54":{},"55":{},"56":{},"57":{},"58":{}},"description":{"24":{},"25":{},"30":{},"36":{},"49":{},"54":{},"57":{},"58":{}}}],["image.cbor",{"_index":346,"title":{},"description":{"58":{}}}],["image_buffer/clear",{"_index":338,"title":{},"description":{"57":{}}}],["image_buffer/image.cbor",{"_index":331,"title":{},"description":{"54":{}}}],["image_buffer/image.jpeg",{"_index":334,"title":{},"description":{"55":{}}}],["image_buffer/image.tiff",{"_index":335,"title":{},"description":{"56":{}}}],["image_buffer/start.cbor",{"_index":328,"title":{},"description":{"53":{}}}],["image_buffer/statu",{"_index":347,"title":{},"description":{"58":{}}}],["implement",{"_index":16,"title":{},"description":{"0":{}}}],["impos",{"_index":54,"title":{},"description":{"0":{}}}],["inact",{"_index":69,"title":{},"description":{"1":{},"8":{},"10":{},"12":{},"14":{},"16":{},"18":{},"19":{},"22":{},"26":{},"32":{}}}],["includ",{"_index":339,"title":{},"description":{"58":{}}}],["indefinit",{"_index":129,"title":{},"description":{"4":{}}}],["index",{"_index":178,"title":{"10":{},"11":{}},"description":{}}],["inform",{"_index":140,"title":{},"description":{"6":{}}}],["initi",{"_index":62,"title":{"1":{},"45":{},"48":{}},"description":{"1":{},"4":{},"44":{}}}],["instead",{"_index":80,"title":{},"description":{"1":{}}}],["instrument",{"_index":182,"title":{"14":{},"15":{}},"description":{}}],["integ",{"_index":205,"title":{},"description":{"24":{},"25":{}}}],["integr",{"_index":106,"title":{"22":{},"23":{}},"description":{"2":{},"46":{},"49":{}}}],["intend",{"_index":49,"title":{},"description":{"0":{}}}],["interact",{"_index":18,"title":{},"description":{"0":{}}}],["interfac",{"_index":43,"title":{},"description":{"0":{},"1":{}}}],["intern",{"_index":201,"title":{"24":{},"25":{}},"description":{"24":{},"25":{}}}],["ioctl",{"_index":45,"title":{},"description":{"0":{}}}],["jfjoch_brok",{"_index":349,"title":{"59":{}},"description":{}}],["jpeg",{"_index":332,"title":{"55":{}},"description":{}}],["jungfrau",{"_index":99,"title":{},"description":{"2":{},"38":{}}}],["jungfraujoch",{"_index":215,"title":{"34":{},"51":{},"59":{}},"description":{"26":{},"28":{},"30":{},"57":{},"58":{}}}],["kernel",{"_index":36,"title":{},"description":{"0":{}}}],["kernel'",{"_index":29,"title":{},"description":{"0":{}}}],["last",{"_index":274,"title":{},"description":{"42":{},"57":{}}}],["latest",{"_index":330,"title":{},"description":{"54":{}}}],["latter",{"_index":303,"title":{},"description":{"46":{},"49":{}}}],["librari",{"_index":35,"title":{},"description":{"0":{}}}],["licens",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["linux",{"_index":28,"title":{},"description":{"0":{}}}],["list",{"_index":220,"title":{"27":{}},"description":{"26":{}}}],["load",{"_index":199,"title":{"24":{},"25":{}},"description":{"24":{},"25":{}}}],["long",{"_index":105,"title":{},"description":{"2":{}}}],["make",{"_index":152,"title":{},"description":{"6":{}}}],["mask",{"_index":250,"title":{"32":{},"33":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{}},"description":{"44":{},"45":{},"46":{},"47":{},"48":{},"49":{}}}],["mean",{"_index":284,"title":{},"description":{"44":{},"47":{}}}],["mechan",{"_index":61,"title":{},"description":{"0":{}}}],["mere",{"_index":42,"title":{},"description":{"0":{}}}],["messag",{"_index":229,"title":{"53":{},"54":{}},"description":{"28":{},"30":{}}}],["metadata",{"_index":183,"title":{"14":{},"15":{},"30":{},"31":{}},"description":{"30":{},"53":{},"54":{}}}],["minut",{"_index":86,"title":{},"description":{"1":{}}}],["misbehav",{"_index":295,"title":{},"description":{"46":{},"49":{}}}],["mode",{"_index":297,"title":{},"description":{"46":{},"49":{}}}],["modul",{"_index":301,"title":{},"description":{"46":{},"49":{}}}],["module/storag",{"_index":277,"title":{},"description":{"43":{}}}],["moment",{"_index":252,"title":{},"description":{"32":{}}}],["more",{"_index":342,"title":{},"description":{"58":{}}}],["multipl",{"_index":217,"title":{},"description":{"26":{}}}],["need",{"_index":90,"title":{},"description":{"1":{},"2":{},"46":{},"49":{}}}],["network",{"_index":59,"title":{},"description":{"0":{},"1":{},"6":{}}}],["new",{"_index":174,"title":{},"description":{"8":{}}}],["number",{"_index":206,"title":{},"description":{"24":{},"25":{}}}],["nxmx",{"_index":282,"title":{},"description":{"44":{},"46":{},"47":{},"49":{}}}],["on",{"_index":89,"title":{},"description":{"1":{},"2":{},"8":{},"26":{}}}],["onc",{"_index":102,"title":{},"description":{"2":{}}}],["openapi",{"_index":14,"title":{},"description":{"0":{}}}],["oper",{"_index":74,"title":{},"description":{"1":{},"2":{},"8":{},"32":{},"58":{}}}],["option",{"_index":243,"title":{},"description":{"28":{}}}],["output",{"_index":186,"title":{"16":{},"17":{}},"description":{}}],["pedest",{"_index":79,"title":{"50":{}},"description":{"1":{},"2":{},"4":{},"6":{},"8":{}}}],["per",{"_index":103,"title":{},"description":{"2":{}}}],["period",{"_index":130,"title":{},"description":{"4":{}}}],["pixel",{"_index":280,"title":{},"description":{"44":{},"45":{},"46":{},"47":{},"48":{},"49":{}}}],["plot",{"_index":319,"title":{"51":{}},"description":{}}],["point",{"_index":255,"title":{},"description":{"32":{}}}],["possibl",{"_index":134,"title":{},"description":{"4":{},"32":{}}}],["post",{"_index":78,"title":{},"description":{"1":{},"2":{}}}],["power",{"_index":167,"title":{},"description":{"7":{}}}],["prepar",{"_index":159,"title":{"7":{}},"description":{}}],["preview",{"_index":228,"title":{"28":{},"29":{},"55":{},"56":{}},"description":{"28":{}}}],["preview/pedestal.tiff",{"_index":317,"title":{},"description":{"50":{}}}],["preview/plot",{"_index":320,"title":{},"description":{"51":{}}}],["procedur",{"_index":110,"title":{},"description":{"3":{},"4":{},"8":{}}}],["process",{"_index":147,"title":{"21":{}},"description":{"6":{}}}],["program",{"_index":41,"title":{},"description":{"0":{}}}],["provid",{"_index":131,"title":{},"description":{"4":{},"26":{},"43":{}}}],["provis",{"_index":8,"title":{},"description":{"0":{}}}],["psi",{"_index":253,"title":{},"description":{"32":{}}}],["pub",{"_index":246,"title":{},"description":{"30":{}}}],["puls",{"_index":261,"title":{"36":{}},"description":{"36":{}}}],["put",{"_index":241,"title":{},"description":{"28":{},"30":{}}}],["raw",{"_index":189,"title":{"18":{}},"description":{"46":{},"49":{}}}],["raw/convert",{"_index":208,"title":{},"description":{"24":{},"25":{}}}],["readi",{"_index":112,"title":{},"description":{"3":{}}}],["recommend",{"_index":77,"title":{},"description":{"1":{},"2":{}}}],["reconfigur",{"_index":75,"title":{},"description":{"1":{}}}],["record",{"_index":264,"title":{},"description":{"36":{}}}],["regardless",{"_index":55,"title":{},"description":{"0":{}}}],["region",{"_index":296,"title":{},"description":{"46":{},"49":{}}}],["region-of-interest",{"_index":219,"title":{},"description":{"26":{}}}],["reiniti",{"_index":224,"title":{},"description":{"26":{}}}],["replac",{"_index":344,"title":{},"description":{"58":{}}}],["request",{"_index":242,"title":{},"description":{"28":{},"30":{}}}],["requir",{"_index":21,"title":{},"description":{"0":{},"4":{},"24":{},"25":{},"26":{}}}],["respons",{"_index":223,"title":{},"description":{"26":{}}}],["result",{"_index":273,"title":{"52":{}},"description":{"42":{}}}],["result/scan",{"_index":322,"title":{},"description":{"52":{}}}],["retri",{"_index":137,"title":{},"description":{"4":{}}}],["return",{"_index":111,"title":{"36":{},"37":{}},"description":{"3":{},"36":{},"37":{}}}],["roi",{"_index":269,"title":{"39":{},"40":{}},"description":{}}],["run",{"_index":101,"title":{"6":{}},"description":{"2":{},"3":{},"4":{},"6":{},"20":{},"57":{},"58":{}}}],["runtim",{"_index":34,"title":{},"description":{"0":{}}}],["safeti",{"_index":135,"title":{},"description":{"4":{}}}],["save",{"_index":175,"title":{},"description":{"8":{}}}],["scan",{"_index":321,"title":{"52":{}},"description":{}}],["script",{"_index":119,"title":{},"description":{"4":{}}}],["see",{"_index":281,"title":{},"description":{"44":{},"47":{}}}],["select",{"_index":214,"title":{"26":{}},"description":{"27":{}}}],["send",{"_index":138,"title":{"5":{}},"description":{}}],["sent",{"_index":149,"title":{},"description":{"6":{}}}],["separ",{"_index":278,"title":{},"description":{"43":{}}}],["server",{"_index":128,"title":{},"description":{"4":{}}}],["set",{"_index":170,"title":{"10":{},"12":{},"13":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"55":{}},"description":{"8":{},"24":{},"25":{},"26":{},"28":{},"30":{}}}],["shadow",{"_index":294,"title":{},"description":{"46":{},"49":{}}}],["shutter",{"_index":72,"title":{},"description":{"1":{},"2":{}}}],["similar",{"_index":26,"title":{},"description":{"0":{}}}],["size",{"_index":207,"title":{},"description":{"24":{},"25":{}}}],["slot",{"_index":343,"title":{},"description":{"58":{}}}],["socket",{"_index":232,"title":{"31":{}},"description":{"28":{},"30":{}}}],["socket_address",{"_index":237,"title":{},"description":{"28":{},"30":{}}}],["soft",{"_index":139,"title":{"5":{}},"description":{"5":{}}}],["soft/ttl",{"_index":114,"title":{},"description":{"3":{}}}],["softwar",{"_index":126,"title":{},"description":{"4":{}}}],["sole",{"_index":12,"title":{},"description":{"0":{}}}],["specif",{"_index":52,"title":{},"description":{"0":{}}}],["spirit",{"_index":27,"title":{},"description":{"0":{}}}],["spot",{"_index":194,"title":{"20":{}},"description":{"46":{},"49":{}}}],["stack",{"_index":300,"title":{},"description":{"46":{},"49":{}}}],["stage",{"_index":144,"title":{},"description":{"6":{},"58":{}}}],["standard",{"_index":283,"title":{},"description":{"44":{},"47":{}}}],["start",{"_index":108,"title":{"3":{},"53":{}},"description":{"3":{}}}],["state",{"_index":39,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"6":{},"7":{},"8":{},"10":{},"12":{},"14":{},"16":{},"18":{},"19":{},"24":{},"25":{},"26":{},"32":{},"46":{},"47":{},"49":{}}}],["statist",{"_index":272,"title":{"41":{},"42":{},"43":{}},"description":{"41":{},"43":{}}}],["statistics/calibr",{"_index":279,"title":{},"description":{"43":{}}}],["statistics/data_collect",{"_index":275,"title":{},"description":{"42":{}}}],["statu",{"_index":257,"title":{"34":{},"35":{},"38":{},"58":{}},"description":{"34":{},"38":{},"58":{}}}],["stop",{"_index":143,"title":{},"description":{"6":{},"46":{},"49":{}}}],["storag",{"_index":81,"title":{},"description":{"1":{}}}],["store",{"_index":310,"title":{},"description":{"46":{},"49":{}}}],["stream",{"_index":230,"title":{},"description":{"28":{},"30":{}}}],["structur",{"_index":235,"title":{},"description":{"28":{},"30":{}}}],["sub",{"_index":231,"title":{},"description":{"28":{}}}],["subject",{"_index":20,"title":{},"description":{"0":{}}}],["sure",{"_index":153,"title":{},"description":{"6":{}}}],["switch",{"_index":156,"title":{},"description":{"6":{}}}],["synchron",{"_index":125,"title":{},"description":{"4":{}}}],["syscal",{"_index":44,"title":{},"description":{"0":{}}}],["take",{"_index":155,"title":{},"description":{"6":{}}}],["term",{"_index":23,"title":{},"description":{"0":{}}}],["through",{"_index":58,"title":{},"description":{"0":{}}}],["tiff",{"_index":212,"title":{"25":{},"47":{},"48":{},"50":{},"56":{}},"description":{"25":{},"49":{}}}],["till",{"_index":120,"title":{},"description":{"4":{}}}],["time",{"_index":84,"title":{},"description":{"1":{},"2":{},"4":{},"6":{}}}],["timeout",{"_index":132,"title":{},"description":{"4":{}}}],["trigger",{"_index":115,"title":{"5":{}},"description":{"3":{},"5":{}}}],["turn",{"_index":160,"title":{"7":{}},"description":{"7":{},"57":{}}}],["two",{"_index":66,"title":{},"description":{"1":{}}}],["under",{"_index":4,"title":{},"description":{"0":{}}}],["unsign",{"_index":309,"title":{},"description":{"46":{},"49":{}}}],["updat",{"_index":97,"title":{},"description":{"2":{}}}],["upload",{"_index":271,"title":{"40":{},"46":{},"49":{}},"description":{"46":{},"49":{}}}],["us",{"_index":11,"title":{"55":{}},"description":{"0":{},"1":{},"2":{},"7":{},"27":{},"46":{},"49":{}}}],["user",{"_index":40,"title":{"45":{},"46":{},"48":{},"49":{}},"description":{"0":{},"45":{},"46":{},"48":{},"49":{}}}],["userspac",{"_index":31,"title":{},"description":{"0":{}}}],["valid",{"_index":316,"title":{},"description":{"49":{}}}],["valu",{"_index":285,"title":{},"description":{"44":{},"46":{},"47":{},"49":{}}}],["version",{"_index":348,"title":{"59":{}},"description":{"59":{}}}],["via",{"_index":238,"title":{},"description":{"28":{},"30":{}}}],["volatil",{"_index":340,"title":{},"description":{"58":{}}}],["voltag",{"_index":163,"title":{},"description":{"7":{}}}],["wait",{"_index":116,"title":{"4":{}},"description":{}}],["wait_till_don",{"_index":91,"title":{},"description":{"1":{},"2":{},"4":{}}}],["web",{"_index":127,"title":{},"description":{"4":{}}}],["well",{"_index":313,"title":{},"description":{"46":{},"49":{}}}],["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":150,"title":{"12":{},"13":{}},"description":{"6":{}}}],["x-ray",{"_index":71,"title":{},"description":{"1":{},"2":{},"8":{}}}],["xfel",{"_index":260,"title":{"36":{},"37":{}},"description":{"36":{},"37":{}}}],["xfel/event_cod",{"_index":267,"title":{},"description":{"37":{}}}],["xfel/pulse_id",{"_index":265,"title":{},"description":{"36":{}}}],["zeromq",{"_index":227,"title":{"28":{},"29":{},"30":{},"31":{}},"description":{"28":{},"30":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/docs/python_client/docs/DefaultApi.md b/docs/python_client/docs/DefaultApi.md
index 995b1f3f..7b3ca5b3 100644
--- a/docs/python_client/docs/DefaultApi.md
+++ b/docs/python_client/docs/DefaultApi.md
@@ -2665,7 +2665,7 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **image_buffer_image_jpeg_get**
-> bytearray image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color)
+> bytearray image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color, show_res_est=show_res_est)
 
 Get preview image in JPEG format using custom settings
 
@@ -2693,14 +2693,15 @@ with jfjoch_client.ApiClient(configuration) as api_client:
     show_roi = False # bool | Show ROI areas on the image (optional) (default to False)
     show_spots = True # bool | Show spot finding results on the image (optional) (default to True)
     show_beam_center = True # bool | Show beam center on the image (optional) (default to True)
-    saturation = 10 # float | Saturation value to set contrast in the preview image (optional) (default to 10)
+    saturation = 3.4 # float | Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used (optional)
     jpeg_quality = 100 # int | Quality of JPEG image (100 - highest; 0 - lowest) (optional) (default to 100)
     show_res_ring = 0.1 # float | Show resolution ring, provided in Angstrom (optional) (default to 0.1)
     color = indigo # str | Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat (optional) (default to indigo)
+    show_res_est = False # bool | Show resolution estimation as a ring (optional) (default to False)
 
     try:
         # Get preview image in JPEG format using custom settings
-        api_response = api_instance.image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color)
+        api_response = api_instance.image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color, show_res_est=show_res_est)
         print("The response of DefaultApi->image_buffer_image_jpeg_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -2719,10 +2720,11 @@ Name | Type | Description  | Notes
  **show_roi** | **bool**| Show ROI areas on the image | [optional] [default to False]
  **show_spots** | **bool**| Show spot finding results on the image | [optional] [default to True]
  **show_beam_center** | **bool**| Show beam center on the image | [optional] [default to True]
- **saturation** | **float**| Saturation value to set contrast in the preview image | [optional] [default to 10]
+ **saturation** | **float**| Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used | [optional] 
  **jpeg_quality** | **int**| Quality of JPEG image (100 - highest; 0 - lowest) | [optional] [default to 100]
  **show_res_ring** | **float**| Show resolution ring, provided in Angstrom | [optional] [default to 0.1]
  **color** | **str**| Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat | [optional] [default to indigo]
+ **show_res_est** | **bool**| Show resolution estimation as a ring | [optional] [default to False]
 
 ### Return type
 
diff --git a/frontend/package-lock.json b/frontend/package-lock.json
index 729ee528..ed423d71 100644
--- a/frontend/package-lock.json
+++ b/frontend/package-lock.json
@@ -1,12 +1,12 @@
 {
   "name": "jungfraujoch-frontend",
-  "version": "1.0.0-rc.109",
+  "version": "1.0.0-rc.110",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "jungfraujoch-frontend",
-      "version": "1.0.0-rc.109",
+      "version": "1.0.0-rc.110",
       "license": "GPL-3.0",
       "dependencies": {
         "@emotion/react": "^11.10.4",
diff --git a/frontend/src/openapi/index.ts b/frontend/src/openapi/index.ts
index d89af6ce..5f66a868 100644
--- a/frontend/src/openapi/index.ts
+++ b/frontend/src/openapi/index.ts
@@ -54,6 +54,7 @@ export type { plot } from './models/plot';
 export { plot_type } from './models/plot_type';
 export { plot_unit_x } from './models/plot_unit_x';
 export type { plots } from './models/plots';
+export type { resolution_estimate } from './models/resolution_estimate';
 export type { resolution_ring } from './models/resolution_ring';
 export type { roi } from './models/roi';
 export type { roi_azim_list } from './models/roi_azim_list';
diff --git a/frontend/src/openapi/models/resolution_estimate.ts b/frontend/src/openapi/models/resolution_estimate.ts
new file mode 100644
index 00000000..5f51febf
--- /dev/null
+++ b/frontend/src/openapi/models/resolution_estimate.ts
@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Show resolution estimation as a ring
+ */
+export type resolution_estimate = boolean;
diff --git a/frontend/src/openapi/models/saturation.ts b/frontend/src/openapi/models/saturation.ts
index 23c7a181..0402923c 100644
--- a/frontend/src/openapi/models/saturation.ts
+++ b/frontend/src/openapi/models/saturation.ts
@@ -4,6 +4,6 @@
 /* eslint-disable */
 
 /**
- * Saturation value to set contrast in the preview image
+ * Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used
  */
 export type saturation = number;
diff --git a/frontend/src/openapi/services/DefaultService.ts b/frontend/src/openapi/services/DefaultService.ts
index a5156f8f..6cd35197 100644
--- a/frontend/src/openapi/services/DefaultService.ts
+++ b/frontend/src/openapi/services/DefaultService.ts
@@ -1078,10 +1078,11 @@ export class DefaultService {
      * @param showRoi Show ROI areas on the image
      * @param showSpots Show spot finding results on the image
      * @param showBeamCenter Show beam center on the image
-     * @param saturation Saturation value to set contrast in the preview image
+     * @param saturation Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used
      * @param jpegQuality Quality of JPEG image (100 - highest; 0 - lowest)
      * @param showResRing Show resolution ring, provided in Angstrom
      * @param color Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat
+     * @param showResEst Show resolution estimation as a ring
      * @returns binary Preview image
      * @throws ApiError
      */
@@ -1091,10 +1092,11 @@ export class DefaultService {
         showRoi: boolean = false,
         showSpots: boolean = true,
         showBeamCenter: boolean = true,
-        saturation: number = 10,
+        saturation?: number,
         jpegQuality: number = 100,
         showResRing: number = 0.1,
         color: 'indigo' | 'viridis' | 'bw' | 'heat' = 'indigo',
+        showResEst: boolean = false,
     ): CancelablePromise<Blob> {
         return __request(OpenAPI, {
             method: 'GET',
@@ -1109,6 +1111,7 @@ export class DefaultService {
                 'jpeg_quality': jpegQuality,
                 'show_res_ring': showResRing,
                 'color': color,
+                'show_res_est': showResEst,
             },
             errors: {
                 400: `Input parsing or validation error`,
diff --git a/preview/PreviewImage.cpp b/preview/PreviewImage.cpp
index 16193fea..daef6864 100644
--- a/preview/PreviewImage.cpp
+++ b/preview/PreviewImage.cpp
@@ -48,14 +48,46 @@ void PreviewImage::roi(std::vector<rgb> &ret, int64_t in_xpixel, int64_t in_ypix
 }
 
 template<class T>
-std::vector<rgb> PreviewImage::GenerateRGB(const uint8_t* value_8,
+std::vector<rgb> PreviewImage::GenerateRGB(const uint8_t *value_8,
                                            int64_t special_value_64,
+                                           int64_t sat_value_64,
                                            const ColorScale &scale,
-                                           const PreviewImageSettings& settings) const {
+                                           const PreviewImageSettings &settings) const {
     auto value = reinterpret_cast<const T *>(value_8);
     auto special_value = static_cast<T>(special_value_64);
 
-    std::vector<rgb> ret(xpixel*ypixel);
+    float background = settings.background_value.value_or(0.0);
+    float foreground;
+    if (settings.saturation_value.has_value())
+        foreground = settings.saturation_value.value();
+    else {
+        // Auto-contrast procedure
+        std::vector<int64_t> valid;
+        valid.reserve(xpixel * ypixel);
+        for (int i = 0; i < xpixel * ypixel; i++) {
+            if ((value[i] != special_value)
+                && (value[i] != sat_value_64)
+                && (mask[i] != MaskDet)
+                && (mask[i] != MaskGap)
+                && (!settings.show_user_mask || (mask[i] != MaskUsr)))
+                valid.push_back(static_cast<int64_t>(value[i]));
+        }
+
+        if (!valid.empty()) {
+            const size_t m = valid.size();
+            size_t ignore = std::max<size_t>(1, static_cast<size_t>(std::floor(m * auto_foreground_range)));
+            if (ignore >= m) ignore = m - 1; // ensure at least one value remains
+            const size_t rank = m - ignore - 1; // 0-based index for the desired value
+            std::nth_element(valid.begin(), valid.begin() + rank, valid.end());
+            foreground = static_cast<float>(valid[rank]);
+        } else {
+            // Fallback to something above background if no valid pixels remain
+            foreground = background + 1.0f;
+        }
+
+    }
+
+    std::vector<rgb> ret(xpixel * ypixel);
     for (int i = 0; i < xpixel*ypixel; i++) {
         if (mask[i] == MaskGap)
             ret[i] = scale.Apply(ColorScaleSpecial::Gap);
@@ -64,7 +96,7 @@ std::vector<rgb> PreviewImage::GenerateRGB(const uint8_t* value_8,
                  || (settings.show_user_mask && (mask[i] == MaskUsr))) {
             ret[i] = scale.Apply(ColorScaleSpecial::BadPixel);
         } else
-            ret[i] = scale.Apply(value[i], 0.0, settings.saturation_value);;
+            ret[i] = scale.Apply(value[i], background, foreground);
     }
     return ret;
 }
@@ -214,22 +246,22 @@ std::vector<rgb> PreviewImage::GenerateRGB(const PreviewImageSettings &settings,
 
         switch (msg.image.GetMode()) {
             case CompressedImageMode::Int8:
-                v = GenerateRGB<int8_t>(image_ptr, INT8_MIN, scale, settings);
+                v = GenerateRGB<int8_t>(image_ptr, INT8_MIN, INT8_MAX, scale, settings);
                 break;
             case CompressedImageMode::Int16:
-                v = GenerateRGB<int16_t>(image_ptr, INT16_MIN, scale, settings);
+                v = GenerateRGB<int16_t>(image_ptr, INT16_MIN, INT16_MAX, scale, settings);
                 break;
             case CompressedImageMode::Int32:
-                v = GenerateRGB<int32_t>(image_ptr, INT32_MIN, scale, settings);
+                v = GenerateRGB<int32_t>(image_ptr, INT32_MIN, INT32_MAX, scale, settings);
                 break;
             case CompressedImageMode::Uint8:
-                v = GenerateRGB<uint8_t>(image_ptr,UINT8_MAX, scale, settings);
+                v = GenerateRGB<uint8_t>(image_ptr,UINT8_MAX, UINT8_MAX, scale, settings);
                 break;
             case CompressedImageMode::Uint16:
-                v = GenerateRGB<uint16_t>(image_ptr,UINT16_MAX, scale, settings);
+                v = GenerateRGB<uint16_t>(image_ptr,UINT16_MAX, UINT16_MAX, scale, settings);
                 break;
             case CompressedImageMode::Uint32:
-                v = GenerateRGB<uint32_t>(image_ptr,UINT16_MAX, scale, settings);
+                v = GenerateRGB<uint32_t>(image_ptr,UINT32_MAX, UINT32_MAX, scale, settings);
                 break;
             default:
                 throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "Mode not supported");
diff --git a/preview/PreviewImage.h b/preview/PreviewImage.h
index a37cb8cd..7a30fe19 100644
--- a/preview/PreviewImage.h
+++ b/preview/PreviewImage.h
@@ -16,7 +16,8 @@
 enum class PreviewImageFormat {JPEG, TIFF};
 
 struct PreviewImageSettings {
-    float saturation_value = 10;
+    std::optional<float> saturation_value = 10;
+    std::optional<float> background_value = 0;
     int64_t jpeg_quality = 70;
     bool show_beam_center = true;
     bool show_spots = true;
@@ -46,9 +47,12 @@ class PreviewImage {
     constexpr static uint8_t MaskUsr = 2;
     constexpr static uint8_t MaskDet = 3;
 
+    constexpr static float auto_foreground_range = 0.001f;
+
     template<class T>
     std::vector<rgb> GenerateRGB(const uint8_t* value,
                                  int64_t special_value,
+                                 int64_t sat_value,
                                  const ColorScale &scale,
                                  const PreviewImageSettings& settings) const;
     std::vector<rgb> GenerateRGB(const PreviewImageSettings& settings, const DataMessage &msg) const;
diff --git a/tests/JFJochReceiverProcessingTest.cpp b/tests/JFJochReceiverProcessingTest.cpp
index bcc776af..301ba0a0 100644
--- a/tests/JFJochReceiverProcessingTest.cpp
+++ b/tests/JFJochReceiverProcessingTest.cpp
@@ -995,7 +995,6 @@ TEST_CASE("JFJochIntegrationTest_ZMQ_lysozyme_spot_and_index_32", "[JFJochReceiv
 
     std::string jpeg;
     PreviewImageSettings jpeg_settings{
-            .saturation_value = 10,
             .jpeg_quality = 100,
             .show_spots = true
     };