From f859f8108fc5f1a8bdd4c5011a891a2339267ef3 Mon Sep 17 00:00:00 2001
From: Filip Leonarski <filip.leonarski@psi.ch>
Date: Thu, 25 Jun 2026 13:05:41 +0200
Subject: [PATCH 1/7] TCPStreamPusher: remove MSG_ZEROCOPY machinery, use plain
 blocking send

The MSG_ZEROCOPY path was the common factor behind the occasional mid-run
writer disconnects and added substantial failure surface for no benefit at
this throughput (tens of MB/s): the socket error queue raises POLLERR as a
normal event (entangled with liveness detection), and the per-connection
completion-id counter was reset every run while the kernel's sk_zckey is
monotonic for the life of the socket, so on a persistent connection the
bookkeeping diverged from run 2 onward.

Replace it with a straightforward synchronous send():
- SendAll/SendFrame lose all zerocopy params; DATA payloads are sent with a
  plain ::send(MSG_NOSIGNAL), so the image-buffer slot is owned by the kernel
  once send() returns and WriterThread releases it immediately.
- Drop ZeroCopyCompletionThread and the zc_pending/zc_mutex/zc_cv/zc_*_id
  state, SO_ZEROCOPY setup, and the errqueue include.
- StopDataCollectionThreads now drains and releases any queued-but-unsent
  slots on the stalled-writer path (active==false makes WriterThread exit
  without draining) instead of Clear()-ing them, avoiding a slot leak.

The BUSY-heartbeat peer-liveness timeout (backpressure tolerance) is kept;
it is independent of zerocopy.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---
 image_pusher/TCPStreamPusher.cpp | 277 +++++--------------------------
 image_pusher/TCPStreamPusher.h   |  29 +---
 2 files changed, 40 insertions(+), 266 deletions(-)

diff --git a/image_pusher/TCPStreamPusher.cpp b/image_pusher/TCPStreamPusher.cpp
index 7c2656ba..75844476 100644
--- a/image_pusher/TCPStreamPusher.cpp
+++ b/image_pusher/TCPStreamPusher.cpp
@@ -11,9 +11,6 @@
 #include <netinet/tcp.h>
 #include <unistd.h>
 #include <chrono>
-#if defined(MSG_ZEROCOPY)
-#include <linux/errqueue.h>
-#endif
 
 namespace {
 int64_t SteadyNowNs() {
@@ -197,27 +194,14 @@ bool TCPStreamPusher::IsConnectionAlive(const Connection& c) const {
     return so_error == 0;
 }
 
-bool TCPStreamPusher::SendAll(Connection& c, const void* buf, size_t len, bool allow_zerocopy,
-                              bool* zc_used_out, uint32_t* zc_first_out, uint32_t* zc_last_out) {
+bool TCPStreamPusher::SendAll(Connection& c, const void* buf, size_t len) {
     const auto* p = static_cast<const uint8_t*>(buf);
     size_t sent = 0;
-    bool zc_used = false;
-    uint32_t zc_first = 0;
-    uint32_t zc_last = 0;
-
-    bool try_zerocopy = false;
-#if defined(MSG_ZEROCOPY)
-    try_zerocopy = allow_zerocopy && c.zerocopy_enabled.load(std::memory_order_relaxed);
-#endif
 
     while (sent < len) {
         const int local_fd = c.fd.load();
-        if (local_fd < 0 || c.broken) {
-            if (zc_used_out) *zc_used_out = zc_used;
-            if (zc_first_out) *zc_first_out = zc_first;
-            if (zc_last_out) *zc_last_out = zc_last;
+        if (local_fd < 0 || c.broken)
             return false;
-        }
 
         // Treat backpressure as fatal only if the peer shows NO sign of life. A busy
         // writer keeps refreshing last_peer_activity_ns via BUSY heartbeats / ACKs, so
@@ -228,9 +212,6 @@ bool TCPStreamPusher::SendAll(Connection& c, const void* buf, size_t len, bool a
                            " for " + std::to_string(silent_ns / 1000000) + " ms while sending; marking broken");
             c.broken = true;
             CloseFd(c.fd);
-            if (zc_used_out) *zc_used_out = zc_used;
-            if (zc_first_out) *zc_first_out = zc_first;
-            if (zc_last_out) *zc_last_out = zc_last;
             return false;
         }
 
@@ -243,9 +224,6 @@ bool TCPStreamPusher::SendAll(Connection& c, const void* buf, size_t len, bool a
                 continue;
             c.broken = true;
             CloseFd(c.fd);
-            if (zc_used_out) *zc_used_out = zc_used;
-            if (zc_first_out) *zc_first_out = zc_first;
-            if (zc_last_out) *zc_last_out = zc_last;
             return false;
         }
         if (prc == 0)
@@ -253,63 +231,28 @@ bool TCPStreamPusher::SendAll(Connection& c, const void* buf, size_t len, bool a
         if ((pfd.revents & (POLLERR | POLLHUP | POLLNVAL)) != 0 && !(pfd.revents & POLLOUT)) {
             c.broken = true;
             CloseFd(c.fd);
-            if (zc_used_out) *zc_used_out = zc_used;
-            if (zc_first_out) *zc_first_out = zc_first;
-            if (zc_last_out) *zc_last_out = zc_last;
             return false;
         }
 
-        int flags = MSG_NOSIGNAL;
-#if defined(MSG_ZEROCOPY)
-        if (try_zerocopy)
-            flags |= MSG_ZEROCOPY;
-#endif
-
-        ssize_t rc = ::send(local_fd, p + sent, len - sent, flags);
+        ssize_t rc = ::send(local_fd, p + sent, len - sent, MSG_NOSIGNAL);
         if (rc < 0) {
             if (errno == EINTR || errno == EAGAIN || errno == EWOULDBLOCK)
                 continue;
 
-#if defined(MSG_ZEROCOPY)
-            if (try_zerocopy && (errno == EOPNOTSUPP || errno == EINVAL || errno == ENOBUFS)) {
-                try_zerocopy = false;
-                c.zerocopy_enabled.store(false, std::memory_order_relaxed);
-                continue;
-            }
-#endif
-
             if (errno == EPIPE || errno == ECONNRESET || errno == ENOTCONN) {
                 c.broken = true;
                 CloseFd(c.fd);
             }
-
-            if (zc_used_out) *zc_used_out = zc_used;
-            if (zc_first_out) *zc_first_out = zc_first;
-            if (zc_last_out) *zc_last_out = zc_last;
             return false;
         }
 
-#if defined(MSG_ZEROCOPY)
-        if (try_zerocopy && rc > 0) {
-            const uint32_t this_id = c.zc_next_id++;
-            if (!zc_used) {
-                zc_used = true;
-                zc_first = this_id;
-            }
-            zc_last = this_id;
-        }
-#endif
-
         sent += static_cast<size_t>(rc);
     }
 
-    if (zc_used_out) *zc_used_out = zc_used;
-    if (zc_first_out) *zc_first_out = zc_first;
-    if (zc_last_out) *zc_last_out = zc_last;
     return true;
 }
 
-bool TCPStreamPusher::SendFrame(Connection& c, const uint8_t* data, size_t size, TCPFrameType type, int64_t image_number, ZeroCopyReturnValue* z) {
+bool TCPStreamPusher::SendFrame(Connection& c, const uint8_t* data, size_t size, TCPFrameType type, int64_t image_number) {
     TcpFrameHeader h{};
     h.type = static_cast<uint16_t>(type);
     h.payload_size = size;
@@ -317,35 +260,11 @@ bool TCPStreamPusher::SendFrame(Connection& c, const uint8_t* data, size_t size,
     h.socket_number = c.socket_number;
     h.run_number = run_number;
 
-    if (!SendAll(c, &h, sizeof(h), false)) {
-        if (z) z->release();
+    if (!SendAll(c, &h, sizeof(h)))
         return false;
-    }
 
-    bool zc_used = false;
-    uint32_t zc_first = 0;
-    uint32_t zc_last = 0;
-
-    if (size > 0) {
-        // MSG_ZEROCOPY leaves the kernel referencing the caller's buffer after send()
-        // returns, so it is only safe when a ZeroCopyReturnValue keeps that buffer alive
-        // until the completion notification. The synchronous path passes a transient
-        // buffer (z == nullptr) that the caller reuses immediately — never zero-copy it.
-        const bool allow_zerocopy = (z != nullptr)
-                                    && (type == TCPFrameType::DATA || type == TCPFrameType::CALIBRATION);
-        if (!SendAll(c, data, size, allow_zerocopy, &zc_used, &zc_first, &zc_last)) {
-            if (z) {
-                if (zc_used) EnqueueZeroCopyPending(c, z, zc_first, zc_last);
-                else z->release();
-            }
-            return false;
-        }
-    }
-
-    if (z) {
-        if (zc_used) EnqueueZeroCopyPending(c, z, zc_first, zc_last);
-        else z->release();
-    }
+    if (size > 0 && !SendAll(c, data, size))
+        return false;
 
     if (type == TCPFrameType::DATA)
         c.data_sent.fetch_add(1, std::memory_order_relaxed);
@@ -353,110 +272,6 @@ bool TCPStreamPusher::SendFrame(Connection& c, const uint8_t* data, size_t size,
     return true;
 }
 
-// Caller must hold c.zc_mutex.
-void TCPStreamPusher::ReleaseCompletedZeroCopy(Connection& c) {
-    while (!c.zc_pending.empty()) {
-        const auto& front = c.zc_pending.front();
-        if (c.zc_completed_id == std::numeric_limits<uint32_t>::max() || front.last_id > c.zc_completed_id)
-            break;
-        if (front.z)
-            front.z->release();
-        c.zc_pending.pop_front();
-    }
-}
-
-void TCPStreamPusher::EnqueueZeroCopyPending(Connection& c, ZeroCopyReturnValue* z, uint32_t first_id, uint32_t last_id) {
-    std::unique_lock ul(c.zc_mutex);
-    c.zc_pending.push_back(Connection::PendingZC{
-        .first_id = first_id,
-        .last_id = last_id,
-        .z = z
-    });
-    c.zc_cv.notify_all();
-}
-
-void TCPStreamPusher::ForceReleasePendingZeroCopy(Connection& c) {
-    std::unique_lock ul(c.zc_mutex);
-    while (!c.zc_pending.empty()) {
-        auto p = c.zc_pending.front();
-        c.zc_pending.pop_front();
-        if (p.z)
-            p.z->release();
-    }
-    c.zc_cv.notify_all();
-}
-
-bool TCPStreamPusher::WaitForZeroCopyDrain(Connection& c, std::chrono::milliseconds timeout) {
-    std::unique_lock ul(c.zc_mutex);
-    return c.zc_cv.wait_for(ul, timeout, [&] {
-        return c.zc_pending.empty() || c.broken.load();
-    });
-}
-
-void TCPStreamPusher::ZeroCopyCompletionThread(Connection* c) {
-#if defined(MSG_ZEROCOPY)
-    while (c->active || !c->zc_pending.empty()) {
-        const int local_fd = c->fd.load();
-        if (local_fd < 0)
-            break;
-
-        pollfd pfd{};
-        pfd.fd = local_fd;
-        pfd.events = 0; // We only care about POLLERR for errqueue
-
-        const int prc = poll(&pfd, 1, 100);
-        if (prc < 0) {
-            if (errno == EINTR)
-                continue;
-            break;
-        }
-        if (prc == 0)
-            continue;
-
-        // Only process the error queue; POLLERR is always reported regardless of events mask
-        uint8_t control[512];
-        uint8_t data[1];
-        iovec iov{};
-        iov.iov_base = data;
-        iov.iov_len = sizeof(data);
-
-        msghdr msg{};
-        msg.msg_iov = &iov;
-        msg.msg_iovlen = 1;
-        msg.msg_control = control;
-        msg.msg_controllen = sizeof(control);
-
-        while (true) {
-            const ssize_t rr = recvmsg(local_fd, &msg, MSG_ERRQUEUE | MSG_DONTWAIT);
-            if (rr < 0) {
-                if (errno == EAGAIN || errno == EWOULDBLOCK || errno == EINTR)
-                    break;
-                // A real error on the errqueue likely means the socket is dead
-                c->broken = true;
-                break;
-            }
-            for (cmsghdr* cm = CMSG_FIRSTHDR(&msg); cm != nullptr; cm = CMSG_NXTHDR(&msg, cm)) {
-                if (cm->cmsg_level != SOL_IP || cm->cmsg_type != IP_RECVERR)
-                    continue;
-
-                auto* se = reinterpret_cast<sock_extended_err*>(CMSG_DATA(cm));
-                if (!se || se->ee_origin != SO_EE_ORIGIN_ZEROCOPY)
-                    continue;
-
-                const uint32_t end_id = se->ee_data;
-                std::unique_lock ul(c->zc_mutex);
-                if (c->zc_completed_id == std::numeric_limits<uint32_t>::max() || end_id > c->zc_completed_id)
-                    c->zc_completed_id = end_id;
-                ReleaseCompletedZeroCopy(*c);
-                c->zc_cv.notify_all();
-            }
-        }
-    }
-#else
-    (void)c;
-#endif
-}
-
 bool TCPStreamPusher::ReadExact(Connection& c, void* buf, size_t len) {
     auto* p = static_cast<uint8_t*>(buf);
     size_t got = 0;
@@ -525,8 +340,8 @@ bool TCPStreamPusher::ReadExactPersistent(Connection& c, void* buf, size_t len)
                 continue;
             return false;
         }
-        // POLLERR can fire alongside POLLIN during zerocopy — only bail if we have
-        // POLLHUP/POLLNVAL without any readable data.
+        // Only bail if the peer hung up / the fd is invalid and there is no readable
+        // data left to drain.
         if ((pfd.revents & (POLLHUP | POLLNVAL)) != 0 && !(pfd.revents & POLLIN))
             return false;
         if ((pfd.revents & POLLIN) == 0)
@@ -560,13 +375,21 @@ void TCPStreamPusher::WriterThread(Connection* c) {
             continue;
         }
 
-        std::unique_lock ul(c->send_mutex);
-        if (!SendFrame(*c,
-                       static_cast<const uint8_t*>(e.z->GetImage()),
-                       e.z->GetImageSize(),
-                       TCPFrameType::DATA,
-                       e.z->GetImageNumber(),
-                       e.z)) {
+        bool ok;
+        {
+            std::unique_lock ul(c->send_mutex);
+            ok = SendFrame(*c,
+                           static_cast<const uint8_t*>(e.z->GetImage()),
+                           e.z->GetImageSize(),
+                           TCPFrameType::DATA,
+                           e.z->GetImageNumber());
+        }
+
+        // Synchronous send: once send() returns, the payload has been copied into the
+        // kernel socket buffer, so the image-buffer slot can be returned immediately.
+        e.z->release();
+
+        if (!ok) {
             c->broken = true;
             logger.Error("TCP send failed on socket " + std::to_string(c->socket_number));
         }
@@ -744,14 +567,6 @@ void TCPStreamPusher::SetupNewConnection(int new_fd, uint32_t socket_number) {
     if (send_buffer_size)
         setsockopt(new_fd, SOL_SOCKET, SO_SNDBUF, &send_buffer_size.value(), sizeof(int32_t));
 
-#if defined(SO_ZEROCOPY)
-    int zc_one = 1;
-    if (setsockopt(new_fd, SOL_SOCKET, SO_ZEROCOPY, &zc_one, sizeof(zc_one)) == 0)
-        c->zerocopy_enabled.store(true, std::memory_order_relaxed);
-    else
-        c->zerocopy_enabled.store(false, std::memory_order_relaxed);
-#endif
-
     c->connected = true;
     c->broken = false;
     auto now = std::chrono::steady_clock::now();
@@ -809,7 +624,7 @@ void TCPStreamPusher::KeepaliveThread() {
                 continue;
 
             std::unique_lock ul(c.send_mutex);
-            if (!SendFrame(c, nullptr, 0, TCPFrameType::KEEPALIVE, -1, nullptr)) {
+            if (!SendFrame(c, nullptr, 0, TCPFrameType::KEEPALIVE, -1)) {
                 logger.Warning("Keepalive send failed on socket " + std::to_string(c.socket_number));
                 c.broken = true;
             } else {
@@ -850,16 +665,9 @@ void TCPStreamPusher::StartDataCollectionThreads(Connection& c) {
     c.data_acked_ok.store(0, std::memory_order_relaxed);
     c.data_acked_bad.store(0, std::memory_order_relaxed);
     c.data_acked_total.store(0, std::memory_order_relaxed);
-    c.zc_next_id = 0;
-    c.zc_completed_id = std::numeric_limits<uint32_t>::max();
-    {
-        std::unique_lock ul(c.zc_mutex);
-        c.zc_pending.clear();
-    }
 
     c.active = true;
     c.writer_future = std::async(std::launch::async, &TCPStreamPusher::WriterThread, this, &c);
-    c.zc_future = std::async(std::launch::async, &TCPStreamPusher::ZeroCopyCompletionThread, this, &c);
 }
 
 void TCPStreamPusher::StopDataCollectionThreads(Connection& c) {
@@ -872,30 +680,20 @@ void TCPStreamPusher::StopDataCollectionThreads(Connection& c) {
     if (!c.queue.PutTimeout({.end = true}, std::chrono::milliseconds(200))) {
         c.broken = true;
         CloseFd(c.fd);
-        c.queue.Clear();
+        // active==false makes WriterThread exit without draining, so return any
+        // queued-but-unsent slots to the image buffer pool ourselves.
+        ImagePusherQueueElement e{};
+        while (c.queue.Get(e)) {
+            if (e.z)
+                e.z->release();
+        }
         (void)c.queue.Put({.end = true});
     }
 
     c.ack_cv.notify_all();
-    c.zc_cv.notify_all();
 
     if (c.writer_future.valid())
         c.writer_future.get();
-
-    constexpr auto zc_drain_timeout = std::chrono::seconds(2);
-    if (!WaitForZeroCopyDrain(c, zc_drain_timeout)) {
-        logger.Warning("TCP zerocopy completion drain timeout on socket " + std::to_string(c.socket_number) +
-                       "; forcing socket close");
-        c.broken = true;
-        CloseFd(c.fd);
-        c.zc_cv.notify_all();
-        c.ack_cv.notify_all();
-    }
-
-    if (c.zc_future.valid())
-        c.zc_future.get();
-
-    ForceReleasePendingZeroCopy(c);
 }
 
 bool TCPStreamPusher::WaitForAck(Connection& c, TCPFrameType ack_for, std::chrono::milliseconds timeout, std::string* error_text) {
@@ -1006,7 +804,7 @@ void TCPStreamPusher::StartDataCollection(StartMessage& message) {
                 continue;
 
             std::unique_lock ul(c.send_mutex);
-            (void)SendFrame(c, nullptr, 0, TCPFrameType::CANCEL, -1, nullptr);
+            (void)SendFrame(c, nullptr, 0, TCPFrameType::CANCEL, -1);
 
             std::string cancel_ack_err;
             (void)WaitForAck(c, TCPFrameType::CANCEL, std::chrono::milliseconds(500), &cancel_ack_err);
@@ -1033,7 +831,7 @@ void TCPStreamPusher::StartDataCollection(StartMessage& message) {
 
         {
             std::unique_lock ul(c.send_mutex);
-            if (!SendFrame(c, serialization_buffer.data(), serializer.GetBufferSize(), TCPFrameType::START, -1, nullptr)) {
+            if (!SendFrame(c, serialization_buffer.data(), serializer.GetBufferSize(), TCPFrameType::START, -1)) {
                 rollback_cancel();
                 throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
                                       "Timeout/failure sending START on socket " + std::to_string(c.socket_number));
@@ -1069,7 +867,7 @@ bool TCPStreamPusher::SendImage(const uint8_t *image_data, size_t image_size, in
         return false;
 
     std::unique_lock ul(c.send_mutex);
-    return SendFrame(c, image_data, image_size, TCPFrameType::DATA, image_number, nullptr);
+    return SendFrame(c, image_data, image_size, TCPFrameType::DATA, image_number);
 }
 
 bool TCPStreamPusher::SendImage(ZeroCopyReturnValue &z) {
@@ -1140,7 +938,7 @@ bool TCPStreamPusher::EndDataCollection(const EndMessage& message) {
 
         {
             std::unique_lock ul(c.send_mutex);
-            if (!SendFrame(c, serialization_buffer.data(), serializer.GetBufferSize(), TCPFrameType::END, -1, nullptr)) {
+            if (!SendFrame(c, serialization_buffer.data(), serializer.GetBufferSize(), TCPFrameType::END, -1)) {
                 ret = false;
                 continue;
             }
@@ -1233,8 +1031,7 @@ bool TCPStreamPusher::SendCalibration(const CompressedImage& message) {
                               serialization_buffer.data(),
                               serializer.GetBufferSize(),
                               TCPFrameType::CALIBRATION,
-                              -1,
-                              nullptr);
+                              -1);
 
     if (!ok) {
         logger.Error("Failed to send TCP calibration on socket {}", target->socket_number);
diff --git a/image_pusher/TCPStreamPusher.h b/image_pusher/TCPStreamPusher.h
index 2ae61271..78398d8a 100644
--- a/image_pusher/TCPStreamPusher.h
+++ b/image_pusher/TCPStreamPusher.h
@@ -10,7 +10,6 @@
 #include <string>
 #include <vector>
 #include <condition_variable>
-#include <deque>
 
 #include "ImagePusher.h"
 #include "ZMQWriterNotificationPuller.h"
@@ -26,9 +25,8 @@
 ///   - KeepaliveThread: sends periodic keepalive frames when idle (skipped during data collection)
 ///   - Per-connection WriterThread: drains the connection's queue, sends DATA frames
 ///   - Per-connection PersistentAckThread: reads ACKs and keepalive pongs from the peer
-///   - Per-connection ZeroCopyCompletionThread: processes kernel MSG_ZEROCOPY completions
 ///
-/// Lock ordering: connections_mutex → send_mutex → ack_mutex → zc_mutex
+/// Lock ordering: connections_mutex → send_mutex → ack_mutex
 /// IMPORTANT: Never call blocking queue operations while holding connections_mutex.
 ///
 /// Concurrency contract:
@@ -48,11 +46,9 @@ class TCPStreamPusher : public ImagePusher {
         std::atomic<bool> active{false};       // data-collection threads running
         std::atomic<bool> broken{false};
         std::atomic<bool> connected{false};     // persistent connection is alive
-        std::atomic<bool> zerocopy_enabled{false};
 
         ThreadSafeFIFO<ImagePusherQueueElement> queue;
         std::future<void> writer_future;
-        std::future<void> zc_future;
 
         // Persistent ack/keepalive reader (runs as long as the connection is alive)
         std::future<void> persistent_ack_future;
@@ -61,18 +57,6 @@ class TCPStreamPusher : public ImagePusher {
         std::mutex ack_mutex;
         std::condition_variable ack_cv;
 
-        struct PendingZC {
-            uint32_t first_id = 0;
-            uint32_t last_id = 0;
-            ZeroCopyReturnValue* z = nullptr;
-        };
-
-        std::mutex zc_mutex;
-        std::condition_variable zc_cv;
-        std::deque<PendingZC> zc_pending;
-        uint32_t zc_next_id = 0;
-        uint32_t zc_completed_id = std::numeric_limits<uint32_t>::max();
-
         bool start_ack_received = false;
         bool start_ack_ok = false;
         bool end_ack_received = false;
@@ -145,15 +129,13 @@ class TCPStreamPusher : public ImagePusher {
 
     static void CloseFd(std::atomic<int>& fd);
     bool IsConnectionAlive(const Connection& c) const;
-    bool SendAll(Connection& c, const void* buf, size_t len, bool allow_zerocopy,
-                 bool* zc_used = nullptr, uint32_t* zc_first = nullptr, uint32_t* zc_last = nullptr);
+    bool SendAll(Connection& c, const void* buf, size_t len);
     bool ReadExact(Connection& c, void* buf, size_t len);
     bool ReadExactPersistent(Connection& c, void* buf, size_t len);
-    bool SendFrame(Connection& c, const uint8_t* data, size_t size, TCPFrameType type, int64_t image_number, ZeroCopyReturnValue* z);
+    bool SendFrame(Connection& c, const uint8_t* data, size_t size, TCPFrameType type, int64_t image_number);
 
     void WriterThread(Connection* c);
     void PersistentAckThread(Connection* c);
-    void ZeroCopyCompletionThread(Connection* c);
     void AcceptorThread();
     void KeepaliveThread();
 
@@ -164,11 +146,6 @@ class TCPStreamPusher : public ImagePusher {
     void StartDataCollectionThreads(Connection& c);
     void StopDataCollectionThreads(Connection& c);
 
-    void EnqueueZeroCopyPending(Connection& c, ZeroCopyReturnValue* z, uint32_t first_id, uint32_t last_id);
-    void ReleaseCompletedZeroCopy(Connection& c);
-    void ForceReleasePendingZeroCopy(Connection& c);
-    bool WaitForZeroCopyDrain(Connection& c, std::chrono::milliseconds timeout);
-
     bool WaitForAck(Connection& c, TCPFrameType ack_for, std::chrono::milliseconds timeout, std::string* error_text);
     bool WaitForEndAck(Connection& c, std::chrono::milliseconds liveness_timeout, std::string* error_text);
 public:
-- 
2.52.0


From 2a9fd084ab93ba5b99142dd1aa3aceccb5f6fa0b Mon Sep 17 00:00:00 2001
From: Filip Leonarski <filip.leonarski@psi.ch>
Date: Thu, 25 Jun 2026 13:36:57 +0200
Subject: [PATCH 2/7] TCPStreamPusher: post-zerocopy cleanup + fix queue-path
 backpressure drop

Follow-up simplifications after removing the zerocopy machinery, plus a real
backpressure bug the cleanup surfaced:

- SendImage(ZeroCopyReturnValue&) imposed a hard 2s deadline on enqueueing and
  then marked the connection broken. At high frame rate the 128-deep queue
  fills in tens of ms, so any filesystem stall longer than ~2s dropped the run
  even though the writer was alive and heartbeating -- defeating the whole
  BUSY-heartbeat backpressure design. Block instead while the peer is alive
  (!broken && active); the real liveness decision already lives in SendAll's
  peer-liveness timeout, which the writer's BUSY heartbeats keep fresh. This
  makes the queue path consistent with the send path: both wait out arbitrarily
  long stalls and only give up when the peer goes genuinely silent.
- Drop the dead per-connection data_sent counter (written, never read) and the
  redundant ImagePusherQueueElement.image_data set on the TCP path (only the
  HDF5 pusher reads that field).
- Add SetPeerLivenessTimeout() so the liveness window is tunable (and testable).

Add TCPImageCommTest_StalledWriter_SurvivesViaHeartbeat: a controllable raw
writer double connects, ACKs START, then stops draining for 4s while still
sending BUSY heartbeats (peer-liveness window set to 2s). The run must ride out
the stall on the zero-copy queue path and deliver all 1000 images. Verified to
fail (115/1000 delivered, connection dropped) against the old 2s-deadline
behavior.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---
 image_pusher/TCPStreamPusher.cpp |  10 +-
 image_pusher/TCPStreamPusher.h   |   7 +-
 tests/TCPImagePusherTest.cpp     | 232 +++++++++++++++++++++++++++++++
 3 files changed, 241 insertions(+), 8 deletions(-)

diff --git a/image_pusher/TCPStreamPusher.cpp b/image_pusher/TCPStreamPusher.cpp
index 75844476..d8291661 100644
--- a/image_pusher/TCPStreamPusher.cpp
+++ b/image_pusher/TCPStreamPusher.cpp
@@ -266,9 +266,6 @@ bool TCPStreamPusher::SendFrame(Connection& c, const uint8_t* data, size_t size,
     if (size > 0 && !SendAll(c, data, size))
         return false;
 
-    if (type == TCPFrameType::DATA)
-        c.data_sent.fetch_add(1, std::memory_order_relaxed);
-
     return true;
 }
 
@@ -661,7 +658,6 @@ void TCPStreamPusher::StartDataCollectionThreads(Connection& c) {
         c.data_ack_error_text.clear();
     }
 
-    c.data_sent.store(0, std::memory_order_relaxed);
     c.data_acked_ok.store(0, std::memory_order_relaxed);
     c.data_acked_bad.store(0, std::memory_order_relaxed);
     c.data_acked_total.store(0, std::memory_order_relaxed);
@@ -887,7 +883,7 @@ bool TCPStreamPusher::SendImage(ZeroCopyReturnValue &z) {
         target = use[idx];
     }
 
-    if (!target || target->broken || !target->active) {
+    if (!target) {
         z.release();
         return false;
     }
@@ -896,10 +892,10 @@ bool TCPStreamPusher::SendImage(ZeroCopyReturnValue &z) {
     // freshly-created file at startup). Keep waiting as long as it proves it is alive —
     // BUSY heartbeats / ACKs refresh last_peer_activity_ns from a thread independent of
     // its stalled write path — so a slow-but-healthy writer is held back, not dropped.
-    // Only a peer that has gone completely silent for the liveness window is declared dead.
+    // Only a peer that has gone completely silent for the liveness window is declared dead;
+    // a writer that heartbeats but never drains is caught by SendAll's max_backpressure cap.
     while (!target->broken && target->active) {
         if (target->queue.PutTimeout(ImagePusherQueueElement{
-                .image_data = static_cast<uint8_t *>(z.GetImage()),
                 .z = &z,
                 .end = false
             }, std::chrono::milliseconds(50)))
diff --git a/image_pusher/TCPStreamPusher.h b/image_pusher/TCPStreamPusher.h
index 78398d8a..7ef05382 100644
--- a/image_pusher/TCPStreamPusher.h
+++ b/image_pusher/TCPStreamPusher.h
@@ -71,7 +71,6 @@ class TCPStreamPusher : public ImagePusher {
         std::atomic<bool> data_ack_error_reported{false};
         std::string data_ack_error_text;
 
-        std::atomic<uint64_t> data_sent{0};
         std::atomic<uint64_t> data_acked_ok{0};
         std::atomic<uint64_t> data_acked_bad{0};
         std::atomic<uint64_t> data_acked_total{0};
@@ -155,6 +154,12 @@ public:
 
     ~TCPStreamPusher() override;
 
+    /// Max time a send may block on backpressure with no sign of life from the peer
+    /// before the connection is declared dead. A busy-but-alive writer keeps it fresh
+    /// via BUSY heartbeats, so this only catches a genuinely silent peer. Must be set
+    /// before data collection starts.
+    void SetPeerLivenessTimeout(std::chrono::milliseconds t) { peer_liveness_timeout = t; }
+
     std::vector<std::string> GetAddress() const override { return {endpoint}; }
 
     /// Returns the number of currently connected writers (can be called at any time)
diff --git a/tests/TCPImagePusherTest.cpp b/tests/TCPImagePusherTest.cpp
index 7b558518..20cf1440 100644
--- a/tests/TCPImagePusherTest.cpp
+++ b/tests/TCPImagePusherTest.cpp
@@ -3,11 +3,25 @@
 
 #include <random>
 #include <future>
+#include <thread>
+#include <atomic>
+#include <mutex>
+#include <condition_variable>
+#include <chrono>
+#include <vector>
+#include <utility>
+#include <cstring>
+#include <sys/socket.h>
+#include <netinet/in.h>
+#include <arpa/inet.h>
+#include <unistd.h>
 #include <catch2/catch_all.hpp>
 
 #include "../image_pusher/TCPStreamPusher.h"
 #include "../image_puller/TCPImagePuller.h"
 #include "../image_puller/ZMQImagePuller.h"
+#include "../common/ImageBuffer.h"
+#include "../common/ZeroCopyReturnValue.h"
 
 TEST_CASE("TCPImageCommTest_2Writers_WithAck", "[TCP]") {
     const size_t nframes = 128;
@@ -698,3 +712,221 @@ TEST_CASE("TCPImageCommTest_RepubToZMQ", "[TCP][ZeroMQ]") {
     REQUIRE(zmq_nimages == nframes);
     REQUIRE(zmq_errors == 0);
 }
+
+namespace {
+
+// Controllable TCP "writer" peer for backpressure tests. Connects to the pusher, ACKs
+// START, then *stalls* (stops draining the socket) until Release() is called, while a
+// background thread keeps sending BUSY heartbeats — i.e. a writer that is alive but
+// wedged (e.g. on a slow filesystem at high frame rate). Catch2 assertion macros are not
+// thread-safe, so the worker threads only touch atomics; the test thread asserts.
+class StallableWriterDouble {
+public:
+    StallableWriterDouble(const std::string &tcp_addr, int rcvbuf_bytes) {
+        auto [host, port] = ParseHostPort(tcp_addr);
+        fd_ = ::socket(AF_INET, SOCK_STREAM, 0);
+        if (fd_ < 0)
+            return;
+        setsockopt(fd_, SOL_SOCKET, SO_RCVBUF, &rcvbuf_bytes, sizeof(rcvbuf_bytes));
+        sockaddr_in sin{};
+        sin.sin_family = AF_INET;
+        sin.sin_port = htons(port);
+        inet_pton(AF_INET, host.c_str(), &sin.sin_addr);
+        if (::connect(fd_, reinterpret_cast<sockaddr *>(&sin), sizeof(sin)) != 0) {
+            ::close(fd_);
+            fd_ = -1;
+            return;
+        }
+        busy_thread_ = std::thread([this] { BusyLoop(); });
+        reader_thread_ = std::thread([this] { ReaderLoop(); });
+    }
+
+    ~StallableWriterDouble() {
+        stop_ = true;
+        Release();
+        if (fd_ >= 0)
+            ::shutdown(fd_, SHUT_RDWR);
+        if (reader_thread_.joinable())
+            reader_thread_.join();
+        if (busy_thread_.joinable())
+            busy_thread_.join();
+        if (fd_ >= 0)
+            ::close(fd_);
+    }
+
+    [[nodiscard]] bool Connected() const { return fd_ >= 0; }
+
+    // Stop stalling: let the reader drain DATA and ACK END.
+    void Release() {
+        {
+            std::lock_guard<std::mutex> lg(mtx_);
+            released_ = true;
+        }
+        cv_.notify_all();
+    }
+
+    [[nodiscard]] size_t DataFramesReceived() const { return data_frames_.load(); }
+    [[nodiscard]] bool EndAcked() const { return end_acked_.load(); }
+
+private:
+    static std::pair<std::string, uint16_t> ParseHostPort(const std::string &addr) {
+        const std::string prefix = "tcp://";
+        const auto hp = addr.substr(prefix.size());
+        const auto p = hp.find_last_of(':');
+        return {hp.substr(0, p), static_cast<uint16_t>(std::stoi(hp.substr(p + 1)))};
+    }
+
+    bool SendHeader(TCPFrameType type, TCPFrameType ack_for, uint64_t run, uint32_t sock, uint32_t flags) {
+        TcpFrameHeader h{};
+        h.type = static_cast<uint16_t>(type);
+        h.ack_for = static_cast<uint16_t>(ack_for);
+        h.run_number = run;
+        h.socket_number = sock;
+        h.flags = flags;
+        h.payload_size = 0;
+        std::lock_guard<std::mutex> lg(send_mtx_);
+        if (fd_ < 0)
+            return false;
+        return ::send(fd_, &h, sizeof(h), MSG_NOSIGNAL) == static_cast<ssize_t>(sizeof(h));
+    }
+
+    bool ReadExact(void *buf, size_t len) {
+        auto *p = static_cast<uint8_t *>(buf);
+        size_t got = 0;
+        while (got < len) {
+            const ssize_t rc = ::recv(fd_, p + got, len - got, 0);
+            if (rc <= 0)
+                return false;
+            got += static_cast<size_t>(rc);
+        }
+        return true;
+    }
+
+    void BusyLoop() {
+        // Heartbeat keeps the pusher's peer-liveness fresh even while we are not draining.
+        while (!stop_) {
+            SendHeader(TCPFrameType::BUSY, TCPFrameType::DATA, run_.load(), sock_.load(), 0);
+            for (int i = 0; i < 5 && !stop_; i++)
+                std::this_thread::sleep_for(std::chrono::milliseconds(50));
+        }
+    }
+
+    void ReaderLoop() {
+        std::vector<uint8_t> discard;
+        while (!stop_) {
+            TcpFrameHeader h{};
+            if (!ReadExact(&h, sizeof(h)))
+                return;
+            if (h.magic != JFJOCH_TCP_MAGIC || h.version != JFJOCH_TCP_VERSION)
+                return;
+            if (h.payload_size > 0) {
+                discard.resize(h.payload_size);
+                if (!ReadExact(discard.data(), discard.size()))
+                    return;
+            }
+            switch (static_cast<TCPFrameType>(h.type)) {
+                case TCPFrameType::START:
+                    run_.store(h.run_number);
+                    sock_.store(h.socket_number);
+                    SendHeader(TCPFrameType::ACK, TCPFrameType::START, h.run_number, h.socket_number, TCP_ACK_FLAG_OK);
+                    {   // Stall: stop reading until released.
+                        std::unique_lock<std::mutex> ul(mtx_);
+                        cv_.wait(ul, [this] { return released_ || stop_; });
+                    }
+                    break;
+                case TCPFrameType::DATA:
+                    data_frames_.fetch_add(1);
+                    break;
+                case TCPFrameType::END:
+                    SendHeader(TCPFrameType::ACK, TCPFrameType::END, h.run_number, h.socket_number, TCP_ACK_FLAG_OK);
+                    end_acked_.store(true);
+                    return;
+                default:
+                    break;  // ignore KEEPALIVE etc.
+            }
+        }
+    }
+
+    int fd_ = -1;
+    std::thread reader_thread_;
+    std::thread busy_thread_;
+    std::atomic<bool> stop_{false};
+    std::atomic<uint64_t> run_{0};
+    std::atomic<uint32_t> sock_{0};
+    std::atomic<size_t> data_frames_{0};
+    std::atomic<bool> end_acked_{false};
+    std::mutex send_mtx_;
+    std::mutex mtx_;
+    std::condition_variable cv_;
+    bool released_ = false;
+};
+
+}  // namespace
+
+TEST_CASE("TCPImageCommTest_StalledWriter_SurvivesViaHeartbeat", "[TCP]") {
+    // A writer that is alive (still heartbeating) but has stopped draining — e.g. wedged
+    // on a slow filesystem at high frame rate — must NOT be dropped mid-run. The pusher
+    // rides out the backpressure on the production zero-copy queue path until the writer
+    // recovers. Regression for the queue-path send giving up on a fixed deadline, and for
+    // the BUSY heartbeat keeping the connection alive past the peer-liveness window.
+    constexpr int64_t N = 1000;                              // > queue depth + socket buffers
+    constexpr auto liveness = std::chrono::milliseconds(2000);
+    constexpr auto stall = std::chrono::milliseconds(4000);  // > liveness AND > old send deadline
+
+    // Small SO_SNDBUF/SO_RCVBUF so backpressure reaches the queue after few images.
+    TCPStreamPusher pusher("tcp://127.0.0.1:*", 1, 16 * 1024);
+    pusher.SetPeerLivenessTimeout(liveness);
+
+    StallableWriterDouble writer(pusher.GetAddress()[0], 16 * 1024);
+    REQUIRE(writer.Connected());
+
+    for (int attempt = 0; attempt < 200 && pusher.GetConnectedWriters() < 1; ++attempt)
+        std::this_thread::sleep_for(std::chrono::milliseconds(25));
+    REQUIRE(pusher.GetConnectedWriters() == 1);
+
+    ImageBuffer image_buffer(16 * 1024 * 1024);
+    image_buffer.StartMeasurement(static_cast<size_t>(4096));
+
+    StartMessage start{.images_per_file = 1000, .write_master_file = true};
+    pusher.StartDataCollection(start);   // writer ACKs START, then stalls (stops reading)
+
+    auto sender = std::async(std::launch::async, [&] {
+        for (int64_t i = 0; i < N; i++) {
+            ZeroCopyReturnValue *slot = nullptr;
+            while ((slot = image_buffer.GetImageSlot()) == nullptr)
+                std::this_thread::sleep_for(std::chrono::milliseconds(1));
+            std::memset(slot->GetImage(), 0, 256);
+            slot->SetImageNumber(i);
+            slot->SetImageSize(256);   // arbitrary payload; the writer double discards it
+            slot->ReadyToSend();
+            pusher.SendImage(*slot);
+        }
+    });
+
+    // During the stall the queue is full; SendImage must block, not drop the connection.
+    std::this_thread::sleep_for(stall);
+    CHECK(pusher.GetConnectedWriters() == 1);
+    CHECK(sender.wait_for(std::chrono::milliseconds(0)) != std::future_status::ready);
+
+    // Writer recovers and starts draining.
+    writer.Release();
+
+    REQUIRE(sender.wait_for(std::chrono::seconds(30)) == std::future_status::ready);
+    sender.get();
+
+    // Every image makes it across once the stall clears.
+    for (int attempt = 0; attempt < 1200 && writer.DataFramesReceived() < static_cast<size_t>(N); ++attempt)
+        std::this_thread::sleep_for(std::chrono::milliseconds(25));
+    CHECK(writer.DataFramesReceived() == static_cast<size_t>(N));
+
+    // Queue fully drained: END now hands over cleanly without racing data frames.
+    EndMessage end{};
+    CHECK(pusher.EndDataCollection(end) == true);
+
+    for (int attempt = 0; attempt < 200 && !writer.EndAcked(); ++attempt)
+        std::this_thread::sleep_for(std::chrono::milliseconds(25));
+    CHECK(writer.EndAcked());
+    CHECK(pusher.GetConnectedWriters() == 1);
+
+    image_buffer.Finalize(std::chrono::seconds(5));
+}
-- 
2.52.0


From 3cd96b8607a38c6f9928f39f81a96197f50858ca Mon Sep 17 00:00:00 2001
From: Filip Leonarski <filip.leonarski@psi.ch>
Date: Thu, 25 Jun 2026 13:52:37 +0200
Subject: [PATCH 3/7] TCPStreamPusher: hard backpressure cap so a wedged writer
 can't hang the run

The peer-liveness timeout only catches a *silent* writer. A misbehaving writer
that keeps sending BUSY heartbeats while never draining (e.g. a permanently
wedged filesystem) would otherwise block SendAll -- and, through it, the queued
SendImage path and the end-of-run frame_transformation_futures.get() -- forever.

Add a progress-based cap in SendAll: if no bytes leave the socket for
max_backpressure_timeout (default 60s, tunable via SetMaxBackpressureTimeout)
the connection is declared dead regardless of heartbeats. It is one global cap,
enforced everywhere SendAll runs, so it bounds both mid-run stalls and
finalization. Generous relative to the 15s liveness window, since a heartbeating
peer is given more grace than a silent one -- but finite.

Add TCPImageCommTest_WedgedWriter_DroppedByBackpressureCap: a writer that ACKs
START then stalls forever while heartbeating (cap 1.5s, liveness 5s) must have
its connection dropped, and neither the producers nor EndDataCollection may
hang. Verified to hang (timeout) with the cap disabled.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---
 image_pusher/TCPStreamPusher.cpp | 21 ++++++++++--
 image_pusher/TCPStreamPusher.h   | 12 +++++++
 tests/TCPImagePusherTest.cpp     | 59 ++++++++++++++++++++++++++++++++
 3 files changed, 90 insertions(+), 2 deletions(-)

diff --git a/image_pusher/TCPStreamPusher.cpp b/image_pusher/TCPStreamPusher.cpp
index d8291661..f4c9b5ac 100644
--- a/image_pusher/TCPStreamPusher.cpp
+++ b/image_pusher/TCPStreamPusher.cpp
@@ -197,16 +197,19 @@ bool TCPStreamPusher::IsConnectionAlive(const Connection& c) const {
 bool TCPStreamPusher::SendAll(Connection& c, const void* buf, size_t len) {
     const auto* p = static_cast<const uint8_t*>(buf);
     size_t sent = 0;
+    int64_t last_progress_ns = SteadyNowNs();
 
     while (sent < len) {
         const int local_fd = c.fd.load();
         if (local_fd < 0 || c.broken)
             return false;
 
+        const int64_t now_ns = SteadyNowNs();
+
         // Treat backpressure as fatal only if the peer shows NO sign of life. A busy
         // writer keeps refreshing last_peer_activity_ns via BUSY heartbeats / ACKs, so
-        // we wait through arbitrarily long stalls; only a silent peer trips the timeout.
-        const int64_t silent_ns = SteadyNowNs() - c.last_peer_activity_ns.load(std::memory_order_relaxed);
+        // we wait through long stalls; only a silent peer trips this timeout.
+        const int64_t silent_ns = now_ns - c.last_peer_activity_ns.load(std::memory_order_relaxed);
         if (silent_ns > std::chrono::duration_cast<std::chrono::nanoseconds>(peer_liveness_timeout).count()) {
             logger.Warning("No liveness from writer on socket " + std::to_string(c.socket_number) +
                            " for " + std::to_string(silent_ns / 1000000) + " ms while sending; marking broken");
@@ -215,6 +218,19 @@ bool TCPStreamPusher::SendAll(Connection& c, const void* buf, size_t len) {
             return false;
         }
 
+        // Hard backpressure cap: a writer may keep heartbeating yet never drain (e.g. a
+        // permanently wedged filesystem). If no bytes leave the socket for this long, give
+        // up regardless of heartbeats so the run -- and its finalization -- cannot hang.
+        if (now_ns - last_progress_ns >
+            std::chrono::duration_cast<std::chrono::nanoseconds>(max_backpressure_timeout).count()) {
+            logger.Warning("No send progress to writer on socket " + std::to_string(c.socket_number) +
+                           " for " + std::to_string((now_ns - last_progress_ns) / 1000000) +
+                           " ms despite heartbeats; marking broken");
+            c.broken = true;
+            CloseFd(c.fd);
+            return false;
+        }
+
         pollfd pfd{};
         pfd.fd = local_fd;
         pfd.events = POLLOUT;
@@ -247,6 +263,7 @@ bool TCPStreamPusher::SendAll(Connection& c, const void* buf, size_t len) {
         }
 
         sent += static_cast<size_t>(rc);
+        last_progress_ns = SteadyNowNs();
     }
 
     return true;
diff --git a/image_pusher/TCPStreamPusher.h b/image_pusher/TCPStreamPusher.h
index 7ef05382..c2ec0edf 100644
--- a/image_pusher/TCPStreamPusher.h
+++ b/image_pusher/TCPStreamPusher.h
@@ -109,6 +109,12 @@ class TCPStreamPusher : public ImagePusher {
     // every ~250 ms via BUSY heartbeats (and via DATA ACKs), so genuine backpressure of any
     // duration is tolerated; only a truly silent (frozen/dead) peer trips this.
     std::chrono::milliseconds peer_liveness_timeout{15000};
+    // Hard upper bound on backpressure: if the socket accepts no bytes for this long the
+    // writer is wedged and is declared dead even if it keeps heartbeating, so a
+    // misbehaving writer cannot block the run (or its finalization) forever. Generous
+    // relative to peer_liveness_timeout, since a heartbeating peer is given more grace
+    // than a silent one — but still finite.
+    std::chrono::milliseconds max_backpressure_timeout{60000};
 
     int64_t images_per_file = 1;
     uint64_t run_number = 0;
@@ -160,6 +166,12 @@ public:
     /// before data collection starts.
     void SetPeerLivenessTimeout(std::chrono::milliseconds t) { peer_liveness_timeout = t; }
 
+    /// Hard upper bound on backpressure. Even while the peer keeps heartbeating, if no
+    /// bytes can be sent for this long the writer is declared dead so a wedged writer
+    /// cannot block the run or its finalization forever. Must be set before data
+    /// collection starts.
+    void SetMaxBackpressureTimeout(std::chrono::milliseconds t) { max_backpressure_timeout = t; }
+
     std::vector<std::string> GetAddress() const override { return {endpoint}; }
 
     /// Returns the number of currently connected writers (can be called at any time)
diff --git a/tests/TCPImagePusherTest.cpp b/tests/TCPImagePusherTest.cpp
index 20cf1440..9b04c63d 100644
--- a/tests/TCPImagePusherTest.cpp
+++ b/tests/TCPImagePusherTest.cpp
@@ -930,3 +930,62 @@ TEST_CASE("TCPImageCommTest_StalledWriter_SurvivesViaHeartbeat", "[TCP]") {
 
     image_buffer.Finalize(std::chrono::seconds(5));
 }
+
+TEST_CASE("TCPImageCommTest_WedgedWriter_DroppedByBackpressureCap", "[TCP]") {
+    // A writer that keeps heartbeating but never drains (e.g. a permanently wedged
+    // filesystem) must not block the run or its finalization forever. The hard
+    // backpressure cap tears the connection down even though BUSY keeps arriving, and
+    // well before the (longer) peer-liveness timeout that those heartbeats keep at bay.
+    constexpr int64_t N = 1000;
+    constexpr auto liveness = std::chrono::milliseconds(5000);       // kept fresh by heartbeats
+    constexpr auto max_backpressure = std::chrono::milliseconds(1500);
+
+    TCPStreamPusher pusher("tcp://127.0.0.1:*", 1, 16 * 1024);
+    pusher.SetPeerLivenessTimeout(liveness);
+    pusher.SetMaxBackpressureTimeout(max_backpressure);
+
+    StallableWriterDouble writer(pusher.GetAddress()[0], 16 * 1024);   // never released
+    REQUIRE(writer.Connected());
+
+    for (int attempt = 0; attempt < 200 && pusher.GetConnectedWriters() < 1; ++attempt)
+        std::this_thread::sleep_for(std::chrono::milliseconds(25));
+    REQUIRE(pusher.GetConnectedWriters() == 1);
+
+    ImageBuffer image_buffer(16 * 1024 * 1024);
+    image_buffer.StartMeasurement(static_cast<size_t>(4096));
+
+    StartMessage start{.images_per_file = 1000, .write_master_file = true};
+    pusher.StartDataCollection(start);   // writer ACKs START, then stalls forever
+
+    auto sender = std::async(std::launch::async, [&] {
+        for (int64_t i = 0; i < N; i++) {
+            ZeroCopyReturnValue *slot = nullptr;
+            while ((slot = image_buffer.GetImageSlot()) == nullptr)
+                std::this_thread::sleep_for(std::chrono::milliseconds(1));
+            std::memset(slot->GetImage(), 0, 256);
+            slot->SetImageNumber(i);
+            slot->SetImageSize(256);
+            slot->ReadyToSend();
+            pusher.SendImage(*slot);
+        }
+    });
+
+    // The cap must fire and drop the connection despite continuous heartbeats.
+    bool dropped = false;
+    for (int attempt = 0; attempt < 400 && !dropped; ++attempt) {
+        if (pusher.GetConnectedWriters() == 0)
+            dropped = true;
+        else
+            std::this_thread::sleep_for(std::chrono::milliseconds(25));
+    }
+    CHECK(dropped);
+
+    // Neither the producers nor finalization may hang once the writer is wedged.
+    REQUIRE(sender.wait_for(std::chrono::seconds(10)) == std::future_status::ready);
+    sender.get();
+
+    EndMessage end{};
+    CHECK(pusher.EndDataCollection(end) == false);   // bounded, and reports failure
+
+    image_buffer.Finalize(std::chrono::seconds(5));
+}
-- 
2.52.0


From a02fd19af40fdd6ef5b7456c09ac48a4556636c1 Mon Sep 17 00:00:00 2001
From: Filip Leonarski <filip.leonarski@psi.ch>
Date: Thu, 25 Jun 2026 14:17:27 +0200
Subject: [PATCH 4/7] broker: optional TCP liveness/backpressure timeouts in
 config

Expose the two new TCPStreamPusher knobs through the broker config so they can be
tuned per deployment, like send_buffer_size already is:

- peer_liveness_timeout_ms  -> SetPeerLivenessTimeout()
- max_backpressure_timeout_ms -> SetMaxBackpressureTimeout()

Both are optional fields on tcp_settings; when unset the parser leaves the
pusher's built-in defaults (15s / 60s) in place, so existing config files keep
working unchanged. The parser also ignores non-positive values.

The generated broker/gen/model/Tcp_settings.{h,cpp} are hand-patched to mirror
exactly what openapi-generator emits for these fields (verified against the
send_buffer_size pattern and by a from_json/to_json round-trip), so re-running
update_version.sh reproduces them with no diff.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---
 broker/JFJochBrokerParser.cpp     |  6 +++
 broker/gen/model/Tcp_settings.cpp | 70 ++++++++++++++++++++++++++++---
 broker/gen/model/Tcp_settings.h   | 20 ++++++++-
 broker/jfjoch_api.yaml            | 15 +++++++
 4 files changed, 104 insertions(+), 7 deletions(-)

diff --git a/broker/JFJochBrokerParser.cpp b/broker/JFJochBrokerParser.cpp
index 54f4ada9..af2061f4 100644
--- a/broker/JFJochBrokerParser.cpp
+++ b/broker/JFJochBrokerParser.cpp
@@ -206,6 +206,12 @@ std::unique_ptr<ImagePusher> ParseTCPImagePusher(const org::openapitools::server
 
     auto tmp = std::make_unique<TCPStreamPusher>(j.getTcp().getImageSocket(), j.getTcp().getNwriters(), send_buffer_size);
 
+    // Optional liveness/backpressure tuning; unset -> keep the pusher's built-in defaults.
+    if (j.getTcp().peerLivenessTimeoutMsIsSet() && j.getTcp().getPeerLivenessTimeoutMs() > 0)
+        tmp->SetPeerLivenessTimeout(std::chrono::milliseconds(j.getTcp().getPeerLivenessTimeoutMs()));
+    if (j.getTcp().maxBackpressureTimeoutMsIsSet() && j.getTcp().getMaxBackpressureTimeoutMs() > 0)
+        tmp->SetMaxBackpressureTimeout(std::chrono::milliseconds(j.getTcp().getMaxBackpressureTimeoutMs()));
+
     return std::move(tmp);
 }
 
diff --git a/broker/gen/model/Tcp_settings.cpp b/broker/gen/model/Tcp_settings.cpp
index 883ab4b7..ef632894 100644
--- a/broker/gen/model/Tcp_settings.cpp
+++ b/broker/gen/model/Tcp_settings.cpp
@@ -27,7 +27,11 @@ Tcp_settings::Tcp_settings()
     m_Image_socketIsSet = false;
     m_Nwriters = 32L;
     m_NwritersIsSet = false;
-    
+    m_Peer_liveness_timeout_ms = 0L;
+    m_Peer_liveness_timeout_msIsSet = false;
+    m_Max_backpressure_timeout_ms = 0L;
+    m_Max_backpressure_timeout_msIsSet = false;
+
 }
 
 void Tcp_settings::validate() const
@@ -84,8 +88,14 @@ bool Tcp_settings::operator==(const Tcp_settings& rhs) const
     ((!imageSocketIsSet() && !rhs.imageSocketIsSet()) || (imageSocketIsSet() && rhs.imageSocketIsSet() && getImageSocket() == rhs.getImageSocket())) &&
     
     
-    ((!nwritersIsSet() && !rhs.nwritersIsSet()) || (nwritersIsSet() && rhs.nwritersIsSet() && getNwriters() == rhs.getNwriters()))
-    
+    ((!nwritersIsSet() && !rhs.nwritersIsSet()) || (nwritersIsSet() && rhs.nwritersIsSet() && getNwriters() == rhs.getNwriters())) &&
+
+
+    ((!peerLivenessTimeoutMsIsSet() && !rhs.peerLivenessTimeoutMsIsSet()) || (peerLivenessTimeoutMsIsSet() && rhs.peerLivenessTimeoutMsIsSet() && getPeerLivenessTimeoutMs() == rhs.getPeerLivenessTimeoutMs())) &&
+
+
+    ((!maxBackpressureTimeoutMsIsSet() && !rhs.maxBackpressureTimeoutMsIsSet()) || (maxBackpressureTimeoutMsIsSet() && rhs.maxBackpressureTimeoutMsIsSet() && getMaxBackpressureTimeoutMs() == rhs.getMaxBackpressureTimeoutMs()))
+
     ;
 }
 
@@ -103,7 +113,11 @@ void to_json(nlohmann::json& j, const Tcp_settings& o)
         j["image_socket"] = o.m_Image_socket;
     if(o.nwritersIsSet())
         j["nwriters"] = o.m_Nwriters;
-    
+    if(o.peerLivenessTimeoutMsIsSet())
+        j["peer_liveness_timeout_ms"] = o.m_Peer_liveness_timeout_ms;
+    if(o.maxBackpressureTimeoutMsIsSet())
+        j["max_backpressure_timeout_ms"] = o.m_Max_backpressure_timeout_ms;
+
 }
 
 void from_json(const nlohmann::json& j, Tcp_settings& o)
@@ -122,8 +136,18 @@ void from_json(const nlohmann::json& j, Tcp_settings& o)
     {
         j.at("nwriters").get_to(o.m_Nwriters);
         o.m_NwritersIsSet = true;
-    } 
-    
+    }
+    if(j.find("peer_liveness_timeout_ms") != j.end())
+    {
+        j.at("peer_liveness_timeout_ms").get_to(o.m_Peer_liveness_timeout_ms);
+        o.m_Peer_liveness_timeout_msIsSet = true;
+    }
+    if(j.find("max_backpressure_timeout_ms") != j.end())
+    {
+        j.at("max_backpressure_timeout_ms").get_to(o.m_Max_backpressure_timeout_ms);
+        o.m_Max_backpressure_timeout_msIsSet = true;
+    }
+
 }
 
 int64_t Tcp_settings::getSendBufferSize() const
@@ -177,6 +201,40 @@ void Tcp_settings::unsetNwriters()
 {
     m_NwritersIsSet = false;
 }
+int64_t Tcp_settings::getPeerLivenessTimeoutMs() const
+{
+    return m_Peer_liveness_timeout_ms;
+}
+void Tcp_settings::setPeerLivenessTimeoutMs(int64_t const value)
+{
+    m_Peer_liveness_timeout_ms = value;
+    m_Peer_liveness_timeout_msIsSet = true;
+}
+bool Tcp_settings::peerLivenessTimeoutMsIsSet() const
+{
+    return m_Peer_liveness_timeout_msIsSet;
+}
+void Tcp_settings::unsetPeer_liveness_timeout_ms()
+{
+    m_Peer_liveness_timeout_msIsSet = false;
+}
+int64_t Tcp_settings::getMaxBackpressureTimeoutMs() const
+{
+    return m_Max_backpressure_timeout_ms;
+}
+void Tcp_settings::setMaxBackpressureTimeoutMs(int64_t const value)
+{
+    m_Max_backpressure_timeout_ms = value;
+    m_Max_backpressure_timeout_msIsSet = true;
+}
+bool Tcp_settings::maxBackpressureTimeoutMsIsSet() const
+{
+    return m_Max_backpressure_timeout_msIsSet;
+}
+void Tcp_settings::unsetMax_backpressure_timeout_ms()
+{
+    m_Max_backpressure_timeout_msIsSet = false;
+}
 
 
 } // namespace org::openapitools::server::model
diff --git a/broker/gen/model/Tcp_settings.h b/broker/gen/model/Tcp_settings.h
index 2c933bdd..61144d44 100644
--- a/broker/gen/model/Tcp_settings.h
+++ b/broker/gen/model/Tcp_settings.h
@@ -79,6 +79,20 @@ public:
     void setNwriters(int64_t const value);
     bool nwritersIsSet() const;
     void unsetNwriters();
+    /// <summary>
+    /// Max time (in milliseconds) a send may block with no sign of life from the writer (no BUSY heartbeat or ACK) before the connection is declared dead. Optional; the built-in default is used when unset.
+    /// </summary>
+    int64_t getPeerLivenessTimeoutMs() const;
+    void setPeerLivenessTimeoutMs(int64_t const value);
+    bool peerLivenessTimeoutMsIsSet() const;
+    void unsetPeer_liveness_timeout_ms();
+    /// <summary>
+    /// Hard upper bound (in milliseconds) on backpressure: if no bytes can be sent to the writer for this long the connection is declared dead even while the writer keeps heartbeating, so a wedged writer cannot block the run or its finalization. Optional; the built-in default is used when unset.
+    /// </summary>
+    int64_t getMaxBackpressureTimeoutMs() const;
+    void setMaxBackpressureTimeoutMs(int64_t const value);
+    bool maxBackpressureTimeoutMsIsSet() const;
+    void unsetMax_backpressure_timeout_ms();
 
     friend  void to_json(nlohmann::json& j, const Tcp_settings& o);
     friend  void from_json(const nlohmann::json& j, Tcp_settings& o);
@@ -89,7 +103,11 @@ protected:
     bool m_Image_socketIsSet;
     int64_t m_Nwriters;
     bool m_NwritersIsSet;
-    
+    int64_t m_Peer_liveness_timeout_ms;
+    bool m_Peer_liveness_timeout_msIsSet;
+    int64_t m_Max_backpressure_timeout_ms;
+    bool m_Max_backpressure_timeout_msIsSet;
+
 };
 
 } // namespace org::openapitools::server::model
diff --git a/broker/jfjoch_api.yaml b/broker/jfjoch_api.yaml
index 00e70e80..86ead6d2 100644
--- a/broker/jfjoch_api.yaml
+++ b/broker/jfjoch_api.yaml
@@ -2232,6 +2232,21 @@ components:
           maximum: 100
           default: 32
           description: Number of TCP/IP writers to be used for streaming images
+        peer_liveness_timeout_ms:
+          type: integer
+          format: int64
+          description: |
+            Max time (in milliseconds) a send may block with no sign of life from the
+            writer (no BUSY heartbeat or ACK) before the connection is declared dead.
+            Optional; the built-in default is used when unset.
+        max_backpressure_timeout_ms:
+          type: integer
+          format: int64
+          description: |
+            Hard upper bound (in milliseconds) on backpressure: if no bytes can be sent to
+            the writer for this long the connection is declared dead even while the writer
+            keeps heartbeating, so a wedged writer cannot block the run or its
+            finalization. Optional; the built-in default is used when unset.
     pcie_devices:
       type: array
       minLength: 1
-- 
2.52.0


From 51bfb57782560db105e3119853a1145459428120 Mon Sep 17 00:00:00 2001
From: Filip Leonarski <filip.leonarski@psi.ch>
Date: Thu, 25 Jun 2026 14:19:09 +0200
Subject: [PATCH 5/7] Regenerate OpenAPI

---
 broker/gen/model/Tcp_settings.cpp      | 24 ++++++++++++------------
 broker/gen/model/Tcp_settings.h        |  6 +++---
 broker/redoc-static.html               |  2 +-
 docs/python_client/docs/TcpSettings.md |  2 ++
 frontend/src/client/types.gen.ts       | 15 +++++++++++++++
 frontend/src/client/zod.gen.ts         |  4 +++-
 6 files changed, 36 insertions(+), 17 deletions(-)

diff --git a/broker/gen/model/Tcp_settings.cpp b/broker/gen/model/Tcp_settings.cpp
index ef632894..391cfb4c 100644
--- a/broker/gen/model/Tcp_settings.cpp
+++ b/broker/gen/model/Tcp_settings.cpp
@@ -31,7 +31,7 @@ Tcp_settings::Tcp_settings()
     m_Peer_liveness_timeout_msIsSet = false;
     m_Max_backpressure_timeout_ms = 0L;
     m_Max_backpressure_timeout_msIsSet = false;
-
+    
 }
 
 void Tcp_settings::validate() const
@@ -72,7 +72,7 @@ bool Tcp_settings::validate(std::stringstream& msg, const std::string& pathPrefi
         }
 
     }
-    
+            
     return success;
 }
 
@@ -89,13 +89,13 @@ bool Tcp_settings::operator==(const Tcp_settings& rhs) const
     
     
     ((!nwritersIsSet() && !rhs.nwritersIsSet()) || (nwritersIsSet() && rhs.nwritersIsSet() && getNwriters() == rhs.getNwriters())) &&
-
-
+    
+    
     ((!peerLivenessTimeoutMsIsSet() && !rhs.peerLivenessTimeoutMsIsSet()) || (peerLivenessTimeoutMsIsSet() && rhs.peerLivenessTimeoutMsIsSet() && getPeerLivenessTimeoutMs() == rhs.getPeerLivenessTimeoutMs())) &&
-
-
+    
+    
     ((!maxBackpressureTimeoutMsIsSet() && !rhs.maxBackpressureTimeoutMsIsSet()) || (maxBackpressureTimeoutMsIsSet() && rhs.maxBackpressureTimeoutMsIsSet() && getMaxBackpressureTimeoutMs() == rhs.getMaxBackpressureTimeoutMs()))
-
+    
     ;
 }
 
@@ -117,7 +117,7 @@ void to_json(nlohmann::json& j, const Tcp_settings& o)
         j["peer_liveness_timeout_ms"] = o.m_Peer_liveness_timeout_ms;
     if(o.maxBackpressureTimeoutMsIsSet())
         j["max_backpressure_timeout_ms"] = o.m_Max_backpressure_timeout_ms;
-
+    
 }
 
 void from_json(const nlohmann::json& j, Tcp_settings& o)
@@ -136,18 +136,18 @@ void from_json(const nlohmann::json& j, Tcp_settings& o)
     {
         j.at("nwriters").get_to(o.m_Nwriters);
         o.m_NwritersIsSet = true;
-    }
+    } 
     if(j.find("peer_liveness_timeout_ms") != j.end())
     {
         j.at("peer_liveness_timeout_ms").get_to(o.m_Peer_liveness_timeout_ms);
         o.m_Peer_liveness_timeout_msIsSet = true;
-    }
+    } 
     if(j.find("max_backpressure_timeout_ms") != j.end())
     {
         j.at("max_backpressure_timeout_ms").get_to(o.m_Max_backpressure_timeout_ms);
         o.m_Max_backpressure_timeout_msIsSet = true;
-    }
-
+    } 
+    
 }
 
 int64_t Tcp_settings::getSendBufferSize() const
diff --git a/broker/gen/model/Tcp_settings.h b/broker/gen/model/Tcp_settings.h
index 61144d44..d323c3bd 100644
--- a/broker/gen/model/Tcp_settings.h
+++ b/broker/gen/model/Tcp_settings.h
@@ -80,14 +80,14 @@ public:
     bool nwritersIsSet() const;
     void unsetNwriters();
     /// <summary>
-    /// Max time (in milliseconds) a send may block with no sign of life from the writer (no BUSY heartbeat or ACK) before the connection is declared dead. Optional; the built-in default is used when unset.
+    /// Max time (in milliseconds) a send may block with no sign of life from the writer (no BUSY heartbeat or ACK) before the connection is declared dead. Optional; the built-in default is used when unset. 
     /// </summary>
     int64_t getPeerLivenessTimeoutMs() const;
     void setPeerLivenessTimeoutMs(int64_t const value);
     bool peerLivenessTimeoutMsIsSet() const;
     void unsetPeer_liveness_timeout_ms();
     /// <summary>
-    /// Hard upper bound (in milliseconds) on backpressure: if no bytes can be sent to the writer for this long the connection is declared dead even while the writer keeps heartbeating, so a wedged writer cannot block the run or its finalization. Optional; the built-in default is used when unset.
+    /// Hard upper bound (in milliseconds) on backpressure: if no bytes can be sent to the writer for this long the connection is declared dead even while the writer keeps heartbeating, so a wedged writer cannot block the run or its finalization. Optional; the built-in default is used when unset. 
     /// </summary>
     int64_t getMaxBackpressureTimeoutMs() const;
     void setMaxBackpressureTimeoutMs(int64_t const value);
@@ -107,7 +107,7 @@ protected:
     bool m_Peer_liveness_timeout_msIsSet;
     int64_t m_Max_backpressure_timeout_ms;
     bool m_Max_backpressure_timeout_msIsSet;
-
+    
 };
 
 } // namespace org::openapitools::server::model
diff --git a/broker/redoc-static.html b/broker/redoc-static.html
index 0bc418af..207f3324 100644
--- a/broker/redoc-static.html
+++ b/broker/redoc-static.html
@@ -937,7 +937,7 @@ then image might be replaced in the buffer between calling /images and /image.cb
 </div></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-ejfMa-d bNUPQg"><button class="sc-EgOXT cFEcOl"><span type="get" class="sc-eZYNyq qGfV http-verb get">get</span><span class="sc-iEXKAA gUNSDu">/version</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dlWCHZ kWacYr"><div class="sc-hHOBiw cndTNO"><div class="sc-eeDRCY sc-eBMEME gTGgei fbXBig"><p>Test Jungfraujoch system</p>
 </div><div tabindex="0" role="button"><div class="sc-kWtpeL gEncxT"><span>http://localhost:5232</span>/version</div></div></div></div></div></div></div></div></div><div class="sc-dExYaf gZbfaQ"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.3","info":{"title":"Jungfraujoch","description":"API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland).\nJungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU.\nJungfraujoch uses FPGA boards to acquire data at high data rates.\n\n# License Clarification\n\nWhile this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply**\nwhen this file is used solely to generate OpenAPI clients or when implementing applications that\ninteract with the API. Generated client code and applications using this API definition are not\nsubject to the GPL license requirements and may be distributed under terms of your choosing.\n\nThis exception is similar in spirit to the Linux Kernel's approach to userspace API headers and\nthe GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that\nuser programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not\nderivative works of the kernel and are not subject to the terms of the GPL.\n\nThis exception is intended to allow wider use of this API specification without imposing GPL\nrequirements on applications that merely interact with the API, regardless of whether they\ncommunicate through network calls or other mechanisms.\n","version":"1.0.0-rc.153","contact":{"name":"Filip Leonarski (Paul Scherrer Institute)","email":"filip.leonarski@psi.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.html"}},"servers":[{"url":"http://localhost:5232","description":"Test Jungfraujoch system"}],"components":{"parameters":{"binning":{"in":"query","name":"binning","required":false,"schema":{"default":1,"type":"integer"},"description":"Binning of frames for the plot (0 = default binning)"},"experimental_coord":{"in":"query","name":"experimental_coord","required":false,"schema":{"type":"boolean","default":false},"description":"If measurement has goniometer axis defined, plot X-axis will represent rotation angle\nIf measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value\nFor still measurement the number is ignored\n"},"azint_unit":{"in":"query","name":"azint_unit","required":false,"schema":{"type":"string","enum":["Q_recipA","d_A","two_theta_deg"],"default":"Q_recipA"},"description":"Unit used for azim int.\n"},"fill_value":{"in":"query","name":"fill","required":false,"schema":{"type":"number","format":"float"},"description":"Fill value for elements that were missed during data collection\n"},"plot_type":{"in":"query","name":"type","required":true,"description":"Type of requested plot","schema":{"type":"string","enum":["bkg_estimate","azint","azint_1d","spot_count","spot_count_low_res","spot_count_indexed","spot_count_ice","indexing_rate","indexing_lattice_count","indexing_unit_cell_length","indexing_unit_cell_angle","profile_radius","mosaicity","b_factor","error_pixels","saturated_pixels","image_collection_efficiency","receiver_delay","receiver_free_send_buf","strong_pixels","roi_sum","roi_mean","roi_max_count","roi_pixels","roi_weighted_x","roi_weighted_y","packets_received","max_pixel_value","resolution_estimate","pixel_sum","processing_time","beam_center_x","beam_center_y","integrated_reflections","image_scale_factor","image_scale_cc","image_scale_b","compression_ratio"]}},"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","schema":{"type":"string","enum":["indigo","viridis","bw","wb","green","heat","magma","inferno"],"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 least-square diffraction geometry refinement algorithm used by Jungfraujoch.\nBeamCenter - This option is refining both beam center and lattice (restricted to a chosen/detected Bravais lattice).\nOrientationOnly - This option is refining only orientation of the lattice.\n","enum":["BeamCenter","OrientationOnly","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/user of the HDF5 file. \nThis applies solely to string and number (double floating-point). No arrays/sub-objects is allowed.\nFor example {\"hdf5\": {\"val1\":1, \"val2\":\"xyz\"}}, will write /entry/user/val1 and /entry/user/val2.\n"},"image_appendix":{"description":"Image appendix, added as user_data to image ZeroMQ message (can be any valid JSON)\nNot saved in HDF5 file\n"},"data_reduction_factor_serialmx":{"type":"number","format":"float","default":1,"minimum":0,"maximum":1,"description":"Rate at which non-indexed images are accepted to be forwarded to writer. \nValue of 1.0 (default) means that all images are written.\nValues below zero mean that non-indexed images will be accepted with a given probability.\n"},"pixel_value_low_threshold":{"type":"integer","format":"int64","minimum":0,"description":"Set all counts lower than the value to zero. \nWhen the value is set, negative numbers other than error pixel value are always set to zero.\nSetting to zero is equivalent to turning the option off.\n"},"run_number":{"type":"integer","format":"int64","minimum":0,"description":"Number of run within an experimental session. \nTransferred over CBOR stream as \"series ID\", though not saved in HDF5 file.\nIt is highly recommended to keep this number unique for each data collection during experimental series.\nIf not provided, the number will be automatically incremented.\n"},"run_name":{"type":"string","description":"Unique ID of run.\nTransferred over CBOR stream as \"unique series ID\", though not saved in HDF5 file.\nIt is highly recommended to keep this name unique for each data collection during experimental series.\nIf not provided, the name will be automatically generated as number + colon + file_prefix.\n"},"experiment_group":{"type":"string","description":"Name of group owning the data (e.g. p-group or proposal number). \nTransferred over CBOR stream, though not saved in HDF5 file.\n"},"poisson_compression":{"type":"integer","format":"int64","minimum":0,"maximum":16,"description":"Enable lossy compression of pixel values that preserves Poisson statistics. \nRequires to provide a numerical factor SQ.\nPixel value P will be transformed to round(sqrt(P) * SQ), with rounding to the closest integer.\nCompression is turned off if the value is missing or it is set to zero.\n"},"write_nxmx_hdf5_master":{"type":"boolean","default":true,"description":"Write NXmx formatted HDF5 master file. Recommended to use for macromolecular crystallography experiments\nand to turn off for other experiments.\n"},"save_calibration":{"type":"boolean","description":"Forward image calibration (at the moment pedestal and pedestal RMS for JUNGFRAU) using the ZeroMQ stream to writer.\nIf parameter is not provided calibration will be saved only if more than 4 images are recorded.\n"},"polarization_factor":{"type":"number","description":"Polarization factor for integration; 1.0 is horizontal polarization; -1.0 is vertical polarization","format":"float","minimum":-1,"maximum":1},"ring_current_mA":{"type":"number","format":"float","description":"Ring current at the beginning of the data collection","minimum":0},"sample_temperature_K":{"type":"number","format":"float","description":"Sample temperature in Kelvin","minimum":0},"poni_rot1_rad":{"type":"number","description":"PONI angle rot1 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"poni_rot2_rad":{"type":"number","description":"PONI angle rot2 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"poni_rot3_rad":{"type":"number","description":"PONI angle rot3 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"unit_cell":{"$ref":"#/components/schemas/unit_cell"},"spot_finding":{"type":"boolean","description":"Enable spot finding and save spots","default":true},"max_spot_count":{"type":"integer","minimum":10,"maximum":2000,"default":250,"description":"Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected"},"detect_ice_rings":{"type":"boolean","description":"Flag spots as ice rings and reduce their effect on indexing"},"async_start":{"type":"boolean","default":false,"description":"When set to true, `/start` will not wait for detector and Jungfraujoch to be ready for the measurement."},"xray_fluorescence_spectrum":{"type":"object","required":["energy_eV","data"],"properties":{"energy_eV":{"type":"array","items":{"type":"number","format":"float"},"description":"X-ray fluorescence scan energy for each measurement point"},"data":{"type":"array","items":{"type":"number","format":"float"},"description":"X-ray fluorescence scan result in arbitrary units; must be exactly the same length, as energy_eV"}}}}},"crystal_lattice":{"type":"array","items":{"type":"number","format":"float"},"minItems":9,"maxItems":9,"description":"Real-space crystal lattice 3D vectors in Angstrom.\nOrder is 1st vector (x,y,z), 2nd vector (x,y,z) and 3rd vector (x,y,z)\n"},"unit_cell":{"type":"object","description":"Unit cell parameters. Necessary to run indexing. Units of angstrom and degree","required":["a","b","c","alpha","beta","gamma"],"properties":{"a":{"type":"number","format":"float","example":37,"minimum":0},"b":{"type":"number","format":"float","example":37,"minimum":0},"c":{"type":"number","format":"float","example":78,"minimum":0},"alpha":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360},"beta":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360},"gamma":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360}}},"file_writer_format":{"type":"string","enum":["NXmxOnlyData","NXmxLegacy","NXmxVDS","NXmxIntegrated","CBF","TIFF","NoFileWritten"],"default":"NXmxLegacy","description":"NoFileWritten - no files are written at all\nNXmxOnlyData - only data files are written, no master file\nNXmxLegacy - legacy format with soft links to data files in the master file; necessary for DECTRIS Albula 4.0 and DECTRIS Neggia  \nNXmxVDS - newer format with virtual dataset linking data files in the master file, also includes better metadata handling\nNXmxIntegrated - single HDF5 per dataset\nCBF - CBF format (limited metadata)\nTIFF - TIFF format (no metadata)\n"},"file_writer_settings":{"type":"object","properties":{"overwrite":{"type":"boolean","default":false,"description":"Inform jfjoch_write to overwrite existing files. Otherwise files would be saved with .h5.{timestamp}.tmp suffix.\n"},"format":{"$ref":"#/components/schemas/file_writer_format"}}},"pixel_mask_statistics":{"type":"object","properties":{"user_mask":{"description":"Number of pixels masked using the user mask","type":"integer","format":"int64","minimum":0},"too_high_pedestal_rms":{"description":"Number of pixels with G0 pedestal RMS higher than provided threshold","type":"integer","format":"int64","minimum":0},"wrong_gain":{"description":"Number of pixels that show wrong gain level during the pedestal procedure","type":"integer","format":"int64","minimum":0}}},"image_buffer_status":{"type":"object","required":["image_numbers","total_slots","in_preparation_slots","in_sending_slots","available_slots","max_image_number","min_image_number"],"properties":{"min_image_number":{"type":"integer","format":"int64","minimum":0,"description":"Smallest image number available in the buffer"},"max_image_number":{"type":"integer","format":"int64","minimum":0,"description":"Largest image number available in the buffer"},"image_numbers":{"type":"array","description":"Image numbers currently present in the buffer.","items":{"type":"integer","format":"int64"}},"total_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer. This number, compared to number of images in data collection and\nframe rate will determine \"retention\" rate of the image buffer.\n"},"available_slots":{"type":"integer","format":"int64","description":"Slots available for the data collection"},"in_preparation_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer that are currently in preparation for sending.\n"},"in_sending_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer that are currently sending/writing data.\n"},"current_counter":{"type":"integer","format":"int64","description":"Counter of changes in the image buffer - either new start message or new image added.\nFor optimization one can only load new images/datasets from the HTTP if this value changes.\nCounter is optional as it was not implemented in older versions to avoid breaking change\n"}}},"image_format_settings":{"type":"object","required":["summation","jungfrau_conversion","geometry_transform","mask_chip_edges","mask_module_edges","apply_mask"],"properties":{"summation":{"type":"boolean","description":"Enable summation of images to a given image_time\nIf disabled images are saved according to original detector speed, but image count is adjusted\n"},"geometry_transform":{"type":"boolean","description":"Place module read-out into their location on composed detector and extend multipixels\n"},"jungfrau_conversion":{"type":"boolean","description":"Convert pixel value in ADU to photon counts/energy\nOnly affects JUNGFRAU detector\n"},"jungfrau_conversion_factor_keV":{"type":"number","format":"float","minimum":0.001,"maximum":500,"description":"Used to convert energy deposited into pixel to counts\nIf not provided incident_energy_keV is used\n"},"bit_depth_image":{"type":"integer","format":"int64","enum":[8,16,32],"description":"Bit depth of resulting image (it doesn't affect the detector read-out value)\nIf not provided value is adjusted automatically\n"},"signed_output":{"type":"boolean","description":"Controls if pixels have signed output\nIf not provided value is adjusted automatically\n"},"mask_module_edges":{"type":"boolean","default":true,"description":"Mask 1 pixel on the module boundary\n"},"mask_chip_edges":{"type":"boolean","default":true,"description":"Mask multipixels on chip boundary\n"},"jungfrau_mask_pixels_without_g0":{"type":"boolean","default":true,"description":"JUNGFRAU: mask pixels that don't operate in G0, but do operate in G1 and G1.\nThis should be turned off for cases, where detector is operated at room temperature with long exposure time.\n"},"apply_mask":{"type":"boolean","default":false,"description":"Masked pixels are set to special value in the images produced by Jungfraujoch\n"},"jungfrau_pedestal_g0_rms_limit":{"type":"integer","format":"int64","default":100,"minimum":0,"description":"Pixels with pedestal G0 RMS above the threshold are marked as masked pixels"}}},"detector_power_state":{"type":"string","description":"Power on of ASICs","enum":["PowerOn","PowerOff","Partial"]},"detector_state":{"type":"string","description":"Current state of the detector","enum":["Idle","Waiting","Busy","Error","Not connected"]},"detector_status":{"type":"object","required":["state","powerchip","server_version","number_of_triggers_left","fpga_temp_degC","high_voltage_V"],"properties":{"state":{"$ref":"#/components/schemas/detector_state"},"powerchip":{"$ref":"#/components/schemas/detector_power_state"},"server_version":{"type":"string","description":"Detector server (on read-out boards) version"},"number_of_triggers_left":{"type":"integer","format":"int64","description":"Remaining triggers to the detector (max of all modules)"},"fpga_temp_degC":{"type":"array","description":"Temperature of detector FPGAs","items":{"type":"integer","format":"int64"}},"high_voltage_V":{"type":"array","description":"High voltage for detector modules","items":{"type":"integer","format":"int64"}}}},"detector_timing":{"type":"string","enum":["auto","trigger","burst","gated"],"default":"trigger"},"detector_settings":{"type":"object","required":["frame_time_us"],"properties":{"frame_time_us":{"type":"integer","description":"Interval between consecutive frames.\nThis is internal frame time for the JUNGFRAU detector, image time has to be integer multiply of this number.\nFor EIGER detector this is default frame time, not used otherwise\n","format":"int64","minimum":1},"count_time_us":{"type":"integer","description":"Integration time of the detector. \nIf not provided count time will be set to maximum value for a given frame time.\n","format":"int64"},"internal_frame_generator":{"type":"boolean","default":false,"description":"Use internal frame generator in FPGA instead of getting data from a real detector"},"internal_frame_generator_images":{"type":"integer","format":"int64","default":1,"minimum":1,"maximum":64,"description":"Number of images stored in the internal frame generator."},"detector_trigger_delay_ns":{"type":"integer","format":"int64","minimum":0,"default":0,"description":"Delay between TTL trigger and acquisition start [ns]"},"timing":{"$ref":"#/components/schemas/detector_timing"},"eiger_threshold_keV":{"type":"number","format":"float","minimum":1,"maximum":100,"description":"Threshold for the PSI EIGER detector and all DECTRIS detectors.\nIf value is provided, it will be used for all subsequent acquisitions, irrespective of beam energy.\nIf value is not provided, threshold will be determined on start of acquisition as half of incident energy. \nThis might lead to increased start time.\n"},"eiger_bit_depth":{"type":"integer","format":"int64","enum":[8,16,32],"description":"Bit depth of PSI EIGER read-out. This is  \nIf value is not provided, depth will be determined based on the image time:\n* Exposure time < 500 microseconds depth of 8 bit will be used,\n* 500 <= exposure time < 2622 microseconds depth of 16 bit will be used\n* Exposure time >= 2622 microseconds depth of 32 bit will be used.\n"},"jungfrau_pedestal_g0_frames":{"type":"integer","format":"int64","default":2000,"minimum":0},"jungfrau_pedestal_g1_frames":{"type":"integer","format":"int64","default":300,"minimum":0},"jungfrau_pedestal_g2_frames":{"type":"integer","format":"int64","default":300,"minimum":0},"jungfrau_pedestal_min_image_count":{"type":"integer","format":"int64","default":128,"minimum":32,"description":"Minimum number of collected images for pedestal to consider it viable"},"jungfrau_storage_cell_count":{"type":"integer","format":"int64","default":1,"minimum":1,"maximum":16},"jungfrau_storage_cell_delay_ns":{"type":"integer","format":"int64","minimum":2100,"default":5000,"description":"Delay between two storage cells [ns]"},"jungfrau_fixed_gain_g1":{"type":"boolean","default":false,"description":"Fix gain to G1 (can be useful for storage cells)"},"jungfrau_use_gain_hg0":{"type":"boolean","default":false,"description":"Use high G0 (for low energy applications)"}}},"spot_finding_settings":{"type":"object","required":["enable","indexing","signal_to_noise_threshold","photon_count_threshold","max_pix_per_spot","min_pix_per_spot","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","minimum":0.00002,"maximum":10,"format":"float"},"low_q_recipA":{"type":"number","format":"float","minimum":0.00001,"maximum":10},"q_spacing":{"type":"number","format":"float","minimum":0.00001},"azimuthal_bins":{"type":"integer","format":"int64","minimum":1,"maximum":512,"default":1,"description":"Numer of azimuthal (phi) bins; 1 = standard 1D azimuthal integration"},"force_cpu":{"type":"boolean","default":false,"description":"Force CPU processing of azimuthal integration in the FPGA data acquisition workflow.\nThis allows to extend number of azimuthal integration bins, as well as to calculate standard deviation\nof the azimuthal integration results.\n"}}},"detector_list_element":{"type":"object","required":["id","nmodules","description","width","height","serial_number","base_ipv4_addr","udp_interface_count","readout_time_ns","min_frame_time_ns","min_count_time_ns"],"properties":{"id":{"type":"integer","format":"int64","minimum":0},"description":{"type":"string","example":"JUNGFRAU 4 Mpixel"},"serial_number":{"type":"string","example":"JF17T16V01"},"base_ipv4_addr":{"type":"string","example":"10.10.10.1"},"udp_interface_count":{"type":"integer","format":"int64","example":2,"description":"Number of UDP interfaces per detector module"},"nmodules":{"type":"integer","format":"int64","example":18},"width":{"type":"integer","format":"int64","example":2068},"height":{"type":"integer","format":"int64","example":2164},"pixel_size_mm":{"type":"number","format":"float","example":0.075},"readout_time_ns":{"type":"integer","format":"int64"},"min_frame_time_ns":{"type":"integer","format":"int64"},"min_count_time_ns":{"type":"integer","format":"int64"},"type":{"$ref":"#/components/schemas/detector_type"}}},"detector_list":{"type":"object","required":["detectors","current_id"],"properties":{"detectors":{"type":"array","items":{"$ref":"#/components/schemas/detector_list_element"}},"current_id":{"type":"integer","format":"int64","example":0}}},"detector_selection":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","example":1}}},"measurement_statistics":{"type":"object","properties":{"file_prefix":{"type":"string"},"run_number":{"type":"integer","format":"int64","description":"Number of data collection run. This can be either automatically incremented or provided externally for each data collection.\n"},"experiment_group":{"type":"string","description":"Name of group owning the data (e.g. p-group or proposal number).\n"},"images_expected":{"type":"integer","format":"int64"},"images_collected":{"type":"integer","format":"int64","description":"Images collected by the receiver. This number will be lower than images expected if there were issues with data collection performance.\n"},"images_sent":{"type":"integer","format":"int64","description":"Images sent to the writer. \nThe value does not include images discarded by lossy compression filter and images not forwarded due to full ZeroMQ queue.\n"},"images_written":{"type":"integer","format":"int64","description":"Images successfully written to disk.\nThe value is live updated for TCP/IP socket and direct HDF5 writer, while for ZeroMQ it is only updated at the end of experiment.\n"},"images_discarded_lossy_compression":{"type":"integer","format":"int64","description":"Images discarded by the lossy compression filter"},"max_image_number_sent":{"type":"integer","format":"int64"},"collection_efficiency":{"type":"number","format":"float","example":1,"minimum":0,"maximum":1},"compression_ratio":{"type":"number","format":"float","example":5.3,"minimum":0},"cancelled":{"type":"boolean"},"max_receiver_delay":{"type":"integer","format":"int64"},"indexing_rate":{"type":"number","format":"float"},"detector_width":{"type":"integer","format":"int64"},"detector_height":{"type":"integer","format":"int64"},"detector_pixel_depth":{"type":"integer","format":"int64","enum":[2,4]},"bkg_estimate":{"type":"number","format":"float"},"unit_cell":{"type":"string"},"error_pixels":{"type":"number","format":"float","description":"Moving average of 1000 images counting number of error pixels on the detector"},"saturated_pixels":{"type":"number","format":"float","description":"Moving average of 1000 images counting number of saturated pixels on the detector"},"roi_beam_pixels":{"type":"number","format":"float","description":"If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images\nfor number of valid pixels within this ROI\n"},"roi_beam_sum":{"type":"number","format":"float","description":"If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images\nfor sum of valid pixels within this ROI\n"}}},"fpga_status":{"type":"array","items":{"type":"object","required":["pci_dev_id","serial_number","base_mac_addr","eth_link_status","eth_link_count","eth_link_speed","power_usage_W","fpga_temp_C","hbm_temp_C","packets_sls","packets_udp","idle","fw_version","pcie_link_speed","pcie_link_width"],"properties":{"pci_dev_id":{"type":"string"},"serial_number":{"type":"string"},"fw_version":{"type":"string"},"base_mac_addr":{"type":"string"},"eth_link_count":{"type":"integer","format":"int64"},"eth_link_status":{"type":"integer","format":"int64"},"power_usage_W":{"type":"number","format":"float"},"fpga_temp_C":{"type":"number","format":"float"},"hbm_temp_C":{"type":"number","format":"float"},"packets_udp":{"type":"integer","format":"int64"},"packets_sls":{"type":"integer","format":"int64"},"idle":{"type":"boolean"},"pcie_link_speed":{"type":"integer","format":"int64","description":"PCIe link speed measured by generation (expected value is 4 == PCIe Gen4)"},"pcie_link_width":{"type":"integer","format":"int64","description":"PCIe link width (expected value is 8 == x8)"}}}},"broker_status":{"type":"object","required":["state"],"properties":{"state":{"type":"string","enum":["Inactive","Idle","Busy","Measuring","Pedestal","Error"]},"progress":{"type":"number","format":"float","description":"Progress of data collection (only available if receiving is running)","example":1,"minimum":0,"maximum":1},"message":{"type":"string","description":"Message to display besides state of the jfjoch_broker; mostly used for errors and warnings\nThis matters especially for async functions (start/initialize), where API won't return reason\nfor the error during async operation.\n"},"message_severity":{"type":"string","enum":["success","info","warning","error"],"default":"error","description":"Level of the message to display"},"gpu_count":{"type":"integer","format":"int32","description":"Number of installed GPUs"},"broker_version":{"type":"string","description":"Version of the jfjoch_broker","example":"1.0.0-rc.128"}}},"image_pusher_status":{"type":"object","required":["pusher_type","addr","connected_writers"],"description":"Informs about status of the image pusher.\n","properties":{"pusher_type":{"$ref":"#/components/schemas/image_pusher_type"},"addr":{"type":"array","items":{"type":"string"},"example":["tcp://1.2.3.4:5000","tcp://1.2.3.4:5001"],"description":"List of addresses of image pushers.\nFor HDF5 socket - no addresses will be returned.\nFor ZeroMQ - list of addresses for each socket will be provided.\nFor TCP/IP - single address to connect all writers will be provided.\n"},"connected_writers":{"type":"integer","format":"int64","minimum":0,"description":"Number of connected writers \nFor ZeroMQ image socket: number is constant\nFor TCP/IP image socket: number is updated live during operation\n"},"images_written":{"type":"integer","format":"int64","minimum":0,"description":"Number of images written to the image socket.\nThis number is updated live during operation for TCP/IP image socket and direct HDF5 writer.\nIt is updated at the end of experiment for ZeroMQ image socket.\n"},"images_write_error":{"type":"integer","format":"int64","minimum":0,"description":"Number of images that could not be written to the image socket.\nThis number is updated live during operation for TCP/IP image socket.\nNo other socket use it.\n"},"writer_fifo_utilization":{"type":"array","items":{"type":"integer","format":"int64","minimum":0},"description":"Utilization of internal writer FIFO.\nThis number is updated live during operation for TCP/IP image socket.\nNo other socket use it.\n"}}},"plot":{"type":"object","required":["x","y","title"],"description":"x and y coordinates for plotting, it is OK to assume that both arrays have the same size; layout is optimized for Plotly","properties":{"title":{"type":"string","default":""},"x":{"type":"array","items":{"type":"number","format":"float"}},"y":{"type":"array","items":{"type":"number","format":"float","nullable":true}},"z":{"type":"array","items":{"type":"number","format":"float","nullable":true}}}},"plot_unit_x":{"type":"string","enum":["image_number","q_recipA","d_A","angle_deg","ADU","grid_um"],"default":"image_number"},"plots":{"type":"object","required":["plot","unit_x"],"properties":{"title":{"type":"string"},"unit_x":{"$ref":"#/components/schemas/plot_unit_x"},"size_x":{"type":"number","format":"float","description":"Max X range of the plot"},"size_y":{"type":"number","format":"float","description":"Max Y range of the plot"},"plot":{"type":"array","items":{"$ref":"#/components/schemas/plot"}}}},"scan_result":{"type":"object","description":"Results of a scan","required":["images"],"properties":{"file_prefix":{"type":"string"},"rotation_unit_cell":{"$ref":"#/components/schemas/unit_cell"},"rotation_crystal_lattice":{"$ref":"#/components/schemas/crystal_lattice"},"images":{"type":"array","items":{"type":"object","required":["efficiency","number"],"properties":{"efficiency":{"type":"number","format":"float"},"number":{"type":"integer","format":"int64","description":"Detector image number for a given cell"},"nx":{"type":"integer","format":"int64","description":"Cell position in X for grid scan"},"ny":{"type":"integer","format":"int64","description":"Cell position in Y for grid scan"},"angle":{"type":"number","format":"float","description":"Rotation angle associated with the image"},"bkg":{"type":"number","format":"float","description":"Background estimate"},"spots":{"type":"integer","format":"int64","description":"Spot count"},"spots_low_res":{"type":"integer","format":"int64","description":"Spot count in low resolution range"},"spots_indexed":{"type":"integer","format":"int64","description":"Spot count within indexing tolerance"},"spots_ice":{"type":"integer","format":"int64","description":"Spot count within common ice ring resolutions"},"index":{"type":"integer","format":"int64","description":"Indexing solution"},"latt_count":{"type":"integer","format":"int64","description":"Indexing lattice count"},"pr":{"type":"number","format":"float","description":"Profile radius, i.e. how far reflections are from the Ewald sphere"},"b":{"type":"number","format":"float","description":"B-Factor estimate"},"uc":{"$ref":"#/components/schemas/unit_cell"},"xfel_pulseid":{"type":"integer","format":"int64","description":"XFEL pulse ID"},"pixel_sum":{"type":"integer","format":"int64","description":"Total sum of all pixels"},"max":{"type":"integer","format":"int64","description":"Max viable pixel"},"sat":{"type":"integer","format":"int64","description":"Number of saturated pixels"},"err":{"type":"integer","format":"int64","description":"Number of error pixels"},"res":{"type":"number","format":"float","description":"Diffraction resolution estimate"}}}}}},"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"},"image_pusher":{"$ref":"#/components/schemas/image_pusher_status"}}},"error_message":{"type":"object","required":["msg","reason"],"properties":{"msg":{"type":"string","description":"Human readable message","example":"Detector in wrong state"},"reason":{"type":"string","description":"Enumerate field for automated analysis","enum":["WrongDAQState","Other"]}}},"roi_azimuthal":{"type":"object","description":"ROI as Q-range (or resolution range), optionally restricted to an azimuthal-angle sector","required":["name","q_min_recipA","q_max_recipA"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"q_min_recipA":{"type":"number","format":"float","minimum":0.00001,"description":"Minimum Q-range for the ROI"},"q_max_recipA":{"type":"number","format":"float","minimum":0.00001,"description":"Maximum Q-range for the ROI"},"phi_min_deg":{"type":"number","format":"float","description":"Lower azimuthal-angle bound of the sector [degrees]. Optional: provide both phi_min_deg and phi_max_deg to restrict the ROI to an angular sector, or omit both for a full ring. A sector with phi_min_deg > phi_max_deg wraps across 0.\n"},"phi_max_deg":{"type":"number","format":"float","description":"Upper azimuthal-angle bound of the sector [degrees]. Optional; see phi_min_deg.\n"}}},"roi_circle":{"type":"object","description":"Circular ROI","required":["name","center_x_pxl","center_y_pxl","radius_pxl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"center_x_pxl":{"type":"number","format":"float","description":"X coordinate of center of the circle [pixels]"},"center_y_pxl":{"type":"number","format":"float","description":"Y coordinate of center of the circle [pixels]"},"radius_pxl":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"Radius of the circle [pixels]"}}},"roi_box":{"type":"object","description":"Box ROI","required":["name","min_x_pxl","max_x_pxl","min_y_pxl","max_y_pxl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"min_x_pxl":{"type":"integer","format":"int64","description":"Lower bound (inclusive) in X coordinate for the box","minimum":0},"max_x_pxl":{"type":"integer","format":"int64","description":"Upper bound (inclusive) in X coordinate for the box","minimum":0},"min_y_pxl":{"type":"integer","format":"int64","description":"Lower bound (inclusive) in Y coordinate for the box","minimum":0},"max_y_pxl":{"type":"integer","format":"int64","description":"Upper bound (inclusive) in Y coordinate for the box","minimum":0}}},"roi_circle_list":{"type":"object","description":"List of circular ROIs","required":["rois"],"properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_circle"}}}},"roi_box_list":{"type":"object","description":"List of box ROIs","properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_box"}}}},"roi_azim_list":{"type":"object","description":"List of azimuthal ROIs","properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_azimuthal"}}}},"roi_definitions":{"type":"object","required":["box","circle","azim"],"description":"ROI defintions","properties":{"box":{"$ref":"#/components/schemas/roi_box_list"},"circle":{"$ref":"#/components/schemas/roi_circle_list"},"azim":{"$ref":"#/components/schemas/roi_azim_list"}}},"dark_mask_settings":{"type":"object","description":"Settings for collection of dark images to be used for mask calculation","required":["detector_threshold_keV","frame_threshold_keV","max_allowed_pixel_count","max_frames_with_signal","frame_time_us","number_of_frames"],"properties":{"detector_threshold_keV":{"type":"number","format":"float","description":"Energy threshold for dark image collection","minimum":2.5,"default":3.5,"maximum":100},"frame_time_us":{"type":"integer","format":"int64","description":"Time between frames for dark image collection","minimum":500,"default":10000,"maximum":100000},"number_of_frames":{"type":"integer","format":"int64","description":"Number of frames for dark image collection; zero means no dark collection","minimum":0,"default":1000},"max_allowed_pixel_count":{"type":"integer","format":"int64","description":"Maximum count in a pixel considered normal (not-masked)","minimum":0,"default":1},"max_frames_with_signal":{"type":"integer","format":"int64","description":"Maximum number of frames with signal in a pixel considered normal (not-masked)","minimum":0,"default":10}}},"indexing_settings":{"type":"object","description":"Settings for crystallography indexing","required":["algorithm","geom_refinement_algorithm","fft_high_resolution_A","fft_max_unit_cell_A","fft_min_unit_cell_A","fft_num_vectors","tolerance","thread_count","unit_cell_dist_tolerance","index_ice_rings","viable_cell_min_spots","rotation_indexing","rotation_indexing_min_angular_range_deg","rotation_indexing_angular_stride_deg","blocking"],"properties":{"algorithm":{"$ref":"#/components/schemas/indexing_algorithm"},"fft_max_unit_cell_A":{"type":"number","format":"float","default":250,"maximum":500,"minimum":50,"description":"Largest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT"},"fft_min_unit_cell_A":{"type":"number","format":"float","default":10,"minimum":5,"maximum":40,"description":"Smallest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT"},"fft_high_resolution_A":{"type":"number","format":"float","default":2,"minimum":0.5,"maximum":6,"description":"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"},"rotation_indexing":{"type":"boolean","default":false},"rotation_indexing_min_angular_range_deg":{"type":"number","format":"float","default":20,"minimum":1},"rotation_indexing_angular_stride_deg":{"type":"number","format":"float","default":0.5,"minimum":0},"blocking":{"type":"boolean","default":true,"description":"Indexing in Jungfraujoch goes with a dedicated thread pool.\nIf set to false, the thread pool is non-blocking, i.e. if there are no threads available, image indexing will be skipped. This option is recommended for real-time processing at high frame rates.\nIf set to true, the thread pool will block until a thread is available.\n"}}},"instrument_metadata":{"type":"object","description":"Metadata for a measurement instrument","required":["source_name","instrument_name"],"properties":{"source_name":{"type":"string","example":"Swiss Light Source"},"source_type":{"type":"string","description":"Type of radiation source. NXmx gives a fixed dictionary, though Jungfraujoch is not enforcing compliance. \nhttps://manual.nexusformat.org/classes/base_classes/NXsource.html#nxsource\nNXsource allows the following:\n\nSpallation Neutron Source\nPulsed Reactor Neutron Source\nReactor Neutron Source\nSynchrotron X-ray Source\nPulsed Muon Source\nRotating Anode X-ray\nFixed Tube X-ray\nUV Laser\nFree-Electron Laser\nOptical Laser\nIon Source\nUV Plasma Source\nMetal Jet X-ray\n","example":"Synchrotron X-ray Source","default":""},"instrument_name":{"type":"string","example":"CristallinaMX"},"pulsed_source":{"type":"boolean","description":"Settings specific to XFEL (e.g., every image has to come from TTL trigger, save pulse ID and event code)\n","default":false},"electron_source":{"type":"boolean","description":"Settings specific to electron source (e.g., wavelength definition)\n","default":false}}},"detector_module_direction":{"type":"string","enum":["Xp","Xn","Yp","Yn"]},"detector_type":{"type":"string","enum":["EIGER","JUNGFRAU","DECTRIS"]},"image_pusher_type":{"type":"string","default":"None","enum":["ZeroMQ","HDF5","CBOR","TCP","None"]},"standard_detector_geometry":{"type":"object","description":"Regular rectangular geometry, first module is in the bottom left corner of the detector","required":["nmodules"],"properties":{"nmodules":{"type":"integer","minimum":1,"description":"Number of modules in the detector"},"gap_x":{"type":"integer","default":8,"minimum":0,"description":"Gap size in X direction [pixels]"},"gap_y":{"type":"integer","minimum":0,"default":36,"description":"Gap size in Y direction [pixels]"},"modules_in_row":{"type":"integer","minimum":1,"default":1,"description":"Number of modules in one row"}}},"detector_module":{"type":"object","required":["x0","y0","fast_axis","slow_axis"],"properties":{"x0":{"type":"number"},"y0":{"type":"number"},"fast_axis":{"$ref":"#/components/schemas/detector_module_direction"},"slow_axis":{"$ref":"#/components/schemas/detector_module_direction"}}},"detector":{"type":"object","required":["description"],"properties":{"description":{"type":"string","minLength":1},"serial_number":{"type":"string","default":"Unknown","minLength":1},"type":{"$ref":"#/components/schemas/detector_type"},"high_voltage_V":{"type":"integer","format":"int64","minimum":0,"maximum":200,"default":0},"udp_interface_count":{"type":"integer","format":"int64","minimum":1,"maximum":2,"default":1},"module_sync":{"type":"boolean","default":true,"description":"Use module 0 as master for timing. Only applies to JUNGFRAU detector (this cannot be turned off for EIGER)."},"sensor_thickness_um":{"type":"number","format":"float","minimum":0,"default":320},"readout_time_ns":{"type":"integer","format":"int64","minimum":1,"description":"Minimum difference between frame time and count time in microseconds\nDefaults are 3'000 ns for EIGER and 20'000 ns for JUNGFRAU\n"},"min_count_time_ns":{"type":"integer","format":"int64","minimum":0,"description":"Minimum count time available for the detector."},"min_frame_time_ns":{"type":"integer","format":"int64","minimum":0,"description":"Minimum frame time available for the detector."},"calibration_file":{"type":"array","description":"Can be empty for all detectors - default calibration used.\nFor JUNGFRAU: list of gain files, one entry per module.\nFor EIGER: one directory (with detector settings) or list of trim bit files, one entry per half-module.\n","items":{"type":"string"}},"trim_energies_eV":{"type":"array","description":"List of energies at which trimming calibration is provided.\nOnly needed for PSI EIGER and compulsory in this case\n","items":{"type":"integer","format":"int32","minimum":100}},"hostname":{"type":"array","description":"Hostname for detector module. One entry per module\nOne entry per module. Either empty or number of module entries.\n","items":{"type":"string"}},"sensor_material":{"type":"string","default":"Si"},"tx_delay":{"type":"array","items":{"type":"integer","format":"int64"}},"base_data_ipv4_address":{"type":"string","example":"10.10.10.50"},"standard_geometry":{"$ref":"#/components/schemas/standard_detector_geometry"},"custom_geometry":{"type":"array","items":{"$ref":"#/components/schemas/detector_module"}},"roi_mode":{"type":"string","default":"","description":"ROI setting for DECTRIS detectors"},"mirror_y":{"type":"boolean","default":true,"description":"Mirror detector in Y direction to account for MX convention of (0,0) point in top left corner"},"temp_thresold_degC":{"type":"integer","format":"int64","description":"Temperature threshold for JUNGFRAU detector modules","minimum":40,"maximum":70,"default":55},"default_settings":{"$ref":"#/components/schemas/detector_settings"}}},"zeromq_settings":{"type":"object","description":"ZeroMQ configuration for Jungfraujoch software.\nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","properties":{"send_watermark":{"type":"integer","format":"int64","minimum":2,"maximum":16384,"default":100,"description":"Watermark for ZeroMQ send queue (number of outstanding messages queued on Jungfraujoch server per queue)"},"send_buffer_size":{"type":"integer","format":"int64","description":"Send buffer size for ZeroMQ socket"},"image_socket":{"type":"array","items":{"type":"string"},"example":["tcp://1.2.3.4:5000","tcp://1.2.3.4:5001"],"description":"PUSH ZeroMQ socket for images. In case multiple sockets are provided, images are streamed over multiple sockets.  \nImages are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"},"writer_notification_socket":{"type":"string","example":"tcp://1.3.4.6:7000","description":"PULL ZeroMQ socket for notifications from writer that it finished operation. \nThis allows Jungfraujoch to operate in a synchronous manner, with end of acquisition being also end of writing.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address should be avoided, as this socket address is forwarded to the writer process via START ZerOMQ message and in case of multiple ineterfaces the address might be ambigous.\nUsing * (star) instead of port number is allowed and it means a random free port number.\n"}}},"tcp_settings":{"type":"object","description":"TCP image stream configuration for Jungfraujoch software.\nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","required":["addr"],"properties":{"send_buffer_size":{"type":"integer","format":"int64","description":"Send buffer size for TCP/IP socket"},"image_socket":{"type":"string","example":"tcp://1.2.3.4:5000","description":"tcp://<IP address>:<port>\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces\n"},"nwriters":{"type":"integer","format":"int64","minimum":1,"maximum":100,"default":32,"description":"Number of TCP/IP writers to be used for streaming images"}}},"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"},"tcp":{"$ref":"#/components/schemas/tcp_settings"},"instrument":{"$ref":"#/components/schemas/instrument_metadata"},"file_writer":{"$ref":"#/components/schemas/file_writer_settings"},"detector":{"type":"array","minLength":1,"items":{"$ref":"#/components/schemas/detector"}},"indexing":{"$ref":"#/components/schemas/indexing_settings"},"detector_settings":{"$ref":"#/components/schemas/detector_settings"},"azim_int":{"$ref":"#/components/schemas/azim_int_settings"},"image_format":{"$ref":"#/components/schemas/image_format_settings"},"image_buffer_MiB":{"type":"integer","minimum":128,"default":2048,"description":"Size of internal buffer in MiB for images before they are sent to a stream"},"verbose":{"type":"boolean","default":false,"description":"Print extra debug information"},"receiver_threads":{"type":"integer","minimum":1,"maximum":512,"default":64,"description":"Number of threads used by the receiver"},"numa_policy":{"type":"string","deprecated":true,"description":"Ignored value"},"frontend_directory":{"type":"string","description":"Location of built JavaScript web frontend"},"spot_finding":{"$ref":"#/components/schemas/spot_finding_settings"},"image_pusher":{"$ref":"#/components/schemas/image_pusher_type"},"zeromq_preview":{"$ref":"#/components/schemas/zeromq_preview_settings"},"zeromq_metadata":{"$ref":"#/components/schemas/zeromq_metadata_settings"},"dark_mask":{"$ref":"#/components/schemas/dark_mask_settings"}}},"zeromq_metadata_settings":{"type":"object","required":["enabled","period_ms"],"properties":{"enabled":{"type":"boolean","default":true,"description":"ZeroMQ metadata socket is enabled."},"period_ms":{"type":"integer","format":"int64","minimum":1,"default":1000,"description":"Period for generating metadata package sent to the ZeroMQ interface in milliseconds.\n"},"socket_address":{"type":"string","description":"PUB ZeroMQ socket for image metadata information.\nImage metadata are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"}}},"zeromq_preview_settings":{"type":"object","required":["enabled","period_ms"],"properties":{"enabled":{"type":"boolean","default":true,"description":"ZeroMQ preview socket is enabled."},"period_ms":{"type":"integer","format":"int64","default":1000,"description":"Period for generating preview image sent to the ZeroMQ interface in milliseconds. Default is 1 second. \nIf set to zero, all images will be sent ZeroMQ (should be used only in case of relatively slow data collection).\nThis has no effect on HTTP based preview, which updates always at rate of 1 second.\n"},"socket_address":{"type":"string","description":"PUB ZeroMQ socket for preview images. This socket operates at a reduced frame rate.\nImages are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"}}}}},"paths":{"/initialize":{"post":{"summary":"Initialize detector and data acquisition","description":"Should be used in two cases:\n  - Detector is in `Inactive` state\n  - Detector is in `Error` state\nX-ray shutter must be closed. \nThis operation will reconfigure network interface of the detector. \nDuring operation of the detector it is recommended to use the `POST /pedestal` operation instead.\nIf storage cells are used, the execution time might be few minutes.\n\nThis is async function - one needs to use `POST /wait_till_done` to ensure operation is done.\n","responses":{"200":{"description":"Initialization started"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/pedestal":{"post":{"summary":"Collect dark current for the detector","description":"Updates calibration of the JUNGFRAU detector. Must be in `Idle` state.\n\nX-ray shutter must be closed. Recommended to run once per hour for long integration times (> 100 us).\n\nThis is async function - one needs to use `POST /wait_till_done` to ensure operation is done.\n","responses":{"200":{"description":"Everything OK"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/start":{"post":{"summary":"Start detector","description":"Start data acquisition.\nDetector must be in `Idle` state.\nDefault behavior is for the call to block until detector is ready to accept soft/TTL triggers.\nHowever, this behavior can be changed by settings `async_start` to true in the request body, \nin which case the call will return immediately and one needs to use `/wait_until_running` to ensure detector is ready to run.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/wait_until_running":{"post":{"summary":"Wait for acquisition running","parameters":[{"in":"query","name":"timeout","required":false,"schema":{"type":"integer","default":60,"minimum":0,"maximum":3600},"description":"Timeout in seconds (0 == immediate response)"}],"description":"Block execution of external script till detector and Jungfraujoch are ready to collect data.\nTo not block web server for a indefinite period of time, the procedure is provided with a timeout.\nExtending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.\n","responses":{"200":{"description":"Detector in `Measuring` state"},"400":{"description":"Timeout parameter out of bounds"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}},"502":{"description":"Detector is inactive mode"},"504":{"description":"Timeout reached, need to restart operation"}}}},"/wait_till_done":{"post":{"summary":"Wait for acquisition done","parameters":[{"in":"query","name":"timeout","required":false,"schema":{"type":"integer","default":60,"minimum":0,"maximum":3600},"description":"Timeout in seconds (0 == immediate response)"}],"description":"Block execution of external script till initialization, data collection or pedestal is finished.\nRunning this command does not affect (cancel) running data collection, it is only to ensure synchronous execution of other software.\n\nTo not block web server for a indefinite period of time, the procedure is provided with a timeout.\nExtending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.\n","responses":{"200":{"description":"Detector in `Idle` state, another data collection can start immediately"},"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"}}}},"/image_pusher/status":{"get":{"summary":"Get status of image pusher","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_pusher_status"}}}},"500":{"description":"Error encountered when trying to read status","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/detector/status":{"get":{"summary":"Get detector status","description":"Status of the JUNGFRAU detector","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_status"}}}},"404":{"description":"Running in \"simulator\" mode - no detector present"},"500":{"description":"Error encountered when trying to read status","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/config/roi":{"get":{"summary":"Get ROI definitions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roi_definitions"}}}}}},"put":{"summary":"Upload ROI definitions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/roi_definitions"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/statistics":{"get":{"summary":"Get general statistics","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jfjoch_statistics"}}}}}}},"/statistics/data_collection":{"get":{"summary":"Get data collection statistics","description":"Results of the last data collection","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/measurement_statistics"}}}},"404":{"description":"No data collection performed so far"}}}},"/statistics/calibration":{"get":{"summary":"Get calibration statistics","description":"Statistics are provided for each module/storage cell separately","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calibration_statistics"}}}}}}},"/config/mask":{"get":{"summary":"Get mask of the detector (binary)","description":"Detector must be Initialized.\nGet full pixel mask of the detector.\nSee NXmx standard for meaning of pixel values.\n","responses":{"200":{"description":"Binary array (4 byte; unsigned)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}},"/config/user_mask":{"get":{"summary":"Detector must be Initialized.\nGet user mask of the detector (binary)\n","description":"Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked","responses":{"200":{"description":"User mask in binary format (4 byte; unsigned)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"summary":"Upload user mask of the detector (binary)","description":"Should be in `Idle` state.\nUpload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.\nIf detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.\nIn the latter case - module gaps are ignored and don't need to be assigned value.\nMask is expected as binary array (4-byte; unsigned).\n0 - good pixel, other value - masked\nUser mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.\n","requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"All good"},"400":{"description":"Mask is not 4-byte unsigned integer array or empty body"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/config/mask.tiff":{"get":{"summary":"Get mask of the detector (TIFF)","description":"Should be in `Idle` state.\nGet full pixel mask of the detector\nSee NXmx standard for meaning of pixel values\n","responses":{"200":{"description":"Pixel mask in TIFF format (4 byte; unsigned)","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}}}}},"/config/user_mask.tiff":{"get":{"summary":"Detector must be Initialized.\nGet user mask of the detector (TIFF)\n","description":"Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked","responses":{"200":{"description":"User mask in TIFF format (4 byte; unsigned)","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"summary":"Upload user mask of the detector","description":"Should be in `Idle` state.\nUpload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.\nIf detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.\nIn the latter case - module gaps are ignored and don't need to be assigned value.\nMask is expected as a single-channel TIFF (8-, 16- or 32-bit integer, signed or unsigned).\n0 - good pixel, other value - masked\nUser mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.\nUser mask is not automatically applied - i.e. pixels with user mask will have a valid pixel value in the images.\n","requestBody":{"content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"All good"},"400":{"description":"Not a valid single-channel TIFF or size doesn't match the detector"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/preview/pedestal.tiff":{"get":{"parameters":[{"in":"query","name":"gain_level","required":true,"schema":{"type":"integer"},"description":"Gain level (0, 1, 2)"},{"in":"query","name":"sc","schema":{"type":"integer"},"description":"Storage cell number"}],"summary":"Get pedestal in TIFF format","responses":{"200":{"description":"Calibration image","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid gain level or storage cell number"},"404":{"description":"No calibration recorded so far"}}}},"/preview/plot":{"get":{"summary":"Generate 1D plot from Jungfraujoch","parameters":[{"$ref":"#/components/parameters/binning"},{"$ref":"#/components/parameters/plot_type"},{"$ref":"#/components/parameters/fill_value"},{"$ref":"#/components/parameters/experimental_coord"},{"$ref":"#/components/parameters/azint_unit"}],"responses":{"200":{"description":"Everything OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/plots"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/preview/plot.bin":{"get":{"summary":"Generate 1D plot from Jungfraujoch and send in raw binary format.\nData are provided as (32-bit) float binary array.\nThis format doesn't transmit information about X-axis, only values, so it is of limited use for azimuthal integration.\n","parameters":[{"$ref":"#/components/parameters/plot_type"},{"$ref":"#/components/parameters/roi"}],"responses":{"200":{"description":"Everything OK.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/result/scan":{"get":{"summary":"Get full scan result","responses":{"200":{"description":"Everything OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scan_result"}}}},"404":{"description":"No grid scan recorded"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/start.cbor":{"get":{"summary":"Get Start message in CBOR format","description":"Contains metadata for a dataset (e.g., experimental geometry)","responses":{"200":{"description":"Return start message","content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No measurement so far"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.cbor":{"get":{"summary":"Get image message in CBOR format","description":"Contains full image data and metadata. The image must come from the latest data collection.","parameters":[{"$ref":"#/components/parameters/image_id"}],"responses":{"200":{"description":"Return image message","content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Image not present in the buffer - either not yet measured or already replaced by a next image."},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.jpeg":{"get":{"summary":"Get preview image in JPEG format using custom settings","parameters":[{"$ref":"#/components/parameters/image_id"},{"$ref":"#/components/parameters/show_user_mask"},{"$ref":"#/components/parameters/show_roi"},{"$ref":"#/components/parameters/show_spots"},{"$ref":"#/components/parameters/show_beam_center"},{"$ref":"#/components/parameters/saturation"},{"$ref":"#/components/parameters/jpeg_quality"},{"$ref":"#/components/parameters/resolution_ring"},{"$ref":"#/components/parameters/color_scale"},{"$ref":"#/components/parameters/resolution_estimate"}],"responses":{"200":{"description":"Preview image","content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"404":{"description":"Image not present in the buffer - either not yet measured or already replaced by a next image."},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.tiff":{"get":{"summary":"Get preview image in TIFF format","parameters":[{"$ref":"#/components/parameters/image_id"}],"responses":{"200":{"description":"Preview image","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No preview image recorded so far"}}}},"/image_buffer/clear":{"post":{"summary":"Clear image buffer","description":"Turns off image buffer for the last data collection. Can be only run when Jungfraujoch is not collecting data.","responses":{"200":{"description":"Done"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/status":{"get":{"summary":"Get status of the image buffers","description":"Can be run at any stage of Jungfraujoch operation, including during data collection.\nThe status of the image buffer is volatile during data collection - if data collection goes for more images than available buffer slots,\nthen image might be replaced in the buffer between calling /images and /image.cbor.\n","responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_buffer_status"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/version":{"get":{"summary":"Get Jungfraujoch version of jfjoch_broker","responses":{"200":{"description":"Release number of Jungfraujoch","content":{"text/plain":{"schema":{"type":"string","example":"1.0.0-rc.25"}}}}}}}}}},"searchIndex":{"store":["section/License-Clarification","/paths/~1initialize/post","/paths/~1pedestal/post","/paths/~1start/post","/paths/~1wait_until_running/post","/paths/~1wait_till_done/post","/paths/~1trigger/post","/paths/~1cancel/post","/paths/~1deactivate/post","/paths/~1config~1detector/put","/paths/~1config~1detector/get","/paths/~1config~1indexing/put","/paths/~1config~1indexing/get","/paths/~1config~1file_writer/put","/paths/~1config~1file_writer/get","/paths/~1config~1instrument/put","/paths/~1config~1instrument/get","/paths/~1config~1image_format/put","/paths/~1config~1image_format/get","/paths/~1config~1image_format~1raw/post","/paths/~1config~1image_format~1conversion/post","/paths/~1config~1spot_finding/put","/paths/~1config~1spot_finding/get","/paths/~1config~1azim_int/put","/paths/~1config~1azim_int/get","/paths/~1config~1internal_generator_image/put","/paths/~1config~1internal_generator_image.tiff/put","/paths/~1config~1select_detector/put","/paths/~1config~1select_detector/get","/paths/~1config~1zeromq_preview/put","/paths/~1config~1zeromq_preview/get","/paths/~1config~1zeromq_metadata/put","/paths/~1config~1zeromq_metadata/get","/paths/~1config~1dark_mask/put","/paths/~1config~1dark_mask/get","/paths/~1status/get","/paths/~1fpga_status/get","/paths/~1xfel~1pulse_id/get","/paths/~1xfel~1event_code/get","/paths/~1image_pusher~1status/get","/paths/~1detector~1status/get","/paths/~1config~1roi/get","/paths/~1config~1roi/put","/paths/~1statistics/get","/paths/~1statistics~1data_collection/get","/paths/~1statistics~1calibration/get","/paths/~1config~1mask/get","/paths/~1config~1user_mask/get","/paths/~1config~1user_mask/put","/paths/~1config~1mask.tiff/get","/paths/~1config~1user_mask.tiff/get","/paths/~1config~1user_mask.tiff/put","/paths/~1preview~1pedestal.tiff/get","/paths/~1preview~1plot/get","/paths/~1preview~1plot.bin/get","/paths/~1result~1scan/get","/paths/~1image_buffer~1start.cbor/get","/paths/~1image_buffer~1image.cbor/get","/paths/~1image_buffer~1image.jpeg/get","/paths/~1image_buffer~1image.tiff/get","/paths/~1image_buffer~1clear/post","/paths/~1image_buffer~1status/get","/paths/~1version/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.076,1,4.719]],["description/0",[0,1.814,2,4.176,3,2.164,4,2.1,5,1.203,6,3.348,7,1.203,8,1.203,9,1.039,10,0.931,11,1.612,12,1.203,13,0.96,14,1.203,15,1.626,16,1.203,17,2.794,18,2.1,19,0.931,20,2.1,21,1.28,22,1.203,23,2.1,24,1.039,25,2.794,26,1.203,27,1.203,28,2.1,29,1.203,30,1.203,31,1.203,32,1.203,33,1.203,34,1.203,35,1.203,36,2.794,37,1.203,38,1.203,39,0.365,40,0.611,41,1.203,42,2.1,43,1.039,44,1.203,45,1.203,46,1.203,47,1.203,48,1.203,49,1.203,50,1.039,51,1.203,52,1.203,53,1.203,54,1.203,55,1.203,56,1.203,57,1.203,58,1.203,59,0.931,60,0.931,61,1.203]],["title/1",[62,2.287,63,0.409,64,0.96,65,1.908]],["description/1",[11,2.207,39,0.962,43,1.696,59,1.52,62,1.196,63,0.5,66,1.963,67,1.389,68,2.029,69,0.898,70,0.945,71,1.52,72,1.696,73,1.389,74,2.997,75,1.963,76,1.52,77,1.696,78,2.741,79,1.196,80,1.963,81,1.963,82,1.696,83,1.389,84,1.284,85,1.963,86,1.963,87,1.696,88,1.696,89,1.284,90,1.284,91,1.52,92,1.284,93,0.595]],["title/2",[63,0.409,94,1.356,95,2.906,96,2.655]],["description/2",[11,1.236,39,0.779,63,0.28,68,1.99,71,1.988,72,2.218,73,1.816,74,1.678,77,2.218,78,2.218,79,1.564,84,1.678,87,2.218,88,2.218,89,1.678,90,1.678,91,1.988,92,1.678,93,0.779,97,2.567,98,1.988,99,2.218,100,0.849,101,1.305,102,2.567,103,2.567,104,2.567,105,2.567,106,1.564,107,2.567]],["title/3",[63,0.515,108,3.653]],["description/3",[11,1.128,39,0.71,60,2.825,63,0.489,64,0.599,65,1.19,67,1.656,89,1.531,90,1.531,92,1.531,100,0.774,101,1.19,108,2.825,109,2.342,110,3.649,111,1.813,112,2.342,113,3.152,114,2.342,115,2.342,116,1.813,117,1.128,118,0.809,119,2.342,120,2.342,121,1.813,122,2.342,123,1.531,124,2.342,125,2.023]],["title/4",[65,2.125,101,2.125,126,3.612]],["description/4",[15,1.988,21,1.564,63,0.28,64,0.657,73,1.816,83,1.816,84,1.678,92,1.678,94,0.927,111,3.032,113,2.218,125,2.218,127,2.218,128,2.218,129,2.218,130,1.236,131,2.218,132,2.218,133,2.218,134,2.218,135,1.988,136,1.678,137,3.383,138,2.218,139,1.988,140,2.218,141,3.383,142,2.218]],["title/5",[65,2.125,93,1.268,126,3.612]],["description/5",[15,1.641,21,1.291,62,1.291,64,0.863,73,1.499,79,1.291,83,2.385,84,1.385,91,1.641,92,2.205,94,1.218,101,1.714,111,2.611,127,1.831,128,1.831,129,1.831,131,1.831,132,1.831,133,1.831,134,1.831,135,1.641,136,1.385,137,2.914,138,1.831,139,1.641,140,1.831,141,2.914,142,1.831,143,1.831,144,1.499,145,2.119,146,1.641,147,2.119,148,2.119]],["title/6",[63,0.409,116,2.906,149,3.243,150,3.243]],["description/6",[13,2.441,116,5.02,150,4.61]],["title/7",[64,0.96,94,1.356,101,1.908,146,2.906]],["description/7",[39,0.643,59,1.641,63,0.231,64,1.075,65,1.077,79,1.291,84,1.385,94,1.218,96,2.385,100,0.701,101,1.077,143,2.914,144,3.387,146,1.641,151,1.831,152,1.291,153,2.119,154,2.611,155,1.831,156,2.119,157,2.119,158,1.831,159,2.119,160,2.119,161,1.641,162,2.119,163,2.119,164,2.119,165,2.119,166,2.119,167,2.119,168,2.119,169,1.641]],["title/8",[63,0.456,170,4.181,171,3.237]],["description/8",[11,1.607,39,1.012,63,0.518,64,0.854,65,1.696,70,1.607,100,1.103,144,2.36,171,3.68,172,4.753,173,3.337,174,3.337,175,3.337,176,3.337,177,3.337,178,3.337]],["title/9",[63,0.456,117,2.013,179,1.912]],["description/9",[39,1.301,63,0.579,68,1.758,69,1.582,70,1.666,71,1.694,74,1.431,76,1.694,79,2.108,83,2.447,89,1.431,93,0.664,94,0.79,98,2.679,100,1.144,117,1.054,118,1.482,135,1.694,169,1.694,180,1.891,181,2.188,182,1.891,183,2.188,184,2.188,185,1.891]],["title/10",[63,0.515,179,2.158]],["description/10",[93,1.686,185,4.802,186,2.99]],["title/11",[117,1.808,118,1.297,187,3.243,188,3.753]],["description/11",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,189,4.117]],["title/12",[179,2.158,187,4.076]],["description/12",[93,1.686,186,2.99,189,4.802]],["title/13",[10,2.906,117,1.808,118,1.297,161,2.906]],["description/13",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,190,4.117]],["title/14",[10,3.237,118,1.444,161,3.237]],["description/14",[93,1.686,186,2.99,190,4.802]],["title/15",[117,2.013,191,3.612,192,2.388]],["description/15",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,193,4.117]],["title/16",[191,4.076,192,2.695]],["description/16",[93,1.686,186,2.99,193,4.802]],["title/17",[117,1.808,194,1.241,195,3.243,196,1.808]],["description/17",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,197,4.117]],["title/18",[194,1.383,195,3.612,196,2.013]],["description/18",[93,1.686,186,2.99,197,4.802]],["title/19",[64,0.871,94,1.23,179,1.557,196,1.64,198,2.408]],["description/19",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,199,4.765]],["title/20",[64,0.797,94,1.125,179,1.425,196,1.501,200,2.037,201,2.413]],["description/20",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,202,4.765]],["title/21",[179,1.912,203,3.237,204,3.237]],["description/21",[64,1.264,93,1.499,94,1.785,101,2.512,186,2.658,205,4.269]],["title/22",[64,1.07,158,3.612,179,1.912]],["description/22",[93,1.686,186,2.99,205,4.802]],["title/23",[106,2.548,179,1.912,206,2.734]],["description/23",[63,0.56,69,2.347,93,1.556,100,1.697,207,4.433]],["title/24",[106,2.548,179,1.912,206,2.734]],["description/24",[93,1.686,186,2.99,207,4.802]],["title/25",[13,1.425,152,1.899,194,1.03,208,2.204,209,1.78,210,2.204]],["description/25",[13,1.387,21,1.848,39,0.92,63,0.572,100,1.003,118,1.048,152,1.848,194,1.003,208,2.146,209,1.733,210,2.146,211,2.621,212,3.033,213,2.621,214,2.349,215,2.621,216,2.621,217,2.621,218,1.848,219,2.621,220,3.033]],["title/26",[13,1.425,152,1.899,194,1.03,208,2.204,210,2.204,221,1.78]],["description/26",[13,1.42,21,1.891,39,0.941,63,0.58,100,1.026,118,1.072,152,1.891,194,1.026,208,2.195,210,2.195,211,2.682,213,2.682,214,2.403,215,2.682,216,2.682,217,2.682,218,1.891,219,2.682,221,1.773,222,3.104]],["title/27",[63,0.515,223,4.076]],["description/27",[21,1.694,24,2.402,39,0.843,50,3.594,63,0.603,69,1.272,89,2.72,117,1.339,118,0.961,130,1.339,136,1.818,144,1.967,224,2.781,225,2.781,226,2.781,227,2.781,228,2.402,229,2.153,230,2.781,231,2.781,232,2.781,233,2.402]],["title/28",[63,0.456,228,3.612,234,3.237]],["description/28",[11,2.471,63,0.56,179,2.347,223,4.433,233,4.433]],["title/29",[118,1.783,235,2.287,236,2.454]],["description/29",[13,1.174,64,0.657,117,1.236,118,1.353,121,3.032,130,1.236,169,1.988,235,1.564,236,2.561,237,1.816,238,2.218,239,2.567,240,3.032,241,2.218,242,2.218,243,2.218,244,1.816,245,2.218,246,2.218,247,3.383,248,1.816,249,3.383,250,2.567,251,2.567,252,2.218]],["title/30",[118,1.444,235,2.548,236,2.734]],["description/30",[252,5.238]],["title/31",[118,1.783,192,2.144,235,2.287]],["description/31",[13,1.299,64,0.727,117,1.368,118,0.981,121,2.199,130,1.368,192,1.622,194,0.939,235,1.73,237,2.009,238,3.651,240,3.272,241,2.453,242,2.453,243,2.453,244,2.009,245,2.453,246,2.453,247,2.453,248,2.009,249,2.453,253,2.84,254,2.84,255,2.453]],["title/32",[118,1.297,192,2.144,235,2.287,240,2.906]],["description/32",[255,5.238]],["title/33",[64,0.735,94,1.037,95,2.224,118,0.992,179,1.314,256,2.481,257,1.136]],["description/33",[39,1.094,63,0.548,69,1.65,70,1.737,74,2.358,93,1.094,100,1.193,139,2.793,234,2.793,258,3.607,259,3.607,260,3.607,261,3.607,262,3.607,263,3.116]],["title/34",[64,0.797,94,1.125,95,2.413,118,1.076,256,2.692,257,1.233]],["description/34",[263,5.238]],["title/35",[130,2.272,264,2.538]],["description/35",[64,1.365,65,2.712,264,3.487]],["title/36",[152,2.548,264,2.249,265,4.181]],["description/36",[266,6.064]],["title/37",[64,0.735,65,1.46,96,2.032,123,1.878,229,2.224,267,2.032,268,2.481]],["description/37",[68,2.188,123,2.814,194,1.423,229,3.333,267,3.045,268,3.719,269,3.045,270,3.333,271,4.305,272,4.305]],["title/38",[19,2.224,64,0.735,65,1.46,96,2.032,123,1.878,267,2.032,273,2.481]],["description/38",[19,3.826,123,3.231,267,3.495,269,3.495,273,4.269,274,4.942]],["title/39",[194,1.383,264,2.249,275,4.181]],["description/39",[276,6.064]],["title/40",[63,0.515,264,2.538]],["description/40",[63,0.582,99,4.61,264,2.87,277,5.337]],["title/41",[3,3.653,278,4.076]],["description/41",[279,5.238]],["title/42",[3,3.237,278,3.612,280,2.734]],["description/42",[279,5.238]],["title/43",[13,2.158,281,3.085]],["description/43",[281,3.965]],["title/44",[64,1.07,94,1.51,281,2.734]],["description/44",[64,1.313,94,1.853,282,4.433,283,4.433,284,5.132]],["title/45",[98,3.653,281,3.085]],["description/45",[82,4.117,136,3.116,281,3.116,285,4.765,286,4.765,287,4.765,288,4.765]],["title/46",[63,0.456,209,2.388,257,1.654]],["description/46",[62,2.392,63,0.58,200,2.566,257,1.553,289,3.242,290,3.391,291,2.776,292,3.391,293,3.391,294,2.566,295,3.925]],["title/47",[40,1.584,62,1.899,63,0.493,209,1.78,257,1.233]],["description/47",[40,1.884,63,0.558,68,2.601,218,2.259,257,2.024,270,2.87,289,3.118,296,3.203,297,2.622,298,2.622,299,3.203]],["title/48",[40,1.731,63,0.371,209,1.945,257,1.347,280,2.226]],["description/48",[11,0.765,39,0.482,40,1.355,63,0.291,67,1.124,68,2.048,90,1.039,100,0.526,106,0.968,154,1.231,198,1.124,201,1.231,203,1.231,204,1.231,206,1.039,209,0.908,218,0.968,248,1.124,257,1.922,269,1.124,280,1.039,289,1.624,291,1.124,294,1.743,297,1.124,298,1.124,299,1.373,300,1.373,301,1.373,302,1.373,303,1.373,304,1.373,305,1.373,306,1.373,307,1.373,308,1.373,309,1.373,310,2.303,311,1.373,312,1.373,313,1.373,314,1.373,315,1.373,316,1.373,317,1.589,318,1.373,319,1.373,320,1.373,321,1.373,322,1.373]],["title/49",[63,0.456,221,2.388,257,1.654]],["description/49",[39,1.191,63,0.428,100,1.298,200,2.566,257,1.553,289,3.242,290,3.391,291,2.776,292,3.391,293,3.391,294,2.566,323,3.925]],["title/50",[40,1.584,62,1.899,63,0.493,221,1.78,257,1.233]],["description/50",[40,1.884,63,0.558,68,2.601,218,2.259,257,2.024,270,2.87,289,3.118,296,3.203,297,2.622,298,2.622,324,3.203]],["title/51",[40,1.908,63,0.409,257,1.485,280,2.454]],["description/51",[9,1.142,11,0.637,39,0.401,40,1.815,63,0.249,67,0.935,68,2.048,90,0.864,100,0.437,106,0.805,154,1.024,180,1.142,182,1.142,194,0.437,198,0.935,201,1.024,203,1.024,204,1.024,206,0.864,214,1.024,218,0.805,221,0.755,248,0.935,257,1.973,280,0.864,289,2.177,291,0.935,294,1.964,297,0.935,298,0.935,300,1.142,301,1.142,302,1.142,303,1.142,304,1.142,305,1.142,306,1.142,307,1.142,308,1.142,309,1.142,310,1.969,311,1.142,312,1.142,313,1.142,314,1.142,315,1.142,316,1.142,318,1.142,319,1.142,320,1.142,321,1.969,322,1.142,324,1.142,325,1.322,326,1.322,327,1.142,328,1.322,329,1.322]],["title/52",[79,2.548,196,2.013,221,2.388]],["description/52",[330,6.064]],["title/53",[13,1.717,130,1.808,331,3.243,332,3.243]],["description/53",[333,6.064]],["title/54",[11,0.594,13,0.564,64,0.315,106,0.751,130,0.594,136,0.806,149,1.065,151,1.065,196,1.033,198,0.872,206,0.806,209,1.225,269,0.872,294,0.806,327,1.065,331,1.065,332,1.065,334,1.232,335,1.232,336,1.232,337,1.232,338,1.232]],["description/54",[339,6.064]],["title/55",[200,2.734,282,3.612,340,4.181]],["description/55",[341,6.064]],["title/56",[108,2.906,196,1.808,237,2.655,342,3.243]],["description/56",[192,2.722,244,3.371,343,4.765,344,4.765,345,4.765,346,4.765,347,4.765]],["title/57",[194,1.241,196,1.808,237,2.655,342,3.243]],["description/57",[64,1.418,94,1.506,192,2.382,194,1.832,200,2.727,244,2.95,348,4.17,349,4.17,350,4.17]],["title/58",[11,1.383,118,0.992,194,0.95,196,1.383,236,1.878,351,2.872,352,2.872]],["description/58",[353,6.064]],["title/59",[194,1.241,196,1.808,221,2.144,236,2.454]],["description/59",[354,6.064]],["title/60",[194,1.383,355,4.181,356,2.957]],["description/60",[64,1.418,94,2.001,101,2.119,130,2.008,171,3.229,194,1.379,283,3.603,356,2.95,357,4.17]],["title/61",[194,1.383,264,2.249,356,2.957]],["description/61",[60,1.95,64,1.201,68,1.28,74,1.647,76,2.989,94,1.695,101,1.28,130,1.213,155,2.176,194,1.74,234,1.95,264,1.355,356,3.319,358,2.519,359,2.519,360,2.519,361,2.519,362,2.519,363,2.519,364,2.519,365,2.519,366,2.519]],["title/62",[130,2.013,367,3.612,368,4.181]],["description/62",[367,5.238]]],"invertedIndex":[["",{"_index":68,"title":{},"description":{"1":{},"2":{},"9":{},"37":{},"47":{},"48":{},"50":{},"51":{},"61":{}}}],["0",{"_index":297,"title":{},"description":{"47":{},"48":{},"50":{},"51":{}}}],["1",{"_index":270,"title":{},"description":{"37":{},"47":{},"50":{}}}],["100",{"_index":107,"title":{},"description":{"2":{}}}],["1024x512",{"_index":308,"title":{},"description":{"48":{},"51":{}}}],["16",{"_index":326,"title":{},"description":{"51":{}}}],["16-bit",{"_index":213,"title":{},"description":{"25":{},"26":{}}}],["1d",{"_index":331,"title":{"53":{},"54":{}},"description":{}}],["32-bit",{"_index":327,"title":{"54":{}},"description":{"51":{}}}],["4-byte",{"_index":317,"title":{},"description":{"48":{}}}],["8",{"_index":321,"title":{},"description":{"48":{},"51":{}}}],["accept",{"_index":114,"title":{},"description":{"3":{}}}],["account",{"_index":301,"title":{},"description":{"48":{},"51":{}}}],["acquisit",{"_index":65,"title":{"1":{},"4":{},"5":{},"37":{},"38":{}},"description":{"3":{},"7":{},"8":{},"35":{}}}],["actual",{"_index":296,"title":{},"description":{"47":{},"50":{}}}],["adjust",{"_index":242,"title":{},"description":{"29":{},"31":{}}}],["affect",{"_index":145,"title":{},"description":{"5":{}}}],["again",{"_index":181,"title":{},"description":{"9":{}}}],["algorithm",{"_index":188,"title":{"11":{}},"description":{}}],["allow",{"_index":50,"title":{},"description":{"0":{},"27":{}}}],["alway",{"_index":176,"title":{},"description":{"8":{}}}],["and/or",{"_index":226,"title":{},"description":{"27":{}}}],["anytim",{"_index":186,"title":{},"description":{"10":{},"12":{},"14":{},"16":{},"18":{},"21":{},"22":{},"24":{}}}],["api",{"_index":2,"title":{},"description":{"0":{}}}],["appli",{"_index":9,"title":{},"description":{"0":{},"51":{}}}],["applic",{"_index":17,"title":{},"description":{"0":{}}}],["approach",{"_index":30,"title":{},"description":{"0":{}}}],["array",{"_index":269,"title":{"54":{}},"description":{"37":{},"38":{},"48":{}}}],["asic",{"_index":175,"title":{},"description":{"8":{}}}],["assign",{"_index":315,"title":{},"description":{"48":{},"51":{}}}],["async",{"_index":87,"title":{},"description":{"1":{},"2":{}}}],["async_start",{"_index":119,"title":{},"description":{"3":{}}}],["automat",{"_index":182,"title":{},"description":{"9":{},"51":{}}}],["avail",{"_index":234,"title":{"28":{}},"description":{"33":{},"61":{}}}],["azimuth",{"_index":206,"title":{"23":{},"24":{},"54":{}},"description":{"48":{},"51":{}}}],["back",{"_index":168,"title":{},"description":{"7":{}}}],["base",{"_index":251,"title":{},"description":{"29":{}}}],["be",{"_index":157,"title":{},"description":{"7":{}}}],["beam",{"_index":302,"title":{},"description":{"48":{},"51":{}}}],["befor",{"_index":177,"title":{},"description":{"8":{}}}],["behavior",{"_index":110,"title":{},"description":{"3":{}}}],["between",{"_index":364,"title":{},"description":{"61":{}}}],["binari",{"_index":209,"title":{"25":{},"46":{},"47":{},"48":{},"54":{}},"description":{"25":{},"48":{}}}],["bit",{"_index":320,"title":{},"description":{"48":{},"51":{}}}],["blob",{"_index":212,"title":{},"description":{"25":{}}}],["block",{"_index":111,"title":{},"description":{"3":{},"4":{},"5":{}}}],["bodi",{"_index":122,"title":{},"description":{"3":{}}}],["both",{"_index":307,"title":{},"description":{"48":{},"51":{}}}],["buffer",{"_index":356,"title":{"60":{},"61":{}},"description":{"60":{},"61":{}}}],["calcul",{"_index":256,"title":{"33":{},"34":{}},"description":{}}],["calibr",{"_index":98,"title":{"45":{}},"description":{"2":{},"9":{}}}],["call",{"_index":60,"title":{},"description":{"0":{},"3":{},"61":{}}}],["cancel",{"_index":146,"title":{"7":{}},"description":{"5":{},"7":{}}}],["card",{"_index":153,"title":{},"description":{"7":{}}}],["case",{"_index":67,"title":{},"description":{"1":{},"3":{},"48":{},"51":{}}}],["cbor",{"_index":342,"title":{"56":{},"57":{}},"description":{}}],["cell",{"_index":82,"title":{},"description":{"1":{},"45":{}}}],["chang",{"_index":117,"title":{"9":{},"11":{},"13":{},"15":{},"17":{}},"description":{"3":{},"9":{},"27":{},"29":{},"31":{}}}],["choos",{"_index":24,"title":{},"description":{"0":{},"27":{}}}],["clarif",{"_index":1,"title":{"0":{}},"description":{}}],["clear",{"_index":355,"title":{"60":{}},"description":{}}],["client",{"_index":15,"title":{},"description":{"0":{},"4":{},"5":{}}}],["close",{"_index":73,"title":{},"description":{"1":{},"2":{},"4":{},"5":{}}}],["code",{"_index":19,"title":{"38":{}},"description":{"0":{},"38":{}}}],["collect",{"_index":94,"title":{"2":{},"7":{},"19":{},"20":{},"33":{},"34":{},"44":{}},"description":{"4":{},"5":{},"7":{},"9":{},"21":{},"44":{},"57":{},"60":{},"61":{}}}],["come",{"_index":348,"title":{},"description":{"57":{}}}],["command",{"_index":144,"title":{},"description":{"5":{},"7":{},"8":{},"27":{}}}],["commun",{"_index":57,"title":{},"description":{"0":{}}}],["config/azim_int",{"_index":207,"title":{},"description":{"23":{},"24":{}}}],["config/dark_mask",{"_index":263,"title":{},"description":{"33":{},"34":{}}}],["config/detector",{"_index":185,"title":{},"description":{"9":{},"10":{}}}],["config/file_writ",{"_index":190,"title":{},"description":{"13":{},"14":{}}}],["config/image_format",{"_index":197,"title":{},"description":{"17":{},"18":{}}}],["config/image_format/convers",{"_index":202,"title":{},"description":{"20":{}}}],["config/image_format/raw",{"_index":199,"title":{},"description":{"19":{}}}],["config/index",{"_index":189,"title":{},"description":{"11":{},"12":{}}}],["config/instru",{"_index":193,"title":{},"description":{"15":{},"16":{}}}],["config/internal_generator_imag",{"_index":220,"title":{},"description":{"25":{}}}],["config/internal_generator_image.tiff",{"_index":222,"title":{},"description":{"26":{}}}],["config/mask",{"_index":295,"title":{},"description":{"46":{}}}],["config/mask.tiff",{"_index":323,"title":{},"description":{"49":{}}}],["config/roi",{"_index":279,"title":{},"description":{"41":{},"42":{}}}],["config/select_detector",{"_index":233,"title":{},"description":{"27":{},"28":{}}}],["config/spot_find",{"_index":205,"title":{},"description":{"21":{},"22":{}}}],["config/user_mask",{"_index":299,"title":{},"description":{"47":{},"48":{}}}],["config/user_mask.tiff",{"_index":324,"title":{},"description":{"50":{},"51":{}}}],["config/zeromq_metadata",{"_index":255,"title":{},"description":{"31":{},"32":{}}}],["config/zeromq_preview",{"_index":252,"title":{},"description":{"29":{},"30":{}}}],["configur",{"_index":179,"title":{"9":{},"10":{},"12":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"33":{}},"description":{"28":{}}}],["connect",{"_index":141,"title":{},"description":{"4":{},"5":{}}}],["consist",{"_index":230,"title":{},"description":{"27":{}}}],["contain",{"_index":244,"title":{},"description":{"29":{},"31":{},"56":{},"57":{}}}],["control",{"_index":224,"title":{},"description":{"27":{}}}],["convers",{"_index":201,"title":{"20":{}},"description":{"48":{},"51":{}}}],["convert",{"_index":311,"title":{},"description":{"48":{},"51":{}}}],["coordin",{"_index":218,"title":{},"description":{"25":{},"26":{},"47":{},"48":{},"50":{},"51":{}}}],["copyleft",{"_index":7,"title":{},"description":{"0":{}}}],["cover",{"_index":254,"title":{},"description":{"31":{}}}],["cpu",{"_index":159,"title":{},"description":{"7":{}}}],["current",{"_index":96,"title":{"2":{},"37":{},"38":{}},"description":{"7":{}}}],["custom",{"_index":352,"title":{"58":{}},"description":{}}],["dark",{"_index":95,"title":{"2":{},"33":{},"34":{}},"description":{}}],["data",{"_index":64,"title":{"1":{},"7":{},"19":{},"20":{},"22":{},"33":{},"34":{},"37":{},"38":{},"44":{},"54":{}},"description":{"3":{},"4":{},"5":{},"7":{},"8":{},"21":{},"29":{},"31":{},"35":{},"44":{},"57":{},"60":{},"61":{}}}],["dataset",{"_index":343,"title":{},"description":{"56":{}}}],["deactiv",{"_index":172,"title":{},"description":{"8":{}}}],["dectri",{"_index":258,"title":{},"description":{"33":{}}}],["default",{"_index":109,"title":{},"description":{"3":{}}}],["definit",{"_index":3,"title":{"41":{},"42":{}},"description":{"0":{}}}],["depend",{"_index":219,"title":{},"description":{"25":{},"26":{}}}],["deriv",{"_index":47,"title":{},"description":{"0":{}}}],["detector",{"_index":63,"title":{"1":{},"2":{},"3":{},"6":{},"8":{},"9":{},"10":{},"27":{},"28":{},"40":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}},"description":{"1":{},"2":{},"3":{},"4":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"23":{},"25":{},"26":{},"27":{},"28":{},"33":{},"40":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}}}],["detector/statu",{"_index":277,"title":{},"description":{"40":{}}}],["develop",{"_index":37,"title":{},"description":{"0":{}}}],["devic",{"_index":265,"title":{"36":{}},"description":{}}],["distribut",{"_index":22,"title":{},"description":{"0":{}}}],["doesn't",{"_index":335,"title":{"54":{}},"description":{}}],["don't",{"_index":314,"title":{},"description":{"48":{},"51":{}}}],["done",{"_index":93,"title":{"5":{}},"description":{"1":{},"2":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"33":{}}}],["dure",{"_index":76,"title":{},"description":{"1":{},"9":{},"61":{}}}],["e.g",{"_index":344,"title":{},"description":{"56":{}}}],["each",{"_index":285,"title":{},"description":{"45":{}}}],["effect",{"_index":169,"title":{},"description":{"7":{},"9":{},"29":{}}}],["eiger",{"_index":261,"title":{},"description":{"33":{}}}],["ensur",{"_index":92,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{}}}],["error",{"_index":70,"title":{},"description":{"1":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"33":{}}}],["etc",{"_index":46,"title":{},"description":{"0":{}}}],["event",{"_index":273,"title":{"38":{}},"description":{"38":{}}}],["exampl",{"_index":300,"title":{},"description":{"48":{},"51":{}}}],["except",{"_index":25,"title":{},"description":{"0":{}}}],["execut",{"_index":83,"title":{},"description":{"1":{},"4":{},"5":{},"9":{}}}],["expect",{"_index":316,"title":{},"description":{"48":{},"51":{}}}],["experiment",{"_index":345,"title":{},"description":{"56":{}}}],["explicitli",{"_index":38,"title":{},"description":{"0":{}}}],["extend",{"_index":138,"title":{},"description":{"4":{},"5":{}}}],["extern",{"_index":127,"title":{},"description":{"4":{},"5":{}}}],["few",{"_index":85,"title":{},"description":{"1":{}}}],["file",{"_index":10,"title":{"13":{},"14":{}},"description":{"0":{}}}],["find",{"_index":204,"title":{"21":{}},"description":{"48":{},"51":{}}}],["finish",{"_index":143,"title":{},"description":{"5":{},"7":{}}}],["float",{"_index":334,"title":{"54":{}},"description":{}}],["format",{"_index":196,"title":{"17":{},"18":{},"19":{},"20":{},"52":{},"54":{},"56":{},"57":{},"58":{},"59":{}},"description":{}}],["fpga",{"_index":152,"title":{"25":{},"26":{},"36":{}},"description":{"7":{},"25":{},"26":{}}}],["fpga_statu",{"_index":266,"title":{},"description":{"36":{}}}],["frame",{"_index":156,"title":{},"description":{"7":{}}}],["full",{"_index":200,"title":{"20":{},"55":{}},"description":{"46":{},"49":{},"57":{}}}],["function",{"_index":88,"title":{},"description":{"1":{},"2":{}}}],["gap",{"_index":313,"title":{},"description":{"48":{},"51":{}}}],["gcc",{"_index":33,"title":{},"description":{"0":{}}}],["gener",{"_index":13,"title":{"25":{},"26":{},"43":{},"53":{},"54":{}},"description":{"0":{},"6":{},"25":{},"26":{},"29":{},"31":{}}}],["geometri",{"_index":346,"title":{},"description":{"56":{}}}],["given",{"_index":162,"title":{},"description":{"7":{}}}],["goe",{"_index":360,"title":{},"description":{"61":{}}}],["good",{"_index":298,"title":{},"description":{"47":{},"48":{},"50":{},"51":{}}}],["gpl",{"_index":6,"title":{},"description":{"0":{}}}],["gpl-3.0",{"_index":5,"title":{},"description":{"0":{}}}],["gracefulli",{"_index":165,"title":{},"description":{"7":{}}}],["happen",{"_index":211,"title":{},"description":{"25":{},"26":{}}}],["header",{"_index":32,"title":{},"description":{"0":{}}}],["here",{"_index":241,"title":{},"description":{"29":{},"31":{}}}],["high",{"_index":173,"title":{},"description":{"8":{}}}],["hour",{"_index":104,"title":{},"description":{"2":{}}}],["http",{"_index":247,"title":{},"description":{"29":{},"31":{}}}],["i.",{"_index":180,"title":{},"description":{"9":{},"51":{}}}],["id",{"_index":229,"title":{"37":{}},"description":{"27":{},"37":{}}}],["idl",{"_index":100,"title":{},"description":{"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"23":{},"25":{},"26":{},"33":{},"48":{},"49":{},"51":{}}}],["ignor",{"_index":248,"title":{},"description":{"29":{},"31":{},"48":{},"51":{}}}],["imag",{"_index":194,"title":{"17":{},"18":{},"25":{},"26":{},"39":{},"57":{},"58":{},"59":{},"60":{},"61":{}},"description":{"25":{},"26":{},"31":{},"37":{},"51":{},"57":{},"60":{},"61":{}}}],["image.cbor",{"_index":365,"title":{},"description":{"61":{}}}],["image_buffer/clear",{"_index":357,"title":{},"description":{"60":{}}}],["image_buffer/image.cbor",{"_index":350,"title":{},"description":{"57":{}}}],["image_buffer/image.jpeg",{"_index":353,"title":{},"description":{"58":{}}}],["image_buffer/image.tiff",{"_index":354,"title":{},"description":{"59":{}}}],["image_buffer/start.cbor",{"_index":347,"title":{},"description":{"56":{}}}],["image_buffer/statu",{"_index":366,"title":{},"description":{"61":{}}}],["image_pusher/statu",{"_index":276,"title":{},"description":{"39":{}}}],["immedi",{"_index":124,"title":{},"description":{"3":{}}}],["implement",{"_index":16,"title":{},"description":{"0":{}}}],["impos",{"_index":54,"title":{},"description":{"0":{}}}],["inact",{"_index":69,"title":{},"description":{"1":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"23":{},"27":{},"33":{}}}],["includ",{"_index":358,"title":{},"description":{"61":{}}}],["indefinit",{"_index":133,"title":{},"description":{"4":{},"5":{}}}],["index",{"_index":187,"title":{"11":{},"12":{}},"description":{}}],["inform",{"_index":151,"title":{"54":{}},"description":{"7":{}}}],["initi",{"_index":62,"title":{"1":{},"47":{},"50":{}},"description":{"1":{},"5":{},"46":{}}}],["instead",{"_index":80,"title":{},"description":{"1":{}}}],["instrument",{"_index":191,"title":{"15":{},"16":{}},"description":{}}],["integ",{"_index":214,"title":{},"description":{"25":{},"26":{},"51":{}}}],["integr",{"_index":106,"title":{"23":{},"24":{},"54":{}},"description":{"2":{},"48":{},"51":{}}}],["intend",{"_index":49,"title":{},"description":{"0":{}}}],["interact",{"_index":18,"title":{},"description":{"0":{}}}],["interfac",{"_index":43,"title":{},"description":{"0":{},"1":{}}}],["intern",{"_index":210,"title":{"25":{},"26":{}},"description":{"25":{},"26":{}}}],["ioctl",{"_index":45,"title":{},"description":{"0":{}}}],["jfjoch_brok",{"_index":368,"title":{"62":{}},"description":{}}],["jpeg",{"_index":351,"title":{"58":{}},"description":{}}],["jungfrau",{"_index":99,"title":{},"description":{"2":{},"40":{}}}],["jungfraujoch",{"_index":130,"title":{"35":{},"53":{},"54":{},"62":{}},"description":{"4":{},"27":{},"29":{},"31":{},"60":{},"61":{}}}],["kernel",{"_index":36,"title":{},"description":{"0":{}}}],["kernel'",{"_index":29,"title":{},"description":{"0":{}}}],["last",{"_index":283,"title":{},"description":{"44":{},"60":{}}}],["latest",{"_index":349,"title":{},"description":{"57":{}}}],["latter",{"_index":312,"title":{},"description":{"48":{},"51":{}}}],["librari",{"_index":35,"title":{},"description":{"0":{}}}],["licens",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["limit",{"_index":338,"title":{"54":{}},"description":{}}],["linux",{"_index":28,"title":{},"description":{"0":{}}}],["list",{"_index":228,"title":{"28":{}},"description":{"27":{}}}],["load",{"_index":208,"title":{"25":{},"26":{}},"description":{"25":{},"26":{}}}],["long",{"_index":105,"title":{},"description":{"2":{}}}],["make",{"_index":163,"title":{},"description":{"7":{}}}],["mask",{"_index":257,"title":{"33":{},"34":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}},"description":{"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}}}],["mean",{"_index":293,"title":{},"description":{"46":{},"49":{}}}],["mechan",{"_index":61,"title":{},"description":{"0":{}}}],["mere",{"_index":42,"title":{},"description":{"0":{}}}],["messag",{"_index":237,"title":{"56":{},"57":{}},"description":{"29":{},"31":{}}}],["metadata",{"_index":192,"title":{"15":{},"16":{},"31":{},"32":{}},"description":{"31":{},"56":{},"57":{}}}],["minut",{"_index":86,"title":{},"description":{"1":{}}}],["misbehav",{"_index":304,"title":{},"description":{"48":{},"51":{}}}],["mode",{"_index":306,"title":{},"description":{"48":{},"51":{}}}],["modul",{"_index":310,"title":{},"description":{"48":{},"51":{}}}],["module/storag",{"_index":286,"title":{},"description":{"45":{}}}],["moment",{"_index":259,"title":{},"description":{"33":{}}}],["more",{"_index":361,"title":{},"description":{"61":{}}}],["multipl",{"_index":225,"title":{},"description":{"27":{}}}],["need",{"_index":90,"title":{},"description":{"1":{},"2":{},"3":{},"48":{},"51":{}}}],["network",{"_index":59,"title":{},"description":{"0":{},"1":{},"7":{}}}],["new",{"_index":183,"title":{},"description":{"9":{}}}],["number",{"_index":215,"title":{},"description":{"25":{},"26":{}}}],["nxmx",{"_index":291,"title":{},"description":{"46":{},"48":{},"49":{},"51":{}}}],["on",{"_index":89,"title":{},"description":{"1":{},"2":{},"3":{},"9":{},"27":{}}}],["onc",{"_index":102,"title":{},"description":{"2":{}}}],["openapi",{"_index":14,"title":{},"description":{"0":{}}}],["oper",{"_index":74,"title":{},"description":{"1":{},"2":{},"9":{},"33":{},"61":{}}}],["option",{"_index":250,"title":{},"description":{"29":{}}}],["output",{"_index":195,"title":{"17":{},"18":{}},"description":{}}],["pedest",{"_index":79,"title":{"52":{}},"description":{"1":{},"2":{},"5":{},"7":{},"9":{}}}],["per",{"_index":103,"title":{},"description":{"2":{}}}],["period",{"_index":134,"title":{},"description":{"4":{},"5":{}}}],["pixel",{"_index":289,"title":{},"description":{"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}}}],["plot",{"_index":332,"title":{"53":{},"54":{}},"description":{}}],["point",{"_index":262,"title":{},"description":{"33":{}}}],["possibl",{"_index":139,"title":{},"description":{"4":{},"5":{},"33":{}}}],["post",{"_index":78,"title":{},"description":{"1":{},"2":{}}}],["power",{"_index":178,"title":{},"description":{"8":{}}}],["prepar",{"_index":170,"title":{"8":{}},"description":{}}],["preview",{"_index":236,"title":{"29":{},"30":{},"58":{},"59":{}},"description":{"29":{}}}],["preview/pedestal.tiff",{"_index":330,"title":{},"description":{"52":{}}}],["preview/plot",{"_index":333,"title":{},"description":{"53":{}}}],["preview/plot.bin",{"_index":339,"title":{},"description":{"54":{}}}],["procedur",{"_index":135,"title":{},"description":{"4":{},"5":{},"9":{}}}],["process",{"_index":158,"title":{"22":{}},"description":{"7":{}}}],["program",{"_index":41,"title":{},"description":{"0":{}}}],["provid",{"_index":136,"title":{"54":{}},"description":{"4":{},"5":{},"27":{},"45":{}}}],["provis",{"_index":8,"title":{},"description":{"0":{}}}],["psi",{"_index":260,"title":{},"description":{"33":{}}}],["pub",{"_index":253,"title":{},"description":{"31":{}}}],["puls",{"_index":268,"title":{"37":{}},"description":{"37":{}}}],["pusher",{"_index":275,"title":{"39":{}},"description":{}}],["put",{"_index":249,"title":{},"description":{"29":{},"31":{}}}],["raw",{"_index":198,"title":{"19":{},"54":{}},"description":{"48":{},"51":{}}}],["raw/convert",{"_index":217,"title":{},"description":{"25":{},"26":{}}}],["readi",{"_index":113,"title":{},"description":{"3":{},"4":{}}}],["recommend",{"_index":77,"title":{},"description":{"1":{},"2":{}}}],["reconfigur",{"_index":75,"title":{},"description":{"1":{}}}],["record",{"_index":271,"title":{},"description":{"37":{}}}],["regardless",{"_index":55,"title":{},"description":{"0":{}}}],["region",{"_index":305,"title":{},"description":{"48":{},"51":{}}}],["region-of-interest",{"_index":227,"title":{},"description":{"27":{}}}],["reiniti",{"_index":232,"title":{},"description":{"27":{}}}],["replac",{"_index":363,"title":{},"description":{"61":{}}}],["request",{"_index":121,"title":{},"description":{"3":{},"29":{},"31":{}}}],["requir",{"_index":21,"title":{},"description":{"0":{},"4":{},"5":{},"25":{},"26":{},"27":{}}}],["respons",{"_index":231,"title":{},"description":{"27":{}}}],["result",{"_index":282,"title":{"55":{}},"description":{"44":{}}}],["result/scan",{"_index":341,"title":{},"description":{"55":{}}}],["retri",{"_index":142,"title":{},"description":{"4":{},"5":{}}}],["return",{"_index":123,"title":{"37":{},"38":{}},"description":{"3":{},"37":{},"38":{}}}],["roi",{"_index":278,"title":{"41":{},"42":{}},"description":{}}],["run",{"_index":101,"title":{"4":{},"7":{}},"description":{"2":{},"3":{},"5":{},"7":{},"21":{},"60":{},"61":{}}}],["runtim",{"_index":34,"title":{},"description":{"0":{}}}],["safeti",{"_index":140,"title":{},"description":{"4":{},"5":{}}}],["save",{"_index":184,"title":{},"description":{"9":{}}}],["scan",{"_index":340,"title":{"55":{}},"description":{}}],["script",{"_index":128,"title":{},"description":{"4":{},"5":{}}}],["see",{"_index":290,"title":{},"description":{"46":{},"49":{}}}],["select",{"_index":223,"title":{"27":{}},"description":{"28":{}}}],["send",{"_index":149,"title":{"6":{},"54":{}},"description":{}}],["sent",{"_index":160,"title":{},"description":{"7":{}}}],["separ",{"_index":287,"title":{},"description":{"45":{}}}],["server",{"_index":132,"title":{},"description":{"4":{},"5":{}}}],["set",{"_index":118,"title":{"11":{},"13":{},"14":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"58":{}},"description":{"3":{},"9":{},"25":{},"26":{},"27":{},"29":{},"31":{}}}],["shadow",{"_index":303,"title":{},"description":{"48":{},"51":{}}}],["shutter",{"_index":72,"title":{},"description":{"1":{},"2":{}}}],["sign",{"_index":328,"title":{},"description":{"51":{}}}],["similar",{"_index":26,"title":{},"description":{"0":{}}}],["single-channel",{"_index":325,"title":{},"description":{"51":{}}}],["size",{"_index":216,"title":{},"description":{"25":{},"26":{}}}],["slot",{"_index":362,"title":{},"description":{"61":{}}}],["socket",{"_index":240,"title":{"32":{}},"description":{"29":{},"31":{}}}],["socket_address",{"_index":245,"title":{},"description":{"29":{},"31":{}}}],["soft",{"_index":150,"title":{"6":{}},"description":{"6":{}}}],["soft/ttl",{"_index":115,"title":{},"description":{"3":{}}}],["softwar",{"_index":148,"title":{},"description":{"5":{}}}],["sole",{"_index":12,"title":{},"description":{"0":{}}}],["specif",{"_index":52,"title":{},"description":{"0":{}}}],["spirit",{"_index":27,"title":{},"description":{"0":{}}}],["spot",{"_index":203,"title":{"21":{}},"description":{"48":{},"51":{}}}],["stack",{"_index":309,"title":{},"description":{"48":{},"51":{}}}],["stage",{"_index":155,"title":{},"description":{"7":{},"61":{}}}],["standard",{"_index":292,"title":{},"description":{"46":{},"49":{}}}],["start",{"_index":108,"title":{"3":{},"56":{}},"description":{"3":{}}}],["state",{"_index":39,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"25":{},"26":{},"27":{},"33":{},"48":{},"49":{},"51":{}}}],["statist",{"_index":281,"title":{"43":{},"44":{},"45":{}},"description":{"43":{},"45":{}}}],["statistics/calibr",{"_index":288,"title":{},"description":{"45":{}}}],["statistics/data_collect",{"_index":284,"title":{},"description":{"44":{}}}],["statu",{"_index":264,"title":{"35":{},"36":{},"39":{},"40":{},"61":{}},"description":{"35":{},"40":{},"61":{}}}],["stop",{"_index":154,"title":{},"description":{"7":{},"48":{},"51":{}}}],["storag",{"_index":81,"title":{},"description":{"1":{}}}],["store",{"_index":319,"title":{},"description":{"48":{},"51":{}}}],["stream",{"_index":238,"title":{},"description":{"29":{},"31":{}}}],["structur",{"_index":243,"title":{},"description":{"29":{},"31":{}}}],["sub",{"_index":239,"title":{},"description":{"29":{}}}],["subject",{"_index":20,"title":{},"description":{"0":{}}}],["sure",{"_index":164,"title":{},"description":{"7":{}}}],["switch",{"_index":167,"title":{},"description":{"7":{}}}],["synchron",{"_index":147,"title":{},"description":{"5":{}}}],["syscal",{"_index":44,"title":{},"description":{"0":{}}}],["take",{"_index":166,"title":{},"description":{"7":{}}}],["term",{"_index":23,"title":{},"description":{"0":{}}}],["through",{"_index":58,"title":{},"description":{"0":{}}}],["tiff",{"_index":221,"title":{"26":{},"49":{},"50":{},"52":{},"59":{}},"description":{"26":{},"51":{}}}],["till",{"_index":129,"title":{},"description":{"4":{},"5":{}}}],["time",{"_index":84,"title":{},"description":{"1":{},"2":{},"4":{},"5":{},"7":{}}}],["timeout",{"_index":137,"title":{},"description":{"4":{},"5":{}}}],["transmit",{"_index":336,"title":{"54":{}},"description":{}}],["trigger",{"_index":116,"title":{"6":{}},"description":{"3":{},"6":{}}}],["true",{"_index":120,"title":{},"description":{"3":{}}}],["turn",{"_index":171,"title":{"8":{}},"description":{"8":{},"60":{}}}],["two",{"_index":66,"title":{},"description":{"1":{}}}],["under",{"_index":4,"title":{},"description":{"0":{}}}],["unsign",{"_index":318,"title":{},"description":{"48":{},"51":{}}}],["until",{"_index":112,"title":{},"description":{"3":{}}}],["updat",{"_index":97,"title":{},"description":{"2":{}}}],["upload",{"_index":280,"title":{"42":{},"48":{},"51":{}},"description":{"48":{},"51":{}}}],["us",{"_index":11,"title":{"54":{},"58":{}},"description":{"0":{},"1":{},"2":{},"3":{},"8":{},"28":{},"48":{},"51":{}}}],["user",{"_index":40,"title":{"47":{},"48":{},"50":{},"51":{}},"description":{"0":{},"47":{},"48":{},"50":{},"51":{}}}],["userspac",{"_index":31,"title":{},"description":{"0":{}}}],["valid",{"_index":329,"title":{},"description":{"51":{}}}],["valu",{"_index":294,"title":{"54":{}},"description":{"46":{},"48":{},"49":{},"51":{}}}],["version",{"_index":367,"title":{"62":{}},"description":{"62":{}}}],["via",{"_index":246,"title":{},"description":{"29":{},"31":{}}}],["volatil",{"_index":359,"title":{},"description":{"61":{}}}],["voltag",{"_index":174,"title":{},"description":{"8":{}}}],["wait",{"_index":126,"title":{"4":{},"5":{}},"description":{}}],["wait_till_don",{"_index":91,"title":{},"description":{"1":{},"2":{},"5":{}}}],["wait_until_run",{"_index":125,"title":{},"description":{"3":{},"4":{}}}],["web",{"_index":131,"title":{},"description":{"4":{},"5":{}}}],["well",{"_index":322,"title":{},"description":{"48":{},"51":{}}}],["whether",{"_index":56,"title":{},"description":{"0":{}}}],["wider",{"_index":51,"title":{},"description":{"0":{}}}],["without",{"_index":53,"title":{},"description":{"0":{}}}],["work",{"_index":48,"title":{},"description":{"0":{}}}],["writer",{"_index":161,"title":{"13":{},"14":{}},"description":{"7":{}}}],["x-axi",{"_index":337,"title":{"54":{}},"description":{}}],["x-ray",{"_index":71,"title":{},"description":{"1":{},"2":{},"9":{}}}],["xfel",{"_index":267,"title":{"37":{},"38":{}},"description":{"37":{},"38":{}}}],["xfel/event_cod",{"_index":274,"title":{},"description":{"38":{}}}],["xfel/pulse_id",{"_index":272,"title":{},"description":{"37":{}}}],["zeromq",{"_index":235,"title":{"29":{},"30":{},"31":{},"32":{}},"description":{"29":{},"31":{}}}]],"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.153","contact":{"name":"Filip Leonarski (Paul Scherrer Institute)","email":"filip.leonarski@psi.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.html"}},"servers":[{"url":"http://localhost:5232","description":"Test Jungfraujoch system"}],"components":{"parameters":{"binning":{"in":"query","name":"binning","required":false,"schema":{"default":1,"type":"integer"},"description":"Binning of frames for the plot (0 = default binning)"},"experimental_coord":{"in":"query","name":"experimental_coord","required":false,"schema":{"type":"boolean","default":false},"description":"If measurement has goniometer axis defined, plot X-axis will represent rotation angle\nIf measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value\nFor still measurement the number is ignored\n"},"azint_unit":{"in":"query","name":"azint_unit","required":false,"schema":{"type":"string","enum":["Q_recipA","d_A","two_theta_deg"],"default":"Q_recipA"},"description":"Unit used for azim int.\n"},"fill_value":{"in":"query","name":"fill","required":false,"schema":{"type":"number","format":"float"},"description":"Fill value for elements that were missed during data collection\n"},"plot_type":{"in":"query","name":"type","required":true,"description":"Type of requested plot","schema":{"type":"string","enum":["bkg_estimate","azint","azint_1d","spot_count","spot_count_low_res","spot_count_indexed","spot_count_ice","indexing_rate","indexing_lattice_count","indexing_unit_cell_length","indexing_unit_cell_angle","profile_radius","mosaicity","b_factor","error_pixels","saturated_pixels","image_collection_efficiency","receiver_delay","receiver_free_send_buf","strong_pixels","roi_sum","roi_mean","roi_max_count","roi_pixels","roi_weighted_x","roi_weighted_y","packets_received","max_pixel_value","resolution_estimate","pixel_sum","processing_time","beam_center_x","beam_center_y","integrated_reflections","image_scale_factor","image_scale_cc","image_scale_b","compression_ratio"]}},"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","schema":{"type":"string","enum":["indigo","viridis","bw","wb","green","heat","magma","inferno"],"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 least-square diffraction geometry refinement algorithm used by Jungfraujoch.\nBeamCenter - This option is refining both beam center and lattice (restricted to a chosen/detected Bravais lattice).\nOrientationOnly - This option is refining only orientation of the lattice.\n","enum":["BeamCenter","OrientationOnly","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/user of the HDF5 file. \nThis applies solely to string and number (double floating-point). No arrays/sub-objects is allowed.\nFor example {\"hdf5\": {\"val1\":1, \"val2\":\"xyz\"}}, will write /entry/user/val1 and /entry/user/val2.\n"},"image_appendix":{"description":"Image appendix, added as user_data to image ZeroMQ message (can be any valid JSON)\nNot saved in HDF5 file\n"},"data_reduction_factor_serialmx":{"type":"number","format":"float","default":1,"minimum":0,"maximum":1,"description":"Rate at which non-indexed images are accepted to be forwarded to writer. \nValue of 1.0 (default) means that all images are written.\nValues below zero mean that non-indexed images will be accepted with a given probability.\n"},"pixel_value_low_threshold":{"type":"integer","format":"int64","minimum":0,"description":"Set all counts lower than the value to zero. \nWhen the value is set, negative numbers other than error pixel value are always set to zero.\nSetting to zero is equivalent to turning the option off.\n"},"run_number":{"type":"integer","format":"int64","minimum":0,"description":"Number of run within an experimental session. \nTransferred over CBOR stream as \"series ID\", though not saved in HDF5 file.\nIt is highly recommended to keep this number unique for each data collection during experimental series.\nIf not provided, the number will be automatically incremented.\n"},"run_name":{"type":"string","description":"Unique ID of run.\nTransferred over CBOR stream as \"unique series ID\", though not saved in HDF5 file.\nIt is highly recommended to keep this name unique for each data collection during experimental series.\nIf not provided, the name will be automatically generated as number + colon + file_prefix.\n"},"experiment_group":{"type":"string","description":"Name of group owning the data (e.g. p-group or proposal number). \nTransferred over CBOR stream, though not saved in HDF5 file.\n"},"poisson_compression":{"type":"integer","format":"int64","minimum":0,"maximum":16,"description":"Enable lossy compression of pixel values that preserves Poisson statistics. \nRequires to provide a numerical factor SQ.\nPixel value P will be transformed to round(sqrt(P) * SQ), with rounding to the closest integer.\nCompression is turned off if the value is missing or it is set to zero.\n"},"write_nxmx_hdf5_master":{"type":"boolean","default":true,"description":"Write NXmx formatted HDF5 master file. Recommended to use for macromolecular crystallography experiments\nand to turn off for other experiments.\n"},"save_calibration":{"type":"boolean","description":"Forward image calibration (at the moment pedestal and pedestal RMS for JUNGFRAU) using the ZeroMQ stream to writer.\nIf parameter is not provided calibration will be saved only if more than 4 images are recorded.\n"},"polarization_factor":{"type":"number","description":"Polarization factor for integration; 1.0 is horizontal polarization; -1.0 is vertical polarization","format":"float","minimum":-1,"maximum":1},"ring_current_mA":{"type":"number","format":"float","description":"Ring current at the beginning of the data collection","minimum":0},"sample_temperature_K":{"type":"number","format":"float","description":"Sample temperature in Kelvin","minimum":0},"poni_rot1_rad":{"type":"number","description":"PONI angle rot1 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"poni_rot2_rad":{"type":"number","description":"PONI angle rot2 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"poni_rot3_rad":{"type":"number","description":"PONI angle rot3 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"unit_cell":{"$ref":"#/components/schemas/unit_cell"},"spot_finding":{"type":"boolean","description":"Enable spot finding and save spots","default":true},"max_spot_count":{"type":"integer","minimum":10,"maximum":2000,"default":250,"description":"Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected"},"detect_ice_rings":{"type":"boolean","description":"Flag spots as ice rings and reduce their effect on indexing"},"async_start":{"type":"boolean","default":false,"description":"When set to true, `/start` will not wait for detector and Jungfraujoch to be ready for the measurement."},"xray_fluorescence_spectrum":{"type":"object","required":["energy_eV","data"],"properties":{"energy_eV":{"type":"array","items":{"type":"number","format":"float"},"description":"X-ray fluorescence scan energy for each measurement point"},"data":{"type":"array","items":{"type":"number","format":"float"},"description":"X-ray fluorescence scan result in arbitrary units; must be exactly the same length, as energy_eV"}}}}},"crystal_lattice":{"type":"array","items":{"type":"number","format":"float"},"minItems":9,"maxItems":9,"description":"Real-space crystal lattice 3D vectors in Angstrom.\nOrder is 1st vector (x,y,z), 2nd vector (x,y,z) and 3rd vector (x,y,z)\n"},"unit_cell":{"type":"object","description":"Unit cell parameters. Necessary to run indexing. Units of angstrom and degree","required":["a","b","c","alpha","beta","gamma"],"properties":{"a":{"type":"number","format":"float","example":37,"minimum":0},"b":{"type":"number","format":"float","example":37,"minimum":0},"c":{"type":"number","format":"float","example":78,"minimum":0},"alpha":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360},"beta":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360},"gamma":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360}}},"file_writer_format":{"type":"string","enum":["NXmxOnlyData","NXmxLegacy","NXmxVDS","NXmxIntegrated","CBF","TIFF","NoFileWritten"],"default":"NXmxLegacy","description":"NoFileWritten - no files are written at all\nNXmxOnlyData - only data files are written, no master file\nNXmxLegacy - legacy format with soft links to data files in the master file; necessary for DECTRIS Albula 4.0 and DECTRIS Neggia  \nNXmxVDS - newer format with virtual dataset linking data files in the master file, also includes better metadata handling\nNXmxIntegrated - single HDF5 per dataset\nCBF - CBF format (limited metadata)\nTIFF - TIFF format (no metadata)\n"},"file_writer_settings":{"type":"object","properties":{"overwrite":{"type":"boolean","default":false,"description":"Inform jfjoch_write to overwrite existing files. Otherwise files would be saved with .h5.{timestamp}.tmp suffix.\n"},"format":{"$ref":"#/components/schemas/file_writer_format"}}},"pixel_mask_statistics":{"type":"object","properties":{"user_mask":{"description":"Number of pixels masked using the user mask","type":"integer","format":"int64","minimum":0},"too_high_pedestal_rms":{"description":"Number of pixels with G0 pedestal RMS higher than provided threshold","type":"integer","format":"int64","minimum":0},"wrong_gain":{"description":"Number of pixels that show wrong gain level during the pedestal procedure","type":"integer","format":"int64","minimum":0}}},"image_buffer_status":{"type":"object","required":["image_numbers","total_slots","in_preparation_slots","in_sending_slots","available_slots","max_image_number","min_image_number"],"properties":{"min_image_number":{"type":"integer","format":"int64","minimum":0,"description":"Smallest image number available in the buffer"},"max_image_number":{"type":"integer","format":"int64","minimum":0,"description":"Largest image number available in the buffer"},"image_numbers":{"type":"array","description":"Image numbers currently present in the buffer.","items":{"type":"integer","format":"int64"}},"total_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer. This number, compared to number of images in data collection and\nframe rate will determine \"retention\" rate of the image buffer.\n"},"available_slots":{"type":"integer","format":"int64","description":"Slots available for the data collection"},"in_preparation_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer that are currently in preparation for sending.\n"},"in_sending_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer that are currently sending/writing data.\n"},"current_counter":{"type":"integer","format":"int64","description":"Counter of changes in the image buffer - either new start message or new image added.\nFor optimization one can only load new images/datasets from the HTTP if this value changes.\nCounter is optional as it was not implemented in older versions to avoid breaking change\n"}}},"image_format_settings":{"type":"object","required":["summation","jungfrau_conversion","geometry_transform","mask_chip_edges","mask_module_edges","apply_mask"],"properties":{"summation":{"type":"boolean","description":"Enable summation of images to a given image_time\nIf disabled images are saved according to original detector speed, but image count is adjusted\n"},"geometry_transform":{"type":"boolean","description":"Place module read-out into their location on composed detector and extend multipixels\n"},"jungfrau_conversion":{"type":"boolean","description":"Convert pixel value in ADU to photon counts/energy\nOnly affects JUNGFRAU detector\n"},"jungfrau_conversion_factor_keV":{"type":"number","format":"float","minimum":0.001,"maximum":500,"description":"Used to convert energy deposited into pixel to counts\nIf not provided incident_energy_keV is used\n"},"bit_depth_image":{"type":"integer","format":"int64","enum":[8,16,32],"description":"Bit depth of resulting image (it doesn't affect the detector read-out value)\nIf not provided value is adjusted automatically\n"},"signed_output":{"type":"boolean","description":"Controls if pixels have signed output\nIf not provided value is adjusted automatically\n"},"mask_module_edges":{"type":"boolean","default":true,"description":"Mask 1 pixel on the module boundary\n"},"mask_chip_edges":{"type":"boolean","default":true,"description":"Mask multipixels on chip boundary\n"},"jungfrau_mask_pixels_without_g0":{"type":"boolean","default":true,"description":"JUNGFRAU: mask pixels that don't operate in G0, but do operate in G1 and G1.\nThis should be turned off for cases, where detector is operated at room temperature with long exposure time.\n"},"apply_mask":{"type":"boolean","default":false,"description":"Masked pixels are set to special value in the images produced by Jungfraujoch\n"},"jungfrau_pedestal_g0_rms_limit":{"type":"integer","format":"int64","default":100,"minimum":0,"description":"Pixels with pedestal G0 RMS above the threshold are marked as masked pixels"}}},"detector_power_state":{"type":"string","description":"Power on of ASICs","enum":["PowerOn","PowerOff","Partial"]},"detector_state":{"type":"string","description":"Current state of the detector","enum":["Idle","Waiting","Busy","Error","Not connected"]},"detector_status":{"type":"object","required":["state","powerchip","server_version","number_of_triggers_left","fpga_temp_degC","high_voltage_V"],"properties":{"state":{"$ref":"#/components/schemas/detector_state"},"powerchip":{"$ref":"#/components/schemas/detector_power_state"},"server_version":{"type":"string","description":"Detector server (on read-out boards) version"},"number_of_triggers_left":{"type":"integer","format":"int64","description":"Remaining triggers to the detector (max of all modules)"},"fpga_temp_degC":{"type":"array","description":"Temperature of detector FPGAs","items":{"type":"integer","format":"int64"}},"high_voltage_V":{"type":"array","description":"High voltage for detector modules","items":{"type":"integer","format":"int64"}}}},"detector_timing":{"type":"string","enum":["auto","trigger","burst","gated"],"default":"trigger"},"detector_settings":{"type":"object","required":["frame_time_us"],"properties":{"frame_time_us":{"type":"integer","description":"Interval between consecutive frames.\nThis is internal frame time for the JUNGFRAU detector, image time has to be integer multiply of this number.\nFor EIGER detector this is default frame time, not used otherwise\n","format":"int64","minimum":1},"count_time_us":{"type":"integer","description":"Integration time of the detector. \nIf not provided count time will be set to maximum value for a given frame time.\n","format":"int64"},"internal_frame_generator":{"type":"boolean","default":false,"description":"Use internal frame generator in FPGA instead of getting data from a real detector"},"internal_frame_generator_images":{"type":"integer","format":"int64","default":1,"minimum":1,"maximum":64,"description":"Number of images stored in the internal frame generator."},"detector_trigger_delay_ns":{"type":"integer","format":"int64","minimum":0,"default":0,"description":"Delay between TTL trigger and acquisition start [ns]"},"timing":{"$ref":"#/components/schemas/detector_timing"},"eiger_threshold_keV":{"type":"number","format":"float","minimum":1,"maximum":100,"description":"Threshold for the PSI EIGER detector and all DECTRIS detectors.\nIf value is provided, it will be used for all subsequent acquisitions, irrespective of beam energy.\nIf value is not provided, threshold will be determined on start of acquisition as half of incident energy. \nThis might lead to increased start time.\n"},"eiger_bit_depth":{"type":"integer","format":"int64","enum":[8,16,32],"description":"Bit depth of PSI EIGER read-out. This is  \nIf value is not provided, depth will be determined based on the image time:\n* Exposure time < 500 microseconds depth of 8 bit will be used,\n* 500 <= exposure time < 2622 microseconds depth of 16 bit will be used\n* Exposure time >= 2622 microseconds depth of 32 bit will be used.\n"},"jungfrau_pedestal_g0_frames":{"type":"integer","format":"int64","default":2000,"minimum":0},"jungfrau_pedestal_g1_frames":{"type":"integer","format":"int64","default":300,"minimum":0},"jungfrau_pedestal_g2_frames":{"type":"integer","format":"int64","default":300,"minimum":0},"jungfrau_pedestal_min_image_count":{"type":"integer","format":"int64","default":128,"minimum":32,"description":"Minimum number of collected images for pedestal to consider it viable"},"jungfrau_storage_cell_count":{"type":"integer","format":"int64","default":1,"minimum":1,"maximum":16},"jungfrau_storage_cell_delay_ns":{"type":"integer","format":"int64","minimum":2100,"default":5000,"description":"Delay between two storage cells [ns]"},"jungfrau_fixed_gain_g1":{"type":"boolean","default":false,"description":"Fix gain to G1 (can be useful for storage cells)"},"jungfrau_use_gain_hg0":{"type":"boolean","default":false,"description":"Use high G0 (for low energy applications)"}}},"spot_finding_settings":{"type":"object","required":["enable","indexing","signal_to_noise_threshold","photon_count_threshold","max_pix_per_spot","min_pix_per_spot","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","minimum":0.00002,"maximum":10,"format":"float"},"low_q_recipA":{"type":"number","format":"float","minimum":0.00001,"maximum":10},"q_spacing":{"type":"number","format":"float","minimum":0.00001},"azimuthal_bins":{"type":"integer","format":"int64","minimum":1,"maximum":512,"default":1,"description":"Numer of azimuthal (phi) bins; 1 = standard 1D azimuthal integration"},"force_cpu":{"type":"boolean","default":false,"description":"Force CPU processing of azimuthal integration in the FPGA data acquisition workflow.\nThis allows to extend number of azimuthal integration bins, as well as to calculate standard deviation\nof the azimuthal integration results.\n"}}},"detector_list_element":{"type":"object","required":["id","nmodules","description","width","height","serial_number","base_ipv4_addr","udp_interface_count","readout_time_ns","min_frame_time_ns","min_count_time_ns"],"properties":{"id":{"type":"integer","format":"int64","minimum":0},"description":{"type":"string","example":"JUNGFRAU 4 Mpixel"},"serial_number":{"type":"string","example":"JF17T16V01"},"base_ipv4_addr":{"type":"string","example":"10.10.10.1"},"udp_interface_count":{"type":"integer","format":"int64","example":2,"description":"Number of UDP interfaces per detector module"},"nmodules":{"type":"integer","format":"int64","example":18},"width":{"type":"integer","format":"int64","example":2068},"height":{"type":"integer","format":"int64","example":2164},"pixel_size_mm":{"type":"number","format":"float","example":0.075},"readout_time_ns":{"type":"integer","format":"int64"},"min_frame_time_ns":{"type":"integer","format":"int64"},"min_count_time_ns":{"type":"integer","format":"int64"},"type":{"$ref":"#/components/schemas/detector_type"}}},"detector_list":{"type":"object","required":["detectors","current_id"],"properties":{"detectors":{"type":"array","items":{"$ref":"#/components/schemas/detector_list_element"}},"current_id":{"type":"integer","format":"int64","example":0}}},"detector_selection":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","example":1}}},"measurement_statistics":{"type":"object","properties":{"file_prefix":{"type":"string"},"run_number":{"type":"integer","format":"int64","description":"Number of data collection run. This can be either automatically incremented or provided externally for each data collection.\n"},"experiment_group":{"type":"string","description":"Name of group owning the data (e.g. p-group or proposal number).\n"},"images_expected":{"type":"integer","format":"int64"},"images_collected":{"type":"integer","format":"int64","description":"Images collected by the receiver. This number will be lower than images expected if there were issues with data collection performance.\n"},"images_sent":{"type":"integer","format":"int64","description":"Images sent to the writer. \nThe value does not include images discarded by lossy compression filter and images not forwarded due to full ZeroMQ queue.\n"},"images_written":{"type":"integer","format":"int64","description":"Images successfully written to disk.\nThe value is live updated for TCP/IP socket and direct HDF5 writer, while for ZeroMQ it is only updated at the end of experiment.\n"},"images_discarded_lossy_compression":{"type":"integer","format":"int64","description":"Images discarded by the lossy compression filter"},"max_image_number_sent":{"type":"integer","format":"int64"},"collection_efficiency":{"type":"number","format":"float","example":1,"minimum":0,"maximum":1},"compression_ratio":{"type":"number","format":"float","example":5.3,"minimum":0},"cancelled":{"type":"boolean"},"max_receiver_delay":{"type":"integer","format":"int64"},"indexing_rate":{"type":"number","format":"float"},"detector_width":{"type":"integer","format":"int64"},"detector_height":{"type":"integer","format":"int64"},"detector_pixel_depth":{"type":"integer","format":"int64","enum":[2,4]},"bkg_estimate":{"type":"number","format":"float"},"unit_cell":{"type":"string"},"error_pixels":{"type":"number","format":"float","description":"Moving average of 1000 images counting number of error pixels on the detector"},"saturated_pixels":{"type":"number","format":"float","description":"Moving average of 1000 images counting number of saturated pixels on the detector"},"roi_beam_pixels":{"type":"number","format":"float","description":"If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images\nfor number of valid pixels within this ROI\n"},"roi_beam_sum":{"type":"number","format":"float","description":"If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images\nfor sum of valid pixels within this ROI\n"}}},"fpga_status":{"type":"array","items":{"type":"object","required":["pci_dev_id","serial_number","base_mac_addr","eth_link_status","eth_link_count","eth_link_speed","power_usage_W","fpga_temp_C","hbm_temp_C","packets_sls","packets_udp","idle","fw_version","pcie_link_speed","pcie_link_width"],"properties":{"pci_dev_id":{"type":"string"},"serial_number":{"type":"string"},"fw_version":{"type":"string"},"base_mac_addr":{"type":"string"},"eth_link_count":{"type":"integer","format":"int64"},"eth_link_status":{"type":"integer","format":"int64"},"power_usage_W":{"type":"number","format":"float"},"fpga_temp_C":{"type":"number","format":"float"},"hbm_temp_C":{"type":"number","format":"float"},"packets_udp":{"type":"integer","format":"int64"},"packets_sls":{"type":"integer","format":"int64"},"idle":{"type":"boolean"},"pcie_link_speed":{"type":"integer","format":"int64","description":"PCIe link speed measured by generation (expected value is 4 == PCIe Gen4)"},"pcie_link_width":{"type":"integer","format":"int64","description":"PCIe link width (expected value is 8 == x8)"}}}},"broker_status":{"type":"object","required":["state"],"properties":{"state":{"type":"string","enum":["Inactive","Idle","Busy","Measuring","Pedestal","Error"]},"progress":{"type":"number","format":"float","description":"Progress of data collection (only available if receiving is running)","example":1,"minimum":0,"maximum":1},"message":{"type":"string","description":"Message to display besides state of the jfjoch_broker; mostly used for errors and warnings\nThis matters especially for async functions (start/initialize), where API won't return reason\nfor the error during async operation.\n"},"message_severity":{"type":"string","enum":["success","info","warning","error"],"default":"error","description":"Level of the message to display"},"gpu_count":{"type":"integer","format":"int32","description":"Number of installed GPUs"},"broker_version":{"type":"string","description":"Version of the jfjoch_broker","example":"1.0.0-rc.128"}}},"image_pusher_status":{"type":"object","required":["pusher_type","addr","connected_writers"],"description":"Informs about status of the image pusher.\n","properties":{"pusher_type":{"$ref":"#/components/schemas/image_pusher_type"},"addr":{"type":"array","items":{"type":"string"},"example":["tcp://1.2.3.4:5000","tcp://1.2.3.4:5001"],"description":"List of addresses of image pushers.\nFor HDF5 socket - no addresses will be returned.\nFor ZeroMQ - list of addresses for each socket will be provided.\nFor TCP/IP - single address to connect all writers will be provided.\n"},"connected_writers":{"type":"integer","format":"int64","minimum":0,"description":"Number of connected writers \nFor ZeroMQ image socket: number is constant\nFor TCP/IP image socket: number is updated live during operation\n"},"images_written":{"type":"integer","format":"int64","minimum":0,"description":"Number of images written to the image socket.\nThis number is updated live during operation for TCP/IP image socket and direct HDF5 writer.\nIt is updated at the end of experiment for ZeroMQ image socket.\n"},"images_write_error":{"type":"integer","format":"int64","minimum":0,"description":"Number of images that could not be written to the image socket.\nThis number is updated live during operation for TCP/IP image socket.\nNo other socket use it.\n"},"writer_fifo_utilization":{"type":"array","items":{"type":"integer","format":"int64","minimum":0},"description":"Utilization of internal writer FIFO.\nThis number is updated live during operation for TCP/IP image socket.\nNo other socket use it.\n"}}},"plot":{"type":"object","required":["x","y","title"],"description":"x and y coordinates for plotting, it is OK to assume that both arrays have the same size; layout is optimized for Plotly","properties":{"title":{"type":"string","default":""},"x":{"type":"array","items":{"type":"number","format":"float"}},"y":{"type":"array","items":{"type":"number","format":"float","nullable":true}},"z":{"type":"array","items":{"type":"number","format":"float","nullable":true}}}},"plot_unit_x":{"type":"string","enum":["image_number","q_recipA","d_A","angle_deg","ADU","grid_um"],"default":"image_number"},"plots":{"type":"object","required":["plot","unit_x"],"properties":{"title":{"type":"string"},"unit_x":{"$ref":"#/components/schemas/plot_unit_x"},"size_x":{"type":"number","format":"float","description":"Max X range of the plot"},"size_y":{"type":"number","format":"float","description":"Max Y range of the plot"},"plot":{"type":"array","items":{"$ref":"#/components/schemas/plot"}}}},"scan_result":{"type":"object","description":"Results of a scan","required":["images"],"properties":{"file_prefix":{"type":"string"},"rotation_unit_cell":{"$ref":"#/components/schemas/unit_cell"},"rotation_crystal_lattice":{"$ref":"#/components/schemas/crystal_lattice"},"images":{"type":"array","items":{"type":"object","required":["efficiency","number"],"properties":{"efficiency":{"type":"number","format":"float"},"number":{"type":"integer","format":"int64","description":"Detector image number for a given cell"},"nx":{"type":"integer","format":"int64","description":"Cell position in X for grid scan"},"ny":{"type":"integer","format":"int64","description":"Cell position in Y for grid scan"},"angle":{"type":"number","format":"float","description":"Rotation angle associated with the image"},"bkg":{"type":"number","format":"float","description":"Background estimate"},"spots":{"type":"integer","format":"int64","description":"Spot count"},"spots_low_res":{"type":"integer","format":"int64","description":"Spot count in low resolution range"},"spots_indexed":{"type":"integer","format":"int64","description":"Spot count within indexing tolerance"},"spots_ice":{"type":"integer","format":"int64","description":"Spot count within common ice ring resolutions"},"index":{"type":"integer","format":"int64","description":"Indexing solution"},"latt_count":{"type":"integer","format":"int64","description":"Indexing lattice count"},"pr":{"type":"number","format":"float","description":"Profile radius, i.e. how far reflections are from the Ewald sphere"},"b":{"type":"number","format":"float","description":"B-Factor estimate"},"uc":{"$ref":"#/components/schemas/unit_cell"},"xfel_pulseid":{"type":"integer","format":"int64","description":"XFEL pulse ID"},"pixel_sum":{"type":"integer","format":"int64","description":"Total sum of all pixels"},"max":{"type":"integer","format":"int64","description":"Max viable pixel"},"sat":{"type":"integer","format":"int64","description":"Number of saturated pixels"},"err":{"type":"integer","format":"int64","description":"Number of error pixels"},"res":{"type":"number","format":"float","description":"Diffraction resolution estimate"}}}}}},"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"},"image_pusher":{"$ref":"#/components/schemas/image_pusher_status"}}},"error_message":{"type":"object","required":["msg","reason"],"properties":{"msg":{"type":"string","description":"Human readable message","example":"Detector in wrong state"},"reason":{"type":"string","description":"Enumerate field for automated analysis","enum":["WrongDAQState","Other"]}}},"roi_azimuthal":{"type":"object","description":"ROI as Q-range (or resolution range), optionally restricted to an azimuthal-angle sector","required":["name","q_min_recipA","q_max_recipA"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"q_min_recipA":{"type":"number","format":"float","minimum":0.00001,"description":"Minimum Q-range for the ROI"},"q_max_recipA":{"type":"number","format":"float","minimum":0.00001,"description":"Maximum Q-range for the ROI"},"phi_min_deg":{"type":"number","format":"float","description":"Lower azimuthal-angle bound of the sector [degrees]. Optional: provide both phi_min_deg and phi_max_deg to restrict the ROI to an angular sector, or omit both for a full ring. A sector with phi_min_deg > phi_max_deg wraps across 0.\n"},"phi_max_deg":{"type":"number","format":"float","description":"Upper azimuthal-angle bound of the sector [degrees]. Optional; see phi_min_deg.\n"}}},"roi_circle":{"type":"object","description":"Circular ROI","required":["name","center_x_pxl","center_y_pxl","radius_pxl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"center_x_pxl":{"type":"number","format":"float","description":"X coordinate of center of the circle [pixels]"},"center_y_pxl":{"type":"number","format":"float","description":"Y coordinate of center of the circle [pixels]"},"radius_pxl":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"Radius of the circle [pixels]"}}},"roi_box":{"type":"object","description":"Box ROI","required":["name","min_x_pxl","max_x_pxl","min_y_pxl","max_y_pxl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"min_x_pxl":{"type":"integer","format":"int64","description":"Lower bound (inclusive) in X coordinate for the box","minimum":0},"max_x_pxl":{"type":"integer","format":"int64","description":"Upper bound (inclusive) in X coordinate for the box","minimum":0},"min_y_pxl":{"type":"integer","format":"int64","description":"Lower bound (inclusive) in Y coordinate for the box","minimum":0},"max_y_pxl":{"type":"integer","format":"int64","description":"Upper bound (inclusive) in Y coordinate for the box","minimum":0}}},"roi_circle_list":{"type":"object","description":"List of circular ROIs","required":["rois"],"properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_circle"}}}},"roi_box_list":{"type":"object","description":"List of box ROIs","properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_box"}}}},"roi_azim_list":{"type":"object","description":"List of azimuthal ROIs","properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_azimuthal"}}}},"roi_definitions":{"type":"object","required":["box","circle","azim"],"description":"ROI defintions","properties":{"box":{"$ref":"#/components/schemas/roi_box_list"},"circle":{"$ref":"#/components/schemas/roi_circle_list"},"azim":{"$ref":"#/components/schemas/roi_azim_list"}}},"dark_mask_settings":{"type":"object","description":"Settings for collection of dark images to be used for mask calculation","required":["detector_threshold_keV","frame_threshold_keV","max_allowed_pixel_count","max_frames_with_signal","frame_time_us","number_of_frames"],"properties":{"detector_threshold_keV":{"type":"number","format":"float","description":"Energy threshold for dark image collection","minimum":2.5,"default":3.5,"maximum":100},"frame_time_us":{"type":"integer","format":"int64","description":"Time between frames for dark image collection","minimum":500,"default":10000,"maximum":100000},"number_of_frames":{"type":"integer","format":"int64","description":"Number of frames for dark image collection; zero means no dark collection","minimum":0,"default":1000},"max_allowed_pixel_count":{"type":"integer","format":"int64","description":"Maximum count in a pixel considered normal (not-masked)","minimum":0,"default":1},"max_frames_with_signal":{"type":"integer","format":"int64","description":"Maximum number of frames with signal in a pixel considered normal (not-masked)","minimum":0,"default":10}}},"indexing_settings":{"type":"object","description":"Settings for crystallography indexing","required":["algorithm","geom_refinement_algorithm","fft_high_resolution_A","fft_max_unit_cell_A","fft_min_unit_cell_A","fft_num_vectors","tolerance","thread_count","unit_cell_dist_tolerance","index_ice_rings","viable_cell_min_spots","rotation_indexing","rotation_indexing_min_angular_range_deg","rotation_indexing_angular_stride_deg","blocking"],"properties":{"algorithm":{"$ref":"#/components/schemas/indexing_algorithm"},"fft_max_unit_cell_A":{"type":"number","format":"float","default":250,"maximum":500,"minimum":50,"description":"Largest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT"},"fft_min_unit_cell_A":{"type":"number","format":"float","default":10,"minimum":5,"maximum":40,"description":"Smallest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT"},"fft_high_resolution_A":{"type":"number","format":"float","default":2,"minimum":0.5,"maximum":6,"description":"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"},"rotation_indexing":{"type":"boolean","default":false},"rotation_indexing_min_angular_range_deg":{"type":"number","format":"float","default":20,"minimum":1},"rotation_indexing_angular_stride_deg":{"type":"number","format":"float","default":0.5,"minimum":0},"blocking":{"type":"boolean","default":true,"description":"Indexing in Jungfraujoch goes with a dedicated thread pool.\nIf set to false, the thread pool is non-blocking, i.e. if there are no threads available, image indexing will be skipped. This option is recommended for real-time processing at high frame rates.\nIf set to true, the thread pool will block until a thread is available.\n"}}},"instrument_metadata":{"type":"object","description":"Metadata for a measurement instrument","required":["source_name","instrument_name"],"properties":{"source_name":{"type":"string","example":"Swiss Light Source"},"source_type":{"type":"string","description":"Type of radiation source. NXmx gives a fixed dictionary, though Jungfraujoch is not enforcing compliance. \nhttps://manual.nexusformat.org/classes/base_classes/NXsource.html#nxsource\nNXsource allows the following:\n\nSpallation Neutron Source\nPulsed Reactor Neutron Source\nReactor Neutron Source\nSynchrotron X-ray Source\nPulsed Muon Source\nRotating Anode X-ray\nFixed Tube X-ray\nUV Laser\nFree-Electron Laser\nOptical Laser\nIon Source\nUV Plasma Source\nMetal Jet X-ray\n","example":"Synchrotron X-ray Source","default":""},"instrument_name":{"type":"string","example":"CristallinaMX"},"pulsed_source":{"type":"boolean","description":"Settings specific to XFEL (e.g., every image has to come from TTL trigger, save pulse ID and event code)\n","default":false},"electron_source":{"type":"boolean","description":"Settings specific to electron source (e.g., wavelength definition)\n","default":false}}},"detector_module_direction":{"type":"string","enum":["Xp","Xn","Yp","Yn"]},"detector_type":{"type":"string","enum":["EIGER","JUNGFRAU","DECTRIS"]},"image_pusher_type":{"type":"string","default":"None","enum":["ZeroMQ","HDF5","CBOR","TCP","None"]},"standard_detector_geometry":{"type":"object","description":"Regular rectangular geometry, first module is in the bottom left corner of the detector","required":["nmodules"],"properties":{"nmodules":{"type":"integer","minimum":1,"description":"Number of modules in the detector"},"gap_x":{"type":"integer","default":8,"minimum":0,"description":"Gap size in X direction [pixels]"},"gap_y":{"type":"integer","minimum":0,"default":36,"description":"Gap size in Y direction [pixels]"},"modules_in_row":{"type":"integer","minimum":1,"default":1,"description":"Number of modules in one row"}}},"detector_module":{"type":"object","required":["x0","y0","fast_axis","slow_axis"],"properties":{"x0":{"type":"number"},"y0":{"type":"number"},"fast_axis":{"$ref":"#/components/schemas/detector_module_direction"},"slow_axis":{"$ref":"#/components/schemas/detector_module_direction"}}},"detector":{"type":"object","required":["description"],"properties":{"description":{"type":"string","minLength":1},"serial_number":{"type":"string","default":"Unknown","minLength":1},"type":{"$ref":"#/components/schemas/detector_type"},"high_voltage_V":{"type":"integer","format":"int64","minimum":0,"maximum":200,"default":0},"udp_interface_count":{"type":"integer","format":"int64","minimum":1,"maximum":2,"default":1},"module_sync":{"type":"boolean","default":true,"description":"Use module 0 as master for timing. Only applies to JUNGFRAU detector (this cannot be turned off for EIGER)."},"sensor_thickness_um":{"type":"number","format":"float","minimum":0,"default":320},"readout_time_ns":{"type":"integer","format":"int64","minimum":1,"description":"Minimum difference between frame time and count time in microseconds\nDefaults are 3'000 ns for EIGER and 20'000 ns for JUNGFRAU\n"},"min_count_time_ns":{"type":"integer","format":"int64","minimum":0,"description":"Minimum count time available for the detector."},"min_frame_time_ns":{"type":"integer","format":"int64","minimum":0,"description":"Minimum frame time available for the detector."},"calibration_file":{"type":"array","description":"Can be empty for all detectors - default calibration used.\nFor JUNGFRAU: list of gain files, one entry per module.\nFor EIGER: one directory (with detector settings) or list of trim bit files, one entry per half-module.\n","items":{"type":"string"}},"trim_energies_eV":{"type":"array","description":"List of energies at which trimming calibration is provided.\nOnly needed for PSI EIGER and compulsory in this case\n","items":{"type":"integer","format":"int32","minimum":100}},"hostname":{"type":"array","description":"Hostname for detector module. One entry per module\nOne entry per module. Either empty or number of module entries.\n","items":{"type":"string"}},"sensor_material":{"type":"string","default":"Si"},"tx_delay":{"type":"array","items":{"type":"integer","format":"int64"}},"base_data_ipv4_address":{"type":"string","example":"10.10.10.50"},"standard_geometry":{"$ref":"#/components/schemas/standard_detector_geometry"},"custom_geometry":{"type":"array","items":{"$ref":"#/components/schemas/detector_module"}},"roi_mode":{"type":"string","default":"","description":"ROI setting for DECTRIS detectors"},"mirror_y":{"type":"boolean","default":true,"description":"Mirror detector in Y direction to account for MX convention of (0,0) point in top left corner"},"temp_thresold_degC":{"type":"integer","format":"int64","description":"Temperature threshold for JUNGFRAU detector modules","minimum":40,"maximum":70,"default":55},"default_settings":{"$ref":"#/components/schemas/detector_settings"}}},"zeromq_settings":{"type":"object","description":"ZeroMQ configuration for Jungfraujoch software.\nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","properties":{"send_watermark":{"type":"integer","format":"int64","minimum":2,"maximum":16384,"default":100,"description":"Watermark for ZeroMQ send queue (number of outstanding messages queued on Jungfraujoch server per queue)"},"send_buffer_size":{"type":"integer","format":"int64","description":"Send buffer size for ZeroMQ socket"},"image_socket":{"type":"array","items":{"type":"string"},"example":["tcp://1.2.3.4:5000","tcp://1.2.3.4:5001"],"description":"PUSH ZeroMQ socket for images. In case multiple sockets are provided, images are streamed over multiple sockets.  \nImages are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"},"writer_notification_socket":{"type":"string","example":"tcp://1.3.4.6:7000","description":"PULL ZeroMQ socket for notifications from writer that it finished operation. \nThis allows Jungfraujoch to operate in a synchronous manner, with end of acquisition being also end of writing.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address should be avoided, as this socket address is forwarded to the writer process via START ZerOMQ message and in case of multiple ineterfaces the address might be ambigous.\nUsing * (star) instead of port number is allowed and it means a random free port number.\n"}}},"tcp_settings":{"type":"object","description":"TCP image stream configuration for Jungfraujoch software.\nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","required":["addr"],"properties":{"send_buffer_size":{"type":"integer","format":"int64","description":"Send buffer size for TCP/IP socket"},"image_socket":{"type":"string","example":"tcp://1.2.3.4:5000","description":"tcp://<IP address>:<port>\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces\n"},"nwriters":{"type":"integer","format":"int64","minimum":1,"maximum":100,"default":32,"description":"Number of TCP/IP writers to be used for streaming images"},"peer_liveness_timeout_ms":{"type":"integer","format":"int64","description":"Max time (in milliseconds) a send may block with no sign of life from the\nwriter (no BUSY heartbeat or ACK) before the connection is declared dead.\nOptional; the built-in default is used when unset.\n"},"max_backpressure_timeout_ms":{"type":"integer","format":"int64","description":"Hard upper bound (in milliseconds) on backpressure: if no bytes can be sent to\nthe writer for this long the connection is declared dead even while the writer\nkeeps heartbeating, so a wedged writer cannot block the run or its\nfinalization. Optional; the built-in default is used when unset.\n"}}},"pcie_devices":{"type":"array","minLength":1,"items":{"type":"object","required":["block_device"],"properties":{"blk":{"type":"string","example":"/dev/jfjoch0","description":"Block device name"},"ipv4":{"type":"string","example":"10.1.1.7","description":"IPv4 address of the block device"}}}},"jfjoch_settings":{"type":"object","required":["detector","frontend_directory","image_pusher"],"description":"Default settings for Jungfraujoch software. \nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","properties":{"pcie":{"$ref":"#/components/schemas/pcie_devices"},"zeromq":{"$ref":"#/components/schemas/zeromq_settings"},"tcp":{"$ref":"#/components/schemas/tcp_settings"},"instrument":{"$ref":"#/components/schemas/instrument_metadata"},"file_writer":{"$ref":"#/components/schemas/file_writer_settings"},"detector":{"type":"array","minLength":1,"items":{"$ref":"#/components/schemas/detector"}},"indexing":{"$ref":"#/components/schemas/indexing_settings"},"detector_settings":{"$ref":"#/components/schemas/detector_settings"},"azim_int":{"$ref":"#/components/schemas/azim_int_settings"},"image_format":{"$ref":"#/components/schemas/image_format_settings"},"image_buffer_MiB":{"type":"integer","minimum":128,"default":2048,"description":"Size of internal buffer in MiB for images before they are sent to a stream"},"verbose":{"type":"boolean","default":false,"description":"Print extra debug information"},"receiver_threads":{"type":"integer","minimum":1,"maximum":512,"default":64,"description":"Number of threads used by the receiver"},"numa_policy":{"type":"string","deprecated":true,"description":"Ignored value"},"frontend_directory":{"type":"string","description":"Location of built JavaScript web frontend"},"spot_finding":{"$ref":"#/components/schemas/spot_finding_settings"},"image_pusher":{"$ref":"#/components/schemas/image_pusher_type"},"zeromq_preview":{"$ref":"#/components/schemas/zeromq_preview_settings"},"zeromq_metadata":{"$ref":"#/components/schemas/zeromq_metadata_settings"},"dark_mask":{"$ref":"#/components/schemas/dark_mask_settings"}}},"zeromq_metadata_settings":{"type":"object","required":["enabled","period_ms"],"properties":{"enabled":{"type":"boolean","default":true,"description":"ZeroMQ metadata socket is enabled."},"period_ms":{"type":"integer","format":"int64","minimum":1,"default":1000,"description":"Period for generating metadata package sent to the ZeroMQ interface in milliseconds.\n"},"socket_address":{"type":"string","description":"PUB ZeroMQ socket for image metadata information.\nImage metadata are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"}}},"zeromq_preview_settings":{"type":"object","required":["enabled","period_ms"],"properties":{"enabled":{"type":"boolean","default":true,"description":"ZeroMQ preview socket is enabled."},"period_ms":{"type":"integer","format":"int64","default":1000,"description":"Period for generating preview image sent to the ZeroMQ interface in milliseconds. Default is 1 second. \nIf set to zero, all images will be sent ZeroMQ (should be used only in case of relatively slow data collection).\nThis has no effect on HTTP based preview, which updates always at rate of 1 second.\n"},"socket_address":{"type":"string","description":"PUB ZeroMQ socket for preview images. This socket operates at a reduced frame rate.\nImages are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"}}}}},"paths":{"/initialize":{"post":{"summary":"Initialize detector and data acquisition","description":"Should be used in two cases:\n  - Detector is in `Inactive` state\n  - Detector is in `Error` state\nX-ray shutter must be closed. \nThis operation will reconfigure network interface of the detector. \nDuring operation of the detector it is recommended to use the `POST /pedestal` operation instead.\nIf storage cells are used, the execution time might be few minutes.\n\nThis is async function - one needs to use `POST /wait_till_done` to ensure operation is done.\n","responses":{"200":{"description":"Initialization started"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/pedestal":{"post":{"summary":"Collect dark current for the detector","description":"Updates calibration of the JUNGFRAU detector. Must be in `Idle` state.\n\nX-ray shutter must be closed. Recommended to run once per hour for long integration times (> 100 us).\n\nThis is async function - one needs to use `POST /wait_till_done` to ensure operation is done.\n","responses":{"200":{"description":"Everything OK"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/start":{"post":{"summary":"Start detector","description":"Start data acquisition.\nDetector must be in `Idle` state.\nDefault behavior is for the call to block until detector is ready to accept soft/TTL triggers.\nHowever, this behavior can be changed by settings `async_start` to true in the request body, \nin which case the call will return immediately and one needs to use `/wait_until_running` to ensure detector is ready to run.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/wait_until_running":{"post":{"summary":"Wait for acquisition running","parameters":[{"in":"query","name":"timeout","required":false,"schema":{"type":"integer","default":60,"minimum":0,"maximum":3600},"description":"Timeout in seconds (0 == immediate response)"}],"description":"Block execution of external script till detector and Jungfraujoch are ready to collect data.\nTo not block web server for a indefinite period of time, the procedure is provided with a timeout.\nExtending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.\n","responses":{"200":{"description":"Detector in `Measuring` state"},"400":{"description":"Timeout parameter out of bounds"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}},"502":{"description":"Detector is inactive mode"},"504":{"description":"Timeout reached, need to restart operation"}}}},"/wait_till_done":{"post":{"summary":"Wait for acquisition done","parameters":[{"in":"query","name":"timeout","required":false,"schema":{"type":"integer","default":60,"minimum":0,"maximum":3600},"description":"Timeout in seconds (0 == immediate response)"}],"description":"Block execution of external script till initialization, data collection or pedestal is finished.\nRunning this command does not affect (cancel) running data collection, it is only to ensure synchronous execution of other software.\n\nTo not block web server for a indefinite period of time, the procedure is provided with a timeout.\nExtending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.\n","responses":{"200":{"description":"Detector in `Idle` state, another data collection can start immediately"},"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"}}}},"/image_pusher/status":{"get":{"summary":"Get status of image pusher","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_pusher_status"}}}},"500":{"description":"Error encountered when trying to read status","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/detector/status":{"get":{"summary":"Get detector status","description":"Status of the JUNGFRAU detector","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_status"}}}},"404":{"description":"Running in \"simulator\" mode - no detector present"},"500":{"description":"Error encountered when trying to read status","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/config/roi":{"get":{"summary":"Get ROI definitions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roi_definitions"}}}}}},"put":{"summary":"Upload ROI definitions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/roi_definitions"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/statistics":{"get":{"summary":"Get general statistics","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jfjoch_statistics"}}}}}}},"/statistics/data_collection":{"get":{"summary":"Get data collection statistics","description":"Results of the last data collection","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/measurement_statistics"}}}},"404":{"description":"No data collection performed so far"}}}},"/statistics/calibration":{"get":{"summary":"Get calibration statistics","description":"Statistics are provided for each module/storage cell separately","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calibration_statistics"}}}}}}},"/config/mask":{"get":{"summary":"Get mask of the detector (binary)","description":"Detector must be Initialized.\nGet full pixel mask of the detector.\nSee NXmx standard for meaning of pixel values.\n","responses":{"200":{"description":"Binary array (4 byte; unsigned)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}},"/config/user_mask":{"get":{"summary":"Detector must be Initialized.\nGet user mask of the detector (binary)\n","description":"Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked","responses":{"200":{"description":"User mask in binary format (4 byte; unsigned)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"summary":"Upload user mask of the detector (binary)","description":"Should be in `Idle` state.\nUpload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.\nIf detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.\nIn the latter case - module gaps are ignored and don't need to be assigned value.\nMask is expected as binary array (4-byte; unsigned).\n0 - good pixel, other value - masked\nUser mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.\n","requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"All good"},"400":{"description":"Mask is not 4-byte unsigned integer array or empty body"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/config/mask.tiff":{"get":{"summary":"Get mask of the detector (TIFF)","description":"Should be in `Idle` state.\nGet full pixel mask of the detector\nSee NXmx standard for meaning of pixel values\n","responses":{"200":{"description":"Pixel mask in TIFF format (4 byte; unsigned)","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}}}}},"/config/user_mask.tiff":{"get":{"summary":"Detector must be Initialized.\nGet user mask of the detector (TIFF)\n","description":"Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked","responses":{"200":{"description":"User mask in TIFF format (4 byte; unsigned)","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"summary":"Upload user mask of the detector","description":"Should be in `Idle` state.\nUpload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.\nIf detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.\nIn the latter case - module gaps are ignored and don't need to be assigned value.\nMask is expected as a single-channel TIFF (8-, 16- or 32-bit integer, signed or unsigned).\n0 - good pixel, other value - masked\nUser mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.\nUser mask is not automatically applied - i.e. pixels with user mask will have a valid pixel value in the images.\n","requestBody":{"content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"All good"},"400":{"description":"Not a valid single-channel TIFF or size doesn't match the detector"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/preview/pedestal.tiff":{"get":{"parameters":[{"in":"query","name":"gain_level","required":true,"schema":{"type":"integer"},"description":"Gain level (0, 1, 2)"},{"in":"query","name":"sc","schema":{"type":"integer"},"description":"Storage cell number"}],"summary":"Get pedestal in TIFF format","responses":{"200":{"description":"Calibration image","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid gain level or storage cell number"},"404":{"description":"No calibration recorded so far"}}}},"/preview/plot":{"get":{"summary":"Generate 1D plot from Jungfraujoch","parameters":[{"$ref":"#/components/parameters/binning"},{"$ref":"#/components/parameters/plot_type"},{"$ref":"#/components/parameters/fill_value"},{"$ref":"#/components/parameters/experimental_coord"},{"$ref":"#/components/parameters/azint_unit"}],"responses":{"200":{"description":"Everything OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/plots"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/preview/plot.bin":{"get":{"summary":"Generate 1D plot from Jungfraujoch and send in raw binary format.\nData are provided as (32-bit) float binary array.\nThis format doesn't transmit information about X-axis, only values, so it is of limited use for azimuthal integration.\n","parameters":[{"$ref":"#/components/parameters/plot_type"},{"$ref":"#/components/parameters/roi"}],"responses":{"200":{"description":"Everything OK.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/result/scan":{"get":{"summary":"Get full scan result","responses":{"200":{"description":"Everything OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scan_result"}}}},"404":{"description":"No grid scan recorded"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/start.cbor":{"get":{"summary":"Get Start message in CBOR format","description":"Contains metadata for a dataset (e.g., experimental geometry)","responses":{"200":{"description":"Return start message","content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No measurement so far"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.cbor":{"get":{"summary":"Get image message in CBOR format","description":"Contains full image data and metadata. The image must come from the latest data collection.","parameters":[{"$ref":"#/components/parameters/image_id"}],"responses":{"200":{"description":"Return image message","content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Image not present in the buffer - either not yet measured or already replaced by a next image."},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.jpeg":{"get":{"summary":"Get preview image in JPEG format using custom settings","parameters":[{"$ref":"#/components/parameters/image_id"},{"$ref":"#/components/parameters/show_user_mask"},{"$ref":"#/components/parameters/show_roi"},{"$ref":"#/components/parameters/show_spots"},{"$ref":"#/components/parameters/show_beam_center"},{"$ref":"#/components/parameters/saturation"},{"$ref":"#/components/parameters/jpeg_quality"},{"$ref":"#/components/parameters/resolution_ring"},{"$ref":"#/components/parameters/color_scale"},{"$ref":"#/components/parameters/resolution_estimate"}],"responses":{"200":{"description":"Preview image","content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"404":{"description":"Image not present in the buffer - either not yet measured or already replaced by a next image."},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.tiff":{"get":{"summary":"Get preview image in TIFF format","parameters":[{"$ref":"#/components/parameters/image_id"}],"responses":{"200":{"description":"Preview image","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No preview image recorded so far"}}}},"/image_buffer/clear":{"post":{"summary":"Clear image buffer","description":"Turns off image buffer for the last data collection. Can be only run when Jungfraujoch is not collecting data.","responses":{"200":{"description":"Done"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/status":{"get":{"summary":"Get status of the image buffers","description":"Can be run at any stage of Jungfraujoch operation, including during data collection.\nThe status of the image buffer is volatile during data collection - if data collection goes for more images than available buffer slots,\nthen image might be replaced in the buffer between calling /images and /image.cbor.\n","responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_buffer_status"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/version":{"get":{"summary":"Get Jungfraujoch version of jfjoch_broker","responses":{"200":{"description":"Release number of Jungfraujoch","content":{"text/plain":{"schema":{"type":"string","example":"1.0.0-rc.25"}}}}}}}}}},"searchIndex":{"store":["section/License-Clarification","/paths/~1initialize/post","/paths/~1pedestal/post","/paths/~1start/post","/paths/~1wait_until_running/post","/paths/~1wait_till_done/post","/paths/~1trigger/post","/paths/~1cancel/post","/paths/~1deactivate/post","/paths/~1config~1detector/put","/paths/~1config~1detector/get","/paths/~1config~1indexing/put","/paths/~1config~1indexing/get","/paths/~1config~1file_writer/put","/paths/~1config~1file_writer/get","/paths/~1config~1instrument/put","/paths/~1config~1instrument/get","/paths/~1config~1image_format/put","/paths/~1config~1image_format/get","/paths/~1config~1image_format~1raw/post","/paths/~1config~1image_format~1conversion/post","/paths/~1config~1spot_finding/put","/paths/~1config~1spot_finding/get","/paths/~1config~1azim_int/put","/paths/~1config~1azim_int/get","/paths/~1config~1internal_generator_image/put","/paths/~1config~1internal_generator_image.tiff/put","/paths/~1config~1select_detector/put","/paths/~1config~1select_detector/get","/paths/~1config~1zeromq_preview/put","/paths/~1config~1zeromq_preview/get","/paths/~1config~1zeromq_metadata/put","/paths/~1config~1zeromq_metadata/get","/paths/~1config~1dark_mask/put","/paths/~1config~1dark_mask/get","/paths/~1status/get","/paths/~1fpga_status/get","/paths/~1xfel~1pulse_id/get","/paths/~1xfel~1event_code/get","/paths/~1image_pusher~1status/get","/paths/~1detector~1status/get","/paths/~1config~1roi/get","/paths/~1config~1roi/put","/paths/~1statistics/get","/paths/~1statistics~1data_collection/get","/paths/~1statistics~1calibration/get","/paths/~1config~1mask/get","/paths/~1config~1user_mask/get","/paths/~1config~1user_mask/put","/paths/~1config~1mask.tiff/get","/paths/~1config~1user_mask.tiff/get","/paths/~1config~1user_mask.tiff/put","/paths/~1preview~1pedestal.tiff/get","/paths/~1preview~1plot/get","/paths/~1preview~1plot.bin/get","/paths/~1result~1scan/get","/paths/~1image_buffer~1start.cbor/get","/paths/~1image_buffer~1image.cbor/get","/paths/~1image_buffer~1image.jpeg/get","/paths/~1image_buffer~1image.tiff/get","/paths/~1image_buffer~1clear/post","/paths/~1image_buffer~1status/get","/paths/~1version/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.076,1,4.719]],["description/0",[0,1.814,2,4.176,3,2.164,4,2.1,5,1.203,6,3.348,7,1.203,8,1.203,9,1.039,10,0.931,11,1.612,12,1.203,13,0.96,14,1.203,15,1.626,16,1.203,17,2.794,18,2.1,19,0.931,20,2.1,21,1.28,22,1.203,23,2.1,24,1.039,25,2.794,26,1.203,27,1.203,28,2.1,29,1.203,30,1.203,31,1.203,32,1.203,33,1.203,34,1.203,35,1.203,36,2.794,37,1.203,38,1.203,39,0.365,40,0.611,41,1.203,42,2.1,43,1.039,44,1.203,45,1.203,46,1.203,47,1.203,48,1.203,49,1.203,50,1.039,51,1.203,52,1.203,53,1.203,54,1.203,55,1.203,56,1.203,57,1.203,58,1.203,59,0.931,60,0.931,61,1.203]],["title/1",[62,2.287,63,0.409,64,0.96,65,1.908]],["description/1",[11,2.207,39,0.962,43,1.696,59,1.52,62,1.196,63,0.5,66,1.963,67,1.389,68,2.029,69,0.898,70,0.945,71,1.52,72,1.696,73,1.389,74,2.997,75,1.963,76,1.52,77,1.696,78,2.741,79,1.196,80,1.963,81,1.963,82,1.696,83,1.389,84,1.284,85,1.963,86,1.963,87,1.696,88,1.696,89,1.284,90,1.284,91,1.52,92,1.284,93,0.595]],["title/2",[63,0.409,94,1.356,95,2.906,96,2.655]],["description/2",[11,1.236,39,0.779,63,0.28,68,1.99,71,1.988,72,2.218,73,1.816,74,1.678,77,2.218,78,2.218,79,1.564,84,1.678,87,2.218,88,2.218,89,1.678,90,1.678,91,1.988,92,1.678,93,0.779,97,2.567,98,1.988,99,2.218,100,0.849,101,1.305,102,2.567,103,2.567,104,2.567,105,2.567,106,1.564,107,2.567]],["title/3",[63,0.515,108,3.653]],["description/3",[11,1.128,39,0.71,60,2.825,63,0.489,64,0.599,65,1.19,67,1.656,89,1.531,90,1.531,92,1.531,100,0.774,101,1.19,108,2.825,109,2.342,110,3.649,111,1.813,112,2.342,113,3.152,114,2.342,115,2.342,116,1.813,117,1.128,118,0.809,119,2.342,120,2.342,121,1.813,122,2.342,123,1.531,124,2.342,125,2.023]],["title/4",[65,2.125,101,2.125,126,3.612]],["description/4",[15,1.988,21,1.564,63,0.28,64,0.657,73,1.816,83,1.816,84,1.678,92,1.678,94,0.927,111,3.032,113,2.218,125,2.218,127,2.218,128,2.218,129,2.218,130,1.236,131,2.218,132,2.218,133,2.218,134,2.218,135,1.988,136,1.678,137,3.383,138,2.218,139,1.988,140,2.218,141,3.383,142,2.218]],["title/5",[65,2.125,93,1.268,126,3.612]],["description/5",[15,1.641,21,1.291,62,1.291,64,0.863,73,1.499,79,1.291,83,2.385,84,1.385,91,1.641,92,2.205,94,1.218,101,1.714,111,2.611,127,1.831,128,1.831,129,1.831,131,1.831,132,1.831,133,1.831,134,1.831,135,1.641,136,1.385,137,2.914,138,1.831,139,1.641,140,1.831,141,2.914,142,1.831,143,1.831,144,1.499,145,2.119,146,1.641,147,2.119,148,2.119]],["title/6",[63,0.409,116,2.906,149,3.243,150,3.243]],["description/6",[13,2.441,116,5.02,150,4.61]],["title/7",[64,0.96,94,1.356,101,1.908,146,2.906]],["description/7",[39,0.643,59,1.641,63,0.231,64,1.075,65,1.077,79,1.291,84,1.385,94,1.218,96,2.385,100,0.701,101,1.077,143,2.914,144,3.387,146,1.641,151,1.831,152,1.291,153,2.119,154,2.611,155,1.831,156,2.119,157,2.119,158,1.831,159,2.119,160,2.119,161,1.641,162,2.119,163,2.119,164,2.119,165,2.119,166,2.119,167,2.119,168,2.119,169,1.641]],["title/8",[63,0.456,170,4.181,171,3.237]],["description/8",[11,1.607,39,1.012,63,0.518,64,0.854,65,1.696,70,1.607,100,1.103,144,2.36,171,3.68,172,4.753,173,3.337,174,3.337,175,3.337,176,3.337,177,3.337,178,3.337]],["title/9",[63,0.456,117,2.013,179,1.912]],["description/9",[39,1.301,63,0.579,68,1.758,69,1.582,70,1.666,71,1.694,74,1.431,76,1.694,79,2.108,83,2.447,89,1.431,93,0.664,94,0.79,98,2.679,100,1.144,117,1.054,118,1.482,135,1.694,169,1.694,180,1.891,181,2.188,182,1.891,183,2.188,184,2.188,185,1.891]],["title/10",[63,0.515,179,2.158]],["description/10",[93,1.686,185,4.802,186,2.99]],["title/11",[117,1.808,118,1.297,187,3.243,188,3.753]],["description/11",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,189,4.117]],["title/12",[179,2.158,187,4.076]],["description/12",[93,1.686,186,2.99,189,4.802]],["title/13",[10,2.906,117,1.808,118,1.297,161,2.906]],["description/13",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,190,4.117]],["title/14",[10,3.237,118,1.444,161,3.237]],["description/14",[93,1.686,186,2.99,190,4.802]],["title/15",[117,2.013,191,3.612,192,2.388]],["description/15",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,193,4.117]],["title/16",[191,4.076,192,2.695]],["description/16",[93,1.686,186,2.99,193,4.802]],["title/17",[117,1.808,194,1.241,195,3.243,196,1.808]],["description/17",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,197,4.117]],["title/18",[194,1.383,195,3.612,196,2.013]],["description/18",[93,1.686,186,2.99,197,4.802]],["title/19",[64,0.871,94,1.23,179,1.557,196,1.64,198,2.408]],["description/19",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,199,4.765]],["title/20",[64,0.797,94,1.125,179,1.425,196,1.501,200,2.037,201,2.413]],["description/20",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,202,4.765]],["title/21",[179,1.912,203,3.237,204,3.237]],["description/21",[64,1.264,93,1.499,94,1.785,101,2.512,186,2.658,205,4.269]],["title/22",[64,1.07,158,3.612,179,1.912]],["description/22",[93,1.686,186,2.99,205,4.802]],["title/23",[106,2.548,179,1.912,206,2.734]],["description/23",[63,0.56,69,2.347,93,1.556,100,1.697,207,4.433]],["title/24",[106,2.548,179,1.912,206,2.734]],["description/24",[93,1.686,186,2.99,207,4.802]],["title/25",[13,1.425,152,1.899,194,1.03,208,2.204,209,1.78,210,2.204]],["description/25",[13,1.387,21,1.848,39,0.92,63,0.572,100,1.003,118,1.048,152,1.848,194,1.003,208,2.146,209,1.733,210,2.146,211,2.621,212,3.033,213,2.621,214,2.349,215,2.621,216,2.621,217,2.621,218,1.848,219,2.621,220,3.033]],["title/26",[13,1.425,152,1.899,194,1.03,208,2.204,210,2.204,221,1.78]],["description/26",[13,1.42,21,1.891,39,0.941,63,0.58,100,1.026,118,1.072,152,1.891,194,1.026,208,2.195,210,2.195,211,2.682,213,2.682,214,2.403,215,2.682,216,2.682,217,2.682,218,1.891,219,2.682,221,1.773,222,3.104]],["title/27",[63,0.515,223,4.076]],["description/27",[21,1.694,24,2.402,39,0.843,50,3.594,63,0.603,69,1.272,89,2.72,117,1.339,118,0.961,130,1.339,136,1.818,144,1.967,224,2.781,225,2.781,226,2.781,227,2.781,228,2.402,229,2.153,230,2.781,231,2.781,232,2.781,233,2.402]],["title/28",[63,0.456,228,3.612,234,3.237]],["description/28",[11,2.471,63,0.56,179,2.347,223,4.433,233,4.433]],["title/29",[118,1.783,235,2.287,236,2.454]],["description/29",[13,1.174,64,0.657,117,1.236,118,1.353,121,3.032,130,1.236,169,1.988,235,1.564,236,2.561,237,1.816,238,2.218,239,2.567,240,3.032,241,2.218,242,2.218,243,2.218,244,1.816,245,2.218,246,2.218,247,3.383,248,1.816,249,3.383,250,2.567,251,2.567,252,2.218]],["title/30",[118,1.444,235,2.548,236,2.734]],["description/30",[252,5.238]],["title/31",[118,1.783,192,2.144,235,2.287]],["description/31",[13,1.299,64,0.727,117,1.368,118,0.981,121,2.199,130,1.368,192,1.622,194,0.939,235,1.73,237,2.009,238,3.651,240,3.272,241,2.453,242,2.453,243,2.453,244,2.009,245,2.453,246,2.453,247,2.453,248,2.009,249,2.453,253,2.84,254,2.84,255,2.453]],["title/32",[118,1.297,192,2.144,235,2.287,240,2.906]],["description/32",[255,5.238]],["title/33",[64,0.735,94,1.037,95,2.224,118,0.992,179,1.314,256,2.481,257,1.136]],["description/33",[39,1.094,63,0.548,69,1.65,70,1.737,74,2.358,93,1.094,100,1.193,139,2.793,234,2.793,258,3.607,259,3.607,260,3.607,261,3.607,262,3.607,263,3.116]],["title/34",[64,0.797,94,1.125,95,2.413,118,1.076,256,2.692,257,1.233]],["description/34",[263,5.238]],["title/35",[130,2.272,264,2.538]],["description/35",[64,1.365,65,2.712,264,3.487]],["title/36",[152,2.548,264,2.249,265,4.181]],["description/36",[266,6.064]],["title/37",[64,0.735,65,1.46,96,2.032,123,1.878,229,2.224,267,2.032,268,2.481]],["description/37",[68,2.188,123,2.814,194,1.423,229,3.333,267,3.045,268,3.719,269,3.045,270,3.333,271,4.305,272,4.305]],["title/38",[19,2.224,64,0.735,65,1.46,96,2.032,123,1.878,267,2.032,273,2.481]],["description/38",[19,3.826,123,3.231,267,3.495,269,3.495,273,4.269,274,4.942]],["title/39",[194,1.383,264,2.249,275,4.181]],["description/39",[276,6.064]],["title/40",[63,0.515,264,2.538]],["description/40",[63,0.582,99,4.61,264,2.87,277,5.337]],["title/41",[3,3.653,278,4.076]],["description/41",[279,5.238]],["title/42",[3,3.237,278,3.612,280,2.734]],["description/42",[279,5.238]],["title/43",[13,2.158,281,3.085]],["description/43",[281,3.965]],["title/44",[64,1.07,94,1.51,281,2.734]],["description/44",[64,1.313,94,1.853,282,4.433,283,4.433,284,5.132]],["title/45",[98,3.653,281,3.085]],["description/45",[82,4.117,136,3.116,281,3.116,285,4.765,286,4.765,287,4.765,288,4.765]],["title/46",[63,0.456,209,2.388,257,1.654]],["description/46",[62,2.392,63,0.58,200,2.566,257,1.553,289,3.242,290,3.391,291,2.776,292,3.391,293,3.391,294,2.566,295,3.925]],["title/47",[40,1.584,62,1.899,63,0.493,209,1.78,257,1.233]],["description/47",[40,1.884,63,0.558,68,2.601,218,2.259,257,2.024,270,2.87,289,3.118,296,3.203,297,2.622,298,2.622,299,3.203]],["title/48",[40,1.731,63,0.371,209,1.945,257,1.347,280,2.226]],["description/48",[11,0.765,39,0.482,40,1.355,63,0.291,67,1.124,68,2.048,90,1.039,100,0.526,106,0.968,154,1.231,198,1.124,201,1.231,203,1.231,204,1.231,206,1.039,209,0.908,218,0.968,248,1.124,257,1.922,269,1.124,280,1.039,289,1.624,291,1.124,294,1.743,297,1.124,298,1.124,299,1.373,300,1.373,301,1.373,302,1.373,303,1.373,304,1.373,305,1.373,306,1.373,307,1.373,308,1.373,309,1.373,310,2.303,311,1.373,312,1.373,313,1.373,314,1.373,315,1.373,316,1.373,317,1.589,318,1.373,319,1.373,320,1.373,321,1.373,322,1.373]],["title/49",[63,0.456,221,2.388,257,1.654]],["description/49",[39,1.191,63,0.428,100,1.298,200,2.566,257,1.553,289,3.242,290,3.391,291,2.776,292,3.391,293,3.391,294,2.566,323,3.925]],["title/50",[40,1.584,62,1.899,63,0.493,221,1.78,257,1.233]],["description/50",[40,1.884,63,0.558,68,2.601,218,2.259,257,2.024,270,2.87,289,3.118,296,3.203,297,2.622,298,2.622,324,3.203]],["title/51",[40,1.908,63,0.409,257,1.485,280,2.454]],["description/51",[9,1.142,11,0.637,39,0.401,40,1.815,63,0.249,67,0.935,68,2.048,90,0.864,100,0.437,106,0.805,154,1.024,180,1.142,182,1.142,194,0.437,198,0.935,201,1.024,203,1.024,204,1.024,206,0.864,214,1.024,218,0.805,221,0.755,248,0.935,257,1.973,280,0.864,289,2.177,291,0.935,294,1.964,297,0.935,298,0.935,300,1.142,301,1.142,302,1.142,303,1.142,304,1.142,305,1.142,306,1.142,307,1.142,308,1.142,309,1.142,310,1.969,311,1.142,312,1.142,313,1.142,314,1.142,315,1.142,316,1.142,318,1.142,319,1.142,320,1.142,321,1.969,322,1.142,324,1.142,325,1.322,326,1.322,327,1.142,328,1.322,329,1.322]],["title/52",[79,2.548,196,2.013,221,2.388]],["description/52",[330,6.064]],["title/53",[13,1.717,130,1.808,331,3.243,332,3.243]],["description/53",[333,6.064]],["title/54",[11,0.594,13,0.564,64,0.315,106,0.751,130,0.594,136,0.806,149,1.065,151,1.065,196,1.033,198,0.872,206,0.806,209,1.225,269,0.872,294,0.806,327,1.065,331,1.065,332,1.065,334,1.232,335,1.232,336,1.232,337,1.232,338,1.232]],["description/54",[339,6.064]],["title/55",[200,2.734,282,3.612,340,4.181]],["description/55",[341,6.064]],["title/56",[108,2.906,196,1.808,237,2.655,342,3.243]],["description/56",[192,2.722,244,3.371,343,4.765,344,4.765,345,4.765,346,4.765,347,4.765]],["title/57",[194,1.241,196,1.808,237,2.655,342,3.243]],["description/57",[64,1.418,94,1.506,192,2.382,194,1.832,200,2.727,244,2.95,348,4.17,349,4.17,350,4.17]],["title/58",[11,1.383,118,0.992,194,0.95,196,1.383,236,1.878,351,2.872,352,2.872]],["description/58",[353,6.064]],["title/59",[194,1.241,196,1.808,221,2.144,236,2.454]],["description/59",[354,6.064]],["title/60",[194,1.383,355,4.181,356,2.957]],["description/60",[64,1.418,94,2.001,101,2.119,130,2.008,171,3.229,194,1.379,283,3.603,356,2.95,357,4.17]],["title/61",[194,1.383,264,2.249,356,2.957]],["description/61",[60,1.95,64,1.201,68,1.28,74,1.647,76,2.989,94,1.695,101,1.28,130,1.213,155,2.176,194,1.74,234,1.95,264,1.355,356,3.319,358,2.519,359,2.519,360,2.519,361,2.519,362,2.519,363,2.519,364,2.519,365,2.519,366,2.519]],["title/62",[130,2.013,367,3.612,368,4.181]],["description/62",[367,5.238]]],"invertedIndex":[["",{"_index":68,"title":{},"description":{"1":{},"2":{},"9":{},"37":{},"47":{},"48":{},"50":{},"51":{},"61":{}}}],["0",{"_index":297,"title":{},"description":{"47":{},"48":{},"50":{},"51":{}}}],["1",{"_index":270,"title":{},"description":{"37":{},"47":{},"50":{}}}],["100",{"_index":107,"title":{},"description":{"2":{}}}],["1024x512",{"_index":308,"title":{},"description":{"48":{},"51":{}}}],["16",{"_index":326,"title":{},"description":{"51":{}}}],["16-bit",{"_index":213,"title":{},"description":{"25":{},"26":{}}}],["1d",{"_index":331,"title":{"53":{},"54":{}},"description":{}}],["32-bit",{"_index":327,"title":{"54":{}},"description":{"51":{}}}],["4-byte",{"_index":317,"title":{},"description":{"48":{}}}],["8",{"_index":321,"title":{},"description":{"48":{},"51":{}}}],["accept",{"_index":114,"title":{},"description":{"3":{}}}],["account",{"_index":301,"title":{},"description":{"48":{},"51":{}}}],["acquisit",{"_index":65,"title":{"1":{},"4":{},"5":{},"37":{},"38":{}},"description":{"3":{},"7":{},"8":{},"35":{}}}],["actual",{"_index":296,"title":{},"description":{"47":{},"50":{}}}],["adjust",{"_index":242,"title":{},"description":{"29":{},"31":{}}}],["affect",{"_index":145,"title":{},"description":{"5":{}}}],["again",{"_index":181,"title":{},"description":{"9":{}}}],["algorithm",{"_index":188,"title":{"11":{}},"description":{}}],["allow",{"_index":50,"title":{},"description":{"0":{},"27":{}}}],["alway",{"_index":176,"title":{},"description":{"8":{}}}],["and/or",{"_index":226,"title":{},"description":{"27":{}}}],["anytim",{"_index":186,"title":{},"description":{"10":{},"12":{},"14":{},"16":{},"18":{},"21":{},"22":{},"24":{}}}],["api",{"_index":2,"title":{},"description":{"0":{}}}],["appli",{"_index":9,"title":{},"description":{"0":{},"51":{}}}],["applic",{"_index":17,"title":{},"description":{"0":{}}}],["approach",{"_index":30,"title":{},"description":{"0":{}}}],["array",{"_index":269,"title":{"54":{}},"description":{"37":{},"38":{},"48":{}}}],["asic",{"_index":175,"title":{},"description":{"8":{}}}],["assign",{"_index":315,"title":{},"description":{"48":{},"51":{}}}],["async",{"_index":87,"title":{},"description":{"1":{},"2":{}}}],["async_start",{"_index":119,"title":{},"description":{"3":{}}}],["automat",{"_index":182,"title":{},"description":{"9":{},"51":{}}}],["avail",{"_index":234,"title":{"28":{}},"description":{"33":{},"61":{}}}],["azimuth",{"_index":206,"title":{"23":{},"24":{},"54":{}},"description":{"48":{},"51":{}}}],["back",{"_index":168,"title":{},"description":{"7":{}}}],["base",{"_index":251,"title":{},"description":{"29":{}}}],["be",{"_index":157,"title":{},"description":{"7":{}}}],["beam",{"_index":302,"title":{},"description":{"48":{},"51":{}}}],["befor",{"_index":177,"title":{},"description":{"8":{}}}],["behavior",{"_index":110,"title":{},"description":{"3":{}}}],["between",{"_index":364,"title":{},"description":{"61":{}}}],["binari",{"_index":209,"title":{"25":{},"46":{},"47":{},"48":{},"54":{}},"description":{"25":{},"48":{}}}],["bit",{"_index":320,"title":{},"description":{"48":{},"51":{}}}],["blob",{"_index":212,"title":{},"description":{"25":{}}}],["block",{"_index":111,"title":{},"description":{"3":{},"4":{},"5":{}}}],["bodi",{"_index":122,"title":{},"description":{"3":{}}}],["both",{"_index":307,"title":{},"description":{"48":{},"51":{}}}],["buffer",{"_index":356,"title":{"60":{},"61":{}},"description":{"60":{},"61":{}}}],["calcul",{"_index":256,"title":{"33":{},"34":{}},"description":{}}],["calibr",{"_index":98,"title":{"45":{}},"description":{"2":{},"9":{}}}],["call",{"_index":60,"title":{},"description":{"0":{},"3":{},"61":{}}}],["cancel",{"_index":146,"title":{"7":{}},"description":{"5":{},"7":{}}}],["card",{"_index":153,"title":{},"description":{"7":{}}}],["case",{"_index":67,"title":{},"description":{"1":{},"3":{},"48":{},"51":{}}}],["cbor",{"_index":342,"title":{"56":{},"57":{}},"description":{}}],["cell",{"_index":82,"title":{},"description":{"1":{},"45":{}}}],["chang",{"_index":117,"title":{"9":{},"11":{},"13":{},"15":{},"17":{}},"description":{"3":{},"9":{},"27":{},"29":{},"31":{}}}],["choos",{"_index":24,"title":{},"description":{"0":{},"27":{}}}],["clarif",{"_index":1,"title":{"0":{}},"description":{}}],["clear",{"_index":355,"title":{"60":{}},"description":{}}],["client",{"_index":15,"title":{},"description":{"0":{},"4":{},"5":{}}}],["close",{"_index":73,"title":{},"description":{"1":{},"2":{},"4":{},"5":{}}}],["code",{"_index":19,"title":{"38":{}},"description":{"0":{},"38":{}}}],["collect",{"_index":94,"title":{"2":{},"7":{},"19":{},"20":{},"33":{},"34":{},"44":{}},"description":{"4":{},"5":{},"7":{},"9":{},"21":{},"44":{},"57":{},"60":{},"61":{}}}],["come",{"_index":348,"title":{},"description":{"57":{}}}],["command",{"_index":144,"title":{},"description":{"5":{},"7":{},"8":{},"27":{}}}],["commun",{"_index":57,"title":{},"description":{"0":{}}}],["config/azim_int",{"_index":207,"title":{},"description":{"23":{},"24":{}}}],["config/dark_mask",{"_index":263,"title":{},"description":{"33":{},"34":{}}}],["config/detector",{"_index":185,"title":{},"description":{"9":{},"10":{}}}],["config/file_writ",{"_index":190,"title":{},"description":{"13":{},"14":{}}}],["config/image_format",{"_index":197,"title":{},"description":{"17":{},"18":{}}}],["config/image_format/convers",{"_index":202,"title":{},"description":{"20":{}}}],["config/image_format/raw",{"_index":199,"title":{},"description":{"19":{}}}],["config/index",{"_index":189,"title":{},"description":{"11":{},"12":{}}}],["config/instru",{"_index":193,"title":{},"description":{"15":{},"16":{}}}],["config/internal_generator_imag",{"_index":220,"title":{},"description":{"25":{}}}],["config/internal_generator_image.tiff",{"_index":222,"title":{},"description":{"26":{}}}],["config/mask",{"_index":295,"title":{},"description":{"46":{}}}],["config/mask.tiff",{"_index":323,"title":{},"description":{"49":{}}}],["config/roi",{"_index":279,"title":{},"description":{"41":{},"42":{}}}],["config/select_detector",{"_index":233,"title":{},"description":{"27":{},"28":{}}}],["config/spot_find",{"_index":205,"title":{},"description":{"21":{},"22":{}}}],["config/user_mask",{"_index":299,"title":{},"description":{"47":{},"48":{}}}],["config/user_mask.tiff",{"_index":324,"title":{},"description":{"50":{},"51":{}}}],["config/zeromq_metadata",{"_index":255,"title":{},"description":{"31":{},"32":{}}}],["config/zeromq_preview",{"_index":252,"title":{},"description":{"29":{},"30":{}}}],["configur",{"_index":179,"title":{"9":{},"10":{},"12":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"33":{}},"description":{"28":{}}}],["connect",{"_index":141,"title":{},"description":{"4":{},"5":{}}}],["consist",{"_index":230,"title":{},"description":{"27":{}}}],["contain",{"_index":244,"title":{},"description":{"29":{},"31":{},"56":{},"57":{}}}],["control",{"_index":224,"title":{},"description":{"27":{}}}],["convers",{"_index":201,"title":{"20":{}},"description":{"48":{},"51":{}}}],["convert",{"_index":311,"title":{},"description":{"48":{},"51":{}}}],["coordin",{"_index":218,"title":{},"description":{"25":{},"26":{},"47":{},"48":{},"50":{},"51":{}}}],["copyleft",{"_index":7,"title":{},"description":{"0":{}}}],["cover",{"_index":254,"title":{},"description":{"31":{}}}],["cpu",{"_index":159,"title":{},"description":{"7":{}}}],["current",{"_index":96,"title":{"2":{},"37":{},"38":{}},"description":{"7":{}}}],["custom",{"_index":352,"title":{"58":{}},"description":{}}],["dark",{"_index":95,"title":{"2":{},"33":{},"34":{}},"description":{}}],["data",{"_index":64,"title":{"1":{},"7":{},"19":{},"20":{},"22":{},"33":{},"34":{},"37":{},"38":{},"44":{},"54":{}},"description":{"3":{},"4":{},"5":{},"7":{},"8":{},"21":{},"29":{},"31":{},"35":{},"44":{},"57":{},"60":{},"61":{}}}],["dataset",{"_index":343,"title":{},"description":{"56":{}}}],["deactiv",{"_index":172,"title":{},"description":{"8":{}}}],["dectri",{"_index":258,"title":{},"description":{"33":{}}}],["default",{"_index":109,"title":{},"description":{"3":{}}}],["definit",{"_index":3,"title":{"41":{},"42":{}},"description":{"0":{}}}],["depend",{"_index":219,"title":{},"description":{"25":{},"26":{}}}],["deriv",{"_index":47,"title":{},"description":{"0":{}}}],["detector",{"_index":63,"title":{"1":{},"2":{},"3":{},"6":{},"8":{},"9":{},"10":{},"27":{},"28":{},"40":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}},"description":{"1":{},"2":{},"3":{},"4":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"23":{},"25":{},"26":{},"27":{},"28":{},"33":{},"40":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}}}],["detector/statu",{"_index":277,"title":{},"description":{"40":{}}}],["develop",{"_index":37,"title":{},"description":{"0":{}}}],["devic",{"_index":265,"title":{"36":{}},"description":{}}],["distribut",{"_index":22,"title":{},"description":{"0":{}}}],["doesn't",{"_index":335,"title":{"54":{}},"description":{}}],["don't",{"_index":314,"title":{},"description":{"48":{},"51":{}}}],["done",{"_index":93,"title":{"5":{}},"description":{"1":{},"2":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"33":{}}}],["dure",{"_index":76,"title":{},"description":{"1":{},"9":{},"61":{}}}],["e.g",{"_index":344,"title":{},"description":{"56":{}}}],["each",{"_index":285,"title":{},"description":{"45":{}}}],["effect",{"_index":169,"title":{},"description":{"7":{},"9":{},"29":{}}}],["eiger",{"_index":261,"title":{},"description":{"33":{}}}],["ensur",{"_index":92,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{}}}],["error",{"_index":70,"title":{},"description":{"1":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"33":{}}}],["etc",{"_index":46,"title":{},"description":{"0":{}}}],["event",{"_index":273,"title":{"38":{}},"description":{"38":{}}}],["exampl",{"_index":300,"title":{},"description":{"48":{},"51":{}}}],["except",{"_index":25,"title":{},"description":{"0":{}}}],["execut",{"_index":83,"title":{},"description":{"1":{},"4":{},"5":{},"9":{}}}],["expect",{"_index":316,"title":{},"description":{"48":{},"51":{}}}],["experiment",{"_index":345,"title":{},"description":{"56":{}}}],["explicitli",{"_index":38,"title":{},"description":{"0":{}}}],["extend",{"_index":138,"title":{},"description":{"4":{},"5":{}}}],["extern",{"_index":127,"title":{},"description":{"4":{},"5":{}}}],["few",{"_index":85,"title":{},"description":{"1":{}}}],["file",{"_index":10,"title":{"13":{},"14":{}},"description":{"0":{}}}],["find",{"_index":204,"title":{"21":{}},"description":{"48":{},"51":{}}}],["finish",{"_index":143,"title":{},"description":{"5":{},"7":{}}}],["float",{"_index":334,"title":{"54":{}},"description":{}}],["format",{"_index":196,"title":{"17":{},"18":{},"19":{},"20":{},"52":{},"54":{},"56":{},"57":{},"58":{},"59":{}},"description":{}}],["fpga",{"_index":152,"title":{"25":{},"26":{},"36":{}},"description":{"7":{},"25":{},"26":{}}}],["fpga_statu",{"_index":266,"title":{},"description":{"36":{}}}],["frame",{"_index":156,"title":{},"description":{"7":{}}}],["full",{"_index":200,"title":{"20":{},"55":{}},"description":{"46":{},"49":{},"57":{}}}],["function",{"_index":88,"title":{},"description":{"1":{},"2":{}}}],["gap",{"_index":313,"title":{},"description":{"48":{},"51":{}}}],["gcc",{"_index":33,"title":{},"description":{"0":{}}}],["gener",{"_index":13,"title":{"25":{},"26":{},"43":{},"53":{},"54":{}},"description":{"0":{},"6":{},"25":{},"26":{},"29":{},"31":{}}}],["geometri",{"_index":346,"title":{},"description":{"56":{}}}],["given",{"_index":162,"title":{},"description":{"7":{}}}],["goe",{"_index":360,"title":{},"description":{"61":{}}}],["good",{"_index":298,"title":{},"description":{"47":{},"48":{},"50":{},"51":{}}}],["gpl",{"_index":6,"title":{},"description":{"0":{}}}],["gpl-3.0",{"_index":5,"title":{},"description":{"0":{}}}],["gracefulli",{"_index":165,"title":{},"description":{"7":{}}}],["happen",{"_index":211,"title":{},"description":{"25":{},"26":{}}}],["header",{"_index":32,"title":{},"description":{"0":{}}}],["here",{"_index":241,"title":{},"description":{"29":{},"31":{}}}],["high",{"_index":173,"title":{},"description":{"8":{}}}],["hour",{"_index":104,"title":{},"description":{"2":{}}}],["http",{"_index":247,"title":{},"description":{"29":{},"31":{}}}],["i.",{"_index":180,"title":{},"description":{"9":{},"51":{}}}],["id",{"_index":229,"title":{"37":{}},"description":{"27":{},"37":{}}}],["idl",{"_index":100,"title":{},"description":{"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"23":{},"25":{},"26":{},"33":{},"48":{},"49":{},"51":{}}}],["ignor",{"_index":248,"title":{},"description":{"29":{},"31":{},"48":{},"51":{}}}],["imag",{"_index":194,"title":{"17":{},"18":{},"25":{},"26":{},"39":{},"57":{},"58":{},"59":{},"60":{},"61":{}},"description":{"25":{},"26":{},"31":{},"37":{},"51":{},"57":{},"60":{},"61":{}}}],["image.cbor",{"_index":365,"title":{},"description":{"61":{}}}],["image_buffer/clear",{"_index":357,"title":{},"description":{"60":{}}}],["image_buffer/image.cbor",{"_index":350,"title":{},"description":{"57":{}}}],["image_buffer/image.jpeg",{"_index":353,"title":{},"description":{"58":{}}}],["image_buffer/image.tiff",{"_index":354,"title":{},"description":{"59":{}}}],["image_buffer/start.cbor",{"_index":347,"title":{},"description":{"56":{}}}],["image_buffer/statu",{"_index":366,"title":{},"description":{"61":{}}}],["image_pusher/statu",{"_index":276,"title":{},"description":{"39":{}}}],["immedi",{"_index":124,"title":{},"description":{"3":{}}}],["implement",{"_index":16,"title":{},"description":{"0":{}}}],["impos",{"_index":54,"title":{},"description":{"0":{}}}],["inact",{"_index":69,"title":{},"description":{"1":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"23":{},"27":{},"33":{}}}],["includ",{"_index":358,"title":{},"description":{"61":{}}}],["indefinit",{"_index":133,"title":{},"description":{"4":{},"5":{}}}],["index",{"_index":187,"title":{"11":{},"12":{}},"description":{}}],["inform",{"_index":151,"title":{"54":{}},"description":{"7":{}}}],["initi",{"_index":62,"title":{"1":{},"47":{},"50":{}},"description":{"1":{},"5":{},"46":{}}}],["instead",{"_index":80,"title":{},"description":{"1":{}}}],["instrument",{"_index":191,"title":{"15":{},"16":{}},"description":{}}],["integ",{"_index":214,"title":{},"description":{"25":{},"26":{},"51":{}}}],["integr",{"_index":106,"title":{"23":{},"24":{},"54":{}},"description":{"2":{},"48":{},"51":{}}}],["intend",{"_index":49,"title":{},"description":{"0":{}}}],["interact",{"_index":18,"title":{},"description":{"0":{}}}],["interfac",{"_index":43,"title":{},"description":{"0":{},"1":{}}}],["intern",{"_index":210,"title":{"25":{},"26":{}},"description":{"25":{},"26":{}}}],["ioctl",{"_index":45,"title":{},"description":{"0":{}}}],["jfjoch_brok",{"_index":368,"title":{"62":{}},"description":{}}],["jpeg",{"_index":351,"title":{"58":{}},"description":{}}],["jungfrau",{"_index":99,"title":{},"description":{"2":{},"40":{}}}],["jungfraujoch",{"_index":130,"title":{"35":{},"53":{},"54":{},"62":{}},"description":{"4":{},"27":{},"29":{},"31":{},"60":{},"61":{}}}],["kernel",{"_index":36,"title":{},"description":{"0":{}}}],["kernel'",{"_index":29,"title":{},"description":{"0":{}}}],["last",{"_index":283,"title":{},"description":{"44":{},"60":{}}}],["latest",{"_index":349,"title":{},"description":{"57":{}}}],["latter",{"_index":312,"title":{},"description":{"48":{},"51":{}}}],["librari",{"_index":35,"title":{},"description":{"0":{}}}],["licens",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["limit",{"_index":338,"title":{"54":{}},"description":{}}],["linux",{"_index":28,"title":{},"description":{"0":{}}}],["list",{"_index":228,"title":{"28":{}},"description":{"27":{}}}],["load",{"_index":208,"title":{"25":{},"26":{}},"description":{"25":{},"26":{}}}],["long",{"_index":105,"title":{},"description":{"2":{}}}],["make",{"_index":163,"title":{},"description":{"7":{}}}],["mask",{"_index":257,"title":{"33":{},"34":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}},"description":{"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}}}],["mean",{"_index":293,"title":{},"description":{"46":{},"49":{}}}],["mechan",{"_index":61,"title":{},"description":{"0":{}}}],["mere",{"_index":42,"title":{},"description":{"0":{}}}],["messag",{"_index":237,"title":{"56":{},"57":{}},"description":{"29":{},"31":{}}}],["metadata",{"_index":192,"title":{"15":{},"16":{},"31":{},"32":{}},"description":{"31":{},"56":{},"57":{}}}],["minut",{"_index":86,"title":{},"description":{"1":{}}}],["misbehav",{"_index":304,"title":{},"description":{"48":{},"51":{}}}],["mode",{"_index":306,"title":{},"description":{"48":{},"51":{}}}],["modul",{"_index":310,"title":{},"description":{"48":{},"51":{}}}],["module/storag",{"_index":286,"title":{},"description":{"45":{}}}],["moment",{"_index":259,"title":{},"description":{"33":{}}}],["more",{"_index":361,"title":{},"description":{"61":{}}}],["multipl",{"_index":225,"title":{},"description":{"27":{}}}],["need",{"_index":90,"title":{},"description":{"1":{},"2":{},"3":{},"48":{},"51":{}}}],["network",{"_index":59,"title":{},"description":{"0":{},"1":{},"7":{}}}],["new",{"_index":183,"title":{},"description":{"9":{}}}],["number",{"_index":215,"title":{},"description":{"25":{},"26":{}}}],["nxmx",{"_index":291,"title":{},"description":{"46":{},"48":{},"49":{},"51":{}}}],["on",{"_index":89,"title":{},"description":{"1":{},"2":{},"3":{},"9":{},"27":{}}}],["onc",{"_index":102,"title":{},"description":{"2":{}}}],["openapi",{"_index":14,"title":{},"description":{"0":{}}}],["oper",{"_index":74,"title":{},"description":{"1":{},"2":{},"9":{},"33":{},"61":{}}}],["option",{"_index":250,"title":{},"description":{"29":{}}}],["output",{"_index":195,"title":{"17":{},"18":{}},"description":{}}],["pedest",{"_index":79,"title":{"52":{}},"description":{"1":{},"2":{},"5":{},"7":{},"9":{}}}],["per",{"_index":103,"title":{},"description":{"2":{}}}],["period",{"_index":134,"title":{},"description":{"4":{},"5":{}}}],["pixel",{"_index":289,"title":{},"description":{"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}}}],["plot",{"_index":332,"title":{"53":{},"54":{}},"description":{}}],["point",{"_index":262,"title":{},"description":{"33":{}}}],["possibl",{"_index":139,"title":{},"description":{"4":{},"5":{},"33":{}}}],["post",{"_index":78,"title":{},"description":{"1":{},"2":{}}}],["power",{"_index":178,"title":{},"description":{"8":{}}}],["prepar",{"_index":170,"title":{"8":{}},"description":{}}],["preview",{"_index":236,"title":{"29":{},"30":{},"58":{},"59":{}},"description":{"29":{}}}],["preview/pedestal.tiff",{"_index":330,"title":{},"description":{"52":{}}}],["preview/plot",{"_index":333,"title":{},"description":{"53":{}}}],["preview/plot.bin",{"_index":339,"title":{},"description":{"54":{}}}],["procedur",{"_index":135,"title":{},"description":{"4":{},"5":{},"9":{}}}],["process",{"_index":158,"title":{"22":{}},"description":{"7":{}}}],["program",{"_index":41,"title":{},"description":{"0":{}}}],["provid",{"_index":136,"title":{"54":{}},"description":{"4":{},"5":{},"27":{},"45":{}}}],["provis",{"_index":8,"title":{},"description":{"0":{}}}],["psi",{"_index":260,"title":{},"description":{"33":{}}}],["pub",{"_index":253,"title":{},"description":{"31":{}}}],["puls",{"_index":268,"title":{"37":{}},"description":{"37":{}}}],["pusher",{"_index":275,"title":{"39":{}},"description":{}}],["put",{"_index":249,"title":{},"description":{"29":{},"31":{}}}],["raw",{"_index":198,"title":{"19":{},"54":{}},"description":{"48":{},"51":{}}}],["raw/convert",{"_index":217,"title":{},"description":{"25":{},"26":{}}}],["readi",{"_index":113,"title":{},"description":{"3":{},"4":{}}}],["recommend",{"_index":77,"title":{},"description":{"1":{},"2":{}}}],["reconfigur",{"_index":75,"title":{},"description":{"1":{}}}],["record",{"_index":271,"title":{},"description":{"37":{}}}],["regardless",{"_index":55,"title":{},"description":{"0":{}}}],["region",{"_index":305,"title":{},"description":{"48":{},"51":{}}}],["region-of-interest",{"_index":227,"title":{},"description":{"27":{}}}],["reiniti",{"_index":232,"title":{},"description":{"27":{}}}],["replac",{"_index":363,"title":{},"description":{"61":{}}}],["request",{"_index":121,"title":{},"description":{"3":{},"29":{},"31":{}}}],["requir",{"_index":21,"title":{},"description":{"0":{},"4":{},"5":{},"25":{},"26":{},"27":{}}}],["respons",{"_index":231,"title":{},"description":{"27":{}}}],["result",{"_index":282,"title":{"55":{}},"description":{"44":{}}}],["result/scan",{"_index":341,"title":{},"description":{"55":{}}}],["retri",{"_index":142,"title":{},"description":{"4":{},"5":{}}}],["return",{"_index":123,"title":{"37":{},"38":{}},"description":{"3":{},"37":{},"38":{}}}],["roi",{"_index":278,"title":{"41":{},"42":{}},"description":{}}],["run",{"_index":101,"title":{"4":{},"7":{}},"description":{"2":{},"3":{},"5":{},"7":{},"21":{},"60":{},"61":{}}}],["runtim",{"_index":34,"title":{},"description":{"0":{}}}],["safeti",{"_index":140,"title":{},"description":{"4":{},"5":{}}}],["save",{"_index":184,"title":{},"description":{"9":{}}}],["scan",{"_index":340,"title":{"55":{}},"description":{}}],["script",{"_index":128,"title":{},"description":{"4":{},"5":{}}}],["see",{"_index":290,"title":{},"description":{"46":{},"49":{}}}],["select",{"_index":223,"title":{"27":{}},"description":{"28":{}}}],["send",{"_index":149,"title":{"6":{},"54":{}},"description":{}}],["sent",{"_index":160,"title":{},"description":{"7":{}}}],["separ",{"_index":287,"title":{},"description":{"45":{}}}],["server",{"_index":132,"title":{},"description":{"4":{},"5":{}}}],["set",{"_index":118,"title":{"11":{},"13":{},"14":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"58":{}},"description":{"3":{},"9":{},"25":{},"26":{},"27":{},"29":{},"31":{}}}],["shadow",{"_index":303,"title":{},"description":{"48":{},"51":{}}}],["shutter",{"_index":72,"title":{},"description":{"1":{},"2":{}}}],["sign",{"_index":328,"title":{},"description":{"51":{}}}],["similar",{"_index":26,"title":{},"description":{"0":{}}}],["single-channel",{"_index":325,"title":{},"description":{"51":{}}}],["size",{"_index":216,"title":{},"description":{"25":{},"26":{}}}],["slot",{"_index":362,"title":{},"description":{"61":{}}}],["socket",{"_index":240,"title":{"32":{}},"description":{"29":{},"31":{}}}],["socket_address",{"_index":245,"title":{},"description":{"29":{},"31":{}}}],["soft",{"_index":150,"title":{"6":{}},"description":{"6":{}}}],["soft/ttl",{"_index":115,"title":{},"description":{"3":{}}}],["softwar",{"_index":148,"title":{},"description":{"5":{}}}],["sole",{"_index":12,"title":{},"description":{"0":{}}}],["specif",{"_index":52,"title":{},"description":{"0":{}}}],["spirit",{"_index":27,"title":{},"description":{"0":{}}}],["spot",{"_index":203,"title":{"21":{}},"description":{"48":{},"51":{}}}],["stack",{"_index":309,"title":{},"description":{"48":{},"51":{}}}],["stage",{"_index":155,"title":{},"description":{"7":{},"61":{}}}],["standard",{"_index":292,"title":{},"description":{"46":{},"49":{}}}],["start",{"_index":108,"title":{"3":{},"56":{}},"description":{"3":{}}}],["state",{"_index":39,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"25":{},"26":{},"27":{},"33":{},"48":{},"49":{},"51":{}}}],["statist",{"_index":281,"title":{"43":{},"44":{},"45":{}},"description":{"43":{},"45":{}}}],["statistics/calibr",{"_index":288,"title":{},"description":{"45":{}}}],["statistics/data_collect",{"_index":284,"title":{},"description":{"44":{}}}],["statu",{"_index":264,"title":{"35":{},"36":{},"39":{},"40":{},"61":{}},"description":{"35":{},"40":{},"61":{}}}],["stop",{"_index":154,"title":{},"description":{"7":{},"48":{},"51":{}}}],["storag",{"_index":81,"title":{},"description":{"1":{}}}],["store",{"_index":319,"title":{},"description":{"48":{},"51":{}}}],["stream",{"_index":238,"title":{},"description":{"29":{},"31":{}}}],["structur",{"_index":243,"title":{},"description":{"29":{},"31":{}}}],["sub",{"_index":239,"title":{},"description":{"29":{}}}],["subject",{"_index":20,"title":{},"description":{"0":{}}}],["sure",{"_index":164,"title":{},"description":{"7":{}}}],["switch",{"_index":167,"title":{},"description":{"7":{}}}],["synchron",{"_index":147,"title":{},"description":{"5":{}}}],["syscal",{"_index":44,"title":{},"description":{"0":{}}}],["take",{"_index":166,"title":{},"description":{"7":{}}}],["term",{"_index":23,"title":{},"description":{"0":{}}}],["through",{"_index":58,"title":{},"description":{"0":{}}}],["tiff",{"_index":221,"title":{"26":{},"49":{},"50":{},"52":{},"59":{}},"description":{"26":{},"51":{}}}],["till",{"_index":129,"title":{},"description":{"4":{},"5":{}}}],["time",{"_index":84,"title":{},"description":{"1":{},"2":{},"4":{},"5":{},"7":{}}}],["timeout",{"_index":137,"title":{},"description":{"4":{},"5":{}}}],["transmit",{"_index":336,"title":{"54":{}},"description":{}}],["trigger",{"_index":116,"title":{"6":{}},"description":{"3":{},"6":{}}}],["true",{"_index":120,"title":{},"description":{"3":{}}}],["turn",{"_index":171,"title":{"8":{}},"description":{"8":{},"60":{}}}],["two",{"_index":66,"title":{},"description":{"1":{}}}],["under",{"_index":4,"title":{},"description":{"0":{}}}],["unsign",{"_index":318,"title":{},"description":{"48":{},"51":{}}}],["until",{"_index":112,"title":{},"description":{"3":{}}}],["updat",{"_index":97,"title":{},"description":{"2":{}}}],["upload",{"_index":280,"title":{"42":{},"48":{},"51":{}},"description":{"48":{},"51":{}}}],["us",{"_index":11,"title":{"54":{},"58":{}},"description":{"0":{},"1":{},"2":{},"3":{},"8":{},"28":{},"48":{},"51":{}}}],["user",{"_index":40,"title":{"47":{},"48":{},"50":{},"51":{}},"description":{"0":{},"47":{},"48":{},"50":{},"51":{}}}],["userspac",{"_index":31,"title":{},"description":{"0":{}}}],["valid",{"_index":329,"title":{},"description":{"51":{}}}],["valu",{"_index":294,"title":{"54":{}},"description":{"46":{},"48":{},"49":{},"51":{}}}],["version",{"_index":367,"title":{"62":{}},"description":{"62":{}}}],["via",{"_index":246,"title":{},"description":{"29":{},"31":{}}}],["volatil",{"_index":359,"title":{},"description":{"61":{}}}],["voltag",{"_index":174,"title":{},"description":{"8":{}}}],["wait",{"_index":126,"title":{"4":{},"5":{}},"description":{}}],["wait_till_don",{"_index":91,"title":{},"description":{"1":{},"2":{},"5":{}}}],["wait_until_run",{"_index":125,"title":{},"description":{"3":{},"4":{}}}],["web",{"_index":131,"title":{},"description":{"4":{},"5":{}}}],["well",{"_index":322,"title":{},"description":{"48":{},"51":{}}}],["whether",{"_index":56,"title":{},"description":{"0":{}}}],["wider",{"_index":51,"title":{},"description":{"0":{}}}],["without",{"_index":53,"title":{},"description":{"0":{}}}],["work",{"_index":48,"title":{},"description":{"0":{}}}],["writer",{"_index":161,"title":{"13":{},"14":{}},"description":{"7":{}}}],["x-axi",{"_index":337,"title":{"54":{}},"description":{}}],["x-ray",{"_index":71,"title":{},"description":{"1":{},"2":{},"9":{}}}],["xfel",{"_index":267,"title":{"37":{},"38":{}},"description":{"37":{},"38":{}}}],["xfel/event_cod",{"_index":274,"title":{},"description":{"38":{}}}],["xfel/pulse_id",{"_index":272,"title":{},"description":{"37":{}}}],["zeromq",{"_index":235,"title":{"29":{},"30":{},"31":{},"32":{}},"description":{"29":{},"31":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/docs/python_client/docs/TcpSettings.md b/docs/python_client/docs/TcpSettings.md
index 39df8093..7a1c06c7 100644
--- a/docs/python_client/docs/TcpSettings.md
+++ b/docs/python_client/docs/TcpSettings.md
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
 **send_buffer_size** | **int** | Send buffer size for TCP/IP socket | [optional] 
 **image_socket** | **str** | tcp://&lt;IP address&gt;:&lt;port&gt; 0.0.0.0 instead of IP address is accepted and means listening on all network interfaces  | [optional] 
 **nwriters** | **int** | Number of TCP/IP writers to be used for streaming images | [optional] [default to 32]
+**peer_liveness_timeout_ms** | **int** | Max time (in milliseconds) a send may block with no sign of life from the writer (no BUSY heartbeat or ACK) before the connection is declared dead. Optional; the built-in default is used when unset.  | [optional] 
+**max_backpressure_timeout_ms** | **int** | Hard upper bound (in milliseconds) on backpressure: if no bytes can be sent to the writer for this long the connection is declared dead even while the writer keeps heartbeating, so a wedged writer cannot block the run or its finalization. Optional; the built-in default is used when unset.  | [optional] 
 
 ## Example
 
diff --git a/frontend/src/client/types.gen.ts b/frontend/src/client/types.gen.ts
index eaab66ba..f7ceeb88 100644
--- a/frontend/src/client/types.gen.ts
+++ b/frontend/src/client/types.gen.ts
@@ -1474,6 +1474,21 @@ export type tcp_settings = {
      * Number of TCP/IP writers to be used for streaming images
      */
     nwriters?: number;
+    /**
+     * Max time (in milliseconds) a send may block with no sign of life from the
+     * writer (no BUSY heartbeat or ACK) before the connection is declared dead.
+     * Optional; the built-in default is used when unset.
+     *
+     */
+    peer_liveness_timeout_ms?: number;
+    /**
+     * Hard upper bound (in milliseconds) on backpressure: if no bytes can be sent to
+     * the writer for this long the connection is declared dead even while the writer
+     * keeps heartbeating, so a wedged writer cannot block the run or its
+     * finalization. Optional; the built-in default is used when unset.
+     *
+     */
+    max_backpressure_timeout_ms?: number;
 };
 
 export type pcie_devices = Array<{
diff --git a/frontend/src/client/zod.gen.ts b/frontend/src/client/zod.gen.ts
index f07a9f3f..26f806cf 100644
--- a/frontend/src/client/zod.gen.ts
+++ b/frontend/src/client/zod.gen.ts
@@ -645,7 +645,9 @@ export const zZeromqSettings = z.object({
 export const zTcpSettings = z.object({
     send_buffer_size: z.coerce.bigint().min(BigInt('-9223372036854775808'), { error: 'Invalid value: Expected int64 to be >= -9223372036854775808' }).max(BigInt('9223372036854775807'), { error: 'Invalid value: Expected int64 to be <= 9223372036854775807' }).optional(),
     image_socket: z.string().optional(),
-    nwriters: z.coerce.bigint().gte(BigInt(1)).lte(BigInt(100)).optional().default(BigInt(32))
+    nwriters: z.coerce.bigint().gte(BigInt(1)).lte(BigInt(100)).optional().default(BigInt(32)),
+    peer_liveness_timeout_ms: z.coerce.bigint().min(BigInt('-9223372036854775808'), { error: 'Invalid value: Expected int64 to be >= -9223372036854775808' }).max(BigInt('9223372036854775807'), { error: 'Invalid value: Expected int64 to be <= 9223372036854775807' }).optional(),
+    max_backpressure_timeout_ms: z.coerce.bigint().min(BigInt('-9223372036854775808'), { error: 'Invalid value: Expected int64 to be >= -9223372036854775808' }).max(BigInt('9223372036854775807'), { error: 'Invalid value: Expected int64 to be <= 9223372036854775807' }).optional()
 });
 
 export const zPcieDevices = z.array(z.object({
-- 
2.52.0


From 26554c86e3a955ea996ee2586afccca00a139edd Mon Sep 17 00:00:00 2001
From: Filip Leonarski <filip.leonarski@psi.ch>
Date: Thu, 25 Jun 2026 15:58:28 +0200
Subject: [PATCH 6/7] VERSION: 1.0.0-rc.154

---
 VERSION                                                    | 2 +-
 broker/gen/model/Azim_int_settings.cpp                     | 2 +-
 broker/gen/model/Azim_int_settings.h                       | 2 +-
 broker/gen/model/Broker_status.cpp                         | 2 +-
 broker/gen/model/Broker_status.h                           | 2 +-
 broker/gen/model/Calibration_statistics_inner.cpp          | 2 +-
 broker/gen/model/Calibration_statistics_inner.h            | 2 +-
 broker/gen/model/Dark_mask_settings.cpp                    | 2 +-
 broker/gen/model/Dark_mask_settings.h                      | 2 +-
 broker/gen/model/Dataset_settings.cpp                      | 2 +-
 broker/gen/model/Dataset_settings.h                        | 2 +-
 .../model/Dataset_settings_xray_fluorescence_spectrum.cpp  | 2 +-
 .../model/Dataset_settings_xray_fluorescence_spectrum.h    | 2 +-
 broker/gen/model/Detector.cpp                              | 2 +-
 broker/gen/model/Detector.h                                | 2 +-
 broker/gen/model/Detector_list.cpp                         | 2 +-
 broker/gen/model/Detector_list.h                           | 2 +-
 broker/gen/model/Detector_list_element.cpp                 | 2 +-
 broker/gen/model/Detector_list_element.h                   | 2 +-
 broker/gen/model/Detector_module.cpp                       | 2 +-
 broker/gen/model/Detector_module.h                         | 2 +-
 broker/gen/model/Detector_module_direction.cpp             | 2 +-
 broker/gen/model/Detector_module_direction.h               | 2 +-
 broker/gen/model/Detector_power_state.cpp                  | 2 +-
 broker/gen/model/Detector_power_state.h                    | 2 +-
 broker/gen/model/Detector_selection.cpp                    | 2 +-
 broker/gen/model/Detector_selection.h                      | 2 +-
 broker/gen/model/Detector_settings.cpp                     | 2 +-
 broker/gen/model/Detector_settings.h                       | 2 +-
 broker/gen/model/Detector_state.cpp                        | 2 +-
 broker/gen/model/Detector_state.h                          | 2 +-
 broker/gen/model/Detector_status.cpp                       | 2 +-
 broker/gen/model/Detector_status.h                         | 2 +-
 broker/gen/model/Detector_timing.cpp                       | 2 +-
 broker/gen/model/Detector_timing.h                         | 2 +-
 broker/gen/model/Detector_type.cpp                         | 2 +-
 broker/gen/model/Detector_type.h                           | 2 +-
 broker/gen/model/Error_message.cpp                         | 2 +-
 broker/gen/model/Error_message.h                           | 2 +-
 broker/gen/model/File_writer_format.cpp                    | 2 +-
 broker/gen/model/File_writer_format.h                      | 2 +-
 broker/gen/model/File_writer_settings.cpp                  | 2 +-
 broker/gen/model/File_writer_settings.h                    | 2 +-
 broker/gen/model/Fpga_status_inner.cpp                     | 2 +-
 broker/gen/model/Fpga_status_inner.h                       | 2 +-
 broker/gen/model/Geom_refinement_algorithm.cpp             | 2 +-
 broker/gen/model/Geom_refinement_algorithm.h               | 2 +-
 broker/gen/model/Grid_scan.cpp                             | 2 +-
 broker/gen/model/Grid_scan.h                               | 2 +-
 broker/gen/model/Helpers.cpp                               | 2 +-
 broker/gen/model/Helpers.h                                 | 2 +-
 broker/gen/model/Image_buffer_status.cpp                   | 2 +-
 broker/gen/model/Image_buffer_status.h                     | 2 +-
 broker/gen/model/Image_format_settings.cpp                 | 2 +-
 broker/gen/model/Image_format_settings.h                   | 2 +-
 broker/gen/model/Image_pusher_status.cpp                   | 2 +-
 broker/gen/model/Image_pusher_status.h                     | 2 +-
 broker/gen/model/Image_pusher_type.cpp                     | 2 +-
 broker/gen/model/Image_pusher_type.h                       | 2 +-
 broker/gen/model/Indexing_algorithm.cpp                    | 2 +-
 broker/gen/model/Indexing_algorithm.h                      | 2 +-
 broker/gen/model/Indexing_settings.cpp                     | 2 +-
 broker/gen/model/Indexing_settings.h                       | 2 +-
 broker/gen/model/Instrument_metadata.cpp                   | 2 +-
 broker/gen/model/Instrument_metadata.h                     | 2 +-
 broker/gen/model/Jfjoch_settings.cpp                       | 2 +-
 broker/gen/model/Jfjoch_settings.h                         | 2 +-
 broker/gen/model/Jfjoch_statistics.cpp                     | 2 +-
 broker/gen/model/Jfjoch_statistics.h                       | 2 +-
 broker/gen/model/Measurement_statistics.cpp                | 2 +-
 broker/gen/model/Measurement_statistics.h                  | 2 +-
 broker/gen/model/Pcie_devices_inner.cpp                    | 2 +-
 broker/gen/model/Pcie_devices_inner.h                      | 2 +-
 broker/gen/model/Pixel_mask_statistics.cpp                 | 2 +-
 broker/gen/model/Pixel_mask_statistics.h                   | 2 +-
 broker/gen/model/Plot.cpp                                  | 2 +-
 broker/gen/model/Plot.h                                    | 2 +-
 broker/gen/model/Plot_unit_x.cpp                           | 2 +-
 broker/gen/model/Plot_unit_x.h                             | 2 +-
 broker/gen/model/Plots.cpp                                 | 2 +-
 broker/gen/model/Plots.h                                   | 2 +-
 broker/gen/model/Roi_azim_list.cpp                         | 2 +-
 broker/gen/model/Roi_azim_list.h                           | 2 +-
 broker/gen/model/Roi_azimuthal.cpp                         | 2 +-
 broker/gen/model/Roi_azimuthal.h                           | 2 +-
 broker/gen/model/Roi_box.cpp                               | 2 +-
 broker/gen/model/Roi_box.h                                 | 2 +-
 broker/gen/model/Roi_box_list.cpp                          | 2 +-
 broker/gen/model/Roi_box_list.h                            | 2 +-
 broker/gen/model/Roi_circle.cpp                            | 2 +-
 broker/gen/model/Roi_circle.h                              | 2 +-
 broker/gen/model/Roi_circle_list.cpp                       | 2 +-
 broker/gen/model/Roi_circle_list.h                         | 2 +-
 broker/gen/model/Roi_definitions.cpp                       | 2 +-
 broker/gen/model/Roi_definitions.h                         | 2 +-
 broker/gen/model/Rotation_axis.cpp                         | 2 +-
 broker/gen/model/Rotation_axis.h                           | 2 +-
 broker/gen/model/Scan_result.cpp                           | 2 +-
 broker/gen/model/Scan_result.h                             | 2 +-
 broker/gen/model/Scan_result_images_inner.cpp              | 2 +-
 broker/gen/model/Scan_result_images_inner.h                | 2 +-
 broker/gen/model/Spot_finding_settings.cpp                 | 2 +-
 broker/gen/model/Spot_finding_settings.h                   | 2 +-
 broker/gen/model/Standard_detector_geometry.cpp            | 2 +-
 broker/gen/model/Standard_detector_geometry.h              | 2 +-
 broker/gen/model/Tcp_settings.cpp                          | 2 +-
 broker/gen/model/Tcp_settings.h                            | 2 +-
 broker/gen/model/Unit_cell.cpp                             | 2 +-
 broker/gen/model/Unit_cell.h                               | 2 +-
 broker/gen/model/Zeromq_metadata_settings.cpp              | 2 +-
 broker/gen/model/Zeromq_metadata_settings.h                | 2 +-
 broker/gen/model/Zeromq_preview_settings.cpp               | 2 +-
 broker/gen/model/Zeromq_preview_settings.h                 | 2 +-
 broker/gen/model/Zeromq_settings.cpp                       | 2 +-
 broker/gen/model/Zeromq_settings.h                         | 2 +-
 broker/jfjoch_api.yaml                                     | 2 +-
 broker/redoc-static.html                                   | 4 ++--
 docs/CHANGELOG.md                                          | 7 ++++++-
 docs/conf.py                                               | 2 +-
 docs/python_client/README.md                               | 4 ++--
 fpga/hdl/action_config.v                                   | 2 +-
 fpga/pcie_driver/dkms.conf                                 | 2 +-
 fpga/pcie_driver/install_dkms.sh                           | 2 +-
 fpga/pcie_driver/jfjoch_drv.c                              | 2 +-
 fpga/pcie_driver/postinstall.sh                            | 2 +-
 fpga/pcie_driver/preuninstall.sh                           | 2 +-
 frontend/package.json                                      | 2 +-
 frontend/src/version.ts                                    | 2 +-
 128 files changed, 135 insertions(+), 130 deletions(-)

diff --git a/VERSION b/VERSION
index 9f1ff589..9deaf135 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-1.0.0-rc.153
+1.0.0-rc.154
diff --git a/broker/gen/model/Azim_int_settings.cpp b/broker/gen/model/Azim_int_settings.cpp
index 826ea5ae..49351f97 100644
--- a/broker/gen/model/Azim_int_settings.cpp
+++ b/broker/gen/model/Azim_int_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Azim_int_settings.h b/broker/gen/model/Azim_int_settings.h
index 158c8922..063dd191 100644
--- a/broker/gen/model/Azim_int_settings.h
+++ b/broker/gen/model/Azim_int_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Broker_status.cpp b/broker/gen/model/Broker_status.cpp
index 6cec1ee2..2fdf992c 100644
--- a/broker/gen/model/Broker_status.cpp
+++ b/broker/gen/model/Broker_status.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Broker_status.h b/broker/gen/model/Broker_status.h
index f18ca782..de829430 100644
--- a/broker/gen/model/Broker_status.h
+++ b/broker/gen/model/Broker_status.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Calibration_statistics_inner.cpp b/broker/gen/model/Calibration_statistics_inner.cpp
index 9556ade6..30e872f4 100644
--- a/broker/gen/model/Calibration_statistics_inner.cpp
+++ b/broker/gen/model/Calibration_statistics_inner.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Calibration_statistics_inner.h b/broker/gen/model/Calibration_statistics_inner.h
index 3f67f0b6..22afe322 100644
--- a/broker/gen/model/Calibration_statistics_inner.h
+++ b/broker/gen/model/Calibration_statistics_inner.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Dark_mask_settings.cpp b/broker/gen/model/Dark_mask_settings.cpp
index 8b1ca257..379ba1fe 100644
--- a/broker/gen/model/Dark_mask_settings.cpp
+++ b/broker/gen/model/Dark_mask_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Dark_mask_settings.h b/broker/gen/model/Dark_mask_settings.h
index 4f9c9823..14bc6cf2 100644
--- a/broker/gen/model/Dark_mask_settings.h
+++ b/broker/gen/model/Dark_mask_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Dataset_settings.cpp b/broker/gen/model/Dataset_settings.cpp
index 7e07777c..59838730 100644
--- a/broker/gen/model/Dataset_settings.cpp
+++ b/broker/gen/model/Dataset_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Dataset_settings.h b/broker/gen/model/Dataset_settings.h
index 510286d3..52eccd36 100644
--- a/broker/gen/model/Dataset_settings.h
+++ b/broker/gen/model/Dataset_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.cpp b/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.cpp
index 157d97d2..5039cdce 100644
--- a/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.cpp
+++ b/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.h b/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.h
index 7bfa5137..e404eb9a 100644
--- a/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.h
+++ b/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector.cpp b/broker/gen/model/Detector.cpp
index 0b686db6..dcafc530 100644
--- a/broker/gen/model/Detector.cpp
+++ b/broker/gen/model/Detector.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector.h b/broker/gen/model/Detector.h
index ee24d86d..46dd2439 100644
--- a/broker/gen/model/Detector.h
+++ b/broker/gen/model/Detector.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_list.cpp b/broker/gen/model/Detector_list.cpp
index de7e27e2..40660ee8 100644
--- a/broker/gen/model/Detector_list.cpp
+++ b/broker/gen/model/Detector_list.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_list.h b/broker/gen/model/Detector_list.h
index 445f8481..0c138c25 100644
--- a/broker/gen/model/Detector_list.h
+++ b/broker/gen/model/Detector_list.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_list_element.cpp b/broker/gen/model/Detector_list_element.cpp
index 7c59cfe3..3e902a07 100644
--- a/broker/gen/model/Detector_list_element.cpp
+++ b/broker/gen/model/Detector_list_element.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_list_element.h b/broker/gen/model/Detector_list_element.h
index 32793439..30fb15ab 100644
--- a/broker/gen/model/Detector_list_element.h
+++ b/broker/gen/model/Detector_list_element.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_module.cpp b/broker/gen/model/Detector_module.cpp
index f28cc957..457bed49 100644
--- a/broker/gen/model/Detector_module.cpp
+++ b/broker/gen/model/Detector_module.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_module.h b/broker/gen/model/Detector_module.h
index f04863c1..ef6dd400 100644
--- a/broker/gen/model/Detector_module.h
+++ b/broker/gen/model/Detector_module.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_module_direction.cpp b/broker/gen/model/Detector_module_direction.cpp
index 068dc6e7..b534f868 100644
--- a/broker/gen/model/Detector_module_direction.cpp
+++ b/broker/gen/model/Detector_module_direction.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_module_direction.h b/broker/gen/model/Detector_module_direction.h
index 19f22005..364a15c0 100644
--- a/broker/gen/model/Detector_module_direction.h
+++ b/broker/gen/model/Detector_module_direction.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_power_state.cpp b/broker/gen/model/Detector_power_state.cpp
index 9ee53908..38d2e3a3 100644
--- a/broker/gen/model/Detector_power_state.cpp
+++ b/broker/gen/model/Detector_power_state.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_power_state.h b/broker/gen/model/Detector_power_state.h
index d1a6c5cb..35c23084 100644
--- a/broker/gen/model/Detector_power_state.h
+++ b/broker/gen/model/Detector_power_state.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_selection.cpp b/broker/gen/model/Detector_selection.cpp
index 3cf0fa77..716d1beb 100644
--- a/broker/gen/model/Detector_selection.cpp
+++ b/broker/gen/model/Detector_selection.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_selection.h b/broker/gen/model/Detector_selection.h
index bba38849..f8b0df1a 100644
--- a/broker/gen/model/Detector_selection.h
+++ b/broker/gen/model/Detector_selection.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_settings.cpp b/broker/gen/model/Detector_settings.cpp
index d8bf158a..540eb7aa 100644
--- a/broker/gen/model/Detector_settings.cpp
+++ b/broker/gen/model/Detector_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_settings.h b/broker/gen/model/Detector_settings.h
index 6546179d..0acdb9ab 100644
--- a/broker/gen/model/Detector_settings.h
+++ b/broker/gen/model/Detector_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_state.cpp b/broker/gen/model/Detector_state.cpp
index c4ab8f1b..353fcc32 100644
--- a/broker/gen/model/Detector_state.cpp
+++ b/broker/gen/model/Detector_state.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_state.h b/broker/gen/model/Detector_state.h
index b372129d..15888882 100644
--- a/broker/gen/model/Detector_state.h
+++ b/broker/gen/model/Detector_state.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_status.cpp b/broker/gen/model/Detector_status.cpp
index 0e8b2a95..e3e32995 100644
--- a/broker/gen/model/Detector_status.cpp
+++ b/broker/gen/model/Detector_status.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_status.h b/broker/gen/model/Detector_status.h
index e3b2ccca..85a56c4a 100644
--- a/broker/gen/model/Detector_status.h
+++ b/broker/gen/model/Detector_status.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_timing.cpp b/broker/gen/model/Detector_timing.cpp
index de423c69..4f3d1380 100644
--- a/broker/gen/model/Detector_timing.cpp
+++ b/broker/gen/model/Detector_timing.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_timing.h b/broker/gen/model/Detector_timing.h
index e7110f99..20e9a227 100644
--- a/broker/gen/model/Detector_timing.h
+++ b/broker/gen/model/Detector_timing.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_type.cpp b/broker/gen/model/Detector_type.cpp
index 9399377a..5cfd52a6 100644
--- a/broker/gen/model/Detector_type.cpp
+++ b/broker/gen/model/Detector_type.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Detector_type.h b/broker/gen/model/Detector_type.h
index 7e9532b7..d42cbfac 100644
--- a/broker/gen/model/Detector_type.h
+++ b/broker/gen/model/Detector_type.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Error_message.cpp b/broker/gen/model/Error_message.cpp
index 416ac4e6..8858793a 100644
--- a/broker/gen/model/Error_message.cpp
+++ b/broker/gen/model/Error_message.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Error_message.h b/broker/gen/model/Error_message.h
index 517ebc30..bc1d628c 100644
--- a/broker/gen/model/Error_message.h
+++ b/broker/gen/model/Error_message.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/File_writer_format.cpp b/broker/gen/model/File_writer_format.cpp
index 1032d71a..9e0e9e55 100644
--- a/broker/gen/model/File_writer_format.cpp
+++ b/broker/gen/model/File_writer_format.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/File_writer_format.h b/broker/gen/model/File_writer_format.h
index 0cbca1c6..88161ac7 100644
--- a/broker/gen/model/File_writer_format.h
+++ b/broker/gen/model/File_writer_format.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/File_writer_settings.cpp b/broker/gen/model/File_writer_settings.cpp
index dc5c16aa..95f8aa6d 100644
--- a/broker/gen/model/File_writer_settings.cpp
+++ b/broker/gen/model/File_writer_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/File_writer_settings.h b/broker/gen/model/File_writer_settings.h
index 3ef56e2a..edb7a426 100644
--- a/broker/gen/model/File_writer_settings.h
+++ b/broker/gen/model/File_writer_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Fpga_status_inner.cpp b/broker/gen/model/Fpga_status_inner.cpp
index 0851c88a..2023f3e2 100644
--- a/broker/gen/model/Fpga_status_inner.cpp
+++ b/broker/gen/model/Fpga_status_inner.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Fpga_status_inner.h b/broker/gen/model/Fpga_status_inner.h
index 75153cdd..cfc468e6 100644
--- a/broker/gen/model/Fpga_status_inner.h
+++ b/broker/gen/model/Fpga_status_inner.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Geom_refinement_algorithm.cpp b/broker/gen/model/Geom_refinement_algorithm.cpp
index d56046ad..262a7e78 100644
--- a/broker/gen/model/Geom_refinement_algorithm.cpp
+++ b/broker/gen/model/Geom_refinement_algorithm.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Geom_refinement_algorithm.h b/broker/gen/model/Geom_refinement_algorithm.h
index 1267dcc4..5a6d38d5 100644
--- a/broker/gen/model/Geom_refinement_algorithm.h
+++ b/broker/gen/model/Geom_refinement_algorithm.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Grid_scan.cpp b/broker/gen/model/Grid_scan.cpp
index b610bce2..3abbf48f 100644
--- a/broker/gen/model/Grid_scan.cpp
+++ b/broker/gen/model/Grid_scan.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Grid_scan.h b/broker/gen/model/Grid_scan.h
index 077ccebb..f41b5f16 100644
--- a/broker/gen/model/Grid_scan.h
+++ b/broker/gen/model/Grid_scan.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Helpers.cpp b/broker/gen/model/Helpers.cpp
index f24789fc..d096e3a7 100644
--- a/broker/gen/model/Helpers.cpp
+++ b/broker/gen/model/Helpers.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Helpers.h b/broker/gen/model/Helpers.h
index 6d6c04a0..9dfff356 100644
--- a/broker/gen/model/Helpers.h
+++ b/broker/gen/model/Helpers.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Image_buffer_status.cpp b/broker/gen/model/Image_buffer_status.cpp
index 7291140c..c72bd8d4 100644
--- a/broker/gen/model/Image_buffer_status.cpp
+++ b/broker/gen/model/Image_buffer_status.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Image_buffer_status.h b/broker/gen/model/Image_buffer_status.h
index 4678e21b..0538a344 100644
--- a/broker/gen/model/Image_buffer_status.h
+++ b/broker/gen/model/Image_buffer_status.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Image_format_settings.cpp b/broker/gen/model/Image_format_settings.cpp
index 50b354dc..034bb96d 100644
--- a/broker/gen/model/Image_format_settings.cpp
+++ b/broker/gen/model/Image_format_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Image_format_settings.h b/broker/gen/model/Image_format_settings.h
index 4f3cc8db..d79068c4 100644
--- a/broker/gen/model/Image_format_settings.h
+++ b/broker/gen/model/Image_format_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Image_pusher_status.cpp b/broker/gen/model/Image_pusher_status.cpp
index 4a637f45..22ad825a 100644
--- a/broker/gen/model/Image_pusher_status.cpp
+++ b/broker/gen/model/Image_pusher_status.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Image_pusher_status.h b/broker/gen/model/Image_pusher_status.h
index d1cdf1aa..67b41028 100644
--- a/broker/gen/model/Image_pusher_status.h
+++ b/broker/gen/model/Image_pusher_status.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Image_pusher_type.cpp b/broker/gen/model/Image_pusher_type.cpp
index 320ec448..5bfb0482 100644
--- a/broker/gen/model/Image_pusher_type.cpp
+++ b/broker/gen/model/Image_pusher_type.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Image_pusher_type.h b/broker/gen/model/Image_pusher_type.h
index 0a54762f..ce063840 100644
--- a/broker/gen/model/Image_pusher_type.h
+++ b/broker/gen/model/Image_pusher_type.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Indexing_algorithm.cpp b/broker/gen/model/Indexing_algorithm.cpp
index 31f4a0ab..b9da3321 100644
--- a/broker/gen/model/Indexing_algorithm.cpp
+++ b/broker/gen/model/Indexing_algorithm.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Indexing_algorithm.h b/broker/gen/model/Indexing_algorithm.h
index 80f7762e..c875177f 100644
--- a/broker/gen/model/Indexing_algorithm.h
+++ b/broker/gen/model/Indexing_algorithm.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Indexing_settings.cpp b/broker/gen/model/Indexing_settings.cpp
index bf4a805f..ad50388c 100644
--- a/broker/gen/model/Indexing_settings.cpp
+++ b/broker/gen/model/Indexing_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Indexing_settings.h b/broker/gen/model/Indexing_settings.h
index 50003d68..a6607b90 100644
--- a/broker/gen/model/Indexing_settings.h
+++ b/broker/gen/model/Indexing_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Instrument_metadata.cpp b/broker/gen/model/Instrument_metadata.cpp
index ec9f8815..89cfae93 100644
--- a/broker/gen/model/Instrument_metadata.cpp
+++ b/broker/gen/model/Instrument_metadata.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Instrument_metadata.h b/broker/gen/model/Instrument_metadata.h
index 1b6e0a11..95fd3606 100644
--- a/broker/gen/model/Instrument_metadata.h
+++ b/broker/gen/model/Instrument_metadata.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Jfjoch_settings.cpp b/broker/gen/model/Jfjoch_settings.cpp
index 8db1ff0f..1e9d2552 100644
--- a/broker/gen/model/Jfjoch_settings.cpp
+++ b/broker/gen/model/Jfjoch_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Jfjoch_settings.h b/broker/gen/model/Jfjoch_settings.h
index 85982af3..4443c3b6 100644
--- a/broker/gen/model/Jfjoch_settings.h
+++ b/broker/gen/model/Jfjoch_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Jfjoch_statistics.cpp b/broker/gen/model/Jfjoch_statistics.cpp
index 37b4b262..2131b0ec 100644
--- a/broker/gen/model/Jfjoch_statistics.cpp
+++ b/broker/gen/model/Jfjoch_statistics.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Jfjoch_statistics.h b/broker/gen/model/Jfjoch_statistics.h
index eee784f5..24860a0d 100644
--- a/broker/gen/model/Jfjoch_statistics.h
+++ b/broker/gen/model/Jfjoch_statistics.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Measurement_statistics.cpp b/broker/gen/model/Measurement_statistics.cpp
index c8278f09..f106d5f9 100644
--- a/broker/gen/model/Measurement_statistics.cpp
+++ b/broker/gen/model/Measurement_statistics.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Measurement_statistics.h b/broker/gen/model/Measurement_statistics.h
index 3fc19a24..f05e3c45 100644
--- a/broker/gen/model/Measurement_statistics.h
+++ b/broker/gen/model/Measurement_statistics.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Pcie_devices_inner.cpp b/broker/gen/model/Pcie_devices_inner.cpp
index d91cb19f..9415c491 100644
--- a/broker/gen/model/Pcie_devices_inner.cpp
+++ b/broker/gen/model/Pcie_devices_inner.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Pcie_devices_inner.h b/broker/gen/model/Pcie_devices_inner.h
index 7612c1c6..48389b8d 100644
--- a/broker/gen/model/Pcie_devices_inner.h
+++ b/broker/gen/model/Pcie_devices_inner.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Pixel_mask_statistics.cpp b/broker/gen/model/Pixel_mask_statistics.cpp
index f132990b..488b6c82 100644
--- a/broker/gen/model/Pixel_mask_statistics.cpp
+++ b/broker/gen/model/Pixel_mask_statistics.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Pixel_mask_statistics.h b/broker/gen/model/Pixel_mask_statistics.h
index a9e3a2e6..0582829c 100644
--- a/broker/gen/model/Pixel_mask_statistics.h
+++ b/broker/gen/model/Pixel_mask_statistics.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Plot.cpp b/broker/gen/model/Plot.cpp
index fea50f58..e7c42073 100644
--- a/broker/gen/model/Plot.cpp
+++ b/broker/gen/model/Plot.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Plot.h b/broker/gen/model/Plot.h
index 01aa18ca..140f60f8 100644
--- a/broker/gen/model/Plot.h
+++ b/broker/gen/model/Plot.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Plot_unit_x.cpp b/broker/gen/model/Plot_unit_x.cpp
index 50c0fe12..4bc5d0bc 100644
--- a/broker/gen/model/Plot_unit_x.cpp
+++ b/broker/gen/model/Plot_unit_x.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Plot_unit_x.h b/broker/gen/model/Plot_unit_x.h
index c4a008e2..7ba97449 100644
--- a/broker/gen/model/Plot_unit_x.h
+++ b/broker/gen/model/Plot_unit_x.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Plots.cpp b/broker/gen/model/Plots.cpp
index 3353b009..165198bd 100644
--- a/broker/gen/model/Plots.cpp
+++ b/broker/gen/model/Plots.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Plots.h b/broker/gen/model/Plots.h
index ab6d44c5..4725d57e 100644
--- a/broker/gen/model/Plots.h
+++ b/broker/gen/model/Plots.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_azim_list.cpp b/broker/gen/model/Roi_azim_list.cpp
index 50a0eb11..d3829746 100644
--- a/broker/gen/model/Roi_azim_list.cpp
+++ b/broker/gen/model/Roi_azim_list.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_azim_list.h b/broker/gen/model/Roi_azim_list.h
index f0125932..aa661733 100644
--- a/broker/gen/model/Roi_azim_list.h
+++ b/broker/gen/model/Roi_azim_list.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_azimuthal.cpp b/broker/gen/model/Roi_azimuthal.cpp
index d6c4aa5d..6357e160 100644
--- a/broker/gen/model/Roi_azimuthal.cpp
+++ b/broker/gen/model/Roi_azimuthal.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_azimuthal.h b/broker/gen/model/Roi_azimuthal.h
index 7f938c2d..33082c19 100644
--- a/broker/gen/model/Roi_azimuthal.h
+++ b/broker/gen/model/Roi_azimuthal.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_box.cpp b/broker/gen/model/Roi_box.cpp
index c9732767..b869123e 100644
--- a/broker/gen/model/Roi_box.cpp
+++ b/broker/gen/model/Roi_box.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_box.h b/broker/gen/model/Roi_box.h
index 286ffb08..8a560cf6 100644
--- a/broker/gen/model/Roi_box.h
+++ b/broker/gen/model/Roi_box.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_box_list.cpp b/broker/gen/model/Roi_box_list.cpp
index 556dede5..93286b0a 100644
--- a/broker/gen/model/Roi_box_list.cpp
+++ b/broker/gen/model/Roi_box_list.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_box_list.h b/broker/gen/model/Roi_box_list.h
index c18a0702..a6ec5e93 100644
--- a/broker/gen/model/Roi_box_list.h
+++ b/broker/gen/model/Roi_box_list.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_circle.cpp b/broker/gen/model/Roi_circle.cpp
index 0e897514..1de07afc 100644
--- a/broker/gen/model/Roi_circle.cpp
+++ b/broker/gen/model/Roi_circle.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_circle.h b/broker/gen/model/Roi_circle.h
index 0b7ee690..defc2d0b 100644
--- a/broker/gen/model/Roi_circle.h
+++ b/broker/gen/model/Roi_circle.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_circle_list.cpp b/broker/gen/model/Roi_circle_list.cpp
index 88f1bc6d..18242235 100644
--- a/broker/gen/model/Roi_circle_list.cpp
+++ b/broker/gen/model/Roi_circle_list.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_circle_list.h b/broker/gen/model/Roi_circle_list.h
index e6219a9e..724d9131 100644
--- a/broker/gen/model/Roi_circle_list.h
+++ b/broker/gen/model/Roi_circle_list.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_definitions.cpp b/broker/gen/model/Roi_definitions.cpp
index 18c6d380..5331e427 100644
--- a/broker/gen/model/Roi_definitions.cpp
+++ b/broker/gen/model/Roi_definitions.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Roi_definitions.h b/broker/gen/model/Roi_definitions.h
index 7c75eafd..0d6c9284 100644
--- a/broker/gen/model/Roi_definitions.h
+++ b/broker/gen/model/Roi_definitions.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Rotation_axis.cpp b/broker/gen/model/Rotation_axis.cpp
index 45928b50..39fbd8cb 100644
--- a/broker/gen/model/Rotation_axis.cpp
+++ b/broker/gen/model/Rotation_axis.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Rotation_axis.h b/broker/gen/model/Rotation_axis.h
index 54e72f01..8e2adb87 100644
--- a/broker/gen/model/Rotation_axis.h
+++ b/broker/gen/model/Rotation_axis.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Scan_result.cpp b/broker/gen/model/Scan_result.cpp
index d61f4c0c..919d870f 100644
--- a/broker/gen/model/Scan_result.cpp
+++ b/broker/gen/model/Scan_result.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Scan_result.h b/broker/gen/model/Scan_result.h
index 03733748..c41d9207 100644
--- a/broker/gen/model/Scan_result.h
+++ b/broker/gen/model/Scan_result.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Scan_result_images_inner.cpp b/broker/gen/model/Scan_result_images_inner.cpp
index c1ccfade..aed7e7ff 100644
--- a/broker/gen/model/Scan_result_images_inner.cpp
+++ b/broker/gen/model/Scan_result_images_inner.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Scan_result_images_inner.h b/broker/gen/model/Scan_result_images_inner.h
index fac1cdfd..7e5981f1 100644
--- a/broker/gen/model/Scan_result_images_inner.h
+++ b/broker/gen/model/Scan_result_images_inner.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Spot_finding_settings.cpp b/broker/gen/model/Spot_finding_settings.cpp
index c7155a5a..d6739e20 100644
--- a/broker/gen/model/Spot_finding_settings.cpp
+++ b/broker/gen/model/Spot_finding_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Spot_finding_settings.h b/broker/gen/model/Spot_finding_settings.h
index 4eb59121..e74a8afb 100644
--- a/broker/gen/model/Spot_finding_settings.h
+++ b/broker/gen/model/Spot_finding_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Standard_detector_geometry.cpp b/broker/gen/model/Standard_detector_geometry.cpp
index 38d22564..5d58c14f 100644
--- a/broker/gen/model/Standard_detector_geometry.cpp
+++ b/broker/gen/model/Standard_detector_geometry.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Standard_detector_geometry.h b/broker/gen/model/Standard_detector_geometry.h
index e50c21a9..63f14e9f 100644
--- a/broker/gen/model/Standard_detector_geometry.h
+++ b/broker/gen/model/Standard_detector_geometry.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Tcp_settings.cpp b/broker/gen/model/Tcp_settings.cpp
index 391cfb4c..694f3937 100644
--- a/broker/gen/model/Tcp_settings.cpp
+++ b/broker/gen/model/Tcp_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Tcp_settings.h b/broker/gen/model/Tcp_settings.h
index d323c3bd..0e460bcc 100644
--- a/broker/gen/model/Tcp_settings.h
+++ b/broker/gen/model/Tcp_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Unit_cell.cpp b/broker/gen/model/Unit_cell.cpp
index 75b301d7..c960b1fd 100644
--- a/broker/gen/model/Unit_cell.cpp
+++ b/broker/gen/model/Unit_cell.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Unit_cell.h b/broker/gen/model/Unit_cell.h
index 48499fac..7574e3d2 100644
--- a/broker/gen/model/Unit_cell.h
+++ b/broker/gen/model/Unit_cell.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Zeromq_metadata_settings.cpp b/broker/gen/model/Zeromq_metadata_settings.cpp
index dd409b32..99f57fc4 100644
--- a/broker/gen/model/Zeromq_metadata_settings.cpp
+++ b/broker/gen/model/Zeromq_metadata_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Zeromq_metadata_settings.h b/broker/gen/model/Zeromq_metadata_settings.h
index 8fdaeea4..dd54d67f 100644
--- a/broker/gen/model/Zeromq_metadata_settings.h
+++ b/broker/gen/model/Zeromq_metadata_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Zeromq_preview_settings.cpp b/broker/gen/model/Zeromq_preview_settings.cpp
index 52a16b37..7939724b 100644
--- a/broker/gen/model/Zeromq_preview_settings.cpp
+++ b/broker/gen/model/Zeromq_preview_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Zeromq_preview_settings.h b/broker/gen/model/Zeromq_preview_settings.h
index e33df9c7..007cb1c0 100644
--- a/broker/gen/model/Zeromq_preview_settings.h
+++ b/broker/gen/model/Zeromq_preview_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Zeromq_settings.cpp b/broker/gen/model/Zeromq_settings.cpp
index 8643b5fa..360f511f 100644
--- a/broker/gen/model/Zeromq_settings.cpp
+++ b/broker/gen/model/Zeromq_settings.cpp
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/gen/model/Zeromq_settings.h b/broker/gen/model/Zeromq_settings.h
index 1697b1ab..3886ece9 100644
--- a/broker/gen/model/Zeromq_settings.h
+++ b/broker/gen/model/Zeromq_settings.h
@@ -2,7 +2,7 @@
 * Jungfraujoch
 * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.153
+* The version of the OpenAPI document: 1.0.0-rc.154
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/broker/jfjoch_api.yaml b/broker/jfjoch_api.yaml
index 86ead6d2..1b04f849 100644
--- a/broker/jfjoch_api.yaml
+++ b/broker/jfjoch_api.yaml
@@ -22,7 +22,7 @@ info:
     requirements on applications that merely interact with the API, regardless of whether they
     communicate through network calls or other mechanisms.
 
-  version: 1.0.0-rc.153
+  version: 1.0.0-rc.154
   contact:
     name: Filip Leonarski (Paul Scherrer Institute)
     email: filip.leonarski@psi.ch
diff --git a/broker/redoc-static.html b/broker/redoc-static.html
index 207f3324..ecef9526 100644
--- a/broker/redoc-static.html
+++ b/broker/redoc-static.html
@@ -399,7 +399,7 @@ This format doesn&#x27;t transmit information about X-axis, only values, so it i
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-eulNck iEaKWZ api-content"><div class="sc-dcJsrY bBkGhy"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx api-info"><h1 class="sc-imWYAI sc-ktJbId cILgPb UQJzT">Jungfraujoch<!-- --> <span>(<!-- -->1.0.0-rc.153<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eeDRCY sc-eBMEME gTGgei fMmru"><div class="sc-fiCwlc iQovLz"><div class="sc-jIGnZt cKLRU"><span class="sc-kMkxaj csEIgT">Filip Leonarski (Paul Scherrer Institute)<!-- -->:<!-- --> <a href="mailto:filip.leonarski@psi.ch">filip.leonarski@psi.ch</a></span> <!-- --> <span class="sc-kMkxaj csEIgT">License:<!-- --> <a href="https://www.gnu.org/licenses/gpl-3.0.html">GPL-3.0</a></span> </div></div></div><div class="sc-eeDRCY sc-eBMEME gTGgei fMmru" data-role="redoc-summary"></div><div class="sc-eeDRCY sc-eBMEME gTGgei fMmru" data-role="redoc-description"><p>API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland).
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-eulNck iEaKWZ api-content"><div class="sc-dcJsrY bBkGhy"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx api-info"><h1 class="sc-imWYAI sc-ktJbId cILgPb UQJzT">Jungfraujoch<!-- --> <span>(<!-- -->1.0.0-rc.154<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eeDRCY sc-eBMEME gTGgei fMmru"><div class="sc-fiCwlc iQovLz"><div class="sc-jIGnZt cKLRU"><span class="sc-kMkxaj csEIgT">Filip Leonarski (Paul Scherrer Institute)<!-- -->:<!-- --> <a href="mailto:filip.leonarski@psi.ch">filip.leonarski@psi.ch</a></span> <!-- --> <span class="sc-kMkxaj csEIgT">License:<!-- --> <a href="https://www.gnu.org/licenses/gpl-3.0.html">GPL-3.0</a></span> </div></div></div><div class="sc-eeDRCY sc-eBMEME gTGgei fMmru" data-role="redoc-summary"></div><div class="sc-eeDRCY sc-eBMEME gTGgei fMmru" data-role="redoc-description"><p>API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland).
 Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU.
 Jungfraujoch uses FPGA boards to acquire data at high data rates.</p>
 </div></div></div></div><div id="section/License-Clarification" data-section-id="section/License-Clarification" class="sc-dcJsrY bBkGhy"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#section/License-Clarification" aria-label="section/License-Clarification"></a>License Clarification</h2></div></div><div class="sc-fqkvVR diIqQJ"><div class="sc-eeDRCY sc-eBMEME gTGgei fMmru redoc-markdown "><p>While this API definition is licensed under GPL-3.0, <strong>the GPL copyleft provisions do not apply</strong>
@@ -937,7 +937,7 @@ then image might be replaced in the buffer between calling /images and /image.cb
 </div></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-ejfMa-d bNUPQg"><button class="sc-EgOXT cFEcOl"><span type="get" class="sc-eZYNyq qGfV http-verb get">get</span><span class="sc-iEXKAA gUNSDu">/version</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dlWCHZ kWacYr"><div class="sc-hHOBiw cndTNO"><div class="sc-eeDRCY sc-eBMEME gTGgei fbXBig"><p>Test Jungfraujoch system</p>
 </div><div tabindex="0" role="button"><div class="sc-kWtpeL gEncxT"><span>http://localhost:5232</span>/version</div></div></div></div></div></div></div></div></div><div class="sc-dExYaf gZbfaQ"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.3","info":{"title":"Jungfraujoch","description":"API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland).\nJungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU.\nJungfraujoch uses FPGA boards to acquire data at high data rates.\n\n# License Clarification\n\nWhile this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply**\nwhen this file is used solely to generate OpenAPI clients or when implementing applications that\ninteract with the API. Generated client code and applications using this API definition are not\nsubject to the GPL license requirements and may be distributed under terms of your choosing.\n\nThis exception is similar in spirit to the Linux Kernel's approach to userspace API headers and\nthe GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that\nuser programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not\nderivative works of the kernel and are not subject to the terms of the GPL.\n\nThis exception is intended to allow wider use of this API specification without imposing GPL\nrequirements on applications that merely interact with the API, regardless of whether they\ncommunicate through network calls or other mechanisms.\n","version":"1.0.0-rc.153","contact":{"name":"Filip Leonarski (Paul Scherrer Institute)","email":"filip.leonarski@psi.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.html"}},"servers":[{"url":"http://localhost:5232","description":"Test Jungfraujoch system"}],"components":{"parameters":{"binning":{"in":"query","name":"binning","required":false,"schema":{"default":1,"type":"integer"},"description":"Binning of frames for the plot (0 = default binning)"},"experimental_coord":{"in":"query","name":"experimental_coord","required":false,"schema":{"type":"boolean","default":false},"description":"If measurement has goniometer axis defined, plot X-axis will represent rotation angle\nIf measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value\nFor still measurement the number is ignored\n"},"azint_unit":{"in":"query","name":"azint_unit","required":false,"schema":{"type":"string","enum":["Q_recipA","d_A","two_theta_deg"],"default":"Q_recipA"},"description":"Unit used for azim int.\n"},"fill_value":{"in":"query","name":"fill","required":false,"schema":{"type":"number","format":"float"},"description":"Fill value for elements that were missed during data collection\n"},"plot_type":{"in":"query","name":"type","required":true,"description":"Type of requested plot","schema":{"type":"string","enum":["bkg_estimate","azint","azint_1d","spot_count","spot_count_low_res","spot_count_indexed","spot_count_ice","indexing_rate","indexing_lattice_count","indexing_unit_cell_length","indexing_unit_cell_angle","profile_radius","mosaicity","b_factor","error_pixels","saturated_pixels","image_collection_efficiency","receiver_delay","receiver_free_send_buf","strong_pixels","roi_sum","roi_mean","roi_max_count","roi_pixels","roi_weighted_x","roi_weighted_y","packets_received","max_pixel_value","resolution_estimate","pixel_sum","processing_time","beam_center_x","beam_center_y","integrated_reflections","image_scale_factor","image_scale_cc","image_scale_b","compression_ratio"]}},"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","schema":{"type":"string","enum":["indigo","viridis","bw","wb","green","heat","magma","inferno"],"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 least-square diffraction geometry refinement algorithm used by Jungfraujoch.\nBeamCenter - This option is refining both beam center and lattice (restricted to a chosen/detected Bravais lattice).\nOrientationOnly - This option is refining only orientation of the lattice.\n","enum":["BeamCenter","OrientationOnly","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/user of the HDF5 file. \nThis applies solely to string and number (double floating-point). No arrays/sub-objects is allowed.\nFor example {\"hdf5\": {\"val1\":1, \"val2\":\"xyz\"}}, will write /entry/user/val1 and /entry/user/val2.\n"},"image_appendix":{"description":"Image appendix, added as user_data to image ZeroMQ message (can be any valid JSON)\nNot saved in HDF5 file\n"},"data_reduction_factor_serialmx":{"type":"number","format":"float","default":1,"minimum":0,"maximum":1,"description":"Rate at which non-indexed images are accepted to be forwarded to writer. \nValue of 1.0 (default) means that all images are written.\nValues below zero mean that non-indexed images will be accepted with a given probability.\n"},"pixel_value_low_threshold":{"type":"integer","format":"int64","minimum":0,"description":"Set all counts lower than the value to zero. \nWhen the value is set, negative numbers other than error pixel value are always set to zero.\nSetting to zero is equivalent to turning the option off.\n"},"run_number":{"type":"integer","format":"int64","minimum":0,"description":"Number of run within an experimental session. \nTransferred over CBOR stream as \"series ID\", though not saved in HDF5 file.\nIt is highly recommended to keep this number unique for each data collection during experimental series.\nIf not provided, the number will be automatically incremented.\n"},"run_name":{"type":"string","description":"Unique ID of run.\nTransferred over CBOR stream as \"unique series ID\", though not saved in HDF5 file.\nIt is highly recommended to keep this name unique for each data collection during experimental series.\nIf not provided, the name will be automatically generated as number + colon + file_prefix.\n"},"experiment_group":{"type":"string","description":"Name of group owning the data (e.g. p-group or proposal number). \nTransferred over CBOR stream, though not saved in HDF5 file.\n"},"poisson_compression":{"type":"integer","format":"int64","minimum":0,"maximum":16,"description":"Enable lossy compression of pixel values that preserves Poisson statistics. \nRequires to provide a numerical factor SQ.\nPixel value P will be transformed to round(sqrt(P) * SQ), with rounding to the closest integer.\nCompression is turned off if the value is missing or it is set to zero.\n"},"write_nxmx_hdf5_master":{"type":"boolean","default":true,"description":"Write NXmx formatted HDF5 master file. Recommended to use for macromolecular crystallography experiments\nand to turn off for other experiments.\n"},"save_calibration":{"type":"boolean","description":"Forward image calibration (at the moment pedestal and pedestal RMS for JUNGFRAU) using the ZeroMQ stream to writer.\nIf parameter is not provided calibration will be saved only if more than 4 images are recorded.\n"},"polarization_factor":{"type":"number","description":"Polarization factor for integration; 1.0 is horizontal polarization; -1.0 is vertical polarization","format":"float","minimum":-1,"maximum":1},"ring_current_mA":{"type":"number","format":"float","description":"Ring current at the beginning of the data collection","minimum":0},"sample_temperature_K":{"type":"number","format":"float","description":"Sample temperature in Kelvin","minimum":0},"poni_rot1_rad":{"type":"number","description":"PONI angle rot1 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"poni_rot2_rad":{"type":"number","description":"PONI angle rot2 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"poni_rot3_rad":{"type":"number","description":"PONI angle rot3 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"unit_cell":{"$ref":"#/components/schemas/unit_cell"},"spot_finding":{"type":"boolean","description":"Enable spot finding and save spots","default":true},"max_spot_count":{"type":"integer","minimum":10,"maximum":2000,"default":250,"description":"Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected"},"detect_ice_rings":{"type":"boolean","description":"Flag spots as ice rings and reduce their effect on indexing"},"async_start":{"type":"boolean","default":false,"description":"When set to true, `/start` will not wait for detector and Jungfraujoch to be ready for the measurement."},"xray_fluorescence_spectrum":{"type":"object","required":["energy_eV","data"],"properties":{"energy_eV":{"type":"array","items":{"type":"number","format":"float"},"description":"X-ray fluorescence scan energy for each measurement point"},"data":{"type":"array","items":{"type":"number","format":"float"},"description":"X-ray fluorescence scan result in arbitrary units; must be exactly the same length, as energy_eV"}}}}},"crystal_lattice":{"type":"array","items":{"type":"number","format":"float"},"minItems":9,"maxItems":9,"description":"Real-space crystal lattice 3D vectors in Angstrom.\nOrder is 1st vector (x,y,z), 2nd vector (x,y,z) and 3rd vector (x,y,z)\n"},"unit_cell":{"type":"object","description":"Unit cell parameters. Necessary to run indexing. Units of angstrom and degree","required":["a","b","c","alpha","beta","gamma"],"properties":{"a":{"type":"number","format":"float","example":37,"minimum":0},"b":{"type":"number","format":"float","example":37,"minimum":0},"c":{"type":"number","format":"float","example":78,"minimum":0},"alpha":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360},"beta":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360},"gamma":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360}}},"file_writer_format":{"type":"string","enum":["NXmxOnlyData","NXmxLegacy","NXmxVDS","NXmxIntegrated","CBF","TIFF","NoFileWritten"],"default":"NXmxLegacy","description":"NoFileWritten - no files are written at all\nNXmxOnlyData - only data files are written, no master file\nNXmxLegacy - legacy format with soft links to data files in the master file; necessary for DECTRIS Albula 4.0 and DECTRIS Neggia  \nNXmxVDS - newer format with virtual dataset linking data files in the master file, also includes better metadata handling\nNXmxIntegrated - single HDF5 per dataset\nCBF - CBF format (limited metadata)\nTIFF - TIFF format (no metadata)\n"},"file_writer_settings":{"type":"object","properties":{"overwrite":{"type":"boolean","default":false,"description":"Inform jfjoch_write to overwrite existing files. Otherwise files would be saved with .h5.{timestamp}.tmp suffix.\n"},"format":{"$ref":"#/components/schemas/file_writer_format"}}},"pixel_mask_statistics":{"type":"object","properties":{"user_mask":{"description":"Number of pixels masked using the user mask","type":"integer","format":"int64","minimum":0},"too_high_pedestal_rms":{"description":"Number of pixels with G0 pedestal RMS higher than provided threshold","type":"integer","format":"int64","minimum":0},"wrong_gain":{"description":"Number of pixels that show wrong gain level during the pedestal procedure","type":"integer","format":"int64","minimum":0}}},"image_buffer_status":{"type":"object","required":["image_numbers","total_slots","in_preparation_slots","in_sending_slots","available_slots","max_image_number","min_image_number"],"properties":{"min_image_number":{"type":"integer","format":"int64","minimum":0,"description":"Smallest image number available in the buffer"},"max_image_number":{"type":"integer","format":"int64","minimum":0,"description":"Largest image number available in the buffer"},"image_numbers":{"type":"array","description":"Image numbers currently present in the buffer.","items":{"type":"integer","format":"int64"}},"total_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer. This number, compared to number of images in data collection and\nframe rate will determine \"retention\" rate of the image buffer.\n"},"available_slots":{"type":"integer","format":"int64","description":"Slots available for the data collection"},"in_preparation_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer that are currently in preparation for sending.\n"},"in_sending_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer that are currently sending/writing data.\n"},"current_counter":{"type":"integer","format":"int64","description":"Counter of changes in the image buffer - either new start message or new image added.\nFor optimization one can only load new images/datasets from the HTTP if this value changes.\nCounter is optional as it was not implemented in older versions to avoid breaking change\n"}}},"image_format_settings":{"type":"object","required":["summation","jungfrau_conversion","geometry_transform","mask_chip_edges","mask_module_edges","apply_mask"],"properties":{"summation":{"type":"boolean","description":"Enable summation of images to a given image_time\nIf disabled images are saved according to original detector speed, but image count is adjusted\n"},"geometry_transform":{"type":"boolean","description":"Place module read-out into their location on composed detector and extend multipixels\n"},"jungfrau_conversion":{"type":"boolean","description":"Convert pixel value in ADU to photon counts/energy\nOnly affects JUNGFRAU detector\n"},"jungfrau_conversion_factor_keV":{"type":"number","format":"float","minimum":0.001,"maximum":500,"description":"Used to convert energy deposited into pixel to counts\nIf not provided incident_energy_keV is used\n"},"bit_depth_image":{"type":"integer","format":"int64","enum":[8,16,32],"description":"Bit depth of resulting image (it doesn't affect the detector read-out value)\nIf not provided value is adjusted automatically\n"},"signed_output":{"type":"boolean","description":"Controls if pixels have signed output\nIf not provided value is adjusted automatically\n"},"mask_module_edges":{"type":"boolean","default":true,"description":"Mask 1 pixel on the module boundary\n"},"mask_chip_edges":{"type":"boolean","default":true,"description":"Mask multipixels on chip boundary\n"},"jungfrau_mask_pixels_without_g0":{"type":"boolean","default":true,"description":"JUNGFRAU: mask pixels that don't operate in G0, but do operate in G1 and G1.\nThis should be turned off for cases, where detector is operated at room temperature with long exposure time.\n"},"apply_mask":{"type":"boolean","default":false,"description":"Masked pixels are set to special value in the images produced by Jungfraujoch\n"},"jungfrau_pedestal_g0_rms_limit":{"type":"integer","format":"int64","default":100,"minimum":0,"description":"Pixels with pedestal G0 RMS above the threshold are marked as masked pixels"}}},"detector_power_state":{"type":"string","description":"Power on of ASICs","enum":["PowerOn","PowerOff","Partial"]},"detector_state":{"type":"string","description":"Current state of the detector","enum":["Idle","Waiting","Busy","Error","Not connected"]},"detector_status":{"type":"object","required":["state","powerchip","server_version","number_of_triggers_left","fpga_temp_degC","high_voltage_V"],"properties":{"state":{"$ref":"#/components/schemas/detector_state"},"powerchip":{"$ref":"#/components/schemas/detector_power_state"},"server_version":{"type":"string","description":"Detector server (on read-out boards) version"},"number_of_triggers_left":{"type":"integer","format":"int64","description":"Remaining triggers to the detector (max of all modules)"},"fpga_temp_degC":{"type":"array","description":"Temperature of detector FPGAs","items":{"type":"integer","format":"int64"}},"high_voltage_V":{"type":"array","description":"High voltage for detector modules","items":{"type":"integer","format":"int64"}}}},"detector_timing":{"type":"string","enum":["auto","trigger","burst","gated"],"default":"trigger"},"detector_settings":{"type":"object","required":["frame_time_us"],"properties":{"frame_time_us":{"type":"integer","description":"Interval between consecutive frames.\nThis is internal frame time for the JUNGFRAU detector, image time has to be integer multiply of this number.\nFor EIGER detector this is default frame time, not used otherwise\n","format":"int64","minimum":1},"count_time_us":{"type":"integer","description":"Integration time of the detector. \nIf not provided count time will be set to maximum value for a given frame time.\n","format":"int64"},"internal_frame_generator":{"type":"boolean","default":false,"description":"Use internal frame generator in FPGA instead of getting data from a real detector"},"internal_frame_generator_images":{"type":"integer","format":"int64","default":1,"minimum":1,"maximum":64,"description":"Number of images stored in the internal frame generator."},"detector_trigger_delay_ns":{"type":"integer","format":"int64","minimum":0,"default":0,"description":"Delay between TTL trigger and acquisition start [ns]"},"timing":{"$ref":"#/components/schemas/detector_timing"},"eiger_threshold_keV":{"type":"number","format":"float","minimum":1,"maximum":100,"description":"Threshold for the PSI EIGER detector and all DECTRIS detectors.\nIf value is provided, it will be used for all subsequent acquisitions, irrespective of beam energy.\nIf value is not provided, threshold will be determined on start of acquisition as half of incident energy. \nThis might lead to increased start time.\n"},"eiger_bit_depth":{"type":"integer","format":"int64","enum":[8,16,32],"description":"Bit depth of PSI EIGER read-out. This is  \nIf value is not provided, depth will be determined based on the image time:\n* Exposure time < 500 microseconds depth of 8 bit will be used,\n* 500 <= exposure time < 2622 microseconds depth of 16 bit will be used\n* Exposure time >= 2622 microseconds depth of 32 bit will be used.\n"},"jungfrau_pedestal_g0_frames":{"type":"integer","format":"int64","default":2000,"minimum":0},"jungfrau_pedestal_g1_frames":{"type":"integer","format":"int64","default":300,"minimum":0},"jungfrau_pedestal_g2_frames":{"type":"integer","format":"int64","default":300,"minimum":0},"jungfrau_pedestal_min_image_count":{"type":"integer","format":"int64","default":128,"minimum":32,"description":"Minimum number of collected images for pedestal to consider it viable"},"jungfrau_storage_cell_count":{"type":"integer","format":"int64","default":1,"minimum":1,"maximum":16},"jungfrau_storage_cell_delay_ns":{"type":"integer","format":"int64","minimum":2100,"default":5000,"description":"Delay between two storage cells [ns]"},"jungfrau_fixed_gain_g1":{"type":"boolean","default":false,"description":"Fix gain to G1 (can be useful for storage cells)"},"jungfrau_use_gain_hg0":{"type":"boolean","default":false,"description":"Use high G0 (for low energy applications)"}}},"spot_finding_settings":{"type":"object","required":["enable","indexing","signal_to_noise_threshold","photon_count_threshold","max_pix_per_spot","min_pix_per_spot","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","minimum":0.00002,"maximum":10,"format":"float"},"low_q_recipA":{"type":"number","format":"float","minimum":0.00001,"maximum":10},"q_spacing":{"type":"number","format":"float","minimum":0.00001},"azimuthal_bins":{"type":"integer","format":"int64","minimum":1,"maximum":512,"default":1,"description":"Numer of azimuthal (phi) bins; 1 = standard 1D azimuthal integration"},"force_cpu":{"type":"boolean","default":false,"description":"Force CPU processing of azimuthal integration in the FPGA data acquisition workflow.\nThis allows to extend number of azimuthal integration bins, as well as to calculate standard deviation\nof the azimuthal integration results.\n"}}},"detector_list_element":{"type":"object","required":["id","nmodules","description","width","height","serial_number","base_ipv4_addr","udp_interface_count","readout_time_ns","min_frame_time_ns","min_count_time_ns"],"properties":{"id":{"type":"integer","format":"int64","minimum":0},"description":{"type":"string","example":"JUNGFRAU 4 Mpixel"},"serial_number":{"type":"string","example":"JF17T16V01"},"base_ipv4_addr":{"type":"string","example":"10.10.10.1"},"udp_interface_count":{"type":"integer","format":"int64","example":2,"description":"Number of UDP interfaces per detector module"},"nmodules":{"type":"integer","format":"int64","example":18},"width":{"type":"integer","format":"int64","example":2068},"height":{"type":"integer","format":"int64","example":2164},"pixel_size_mm":{"type":"number","format":"float","example":0.075},"readout_time_ns":{"type":"integer","format":"int64"},"min_frame_time_ns":{"type":"integer","format":"int64"},"min_count_time_ns":{"type":"integer","format":"int64"},"type":{"$ref":"#/components/schemas/detector_type"}}},"detector_list":{"type":"object","required":["detectors","current_id"],"properties":{"detectors":{"type":"array","items":{"$ref":"#/components/schemas/detector_list_element"}},"current_id":{"type":"integer","format":"int64","example":0}}},"detector_selection":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","example":1}}},"measurement_statistics":{"type":"object","properties":{"file_prefix":{"type":"string"},"run_number":{"type":"integer","format":"int64","description":"Number of data collection run. This can be either automatically incremented or provided externally for each data collection.\n"},"experiment_group":{"type":"string","description":"Name of group owning the data (e.g. p-group or proposal number).\n"},"images_expected":{"type":"integer","format":"int64"},"images_collected":{"type":"integer","format":"int64","description":"Images collected by the receiver. This number will be lower than images expected if there were issues with data collection performance.\n"},"images_sent":{"type":"integer","format":"int64","description":"Images sent to the writer. \nThe value does not include images discarded by lossy compression filter and images not forwarded due to full ZeroMQ queue.\n"},"images_written":{"type":"integer","format":"int64","description":"Images successfully written to disk.\nThe value is live updated for TCP/IP socket and direct HDF5 writer, while for ZeroMQ it is only updated at the end of experiment.\n"},"images_discarded_lossy_compression":{"type":"integer","format":"int64","description":"Images discarded by the lossy compression filter"},"max_image_number_sent":{"type":"integer","format":"int64"},"collection_efficiency":{"type":"number","format":"float","example":1,"minimum":0,"maximum":1},"compression_ratio":{"type":"number","format":"float","example":5.3,"minimum":0},"cancelled":{"type":"boolean"},"max_receiver_delay":{"type":"integer","format":"int64"},"indexing_rate":{"type":"number","format":"float"},"detector_width":{"type":"integer","format":"int64"},"detector_height":{"type":"integer","format":"int64"},"detector_pixel_depth":{"type":"integer","format":"int64","enum":[2,4]},"bkg_estimate":{"type":"number","format":"float"},"unit_cell":{"type":"string"},"error_pixels":{"type":"number","format":"float","description":"Moving average of 1000 images counting number of error pixels on the detector"},"saturated_pixels":{"type":"number","format":"float","description":"Moving average of 1000 images counting number of saturated pixels on the detector"},"roi_beam_pixels":{"type":"number","format":"float","description":"If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images\nfor number of valid pixels within this ROI\n"},"roi_beam_sum":{"type":"number","format":"float","description":"If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images\nfor sum of valid pixels within this ROI\n"}}},"fpga_status":{"type":"array","items":{"type":"object","required":["pci_dev_id","serial_number","base_mac_addr","eth_link_status","eth_link_count","eth_link_speed","power_usage_W","fpga_temp_C","hbm_temp_C","packets_sls","packets_udp","idle","fw_version","pcie_link_speed","pcie_link_width"],"properties":{"pci_dev_id":{"type":"string"},"serial_number":{"type":"string"},"fw_version":{"type":"string"},"base_mac_addr":{"type":"string"},"eth_link_count":{"type":"integer","format":"int64"},"eth_link_status":{"type":"integer","format":"int64"},"power_usage_W":{"type":"number","format":"float"},"fpga_temp_C":{"type":"number","format":"float"},"hbm_temp_C":{"type":"number","format":"float"},"packets_udp":{"type":"integer","format":"int64"},"packets_sls":{"type":"integer","format":"int64"},"idle":{"type":"boolean"},"pcie_link_speed":{"type":"integer","format":"int64","description":"PCIe link speed measured by generation (expected value is 4 == PCIe Gen4)"},"pcie_link_width":{"type":"integer","format":"int64","description":"PCIe link width (expected value is 8 == x8)"}}}},"broker_status":{"type":"object","required":["state"],"properties":{"state":{"type":"string","enum":["Inactive","Idle","Busy","Measuring","Pedestal","Error"]},"progress":{"type":"number","format":"float","description":"Progress of data collection (only available if receiving is running)","example":1,"minimum":0,"maximum":1},"message":{"type":"string","description":"Message to display besides state of the jfjoch_broker; mostly used for errors and warnings\nThis matters especially for async functions (start/initialize), where API won't return reason\nfor the error during async operation.\n"},"message_severity":{"type":"string","enum":["success","info","warning","error"],"default":"error","description":"Level of the message to display"},"gpu_count":{"type":"integer","format":"int32","description":"Number of installed GPUs"},"broker_version":{"type":"string","description":"Version of the jfjoch_broker","example":"1.0.0-rc.128"}}},"image_pusher_status":{"type":"object","required":["pusher_type","addr","connected_writers"],"description":"Informs about status of the image pusher.\n","properties":{"pusher_type":{"$ref":"#/components/schemas/image_pusher_type"},"addr":{"type":"array","items":{"type":"string"},"example":["tcp://1.2.3.4:5000","tcp://1.2.3.4:5001"],"description":"List of addresses of image pushers.\nFor HDF5 socket - no addresses will be returned.\nFor ZeroMQ - list of addresses for each socket will be provided.\nFor TCP/IP - single address to connect all writers will be provided.\n"},"connected_writers":{"type":"integer","format":"int64","minimum":0,"description":"Number of connected writers \nFor ZeroMQ image socket: number is constant\nFor TCP/IP image socket: number is updated live during operation\n"},"images_written":{"type":"integer","format":"int64","minimum":0,"description":"Number of images written to the image socket.\nThis number is updated live during operation for TCP/IP image socket and direct HDF5 writer.\nIt is updated at the end of experiment for ZeroMQ image socket.\n"},"images_write_error":{"type":"integer","format":"int64","minimum":0,"description":"Number of images that could not be written to the image socket.\nThis number is updated live during operation for TCP/IP image socket.\nNo other socket use it.\n"},"writer_fifo_utilization":{"type":"array","items":{"type":"integer","format":"int64","minimum":0},"description":"Utilization of internal writer FIFO.\nThis number is updated live during operation for TCP/IP image socket.\nNo other socket use it.\n"}}},"plot":{"type":"object","required":["x","y","title"],"description":"x and y coordinates for plotting, it is OK to assume that both arrays have the same size; layout is optimized for Plotly","properties":{"title":{"type":"string","default":""},"x":{"type":"array","items":{"type":"number","format":"float"}},"y":{"type":"array","items":{"type":"number","format":"float","nullable":true}},"z":{"type":"array","items":{"type":"number","format":"float","nullable":true}}}},"plot_unit_x":{"type":"string","enum":["image_number","q_recipA","d_A","angle_deg","ADU","grid_um"],"default":"image_number"},"plots":{"type":"object","required":["plot","unit_x"],"properties":{"title":{"type":"string"},"unit_x":{"$ref":"#/components/schemas/plot_unit_x"},"size_x":{"type":"number","format":"float","description":"Max X range of the plot"},"size_y":{"type":"number","format":"float","description":"Max Y range of the plot"},"plot":{"type":"array","items":{"$ref":"#/components/schemas/plot"}}}},"scan_result":{"type":"object","description":"Results of a scan","required":["images"],"properties":{"file_prefix":{"type":"string"},"rotation_unit_cell":{"$ref":"#/components/schemas/unit_cell"},"rotation_crystal_lattice":{"$ref":"#/components/schemas/crystal_lattice"},"images":{"type":"array","items":{"type":"object","required":["efficiency","number"],"properties":{"efficiency":{"type":"number","format":"float"},"number":{"type":"integer","format":"int64","description":"Detector image number for a given cell"},"nx":{"type":"integer","format":"int64","description":"Cell position in X for grid scan"},"ny":{"type":"integer","format":"int64","description":"Cell position in Y for grid scan"},"angle":{"type":"number","format":"float","description":"Rotation angle associated with the image"},"bkg":{"type":"number","format":"float","description":"Background estimate"},"spots":{"type":"integer","format":"int64","description":"Spot count"},"spots_low_res":{"type":"integer","format":"int64","description":"Spot count in low resolution range"},"spots_indexed":{"type":"integer","format":"int64","description":"Spot count within indexing tolerance"},"spots_ice":{"type":"integer","format":"int64","description":"Spot count within common ice ring resolutions"},"index":{"type":"integer","format":"int64","description":"Indexing solution"},"latt_count":{"type":"integer","format":"int64","description":"Indexing lattice count"},"pr":{"type":"number","format":"float","description":"Profile radius, i.e. how far reflections are from the Ewald sphere"},"b":{"type":"number","format":"float","description":"B-Factor estimate"},"uc":{"$ref":"#/components/schemas/unit_cell"},"xfel_pulseid":{"type":"integer","format":"int64","description":"XFEL pulse ID"},"pixel_sum":{"type":"integer","format":"int64","description":"Total sum of all pixels"},"max":{"type":"integer","format":"int64","description":"Max viable pixel"},"sat":{"type":"integer","format":"int64","description":"Number of saturated pixels"},"err":{"type":"integer","format":"int64","description":"Number of error pixels"},"res":{"type":"number","format":"float","description":"Diffraction resolution estimate"}}}}}},"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"},"image_pusher":{"$ref":"#/components/schemas/image_pusher_status"}}},"error_message":{"type":"object","required":["msg","reason"],"properties":{"msg":{"type":"string","description":"Human readable message","example":"Detector in wrong state"},"reason":{"type":"string","description":"Enumerate field for automated analysis","enum":["WrongDAQState","Other"]}}},"roi_azimuthal":{"type":"object","description":"ROI as Q-range (or resolution range), optionally restricted to an azimuthal-angle sector","required":["name","q_min_recipA","q_max_recipA"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"q_min_recipA":{"type":"number","format":"float","minimum":0.00001,"description":"Minimum Q-range for the ROI"},"q_max_recipA":{"type":"number","format":"float","minimum":0.00001,"description":"Maximum Q-range for the ROI"},"phi_min_deg":{"type":"number","format":"float","description":"Lower azimuthal-angle bound of the sector [degrees]. Optional: provide both phi_min_deg and phi_max_deg to restrict the ROI to an angular sector, or omit both for a full ring. A sector with phi_min_deg > phi_max_deg wraps across 0.\n"},"phi_max_deg":{"type":"number","format":"float","description":"Upper azimuthal-angle bound of the sector [degrees]. Optional; see phi_min_deg.\n"}}},"roi_circle":{"type":"object","description":"Circular ROI","required":["name","center_x_pxl","center_y_pxl","radius_pxl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"center_x_pxl":{"type":"number","format":"float","description":"X coordinate of center of the circle [pixels]"},"center_y_pxl":{"type":"number","format":"float","description":"Y coordinate of center of the circle [pixels]"},"radius_pxl":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"Radius of the circle [pixels]"}}},"roi_box":{"type":"object","description":"Box ROI","required":["name","min_x_pxl","max_x_pxl","min_y_pxl","max_y_pxl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"min_x_pxl":{"type":"integer","format":"int64","description":"Lower bound (inclusive) in X coordinate for the box","minimum":0},"max_x_pxl":{"type":"integer","format":"int64","description":"Upper bound (inclusive) in X coordinate for the box","minimum":0},"min_y_pxl":{"type":"integer","format":"int64","description":"Lower bound (inclusive) in Y coordinate for the box","minimum":0},"max_y_pxl":{"type":"integer","format":"int64","description":"Upper bound (inclusive) in Y coordinate for the box","minimum":0}}},"roi_circle_list":{"type":"object","description":"List of circular ROIs","required":["rois"],"properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_circle"}}}},"roi_box_list":{"type":"object","description":"List of box ROIs","properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_box"}}}},"roi_azim_list":{"type":"object","description":"List of azimuthal ROIs","properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_azimuthal"}}}},"roi_definitions":{"type":"object","required":["box","circle","azim"],"description":"ROI defintions","properties":{"box":{"$ref":"#/components/schemas/roi_box_list"},"circle":{"$ref":"#/components/schemas/roi_circle_list"},"azim":{"$ref":"#/components/schemas/roi_azim_list"}}},"dark_mask_settings":{"type":"object","description":"Settings for collection of dark images to be used for mask calculation","required":["detector_threshold_keV","frame_threshold_keV","max_allowed_pixel_count","max_frames_with_signal","frame_time_us","number_of_frames"],"properties":{"detector_threshold_keV":{"type":"number","format":"float","description":"Energy threshold for dark image collection","minimum":2.5,"default":3.5,"maximum":100},"frame_time_us":{"type":"integer","format":"int64","description":"Time between frames for dark image collection","minimum":500,"default":10000,"maximum":100000},"number_of_frames":{"type":"integer","format":"int64","description":"Number of frames for dark image collection; zero means no dark collection","minimum":0,"default":1000},"max_allowed_pixel_count":{"type":"integer","format":"int64","description":"Maximum count in a pixel considered normal (not-masked)","minimum":0,"default":1},"max_frames_with_signal":{"type":"integer","format":"int64","description":"Maximum number of frames with signal in a pixel considered normal (not-masked)","minimum":0,"default":10}}},"indexing_settings":{"type":"object","description":"Settings for crystallography indexing","required":["algorithm","geom_refinement_algorithm","fft_high_resolution_A","fft_max_unit_cell_A","fft_min_unit_cell_A","fft_num_vectors","tolerance","thread_count","unit_cell_dist_tolerance","index_ice_rings","viable_cell_min_spots","rotation_indexing","rotation_indexing_min_angular_range_deg","rotation_indexing_angular_stride_deg","blocking"],"properties":{"algorithm":{"$ref":"#/components/schemas/indexing_algorithm"},"fft_max_unit_cell_A":{"type":"number","format":"float","default":250,"maximum":500,"minimum":50,"description":"Largest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT"},"fft_min_unit_cell_A":{"type":"number","format":"float","default":10,"minimum":5,"maximum":40,"description":"Smallest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT"},"fft_high_resolution_A":{"type":"number","format":"float","default":2,"minimum":0.5,"maximum":6,"description":"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"},"rotation_indexing":{"type":"boolean","default":false},"rotation_indexing_min_angular_range_deg":{"type":"number","format":"float","default":20,"minimum":1},"rotation_indexing_angular_stride_deg":{"type":"number","format":"float","default":0.5,"minimum":0},"blocking":{"type":"boolean","default":true,"description":"Indexing in Jungfraujoch goes with a dedicated thread pool.\nIf set to false, the thread pool is non-blocking, i.e. if there are no threads available, image indexing will be skipped. This option is recommended for real-time processing at high frame rates.\nIf set to true, the thread pool will block until a thread is available.\n"}}},"instrument_metadata":{"type":"object","description":"Metadata for a measurement instrument","required":["source_name","instrument_name"],"properties":{"source_name":{"type":"string","example":"Swiss Light Source"},"source_type":{"type":"string","description":"Type of radiation source. NXmx gives a fixed dictionary, though Jungfraujoch is not enforcing compliance. \nhttps://manual.nexusformat.org/classes/base_classes/NXsource.html#nxsource\nNXsource allows the following:\n\nSpallation Neutron Source\nPulsed Reactor Neutron Source\nReactor Neutron Source\nSynchrotron X-ray Source\nPulsed Muon Source\nRotating Anode X-ray\nFixed Tube X-ray\nUV Laser\nFree-Electron Laser\nOptical Laser\nIon Source\nUV Plasma Source\nMetal Jet X-ray\n","example":"Synchrotron X-ray Source","default":""},"instrument_name":{"type":"string","example":"CristallinaMX"},"pulsed_source":{"type":"boolean","description":"Settings specific to XFEL (e.g., every image has to come from TTL trigger, save pulse ID and event code)\n","default":false},"electron_source":{"type":"boolean","description":"Settings specific to electron source (e.g., wavelength definition)\n","default":false}}},"detector_module_direction":{"type":"string","enum":["Xp","Xn","Yp","Yn"]},"detector_type":{"type":"string","enum":["EIGER","JUNGFRAU","DECTRIS"]},"image_pusher_type":{"type":"string","default":"None","enum":["ZeroMQ","HDF5","CBOR","TCP","None"]},"standard_detector_geometry":{"type":"object","description":"Regular rectangular geometry, first module is in the bottom left corner of the detector","required":["nmodules"],"properties":{"nmodules":{"type":"integer","minimum":1,"description":"Number of modules in the detector"},"gap_x":{"type":"integer","default":8,"minimum":0,"description":"Gap size in X direction [pixels]"},"gap_y":{"type":"integer","minimum":0,"default":36,"description":"Gap size in Y direction [pixels]"},"modules_in_row":{"type":"integer","minimum":1,"default":1,"description":"Number of modules in one row"}}},"detector_module":{"type":"object","required":["x0","y0","fast_axis","slow_axis"],"properties":{"x0":{"type":"number"},"y0":{"type":"number"},"fast_axis":{"$ref":"#/components/schemas/detector_module_direction"},"slow_axis":{"$ref":"#/components/schemas/detector_module_direction"}}},"detector":{"type":"object","required":["description"],"properties":{"description":{"type":"string","minLength":1},"serial_number":{"type":"string","default":"Unknown","minLength":1},"type":{"$ref":"#/components/schemas/detector_type"},"high_voltage_V":{"type":"integer","format":"int64","minimum":0,"maximum":200,"default":0},"udp_interface_count":{"type":"integer","format":"int64","minimum":1,"maximum":2,"default":1},"module_sync":{"type":"boolean","default":true,"description":"Use module 0 as master for timing. Only applies to JUNGFRAU detector (this cannot be turned off for EIGER)."},"sensor_thickness_um":{"type":"number","format":"float","minimum":0,"default":320},"readout_time_ns":{"type":"integer","format":"int64","minimum":1,"description":"Minimum difference between frame time and count time in microseconds\nDefaults are 3'000 ns for EIGER and 20'000 ns for JUNGFRAU\n"},"min_count_time_ns":{"type":"integer","format":"int64","minimum":0,"description":"Minimum count time available for the detector."},"min_frame_time_ns":{"type":"integer","format":"int64","minimum":0,"description":"Minimum frame time available for the detector."},"calibration_file":{"type":"array","description":"Can be empty for all detectors - default calibration used.\nFor JUNGFRAU: list of gain files, one entry per module.\nFor EIGER: one directory (with detector settings) or list of trim bit files, one entry per half-module.\n","items":{"type":"string"}},"trim_energies_eV":{"type":"array","description":"List of energies at which trimming calibration is provided.\nOnly needed for PSI EIGER and compulsory in this case\n","items":{"type":"integer","format":"int32","minimum":100}},"hostname":{"type":"array","description":"Hostname for detector module. One entry per module\nOne entry per module. Either empty or number of module entries.\n","items":{"type":"string"}},"sensor_material":{"type":"string","default":"Si"},"tx_delay":{"type":"array","items":{"type":"integer","format":"int64"}},"base_data_ipv4_address":{"type":"string","example":"10.10.10.50"},"standard_geometry":{"$ref":"#/components/schemas/standard_detector_geometry"},"custom_geometry":{"type":"array","items":{"$ref":"#/components/schemas/detector_module"}},"roi_mode":{"type":"string","default":"","description":"ROI setting for DECTRIS detectors"},"mirror_y":{"type":"boolean","default":true,"description":"Mirror detector in Y direction to account for MX convention of (0,0) point in top left corner"},"temp_thresold_degC":{"type":"integer","format":"int64","description":"Temperature threshold for JUNGFRAU detector modules","minimum":40,"maximum":70,"default":55},"default_settings":{"$ref":"#/components/schemas/detector_settings"}}},"zeromq_settings":{"type":"object","description":"ZeroMQ configuration for Jungfraujoch software.\nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","properties":{"send_watermark":{"type":"integer","format":"int64","minimum":2,"maximum":16384,"default":100,"description":"Watermark for ZeroMQ send queue (number of outstanding messages queued on Jungfraujoch server per queue)"},"send_buffer_size":{"type":"integer","format":"int64","description":"Send buffer size for ZeroMQ socket"},"image_socket":{"type":"array","items":{"type":"string"},"example":["tcp://1.2.3.4:5000","tcp://1.2.3.4:5001"],"description":"PUSH ZeroMQ socket for images. In case multiple sockets are provided, images are streamed over multiple sockets.  \nImages are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"},"writer_notification_socket":{"type":"string","example":"tcp://1.3.4.6:7000","description":"PULL ZeroMQ socket for notifications from writer that it finished operation. \nThis allows Jungfraujoch to operate in a synchronous manner, with end of acquisition being also end of writing.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address should be avoided, as this socket address is forwarded to the writer process via START ZerOMQ message and in case of multiple ineterfaces the address might be ambigous.\nUsing * (star) instead of port number is allowed and it means a random free port number.\n"}}},"tcp_settings":{"type":"object","description":"TCP image stream configuration for Jungfraujoch software.\nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","required":["addr"],"properties":{"send_buffer_size":{"type":"integer","format":"int64","description":"Send buffer size for TCP/IP socket"},"image_socket":{"type":"string","example":"tcp://1.2.3.4:5000","description":"tcp://<IP address>:<port>\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces\n"},"nwriters":{"type":"integer","format":"int64","minimum":1,"maximum":100,"default":32,"description":"Number of TCP/IP writers to be used for streaming images"},"peer_liveness_timeout_ms":{"type":"integer","format":"int64","description":"Max time (in milliseconds) a send may block with no sign of life from the\nwriter (no BUSY heartbeat or ACK) before the connection is declared dead.\nOptional; the built-in default is used when unset.\n"},"max_backpressure_timeout_ms":{"type":"integer","format":"int64","description":"Hard upper bound (in milliseconds) on backpressure: if no bytes can be sent to\nthe writer for this long the connection is declared dead even while the writer\nkeeps heartbeating, so a wedged writer cannot block the run or its\nfinalization. Optional; the built-in default is used when unset.\n"}}},"pcie_devices":{"type":"array","minLength":1,"items":{"type":"object","required":["block_device"],"properties":{"blk":{"type":"string","example":"/dev/jfjoch0","description":"Block device name"},"ipv4":{"type":"string","example":"10.1.1.7","description":"IPv4 address of the block device"}}}},"jfjoch_settings":{"type":"object","required":["detector","frontend_directory","image_pusher"],"description":"Default settings for Jungfraujoch software. \nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","properties":{"pcie":{"$ref":"#/components/schemas/pcie_devices"},"zeromq":{"$ref":"#/components/schemas/zeromq_settings"},"tcp":{"$ref":"#/components/schemas/tcp_settings"},"instrument":{"$ref":"#/components/schemas/instrument_metadata"},"file_writer":{"$ref":"#/components/schemas/file_writer_settings"},"detector":{"type":"array","minLength":1,"items":{"$ref":"#/components/schemas/detector"}},"indexing":{"$ref":"#/components/schemas/indexing_settings"},"detector_settings":{"$ref":"#/components/schemas/detector_settings"},"azim_int":{"$ref":"#/components/schemas/azim_int_settings"},"image_format":{"$ref":"#/components/schemas/image_format_settings"},"image_buffer_MiB":{"type":"integer","minimum":128,"default":2048,"description":"Size of internal buffer in MiB for images before they are sent to a stream"},"verbose":{"type":"boolean","default":false,"description":"Print extra debug information"},"receiver_threads":{"type":"integer","minimum":1,"maximum":512,"default":64,"description":"Number of threads used by the receiver"},"numa_policy":{"type":"string","deprecated":true,"description":"Ignored value"},"frontend_directory":{"type":"string","description":"Location of built JavaScript web frontend"},"spot_finding":{"$ref":"#/components/schemas/spot_finding_settings"},"image_pusher":{"$ref":"#/components/schemas/image_pusher_type"},"zeromq_preview":{"$ref":"#/components/schemas/zeromq_preview_settings"},"zeromq_metadata":{"$ref":"#/components/schemas/zeromq_metadata_settings"},"dark_mask":{"$ref":"#/components/schemas/dark_mask_settings"}}},"zeromq_metadata_settings":{"type":"object","required":["enabled","period_ms"],"properties":{"enabled":{"type":"boolean","default":true,"description":"ZeroMQ metadata socket is enabled."},"period_ms":{"type":"integer","format":"int64","minimum":1,"default":1000,"description":"Period for generating metadata package sent to the ZeroMQ interface in milliseconds.\n"},"socket_address":{"type":"string","description":"PUB ZeroMQ socket for image metadata information.\nImage metadata are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"}}},"zeromq_preview_settings":{"type":"object","required":["enabled","period_ms"],"properties":{"enabled":{"type":"boolean","default":true,"description":"ZeroMQ preview socket is enabled."},"period_ms":{"type":"integer","format":"int64","default":1000,"description":"Period for generating preview image sent to the ZeroMQ interface in milliseconds. Default is 1 second. \nIf set to zero, all images will be sent ZeroMQ (should be used only in case of relatively slow data collection).\nThis has no effect on HTTP based preview, which updates always at rate of 1 second.\n"},"socket_address":{"type":"string","description":"PUB ZeroMQ socket for preview images. This socket operates at a reduced frame rate.\nImages are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"}}}}},"paths":{"/initialize":{"post":{"summary":"Initialize detector and data acquisition","description":"Should be used in two cases:\n  - Detector is in `Inactive` state\n  - Detector is in `Error` state\nX-ray shutter must be closed. \nThis operation will reconfigure network interface of the detector. \nDuring operation of the detector it is recommended to use the `POST /pedestal` operation instead.\nIf storage cells are used, the execution time might be few minutes.\n\nThis is async function - one needs to use `POST /wait_till_done` to ensure operation is done.\n","responses":{"200":{"description":"Initialization started"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/pedestal":{"post":{"summary":"Collect dark current for the detector","description":"Updates calibration of the JUNGFRAU detector. Must be in `Idle` state.\n\nX-ray shutter must be closed. Recommended to run once per hour for long integration times (> 100 us).\n\nThis is async function - one needs to use `POST /wait_till_done` to ensure operation is done.\n","responses":{"200":{"description":"Everything OK"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/start":{"post":{"summary":"Start detector","description":"Start data acquisition.\nDetector must be in `Idle` state.\nDefault behavior is for the call to block until detector is ready to accept soft/TTL triggers.\nHowever, this behavior can be changed by settings `async_start` to true in the request body, \nin which case the call will return immediately and one needs to use `/wait_until_running` to ensure detector is ready to run.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/wait_until_running":{"post":{"summary":"Wait for acquisition running","parameters":[{"in":"query","name":"timeout","required":false,"schema":{"type":"integer","default":60,"minimum":0,"maximum":3600},"description":"Timeout in seconds (0 == immediate response)"}],"description":"Block execution of external script till detector and Jungfraujoch are ready to collect data.\nTo not block web server for a indefinite period of time, the procedure is provided with a timeout.\nExtending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.\n","responses":{"200":{"description":"Detector in `Measuring` state"},"400":{"description":"Timeout parameter out of bounds"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}},"502":{"description":"Detector is inactive mode"},"504":{"description":"Timeout reached, need to restart operation"}}}},"/wait_till_done":{"post":{"summary":"Wait for acquisition done","parameters":[{"in":"query","name":"timeout","required":false,"schema":{"type":"integer","default":60,"minimum":0,"maximum":3600},"description":"Timeout in seconds (0 == immediate response)"}],"description":"Block execution of external script till initialization, data collection or pedestal is finished.\nRunning this command does not affect (cancel) running data collection, it is only to ensure synchronous execution of other software.\n\nTo not block web server for a indefinite period of time, the procedure is provided with a timeout.\nExtending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.\n","responses":{"200":{"description":"Detector in `Idle` state, another data collection can start immediately"},"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"}}}},"/image_pusher/status":{"get":{"summary":"Get status of image pusher","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_pusher_status"}}}},"500":{"description":"Error encountered when trying to read status","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/detector/status":{"get":{"summary":"Get detector status","description":"Status of the JUNGFRAU detector","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_status"}}}},"404":{"description":"Running in \"simulator\" mode - no detector present"},"500":{"description":"Error encountered when trying to read status","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/config/roi":{"get":{"summary":"Get ROI definitions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roi_definitions"}}}}}},"put":{"summary":"Upload ROI definitions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/roi_definitions"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/statistics":{"get":{"summary":"Get general statistics","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jfjoch_statistics"}}}}}}},"/statistics/data_collection":{"get":{"summary":"Get data collection statistics","description":"Results of the last data collection","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/measurement_statistics"}}}},"404":{"description":"No data collection performed so far"}}}},"/statistics/calibration":{"get":{"summary":"Get calibration statistics","description":"Statistics are provided for each module/storage cell separately","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calibration_statistics"}}}}}}},"/config/mask":{"get":{"summary":"Get mask of the detector (binary)","description":"Detector must be Initialized.\nGet full pixel mask of the detector.\nSee NXmx standard for meaning of pixel values.\n","responses":{"200":{"description":"Binary array (4 byte; unsigned)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}},"/config/user_mask":{"get":{"summary":"Detector must be Initialized.\nGet user mask of the detector (binary)\n","description":"Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked","responses":{"200":{"description":"User mask in binary format (4 byte; unsigned)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"summary":"Upload user mask of the detector (binary)","description":"Should be in `Idle` state.\nUpload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.\nIf detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.\nIn the latter case - module gaps are ignored and don't need to be assigned value.\nMask is expected as binary array (4-byte; unsigned).\n0 - good pixel, other value - masked\nUser mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.\n","requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"All good"},"400":{"description":"Mask is not 4-byte unsigned integer array or empty body"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/config/mask.tiff":{"get":{"summary":"Get mask of the detector (TIFF)","description":"Should be in `Idle` state.\nGet full pixel mask of the detector\nSee NXmx standard for meaning of pixel values\n","responses":{"200":{"description":"Pixel mask in TIFF format (4 byte; unsigned)","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}}}}},"/config/user_mask.tiff":{"get":{"summary":"Detector must be Initialized.\nGet user mask of the detector (TIFF)\n","description":"Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked","responses":{"200":{"description":"User mask in TIFF format (4 byte; unsigned)","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"summary":"Upload user mask of the detector","description":"Should be in `Idle` state.\nUpload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.\nIf detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.\nIn the latter case - module gaps are ignored and don't need to be assigned value.\nMask is expected as a single-channel TIFF (8-, 16- or 32-bit integer, signed or unsigned).\n0 - good pixel, other value - masked\nUser mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.\nUser mask is not automatically applied - i.e. pixels with user mask will have a valid pixel value in the images.\n","requestBody":{"content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"All good"},"400":{"description":"Not a valid single-channel TIFF or size doesn't match the detector"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/preview/pedestal.tiff":{"get":{"parameters":[{"in":"query","name":"gain_level","required":true,"schema":{"type":"integer"},"description":"Gain level (0, 1, 2)"},{"in":"query","name":"sc","schema":{"type":"integer"},"description":"Storage cell number"}],"summary":"Get pedestal in TIFF format","responses":{"200":{"description":"Calibration image","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid gain level or storage cell number"},"404":{"description":"No calibration recorded so far"}}}},"/preview/plot":{"get":{"summary":"Generate 1D plot from Jungfraujoch","parameters":[{"$ref":"#/components/parameters/binning"},{"$ref":"#/components/parameters/plot_type"},{"$ref":"#/components/parameters/fill_value"},{"$ref":"#/components/parameters/experimental_coord"},{"$ref":"#/components/parameters/azint_unit"}],"responses":{"200":{"description":"Everything OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/plots"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/preview/plot.bin":{"get":{"summary":"Generate 1D plot from Jungfraujoch and send in raw binary format.\nData are provided as (32-bit) float binary array.\nThis format doesn't transmit information about X-axis, only values, so it is of limited use for azimuthal integration.\n","parameters":[{"$ref":"#/components/parameters/plot_type"},{"$ref":"#/components/parameters/roi"}],"responses":{"200":{"description":"Everything OK.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/result/scan":{"get":{"summary":"Get full scan result","responses":{"200":{"description":"Everything OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scan_result"}}}},"404":{"description":"No grid scan recorded"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/start.cbor":{"get":{"summary":"Get Start message in CBOR format","description":"Contains metadata for a dataset (e.g., experimental geometry)","responses":{"200":{"description":"Return start message","content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No measurement so far"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.cbor":{"get":{"summary":"Get image message in CBOR format","description":"Contains full image data and metadata. The image must come from the latest data collection.","parameters":[{"$ref":"#/components/parameters/image_id"}],"responses":{"200":{"description":"Return image message","content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Image not present in the buffer - either not yet measured or already replaced by a next image."},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.jpeg":{"get":{"summary":"Get preview image in JPEG format using custom settings","parameters":[{"$ref":"#/components/parameters/image_id"},{"$ref":"#/components/parameters/show_user_mask"},{"$ref":"#/components/parameters/show_roi"},{"$ref":"#/components/parameters/show_spots"},{"$ref":"#/components/parameters/show_beam_center"},{"$ref":"#/components/parameters/saturation"},{"$ref":"#/components/parameters/jpeg_quality"},{"$ref":"#/components/parameters/resolution_ring"},{"$ref":"#/components/parameters/color_scale"},{"$ref":"#/components/parameters/resolution_estimate"}],"responses":{"200":{"description":"Preview image","content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"404":{"description":"Image not present in the buffer - either not yet measured or already replaced by a next image."},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.tiff":{"get":{"summary":"Get preview image in TIFF format","parameters":[{"$ref":"#/components/parameters/image_id"}],"responses":{"200":{"description":"Preview image","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No preview image recorded so far"}}}},"/image_buffer/clear":{"post":{"summary":"Clear image buffer","description":"Turns off image buffer for the last data collection. Can be only run when Jungfraujoch is not collecting data.","responses":{"200":{"description":"Done"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/status":{"get":{"summary":"Get status of the image buffers","description":"Can be run at any stage of Jungfraujoch operation, including during data collection.\nThe status of the image buffer is volatile during data collection - if data collection goes for more images than available buffer slots,\nthen image might be replaced in the buffer between calling /images and /image.cbor.\n","responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_buffer_status"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/version":{"get":{"summary":"Get Jungfraujoch version of jfjoch_broker","responses":{"200":{"description":"Release number of Jungfraujoch","content":{"text/plain":{"schema":{"type":"string","example":"1.0.0-rc.25"}}}}}}}}}},"searchIndex":{"store":["section/License-Clarification","/paths/~1initialize/post","/paths/~1pedestal/post","/paths/~1start/post","/paths/~1wait_until_running/post","/paths/~1wait_till_done/post","/paths/~1trigger/post","/paths/~1cancel/post","/paths/~1deactivate/post","/paths/~1config~1detector/put","/paths/~1config~1detector/get","/paths/~1config~1indexing/put","/paths/~1config~1indexing/get","/paths/~1config~1file_writer/put","/paths/~1config~1file_writer/get","/paths/~1config~1instrument/put","/paths/~1config~1instrument/get","/paths/~1config~1image_format/put","/paths/~1config~1image_format/get","/paths/~1config~1image_format~1raw/post","/paths/~1config~1image_format~1conversion/post","/paths/~1config~1spot_finding/put","/paths/~1config~1spot_finding/get","/paths/~1config~1azim_int/put","/paths/~1config~1azim_int/get","/paths/~1config~1internal_generator_image/put","/paths/~1config~1internal_generator_image.tiff/put","/paths/~1config~1select_detector/put","/paths/~1config~1select_detector/get","/paths/~1config~1zeromq_preview/put","/paths/~1config~1zeromq_preview/get","/paths/~1config~1zeromq_metadata/put","/paths/~1config~1zeromq_metadata/get","/paths/~1config~1dark_mask/put","/paths/~1config~1dark_mask/get","/paths/~1status/get","/paths/~1fpga_status/get","/paths/~1xfel~1pulse_id/get","/paths/~1xfel~1event_code/get","/paths/~1image_pusher~1status/get","/paths/~1detector~1status/get","/paths/~1config~1roi/get","/paths/~1config~1roi/put","/paths/~1statistics/get","/paths/~1statistics~1data_collection/get","/paths/~1statistics~1calibration/get","/paths/~1config~1mask/get","/paths/~1config~1user_mask/get","/paths/~1config~1user_mask/put","/paths/~1config~1mask.tiff/get","/paths/~1config~1user_mask.tiff/get","/paths/~1config~1user_mask.tiff/put","/paths/~1preview~1pedestal.tiff/get","/paths/~1preview~1plot/get","/paths/~1preview~1plot.bin/get","/paths/~1result~1scan/get","/paths/~1image_buffer~1start.cbor/get","/paths/~1image_buffer~1image.cbor/get","/paths/~1image_buffer~1image.jpeg/get","/paths/~1image_buffer~1image.tiff/get","/paths/~1image_buffer~1clear/post","/paths/~1image_buffer~1status/get","/paths/~1version/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.076,1,4.719]],["description/0",[0,1.814,2,4.176,3,2.164,4,2.1,5,1.203,6,3.348,7,1.203,8,1.203,9,1.039,10,0.931,11,1.612,12,1.203,13,0.96,14,1.203,15,1.626,16,1.203,17,2.794,18,2.1,19,0.931,20,2.1,21,1.28,22,1.203,23,2.1,24,1.039,25,2.794,26,1.203,27,1.203,28,2.1,29,1.203,30,1.203,31,1.203,32,1.203,33,1.203,34,1.203,35,1.203,36,2.794,37,1.203,38,1.203,39,0.365,40,0.611,41,1.203,42,2.1,43,1.039,44,1.203,45,1.203,46,1.203,47,1.203,48,1.203,49,1.203,50,1.039,51,1.203,52,1.203,53,1.203,54,1.203,55,1.203,56,1.203,57,1.203,58,1.203,59,0.931,60,0.931,61,1.203]],["title/1",[62,2.287,63,0.409,64,0.96,65,1.908]],["description/1",[11,2.207,39,0.962,43,1.696,59,1.52,62,1.196,63,0.5,66,1.963,67,1.389,68,2.029,69,0.898,70,0.945,71,1.52,72,1.696,73,1.389,74,2.997,75,1.963,76,1.52,77,1.696,78,2.741,79,1.196,80,1.963,81,1.963,82,1.696,83,1.389,84,1.284,85,1.963,86,1.963,87,1.696,88,1.696,89,1.284,90,1.284,91,1.52,92,1.284,93,0.595]],["title/2",[63,0.409,94,1.356,95,2.906,96,2.655]],["description/2",[11,1.236,39,0.779,63,0.28,68,1.99,71,1.988,72,2.218,73,1.816,74,1.678,77,2.218,78,2.218,79,1.564,84,1.678,87,2.218,88,2.218,89,1.678,90,1.678,91,1.988,92,1.678,93,0.779,97,2.567,98,1.988,99,2.218,100,0.849,101,1.305,102,2.567,103,2.567,104,2.567,105,2.567,106,1.564,107,2.567]],["title/3",[63,0.515,108,3.653]],["description/3",[11,1.128,39,0.71,60,2.825,63,0.489,64,0.599,65,1.19,67,1.656,89,1.531,90,1.531,92,1.531,100,0.774,101,1.19,108,2.825,109,2.342,110,3.649,111,1.813,112,2.342,113,3.152,114,2.342,115,2.342,116,1.813,117,1.128,118,0.809,119,2.342,120,2.342,121,1.813,122,2.342,123,1.531,124,2.342,125,2.023]],["title/4",[65,2.125,101,2.125,126,3.612]],["description/4",[15,1.988,21,1.564,63,0.28,64,0.657,73,1.816,83,1.816,84,1.678,92,1.678,94,0.927,111,3.032,113,2.218,125,2.218,127,2.218,128,2.218,129,2.218,130,1.236,131,2.218,132,2.218,133,2.218,134,2.218,135,1.988,136,1.678,137,3.383,138,2.218,139,1.988,140,2.218,141,3.383,142,2.218]],["title/5",[65,2.125,93,1.268,126,3.612]],["description/5",[15,1.641,21,1.291,62,1.291,64,0.863,73,1.499,79,1.291,83,2.385,84,1.385,91,1.641,92,2.205,94,1.218,101,1.714,111,2.611,127,1.831,128,1.831,129,1.831,131,1.831,132,1.831,133,1.831,134,1.831,135,1.641,136,1.385,137,2.914,138,1.831,139,1.641,140,1.831,141,2.914,142,1.831,143,1.831,144,1.499,145,2.119,146,1.641,147,2.119,148,2.119]],["title/6",[63,0.409,116,2.906,149,3.243,150,3.243]],["description/6",[13,2.441,116,5.02,150,4.61]],["title/7",[64,0.96,94,1.356,101,1.908,146,2.906]],["description/7",[39,0.643,59,1.641,63,0.231,64,1.075,65,1.077,79,1.291,84,1.385,94,1.218,96,2.385,100,0.701,101,1.077,143,2.914,144,3.387,146,1.641,151,1.831,152,1.291,153,2.119,154,2.611,155,1.831,156,2.119,157,2.119,158,1.831,159,2.119,160,2.119,161,1.641,162,2.119,163,2.119,164,2.119,165,2.119,166,2.119,167,2.119,168,2.119,169,1.641]],["title/8",[63,0.456,170,4.181,171,3.237]],["description/8",[11,1.607,39,1.012,63,0.518,64,0.854,65,1.696,70,1.607,100,1.103,144,2.36,171,3.68,172,4.753,173,3.337,174,3.337,175,3.337,176,3.337,177,3.337,178,3.337]],["title/9",[63,0.456,117,2.013,179,1.912]],["description/9",[39,1.301,63,0.579,68,1.758,69,1.582,70,1.666,71,1.694,74,1.431,76,1.694,79,2.108,83,2.447,89,1.431,93,0.664,94,0.79,98,2.679,100,1.144,117,1.054,118,1.482,135,1.694,169,1.694,180,1.891,181,2.188,182,1.891,183,2.188,184,2.188,185,1.891]],["title/10",[63,0.515,179,2.158]],["description/10",[93,1.686,185,4.802,186,2.99]],["title/11",[117,1.808,118,1.297,187,3.243,188,3.753]],["description/11",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,189,4.117]],["title/12",[179,2.158,187,4.076]],["description/12",[93,1.686,186,2.99,189,4.802]],["title/13",[10,2.906,117,1.808,118,1.297,161,2.906]],["description/13",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,190,4.117]],["title/14",[10,3.237,118,1.444,161,3.237]],["description/14",[93,1.686,186,2.99,190,4.802]],["title/15",[117,2.013,191,3.612,192,2.388]],["description/15",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,193,4.117]],["title/16",[191,4.076,192,2.695]],["description/16",[93,1.686,186,2.99,193,4.802]],["title/17",[117,1.808,194,1.241,195,3.243,196,1.808]],["description/17",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,197,4.117]],["title/18",[194,1.383,195,3.612,196,2.013]],["description/18",[93,1.686,186,2.99,197,4.802]],["title/19",[64,0.871,94,1.23,179,1.557,196,1.64,198,2.408]],["description/19",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,199,4.765]],["title/20",[64,0.797,94,1.125,179,1.425,196,1.501,200,2.037,201,2.413]],["description/20",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,202,4.765]],["title/21",[179,1.912,203,3.237,204,3.237]],["description/21",[64,1.264,93,1.499,94,1.785,101,2.512,186,2.658,205,4.269]],["title/22",[64,1.07,158,3.612,179,1.912]],["description/22",[93,1.686,186,2.99,205,4.802]],["title/23",[106,2.548,179,1.912,206,2.734]],["description/23",[63,0.56,69,2.347,93,1.556,100,1.697,207,4.433]],["title/24",[106,2.548,179,1.912,206,2.734]],["description/24",[93,1.686,186,2.99,207,4.802]],["title/25",[13,1.425,152,1.899,194,1.03,208,2.204,209,1.78,210,2.204]],["description/25",[13,1.387,21,1.848,39,0.92,63,0.572,100,1.003,118,1.048,152,1.848,194,1.003,208,2.146,209,1.733,210,2.146,211,2.621,212,3.033,213,2.621,214,2.349,215,2.621,216,2.621,217,2.621,218,1.848,219,2.621,220,3.033]],["title/26",[13,1.425,152,1.899,194,1.03,208,2.204,210,2.204,221,1.78]],["description/26",[13,1.42,21,1.891,39,0.941,63,0.58,100,1.026,118,1.072,152,1.891,194,1.026,208,2.195,210,2.195,211,2.682,213,2.682,214,2.403,215,2.682,216,2.682,217,2.682,218,1.891,219,2.682,221,1.773,222,3.104]],["title/27",[63,0.515,223,4.076]],["description/27",[21,1.694,24,2.402,39,0.843,50,3.594,63,0.603,69,1.272,89,2.72,117,1.339,118,0.961,130,1.339,136,1.818,144,1.967,224,2.781,225,2.781,226,2.781,227,2.781,228,2.402,229,2.153,230,2.781,231,2.781,232,2.781,233,2.402]],["title/28",[63,0.456,228,3.612,234,3.237]],["description/28",[11,2.471,63,0.56,179,2.347,223,4.433,233,4.433]],["title/29",[118,1.783,235,2.287,236,2.454]],["description/29",[13,1.174,64,0.657,117,1.236,118,1.353,121,3.032,130,1.236,169,1.988,235,1.564,236,2.561,237,1.816,238,2.218,239,2.567,240,3.032,241,2.218,242,2.218,243,2.218,244,1.816,245,2.218,246,2.218,247,3.383,248,1.816,249,3.383,250,2.567,251,2.567,252,2.218]],["title/30",[118,1.444,235,2.548,236,2.734]],["description/30",[252,5.238]],["title/31",[118,1.783,192,2.144,235,2.287]],["description/31",[13,1.299,64,0.727,117,1.368,118,0.981,121,2.199,130,1.368,192,1.622,194,0.939,235,1.73,237,2.009,238,3.651,240,3.272,241,2.453,242,2.453,243,2.453,244,2.009,245,2.453,246,2.453,247,2.453,248,2.009,249,2.453,253,2.84,254,2.84,255,2.453]],["title/32",[118,1.297,192,2.144,235,2.287,240,2.906]],["description/32",[255,5.238]],["title/33",[64,0.735,94,1.037,95,2.224,118,0.992,179,1.314,256,2.481,257,1.136]],["description/33",[39,1.094,63,0.548,69,1.65,70,1.737,74,2.358,93,1.094,100,1.193,139,2.793,234,2.793,258,3.607,259,3.607,260,3.607,261,3.607,262,3.607,263,3.116]],["title/34",[64,0.797,94,1.125,95,2.413,118,1.076,256,2.692,257,1.233]],["description/34",[263,5.238]],["title/35",[130,2.272,264,2.538]],["description/35",[64,1.365,65,2.712,264,3.487]],["title/36",[152,2.548,264,2.249,265,4.181]],["description/36",[266,6.064]],["title/37",[64,0.735,65,1.46,96,2.032,123,1.878,229,2.224,267,2.032,268,2.481]],["description/37",[68,2.188,123,2.814,194,1.423,229,3.333,267,3.045,268,3.719,269,3.045,270,3.333,271,4.305,272,4.305]],["title/38",[19,2.224,64,0.735,65,1.46,96,2.032,123,1.878,267,2.032,273,2.481]],["description/38",[19,3.826,123,3.231,267,3.495,269,3.495,273,4.269,274,4.942]],["title/39",[194,1.383,264,2.249,275,4.181]],["description/39",[276,6.064]],["title/40",[63,0.515,264,2.538]],["description/40",[63,0.582,99,4.61,264,2.87,277,5.337]],["title/41",[3,3.653,278,4.076]],["description/41",[279,5.238]],["title/42",[3,3.237,278,3.612,280,2.734]],["description/42",[279,5.238]],["title/43",[13,2.158,281,3.085]],["description/43",[281,3.965]],["title/44",[64,1.07,94,1.51,281,2.734]],["description/44",[64,1.313,94,1.853,282,4.433,283,4.433,284,5.132]],["title/45",[98,3.653,281,3.085]],["description/45",[82,4.117,136,3.116,281,3.116,285,4.765,286,4.765,287,4.765,288,4.765]],["title/46",[63,0.456,209,2.388,257,1.654]],["description/46",[62,2.392,63,0.58,200,2.566,257,1.553,289,3.242,290,3.391,291,2.776,292,3.391,293,3.391,294,2.566,295,3.925]],["title/47",[40,1.584,62,1.899,63,0.493,209,1.78,257,1.233]],["description/47",[40,1.884,63,0.558,68,2.601,218,2.259,257,2.024,270,2.87,289,3.118,296,3.203,297,2.622,298,2.622,299,3.203]],["title/48",[40,1.731,63,0.371,209,1.945,257,1.347,280,2.226]],["description/48",[11,0.765,39,0.482,40,1.355,63,0.291,67,1.124,68,2.048,90,1.039,100,0.526,106,0.968,154,1.231,198,1.124,201,1.231,203,1.231,204,1.231,206,1.039,209,0.908,218,0.968,248,1.124,257,1.922,269,1.124,280,1.039,289,1.624,291,1.124,294,1.743,297,1.124,298,1.124,299,1.373,300,1.373,301,1.373,302,1.373,303,1.373,304,1.373,305,1.373,306,1.373,307,1.373,308,1.373,309,1.373,310,2.303,311,1.373,312,1.373,313,1.373,314,1.373,315,1.373,316,1.373,317,1.589,318,1.373,319,1.373,320,1.373,321,1.373,322,1.373]],["title/49",[63,0.456,221,2.388,257,1.654]],["description/49",[39,1.191,63,0.428,100,1.298,200,2.566,257,1.553,289,3.242,290,3.391,291,2.776,292,3.391,293,3.391,294,2.566,323,3.925]],["title/50",[40,1.584,62,1.899,63,0.493,221,1.78,257,1.233]],["description/50",[40,1.884,63,0.558,68,2.601,218,2.259,257,2.024,270,2.87,289,3.118,296,3.203,297,2.622,298,2.622,324,3.203]],["title/51",[40,1.908,63,0.409,257,1.485,280,2.454]],["description/51",[9,1.142,11,0.637,39,0.401,40,1.815,63,0.249,67,0.935,68,2.048,90,0.864,100,0.437,106,0.805,154,1.024,180,1.142,182,1.142,194,0.437,198,0.935,201,1.024,203,1.024,204,1.024,206,0.864,214,1.024,218,0.805,221,0.755,248,0.935,257,1.973,280,0.864,289,2.177,291,0.935,294,1.964,297,0.935,298,0.935,300,1.142,301,1.142,302,1.142,303,1.142,304,1.142,305,1.142,306,1.142,307,1.142,308,1.142,309,1.142,310,1.969,311,1.142,312,1.142,313,1.142,314,1.142,315,1.142,316,1.142,318,1.142,319,1.142,320,1.142,321,1.969,322,1.142,324,1.142,325,1.322,326,1.322,327,1.142,328,1.322,329,1.322]],["title/52",[79,2.548,196,2.013,221,2.388]],["description/52",[330,6.064]],["title/53",[13,1.717,130,1.808,331,3.243,332,3.243]],["description/53",[333,6.064]],["title/54",[11,0.594,13,0.564,64,0.315,106,0.751,130,0.594,136,0.806,149,1.065,151,1.065,196,1.033,198,0.872,206,0.806,209,1.225,269,0.872,294,0.806,327,1.065,331,1.065,332,1.065,334,1.232,335,1.232,336,1.232,337,1.232,338,1.232]],["description/54",[339,6.064]],["title/55",[200,2.734,282,3.612,340,4.181]],["description/55",[341,6.064]],["title/56",[108,2.906,196,1.808,237,2.655,342,3.243]],["description/56",[192,2.722,244,3.371,343,4.765,344,4.765,345,4.765,346,4.765,347,4.765]],["title/57",[194,1.241,196,1.808,237,2.655,342,3.243]],["description/57",[64,1.418,94,1.506,192,2.382,194,1.832,200,2.727,244,2.95,348,4.17,349,4.17,350,4.17]],["title/58",[11,1.383,118,0.992,194,0.95,196,1.383,236,1.878,351,2.872,352,2.872]],["description/58",[353,6.064]],["title/59",[194,1.241,196,1.808,221,2.144,236,2.454]],["description/59",[354,6.064]],["title/60",[194,1.383,355,4.181,356,2.957]],["description/60",[64,1.418,94,2.001,101,2.119,130,2.008,171,3.229,194,1.379,283,3.603,356,2.95,357,4.17]],["title/61",[194,1.383,264,2.249,356,2.957]],["description/61",[60,1.95,64,1.201,68,1.28,74,1.647,76,2.989,94,1.695,101,1.28,130,1.213,155,2.176,194,1.74,234,1.95,264,1.355,356,3.319,358,2.519,359,2.519,360,2.519,361,2.519,362,2.519,363,2.519,364,2.519,365,2.519,366,2.519]],["title/62",[130,2.013,367,3.612,368,4.181]],["description/62",[367,5.238]]],"invertedIndex":[["",{"_index":68,"title":{},"description":{"1":{},"2":{},"9":{},"37":{},"47":{},"48":{},"50":{},"51":{},"61":{}}}],["0",{"_index":297,"title":{},"description":{"47":{},"48":{},"50":{},"51":{}}}],["1",{"_index":270,"title":{},"description":{"37":{},"47":{},"50":{}}}],["100",{"_index":107,"title":{},"description":{"2":{}}}],["1024x512",{"_index":308,"title":{},"description":{"48":{},"51":{}}}],["16",{"_index":326,"title":{},"description":{"51":{}}}],["16-bit",{"_index":213,"title":{},"description":{"25":{},"26":{}}}],["1d",{"_index":331,"title":{"53":{},"54":{}},"description":{}}],["32-bit",{"_index":327,"title":{"54":{}},"description":{"51":{}}}],["4-byte",{"_index":317,"title":{},"description":{"48":{}}}],["8",{"_index":321,"title":{},"description":{"48":{},"51":{}}}],["accept",{"_index":114,"title":{},"description":{"3":{}}}],["account",{"_index":301,"title":{},"description":{"48":{},"51":{}}}],["acquisit",{"_index":65,"title":{"1":{},"4":{},"5":{},"37":{},"38":{}},"description":{"3":{},"7":{},"8":{},"35":{}}}],["actual",{"_index":296,"title":{},"description":{"47":{},"50":{}}}],["adjust",{"_index":242,"title":{},"description":{"29":{},"31":{}}}],["affect",{"_index":145,"title":{},"description":{"5":{}}}],["again",{"_index":181,"title":{},"description":{"9":{}}}],["algorithm",{"_index":188,"title":{"11":{}},"description":{}}],["allow",{"_index":50,"title":{},"description":{"0":{},"27":{}}}],["alway",{"_index":176,"title":{},"description":{"8":{}}}],["and/or",{"_index":226,"title":{},"description":{"27":{}}}],["anytim",{"_index":186,"title":{},"description":{"10":{},"12":{},"14":{},"16":{},"18":{},"21":{},"22":{},"24":{}}}],["api",{"_index":2,"title":{},"description":{"0":{}}}],["appli",{"_index":9,"title":{},"description":{"0":{},"51":{}}}],["applic",{"_index":17,"title":{},"description":{"0":{}}}],["approach",{"_index":30,"title":{},"description":{"0":{}}}],["array",{"_index":269,"title":{"54":{}},"description":{"37":{},"38":{},"48":{}}}],["asic",{"_index":175,"title":{},"description":{"8":{}}}],["assign",{"_index":315,"title":{},"description":{"48":{},"51":{}}}],["async",{"_index":87,"title":{},"description":{"1":{},"2":{}}}],["async_start",{"_index":119,"title":{},"description":{"3":{}}}],["automat",{"_index":182,"title":{},"description":{"9":{},"51":{}}}],["avail",{"_index":234,"title":{"28":{}},"description":{"33":{},"61":{}}}],["azimuth",{"_index":206,"title":{"23":{},"24":{},"54":{}},"description":{"48":{},"51":{}}}],["back",{"_index":168,"title":{},"description":{"7":{}}}],["base",{"_index":251,"title":{},"description":{"29":{}}}],["be",{"_index":157,"title":{},"description":{"7":{}}}],["beam",{"_index":302,"title":{},"description":{"48":{},"51":{}}}],["befor",{"_index":177,"title":{},"description":{"8":{}}}],["behavior",{"_index":110,"title":{},"description":{"3":{}}}],["between",{"_index":364,"title":{},"description":{"61":{}}}],["binari",{"_index":209,"title":{"25":{},"46":{},"47":{},"48":{},"54":{}},"description":{"25":{},"48":{}}}],["bit",{"_index":320,"title":{},"description":{"48":{},"51":{}}}],["blob",{"_index":212,"title":{},"description":{"25":{}}}],["block",{"_index":111,"title":{},"description":{"3":{},"4":{},"5":{}}}],["bodi",{"_index":122,"title":{},"description":{"3":{}}}],["both",{"_index":307,"title":{},"description":{"48":{},"51":{}}}],["buffer",{"_index":356,"title":{"60":{},"61":{}},"description":{"60":{},"61":{}}}],["calcul",{"_index":256,"title":{"33":{},"34":{}},"description":{}}],["calibr",{"_index":98,"title":{"45":{}},"description":{"2":{},"9":{}}}],["call",{"_index":60,"title":{},"description":{"0":{},"3":{},"61":{}}}],["cancel",{"_index":146,"title":{"7":{}},"description":{"5":{},"7":{}}}],["card",{"_index":153,"title":{},"description":{"7":{}}}],["case",{"_index":67,"title":{},"description":{"1":{},"3":{},"48":{},"51":{}}}],["cbor",{"_index":342,"title":{"56":{},"57":{}},"description":{}}],["cell",{"_index":82,"title":{},"description":{"1":{},"45":{}}}],["chang",{"_index":117,"title":{"9":{},"11":{},"13":{},"15":{},"17":{}},"description":{"3":{},"9":{},"27":{},"29":{},"31":{}}}],["choos",{"_index":24,"title":{},"description":{"0":{},"27":{}}}],["clarif",{"_index":1,"title":{"0":{}},"description":{}}],["clear",{"_index":355,"title":{"60":{}},"description":{}}],["client",{"_index":15,"title":{},"description":{"0":{},"4":{},"5":{}}}],["close",{"_index":73,"title":{},"description":{"1":{},"2":{},"4":{},"5":{}}}],["code",{"_index":19,"title":{"38":{}},"description":{"0":{},"38":{}}}],["collect",{"_index":94,"title":{"2":{},"7":{},"19":{},"20":{},"33":{},"34":{},"44":{}},"description":{"4":{},"5":{},"7":{},"9":{},"21":{},"44":{},"57":{},"60":{},"61":{}}}],["come",{"_index":348,"title":{},"description":{"57":{}}}],["command",{"_index":144,"title":{},"description":{"5":{},"7":{},"8":{},"27":{}}}],["commun",{"_index":57,"title":{},"description":{"0":{}}}],["config/azim_int",{"_index":207,"title":{},"description":{"23":{},"24":{}}}],["config/dark_mask",{"_index":263,"title":{},"description":{"33":{},"34":{}}}],["config/detector",{"_index":185,"title":{},"description":{"9":{},"10":{}}}],["config/file_writ",{"_index":190,"title":{},"description":{"13":{},"14":{}}}],["config/image_format",{"_index":197,"title":{},"description":{"17":{},"18":{}}}],["config/image_format/convers",{"_index":202,"title":{},"description":{"20":{}}}],["config/image_format/raw",{"_index":199,"title":{},"description":{"19":{}}}],["config/index",{"_index":189,"title":{},"description":{"11":{},"12":{}}}],["config/instru",{"_index":193,"title":{},"description":{"15":{},"16":{}}}],["config/internal_generator_imag",{"_index":220,"title":{},"description":{"25":{}}}],["config/internal_generator_image.tiff",{"_index":222,"title":{},"description":{"26":{}}}],["config/mask",{"_index":295,"title":{},"description":{"46":{}}}],["config/mask.tiff",{"_index":323,"title":{},"description":{"49":{}}}],["config/roi",{"_index":279,"title":{},"description":{"41":{},"42":{}}}],["config/select_detector",{"_index":233,"title":{},"description":{"27":{},"28":{}}}],["config/spot_find",{"_index":205,"title":{},"description":{"21":{},"22":{}}}],["config/user_mask",{"_index":299,"title":{},"description":{"47":{},"48":{}}}],["config/user_mask.tiff",{"_index":324,"title":{},"description":{"50":{},"51":{}}}],["config/zeromq_metadata",{"_index":255,"title":{},"description":{"31":{},"32":{}}}],["config/zeromq_preview",{"_index":252,"title":{},"description":{"29":{},"30":{}}}],["configur",{"_index":179,"title":{"9":{},"10":{},"12":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"33":{}},"description":{"28":{}}}],["connect",{"_index":141,"title":{},"description":{"4":{},"5":{}}}],["consist",{"_index":230,"title":{},"description":{"27":{}}}],["contain",{"_index":244,"title":{},"description":{"29":{},"31":{},"56":{},"57":{}}}],["control",{"_index":224,"title":{},"description":{"27":{}}}],["convers",{"_index":201,"title":{"20":{}},"description":{"48":{},"51":{}}}],["convert",{"_index":311,"title":{},"description":{"48":{},"51":{}}}],["coordin",{"_index":218,"title":{},"description":{"25":{},"26":{},"47":{},"48":{},"50":{},"51":{}}}],["copyleft",{"_index":7,"title":{},"description":{"0":{}}}],["cover",{"_index":254,"title":{},"description":{"31":{}}}],["cpu",{"_index":159,"title":{},"description":{"7":{}}}],["current",{"_index":96,"title":{"2":{},"37":{},"38":{}},"description":{"7":{}}}],["custom",{"_index":352,"title":{"58":{}},"description":{}}],["dark",{"_index":95,"title":{"2":{},"33":{},"34":{}},"description":{}}],["data",{"_index":64,"title":{"1":{},"7":{},"19":{},"20":{},"22":{},"33":{},"34":{},"37":{},"38":{},"44":{},"54":{}},"description":{"3":{},"4":{},"5":{},"7":{},"8":{},"21":{},"29":{},"31":{},"35":{},"44":{},"57":{},"60":{},"61":{}}}],["dataset",{"_index":343,"title":{},"description":{"56":{}}}],["deactiv",{"_index":172,"title":{},"description":{"8":{}}}],["dectri",{"_index":258,"title":{},"description":{"33":{}}}],["default",{"_index":109,"title":{},"description":{"3":{}}}],["definit",{"_index":3,"title":{"41":{},"42":{}},"description":{"0":{}}}],["depend",{"_index":219,"title":{},"description":{"25":{},"26":{}}}],["deriv",{"_index":47,"title":{},"description":{"0":{}}}],["detector",{"_index":63,"title":{"1":{},"2":{},"3":{},"6":{},"8":{},"9":{},"10":{},"27":{},"28":{},"40":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}},"description":{"1":{},"2":{},"3":{},"4":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"23":{},"25":{},"26":{},"27":{},"28":{},"33":{},"40":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}}}],["detector/statu",{"_index":277,"title":{},"description":{"40":{}}}],["develop",{"_index":37,"title":{},"description":{"0":{}}}],["devic",{"_index":265,"title":{"36":{}},"description":{}}],["distribut",{"_index":22,"title":{},"description":{"0":{}}}],["doesn't",{"_index":335,"title":{"54":{}},"description":{}}],["don't",{"_index":314,"title":{},"description":{"48":{},"51":{}}}],["done",{"_index":93,"title":{"5":{}},"description":{"1":{},"2":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"33":{}}}],["dure",{"_index":76,"title":{},"description":{"1":{},"9":{},"61":{}}}],["e.g",{"_index":344,"title":{},"description":{"56":{}}}],["each",{"_index":285,"title":{},"description":{"45":{}}}],["effect",{"_index":169,"title":{},"description":{"7":{},"9":{},"29":{}}}],["eiger",{"_index":261,"title":{},"description":{"33":{}}}],["ensur",{"_index":92,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{}}}],["error",{"_index":70,"title":{},"description":{"1":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"33":{}}}],["etc",{"_index":46,"title":{},"description":{"0":{}}}],["event",{"_index":273,"title":{"38":{}},"description":{"38":{}}}],["exampl",{"_index":300,"title":{},"description":{"48":{},"51":{}}}],["except",{"_index":25,"title":{},"description":{"0":{}}}],["execut",{"_index":83,"title":{},"description":{"1":{},"4":{},"5":{},"9":{}}}],["expect",{"_index":316,"title":{},"description":{"48":{},"51":{}}}],["experiment",{"_index":345,"title":{},"description":{"56":{}}}],["explicitli",{"_index":38,"title":{},"description":{"0":{}}}],["extend",{"_index":138,"title":{},"description":{"4":{},"5":{}}}],["extern",{"_index":127,"title":{},"description":{"4":{},"5":{}}}],["few",{"_index":85,"title":{},"description":{"1":{}}}],["file",{"_index":10,"title":{"13":{},"14":{}},"description":{"0":{}}}],["find",{"_index":204,"title":{"21":{}},"description":{"48":{},"51":{}}}],["finish",{"_index":143,"title":{},"description":{"5":{},"7":{}}}],["float",{"_index":334,"title":{"54":{}},"description":{}}],["format",{"_index":196,"title":{"17":{},"18":{},"19":{},"20":{},"52":{},"54":{},"56":{},"57":{},"58":{},"59":{}},"description":{}}],["fpga",{"_index":152,"title":{"25":{},"26":{},"36":{}},"description":{"7":{},"25":{},"26":{}}}],["fpga_statu",{"_index":266,"title":{},"description":{"36":{}}}],["frame",{"_index":156,"title":{},"description":{"7":{}}}],["full",{"_index":200,"title":{"20":{},"55":{}},"description":{"46":{},"49":{},"57":{}}}],["function",{"_index":88,"title":{},"description":{"1":{},"2":{}}}],["gap",{"_index":313,"title":{},"description":{"48":{},"51":{}}}],["gcc",{"_index":33,"title":{},"description":{"0":{}}}],["gener",{"_index":13,"title":{"25":{},"26":{},"43":{},"53":{},"54":{}},"description":{"0":{},"6":{},"25":{},"26":{},"29":{},"31":{}}}],["geometri",{"_index":346,"title":{},"description":{"56":{}}}],["given",{"_index":162,"title":{},"description":{"7":{}}}],["goe",{"_index":360,"title":{},"description":{"61":{}}}],["good",{"_index":298,"title":{},"description":{"47":{},"48":{},"50":{},"51":{}}}],["gpl",{"_index":6,"title":{},"description":{"0":{}}}],["gpl-3.0",{"_index":5,"title":{},"description":{"0":{}}}],["gracefulli",{"_index":165,"title":{},"description":{"7":{}}}],["happen",{"_index":211,"title":{},"description":{"25":{},"26":{}}}],["header",{"_index":32,"title":{},"description":{"0":{}}}],["here",{"_index":241,"title":{},"description":{"29":{},"31":{}}}],["high",{"_index":173,"title":{},"description":{"8":{}}}],["hour",{"_index":104,"title":{},"description":{"2":{}}}],["http",{"_index":247,"title":{},"description":{"29":{},"31":{}}}],["i.",{"_index":180,"title":{},"description":{"9":{},"51":{}}}],["id",{"_index":229,"title":{"37":{}},"description":{"27":{},"37":{}}}],["idl",{"_index":100,"title":{},"description":{"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"23":{},"25":{},"26":{},"33":{},"48":{},"49":{},"51":{}}}],["ignor",{"_index":248,"title":{},"description":{"29":{},"31":{},"48":{},"51":{}}}],["imag",{"_index":194,"title":{"17":{},"18":{},"25":{},"26":{},"39":{},"57":{},"58":{},"59":{},"60":{},"61":{}},"description":{"25":{},"26":{},"31":{},"37":{},"51":{},"57":{},"60":{},"61":{}}}],["image.cbor",{"_index":365,"title":{},"description":{"61":{}}}],["image_buffer/clear",{"_index":357,"title":{},"description":{"60":{}}}],["image_buffer/image.cbor",{"_index":350,"title":{},"description":{"57":{}}}],["image_buffer/image.jpeg",{"_index":353,"title":{},"description":{"58":{}}}],["image_buffer/image.tiff",{"_index":354,"title":{},"description":{"59":{}}}],["image_buffer/start.cbor",{"_index":347,"title":{},"description":{"56":{}}}],["image_buffer/statu",{"_index":366,"title":{},"description":{"61":{}}}],["image_pusher/statu",{"_index":276,"title":{},"description":{"39":{}}}],["immedi",{"_index":124,"title":{},"description":{"3":{}}}],["implement",{"_index":16,"title":{},"description":{"0":{}}}],["impos",{"_index":54,"title":{},"description":{"0":{}}}],["inact",{"_index":69,"title":{},"description":{"1":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"23":{},"27":{},"33":{}}}],["includ",{"_index":358,"title":{},"description":{"61":{}}}],["indefinit",{"_index":133,"title":{},"description":{"4":{},"5":{}}}],["index",{"_index":187,"title":{"11":{},"12":{}},"description":{}}],["inform",{"_index":151,"title":{"54":{}},"description":{"7":{}}}],["initi",{"_index":62,"title":{"1":{},"47":{},"50":{}},"description":{"1":{},"5":{},"46":{}}}],["instead",{"_index":80,"title":{},"description":{"1":{}}}],["instrument",{"_index":191,"title":{"15":{},"16":{}},"description":{}}],["integ",{"_index":214,"title":{},"description":{"25":{},"26":{},"51":{}}}],["integr",{"_index":106,"title":{"23":{},"24":{},"54":{}},"description":{"2":{},"48":{},"51":{}}}],["intend",{"_index":49,"title":{},"description":{"0":{}}}],["interact",{"_index":18,"title":{},"description":{"0":{}}}],["interfac",{"_index":43,"title":{},"description":{"0":{},"1":{}}}],["intern",{"_index":210,"title":{"25":{},"26":{}},"description":{"25":{},"26":{}}}],["ioctl",{"_index":45,"title":{},"description":{"0":{}}}],["jfjoch_brok",{"_index":368,"title":{"62":{}},"description":{}}],["jpeg",{"_index":351,"title":{"58":{}},"description":{}}],["jungfrau",{"_index":99,"title":{},"description":{"2":{},"40":{}}}],["jungfraujoch",{"_index":130,"title":{"35":{},"53":{},"54":{},"62":{}},"description":{"4":{},"27":{},"29":{},"31":{},"60":{},"61":{}}}],["kernel",{"_index":36,"title":{},"description":{"0":{}}}],["kernel'",{"_index":29,"title":{},"description":{"0":{}}}],["last",{"_index":283,"title":{},"description":{"44":{},"60":{}}}],["latest",{"_index":349,"title":{},"description":{"57":{}}}],["latter",{"_index":312,"title":{},"description":{"48":{},"51":{}}}],["librari",{"_index":35,"title":{},"description":{"0":{}}}],["licens",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["limit",{"_index":338,"title":{"54":{}},"description":{}}],["linux",{"_index":28,"title":{},"description":{"0":{}}}],["list",{"_index":228,"title":{"28":{}},"description":{"27":{}}}],["load",{"_index":208,"title":{"25":{},"26":{}},"description":{"25":{},"26":{}}}],["long",{"_index":105,"title":{},"description":{"2":{}}}],["make",{"_index":163,"title":{},"description":{"7":{}}}],["mask",{"_index":257,"title":{"33":{},"34":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}},"description":{"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}}}],["mean",{"_index":293,"title":{},"description":{"46":{},"49":{}}}],["mechan",{"_index":61,"title":{},"description":{"0":{}}}],["mere",{"_index":42,"title":{},"description":{"0":{}}}],["messag",{"_index":237,"title":{"56":{},"57":{}},"description":{"29":{},"31":{}}}],["metadata",{"_index":192,"title":{"15":{},"16":{},"31":{},"32":{}},"description":{"31":{},"56":{},"57":{}}}],["minut",{"_index":86,"title":{},"description":{"1":{}}}],["misbehav",{"_index":304,"title":{},"description":{"48":{},"51":{}}}],["mode",{"_index":306,"title":{},"description":{"48":{},"51":{}}}],["modul",{"_index":310,"title":{},"description":{"48":{},"51":{}}}],["module/storag",{"_index":286,"title":{},"description":{"45":{}}}],["moment",{"_index":259,"title":{},"description":{"33":{}}}],["more",{"_index":361,"title":{},"description":{"61":{}}}],["multipl",{"_index":225,"title":{},"description":{"27":{}}}],["need",{"_index":90,"title":{},"description":{"1":{},"2":{},"3":{},"48":{},"51":{}}}],["network",{"_index":59,"title":{},"description":{"0":{},"1":{},"7":{}}}],["new",{"_index":183,"title":{},"description":{"9":{}}}],["number",{"_index":215,"title":{},"description":{"25":{},"26":{}}}],["nxmx",{"_index":291,"title":{},"description":{"46":{},"48":{},"49":{},"51":{}}}],["on",{"_index":89,"title":{},"description":{"1":{},"2":{},"3":{},"9":{},"27":{}}}],["onc",{"_index":102,"title":{},"description":{"2":{}}}],["openapi",{"_index":14,"title":{},"description":{"0":{}}}],["oper",{"_index":74,"title":{},"description":{"1":{},"2":{},"9":{},"33":{},"61":{}}}],["option",{"_index":250,"title":{},"description":{"29":{}}}],["output",{"_index":195,"title":{"17":{},"18":{}},"description":{}}],["pedest",{"_index":79,"title":{"52":{}},"description":{"1":{},"2":{},"5":{},"7":{},"9":{}}}],["per",{"_index":103,"title":{},"description":{"2":{}}}],["period",{"_index":134,"title":{},"description":{"4":{},"5":{}}}],["pixel",{"_index":289,"title":{},"description":{"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}}}],["plot",{"_index":332,"title":{"53":{},"54":{}},"description":{}}],["point",{"_index":262,"title":{},"description":{"33":{}}}],["possibl",{"_index":139,"title":{},"description":{"4":{},"5":{},"33":{}}}],["post",{"_index":78,"title":{},"description":{"1":{},"2":{}}}],["power",{"_index":178,"title":{},"description":{"8":{}}}],["prepar",{"_index":170,"title":{"8":{}},"description":{}}],["preview",{"_index":236,"title":{"29":{},"30":{},"58":{},"59":{}},"description":{"29":{}}}],["preview/pedestal.tiff",{"_index":330,"title":{},"description":{"52":{}}}],["preview/plot",{"_index":333,"title":{},"description":{"53":{}}}],["preview/plot.bin",{"_index":339,"title":{},"description":{"54":{}}}],["procedur",{"_index":135,"title":{},"description":{"4":{},"5":{},"9":{}}}],["process",{"_index":158,"title":{"22":{}},"description":{"7":{}}}],["program",{"_index":41,"title":{},"description":{"0":{}}}],["provid",{"_index":136,"title":{"54":{}},"description":{"4":{},"5":{},"27":{},"45":{}}}],["provis",{"_index":8,"title":{},"description":{"0":{}}}],["psi",{"_index":260,"title":{},"description":{"33":{}}}],["pub",{"_index":253,"title":{},"description":{"31":{}}}],["puls",{"_index":268,"title":{"37":{}},"description":{"37":{}}}],["pusher",{"_index":275,"title":{"39":{}},"description":{}}],["put",{"_index":249,"title":{},"description":{"29":{},"31":{}}}],["raw",{"_index":198,"title":{"19":{},"54":{}},"description":{"48":{},"51":{}}}],["raw/convert",{"_index":217,"title":{},"description":{"25":{},"26":{}}}],["readi",{"_index":113,"title":{},"description":{"3":{},"4":{}}}],["recommend",{"_index":77,"title":{},"description":{"1":{},"2":{}}}],["reconfigur",{"_index":75,"title":{},"description":{"1":{}}}],["record",{"_index":271,"title":{},"description":{"37":{}}}],["regardless",{"_index":55,"title":{},"description":{"0":{}}}],["region",{"_index":305,"title":{},"description":{"48":{},"51":{}}}],["region-of-interest",{"_index":227,"title":{},"description":{"27":{}}}],["reiniti",{"_index":232,"title":{},"description":{"27":{}}}],["replac",{"_index":363,"title":{},"description":{"61":{}}}],["request",{"_index":121,"title":{},"description":{"3":{},"29":{},"31":{}}}],["requir",{"_index":21,"title":{},"description":{"0":{},"4":{},"5":{},"25":{},"26":{},"27":{}}}],["respons",{"_index":231,"title":{},"description":{"27":{}}}],["result",{"_index":282,"title":{"55":{}},"description":{"44":{}}}],["result/scan",{"_index":341,"title":{},"description":{"55":{}}}],["retri",{"_index":142,"title":{},"description":{"4":{},"5":{}}}],["return",{"_index":123,"title":{"37":{},"38":{}},"description":{"3":{},"37":{},"38":{}}}],["roi",{"_index":278,"title":{"41":{},"42":{}},"description":{}}],["run",{"_index":101,"title":{"4":{},"7":{}},"description":{"2":{},"3":{},"5":{},"7":{},"21":{},"60":{},"61":{}}}],["runtim",{"_index":34,"title":{},"description":{"0":{}}}],["safeti",{"_index":140,"title":{},"description":{"4":{},"5":{}}}],["save",{"_index":184,"title":{},"description":{"9":{}}}],["scan",{"_index":340,"title":{"55":{}},"description":{}}],["script",{"_index":128,"title":{},"description":{"4":{},"5":{}}}],["see",{"_index":290,"title":{},"description":{"46":{},"49":{}}}],["select",{"_index":223,"title":{"27":{}},"description":{"28":{}}}],["send",{"_index":149,"title":{"6":{},"54":{}},"description":{}}],["sent",{"_index":160,"title":{},"description":{"7":{}}}],["separ",{"_index":287,"title":{},"description":{"45":{}}}],["server",{"_index":132,"title":{},"description":{"4":{},"5":{}}}],["set",{"_index":118,"title":{"11":{},"13":{},"14":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"58":{}},"description":{"3":{},"9":{},"25":{},"26":{},"27":{},"29":{},"31":{}}}],["shadow",{"_index":303,"title":{},"description":{"48":{},"51":{}}}],["shutter",{"_index":72,"title":{},"description":{"1":{},"2":{}}}],["sign",{"_index":328,"title":{},"description":{"51":{}}}],["similar",{"_index":26,"title":{},"description":{"0":{}}}],["single-channel",{"_index":325,"title":{},"description":{"51":{}}}],["size",{"_index":216,"title":{},"description":{"25":{},"26":{}}}],["slot",{"_index":362,"title":{},"description":{"61":{}}}],["socket",{"_index":240,"title":{"32":{}},"description":{"29":{},"31":{}}}],["socket_address",{"_index":245,"title":{},"description":{"29":{},"31":{}}}],["soft",{"_index":150,"title":{"6":{}},"description":{"6":{}}}],["soft/ttl",{"_index":115,"title":{},"description":{"3":{}}}],["softwar",{"_index":148,"title":{},"description":{"5":{}}}],["sole",{"_index":12,"title":{},"description":{"0":{}}}],["specif",{"_index":52,"title":{},"description":{"0":{}}}],["spirit",{"_index":27,"title":{},"description":{"0":{}}}],["spot",{"_index":203,"title":{"21":{}},"description":{"48":{},"51":{}}}],["stack",{"_index":309,"title":{},"description":{"48":{},"51":{}}}],["stage",{"_index":155,"title":{},"description":{"7":{},"61":{}}}],["standard",{"_index":292,"title":{},"description":{"46":{},"49":{}}}],["start",{"_index":108,"title":{"3":{},"56":{}},"description":{"3":{}}}],["state",{"_index":39,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"25":{},"26":{},"27":{},"33":{},"48":{},"49":{},"51":{}}}],["statist",{"_index":281,"title":{"43":{},"44":{},"45":{}},"description":{"43":{},"45":{}}}],["statistics/calibr",{"_index":288,"title":{},"description":{"45":{}}}],["statistics/data_collect",{"_index":284,"title":{},"description":{"44":{}}}],["statu",{"_index":264,"title":{"35":{},"36":{},"39":{},"40":{},"61":{}},"description":{"35":{},"40":{},"61":{}}}],["stop",{"_index":154,"title":{},"description":{"7":{},"48":{},"51":{}}}],["storag",{"_index":81,"title":{},"description":{"1":{}}}],["store",{"_index":319,"title":{},"description":{"48":{},"51":{}}}],["stream",{"_index":238,"title":{},"description":{"29":{},"31":{}}}],["structur",{"_index":243,"title":{},"description":{"29":{},"31":{}}}],["sub",{"_index":239,"title":{},"description":{"29":{}}}],["subject",{"_index":20,"title":{},"description":{"0":{}}}],["sure",{"_index":164,"title":{},"description":{"7":{}}}],["switch",{"_index":167,"title":{},"description":{"7":{}}}],["synchron",{"_index":147,"title":{},"description":{"5":{}}}],["syscal",{"_index":44,"title":{},"description":{"0":{}}}],["take",{"_index":166,"title":{},"description":{"7":{}}}],["term",{"_index":23,"title":{},"description":{"0":{}}}],["through",{"_index":58,"title":{},"description":{"0":{}}}],["tiff",{"_index":221,"title":{"26":{},"49":{},"50":{},"52":{},"59":{}},"description":{"26":{},"51":{}}}],["till",{"_index":129,"title":{},"description":{"4":{},"5":{}}}],["time",{"_index":84,"title":{},"description":{"1":{},"2":{},"4":{},"5":{},"7":{}}}],["timeout",{"_index":137,"title":{},"description":{"4":{},"5":{}}}],["transmit",{"_index":336,"title":{"54":{}},"description":{}}],["trigger",{"_index":116,"title":{"6":{}},"description":{"3":{},"6":{}}}],["true",{"_index":120,"title":{},"description":{"3":{}}}],["turn",{"_index":171,"title":{"8":{}},"description":{"8":{},"60":{}}}],["two",{"_index":66,"title":{},"description":{"1":{}}}],["under",{"_index":4,"title":{},"description":{"0":{}}}],["unsign",{"_index":318,"title":{},"description":{"48":{},"51":{}}}],["until",{"_index":112,"title":{},"description":{"3":{}}}],["updat",{"_index":97,"title":{},"description":{"2":{}}}],["upload",{"_index":280,"title":{"42":{},"48":{},"51":{}},"description":{"48":{},"51":{}}}],["us",{"_index":11,"title":{"54":{},"58":{}},"description":{"0":{},"1":{},"2":{},"3":{},"8":{},"28":{},"48":{},"51":{}}}],["user",{"_index":40,"title":{"47":{},"48":{},"50":{},"51":{}},"description":{"0":{},"47":{},"48":{},"50":{},"51":{}}}],["userspac",{"_index":31,"title":{},"description":{"0":{}}}],["valid",{"_index":329,"title":{},"description":{"51":{}}}],["valu",{"_index":294,"title":{"54":{}},"description":{"46":{},"48":{},"49":{},"51":{}}}],["version",{"_index":367,"title":{"62":{}},"description":{"62":{}}}],["via",{"_index":246,"title":{},"description":{"29":{},"31":{}}}],["volatil",{"_index":359,"title":{},"description":{"61":{}}}],["voltag",{"_index":174,"title":{},"description":{"8":{}}}],["wait",{"_index":126,"title":{"4":{},"5":{}},"description":{}}],["wait_till_don",{"_index":91,"title":{},"description":{"1":{},"2":{},"5":{}}}],["wait_until_run",{"_index":125,"title":{},"description":{"3":{},"4":{}}}],["web",{"_index":131,"title":{},"description":{"4":{},"5":{}}}],["well",{"_index":322,"title":{},"description":{"48":{},"51":{}}}],["whether",{"_index":56,"title":{},"description":{"0":{}}}],["wider",{"_index":51,"title":{},"description":{"0":{}}}],["without",{"_index":53,"title":{},"description":{"0":{}}}],["work",{"_index":48,"title":{},"description":{"0":{}}}],["writer",{"_index":161,"title":{"13":{},"14":{}},"description":{"7":{}}}],["x-axi",{"_index":337,"title":{"54":{}},"description":{}}],["x-ray",{"_index":71,"title":{},"description":{"1":{},"2":{},"9":{}}}],["xfel",{"_index":267,"title":{"37":{},"38":{}},"description":{"37":{},"38":{}}}],["xfel/event_cod",{"_index":274,"title":{},"description":{"38":{}}}],["xfel/pulse_id",{"_index":272,"title":{},"description":{"37":{}}}],["zeromq",{"_index":235,"title":{"29":{},"30":{},"31":{},"32":{}},"description":{"29":{},"31":{}}}]],"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.154","contact":{"name":"Filip Leonarski (Paul Scherrer Institute)","email":"filip.leonarski@psi.ch"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.html"}},"servers":[{"url":"http://localhost:5232","description":"Test Jungfraujoch system"}],"components":{"parameters":{"binning":{"in":"query","name":"binning","required":false,"schema":{"default":1,"type":"integer"},"description":"Binning of frames for the plot (0 = default binning)"},"experimental_coord":{"in":"query","name":"experimental_coord","required":false,"schema":{"type":"boolean","default":false},"description":"If measurement has goniometer axis defined, plot X-axis will represent rotation angle\nIf measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value\nFor still measurement the number is ignored\n"},"azint_unit":{"in":"query","name":"azint_unit","required":false,"schema":{"type":"string","enum":["Q_recipA","d_A","two_theta_deg"],"default":"Q_recipA"},"description":"Unit used for azim int.\n"},"fill_value":{"in":"query","name":"fill","required":false,"schema":{"type":"number","format":"float"},"description":"Fill value for elements that were missed during data collection\n"},"plot_type":{"in":"query","name":"type","required":true,"description":"Type of requested plot","schema":{"type":"string","enum":["bkg_estimate","azint","azint_1d","spot_count","spot_count_low_res","spot_count_indexed","spot_count_ice","indexing_rate","indexing_lattice_count","indexing_unit_cell_length","indexing_unit_cell_angle","profile_radius","mosaicity","b_factor","error_pixels","saturated_pixels","image_collection_efficiency","receiver_delay","receiver_free_send_buf","strong_pixels","roi_sum","roi_mean","roi_max_count","roi_pixels","roi_weighted_x","roi_weighted_y","packets_received","max_pixel_value","resolution_estimate","pixel_sum","processing_time","beam_center_x","beam_center_y","integrated_reflections","image_scale_factor","image_scale_cc","image_scale_b","compression_ratio"]}},"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","schema":{"type":"string","enum":["indigo","viridis","bw","wb","green","heat","magma","inferno"],"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 least-square diffraction geometry refinement algorithm used by Jungfraujoch.\nBeamCenter - This option is refining both beam center and lattice (restricted to a chosen/detected Bravais lattice).\nOrientationOnly - This option is refining only orientation of the lattice.\n","enum":["BeamCenter","OrientationOnly","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/user of the HDF5 file. \nThis applies solely to string and number (double floating-point). No arrays/sub-objects is allowed.\nFor example {\"hdf5\": {\"val1\":1, \"val2\":\"xyz\"}}, will write /entry/user/val1 and /entry/user/val2.\n"},"image_appendix":{"description":"Image appendix, added as user_data to image ZeroMQ message (can be any valid JSON)\nNot saved in HDF5 file\n"},"data_reduction_factor_serialmx":{"type":"number","format":"float","default":1,"minimum":0,"maximum":1,"description":"Rate at which non-indexed images are accepted to be forwarded to writer. \nValue of 1.0 (default) means that all images are written.\nValues below zero mean that non-indexed images will be accepted with a given probability.\n"},"pixel_value_low_threshold":{"type":"integer","format":"int64","minimum":0,"description":"Set all counts lower than the value to zero. \nWhen the value is set, negative numbers other than error pixel value are always set to zero.\nSetting to zero is equivalent to turning the option off.\n"},"run_number":{"type":"integer","format":"int64","minimum":0,"description":"Number of run within an experimental session. \nTransferred over CBOR stream as \"series ID\", though not saved in HDF5 file.\nIt is highly recommended to keep this number unique for each data collection during experimental series.\nIf not provided, the number will be automatically incremented.\n"},"run_name":{"type":"string","description":"Unique ID of run.\nTransferred over CBOR stream as \"unique series ID\", though not saved in HDF5 file.\nIt is highly recommended to keep this name unique for each data collection during experimental series.\nIf not provided, the name will be automatically generated as number + colon + file_prefix.\n"},"experiment_group":{"type":"string","description":"Name of group owning the data (e.g. p-group or proposal number). \nTransferred over CBOR stream, though not saved in HDF5 file.\n"},"poisson_compression":{"type":"integer","format":"int64","minimum":0,"maximum":16,"description":"Enable lossy compression of pixel values that preserves Poisson statistics. \nRequires to provide a numerical factor SQ.\nPixel value P will be transformed to round(sqrt(P) * SQ), with rounding to the closest integer.\nCompression is turned off if the value is missing or it is set to zero.\n"},"write_nxmx_hdf5_master":{"type":"boolean","default":true,"description":"Write NXmx formatted HDF5 master file. Recommended to use for macromolecular crystallography experiments\nand to turn off for other experiments.\n"},"save_calibration":{"type":"boolean","description":"Forward image calibration (at the moment pedestal and pedestal RMS for JUNGFRAU) using the ZeroMQ stream to writer.\nIf parameter is not provided calibration will be saved only if more than 4 images are recorded.\n"},"polarization_factor":{"type":"number","description":"Polarization factor for integration; 1.0 is horizontal polarization; -1.0 is vertical polarization","format":"float","minimum":-1,"maximum":1},"ring_current_mA":{"type":"number","format":"float","description":"Ring current at the beginning of the data collection","minimum":0},"sample_temperature_K":{"type":"number","format":"float","description":"Sample temperature in Kelvin","minimum":0},"poni_rot1_rad":{"type":"number","description":"PONI angle rot1 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"poni_rot2_rad":{"type":"number","description":"PONI angle rot2 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"poni_rot3_rad":{"type":"number","description":"PONI angle rot3 (see PyFAI documentation for details) in radians","format":"float","minimum":-6.28318530718,"maximum":6.28318530718,"default":0},"unit_cell":{"$ref":"#/components/schemas/unit_cell"},"spot_finding":{"type":"boolean","description":"Enable spot finding and save spots","default":true},"max_spot_count":{"type":"integer","minimum":10,"maximum":2000,"default":250,"description":"Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected"},"detect_ice_rings":{"type":"boolean","description":"Flag spots as ice rings and reduce their effect on indexing"},"async_start":{"type":"boolean","default":false,"description":"When set to true, `/start` will not wait for detector and Jungfraujoch to be ready for the measurement."},"xray_fluorescence_spectrum":{"type":"object","required":["energy_eV","data"],"properties":{"energy_eV":{"type":"array","items":{"type":"number","format":"float"},"description":"X-ray fluorescence scan energy for each measurement point"},"data":{"type":"array","items":{"type":"number","format":"float"},"description":"X-ray fluorescence scan result in arbitrary units; must be exactly the same length, as energy_eV"}}}}},"crystal_lattice":{"type":"array","items":{"type":"number","format":"float"},"minItems":9,"maxItems":9,"description":"Real-space crystal lattice 3D vectors in Angstrom.\nOrder is 1st vector (x,y,z), 2nd vector (x,y,z) and 3rd vector (x,y,z)\n"},"unit_cell":{"type":"object","description":"Unit cell parameters. Necessary to run indexing. Units of angstrom and degree","required":["a","b","c","alpha","beta","gamma"],"properties":{"a":{"type":"number","format":"float","example":37,"minimum":0},"b":{"type":"number","format":"float","example":37,"minimum":0},"c":{"type":"number","format":"float","example":78,"minimum":0},"alpha":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360},"beta":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360},"gamma":{"type":"number","format":"float","example":90,"minimum":0,"maximum":360}}},"file_writer_format":{"type":"string","enum":["NXmxOnlyData","NXmxLegacy","NXmxVDS","NXmxIntegrated","CBF","TIFF","NoFileWritten"],"default":"NXmxLegacy","description":"NoFileWritten - no files are written at all\nNXmxOnlyData - only data files are written, no master file\nNXmxLegacy - legacy format with soft links to data files in the master file; necessary for DECTRIS Albula 4.0 and DECTRIS Neggia  \nNXmxVDS - newer format with virtual dataset linking data files in the master file, also includes better metadata handling\nNXmxIntegrated - single HDF5 per dataset\nCBF - CBF format (limited metadata)\nTIFF - TIFF format (no metadata)\n"},"file_writer_settings":{"type":"object","properties":{"overwrite":{"type":"boolean","default":false,"description":"Inform jfjoch_write to overwrite existing files. Otherwise files would be saved with .h5.{timestamp}.tmp suffix.\n"},"format":{"$ref":"#/components/schemas/file_writer_format"}}},"pixel_mask_statistics":{"type":"object","properties":{"user_mask":{"description":"Number of pixels masked using the user mask","type":"integer","format":"int64","minimum":0},"too_high_pedestal_rms":{"description":"Number of pixels with G0 pedestal RMS higher than provided threshold","type":"integer","format":"int64","minimum":0},"wrong_gain":{"description":"Number of pixels that show wrong gain level during the pedestal procedure","type":"integer","format":"int64","minimum":0}}},"image_buffer_status":{"type":"object","required":["image_numbers","total_slots","in_preparation_slots","in_sending_slots","available_slots","max_image_number","min_image_number"],"properties":{"min_image_number":{"type":"integer","format":"int64","minimum":0,"description":"Smallest image number available in the buffer"},"max_image_number":{"type":"integer","format":"int64","minimum":0,"description":"Largest image number available in the buffer"},"image_numbers":{"type":"array","description":"Image numbers currently present in the buffer.","items":{"type":"integer","format":"int64"}},"total_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer. This number, compared to number of images in data collection and\nframe rate will determine \"retention\" rate of the image buffer.\n"},"available_slots":{"type":"integer","format":"int64","description":"Slots available for the data collection"},"in_preparation_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer that are currently in preparation for sending.\n"},"in_sending_slots":{"type":"integer","format":"int64","description":"Number of slots in the image buffer that are currently sending/writing data.\n"},"current_counter":{"type":"integer","format":"int64","description":"Counter of changes in the image buffer - either new start message or new image added.\nFor optimization one can only load new images/datasets from the HTTP if this value changes.\nCounter is optional as it was not implemented in older versions to avoid breaking change\n"}}},"image_format_settings":{"type":"object","required":["summation","jungfrau_conversion","geometry_transform","mask_chip_edges","mask_module_edges","apply_mask"],"properties":{"summation":{"type":"boolean","description":"Enable summation of images to a given image_time\nIf disabled images are saved according to original detector speed, but image count is adjusted\n"},"geometry_transform":{"type":"boolean","description":"Place module read-out into their location on composed detector and extend multipixels\n"},"jungfrau_conversion":{"type":"boolean","description":"Convert pixel value in ADU to photon counts/energy\nOnly affects JUNGFRAU detector\n"},"jungfrau_conversion_factor_keV":{"type":"number","format":"float","minimum":0.001,"maximum":500,"description":"Used to convert energy deposited into pixel to counts\nIf not provided incident_energy_keV is used\n"},"bit_depth_image":{"type":"integer","format":"int64","enum":[8,16,32],"description":"Bit depth of resulting image (it doesn't affect the detector read-out value)\nIf not provided value is adjusted automatically\n"},"signed_output":{"type":"boolean","description":"Controls if pixels have signed output\nIf not provided value is adjusted automatically\n"},"mask_module_edges":{"type":"boolean","default":true,"description":"Mask 1 pixel on the module boundary\n"},"mask_chip_edges":{"type":"boolean","default":true,"description":"Mask multipixels on chip boundary\n"},"jungfrau_mask_pixels_without_g0":{"type":"boolean","default":true,"description":"JUNGFRAU: mask pixels that don't operate in G0, but do operate in G1 and G1.\nThis should be turned off for cases, where detector is operated at room temperature with long exposure time.\n"},"apply_mask":{"type":"boolean","default":false,"description":"Masked pixels are set to special value in the images produced by Jungfraujoch\n"},"jungfrau_pedestal_g0_rms_limit":{"type":"integer","format":"int64","default":100,"minimum":0,"description":"Pixels with pedestal G0 RMS above the threshold are marked as masked pixels"}}},"detector_power_state":{"type":"string","description":"Power on of ASICs","enum":["PowerOn","PowerOff","Partial"]},"detector_state":{"type":"string","description":"Current state of the detector","enum":["Idle","Waiting","Busy","Error","Not connected"]},"detector_status":{"type":"object","required":["state","powerchip","server_version","number_of_triggers_left","fpga_temp_degC","high_voltage_V"],"properties":{"state":{"$ref":"#/components/schemas/detector_state"},"powerchip":{"$ref":"#/components/schemas/detector_power_state"},"server_version":{"type":"string","description":"Detector server (on read-out boards) version"},"number_of_triggers_left":{"type":"integer","format":"int64","description":"Remaining triggers to the detector (max of all modules)"},"fpga_temp_degC":{"type":"array","description":"Temperature of detector FPGAs","items":{"type":"integer","format":"int64"}},"high_voltage_V":{"type":"array","description":"High voltage for detector modules","items":{"type":"integer","format":"int64"}}}},"detector_timing":{"type":"string","enum":["auto","trigger","burst","gated"],"default":"trigger"},"detector_settings":{"type":"object","required":["frame_time_us"],"properties":{"frame_time_us":{"type":"integer","description":"Interval between consecutive frames.\nThis is internal frame time for the JUNGFRAU detector, image time has to be integer multiply of this number.\nFor EIGER detector this is default frame time, not used otherwise\n","format":"int64","minimum":1},"count_time_us":{"type":"integer","description":"Integration time of the detector. \nIf not provided count time will be set to maximum value for a given frame time.\n","format":"int64"},"internal_frame_generator":{"type":"boolean","default":false,"description":"Use internal frame generator in FPGA instead of getting data from a real detector"},"internal_frame_generator_images":{"type":"integer","format":"int64","default":1,"minimum":1,"maximum":64,"description":"Number of images stored in the internal frame generator."},"detector_trigger_delay_ns":{"type":"integer","format":"int64","minimum":0,"default":0,"description":"Delay between TTL trigger and acquisition start [ns]"},"timing":{"$ref":"#/components/schemas/detector_timing"},"eiger_threshold_keV":{"type":"number","format":"float","minimum":1,"maximum":100,"description":"Threshold for the PSI EIGER detector and all DECTRIS detectors.\nIf value is provided, it will be used for all subsequent acquisitions, irrespective of beam energy.\nIf value is not provided, threshold will be determined on start of acquisition as half of incident energy. \nThis might lead to increased start time.\n"},"eiger_bit_depth":{"type":"integer","format":"int64","enum":[8,16,32],"description":"Bit depth of PSI EIGER read-out. This is  \nIf value is not provided, depth will be determined based on the image time:\n* Exposure time < 500 microseconds depth of 8 bit will be used,\n* 500 <= exposure time < 2622 microseconds depth of 16 bit will be used\n* Exposure time >= 2622 microseconds depth of 32 bit will be used.\n"},"jungfrau_pedestal_g0_frames":{"type":"integer","format":"int64","default":2000,"minimum":0},"jungfrau_pedestal_g1_frames":{"type":"integer","format":"int64","default":300,"minimum":0},"jungfrau_pedestal_g2_frames":{"type":"integer","format":"int64","default":300,"minimum":0},"jungfrau_pedestal_min_image_count":{"type":"integer","format":"int64","default":128,"minimum":32,"description":"Minimum number of collected images for pedestal to consider it viable"},"jungfrau_storage_cell_count":{"type":"integer","format":"int64","default":1,"minimum":1,"maximum":16},"jungfrau_storage_cell_delay_ns":{"type":"integer","format":"int64","minimum":2100,"default":5000,"description":"Delay between two storage cells [ns]"},"jungfrau_fixed_gain_g1":{"type":"boolean","default":false,"description":"Fix gain to G1 (can be useful for storage cells)"},"jungfrau_use_gain_hg0":{"type":"boolean","default":false,"description":"Use high G0 (for low energy applications)"}}},"spot_finding_settings":{"type":"object","required":["enable","indexing","signal_to_noise_threshold","photon_count_threshold","max_pix_per_spot","min_pix_per_spot","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","minimum":0.00002,"maximum":10,"format":"float"},"low_q_recipA":{"type":"number","format":"float","minimum":0.00001,"maximum":10},"q_spacing":{"type":"number","format":"float","minimum":0.00001},"azimuthal_bins":{"type":"integer","format":"int64","minimum":1,"maximum":512,"default":1,"description":"Numer of azimuthal (phi) bins; 1 = standard 1D azimuthal integration"},"force_cpu":{"type":"boolean","default":false,"description":"Force CPU processing of azimuthal integration in the FPGA data acquisition workflow.\nThis allows to extend number of azimuthal integration bins, as well as to calculate standard deviation\nof the azimuthal integration results.\n"}}},"detector_list_element":{"type":"object","required":["id","nmodules","description","width","height","serial_number","base_ipv4_addr","udp_interface_count","readout_time_ns","min_frame_time_ns","min_count_time_ns"],"properties":{"id":{"type":"integer","format":"int64","minimum":0},"description":{"type":"string","example":"JUNGFRAU 4 Mpixel"},"serial_number":{"type":"string","example":"JF17T16V01"},"base_ipv4_addr":{"type":"string","example":"10.10.10.1"},"udp_interface_count":{"type":"integer","format":"int64","example":2,"description":"Number of UDP interfaces per detector module"},"nmodules":{"type":"integer","format":"int64","example":18},"width":{"type":"integer","format":"int64","example":2068},"height":{"type":"integer","format":"int64","example":2164},"pixel_size_mm":{"type":"number","format":"float","example":0.075},"readout_time_ns":{"type":"integer","format":"int64"},"min_frame_time_ns":{"type":"integer","format":"int64"},"min_count_time_ns":{"type":"integer","format":"int64"},"type":{"$ref":"#/components/schemas/detector_type"}}},"detector_list":{"type":"object","required":["detectors","current_id"],"properties":{"detectors":{"type":"array","items":{"$ref":"#/components/schemas/detector_list_element"}},"current_id":{"type":"integer","format":"int64","example":0}}},"detector_selection":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","example":1}}},"measurement_statistics":{"type":"object","properties":{"file_prefix":{"type":"string"},"run_number":{"type":"integer","format":"int64","description":"Number of data collection run. This can be either automatically incremented or provided externally for each data collection.\n"},"experiment_group":{"type":"string","description":"Name of group owning the data (e.g. p-group or proposal number).\n"},"images_expected":{"type":"integer","format":"int64"},"images_collected":{"type":"integer","format":"int64","description":"Images collected by the receiver. This number will be lower than images expected if there were issues with data collection performance.\n"},"images_sent":{"type":"integer","format":"int64","description":"Images sent to the writer. \nThe value does not include images discarded by lossy compression filter and images not forwarded due to full ZeroMQ queue.\n"},"images_written":{"type":"integer","format":"int64","description":"Images successfully written to disk.\nThe value is live updated for TCP/IP socket and direct HDF5 writer, while for ZeroMQ it is only updated at the end of experiment.\n"},"images_discarded_lossy_compression":{"type":"integer","format":"int64","description":"Images discarded by the lossy compression filter"},"max_image_number_sent":{"type":"integer","format":"int64"},"collection_efficiency":{"type":"number","format":"float","example":1,"minimum":0,"maximum":1},"compression_ratio":{"type":"number","format":"float","example":5.3,"minimum":0},"cancelled":{"type":"boolean"},"max_receiver_delay":{"type":"integer","format":"int64"},"indexing_rate":{"type":"number","format":"float"},"detector_width":{"type":"integer","format":"int64"},"detector_height":{"type":"integer","format":"int64"},"detector_pixel_depth":{"type":"integer","format":"int64","enum":[2,4]},"bkg_estimate":{"type":"number","format":"float"},"unit_cell":{"type":"string"},"error_pixels":{"type":"number","format":"float","description":"Moving average of 1000 images counting number of error pixels on the detector"},"saturated_pixels":{"type":"number","format":"float","description":"Moving average of 1000 images counting number of saturated pixels on the detector"},"roi_beam_pixels":{"type":"number","format":"float","description":"If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images\nfor number of valid pixels within this ROI\n"},"roi_beam_sum":{"type":"number","format":"float","description":"If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images\nfor sum of valid pixels within this ROI\n"}}},"fpga_status":{"type":"array","items":{"type":"object","required":["pci_dev_id","serial_number","base_mac_addr","eth_link_status","eth_link_count","eth_link_speed","power_usage_W","fpga_temp_C","hbm_temp_C","packets_sls","packets_udp","idle","fw_version","pcie_link_speed","pcie_link_width"],"properties":{"pci_dev_id":{"type":"string"},"serial_number":{"type":"string"},"fw_version":{"type":"string"},"base_mac_addr":{"type":"string"},"eth_link_count":{"type":"integer","format":"int64"},"eth_link_status":{"type":"integer","format":"int64"},"power_usage_W":{"type":"number","format":"float"},"fpga_temp_C":{"type":"number","format":"float"},"hbm_temp_C":{"type":"number","format":"float"},"packets_udp":{"type":"integer","format":"int64"},"packets_sls":{"type":"integer","format":"int64"},"idle":{"type":"boolean"},"pcie_link_speed":{"type":"integer","format":"int64","description":"PCIe link speed measured by generation (expected value is 4 == PCIe Gen4)"},"pcie_link_width":{"type":"integer","format":"int64","description":"PCIe link width (expected value is 8 == x8)"}}}},"broker_status":{"type":"object","required":["state"],"properties":{"state":{"type":"string","enum":["Inactive","Idle","Busy","Measuring","Pedestal","Error"]},"progress":{"type":"number","format":"float","description":"Progress of data collection (only available if receiving is running)","example":1,"minimum":0,"maximum":1},"message":{"type":"string","description":"Message to display besides state of the jfjoch_broker; mostly used for errors and warnings\nThis matters especially for async functions (start/initialize), where API won't return reason\nfor the error during async operation.\n"},"message_severity":{"type":"string","enum":["success","info","warning","error"],"default":"error","description":"Level of the message to display"},"gpu_count":{"type":"integer","format":"int32","description":"Number of installed GPUs"},"broker_version":{"type":"string","description":"Version of the jfjoch_broker","example":"1.0.0-rc.128"}}},"image_pusher_status":{"type":"object","required":["pusher_type","addr","connected_writers"],"description":"Informs about status of the image pusher.\n","properties":{"pusher_type":{"$ref":"#/components/schemas/image_pusher_type"},"addr":{"type":"array","items":{"type":"string"},"example":["tcp://1.2.3.4:5000","tcp://1.2.3.4:5001"],"description":"List of addresses of image pushers.\nFor HDF5 socket - no addresses will be returned.\nFor ZeroMQ - list of addresses for each socket will be provided.\nFor TCP/IP - single address to connect all writers will be provided.\n"},"connected_writers":{"type":"integer","format":"int64","minimum":0,"description":"Number of connected writers \nFor ZeroMQ image socket: number is constant\nFor TCP/IP image socket: number is updated live during operation\n"},"images_written":{"type":"integer","format":"int64","minimum":0,"description":"Number of images written to the image socket.\nThis number is updated live during operation for TCP/IP image socket and direct HDF5 writer.\nIt is updated at the end of experiment for ZeroMQ image socket.\n"},"images_write_error":{"type":"integer","format":"int64","minimum":0,"description":"Number of images that could not be written to the image socket.\nThis number is updated live during operation for TCP/IP image socket.\nNo other socket use it.\n"},"writer_fifo_utilization":{"type":"array","items":{"type":"integer","format":"int64","minimum":0},"description":"Utilization of internal writer FIFO.\nThis number is updated live during operation for TCP/IP image socket.\nNo other socket use it.\n"}}},"plot":{"type":"object","required":["x","y","title"],"description":"x and y coordinates for plotting, it is OK to assume that both arrays have the same size; layout is optimized for Plotly","properties":{"title":{"type":"string","default":""},"x":{"type":"array","items":{"type":"number","format":"float"}},"y":{"type":"array","items":{"type":"number","format":"float","nullable":true}},"z":{"type":"array","items":{"type":"number","format":"float","nullable":true}}}},"plot_unit_x":{"type":"string","enum":["image_number","q_recipA","d_A","angle_deg","ADU","grid_um"],"default":"image_number"},"plots":{"type":"object","required":["plot","unit_x"],"properties":{"title":{"type":"string"},"unit_x":{"$ref":"#/components/schemas/plot_unit_x"},"size_x":{"type":"number","format":"float","description":"Max X range of the plot"},"size_y":{"type":"number","format":"float","description":"Max Y range of the plot"},"plot":{"type":"array","items":{"$ref":"#/components/schemas/plot"}}}},"scan_result":{"type":"object","description":"Results of a scan","required":["images"],"properties":{"file_prefix":{"type":"string"},"rotation_unit_cell":{"$ref":"#/components/schemas/unit_cell"},"rotation_crystal_lattice":{"$ref":"#/components/schemas/crystal_lattice"},"images":{"type":"array","items":{"type":"object","required":["efficiency","number"],"properties":{"efficiency":{"type":"number","format":"float"},"number":{"type":"integer","format":"int64","description":"Detector image number for a given cell"},"nx":{"type":"integer","format":"int64","description":"Cell position in X for grid scan"},"ny":{"type":"integer","format":"int64","description":"Cell position in Y for grid scan"},"angle":{"type":"number","format":"float","description":"Rotation angle associated with the image"},"bkg":{"type":"number","format":"float","description":"Background estimate"},"spots":{"type":"integer","format":"int64","description":"Spot count"},"spots_low_res":{"type":"integer","format":"int64","description":"Spot count in low resolution range"},"spots_indexed":{"type":"integer","format":"int64","description":"Spot count within indexing tolerance"},"spots_ice":{"type":"integer","format":"int64","description":"Spot count within common ice ring resolutions"},"index":{"type":"integer","format":"int64","description":"Indexing solution"},"latt_count":{"type":"integer","format":"int64","description":"Indexing lattice count"},"pr":{"type":"number","format":"float","description":"Profile radius, i.e. how far reflections are from the Ewald sphere"},"b":{"type":"number","format":"float","description":"B-Factor estimate"},"uc":{"$ref":"#/components/schemas/unit_cell"},"xfel_pulseid":{"type":"integer","format":"int64","description":"XFEL pulse ID"},"pixel_sum":{"type":"integer","format":"int64","description":"Total sum of all pixels"},"max":{"type":"integer","format":"int64","description":"Max viable pixel"},"sat":{"type":"integer","format":"int64","description":"Number of saturated pixels"},"err":{"type":"integer","format":"int64","description":"Number of error pixels"},"res":{"type":"number","format":"float","description":"Diffraction resolution estimate"}}}}}},"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"},"image_pusher":{"$ref":"#/components/schemas/image_pusher_status"}}},"error_message":{"type":"object","required":["msg","reason"],"properties":{"msg":{"type":"string","description":"Human readable message","example":"Detector in wrong state"},"reason":{"type":"string","description":"Enumerate field for automated analysis","enum":["WrongDAQState","Other"]}}},"roi_azimuthal":{"type":"object","description":"ROI as Q-range (or resolution range), optionally restricted to an azimuthal-angle sector","required":["name","q_min_recipA","q_max_recipA"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"q_min_recipA":{"type":"number","format":"float","minimum":0.00001,"description":"Minimum Q-range for the ROI"},"q_max_recipA":{"type":"number","format":"float","minimum":0.00001,"description":"Maximum Q-range for the ROI"},"phi_min_deg":{"type":"number","format":"float","description":"Lower azimuthal-angle bound of the sector [degrees]. Optional: provide both phi_min_deg and phi_max_deg to restrict the ROI to an angular sector, or omit both for a full ring. A sector with phi_min_deg > phi_max_deg wraps across 0.\n"},"phi_max_deg":{"type":"number","format":"float","description":"Upper azimuthal-angle bound of the sector [degrees]. Optional; see phi_min_deg.\n"}}},"roi_circle":{"type":"object","description":"Circular ROI","required":["name","center_x_pxl","center_y_pxl","radius_pxl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"center_x_pxl":{"type":"number","format":"float","description":"X coordinate of center of the circle [pixels]"},"center_y_pxl":{"type":"number","format":"float","description":"Y coordinate of center of the circle [pixels]"},"radius_pxl":{"type":"number","format":"float","minimum":0,"exclusiveMinimum":true,"description":"Radius of the circle [pixels]"}}},"roi_box":{"type":"object","description":"Box ROI","required":["name","min_x_pxl","max_x_pxl","min_y_pxl","max_y_pxl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name for the ROI; used in the plots"},"min_x_pxl":{"type":"integer","format":"int64","description":"Lower bound (inclusive) in X coordinate for the box","minimum":0},"max_x_pxl":{"type":"integer","format":"int64","description":"Upper bound (inclusive) in X coordinate for the box","minimum":0},"min_y_pxl":{"type":"integer","format":"int64","description":"Lower bound (inclusive) in Y coordinate for the box","minimum":0},"max_y_pxl":{"type":"integer","format":"int64","description":"Upper bound (inclusive) in Y coordinate for the box","minimum":0}}},"roi_circle_list":{"type":"object","description":"List of circular ROIs","required":["rois"],"properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_circle"}}}},"roi_box_list":{"type":"object","description":"List of box ROIs","properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_box"}}}},"roi_azim_list":{"type":"object","description":"List of azimuthal ROIs","properties":{"rois":{"type":"array","maxItems":12,"items":{"$ref":"#/components/schemas/roi_azimuthal"}}}},"roi_definitions":{"type":"object","required":["box","circle","azim"],"description":"ROI defintions","properties":{"box":{"$ref":"#/components/schemas/roi_box_list"},"circle":{"$ref":"#/components/schemas/roi_circle_list"},"azim":{"$ref":"#/components/schemas/roi_azim_list"}}},"dark_mask_settings":{"type":"object","description":"Settings for collection of dark images to be used for mask calculation","required":["detector_threshold_keV","frame_threshold_keV","max_allowed_pixel_count","max_frames_with_signal","frame_time_us","number_of_frames"],"properties":{"detector_threshold_keV":{"type":"number","format":"float","description":"Energy threshold for dark image collection","minimum":2.5,"default":3.5,"maximum":100},"frame_time_us":{"type":"integer","format":"int64","description":"Time between frames for dark image collection","minimum":500,"default":10000,"maximum":100000},"number_of_frames":{"type":"integer","format":"int64","description":"Number of frames for dark image collection; zero means no dark collection","minimum":0,"default":1000},"max_allowed_pixel_count":{"type":"integer","format":"int64","description":"Maximum count in a pixel considered normal (not-masked)","minimum":0,"default":1},"max_frames_with_signal":{"type":"integer","format":"int64","description":"Maximum number of frames with signal in a pixel considered normal (not-masked)","minimum":0,"default":10}}},"indexing_settings":{"type":"object","description":"Settings for crystallography indexing","required":["algorithm","geom_refinement_algorithm","fft_high_resolution_A","fft_max_unit_cell_A","fft_min_unit_cell_A","fft_num_vectors","tolerance","thread_count","unit_cell_dist_tolerance","index_ice_rings","viable_cell_min_spots","rotation_indexing","rotation_indexing_min_angular_range_deg","rotation_indexing_angular_stride_deg","blocking"],"properties":{"algorithm":{"$ref":"#/components/schemas/indexing_algorithm"},"fft_max_unit_cell_A":{"type":"number","format":"float","default":250,"maximum":500,"minimum":50,"description":"Largest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT"},"fft_min_unit_cell_A":{"type":"number","format":"float","default":10,"minimum":5,"maximum":40,"description":"Smallest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT"},"fft_high_resolution_A":{"type":"number","format":"float","default":2,"minimum":0.5,"maximum":6,"description":"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"},"rotation_indexing":{"type":"boolean","default":false},"rotation_indexing_min_angular_range_deg":{"type":"number","format":"float","default":20,"minimum":1},"rotation_indexing_angular_stride_deg":{"type":"number","format":"float","default":0.5,"minimum":0},"blocking":{"type":"boolean","default":true,"description":"Indexing in Jungfraujoch goes with a dedicated thread pool.\nIf set to false, the thread pool is non-blocking, i.e. if there are no threads available, image indexing will be skipped. This option is recommended for real-time processing at high frame rates.\nIf set to true, the thread pool will block until a thread is available.\n"}}},"instrument_metadata":{"type":"object","description":"Metadata for a measurement instrument","required":["source_name","instrument_name"],"properties":{"source_name":{"type":"string","example":"Swiss Light Source"},"source_type":{"type":"string","description":"Type of radiation source. NXmx gives a fixed dictionary, though Jungfraujoch is not enforcing compliance. \nhttps://manual.nexusformat.org/classes/base_classes/NXsource.html#nxsource\nNXsource allows the following:\n\nSpallation Neutron Source\nPulsed Reactor Neutron Source\nReactor Neutron Source\nSynchrotron X-ray Source\nPulsed Muon Source\nRotating Anode X-ray\nFixed Tube X-ray\nUV Laser\nFree-Electron Laser\nOptical Laser\nIon Source\nUV Plasma Source\nMetal Jet X-ray\n","example":"Synchrotron X-ray Source","default":""},"instrument_name":{"type":"string","example":"CristallinaMX"},"pulsed_source":{"type":"boolean","description":"Settings specific to XFEL (e.g., every image has to come from TTL trigger, save pulse ID and event code)\n","default":false},"electron_source":{"type":"boolean","description":"Settings specific to electron source (e.g., wavelength definition)\n","default":false}}},"detector_module_direction":{"type":"string","enum":["Xp","Xn","Yp","Yn"]},"detector_type":{"type":"string","enum":["EIGER","JUNGFRAU","DECTRIS"]},"image_pusher_type":{"type":"string","default":"None","enum":["ZeroMQ","HDF5","CBOR","TCP","None"]},"standard_detector_geometry":{"type":"object","description":"Regular rectangular geometry, first module is in the bottom left corner of the detector","required":["nmodules"],"properties":{"nmodules":{"type":"integer","minimum":1,"description":"Number of modules in the detector"},"gap_x":{"type":"integer","default":8,"minimum":0,"description":"Gap size in X direction [pixels]"},"gap_y":{"type":"integer","minimum":0,"default":36,"description":"Gap size in Y direction [pixels]"},"modules_in_row":{"type":"integer","minimum":1,"default":1,"description":"Number of modules in one row"}}},"detector_module":{"type":"object","required":["x0","y0","fast_axis","slow_axis"],"properties":{"x0":{"type":"number"},"y0":{"type":"number"},"fast_axis":{"$ref":"#/components/schemas/detector_module_direction"},"slow_axis":{"$ref":"#/components/schemas/detector_module_direction"}}},"detector":{"type":"object","required":["description"],"properties":{"description":{"type":"string","minLength":1},"serial_number":{"type":"string","default":"Unknown","minLength":1},"type":{"$ref":"#/components/schemas/detector_type"},"high_voltage_V":{"type":"integer","format":"int64","minimum":0,"maximum":200,"default":0},"udp_interface_count":{"type":"integer","format":"int64","minimum":1,"maximum":2,"default":1},"module_sync":{"type":"boolean","default":true,"description":"Use module 0 as master for timing. Only applies to JUNGFRAU detector (this cannot be turned off for EIGER)."},"sensor_thickness_um":{"type":"number","format":"float","minimum":0,"default":320},"readout_time_ns":{"type":"integer","format":"int64","minimum":1,"description":"Minimum difference between frame time and count time in microseconds\nDefaults are 3'000 ns for EIGER and 20'000 ns for JUNGFRAU\n"},"min_count_time_ns":{"type":"integer","format":"int64","minimum":0,"description":"Minimum count time available for the detector."},"min_frame_time_ns":{"type":"integer","format":"int64","minimum":0,"description":"Minimum frame time available for the detector."},"calibration_file":{"type":"array","description":"Can be empty for all detectors - default calibration used.\nFor JUNGFRAU: list of gain files, one entry per module.\nFor EIGER: one directory (with detector settings) or list of trim bit files, one entry per half-module.\n","items":{"type":"string"}},"trim_energies_eV":{"type":"array","description":"List of energies at which trimming calibration is provided.\nOnly needed for PSI EIGER and compulsory in this case\n","items":{"type":"integer","format":"int32","minimum":100}},"hostname":{"type":"array","description":"Hostname for detector module. One entry per module\nOne entry per module. Either empty or number of module entries.\n","items":{"type":"string"}},"sensor_material":{"type":"string","default":"Si"},"tx_delay":{"type":"array","items":{"type":"integer","format":"int64"}},"base_data_ipv4_address":{"type":"string","example":"10.10.10.50"},"standard_geometry":{"$ref":"#/components/schemas/standard_detector_geometry"},"custom_geometry":{"type":"array","items":{"$ref":"#/components/schemas/detector_module"}},"roi_mode":{"type":"string","default":"","description":"ROI setting for DECTRIS detectors"},"mirror_y":{"type":"boolean","default":true,"description":"Mirror detector in Y direction to account for MX convention of (0,0) point in top left corner"},"temp_thresold_degC":{"type":"integer","format":"int64","description":"Temperature threshold for JUNGFRAU detector modules","minimum":40,"maximum":70,"default":55},"default_settings":{"$ref":"#/components/schemas/detector_settings"}}},"zeromq_settings":{"type":"object","description":"ZeroMQ configuration for Jungfraujoch software.\nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","properties":{"send_watermark":{"type":"integer","format":"int64","minimum":2,"maximum":16384,"default":100,"description":"Watermark for ZeroMQ send queue (number of outstanding messages queued on Jungfraujoch server per queue)"},"send_buffer_size":{"type":"integer","format":"int64","description":"Send buffer size for ZeroMQ socket"},"image_socket":{"type":"array","items":{"type":"string"},"example":["tcp://1.2.3.4:5000","tcp://1.2.3.4:5001"],"description":"PUSH ZeroMQ socket for images. In case multiple sockets are provided, images are streamed over multiple sockets.  \nImages are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"},"writer_notification_socket":{"type":"string","example":"tcp://1.3.4.6:7000","description":"PULL ZeroMQ socket for notifications from writer that it finished operation. \nThis allows Jungfraujoch to operate in a synchronous manner, with end of acquisition being also end of writing.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address should be avoided, as this socket address is forwarded to the writer process via START ZerOMQ message and in case of multiple ineterfaces the address might be ambigous.\nUsing * (star) instead of port number is allowed and it means a random free port number.\n"}}},"tcp_settings":{"type":"object","description":"TCP image stream configuration for Jungfraujoch software.\nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","required":["addr"],"properties":{"send_buffer_size":{"type":"integer","format":"int64","description":"Send buffer size for TCP/IP socket"},"image_socket":{"type":"string","example":"tcp://1.2.3.4:5000","description":"tcp://<IP address>:<port>\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces\n"},"nwriters":{"type":"integer","format":"int64","minimum":1,"maximum":100,"default":32,"description":"Number of TCP/IP writers to be used for streaming images"},"peer_liveness_timeout_ms":{"type":"integer","format":"int64","description":"Max time (in milliseconds) a send may block with no sign of life from the\nwriter (no BUSY heartbeat or ACK) before the connection is declared dead.\nOptional; the built-in default is used when unset.\n"},"max_backpressure_timeout_ms":{"type":"integer","format":"int64","description":"Hard upper bound (in milliseconds) on backpressure: if no bytes can be sent to\nthe writer for this long the connection is declared dead even while the writer\nkeeps heartbeating, so a wedged writer cannot block the run or its\nfinalization. Optional; the built-in default is used when unset.\n"}}},"pcie_devices":{"type":"array","minLength":1,"items":{"type":"object","required":["block_device"],"properties":{"blk":{"type":"string","example":"/dev/jfjoch0","description":"Block device name"},"ipv4":{"type":"string","example":"10.1.1.7","description":"IPv4 address of the block device"}}}},"jfjoch_settings":{"type":"object","required":["detector","frontend_directory","image_pusher"],"description":"Default settings for Jungfraujoch software. \nThis structure is used to provide default settings using configuration JSON file and is not used in HTTP.\n","properties":{"pcie":{"$ref":"#/components/schemas/pcie_devices"},"zeromq":{"$ref":"#/components/schemas/zeromq_settings"},"tcp":{"$ref":"#/components/schemas/tcp_settings"},"instrument":{"$ref":"#/components/schemas/instrument_metadata"},"file_writer":{"$ref":"#/components/schemas/file_writer_settings"},"detector":{"type":"array","minLength":1,"items":{"$ref":"#/components/schemas/detector"}},"indexing":{"$ref":"#/components/schemas/indexing_settings"},"detector_settings":{"$ref":"#/components/schemas/detector_settings"},"azim_int":{"$ref":"#/components/schemas/azim_int_settings"},"image_format":{"$ref":"#/components/schemas/image_format_settings"},"image_buffer_MiB":{"type":"integer","minimum":128,"default":2048,"description":"Size of internal buffer in MiB for images before they are sent to a stream"},"verbose":{"type":"boolean","default":false,"description":"Print extra debug information"},"receiver_threads":{"type":"integer","minimum":1,"maximum":512,"default":64,"description":"Number of threads used by the receiver"},"numa_policy":{"type":"string","deprecated":true,"description":"Ignored value"},"frontend_directory":{"type":"string","description":"Location of built JavaScript web frontend"},"spot_finding":{"$ref":"#/components/schemas/spot_finding_settings"},"image_pusher":{"$ref":"#/components/schemas/image_pusher_type"},"zeromq_preview":{"$ref":"#/components/schemas/zeromq_preview_settings"},"zeromq_metadata":{"$ref":"#/components/schemas/zeromq_metadata_settings"},"dark_mask":{"$ref":"#/components/schemas/dark_mask_settings"}}},"zeromq_metadata_settings":{"type":"object","required":["enabled","period_ms"],"properties":{"enabled":{"type":"boolean","default":true,"description":"ZeroMQ metadata socket is enabled."},"period_ms":{"type":"integer","format":"int64","minimum":1,"default":1000,"description":"Period for generating metadata package sent to the ZeroMQ interface in milliseconds.\n"},"socket_address":{"type":"string","description":"PUB ZeroMQ socket for image metadata information.\nImage metadata are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"}}},"zeromq_preview_settings":{"type":"object","required":["enabled","period_ms"],"properties":{"enabled":{"type":"boolean","default":true,"description":"ZeroMQ preview socket is enabled."},"period_ms":{"type":"integer","format":"int64","default":1000,"description":"Period for generating preview image sent to the ZeroMQ interface in milliseconds. Default is 1 second. \nIf set to zero, all images will be sent ZeroMQ (should be used only in case of relatively slow data collection).\nThis has no effect on HTTP based preview, which updates always at rate of 1 second.\n"},"socket_address":{"type":"string","description":"PUB ZeroMQ socket for preview images. This socket operates at a reduced frame rate.\nImages are serialized using CBOR.\nAddress follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK.\n0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.\n"}}}}},"paths":{"/initialize":{"post":{"summary":"Initialize detector and data acquisition","description":"Should be used in two cases:\n  - Detector is in `Inactive` state\n  - Detector is in `Error` state\nX-ray shutter must be closed. \nThis operation will reconfigure network interface of the detector. \nDuring operation of the detector it is recommended to use the `POST /pedestal` operation instead.\nIf storage cells are used, the execution time might be few minutes.\n\nThis is async function - one needs to use `POST /wait_till_done` to ensure operation is done.\n","responses":{"200":{"description":"Initialization started"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/pedestal":{"post":{"summary":"Collect dark current for the detector","description":"Updates calibration of the JUNGFRAU detector. Must be in `Idle` state.\n\nX-ray shutter must be closed. Recommended to run once per hour for long integration times (> 100 us).\n\nThis is async function - one needs to use `POST /wait_till_done` to ensure operation is done.\n","responses":{"200":{"description":"Everything OK"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/start":{"post":{"summary":"Start detector","description":"Start data acquisition.\nDetector must be in `Idle` state.\nDefault behavior is for the call to block until detector is ready to accept soft/TTL triggers.\nHowever, this behavior can be changed by settings `async_start` to true in the request body, \nin which case the call will return immediately and one needs to use `/wait_until_running` to ensure detector is ready to run.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset_settings"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/wait_until_running":{"post":{"summary":"Wait for acquisition running","parameters":[{"in":"query","name":"timeout","required":false,"schema":{"type":"integer","default":60,"minimum":0,"maximum":3600},"description":"Timeout in seconds (0 == immediate response)"}],"description":"Block execution of external script till detector and Jungfraujoch are ready to collect data.\nTo not block web server for a indefinite period of time, the procedure is provided with a timeout.\nExtending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.\n","responses":{"200":{"description":"Detector in `Measuring` state"},"400":{"description":"Timeout parameter out of bounds"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}},"502":{"description":"Detector is inactive mode"},"504":{"description":"Timeout reached, need to restart operation"}}}},"/wait_till_done":{"post":{"summary":"Wait for acquisition done","parameters":[{"in":"query","name":"timeout","required":false,"schema":{"type":"integer","default":60,"minimum":0,"maximum":3600},"description":"Timeout in seconds (0 == immediate response)"}],"description":"Block execution of external script till initialization, data collection or pedestal is finished.\nRunning this command does not affect (cancel) running data collection, it is only to ensure synchronous execution of other software.\n\nTo not block web server for a indefinite period of time, the procedure is provided with a timeout.\nExtending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.\n","responses":{"200":{"description":"Detector in `Idle` state, another data collection can start immediately"},"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"}}}},"/image_pusher/status":{"get":{"summary":"Get status of image pusher","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_pusher_status"}}}},"500":{"description":"Error encountered when trying to read status","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/detector/status":{"get":{"summary":"Get detector status","description":"Status of the JUNGFRAU detector","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/detector_status"}}}},"404":{"description":"Running in \"simulator\" mode - no detector present"},"500":{"description":"Error encountered when trying to read status","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/config/roi":{"get":{"summary":"Get ROI definitions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roi_definitions"}}}}}},"put":{"summary":"Upload ROI definitions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/roi_definitions"}}}},"responses":{"200":{"description":"Everything OK"},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/statistics":{"get":{"summary":"Get general statistics","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jfjoch_statistics"}}}}}}},"/statistics/data_collection":{"get":{"summary":"Get data collection statistics","description":"Results of the last data collection","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/measurement_statistics"}}}},"404":{"description":"No data collection performed so far"}}}},"/statistics/calibration":{"get":{"summary":"Get calibration statistics","description":"Statistics are provided for each module/storage cell separately","responses":{"200":{"description":"Everything OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calibration_statistics"}}}}}}},"/config/mask":{"get":{"summary":"Get mask of the detector (binary)","description":"Detector must be Initialized.\nGet full pixel mask of the detector.\nSee NXmx standard for meaning of pixel values.\n","responses":{"200":{"description":"Binary array (4 byte; unsigned)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}},"/config/user_mask":{"get":{"summary":"Detector must be Initialized.\nGet user mask of the detector (binary)\n","description":"Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked","responses":{"200":{"description":"User mask in binary format (4 byte; unsigned)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"summary":"Upload user mask of the detector (binary)","description":"Should be in `Idle` state.\nUpload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.\nIf detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.\nIn the latter case - module gaps are ignored and don't need to be assigned value.\nMask is expected as binary array (4-byte; unsigned).\n0 - good pixel, other value - masked\nUser mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.\n","requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"All good"},"400":{"description":"Mask is not 4-byte unsigned integer array or empty body"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/config/mask.tiff":{"get":{"summary":"Get mask of the detector (TIFF)","description":"Should be in `Idle` state.\nGet full pixel mask of the detector\nSee NXmx standard for meaning of pixel values\n","responses":{"200":{"description":"Pixel mask in TIFF format (4 byte; unsigned)","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}}}}},"/config/user_mask.tiff":{"get":{"summary":"Detector must be Initialized.\nGet user mask of the detector (TIFF)\n","description":"Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked","responses":{"200":{"description":"User mask in TIFF format (4 byte; unsigned)","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"summary":"Upload user mask of the detector","description":"Should be in `Idle` state.\nUpload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.\nIf detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.\nIn the latter case - module gaps are ignored and don't need to be assigned value.\nMask is expected as a single-channel TIFF (8-, 16- or 32-bit integer, signed or unsigned).\n0 - good pixel, other value - masked\nUser mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.\nUser mask is not automatically applied - i.e. pixels with user mask will have a valid pixel value in the images.\n","requestBody":{"content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"All good"},"400":{"description":"Not a valid single-channel TIFF or size doesn't match the detector"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/preview/pedestal.tiff":{"get":{"parameters":[{"in":"query","name":"gain_level","required":true,"schema":{"type":"integer"},"description":"Gain level (0, 1, 2)"},{"in":"query","name":"sc","schema":{"type":"integer"},"description":"Storage cell number"}],"summary":"Get pedestal in TIFF format","responses":{"200":{"description":"Calibration image","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid gain level or storage cell number"},"404":{"description":"No calibration recorded so far"}}}},"/preview/plot":{"get":{"summary":"Generate 1D plot from Jungfraujoch","parameters":[{"$ref":"#/components/parameters/binning"},{"$ref":"#/components/parameters/plot_type"},{"$ref":"#/components/parameters/fill_value"},{"$ref":"#/components/parameters/experimental_coord"},{"$ref":"#/components/parameters/azint_unit"}],"responses":{"200":{"description":"Everything OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/plots"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/preview/plot.bin":{"get":{"summary":"Generate 1D plot from Jungfraujoch and send in raw binary format.\nData are provided as (32-bit) float binary array.\nThis format doesn't transmit information about X-axis, only values, so it is of limited use for azimuthal integration.\n","parameters":[{"$ref":"#/components/parameters/plot_type"},{"$ref":"#/components/parameters/roi"}],"responses":{"200":{"description":"Everything OK.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}}}}},"/result/scan":{"get":{"summary":"Get full scan result","responses":{"200":{"description":"Everything OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scan_result"}}}},"404":{"description":"No grid scan recorded"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/start.cbor":{"get":{"summary":"Get Start message in CBOR format","description":"Contains metadata for a dataset (e.g., experimental geometry)","responses":{"200":{"description":"Return start message","content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No measurement so far"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.cbor":{"get":{"summary":"Get image message in CBOR format","description":"Contains full image data and metadata. The image must come from the latest data collection.","parameters":[{"$ref":"#/components/parameters/image_id"}],"responses":{"200":{"description":"Return image message","content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Image not present in the buffer - either not yet measured or already replaced by a next image."},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.jpeg":{"get":{"summary":"Get preview image in JPEG format using custom settings","parameters":[{"$ref":"#/components/parameters/image_id"},{"$ref":"#/components/parameters/show_user_mask"},{"$ref":"#/components/parameters/show_roi"},{"$ref":"#/components/parameters/show_spots"},{"$ref":"#/components/parameters/show_beam_center"},{"$ref":"#/components/parameters/saturation"},{"$ref":"#/components/parameters/jpeg_quality"},{"$ref":"#/components/parameters/resolution_ring"},{"$ref":"#/components/parameters/color_scale"},{"$ref":"#/components/parameters/resolution_estimate"}],"responses":{"200":{"description":"Preview image","content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input parsing or validation error","content":{"text/plain":{"schema":{"type":"string","description":"Exception error"}}}},"404":{"description":"Image not present in the buffer - either not yet measured or already replaced by a next image."},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/image.tiff":{"get":{"summary":"Get preview image in TIFF format","parameters":[{"$ref":"#/components/parameters/image_id"}],"responses":{"200":{"description":"Preview image","content":{"image/tiff":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No preview image recorded so far"}}}},"/image_buffer/clear":{"post":{"summary":"Clear image buffer","description":"Turns off image buffer for the last data collection. Can be only run when Jungfraujoch is not collecting data.","responses":{"200":{"description":"Done"},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/image_buffer/status":{"get":{"summary":"Get status of the image buffers","description":"Can be run at any stage of Jungfraujoch operation, including during data collection.\nThe status of the image buffer is volatile during data collection - if data collection goes for more images than available buffer slots,\nthen image might be replaced in the buffer between calling /images and /image.cbor.\n","responses":{"200":{"description":"Done","content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_buffer_status"}}}},"500":{"description":"Error within Jungfraujoch code - see output message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error_message"}}}}}}},"/version":{"get":{"summary":"Get Jungfraujoch version of jfjoch_broker","responses":{"200":{"description":"Release number of Jungfraujoch","content":{"text/plain":{"schema":{"type":"string","example":"1.0.0-rc.25"}}}}}}}}}},"searchIndex":{"store":["section/License-Clarification","/paths/~1initialize/post","/paths/~1pedestal/post","/paths/~1start/post","/paths/~1wait_until_running/post","/paths/~1wait_till_done/post","/paths/~1trigger/post","/paths/~1cancel/post","/paths/~1deactivate/post","/paths/~1config~1detector/put","/paths/~1config~1detector/get","/paths/~1config~1indexing/put","/paths/~1config~1indexing/get","/paths/~1config~1file_writer/put","/paths/~1config~1file_writer/get","/paths/~1config~1instrument/put","/paths/~1config~1instrument/get","/paths/~1config~1image_format/put","/paths/~1config~1image_format/get","/paths/~1config~1image_format~1raw/post","/paths/~1config~1image_format~1conversion/post","/paths/~1config~1spot_finding/put","/paths/~1config~1spot_finding/get","/paths/~1config~1azim_int/put","/paths/~1config~1azim_int/get","/paths/~1config~1internal_generator_image/put","/paths/~1config~1internal_generator_image.tiff/put","/paths/~1config~1select_detector/put","/paths/~1config~1select_detector/get","/paths/~1config~1zeromq_preview/put","/paths/~1config~1zeromq_preview/get","/paths/~1config~1zeromq_metadata/put","/paths/~1config~1zeromq_metadata/get","/paths/~1config~1dark_mask/put","/paths/~1config~1dark_mask/get","/paths/~1status/get","/paths/~1fpga_status/get","/paths/~1xfel~1pulse_id/get","/paths/~1xfel~1event_code/get","/paths/~1image_pusher~1status/get","/paths/~1detector~1status/get","/paths/~1config~1roi/get","/paths/~1config~1roi/put","/paths/~1statistics/get","/paths/~1statistics~1data_collection/get","/paths/~1statistics~1calibration/get","/paths/~1config~1mask/get","/paths/~1config~1user_mask/get","/paths/~1config~1user_mask/put","/paths/~1config~1mask.tiff/get","/paths/~1config~1user_mask.tiff/get","/paths/~1config~1user_mask.tiff/put","/paths/~1preview~1pedestal.tiff/get","/paths/~1preview~1plot/get","/paths/~1preview~1plot.bin/get","/paths/~1result~1scan/get","/paths/~1image_buffer~1start.cbor/get","/paths/~1image_buffer~1image.cbor/get","/paths/~1image_buffer~1image.jpeg/get","/paths/~1image_buffer~1image.tiff/get","/paths/~1image_buffer~1clear/post","/paths/~1image_buffer~1status/get","/paths/~1version/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.076,1,4.719]],["description/0",[0,1.814,2,4.176,3,2.164,4,2.1,5,1.203,6,3.348,7,1.203,8,1.203,9,1.039,10,0.931,11,1.612,12,1.203,13,0.96,14,1.203,15,1.626,16,1.203,17,2.794,18,2.1,19,0.931,20,2.1,21,1.28,22,1.203,23,2.1,24,1.039,25,2.794,26,1.203,27,1.203,28,2.1,29,1.203,30,1.203,31,1.203,32,1.203,33,1.203,34,1.203,35,1.203,36,2.794,37,1.203,38,1.203,39,0.365,40,0.611,41,1.203,42,2.1,43,1.039,44,1.203,45,1.203,46,1.203,47,1.203,48,1.203,49,1.203,50,1.039,51,1.203,52,1.203,53,1.203,54,1.203,55,1.203,56,1.203,57,1.203,58,1.203,59,0.931,60,0.931,61,1.203]],["title/1",[62,2.287,63,0.409,64,0.96,65,1.908]],["description/1",[11,2.207,39,0.962,43,1.696,59,1.52,62,1.196,63,0.5,66,1.963,67,1.389,68,2.029,69,0.898,70,0.945,71,1.52,72,1.696,73,1.389,74,2.997,75,1.963,76,1.52,77,1.696,78,2.741,79,1.196,80,1.963,81,1.963,82,1.696,83,1.389,84,1.284,85,1.963,86,1.963,87,1.696,88,1.696,89,1.284,90,1.284,91,1.52,92,1.284,93,0.595]],["title/2",[63,0.409,94,1.356,95,2.906,96,2.655]],["description/2",[11,1.236,39,0.779,63,0.28,68,1.99,71,1.988,72,2.218,73,1.816,74,1.678,77,2.218,78,2.218,79,1.564,84,1.678,87,2.218,88,2.218,89,1.678,90,1.678,91,1.988,92,1.678,93,0.779,97,2.567,98,1.988,99,2.218,100,0.849,101,1.305,102,2.567,103,2.567,104,2.567,105,2.567,106,1.564,107,2.567]],["title/3",[63,0.515,108,3.653]],["description/3",[11,1.128,39,0.71,60,2.825,63,0.489,64,0.599,65,1.19,67,1.656,89,1.531,90,1.531,92,1.531,100,0.774,101,1.19,108,2.825,109,2.342,110,3.649,111,1.813,112,2.342,113,3.152,114,2.342,115,2.342,116,1.813,117,1.128,118,0.809,119,2.342,120,2.342,121,1.813,122,2.342,123,1.531,124,2.342,125,2.023]],["title/4",[65,2.125,101,2.125,126,3.612]],["description/4",[15,1.988,21,1.564,63,0.28,64,0.657,73,1.816,83,1.816,84,1.678,92,1.678,94,0.927,111,3.032,113,2.218,125,2.218,127,2.218,128,2.218,129,2.218,130,1.236,131,2.218,132,2.218,133,2.218,134,2.218,135,1.988,136,1.678,137,3.383,138,2.218,139,1.988,140,2.218,141,3.383,142,2.218]],["title/5",[65,2.125,93,1.268,126,3.612]],["description/5",[15,1.641,21,1.291,62,1.291,64,0.863,73,1.499,79,1.291,83,2.385,84,1.385,91,1.641,92,2.205,94,1.218,101,1.714,111,2.611,127,1.831,128,1.831,129,1.831,131,1.831,132,1.831,133,1.831,134,1.831,135,1.641,136,1.385,137,2.914,138,1.831,139,1.641,140,1.831,141,2.914,142,1.831,143,1.831,144,1.499,145,2.119,146,1.641,147,2.119,148,2.119]],["title/6",[63,0.409,116,2.906,149,3.243,150,3.243]],["description/6",[13,2.441,116,5.02,150,4.61]],["title/7",[64,0.96,94,1.356,101,1.908,146,2.906]],["description/7",[39,0.643,59,1.641,63,0.231,64,1.075,65,1.077,79,1.291,84,1.385,94,1.218,96,2.385,100,0.701,101,1.077,143,2.914,144,3.387,146,1.641,151,1.831,152,1.291,153,2.119,154,2.611,155,1.831,156,2.119,157,2.119,158,1.831,159,2.119,160,2.119,161,1.641,162,2.119,163,2.119,164,2.119,165,2.119,166,2.119,167,2.119,168,2.119,169,1.641]],["title/8",[63,0.456,170,4.181,171,3.237]],["description/8",[11,1.607,39,1.012,63,0.518,64,0.854,65,1.696,70,1.607,100,1.103,144,2.36,171,3.68,172,4.753,173,3.337,174,3.337,175,3.337,176,3.337,177,3.337,178,3.337]],["title/9",[63,0.456,117,2.013,179,1.912]],["description/9",[39,1.301,63,0.579,68,1.758,69,1.582,70,1.666,71,1.694,74,1.431,76,1.694,79,2.108,83,2.447,89,1.431,93,0.664,94,0.79,98,2.679,100,1.144,117,1.054,118,1.482,135,1.694,169,1.694,180,1.891,181,2.188,182,1.891,183,2.188,184,2.188,185,1.891]],["title/10",[63,0.515,179,2.158]],["description/10",[93,1.686,185,4.802,186,2.99]],["title/11",[117,1.808,118,1.297,187,3.243,188,3.753]],["description/11",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,189,4.117]],["title/12",[179,2.158,187,4.076]],["description/12",[93,1.686,186,2.99,189,4.802]],["title/13",[10,2.906,117,1.808,118,1.297,161,2.906]],["description/13",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,190,4.117]],["title/14",[10,3.237,118,1.444,161,3.237]],["description/14",[93,1.686,186,2.99,190,4.802]],["title/15",[117,2.013,191,3.612,192,2.388]],["description/15",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,193,4.117]],["title/16",[191,4.076,192,2.695]],["description/16",[93,1.686,186,2.99,193,4.802]],["title/17",[117,1.808,194,1.241,195,3.243,196,1.808]],["description/17",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,197,4.117]],["title/18",[194,1.383,195,3.612,196,2.013]],["description/18",[93,1.686,186,2.99,197,4.802]],["title/19",[64,0.871,94,1.23,179,1.557,196,1.64,198,2.408]],["description/19",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,199,4.765]],["title/20",[64,0.797,94,1.125,179,1.425,196,1.501,200,2.037,201,2.413]],["description/20",[39,1.445,63,0.52,69,2.179,70,2.295,93,1.445,100,1.576,202,4.765]],["title/21",[179,1.912,203,3.237,204,3.237]],["description/21",[64,1.264,93,1.499,94,1.785,101,2.512,186,2.658,205,4.269]],["title/22",[64,1.07,158,3.612,179,1.912]],["description/22",[93,1.686,186,2.99,205,4.802]],["title/23",[106,2.548,179,1.912,206,2.734]],["description/23",[63,0.56,69,2.347,93,1.556,100,1.697,207,4.433]],["title/24",[106,2.548,179,1.912,206,2.734]],["description/24",[93,1.686,186,2.99,207,4.802]],["title/25",[13,1.425,152,1.899,194,1.03,208,2.204,209,1.78,210,2.204]],["description/25",[13,1.387,21,1.848,39,0.92,63,0.572,100,1.003,118,1.048,152,1.848,194,1.003,208,2.146,209,1.733,210,2.146,211,2.621,212,3.033,213,2.621,214,2.349,215,2.621,216,2.621,217,2.621,218,1.848,219,2.621,220,3.033]],["title/26",[13,1.425,152,1.899,194,1.03,208,2.204,210,2.204,221,1.78]],["description/26",[13,1.42,21,1.891,39,0.941,63,0.58,100,1.026,118,1.072,152,1.891,194,1.026,208,2.195,210,2.195,211,2.682,213,2.682,214,2.403,215,2.682,216,2.682,217,2.682,218,1.891,219,2.682,221,1.773,222,3.104]],["title/27",[63,0.515,223,4.076]],["description/27",[21,1.694,24,2.402,39,0.843,50,3.594,63,0.603,69,1.272,89,2.72,117,1.339,118,0.961,130,1.339,136,1.818,144,1.967,224,2.781,225,2.781,226,2.781,227,2.781,228,2.402,229,2.153,230,2.781,231,2.781,232,2.781,233,2.402]],["title/28",[63,0.456,228,3.612,234,3.237]],["description/28",[11,2.471,63,0.56,179,2.347,223,4.433,233,4.433]],["title/29",[118,1.783,235,2.287,236,2.454]],["description/29",[13,1.174,64,0.657,117,1.236,118,1.353,121,3.032,130,1.236,169,1.988,235,1.564,236,2.561,237,1.816,238,2.218,239,2.567,240,3.032,241,2.218,242,2.218,243,2.218,244,1.816,245,2.218,246,2.218,247,3.383,248,1.816,249,3.383,250,2.567,251,2.567,252,2.218]],["title/30",[118,1.444,235,2.548,236,2.734]],["description/30",[252,5.238]],["title/31",[118,1.783,192,2.144,235,2.287]],["description/31",[13,1.299,64,0.727,117,1.368,118,0.981,121,2.199,130,1.368,192,1.622,194,0.939,235,1.73,237,2.009,238,3.651,240,3.272,241,2.453,242,2.453,243,2.453,244,2.009,245,2.453,246,2.453,247,2.453,248,2.009,249,2.453,253,2.84,254,2.84,255,2.453]],["title/32",[118,1.297,192,2.144,235,2.287,240,2.906]],["description/32",[255,5.238]],["title/33",[64,0.735,94,1.037,95,2.224,118,0.992,179,1.314,256,2.481,257,1.136]],["description/33",[39,1.094,63,0.548,69,1.65,70,1.737,74,2.358,93,1.094,100,1.193,139,2.793,234,2.793,258,3.607,259,3.607,260,3.607,261,3.607,262,3.607,263,3.116]],["title/34",[64,0.797,94,1.125,95,2.413,118,1.076,256,2.692,257,1.233]],["description/34",[263,5.238]],["title/35",[130,2.272,264,2.538]],["description/35",[64,1.365,65,2.712,264,3.487]],["title/36",[152,2.548,264,2.249,265,4.181]],["description/36",[266,6.064]],["title/37",[64,0.735,65,1.46,96,2.032,123,1.878,229,2.224,267,2.032,268,2.481]],["description/37",[68,2.188,123,2.814,194,1.423,229,3.333,267,3.045,268,3.719,269,3.045,270,3.333,271,4.305,272,4.305]],["title/38",[19,2.224,64,0.735,65,1.46,96,2.032,123,1.878,267,2.032,273,2.481]],["description/38",[19,3.826,123,3.231,267,3.495,269,3.495,273,4.269,274,4.942]],["title/39",[194,1.383,264,2.249,275,4.181]],["description/39",[276,6.064]],["title/40",[63,0.515,264,2.538]],["description/40",[63,0.582,99,4.61,264,2.87,277,5.337]],["title/41",[3,3.653,278,4.076]],["description/41",[279,5.238]],["title/42",[3,3.237,278,3.612,280,2.734]],["description/42",[279,5.238]],["title/43",[13,2.158,281,3.085]],["description/43",[281,3.965]],["title/44",[64,1.07,94,1.51,281,2.734]],["description/44",[64,1.313,94,1.853,282,4.433,283,4.433,284,5.132]],["title/45",[98,3.653,281,3.085]],["description/45",[82,4.117,136,3.116,281,3.116,285,4.765,286,4.765,287,4.765,288,4.765]],["title/46",[63,0.456,209,2.388,257,1.654]],["description/46",[62,2.392,63,0.58,200,2.566,257,1.553,289,3.242,290,3.391,291,2.776,292,3.391,293,3.391,294,2.566,295,3.925]],["title/47",[40,1.584,62,1.899,63,0.493,209,1.78,257,1.233]],["description/47",[40,1.884,63,0.558,68,2.601,218,2.259,257,2.024,270,2.87,289,3.118,296,3.203,297,2.622,298,2.622,299,3.203]],["title/48",[40,1.731,63,0.371,209,1.945,257,1.347,280,2.226]],["description/48",[11,0.765,39,0.482,40,1.355,63,0.291,67,1.124,68,2.048,90,1.039,100,0.526,106,0.968,154,1.231,198,1.124,201,1.231,203,1.231,204,1.231,206,1.039,209,0.908,218,0.968,248,1.124,257,1.922,269,1.124,280,1.039,289,1.624,291,1.124,294,1.743,297,1.124,298,1.124,299,1.373,300,1.373,301,1.373,302,1.373,303,1.373,304,1.373,305,1.373,306,1.373,307,1.373,308,1.373,309,1.373,310,2.303,311,1.373,312,1.373,313,1.373,314,1.373,315,1.373,316,1.373,317,1.589,318,1.373,319,1.373,320,1.373,321,1.373,322,1.373]],["title/49",[63,0.456,221,2.388,257,1.654]],["description/49",[39,1.191,63,0.428,100,1.298,200,2.566,257,1.553,289,3.242,290,3.391,291,2.776,292,3.391,293,3.391,294,2.566,323,3.925]],["title/50",[40,1.584,62,1.899,63,0.493,221,1.78,257,1.233]],["description/50",[40,1.884,63,0.558,68,2.601,218,2.259,257,2.024,270,2.87,289,3.118,296,3.203,297,2.622,298,2.622,324,3.203]],["title/51",[40,1.908,63,0.409,257,1.485,280,2.454]],["description/51",[9,1.142,11,0.637,39,0.401,40,1.815,63,0.249,67,0.935,68,2.048,90,0.864,100,0.437,106,0.805,154,1.024,180,1.142,182,1.142,194,0.437,198,0.935,201,1.024,203,1.024,204,1.024,206,0.864,214,1.024,218,0.805,221,0.755,248,0.935,257,1.973,280,0.864,289,2.177,291,0.935,294,1.964,297,0.935,298,0.935,300,1.142,301,1.142,302,1.142,303,1.142,304,1.142,305,1.142,306,1.142,307,1.142,308,1.142,309,1.142,310,1.969,311,1.142,312,1.142,313,1.142,314,1.142,315,1.142,316,1.142,318,1.142,319,1.142,320,1.142,321,1.969,322,1.142,324,1.142,325,1.322,326,1.322,327,1.142,328,1.322,329,1.322]],["title/52",[79,2.548,196,2.013,221,2.388]],["description/52",[330,6.064]],["title/53",[13,1.717,130,1.808,331,3.243,332,3.243]],["description/53",[333,6.064]],["title/54",[11,0.594,13,0.564,64,0.315,106,0.751,130,0.594,136,0.806,149,1.065,151,1.065,196,1.033,198,0.872,206,0.806,209,1.225,269,0.872,294,0.806,327,1.065,331,1.065,332,1.065,334,1.232,335,1.232,336,1.232,337,1.232,338,1.232]],["description/54",[339,6.064]],["title/55",[200,2.734,282,3.612,340,4.181]],["description/55",[341,6.064]],["title/56",[108,2.906,196,1.808,237,2.655,342,3.243]],["description/56",[192,2.722,244,3.371,343,4.765,344,4.765,345,4.765,346,4.765,347,4.765]],["title/57",[194,1.241,196,1.808,237,2.655,342,3.243]],["description/57",[64,1.418,94,1.506,192,2.382,194,1.832,200,2.727,244,2.95,348,4.17,349,4.17,350,4.17]],["title/58",[11,1.383,118,0.992,194,0.95,196,1.383,236,1.878,351,2.872,352,2.872]],["description/58",[353,6.064]],["title/59",[194,1.241,196,1.808,221,2.144,236,2.454]],["description/59",[354,6.064]],["title/60",[194,1.383,355,4.181,356,2.957]],["description/60",[64,1.418,94,2.001,101,2.119,130,2.008,171,3.229,194,1.379,283,3.603,356,2.95,357,4.17]],["title/61",[194,1.383,264,2.249,356,2.957]],["description/61",[60,1.95,64,1.201,68,1.28,74,1.647,76,2.989,94,1.695,101,1.28,130,1.213,155,2.176,194,1.74,234,1.95,264,1.355,356,3.319,358,2.519,359,2.519,360,2.519,361,2.519,362,2.519,363,2.519,364,2.519,365,2.519,366,2.519]],["title/62",[130,2.013,367,3.612,368,4.181]],["description/62",[367,5.238]]],"invertedIndex":[["",{"_index":68,"title":{},"description":{"1":{},"2":{},"9":{},"37":{},"47":{},"48":{},"50":{},"51":{},"61":{}}}],["0",{"_index":297,"title":{},"description":{"47":{},"48":{},"50":{},"51":{}}}],["1",{"_index":270,"title":{},"description":{"37":{},"47":{},"50":{}}}],["100",{"_index":107,"title":{},"description":{"2":{}}}],["1024x512",{"_index":308,"title":{},"description":{"48":{},"51":{}}}],["16",{"_index":326,"title":{},"description":{"51":{}}}],["16-bit",{"_index":213,"title":{},"description":{"25":{},"26":{}}}],["1d",{"_index":331,"title":{"53":{},"54":{}},"description":{}}],["32-bit",{"_index":327,"title":{"54":{}},"description":{"51":{}}}],["4-byte",{"_index":317,"title":{},"description":{"48":{}}}],["8",{"_index":321,"title":{},"description":{"48":{},"51":{}}}],["accept",{"_index":114,"title":{},"description":{"3":{}}}],["account",{"_index":301,"title":{},"description":{"48":{},"51":{}}}],["acquisit",{"_index":65,"title":{"1":{},"4":{},"5":{},"37":{},"38":{}},"description":{"3":{},"7":{},"8":{},"35":{}}}],["actual",{"_index":296,"title":{},"description":{"47":{},"50":{}}}],["adjust",{"_index":242,"title":{},"description":{"29":{},"31":{}}}],["affect",{"_index":145,"title":{},"description":{"5":{}}}],["again",{"_index":181,"title":{},"description":{"9":{}}}],["algorithm",{"_index":188,"title":{"11":{}},"description":{}}],["allow",{"_index":50,"title":{},"description":{"0":{},"27":{}}}],["alway",{"_index":176,"title":{},"description":{"8":{}}}],["and/or",{"_index":226,"title":{},"description":{"27":{}}}],["anytim",{"_index":186,"title":{},"description":{"10":{},"12":{},"14":{},"16":{},"18":{},"21":{},"22":{},"24":{}}}],["api",{"_index":2,"title":{},"description":{"0":{}}}],["appli",{"_index":9,"title":{},"description":{"0":{},"51":{}}}],["applic",{"_index":17,"title":{},"description":{"0":{}}}],["approach",{"_index":30,"title":{},"description":{"0":{}}}],["array",{"_index":269,"title":{"54":{}},"description":{"37":{},"38":{},"48":{}}}],["asic",{"_index":175,"title":{},"description":{"8":{}}}],["assign",{"_index":315,"title":{},"description":{"48":{},"51":{}}}],["async",{"_index":87,"title":{},"description":{"1":{},"2":{}}}],["async_start",{"_index":119,"title":{},"description":{"3":{}}}],["automat",{"_index":182,"title":{},"description":{"9":{},"51":{}}}],["avail",{"_index":234,"title":{"28":{}},"description":{"33":{},"61":{}}}],["azimuth",{"_index":206,"title":{"23":{},"24":{},"54":{}},"description":{"48":{},"51":{}}}],["back",{"_index":168,"title":{},"description":{"7":{}}}],["base",{"_index":251,"title":{},"description":{"29":{}}}],["be",{"_index":157,"title":{},"description":{"7":{}}}],["beam",{"_index":302,"title":{},"description":{"48":{},"51":{}}}],["befor",{"_index":177,"title":{},"description":{"8":{}}}],["behavior",{"_index":110,"title":{},"description":{"3":{}}}],["between",{"_index":364,"title":{},"description":{"61":{}}}],["binari",{"_index":209,"title":{"25":{},"46":{},"47":{},"48":{},"54":{}},"description":{"25":{},"48":{}}}],["bit",{"_index":320,"title":{},"description":{"48":{},"51":{}}}],["blob",{"_index":212,"title":{},"description":{"25":{}}}],["block",{"_index":111,"title":{},"description":{"3":{},"4":{},"5":{}}}],["bodi",{"_index":122,"title":{},"description":{"3":{}}}],["both",{"_index":307,"title":{},"description":{"48":{},"51":{}}}],["buffer",{"_index":356,"title":{"60":{},"61":{}},"description":{"60":{},"61":{}}}],["calcul",{"_index":256,"title":{"33":{},"34":{}},"description":{}}],["calibr",{"_index":98,"title":{"45":{}},"description":{"2":{},"9":{}}}],["call",{"_index":60,"title":{},"description":{"0":{},"3":{},"61":{}}}],["cancel",{"_index":146,"title":{"7":{}},"description":{"5":{},"7":{}}}],["card",{"_index":153,"title":{},"description":{"7":{}}}],["case",{"_index":67,"title":{},"description":{"1":{},"3":{},"48":{},"51":{}}}],["cbor",{"_index":342,"title":{"56":{},"57":{}},"description":{}}],["cell",{"_index":82,"title":{},"description":{"1":{},"45":{}}}],["chang",{"_index":117,"title":{"9":{},"11":{},"13":{},"15":{},"17":{}},"description":{"3":{},"9":{},"27":{},"29":{},"31":{}}}],["choos",{"_index":24,"title":{},"description":{"0":{},"27":{}}}],["clarif",{"_index":1,"title":{"0":{}},"description":{}}],["clear",{"_index":355,"title":{"60":{}},"description":{}}],["client",{"_index":15,"title":{},"description":{"0":{},"4":{},"5":{}}}],["close",{"_index":73,"title":{},"description":{"1":{},"2":{},"4":{},"5":{}}}],["code",{"_index":19,"title":{"38":{}},"description":{"0":{},"38":{}}}],["collect",{"_index":94,"title":{"2":{},"7":{},"19":{},"20":{},"33":{},"34":{},"44":{}},"description":{"4":{},"5":{},"7":{},"9":{},"21":{},"44":{},"57":{},"60":{},"61":{}}}],["come",{"_index":348,"title":{},"description":{"57":{}}}],["command",{"_index":144,"title":{},"description":{"5":{},"7":{},"8":{},"27":{}}}],["commun",{"_index":57,"title":{},"description":{"0":{}}}],["config/azim_int",{"_index":207,"title":{},"description":{"23":{},"24":{}}}],["config/dark_mask",{"_index":263,"title":{},"description":{"33":{},"34":{}}}],["config/detector",{"_index":185,"title":{},"description":{"9":{},"10":{}}}],["config/file_writ",{"_index":190,"title":{},"description":{"13":{},"14":{}}}],["config/image_format",{"_index":197,"title":{},"description":{"17":{},"18":{}}}],["config/image_format/convers",{"_index":202,"title":{},"description":{"20":{}}}],["config/image_format/raw",{"_index":199,"title":{},"description":{"19":{}}}],["config/index",{"_index":189,"title":{},"description":{"11":{},"12":{}}}],["config/instru",{"_index":193,"title":{},"description":{"15":{},"16":{}}}],["config/internal_generator_imag",{"_index":220,"title":{},"description":{"25":{}}}],["config/internal_generator_image.tiff",{"_index":222,"title":{},"description":{"26":{}}}],["config/mask",{"_index":295,"title":{},"description":{"46":{}}}],["config/mask.tiff",{"_index":323,"title":{},"description":{"49":{}}}],["config/roi",{"_index":279,"title":{},"description":{"41":{},"42":{}}}],["config/select_detector",{"_index":233,"title":{},"description":{"27":{},"28":{}}}],["config/spot_find",{"_index":205,"title":{},"description":{"21":{},"22":{}}}],["config/user_mask",{"_index":299,"title":{},"description":{"47":{},"48":{}}}],["config/user_mask.tiff",{"_index":324,"title":{},"description":{"50":{},"51":{}}}],["config/zeromq_metadata",{"_index":255,"title":{},"description":{"31":{},"32":{}}}],["config/zeromq_preview",{"_index":252,"title":{},"description":{"29":{},"30":{}}}],["configur",{"_index":179,"title":{"9":{},"10":{},"12":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"33":{}},"description":{"28":{}}}],["connect",{"_index":141,"title":{},"description":{"4":{},"5":{}}}],["consist",{"_index":230,"title":{},"description":{"27":{}}}],["contain",{"_index":244,"title":{},"description":{"29":{},"31":{},"56":{},"57":{}}}],["control",{"_index":224,"title":{},"description":{"27":{}}}],["convers",{"_index":201,"title":{"20":{}},"description":{"48":{},"51":{}}}],["convert",{"_index":311,"title":{},"description":{"48":{},"51":{}}}],["coordin",{"_index":218,"title":{},"description":{"25":{},"26":{},"47":{},"48":{},"50":{},"51":{}}}],["copyleft",{"_index":7,"title":{},"description":{"0":{}}}],["cover",{"_index":254,"title":{},"description":{"31":{}}}],["cpu",{"_index":159,"title":{},"description":{"7":{}}}],["current",{"_index":96,"title":{"2":{},"37":{},"38":{}},"description":{"7":{}}}],["custom",{"_index":352,"title":{"58":{}},"description":{}}],["dark",{"_index":95,"title":{"2":{},"33":{},"34":{}},"description":{}}],["data",{"_index":64,"title":{"1":{},"7":{},"19":{},"20":{},"22":{},"33":{},"34":{},"37":{},"38":{},"44":{},"54":{}},"description":{"3":{},"4":{},"5":{},"7":{},"8":{},"21":{},"29":{},"31":{},"35":{},"44":{},"57":{},"60":{},"61":{}}}],["dataset",{"_index":343,"title":{},"description":{"56":{}}}],["deactiv",{"_index":172,"title":{},"description":{"8":{}}}],["dectri",{"_index":258,"title":{},"description":{"33":{}}}],["default",{"_index":109,"title":{},"description":{"3":{}}}],["definit",{"_index":3,"title":{"41":{},"42":{}},"description":{"0":{}}}],["depend",{"_index":219,"title":{},"description":{"25":{},"26":{}}}],["deriv",{"_index":47,"title":{},"description":{"0":{}}}],["detector",{"_index":63,"title":{"1":{},"2":{},"3":{},"6":{},"8":{},"9":{},"10":{},"27":{},"28":{},"40":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}},"description":{"1":{},"2":{},"3":{},"4":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"23":{},"25":{},"26":{},"27":{},"28":{},"33":{},"40":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}}}],["detector/statu",{"_index":277,"title":{},"description":{"40":{}}}],["develop",{"_index":37,"title":{},"description":{"0":{}}}],["devic",{"_index":265,"title":{"36":{}},"description":{}}],["distribut",{"_index":22,"title":{},"description":{"0":{}}}],["doesn't",{"_index":335,"title":{"54":{}},"description":{}}],["don't",{"_index":314,"title":{},"description":{"48":{},"51":{}}}],["done",{"_index":93,"title":{"5":{}},"description":{"1":{},"2":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"33":{}}}],["dure",{"_index":76,"title":{},"description":{"1":{},"9":{},"61":{}}}],["e.g",{"_index":344,"title":{},"description":{"56":{}}}],["each",{"_index":285,"title":{},"description":{"45":{}}}],["effect",{"_index":169,"title":{},"description":{"7":{},"9":{},"29":{}}}],["eiger",{"_index":261,"title":{},"description":{"33":{}}}],["ensur",{"_index":92,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{}}}],["error",{"_index":70,"title":{},"description":{"1":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"33":{}}}],["etc",{"_index":46,"title":{},"description":{"0":{}}}],["event",{"_index":273,"title":{"38":{}},"description":{"38":{}}}],["exampl",{"_index":300,"title":{},"description":{"48":{},"51":{}}}],["except",{"_index":25,"title":{},"description":{"0":{}}}],["execut",{"_index":83,"title":{},"description":{"1":{},"4":{},"5":{},"9":{}}}],["expect",{"_index":316,"title":{},"description":{"48":{},"51":{}}}],["experiment",{"_index":345,"title":{},"description":{"56":{}}}],["explicitli",{"_index":38,"title":{},"description":{"0":{}}}],["extend",{"_index":138,"title":{},"description":{"4":{},"5":{}}}],["extern",{"_index":127,"title":{},"description":{"4":{},"5":{}}}],["few",{"_index":85,"title":{},"description":{"1":{}}}],["file",{"_index":10,"title":{"13":{},"14":{}},"description":{"0":{}}}],["find",{"_index":204,"title":{"21":{}},"description":{"48":{},"51":{}}}],["finish",{"_index":143,"title":{},"description":{"5":{},"7":{}}}],["float",{"_index":334,"title":{"54":{}},"description":{}}],["format",{"_index":196,"title":{"17":{},"18":{},"19":{},"20":{},"52":{},"54":{},"56":{},"57":{},"58":{},"59":{}},"description":{}}],["fpga",{"_index":152,"title":{"25":{},"26":{},"36":{}},"description":{"7":{},"25":{},"26":{}}}],["fpga_statu",{"_index":266,"title":{},"description":{"36":{}}}],["frame",{"_index":156,"title":{},"description":{"7":{}}}],["full",{"_index":200,"title":{"20":{},"55":{}},"description":{"46":{},"49":{},"57":{}}}],["function",{"_index":88,"title":{},"description":{"1":{},"2":{}}}],["gap",{"_index":313,"title":{},"description":{"48":{},"51":{}}}],["gcc",{"_index":33,"title":{},"description":{"0":{}}}],["gener",{"_index":13,"title":{"25":{},"26":{},"43":{},"53":{},"54":{}},"description":{"0":{},"6":{},"25":{},"26":{},"29":{},"31":{}}}],["geometri",{"_index":346,"title":{},"description":{"56":{}}}],["given",{"_index":162,"title":{},"description":{"7":{}}}],["goe",{"_index":360,"title":{},"description":{"61":{}}}],["good",{"_index":298,"title":{},"description":{"47":{},"48":{},"50":{},"51":{}}}],["gpl",{"_index":6,"title":{},"description":{"0":{}}}],["gpl-3.0",{"_index":5,"title":{},"description":{"0":{}}}],["gracefulli",{"_index":165,"title":{},"description":{"7":{}}}],["happen",{"_index":211,"title":{},"description":{"25":{},"26":{}}}],["header",{"_index":32,"title":{},"description":{"0":{}}}],["here",{"_index":241,"title":{},"description":{"29":{},"31":{}}}],["high",{"_index":173,"title":{},"description":{"8":{}}}],["hour",{"_index":104,"title":{},"description":{"2":{}}}],["http",{"_index":247,"title":{},"description":{"29":{},"31":{}}}],["i.",{"_index":180,"title":{},"description":{"9":{},"51":{}}}],["id",{"_index":229,"title":{"37":{}},"description":{"27":{},"37":{}}}],["idl",{"_index":100,"title":{},"description":{"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"23":{},"25":{},"26":{},"33":{},"48":{},"49":{},"51":{}}}],["ignor",{"_index":248,"title":{},"description":{"29":{},"31":{},"48":{},"51":{}}}],["imag",{"_index":194,"title":{"17":{},"18":{},"25":{},"26":{},"39":{},"57":{},"58":{},"59":{},"60":{},"61":{}},"description":{"25":{},"26":{},"31":{},"37":{},"51":{},"57":{},"60":{},"61":{}}}],["image.cbor",{"_index":365,"title":{},"description":{"61":{}}}],["image_buffer/clear",{"_index":357,"title":{},"description":{"60":{}}}],["image_buffer/image.cbor",{"_index":350,"title":{},"description":{"57":{}}}],["image_buffer/image.jpeg",{"_index":353,"title":{},"description":{"58":{}}}],["image_buffer/image.tiff",{"_index":354,"title":{},"description":{"59":{}}}],["image_buffer/start.cbor",{"_index":347,"title":{},"description":{"56":{}}}],["image_buffer/statu",{"_index":366,"title":{},"description":{"61":{}}}],["image_pusher/statu",{"_index":276,"title":{},"description":{"39":{}}}],["immedi",{"_index":124,"title":{},"description":{"3":{}}}],["implement",{"_index":16,"title":{},"description":{"0":{}}}],["impos",{"_index":54,"title":{},"description":{"0":{}}}],["inact",{"_index":69,"title":{},"description":{"1":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"23":{},"27":{},"33":{}}}],["includ",{"_index":358,"title":{},"description":{"61":{}}}],["indefinit",{"_index":133,"title":{},"description":{"4":{},"5":{}}}],["index",{"_index":187,"title":{"11":{},"12":{}},"description":{}}],["inform",{"_index":151,"title":{"54":{}},"description":{"7":{}}}],["initi",{"_index":62,"title":{"1":{},"47":{},"50":{}},"description":{"1":{},"5":{},"46":{}}}],["instead",{"_index":80,"title":{},"description":{"1":{}}}],["instrument",{"_index":191,"title":{"15":{},"16":{}},"description":{}}],["integ",{"_index":214,"title":{},"description":{"25":{},"26":{},"51":{}}}],["integr",{"_index":106,"title":{"23":{},"24":{},"54":{}},"description":{"2":{},"48":{},"51":{}}}],["intend",{"_index":49,"title":{},"description":{"0":{}}}],["interact",{"_index":18,"title":{},"description":{"0":{}}}],["interfac",{"_index":43,"title":{},"description":{"0":{},"1":{}}}],["intern",{"_index":210,"title":{"25":{},"26":{}},"description":{"25":{},"26":{}}}],["ioctl",{"_index":45,"title":{},"description":{"0":{}}}],["jfjoch_brok",{"_index":368,"title":{"62":{}},"description":{}}],["jpeg",{"_index":351,"title":{"58":{}},"description":{}}],["jungfrau",{"_index":99,"title":{},"description":{"2":{},"40":{}}}],["jungfraujoch",{"_index":130,"title":{"35":{},"53":{},"54":{},"62":{}},"description":{"4":{},"27":{},"29":{},"31":{},"60":{},"61":{}}}],["kernel",{"_index":36,"title":{},"description":{"0":{}}}],["kernel'",{"_index":29,"title":{},"description":{"0":{}}}],["last",{"_index":283,"title":{},"description":{"44":{},"60":{}}}],["latest",{"_index":349,"title":{},"description":{"57":{}}}],["latter",{"_index":312,"title":{},"description":{"48":{},"51":{}}}],["librari",{"_index":35,"title":{},"description":{"0":{}}}],["licens",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["limit",{"_index":338,"title":{"54":{}},"description":{}}],["linux",{"_index":28,"title":{},"description":{"0":{}}}],["list",{"_index":228,"title":{"28":{}},"description":{"27":{}}}],["load",{"_index":208,"title":{"25":{},"26":{}},"description":{"25":{},"26":{}}}],["long",{"_index":105,"title":{},"description":{"2":{}}}],["make",{"_index":163,"title":{},"description":{"7":{}}}],["mask",{"_index":257,"title":{"33":{},"34":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}},"description":{"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}}}],["mean",{"_index":293,"title":{},"description":{"46":{},"49":{}}}],["mechan",{"_index":61,"title":{},"description":{"0":{}}}],["mere",{"_index":42,"title":{},"description":{"0":{}}}],["messag",{"_index":237,"title":{"56":{},"57":{}},"description":{"29":{},"31":{}}}],["metadata",{"_index":192,"title":{"15":{},"16":{},"31":{},"32":{}},"description":{"31":{},"56":{},"57":{}}}],["minut",{"_index":86,"title":{},"description":{"1":{}}}],["misbehav",{"_index":304,"title":{},"description":{"48":{},"51":{}}}],["mode",{"_index":306,"title":{},"description":{"48":{},"51":{}}}],["modul",{"_index":310,"title":{},"description":{"48":{},"51":{}}}],["module/storag",{"_index":286,"title":{},"description":{"45":{}}}],["moment",{"_index":259,"title":{},"description":{"33":{}}}],["more",{"_index":361,"title":{},"description":{"61":{}}}],["multipl",{"_index":225,"title":{},"description":{"27":{}}}],["need",{"_index":90,"title":{},"description":{"1":{},"2":{},"3":{},"48":{},"51":{}}}],["network",{"_index":59,"title":{},"description":{"0":{},"1":{},"7":{}}}],["new",{"_index":183,"title":{},"description":{"9":{}}}],["number",{"_index":215,"title":{},"description":{"25":{},"26":{}}}],["nxmx",{"_index":291,"title":{},"description":{"46":{},"48":{},"49":{},"51":{}}}],["on",{"_index":89,"title":{},"description":{"1":{},"2":{},"3":{},"9":{},"27":{}}}],["onc",{"_index":102,"title":{},"description":{"2":{}}}],["openapi",{"_index":14,"title":{},"description":{"0":{}}}],["oper",{"_index":74,"title":{},"description":{"1":{},"2":{},"9":{},"33":{},"61":{}}}],["option",{"_index":250,"title":{},"description":{"29":{}}}],["output",{"_index":195,"title":{"17":{},"18":{}},"description":{}}],["pedest",{"_index":79,"title":{"52":{}},"description":{"1":{},"2":{},"5":{},"7":{},"9":{}}}],["per",{"_index":103,"title":{},"description":{"2":{}}}],["period",{"_index":134,"title":{},"description":{"4":{},"5":{}}}],["pixel",{"_index":289,"title":{},"description":{"46":{},"47":{},"48":{},"49":{},"50":{},"51":{}}}],["plot",{"_index":332,"title":{"53":{},"54":{}},"description":{}}],["point",{"_index":262,"title":{},"description":{"33":{}}}],["possibl",{"_index":139,"title":{},"description":{"4":{},"5":{},"33":{}}}],["post",{"_index":78,"title":{},"description":{"1":{},"2":{}}}],["power",{"_index":178,"title":{},"description":{"8":{}}}],["prepar",{"_index":170,"title":{"8":{}},"description":{}}],["preview",{"_index":236,"title":{"29":{},"30":{},"58":{},"59":{}},"description":{"29":{}}}],["preview/pedestal.tiff",{"_index":330,"title":{},"description":{"52":{}}}],["preview/plot",{"_index":333,"title":{},"description":{"53":{}}}],["preview/plot.bin",{"_index":339,"title":{},"description":{"54":{}}}],["procedur",{"_index":135,"title":{},"description":{"4":{},"5":{},"9":{}}}],["process",{"_index":158,"title":{"22":{}},"description":{"7":{}}}],["program",{"_index":41,"title":{},"description":{"0":{}}}],["provid",{"_index":136,"title":{"54":{}},"description":{"4":{},"5":{},"27":{},"45":{}}}],["provis",{"_index":8,"title":{},"description":{"0":{}}}],["psi",{"_index":260,"title":{},"description":{"33":{}}}],["pub",{"_index":253,"title":{},"description":{"31":{}}}],["puls",{"_index":268,"title":{"37":{}},"description":{"37":{}}}],["pusher",{"_index":275,"title":{"39":{}},"description":{}}],["put",{"_index":249,"title":{},"description":{"29":{},"31":{}}}],["raw",{"_index":198,"title":{"19":{},"54":{}},"description":{"48":{},"51":{}}}],["raw/convert",{"_index":217,"title":{},"description":{"25":{},"26":{}}}],["readi",{"_index":113,"title":{},"description":{"3":{},"4":{}}}],["recommend",{"_index":77,"title":{},"description":{"1":{},"2":{}}}],["reconfigur",{"_index":75,"title":{},"description":{"1":{}}}],["record",{"_index":271,"title":{},"description":{"37":{}}}],["regardless",{"_index":55,"title":{},"description":{"0":{}}}],["region",{"_index":305,"title":{},"description":{"48":{},"51":{}}}],["region-of-interest",{"_index":227,"title":{},"description":{"27":{}}}],["reiniti",{"_index":232,"title":{},"description":{"27":{}}}],["replac",{"_index":363,"title":{},"description":{"61":{}}}],["request",{"_index":121,"title":{},"description":{"3":{},"29":{},"31":{}}}],["requir",{"_index":21,"title":{},"description":{"0":{},"4":{},"5":{},"25":{},"26":{},"27":{}}}],["respons",{"_index":231,"title":{},"description":{"27":{}}}],["result",{"_index":282,"title":{"55":{}},"description":{"44":{}}}],["result/scan",{"_index":341,"title":{},"description":{"55":{}}}],["retri",{"_index":142,"title":{},"description":{"4":{},"5":{}}}],["return",{"_index":123,"title":{"37":{},"38":{}},"description":{"3":{},"37":{},"38":{}}}],["roi",{"_index":278,"title":{"41":{},"42":{}},"description":{}}],["run",{"_index":101,"title":{"4":{},"7":{}},"description":{"2":{},"3":{},"5":{},"7":{},"21":{},"60":{},"61":{}}}],["runtim",{"_index":34,"title":{},"description":{"0":{}}}],["safeti",{"_index":140,"title":{},"description":{"4":{},"5":{}}}],["save",{"_index":184,"title":{},"description":{"9":{}}}],["scan",{"_index":340,"title":{"55":{}},"description":{}}],["script",{"_index":128,"title":{},"description":{"4":{},"5":{}}}],["see",{"_index":290,"title":{},"description":{"46":{},"49":{}}}],["select",{"_index":223,"title":{"27":{}},"description":{"28":{}}}],["send",{"_index":149,"title":{"6":{},"54":{}},"description":{}}],["sent",{"_index":160,"title":{},"description":{"7":{}}}],["separ",{"_index":287,"title":{},"description":{"45":{}}}],["server",{"_index":132,"title":{},"description":{"4":{},"5":{}}}],["set",{"_index":118,"title":{"11":{},"13":{},"14":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"58":{}},"description":{"3":{},"9":{},"25":{},"26":{},"27":{},"29":{},"31":{}}}],["shadow",{"_index":303,"title":{},"description":{"48":{},"51":{}}}],["shutter",{"_index":72,"title":{},"description":{"1":{},"2":{}}}],["sign",{"_index":328,"title":{},"description":{"51":{}}}],["similar",{"_index":26,"title":{},"description":{"0":{}}}],["single-channel",{"_index":325,"title":{},"description":{"51":{}}}],["size",{"_index":216,"title":{},"description":{"25":{},"26":{}}}],["slot",{"_index":362,"title":{},"description":{"61":{}}}],["socket",{"_index":240,"title":{"32":{}},"description":{"29":{},"31":{}}}],["socket_address",{"_index":245,"title":{},"description":{"29":{},"31":{}}}],["soft",{"_index":150,"title":{"6":{}},"description":{"6":{}}}],["soft/ttl",{"_index":115,"title":{},"description":{"3":{}}}],["softwar",{"_index":148,"title":{},"description":{"5":{}}}],["sole",{"_index":12,"title":{},"description":{"0":{}}}],["specif",{"_index":52,"title":{},"description":{"0":{}}}],["spirit",{"_index":27,"title":{},"description":{"0":{}}}],["spot",{"_index":203,"title":{"21":{}},"description":{"48":{},"51":{}}}],["stack",{"_index":309,"title":{},"description":{"48":{},"51":{}}}],["stage",{"_index":155,"title":{},"description":{"7":{},"61":{}}}],["standard",{"_index":292,"title":{},"description":{"46":{},"49":{}}}],["start",{"_index":108,"title":{"3":{},"56":{}},"description":{"3":{}}}],["state",{"_index":39,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"7":{},"8":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"20":{},"25":{},"26":{},"27":{},"33":{},"48":{},"49":{},"51":{}}}],["statist",{"_index":281,"title":{"43":{},"44":{},"45":{}},"description":{"43":{},"45":{}}}],["statistics/calibr",{"_index":288,"title":{},"description":{"45":{}}}],["statistics/data_collect",{"_index":284,"title":{},"description":{"44":{}}}],["statu",{"_index":264,"title":{"35":{},"36":{},"39":{},"40":{},"61":{}},"description":{"35":{},"40":{},"61":{}}}],["stop",{"_index":154,"title":{},"description":{"7":{},"48":{},"51":{}}}],["storag",{"_index":81,"title":{},"description":{"1":{}}}],["store",{"_index":319,"title":{},"description":{"48":{},"51":{}}}],["stream",{"_index":238,"title":{},"description":{"29":{},"31":{}}}],["structur",{"_index":243,"title":{},"description":{"29":{},"31":{}}}],["sub",{"_index":239,"title":{},"description":{"29":{}}}],["subject",{"_index":20,"title":{},"description":{"0":{}}}],["sure",{"_index":164,"title":{},"description":{"7":{}}}],["switch",{"_index":167,"title":{},"description":{"7":{}}}],["synchron",{"_index":147,"title":{},"description":{"5":{}}}],["syscal",{"_index":44,"title":{},"description":{"0":{}}}],["take",{"_index":166,"title":{},"description":{"7":{}}}],["term",{"_index":23,"title":{},"description":{"0":{}}}],["through",{"_index":58,"title":{},"description":{"0":{}}}],["tiff",{"_index":221,"title":{"26":{},"49":{},"50":{},"52":{},"59":{}},"description":{"26":{},"51":{}}}],["till",{"_index":129,"title":{},"description":{"4":{},"5":{}}}],["time",{"_index":84,"title":{},"description":{"1":{},"2":{},"4":{},"5":{},"7":{}}}],["timeout",{"_index":137,"title":{},"description":{"4":{},"5":{}}}],["transmit",{"_index":336,"title":{"54":{}},"description":{}}],["trigger",{"_index":116,"title":{"6":{}},"description":{"3":{},"6":{}}}],["true",{"_index":120,"title":{},"description":{"3":{}}}],["turn",{"_index":171,"title":{"8":{}},"description":{"8":{},"60":{}}}],["two",{"_index":66,"title":{},"description":{"1":{}}}],["under",{"_index":4,"title":{},"description":{"0":{}}}],["unsign",{"_index":318,"title":{},"description":{"48":{},"51":{}}}],["until",{"_index":112,"title":{},"description":{"3":{}}}],["updat",{"_index":97,"title":{},"description":{"2":{}}}],["upload",{"_index":280,"title":{"42":{},"48":{},"51":{}},"description":{"48":{},"51":{}}}],["us",{"_index":11,"title":{"54":{},"58":{}},"description":{"0":{},"1":{},"2":{},"3":{},"8":{},"28":{},"48":{},"51":{}}}],["user",{"_index":40,"title":{"47":{},"48":{},"50":{},"51":{}},"description":{"0":{},"47":{},"48":{},"50":{},"51":{}}}],["userspac",{"_index":31,"title":{},"description":{"0":{}}}],["valid",{"_index":329,"title":{},"description":{"51":{}}}],["valu",{"_index":294,"title":{"54":{}},"description":{"46":{},"48":{},"49":{},"51":{}}}],["version",{"_index":367,"title":{"62":{}},"description":{"62":{}}}],["via",{"_index":246,"title":{},"description":{"29":{},"31":{}}}],["volatil",{"_index":359,"title":{},"description":{"61":{}}}],["voltag",{"_index":174,"title":{},"description":{"8":{}}}],["wait",{"_index":126,"title":{"4":{},"5":{}},"description":{}}],["wait_till_don",{"_index":91,"title":{},"description":{"1":{},"2":{},"5":{}}}],["wait_until_run",{"_index":125,"title":{},"description":{"3":{},"4":{}}}],["web",{"_index":131,"title":{},"description":{"4":{},"5":{}}}],["well",{"_index":322,"title":{},"description":{"48":{},"51":{}}}],["whether",{"_index":56,"title":{},"description":{"0":{}}}],["wider",{"_index":51,"title":{},"description":{"0":{}}}],["without",{"_index":53,"title":{},"description":{"0":{}}}],["work",{"_index":48,"title":{},"description":{"0":{}}}],["writer",{"_index":161,"title":{"13":{},"14":{}},"description":{"7":{}}}],["x-axi",{"_index":337,"title":{"54":{}},"description":{}}],["x-ray",{"_index":71,"title":{},"description":{"1":{},"2":{},"9":{}}}],["xfel",{"_index":267,"title":{"37":{},"38":{}},"description":{"37":{},"38":{}}}],["xfel/event_cod",{"_index":274,"title":{},"description":{"38":{}}}],["xfel/pulse_id",{"_index":272,"title":{},"description":{"37":{}}}],["zeromq",{"_index":235,"title":{"29":{},"30":{},"31":{},"32":{}},"description":{"29":{},"31":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
index 291950ba..b9234e55 100644
--- a/docs/CHANGELOG.md
+++ b/docs/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 ## 1.0.0
+### 1.0.0-rc.154
+This is an UNSTABLE release. It includes many experimental features, as well as many AI generated fixes. We recommend using rc.152 for production use.
+
+* jfjoch_broker: Fix to TCP file pusher (remove kernel zero copy to improve reliability)
+
 ### 1.0.0-rc.153
 This is an UNSTABLE release. It includes many experimental features, as well as many AI generated fixes. We recommend using rc.152 for production use.
 
@@ -1011,4 +1016,4 @@ Bug fixes:
 * jfjoch_broker: Provide proper error when uploaded file is not a proper TIFF
 * jfjoch_action_test: enable HLS simulation
 
-Documentation improvement and placement in a dedicated directory
\ No newline at end of file
+Documentation improvement and placement in a dedicated directory
diff --git a/docs/conf.py b/docs/conf.py
index d5b883ba..bddd807b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -9,7 +9,7 @@
 project = 'Jungfraujoch'
 copyright = '2024, Paul Scherrer Institute'
 author = 'Filip Leonarski'
-release = '1.0.0-rc.153'
+release = '1.0.0-rc.154'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
diff --git a/docs/python_client/README.md b/docs/python_client/README.md
index 5dff536f..21e88d70 100644
--- a/docs/python_client/README.md
+++ b/docs/python_client/README.md
@@ -22,8 +22,8 @@ communicate through network calls or other mechanisms.
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0.0-rc.153
-- Package version: 1.0.0-rc.153
+- API version: 1.0.0-rc.154
+- Package version: 1.0.0-rc.154
 - Generator version: 7.20.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
diff --git a/fpga/hdl/action_config.v b/fpga/hdl/action_config.v
index 7b27a15c..d7ea37fe 100644
--- a/fpga/hdl/action_config.v
+++ b/fpga/hdl/action_config.v
@@ -10,7 +10,7 @@ localparam signed [31:0] INT32_MIN = 32'sh80000000;
 `define JFJOCH_FPGA_MAJOR_VERSION 8'd1
 `define JFJOCH_FPGA_MINOR_VERSION 8'd0
 `define JFJOCH_FPGA_PATCH_VERSION 8'd0
-`define JFJOCH_FPGA_PRERELEASE 64'h3335312E6372
+`define JFJOCH_FPGA_PRERELEASE 64'h3435312E6372
 
 `define GIT_SHA1 32'h
 `define MAX_MODULES_FPGA 32'd16
diff --git a/fpga/pcie_driver/dkms.conf b/fpga/pcie_driver/dkms.conf
index e0b05757..1ea2aaf5 100644
--- a/fpga/pcie_driver/dkms.conf
+++ b/fpga/pcie_driver/dkms.conf
@@ -1,5 +1,5 @@
 PACKAGE_NAME=jfjoch
-PACKAGE_VERSION=1.0.0-rc.153
+PACKAGE_VERSION=1.0.0-rc.154
 
 DEST_MODULE_LOCATION=/extra
 BUILT_MODULE_NAME=jfjoch
diff --git a/fpga/pcie_driver/install_dkms.sh b/fpga/pcie_driver/install_dkms.sh
index b6d0d4e6..de9b2b3c 100755
--- a/fpga/pcie_driver/install_dkms.sh
+++ b/fpga/pcie_driver/install_dkms.sh
@@ -2,7 +2,7 @@
 
 # Copyright (2019-2024) Paul Scherrer Institute
 
-VERSION=1.0.0-rc.153
+VERSION=1.0.0-rc.154
 
 mkdir -p /usr/src/jfjoch-${VERSION}/src
 cp dkms.conf /usr/src/jfjoch-${VERSION}
diff --git a/fpga/pcie_driver/jfjoch_drv.c b/fpga/pcie_driver/jfjoch_drv.c
index 54f91a98..8ae534db 100644
--- a/fpga/pcie_driver/jfjoch_drv.c
+++ b/fpga/pcie_driver/jfjoch_drv.c
@@ -12,7 +12,7 @@
 MODULE_AUTHOR("Filip Leonarski; Paul Scherrer Institute");
 MODULE_DESCRIPTION("Jungfraujoch device module");
 MODULE_LICENSE("GPL");
-MODULE_VERSION("1.0.0-rc.153");
+MODULE_VERSION("1.0.0-rc.154");
 
 #define PCI_DEV_ID_JUNGFRAUJOCH        (0x3450)
 
diff --git a/fpga/pcie_driver/postinstall.sh b/fpga/pcie_driver/postinstall.sh
index c1b69fa9..f8a9f78c 100644
--- a/fpga/pcie_driver/postinstall.sh
+++ b/fpga/pcie_driver/postinstall.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Taken from https://schneide.blog/2015/08/10/packaging-kernel-modulesdrivers-using-dkms/
 
-VERSION=1.0.0-rc.153
+VERSION=1.0.0-rc.154
 
 occurrences=`/usr/sbin/dkms status | grep jfjoch | grep ${VERSION} | wc -l`
 
diff --git a/fpga/pcie_driver/preuninstall.sh b/fpga/pcie_driver/preuninstall.sh
index 06c49080..b581acd3 100644
--- a/fpga/pcie_driver/preuninstall.sh
+++ b/fpga/pcie_driver/preuninstall.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Taken from https://schneide.blog/2015/08/10/packaging-kernel-modulesdrivers-using-dkms/
 
-VERSION=1.0.0-rc.153
+VERSION=1.0.0-rc.154
 
 /usr/sbin/dkms remove -m jfjoch -v ${VERSION} --all
 
diff --git a/frontend/package.json b/frontend/package.json
index 8d5a3ec3..3169b678 100644
--- a/frontend/package.json
+++ b/frontend/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jungfraujoch-frontend",
-  "version": "1.0.0-rc.153",
+  "version": "1.0.0-rc.154",
   "license": "GPL-3.0",
   "private": true,
   "homepage": "/frontend",
diff --git a/frontend/src/version.ts b/frontend/src/version.ts
index 416dfe51..5f68844f 100644
--- a/frontend/src/version.ts
+++ b/frontend/src/version.ts
@@ -1 +1 @@
-export const JFJOCH_VERSION : string = "1.0.0-rc.153";
\ No newline at end of file
+export const JFJOCH_VERSION : string = "1.0.0-rc.154";
\ No newline at end of file
-- 
2.52.0


From cdbd0b7bed5eae1d548d440fdbedb6db57c37ff4 Mon Sep 17 00:00:00 2001
From: Filip Leonarski <filip.leonarski@psi.ch>
Date: Thu, 25 Jun 2026 16:49:25 +0200
Subject: [PATCH 7/7] TCPStreamPusher: flush queued images before END so writer
 can't drop tail

Under load on the CI machine, the JFJochIntegrationTest_TCP_* tests
intermittently failed with the writer reporting fewer images than sent
(e.g. 4 of 5) and the DATA-ACK count short by one.

EndDataCollection sent the END frame as soon as it could acquire
send_mutex, without waiting for the per-connection WriterThread to drain
its queue. SendImage only enqueues; the WriterThread actually transmits
DATA frames. On a fast machine the queue is already empty when END is
sent, but on a loaded machine the WriterThread falls behind, END
overtakes the still-queued trailing image(s), the remote writer sees END
and finalizes, and the late DATA frame is silently dropped by
ProcessDataImage's Finalized case (no ACK emitted).

Fix: flush before END. WriterThread now drains the queue until the end
sentinel instead of bailing the moment c->active is cleared, and
EndDataCollection stops (and joins) the WriterThread before sending END.
Joining the writer is a race-free barrier: every image is on the wire
before END goes out.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---
 image_pusher/TCPStreamPusher.cpp | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/image_pusher/TCPStreamPusher.cpp b/image_pusher/TCPStreamPusher.cpp
index f4c9b5ac..371ac472 100644
--- a/image_pusher/TCPStreamPusher.cpp
+++ b/image_pusher/TCPStreamPusher.cpp
@@ -377,7 +377,12 @@ bool TCPStreamPusher::ReadExactPersistent(Connection& c, void* buf, size_t len)
 }
 
 void TCPStreamPusher::WriterThread(Connection* c) {
-    while (c->active) {
+    // Drain the queue until the end sentinel. We deliberately do NOT stop on c->active
+    // alone: StopDataCollectionThreads() clears active and then pushes the sentinel, and
+    // every DATA frame enqueued before that sentinel must still be sent. Otherwise END
+    // (sent by EndDataCollection after stopping this thread) could overtake images that
+    // are merely waiting in the queue, and the writer would finalize before receiving them.
+    while (true) {
         auto e = c->queue.GetBlocking();
         if (e.end)
             break;
@@ -944,6 +949,14 @@ bool TCPStreamPusher::EndDataCollection(const EndMessage& message) {
 
     for (auto& cptr : local_connections) {
         auto& c = *cptr;
+
+        // Flush all queued DATA before sending END: stopping the writer thread drains the
+        // send queue and joins it, so every image is on the wire before END goes out. This
+        // prevents END from overtaking images still waiting in the queue when the writer
+        // thread has fallen behind (e.g. on a loaded machine), which would make the remote
+        // writer finalize early and silently drop the trailing images.
+        StopDataCollectionThreads(c);
+
         if (c.broken) {
             ret = false;
             continue;
@@ -962,9 +975,6 @@ bool TCPStreamPusher::EndDataCollection(const EndMessage& message) {
             ret = false;
     }
 
-    for (auto& c : local_connections)
-        StopDataCollectionThreads(*c);
-
     {
         std::lock_guard lg(connections_mutex);
         session_connections.clear();
-- 
2.52.0