Merge branch '2411-NXmx-docs' into 'main'

version 1.0.0-rc.26 minor fixes

See merge request jungfraujoch/nextgendcu!102

.fpga_gitlab-ci.yml

@@ -1,329 +0,0 @@
-stages:
-  - build
-  - test
-  - synthesis
-  - release
-
-build:x86:gcc:
-  stage: build
-  variables:
-    CC: gcc
-    CXX: g++
-  tags:
-    - gcc
-    - x86
-  needs: []
-  script:
-    - mkdir build
-    - cd build
-    - source /opt/rh/gcc-toolset-12/enable 
-    - cmake -DCMAKE_BUILD_TYPE=Release ..
-    - make -j48
-
-build:x86:gcc_writer:
-  stage: build
-  variables:
-    CC: gcc
-    CXX: g++
-  tags:
-    - gcc
-    - x86
-  needs: []
-  script:
-    - mkdir build
-    - cd build
-    - source /opt/rh/gcc-toolset-12/enable
-    - cmake -DCMAKE_BUILD_TYPE=Release -DJFJOCH_WRITER_ONLY=ON ..
-    - make -j48
-
-build:x86:driver:
-  stage: build
-  variables:
-    CC: gcc
-    CXX: g++
-  tags:
-    - gcc
-    - x86
-  needs: []
-  script:
-    - cd fpga/pcie_driver
-    - make
-
-build:x86:python_client:
-  stage: build
-  needs: []
-  tags:
-    - python
-  script:
-    - cd python-client
-    - python3 setup.py sdist bdist_wheel
-    - mv dist/* ..
-  artifacts:
-    paths:
-      - jfjoch_client-*whl
-      - jfjoch_client-*tar.gz
-    expire_in: 1 week
-
-build:x86:vitis_hls:
-  stage: build
-  tags:
-    - x86
-  needs: []
-  rules:
-    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
-    - if: $CI_PIPELINE_SOURCE == "push"
-      changes:
-        - fpga/hls/*
-        - fpga/hdl/*
-        - fpga/scripts/*
-        - fpga/xdc/*
-        - fpga/microblaze/*
-        - fpga/include/jfjoch_fpga.h
-  script:
-    - source /opt/Xilinx/Vitis_HLS/2022.1/settings64.sh
-    - mkdir build
-    - cd build
-    - /usr/bin/cmake ..
-    - make hls
-
-build:x86:frontend:
-  stage: build
-  tags:
-    - x86
-  needs: []
-  script:
-    - mkdir build
-    - cd build
-    - /usr/bin/cmake ..
-    - make frontend
-    - cd ../frontend/dist
-    - tar czf ../../jfjoch_frontend.tar.gz *
-  artifacts:
-    paths:
-      - jfjoch_frontend.tar.gz
-    expire_in: 1 week
-
-build:x86:rpm:
-  stage: build
-  tags:
-    - x86
-  needs: []
-  script:
-    - mkdir build
-    - cd build
-    - source /opt/rh/gcc-toolset-12/enable
-    - cmake -DCMAKE_BUILD_TYPE=Release ..
-    - make frontend
-    - make -j48 package
-    - mv *.rpm ..
-  artifacts:
-    paths:
-      - "*.rpm"
-    expire_in: 1 week
-
-test:x86:gcc:
-  stage: test
-  timeout: 90m
-  variables:
-    CTEST_OUTPUT_ON_FAILURE: 1
-    CC: gcc
-    CXX: g++
-  needs: ["build:x86:gcc"]
-  dependencies: []
-  tags:
-    - gcc
-    - x86
-  script:
-    - source /opt/rh/gcc-toolset-12/enable 
-    - mkdir -p build
-    - cd build
-    - cmake -DCMAKE_BUILD_TYPE=Release ..
-    - make -j48 jfjoch_test HDF5DatasetWriteTest
-    - cd tests
-    - ./jfjoch_test -r junit -o report.xml
-    - cd ../tools
-    - ./HDF5DatasetWriteTest ../../tests/test_data/compression_benchmark.h5
-  artifacts:
-    expire_in: 1 week
-    reports:
-      junit: build/tests/report.xml
-
-test:x86:crystfel:
-  stage: test
-  timeout: 90m
-  variables:
-    CTEST_OUTPUT_ON_FAILURE: 1
-    CC: gcc
-    CXX: g++
-  needs: ["build:x86:gcc"]
-  dependencies: []
-  tags:
-    - gcc
-    - x86
-    - crystfel
-  script:
-    - source /opt/rh/gcc-toolset-12/enable 
-    - mkdir -p build
-    - cd build
-    - cmake -DCMAKE_BUILD_TYPE=Release ..
-    - make -j8 HDF5DatasetWriteTest
-    - cd ../tests/crystfel
-    - HDF5DATASET_WRITE_TEST_IMAGES_PER_FILE=0 ../../build/tools/HDF5DatasetWriteTest ../../tests/test_data/compression_benchmark.h5 10
-    - indexamajig -i writing_test.lst -g jf4m.geom -o x.stream --indexing=xgandalf
-
-test:x86:xds_durin:
-  stage: test
-  timeout: 90m
-  variables:
-    CTEST_OUTPUT_ON_FAILURE: 1
-    CC: gcc
-    CXX: g++
-  needs: ["build:x86:gcc"]
-  dependencies: []
-  tags:
-    - gcc
-    - x86
-    - xds
-  script:
-    - source /opt/rh/gcc-toolset-12/enable 
-    - mkdir -p build
-    - cd build
-    - cmake -DCMAKE_BUILD_TYPE=Release ..
-    - make -j8 HDF5DatasetWriteTest
-    - cd ../tests/xds_durin
-    - HDF5DATASET_WRITE_TEST_IMAGES_PER_FILE=0 ../../build/tools/HDF5DatasetWriteTest ../../tests/test_data/compression_benchmark.h5 25
-    - xds_par |grep -a1 ISa |tail -n1
-
-test:x86:xds_neggia:
-  stage: test
-  timeout: 90m
-  variables:
-    CTEST_OUTPUT_ON_FAILURE: 1
-    CC: gcc
-    CXX: g++
-  needs: ["build:x86:gcc"]
-  dependencies: []
-  tags:
-    - gcc
-    - x86
-    - xds
-  script:
-    - source /opt/rh/gcc-toolset-12/enable
-    - mkdir -p build
-    - cd build
-    - cmake -DCMAKE_BUILD_TYPE=Release ..
-    - make -j8 HDF5DatasetWriteTest
-    - cd ../tests/xds_neggia
-    - HDF5DATASET_WRITE_TEST_IMAGES_PER_FILE=0 ../../build/tools/HDF5DatasetWriteTest ../../tests/test_data/compression_benchmark.h5 25
-    - xds_par |grep -a1 ISa |tail -n1
-
-test:x86:xia2.ssx:
-  stage: test
-  timeout: 90m
-  variables:
-    CTEST_OUTPUT_ON_FAILURE: 1
-    CC: gcc
-    CXX: g++
-  needs: ["build:x86:gcc"]
-  dependencies: []
-  tags:
-    - gcc
-    - x86
-    - xds
-  script:
-    - source /opt/rh/gcc-toolset-12/enable 
-    - mkdir -p build
-    - mkdir -p dials_test
-    - cd build
-    - cmake -DCMAKE_BUILD_TYPE=Release ..
-    - make -j8 HDF5DatasetWriteTest
-    - cd ../dials_test
-    - ../build/tools/HDF5DatasetWriteTest ../tests/test_data/compression_benchmark.h5 100
-    - source /usr/local/dials-v3-17-0/dials_env.sh
-    - xia2.ssx image=writing_test_master.h5 space_group=P43212 unit_cell=78.551,78.551,36.914,90.000,90.000,90.000
-
-synthesis:vivado_pcie_100g:
-  stage: synthesis
-  dependencies: []
-  variables:
-    CC: gcc
-    CXX: g++
-  rules:
-    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
-    - if: $CI_PIPELINE_SOURCE == "push"
-      changes:
-        - fpga/hls/*
-        - fpga/hdl/*
-        - fpga/scripts/*
-        - fpga/xdc/*
-        - fpga/pcie_driver/jfjoch_fpga.h
-    - if: $CI_COMMIT_MESSAGE =~ /^FPGA/
-  allow_failure: true
-  tags:
-    - vivado
-  retry: 2
-  artifacts:
-    paths:
-      - "jfjoch_fpga_pcie_100g.mcs"
-    expire_in: 1 week
-  script:
-    - source /opt/rh/gcc-toolset-12/enable 
-    - source /opt/Xilinx/Vivado/2022.1/settings64.sh
-    - touch jfjoch_fpga_pcie_100g.mcs
-    - mkdir -p build
-    - cd build
-    - /usr/bin/cmake ..
-    - make -j4 pcie_100g
-    - mv fpga/jfjoch_fpga_pcie_100g.mcs ..
-  needs: ["build:x86:gcc", "test:x86:gcc"]
-
-synthesis:vivado_pcie_8x10g:
-  stage: synthesis
-  dependencies: []
-  variables:
-    CC: gcc
-    CXX: g++
-  rules:
-    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
-    - if: $CI_PIPELINE_SOURCE == "push"
-      changes:
-        - fpga/hls/*
-        - fpga/hdl/*
-        - fpga/scripts/*
-        - fpga/xdc/*
-        - fpga/pcie_driver/jfjoch_fpga.h
-    - if: $CI_COMMIT_MESSAGE =~ /^FPGA/
-  allow_failure: true
-  tags:
-    - vivado
-  retry: 2
-  artifacts:
-    paths:
-      - "jfjoch_fpga_pcie_8x10g.mcs"
-    expire_in: 1 week
-  script:
-    - source /opt/rh/gcc-toolset-12/enable
-    - source /opt/Xilinx/Vivado/2022.1/settings64.sh
-    - touch jfjoch_fpga_pcie_8x10g.mcs
-    - mkdir -p build
-    - cd build
-    - /usr/bin/cmake ..
-    - make -j4 pcie_8x10g
-    - mv fpga/jfjoch_fpga_pcie_8x10g.mcs ..
-  needs: [ "build:x86:gcc", "test:x86:gcc" ]
-
-release:
-  stage: release
-  rules:
-    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
-      when: manual
-  tags:
-    - x86
-  dependencies:
-    - synthesis:vivado_pcie_8x10g
-    - synthesis:vivado_pcie_100g
-    - build:x86:python_client
-    - build:x86:frontend
-    - build:x86:rpm
-  script:
-    - bash gitlab_upload_release.sh

.gitignore

@@ -1,3 +1,5 @@
 cmake-build-debug/
 cmake-build-release/
 build*/
+python-client/
+openapi-generator-cli.jar

.gitlab-ci.yml

@@ -1,6 +1,7 @@
 stages:
   - build
   - test
+  - synthesis
   - release
 
 build:x86:gcc:
@@ -54,13 +55,11 @@ build:x86:python_client:
   tags:
     - python
   script:
-    - cd python-client
-    - python3 setup.py sdist bdist_wheel
-    - mv dist/* ..
+    - bash gen_python_client.sh
   artifacts:
     paths:
       - jfjoch_client-*whl
-      - jfjoch_client-*tar.gz
+      - jfjoch-client-*tar.gz
     expire_in: 1 week
 
 build:x86:frontend:
@@ -115,11 +114,11 @@ test:x86:gcc:
     - mkdir -p build
     - cd build
     - cmake -DCMAKE_BUILD_TYPE=Release ..
-    - make -j48 jfjoch_test HDF5DatasetWriteTest
+    - make -j48 jfjoch_test jfjoch_hdf5_test
     - cd tests
     - ./jfjoch_test -r junit -o report.xml
     - cd ../tools
-    - ./HDF5DatasetWriteTest ../../tests/test_data/compression_benchmark.h5
+    - ./jfjoch_hdf5_test ../../tests/test_data/compression_benchmark.h5
   artifacts:
     expire_in: 1 week
     reports:
@@ -143,9 +142,9 @@ test:x86:crystfel:
     - mkdir -p build
     - cd build
     - cmake -DCMAKE_BUILD_TYPE=Release ..
-    - make -j8 HDF5DatasetWriteTest
+    - make -j8 jfjoch_hdf5_test
     - cd ../tests/crystfel
-    - HDF5DATASET_WRITE_TEST_IMAGES_PER_FILE=0 ../../build/tools/HDF5DatasetWriteTest ../../tests/test_data/compression_benchmark.h5 10
+    - ../../build/tools/jfjoch_hdf5_test ../../tests/test_data/compression_benchmark.h5 10
     - indexamajig -i writing_test.lst -g jf4m.geom -o x.stream --indexing=xgandalf
 
 test:x86:xds_durin:
@@ -166,9 +165,9 @@ test:x86:xds_durin:
     - mkdir -p build
     - cd build
     - cmake -DCMAKE_BUILD_TYPE=Release ..
-    - make -j8 HDF5DatasetWriteTest
+    - make -j8 jfjoch_hdf5_test
     - cd ../tests/xds_durin
-    - HDF5DATASET_WRITE_TEST_IMAGES_PER_FILE=0 ../../build/tools/HDF5DatasetWriteTest ../../tests/test_data/compression_benchmark.h5 25
+    - ../../build/tools/jfjoch_hdf5_test ../../tests/test_data/compression_benchmark.h5 25
     - xds_par |grep -a1 ISa |tail -n1
 
 test:x86:xds_neggia:
@@ -189,9 +188,9 @@ test:x86:xds_neggia:
     - mkdir -p build
     - cd build
     - cmake -DCMAKE_BUILD_TYPE=Release ..
-    - make -j8 HDF5DatasetWriteTest
+    - make -j8 jfjoch_hdf5_test
     - cd ../tests/xds_neggia
-    - HDF5DATASET_WRITE_TEST_IMAGES_PER_FILE=0 ../../build/tools/HDF5DatasetWriteTest ../../tests/test_data/compression_benchmark.h5 25
+    - ../../build/tools/jfjoch_hdf5_test ../../tests/test_data/compression_benchmark.h5 25
     - xds_par |grep -a1 ISa |tail -n1
 
 test:x86:xia2.ssx:
@@ -213,12 +212,84 @@ test:x86:xia2.ssx:
     - mkdir -p dials_test
     - cd build
     - cmake -DCMAKE_BUILD_TYPE=Release ..
-    - make -j8 HDF5DatasetWriteTest
+    - make -j8 jfjoch_hdf5_test
     - cd ../dials_test
-    - ../build/tools/HDF5DatasetWriteTest ../tests/test_data/compression_benchmark.h5 100
+    - ../build/tools/jfjoch_hdf5_test ../tests/test_data/compression_benchmark.h5 100
     - source /usr/local/dials-v3-17-0/dials_env.sh
     - xia2.ssx image=writing_test_master.h5 space_group=P43212 unit_cell=78.551,78.551,36.914,90.000,90.000,90.000
 
+synthesis:hls:
+  stage: synthesis
+  dependencies: []
+  variables:
+    CC: gcc
+    CXX: g++
+  rules:
+    - if: $CI_COMMIT_MESSAGE =~ /^FPGA/
+    - if: $CI_COMMIT_MESSAGE =~ /^HLS/
+  tags:
+    - vivado
+  script:
+    - source /opt/rh/gcc-toolset-12/enable
+    - source /opt/Xilinx/Vivado/2022.1/settings64.sh
+    - mkdir -p build
+    - cd build
+    - /usr/bin/cmake ..
+    - make hls
+  needs: ["build:x86:gcc", "test:x86:gcc"]
+
+synthesis:100g:
+  stage: synthesis
+  dependencies: []
+  retry: 2
+  variables:
+    CC: gcc
+    CXX: g++
+  allow_failure: true
+  rules:
+    - if: $CI_COMMIT_MESSAGE =~ /^FPGA/
+  tags:
+    - vivado
+  artifacts:
+    paths:
+      - "jfjoch_fpga_pcie_100g.mcs"
+    expire_in: 1 week
+  script:
+    - source /opt/rh/gcc-toolset-12/enable
+    - source /opt/Xilinx/Vivado/2022.1/settings64.sh
+    - mkdir -p build
+    - cd build
+    - /usr/bin/cmake ..
+    - make -j4 pcie_100g
+    - mv fpga/jfjoch_fpga_pcie_100g.mcs ..
+  needs: ["build:x86:gcc", "test:x86:gcc"]
+
+synthesis:8x10g:
+  stage: synthesis
+  dependencies: []
+  variables:
+    CC: gcc
+    CXX: g++
+  retry: 2
+  allow_failure: true
+  rules:
+    - if: $CI_COMMIT_MESSAGE =~ /^FPGA/
+  tags:
+    - vivado
+  artifacts:
+    paths:
+      - "jfjoch_fpga_pcie_8x10g.mcs"
+    expire_in: 1 week
+  script:
+    - source /opt/rh/gcc-toolset-12/enable
+    - source /opt/Xilinx/Vivado/2022.1/settings64.sh
+    - mkdir -p build
+    - cd build
+    - /usr/bin/cmake ..
+    - make -j4 pcie_8x10g
+    - mv fpga/jfjoch_fpga_pcie_8x10g.mcs ..
+  needs: [ "build:x86:gcc", "test:x86:gcc" ]
+
 release:
   stage: release
   rules:
@@ -230,10 +301,20 @@ release:
   dependencies:
     - build:x86:frontend
     - build:x86:rpm
+    - build:x86:python_client
   script:
-    - cd python-client
-    - python3 setup.py sdist bdist_wheel
-    - twine upload dist/* -u __token__ -p $CI_PYPI_TOKEN --skip-existing
-    - mv dist/* ..
-    - cd ..
     - bash gitlab_upload_release.sh
+
+deploy-pages:
+  stage: release
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      when: manual
+  script:
+    bash make_doc.sh
+  artifacts:
+    paths:
+      - public/
+  tags:
+    - x86
+    - python

.miv_gitlab-ci.yml

@@ -1,42 +0,0 @@
-stages:
-  - mirror
-  - build
-  - publish
-
-
- 
-mirror-psi:
-  stage: mirror
-  tags:
-    - docker-shared
-  script:
-    - SOURCE_REPOSITORY=https://$PSI_PROJECT_GIT_USRNAME:$PSI_PROJECT_GIT_TOKEN@gitlab.psi.ch/jungfraujoch/nextgendcu.git
-    - DESTINATION_REPOSITORY=https://$MIV_PROJECT_GIT_USRNAME:$MIV_PROJECT_GIT_TOKEN@gitlab.maxiv.lu.se/jungfraujoch/nextgendcu.git
-    - GIT_USER_NAME=git
-    - GIT_USER_EMAIL=git@maxiv.lu.se
-    - rm -rf _mirror_repo_tmp
-    - git clone --mirror $SOURCE_REPOSITORY _mirror_repo_tmp
-    - cd _mirror_repo_tmp
-    - git config --local user.name "${GIT_USER_NAME}"
-    - git config --local user.email "${GIT_USER_EMAIL}"
-    - git remote remove origin
-    - git remote add origin $DESTINATION_REPOSITORY
-    - git push --prune --all
-    - git push --prune --tags
-  after_script:
-    - rm -rf _mirror_repo_tmp
-  rules:
-    - if: '$CI_PIPELINE_SOURCE != "schedule" && $CI_PIPELINE_SOURCE != "trigger"'
-      when: never
-    - if: '$MODE != "sync"'
-      when: never
-    - when: always
-
-
-include:
-  - project: 'kits-maxiv/cfg-maxiv-gitlabci'
-    file: '/Docker.gitlab-ci.yml'
-
-variables:
-  DOCKER_REGISTRY: "harbor.maxiv.lu.se/daq"
-  GIT_SUBMODULE_STRATEGY: recursive

.readthedocs.yaml

@@ -0,0 +1,30 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+
+python:
+   install:
+     - requirements: docs/requirements.txt

LICENSE

@@ -0,0 +1,685 @@
+Jungfraujoch software is licensed with GPLv3 license.
+Jungfraujoch FPGA is licensed with CERN OHL-S license (see fpga/LICENSE).
+
+GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
+
+
+================
+
+As a special exception, we specifically permit linking Jungfraujoch code with Nvidia CUDA libraries.
+
+We also permit to link Jungfraujoch software (GPLv3) with Jungfraujoch high-level synthesis code (CERN OHL 2.0) for the purpose
+of simulating FPGA design on CPU.

README.md

@@ -2,110 +2,4 @@
 
 Application to receive data from the PSI JUNGFRAU and EIGER detectors.
 
-Citation: F. Leonarski, M. Bruckner, C. Lopez-Cuenca, A. Mozzanica, H.-C. Stadler, Z. Matej, A. Castellane, B. Mesnet, J. Wojdyla, B. Schmitt and M. Wang "Jungfraujoch: hardware-accelerated data-acquisition system for kilohertz pixel-array X-ray detectors" (2023), J. Synchrotron Rad., 30, 227-234 [doi:10.1107/S1600577522010268](https://doi.org/10.1107/S1600577522010268).
-
-The project is supported by :
-* Innosuisse via Innovation Project "NextGenDCU high data rate acquisition system for X-ray detectors in structural biology applications" (101.535.1 IP-ENG; Apr 2023 - Sep 2025).
-* ETH Domain via Open Research Data Contribute project (Jan - Dec 2023)
-* AMD University Program with donation of licenses of Ethernet IP cores and Vivado software
-
-## License
-
-Operating Jungfraujoch requires license from the Paul Scherrer Institute.
-
-Specifically, non-profit research facilities operating PSI JUNGFRAU and PSI EIGER detectors are granted the license to use the 
-code and binary images within their facilities, as well as to modify the code according to their needs.
-
-Sharing the code requires explicit permission from the Paul Scherrer Institute.
-
-## Compatible detectors
-Currently, Jungfraujoch supports PSI JUNGFRAU and PSI EIGER detectors.
-
-## Hardware requirements
-See [hardware requirements](HARDWARE.md) documentation.
-
-## FPGA bitstream
-Instructions see [here](fpga/README.md)
-
-## Detector
-Jungfraujoch supports PSI JUNGFRAU and EIGER detectors. Jungfruajoch controls the detector via statically compiled `slsDetectorPackage` into its source code.
-It is important that detector firmware has to match `slsDetectorPackage` version used in Jungfraujoch (8.0.2 at the moment).
-See [PSI Detector group website](https://www.psi.ch/en/lxn/software-releases) for details.
-
-## Operating system
-Recommended operating system is Red Hat Enterprise Linux (RHEL) / Rocky Linux versions 8. 
-For this operating system we provide RPMs with pre-built binaries to simplify deployment.
-
-We do also operate one of the systems with Rocky 9 without issues.
-Running Jungfraujoch on Red Hat Enterprise Linux 7 is currently not tested and not recommended, 
-but likely possible with providing some packages from external repositories. 
-There are some limited tests with recent Ubuntu and Fedora distributions, though these are not systematic. 
-Other linux platforms should work, but no tests were done so far.
- 
-### Software dependencies
-Required:
-* C++20 compiler and C++20 standard library; recommended GCC 11+ or clang 14+ (Intel OneAPI, AMD AOCC)
-* CMake version 3.21 or newer + GNU make tool
-* zlib compression library
-
-Optional:
-* CUDA compiler version 11 or newer - required for MX fast feedback indexer
-* NUMA library - to pin threads to nodes/CPUs
-* Node.js - to make frontend
-
-Automatically downloaded by CMake and statically linked: 
-* SLS Detector Package - see [github.com/slsdetectorgroup/slsDetectorPackage](https://github.com/slsdetectorgroup/slsDetectorPackage)
-* Zstandard (Facebook) - see [github.com/facebook/zstd](https://github.com/facebook/zstd)
-* Pistache webserver  - see [github.com/pistacheio/pistache](https://github.com/pistacheio/pistache)
-* Fast feedback indexer (Hans-Christian Stadler, PSI) - see [github.com/paulscherrerinstitute/fast-feedback-indexer](https://github.com/paulscherrerinstitute/fast-feedback-indexer)
-* Catch2 testing library - see [github.com/catchorg/Catch2](https://github.com/catchorg/Catch2)
-* HDF5 library - see [github.com/HDFGroup/hdf5](https://github.com/HDFGroup/hdf5)
-* TIFF library - see [gitlab.com/libtiff/libtiff](https://gitlab.com/libtiff/libtiff)
-
-Please follow the link provided above to check for LICENSE file. Building code with dependencies above requires access from the build system to github.com.
-
-Directly included in the repository:
-* JSON parser/writer from N. Lohmann - see [github.com/nlohmann/json](https://github.com/nlohmann/json)
-* Xilinx arbitrary precision arithmetic headers - see [github.com/Xilinx/HLS_arbitrary_Precision_Types](https://github.com/Xilinx/HLS_arbitrary_Precision_Types)
-* Bitshuffle filter from K. Masui - see [github.com/kiyo-masui/bitshuffle](https://github.com/kiyo-masui/bitshuffle)
-* Fast replacement for Bitshuffle pre-compression filter (Kal Cutter, DECTRIS)  - see [github.com/kalcutter/bitshuffle](https://github.com/kalcutter/bitshuffle)
-* Tinycbor (Intel) - see [github.com/intel/tinycbor](https://github.com/intel/tinycbor)
-* LZ4 compression by Y.Collet - see [github.com/lz4/lz4](https://github.com/lz4/lz4)
-* Spdlog logging library - see [github.com/gabime/spdlog](https://github.com/gabime/spdlog)
-* ZeroMQ library (through slsDetectorPackage) - see [github.com/zeromq/libzmq](https://github.com/zeromq/libzmq)
-
-For license check LICENSE file in respective directory
-
-## Installation guide
-Follow [Installation guide](INSTALL.md).
-
-### Software components
-
-* `jfjoch_broker` in `broker` - main service running on the Jungfraujoch server, responsible for control of the detector and data acquisition;
-  Example configuration `jfjoch_broker` for the modules is given in configuration files present in `etc` directory. See [details](broker/README.md).
-* `jfjoch_writer` in `writer` - HDF5 writer; HDF5 writer is designed to work on the same or separate server system. It has rather limited requirements in terms of performance and memory.
-  The goal is to separate data acquisition node with custom FPGA hardware and file system node with stronger security/stability requirements. See [details](writer/README.md).
-
-## Web Frontend
-Jungfraujoch is equipped with React-based web frontend for user-friendly experience. Frontend has the following options:
-* Presenting current state of the detector
-* Plotting results of online quality calculations
-* Showing live view images from the detector
-* JUNGFRAU calibration numbers
-* Configuring the detector, as well as pedestal/initialization operations
-
-Frontend is written in TypeScript. For details see [frontend/](frontend) directory.
-
-## OpenAPI python client
-Jungfraujoch is controlled with HTTP/REST interface defined with an OpenAPI specification. For convenience, we provide Python client in [python_client](python_client/) directory.
-
-## Tests
- 
-Automated test routine is then accessible as `tests/jfjoch_test`. There are also benchmark routines:
-
-* `HDF5DatasetWriteTest` to measure HDF5 dataset writing speed (single threaded)
-* `jfjoch_spot_finding_test` to apply spot finding and indexing routines in Jungfraujoch to an example dataset - this is equivalent to FPGA spot finding algorithm, but NOT performance equivalent as it is particularly not-efficient
-* `jfjoch_action_test` to test quality/performance of FPGA card(s) and software routines
-
-In addition, tests are executed to verify that datasets written by Jungfraujoch are readable with XDS Durin plugin, XDS Neggia plygin and CrystFEL. 
-Input files for these programs are placed in `xds_durin`, `xds_neggia` and `crystfel` folders. See `.gitlab-ci.yml` for details.
+All documentation is now placed in [docs/](docs/) subdirectory.

VERSION

@@ -1 +1 @@
-1.0.0-rc.21
+1.0.0-rc.26

acquisition_device/AcquisitionCounters.cpp

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #include <thread>
 
@@ -10,7 +11,7 @@ AcquisitionCounters::AcquisitionCounters()
         total_packets(0), expected_frames(0), acquisition_finished(false) {}
 
 void AcquisitionCounters::Reset(const DiffractionExperiment &experiment, uint16_t data_stream) {
-    std::unique_lock<std::shared_mutex> ul(m);
+    std::unique_lock ul(m);
     acquisition_finished = false;
 
     slowest_frame_number = 0;
@@ -21,7 +22,7 @@ void AcquisitionCounters::Reset(const DiffractionExperiment &experiment, uint16_
         (experiment.GetDetectorMode() == DetectorMode::PedestalG2))
         expected_frames = experiment.GetFrameNum();
     else
-        expected_frames = experiment.GetImageNum();
+        expected_frames =  experiment.GetFrameNum() / experiment.GetFPGASummation();
 
     nmodules = experiment.GetModulesNum(data_stream);
     if (nmodules > max_modules)
@@ -35,11 +36,18 @@ void AcquisitionCounters::Reset(const DiffractionExperiment &experiment, uint16_
     saved_completions = std::vector<Completion>(expected_frames * nmodules);
     packets_per_module = std::vector<uint64_t>(nmodules);
     total_packets = 0;
-    expected_packets_per_module = 256 * experiment.GetSummation();
+    expected_packets_per_module = 512 * experiment.GetFPGASummation();
+
+    if (experiment.GetByteDepthReadout() == 4)
+        bytes_per_packet = 4096LU;
+    else if (experiment.GetByteDepthReadout() == 1)
+        bytes_per_packet = 1024LU; // Need to seriously refactor, to have expected_packets_per_module specific for detector
+    else
+        bytes_per_packet = 2048LU;
 }
 
 void AcquisitionCounters::UpdateCounters(const Completion *c) {
-    std::unique_lock<std::shared_mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (c->module_number >= nmodules)
         throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
@@ -75,7 +83,7 @@ void AcquisitionCounters::UpdateCounters(const Completion *c) {
 }
 
 void AcquisitionCounters::SetAcquisitionFinished() {
-    std::unique_lock<std::shared_mutex> ul(m);
+    std::unique_lock ul(m);
     acquisition_finished = true;
     data_updated.notify_all();
 }
@@ -92,7 +100,7 @@ uint64_t AcquisitionCounters::GetBufferHandle(size_t frame, uint16_t module_numb
 }
 
 uint64_t AcquisitionCounters::GetBufferHandleAndClear(size_t frame, uint16_t module_number) {
-    std::unique_lock<std::shared_mutex> ul(m);
+    std::unique_lock ul(m);
     if (frame >= expected_frames)
         throw JFJochException(JFJochExceptionCategory::ArrayOutOfBounds,
                               "GetBufferHandleAndClear Wrong frame number: " + std::to_string(frame));
@@ -106,7 +114,7 @@ uint64_t AcquisitionCounters::GetBufferHandleAndClear(size_t frame, uint16_t mod
 }
 
 uint64_t AcquisitionCounters::GetPedestalBufferHandle(size_t storage_cell, uint16_t module_number) const {
-    std::unique_lock<std::shared_mutex> ul(m);
+    std::unique_lock ul(m);
     if (storage_cell >= 16)
         throw JFJochException(JFJochExceptionCategory::ArrayOutOfBounds,
                               "GetBufferHandleAndClear Wrong frame number: " + std::to_string(storage_cell));
@@ -134,6 +142,8 @@ uint64_t AcquisitionCounters::GetFastestFrameNumber() const {
 
 void AcquisitionCounters::WaitForFrame(size_t curr_frame, uint16_t module_number) const {
     uint64_t slowest_head_tmp = (module_number == UINT16_MAX) ? GetSlowestFrameNumber() : GetCurrFrameNumber(module_number);
+    if (curr_frame == 0)
+        curr_frame = 1; // Cannot wait for frame 0, as this is initial value of slowest frame number, so waiting for frame 1 in this case
     while (!acquisition_finished && (slowest_head_tmp < curr_frame)) {
         std::this_thread::sleep_for(std::chrono::microseconds(100));
         slowest_head_tmp = (module_number == UINT16_MAX) ? GetSlowestFrameNumber() : GetCurrFrameNumber(module_number);
@@ -187,7 +197,7 @@ uint64_t AcquisitionCounters::GetTotalPackets() const {
 }
 
 uint64_t AcquisitionCounters::GetTotalPackets(uint16_t module_number) const {
-    std::unique_lock<std::shared_mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (module_number >= nmodules)
         throw JFJochException(JFJochExceptionCategory::ArrayOutOfBounds,
@@ -207,3 +217,7 @@ uint64_t AcquisitionCounters::GetExpectedPacketsPerModule() const {
 uint64_t AcquisitionCounters::GetModuleNumber() const {
     return nmodules;
 }
+
+uint64_t AcquisitionCounters::GetBytesReceived() const {
+    return GetTotalPackets() * bytes_per_packet;
+}

acquisition_device/AcquisitionCounters.h

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #ifndef JUNGFRAUJOCH_ACQUISITIONCOUNTERS_H
 #define JUNGFRAUJOCH_ACQUISITIONCOUNTERS_H
@@ -36,6 +37,7 @@ class AcquisitionCounters {
     bool acquisition_finished;
     uint64_t expected_frames;
     uint64_t nmodules = max_modules;
+    uint64_t bytes_per_packet;
 
 public:
     static constexpr const uint64_t HandleNotFound = UINT64_MAX;
@@ -61,6 +63,7 @@ public:
 
     uint64_t GetTotalPackets() const;
     uint64_t GetTotalPackets(uint16_t module_number) const;
+    uint64_t GetBytesReceived() const;
 
     uint64_t GetExpectedPackets() const;
     uint64_t GetExpectedPacketsPerModule() const;

acquisition_device/AcquisitionDevice.cpp

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #ifdef JFJOCH_USE_NUMA
 #include <numaif.h>
@@ -52,7 +53,7 @@ void AcquisitionDevice::StartAction(const DiffractionExperiment &experiment, uin
                               "Number of modules exceeds max possible for FPGA"));
 
     counters.Reset(experiment, data_stream);
-    expected_frames = experiment.GetFrameNum() / experiment.GetSummation();
+    expected_frames = experiment.GetFrameNum() / experiment.GetFPGASummation();
 
     // Ensure internal WR queue is empty
     work_request_queue.Clear();
@@ -131,7 +132,7 @@ void AcquisitionDevice::SendWorkRequest(uint32_t handle) {
 }
 
 uint64_t AcquisitionDevice::GetBytesReceived() const {
-    return counters.GetTotalPackets() * 4096LU;
+    return counters.GetBytesReceived();
 }
 
 const DeviceOutput *AcquisitionDevice::GetDeviceOutput(size_t frame_number, uint16_t module_number) const {
@@ -168,6 +169,8 @@ void AcquisitionDevice::InitializeSpotFinderResolutionMap(const float *data, siz
 
 void AcquisitionDevice::InitializeROIMap(const uint16_t *map, size_t module_number) {}
 
+void AcquisitionDevice::InitializePixelMask(const uint32_t *module_mask, size_t module_number) {}
+
 void AcquisitionDevice::InitializeROIMap(const DiffractionExperiment& experiment) {
     std::vector<uint16_t> tmp(RAW_MODULE_SIZE);
     auto offset = experiment.GetFirstModuleOfDataStream(data_stream);
@@ -178,6 +181,13 @@ void AcquisitionDevice::InitializeROIMap(const DiffractionExperiment& experiment
     }
 }
 
+void AcquisitionDevice::InitializePixelMask(const DiffractionExperiment &experiment, const PixelMask &mask) {
+    auto offset = experiment.GetFirstModuleOfDataStream(data_stream);
+    size_t modules = experiment.GetModulesNum(data_stream);
+    for (int m = 0; m < modules; m++)
+        InitializePixelMask(mask.GetMaskRaw().data() + RAW_MODULE_SIZE * (offset + m), m);
+}
+
 void AcquisitionDevice::MapBuffersStandard(size_t c2h_buffer_count, int16_t numa_node) {
     try {
         for (int i = 0; i < c2h_buffer_count; i++)
@@ -278,6 +288,7 @@ void AcquisitionDevice::RunInternalGenerator(const DiffractionExperiment &experi
             break;
         case DetectorType::EIGER:
             config.detector_type = SLS_DETECTOR_TYPE_EIGER;
+            config.eiger_bit_depth = experiment.GetByteDepthReadout() * 8;
             break;
     }
     HW_RunInternalGenerator(config);

acquisition_device/AcquisitionDevice.h

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #ifndef JUNGFRAUJOCH_ACQUISITIONDEVICE_H
 #define JUNGFRAUJOCH_ACQUISITIONDEVICE_H
@@ -11,6 +12,7 @@
 #include "../common/Definitions.h"
 #include "../common/DiffractionExperiment.h"
 #include "../common/Logger.h"
+#include "../common/PixelMask.h"
 
 #include "../common/ThreadSafeFIFO.h"
 #include "../jungfrau/JFCalibration.h"
@@ -94,6 +96,8 @@ public:
     virtual void InitializeIntegrationMap(const uint16_t *map, const float *weights, size_t module_number);
     virtual void InitializeSpotFinderResolutionMap(const float *data, size_t module_number);
     virtual void InitializeROIMap(const uint16_t *map, size_t module_number);
+    void InitializePixelMask(const DiffractionExperiment &experiment, const PixelMask &mask);
+    virtual void InitializePixelMask(const uint32_t *module_mask, size_t module_number);
     void InitializeROIMap(const DiffractionExperiment &experiment);
 
     const AcquisitionCounters& Counters() const;

acquisition_device/AcquisitionDeviceGroup.cpp

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #include "AcquisitionDeviceGroup.h"
 #include "PCIExpressDevice.h"

acquisition_device/AcquisitionDeviceGroup.h

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #ifndef JUNGFRAUJOCH_ACQUISITIONDEVICEGROUP_H
 #define JUNGFRAUJOCH_ACQUISITIONDEVICEGROUP_H

acquisition_device/Completion.cpp

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #include "Completion.h"
 #include "../common/Definitions.h"

acquisition_device/Completion.h

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #ifndef JUNGFRAUJOCH_COMPLETION_H
 #define JUNGFRAUJOCH_COMPLETION_H

acquisition_device/FPGAAcquisitionDevice.cpp

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #include <random>
 #include "FPGAAcquisitionDevice.h"
@@ -135,6 +136,14 @@ void FPGAAcquisitionDevice::InitializeROIMap(const uint16_t *map, size_t module_
     LoadCalibration(0);
 }
 
+void FPGAAcquisitionDevice::InitializePixelMask(const uint32_t *module_mask, size_t module_number) {
+    memcpy(buffer_device[0]->pixels, module_mask, RAW_MODULE_SIZE * sizeof(uint32_t));
+    buffer_device[0]->module_statistics.module_number = module_number;
+    buffer_device[0]->module_statistics.load_calibration_destination = LOAD_CALIBRATION_DEST_PXL_MASK;
+    LoadCalibration(0);
+}
+
+
 void FPGAAcquisitionDevice::InitializeCalibration(const DiffractionExperiment &experiment, const JFCalibration &calib) {
     auto offset = experiment.GetFirstModuleOfDataStream(data_stream);
 
@@ -215,7 +224,7 @@ void FPGAAcquisitionDevice::FillActionRegister(const DiffractionExperiment& x, D
     job.energy_kev          = x.GetPhotonEnergyForConversion_keV();
     job.nstorage_cells      = x.GetStorageCellNumber() - 1;
     job.mode                = data_collection_id << 16;
-    job.nsummation          = x.GetSummation() - 1;
+    job.nsummation          = x.GetFPGASummation() - 1;
 
     expected_descriptors_per_module = DMA_DESCRIPTORS_PER_MODULE;
 
@@ -228,8 +237,18 @@ void FPGAAcquisitionDevice::FillActionRegister(const DiffractionExperiment& x, D
     if (!x.IsPixelSigned())
         job.mode |= MODE_UNSIGNED;
 
-    if (x.GetByteDepthImage() == 4)
-        job.mode |= MODE_32BIT;
+    if (x.GetEigerBitDepth() == 32)
+        job.mode |= MODE_EIGER_32BIT;
+    else if (x.GetEigerBitDepth() == 8)
+        job.mode |= MODE_EIGER_8BIT;
+
+    if (x.GetByteDepthFPGA() == 4)
+        job.mode |= MODE_32BIT_OUTPUT;
+    if (x.GetByteDepthFPGA() == 1)
+        job.mode |= MODE_8BIT_OUTPUT;
+
+    if (x.IsApplyPixelMask())
+        job.mode |= MODE_APPLY_PIXEL_MASK;
 
     if (x.GetLossyCompressionPoisson()) {
         job.mode |= MODE_SQROOT;
@@ -281,4 +300,4 @@ uint32_t FPGAAcquisitionDevice::GetExpectedDescriptorsPerModule() const {
 
 void FPGAAcquisitionDevice::LoadCalibration(uint32_t handle) {
     HW_LoadCalibration(LoadCalibrationConfig{.handle = handle});
-}
+}

acquisition_device/FPGAAcquisitionDevice.h

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #ifndef JUNGFRAUJOCH_FPGAACQUISITIONDEVICE_H
 #define JUNGFRAUJOCH_FPGAACQUISITIONDEVICE_H
@@ -44,6 +45,7 @@ public:
     void InitializeIntegrationMap(const uint16_t *map, const float *weights, size_t module_number) override;
     void InitializeSpotFinderResolutionMap(const float *data, size_t module_number) override;
     void InitializeROIMap(const uint16_t *map, size_t module_number) override;
+    void InitializePixelMask(const uint32_t *module_mask, size_t module_number) override;
     void SetInternalGeneratorFrame(const uint16_t *input, size_t module_number) override;
     uint32_t GetExpectedDescriptorsPerModule() const override;
 };

acquisition_device/HLSSimulatedDevice.cpp

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #include "HLSSimulatedDevice.h"
 
@@ -19,12 +20,12 @@ HLSSimulatedDevice::HLSSimulatedDevice(uint16_t data_stream, size_t in_frame_buf
 }
 
 void HLSSimulatedDevice::CreateFinalPacket(const DiffractionExperiment& experiment) {
-    device->CreateFinalPacket(experiment);
+    device->CreateFinalPacket();
 }
 
 void HLSSimulatedDevice::CreateJFPacket(const DiffractionExperiment& experiment, uint64_t frame_number, uint32_t eth_packet,
                                         uint32_t module_number, const uint16_t *data, int8_t adjust_axis, uint8_t user) {
-    device->CreateJFPacket(experiment, frame_number, eth_packet, module_number, data, adjust_axis, user);
+    device->CreateJFPacket(frame_number, eth_packet, module_number, data, adjust_axis, user);
 }
 
 void HLSSimulatedDevice::CreateJFPackets(const DiffractionExperiment& experiment, uint64_t frame_number_0, uint64_t frames,
@@ -38,7 +39,7 @@ void HLSSimulatedDevice::CreateJFPackets(const DiffractionExperiment& experiment
 void HLSSimulatedDevice::CreateEIGERPacket(const DiffractionExperiment &experiment, uint64_t frame_number,
                                            uint32_t eth_packet, uint32_t module_number, uint32_t col, uint32_t row,
                                            const uint16_t *data) {
-    device->CreateEIGERPacket(experiment, frame_number, eth_packet, module_number, col, row, data);
+    device->CreateEIGERPacket(frame_number, eth_packet, module_number, col, row, data);
 }
 
 void HLSSimulatedDevice::HW_ReadActionRegister(DataCollectionConfig *job) {
@@ -50,7 +51,7 @@ void HLSSimulatedDevice::HW_WriteActionRegister(const DataCollectionConfig *job)
 }
 
 void HLSSimulatedDevice::FPGA_StartAction(const DiffractionExperiment &experiment) {
-    device->FPGA_StartAction(experiment);
+    device->FPGA_StartAction();
 }
 
 void HLSSimulatedDevice::HW_RunInternalGenerator(const FrameGeneratorConfig &config) {

acquisition_device/HLSSimulatedDevice.h

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #ifndef JUNGFRAUJOCH_HLSSIMULATEDDEVICE_H
 #define JUNGFRAUJOCH_HLSSIMULATEDDEVICE_H
@@ -6,7 +7,7 @@
 #include <thread>
 
 #include "../common/DiffractionExperiment.h"
-#include "../fpga/hls/HLSDevice.h"
+#include "../fpga/hls_simulation/HLSDevice.h"
 
 #include "FPGAAcquisitionDevice.h"
 

acquisition_device/PCIExpressDevice.cpp

@@ -1,18 +1,21 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #include "PCIExpressDevice.h"
 #include "../common/NetworkAddressConvert.h"
+#define PCI_EXCEPT(x) try {x;} catch (const std::exception &e) { throw PCIeDeviceException(e.what()); }
 
 PCIExpressDevice::PCIExpressDevice(uint16_t data_stream, uint16_t pci_slot) :
         PCIExpressDevice(data_stream, "/dev/jfjoch" + std::to_string(pci_slot)) {}
 
 PCIExpressDevice::PCIExpressDevice(uint16_t data_stream) :
-PCIExpressDevice(data_stream, "/dev/jfjoch" + std::to_string(data_stream)) {}
+        PCIExpressDevice(data_stream, "/dev/jfjoch" + std::to_string(data_stream)) {}
 
 PCIExpressDevice::PCIExpressDevice(uint16_t data_stream, const std::string &device_name)
-: FPGAAcquisitionDevice(data_stream), dev(device_name, true) {
+        : FPGAAcquisitionDevice(data_stream), dev(device_name, true) {
 
-    DataCollectionStatus status = dev.GetDataCollectionStatus();
+    DataCollectionStatus status;
+    PCI_EXCEPT(status = dev.GetDataCollectionStatus())
 
     max_modules = status.max_modules;
     if (max_modules == 0)
@@ -31,78 +34,88 @@ PCIExpressDevice::PCIExpressDevice(uint16_t data_stream, const std::string &devi
 }
 
 bool PCIExpressDevice::HW_ReadMailbox(uint32_t *values) {
-    return dev.ReadWorkCompletion(values);
+    PCI_EXCEPT(return dev.ReadWorkCompletion(values);)
 }
 
 void PCIExpressDevice::Cancel() {
-    dev.Cancel();
+    PCI_EXCEPT(dev.Cancel();)
 }
 
 bool PCIExpressDevice::HW_SendWorkRequest(uint32_t handle) {
-    return dev.SendWorkRequest(handle);
+    PCI_EXCEPT(return dev.SendWorkRequest(handle);)
 }
 
 void PCIExpressDevice::FPGA_StartAction(const DiffractionExperiment &experiment) {
-    dev.Start();
+    PCI_EXCEPT(dev.Start();)
 }
 
 void PCIExpressDevice::HW_RunInternalGenerator(const FrameGeneratorConfig &config) {
-    dev.RunFrameGenerator(config);
+    PCI_EXCEPT(dev.RunFrameGenerator(config);)
 }
 
 void PCIExpressDevice::FPGA_EndAction() {
-    dev.End();
+    PCI_EXCEPT(dev.End();)
 }
 
 bool PCIExpressDevice::HW_IsIdle() const {
-    return dev.IsIdle();
+    PCI_EXCEPT(return dev.IsIdle();)
 }
 
 void PCIExpressDevice::HW_WriteActionRegister(const DataCollectionConfig *config) {
-    dev.SetConfig(*config);
+    PCI_EXCEPT(dev.SetConfig(*config);)
 }
 
 void PCIExpressDevice::HW_ReadActionRegister(DataCollectionConfig *config) {
-    *config = dev.GetConfig();
+    PCI_EXCEPT(*config = dev.GetConfig();)
 }
 
 std::string PCIExpressDevice::GetMACAddress() const {
-    return MacAddressToStr(dev.GetMACAddress());
+    PCI_EXCEPT(return MacAddressToStr(dev.GetMACAddress());)
 }
 
 uint32_t PCIExpressDevice::GetNumKernelBuffers() const {
-    return dev.GetBufferCount();
+    PCI_EXCEPT(return dev.GetBufferCount();)
 }
 
 int32_t PCIExpressDevice::GetNUMANode() const {
-    return dev.GetNumaNode();
+    PCI_EXCEPT(return dev.GetNumaNode();)
 }
 
 void PCIExpressDevice::SetIPv4Address(uint32_t ipv4_addr_network_order) {
+    PCI_EXCEPT(
     // Configure all links with the same IPv4 address
-    auto dev_status = dev.GetDeviceStatus();
-    for (int i = 0; i < dev_status.eth_link_count; i++)
-        dev.SetIPv4Address(ipv4_addr_network_order, i);
-    dev.SetIPv4Address(ipv4_addr_network_order, NET_IF_FRAME_GENERATOR);
+            auto dev_status = dev.GetDeviceStatus();
+            for (int i = 0; i < dev_status.eth_link_count; i++)
+                dev.SetIPv4Address(ipv4_addr_network_order, i);
+            dev.SetIPv4Address(ipv4_addr_network_order, NET_IF_FRAME_GENERATOR);
+    )
 }
 
 std::string PCIExpressDevice::GetIPv4Address() const {
+    PCI_EXCEPT(
     return IPv4AddressToStr(dev.GetIPv4Address());
+    )
 }
 
 void PCIExpressDevice::HW_SetSpotFinderParameters(const SpotFinderParameters &params) {
-    dev.SetSpotFinderParameters(params);
+    PCI_EXCEPT(
+        dev.SetSpotFinderParameters(params);
+    )
 }
 
 DeviceStatus PCIExpressDevice::GetDeviceStatus() const {
-    return dev.GetDeviceStatus();
+    PCI_EXCEPT(
+        return dev.GetDeviceStatus();
+    )
 }
 
 DataCollectionStatus PCIExpressDevice::GetDataCollectionStatus() const {
-    return dev.GetDataCollectionStatus();
+    PCI_EXCEPT(
+        return dev.GetDataCollectionStatus();
+    )
 }
 
 void PCIExpressDevice::HW_LoadCalibration(const LoadCalibrationConfig &config) {
-    dev.LoadCalibration(config);
+    PCI_EXCEPT(dev.LoadCalibration(config);)
 }
 

acquisition_device/PCIExpressDevice.h

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #ifndef JUNGFRAUJOCH_PCIEXPRESSDEVICE_H
 #define JUNGFRAUJOCH_PCIEXPRESSDEVICE_H

broker/JFJochBrokerHttp.cpp

@@ -1,4 +1,5 @@
-// Copyright (2019-2024) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 // Using OpenAPI licensed with Apache License 2.0
 
 #include <nlohmann/json.hpp>
@@ -6,6 +7,7 @@
 #include "gen/model/Error_message.h"
 #include "../common/GitInfo.h"
 #include "OpenAPIConvert.h"
+#include "../preview/JFJochTIFF.h"
 
 JFJochBrokerHttp::JFJochBrokerHttp(const DiffractionExperiment &experiment, std::shared_ptr<Pistache::Rest::Router> &rtr)
         : DefaultApi(rtr) {
@@ -378,6 +380,18 @@ void JFJochBrokerHttp::plot_indexing_rate_get(const std::optional<int32_t> &binn
     GenericPlot(PlotType::IndexingRate, binning, compression, response);
 }
 
+void JFJochBrokerHttp::plot_indexing_unit_cell_get(const std::optional<int32_t> &binning,
+                                                   const std::optional<bool> &compression,
+                                                   Pistache::Http::ResponseWriter &response) {
+    GenericPlot(PlotType::IndexingUnitCellLength, binning, compression, response);
+}
+
+void JFJochBrokerHttp::plot_indexing_unit_cell_angle_get(const std::optional<int32_t> &binning,
+                                                   const std::optional<bool> &compression,
+                                                   Pistache::Http::ResponseWriter &response) {
+    GenericPlot(PlotType::IndexingUnitCellAngle, binning, compression, response);
+}
+
 void JFJochBrokerHttp::plot_receiver_delay_get(const std::optional<int32_t> &binning,
                                                const std::optional<bool>& compression,
                                                Pistache::Http::ResponseWriter &response) {
@@ -421,18 +435,54 @@ void JFJochBrokerHttp::plot_strong_pixel_get(const std::optional<int32_t> &binni
 }
 
 void JFJochBrokerHttp::config_mask_tiff_get(Pistache::Http::ResponseWriter &response) {
-    std::string s = state_machine.GetFullPixelMaskTIFF();
+    auto s = state_machine.GetFullPixelMaskTIFF();
     response.send(Pistache::Http::Code::Ok, s, Pistache::Http::Mime::MediaType::fromString("image/tiff"));
 }
 
 void JFJochBrokerHttp::config_user_mask_tiff_get(Pistache::Http::ResponseWriter &response) {
-    std::string s = state_machine.GetUserPixelMaskTIFF();
+    auto s = state_machine.GetUserPixelMaskTIFF();
     response.send(Pistache::Http::Code::Ok, s, Pistache::Http::Mime::MediaType::fromString("image/tiff"));
 }
 
 void JFJochBrokerHttp::config_user_mask_tiff_put(const Pistache::Rest::Request &request,
                                                  Pistache::Http::ResponseWriter &response) {
-    state_machine.SetUserPixelMask(request.body());
+    uint32_t cols, lines;
+    auto v = ReadTIFFFromString32(request.body(), cols, lines);
+    state_machine.SetUserPixelMask(v);
+    response.send(Pistache::Http::Code::Ok);
+}
+
+void JFJochBrokerHttp::config_mask_get(Pistache::Http::ResponseWriter &response) {
+    const auto v = state_machine.GetFullPixelMask();
+    response.send(Pistache::Http::Code::Ok,
+        reinterpret_cast<const char *>(v.data()),
+        v.size() * sizeof(uint32_t),
+        Pistache::Http::Mime::MediaType::fromString("application/octet-stream"));
+}
+
+void JFJochBrokerHttp::config_user_mask_get(Pistache::Http::ResponseWriter &response) {
+    const auto v = state_machine.GetUserPixelMask();
+    response.send(Pistache::Http::Code::Ok,
+        reinterpret_cast<const char *>(v.data()),
+        v.size() * sizeof(uint32_t),
+        Pistache::Http::Mime::MediaType::fromString("application/octet-stream"));
+}
+
+void JFJochBrokerHttp::config_user_mask_put(const Pistache::Rest::Request &request,
+    Pistache::Http::ResponseWriter &response) {
+    if (request.body().empty()) {
+        response.send(Pistache::Http::Code::Bad_Request, "Request body cannot be empty");
+        return;
+    }
+
+    if (request.body().size() % 4 != 0) {
+        response.send(Pistache::Http::Code::Bad_Request, "Request has to be 32-bit");
+        return;
+    }
+
+    std::vector<uint32_t> v(request.body().size() / 4);
+    memcpy(v.data(), request.body().data(), request.body().size());
+    state_machine.SetUserPixelMask(v);
     response.send(Pistache::Http::Code::Ok);
 }
 
@@ -498,11 +548,16 @@ void JFJochBrokerHttp::statistics_get(const std::optional<bool> &compression, Pi
     statistics.setDataProcessingSettings(Convert(state_machine.GetSpotFindingSettings()));
     statistics.setInstrumentMetadata(Convert(state_machine.GetInstrumentMetadata()));
     statistics.setImageFormatSettings(Convert(state_machine.GetImageFormatSettings()));
+    statistics.setPixelMask(Convert(state_machine.GetPixelMaskStatistics()));
 
     auto zeromq_prev = state_machine.GetPreviewSocketSettings();
     if (!zeromq_prev.address.empty())
         statistics.setZeromqPreview(Convert(zeromq_prev));
 
+    auto zeromq_metadata = state_machine.GetMetadataSocketSettings();
+    if (!zeromq_metadata.address.empty())
+        statistics.setZeromqMetadata(Convert(zeromq_metadata));
+
     nlohmann::json j = statistics;
     if (!compression.has_value() || compression.value())
         response.setCompression(Pistache::Http::Header::Encoding::Deflate);
@@ -520,3 +575,14 @@ void JFJochBrokerHttp::config_zeromq_preview_put(
     state_machine.SetPreviewSocketSettings(Convert(zeromqPreviewSettings));
     response.send(Pistache::Http::Code::Ok);
 }
+
+void JFJochBrokerHttp::config_zeromq_metadata_get(Pistache::Http::ResponseWriter &response) {
+    ProcessOutput(Convert(state_machine.GetMetadataSocketSettings()), response);
+}
+
+void JFJochBrokerHttp::config_zeromq_metadata_put(
+    const org::openapitools::server::model::Zeromq_metadata_settings &zeromqMetadataSettings,
+    Pistache::Http::ResponseWriter &response) {
+    state_machine.SetMetadataSocketSettings(Convert(zeromqMetadataSettings));
+    response.send(Pistache::Http::Code::Ok);
+}

broker/JFJochBrokerHttp.h

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 // Using OpenAPI licensed with Apache License 2.0
 
 #ifndef JUNGFRAUJOCH_JFJOCHBROKERHTTP_H
@@ -169,6 +170,24 @@ class JFJochBrokerHttp : public org::openapitools::server::api::DefaultApi {
     config_zeromq_preview_put(const org::openapitools::server::model::Zeromq_preview_settings &zeromqPreviewSettings,
                               Pistache::Http::ResponseWriter &response) override;
 
+    void config_zeromq_metadata_get(Pistache::Http::ResponseWriter &response) override;
+
+    void config_zeromq_metadata_put(
+        const org::openapitools::server::model::Zeromq_metadata_settings &zeromqMetadataSettings,
+        Pistache::Http::ResponseWriter &response) override;
+
+    void config_mask_get(Pistache::Http::ResponseWriter &response) override;
+
+    void config_user_mask_get(Pistache::Http::ResponseWriter &response) override;
+
+    void config_user_mask_put(const Pistache::Rest::Request &request,
+        Pistache::Http::ResponseWriter &response) override;
+
+    void plot_indexing_unit_cell_get(const std::optional<int32_t> &binning, const std::optional<bool> &compression,
+        Pistache::Http::ResponseWriter &response) override;
+
+    void plot_indexing_unit_cell_angle_get(const std::optional<int32_t> &binning, const std::optional<bool> &compression,
+        Pistache::Http::ResponseWriter &response) override;
 public:
     JFJochBrokerHttp(const DiffractionExperiment& experiment, std::shared_ptr<Pistache::Rest::Router> &rtr);
     void AddDetectorSetup(const DetectorSetup &setup);

broker/JFJochBrokerParser.cpp

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #include "JFJochBrokerParser.h"
 #include "../common/NetworkAddressConvert.h"
@@ -174,4 +175,9 @@ void ParseReceiverSettings(const org::openapitools::server::model::Jfjoch_settin
         service.PreviewSocket(input.getZeromqPreview().getSocketAddress());
         service.PreviewSocketSettings(Convert(input.getZeromqPreview()));
     }
+
+    if (input.zeromqMetadataIsSet()) {
+        service.MetadataSocket(input.getZeromqMetadata().getSocketAddress());
+        service.MetadataSocketSettings(Convert(input.getZeromqMetadata()));
+    }
 }

broker/JFJochBrokerParser.h

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #ifndef JUNGFRAUJOCH_JFJOCHBROKERPARSER_H
 #define JUNGFRAUJOCH_JFJOCHBROKERPARSER_H

broker/JFJochServices.cpp

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #include "JFJochServices.h"
 #include "../common/JFJochException.h"
@@ -204,11 +205,21 @@ std::vector<DeviceStatus> JFJochServices::GetDeviceStatus() const {
 ZMQPreviewSettings JFJochServices::GetPreviewSocketSettings() {
     if (receiver)
         return receiver->GetPreviewSocketSettings();
-    else
-        return {};
+    return {};
+}
+
+ZMQMetadataSettings JFJochServices::GetMetadataSocketSettings() {
+    if (receiver)
+        return receiver->GetMetadataSocketSettings();
+    return {};
 }
 
 void JFJochServices::SetPreviewSocketSettings(const ZMQPreviewSettings &input) {
     if (receiver)
         receiver->PreviewSocketSettings(input);
 }
+
+void JFJochServices::SetMetadataSocketSettings(const ZMQMetadataSettings &input) {
+    if (receiver)
+        receiver->MetadataSocketSettings(input);
+}

broker/JFJochServices.h

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #ifndef JUNGFRAUJOCH_JFJOCHSERVICES_H
 #define JUNGFRAUJOCH_JFJOCHSERVICES_H
@@ -52,6 +53,9 @@ public:
 
     void SetPreviewSocketSettings(const ZMQPreviewSettings &input);
     ZMQPreviewSettings GetPreviewSocketSettings();
+
+    void SetMetadataSocketSettings(const ZMQMetadataSettings &input);
+    ZMQMetadataSettings GetMetadataSocketSettings();
 };
 
 

broker/JFJochStateMachine.cpp

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #include <thread>
 
@@ -6,11 +7,13 @@
 #include "../preview/JFJochTIFF.h"
 
 JFJochStateMachine::JFJochStateMachine(JFJochServices &in_services, Logger &in_logger)
-        : services(in_services),
-          logger(in_logger),
-          data_processing_settings(DiffractionExperiment::DefaultDataProcessingSettings()),
-          pixel_mask(experiment) {
-
+    : logger(in_logger),
+      services(in_services),
+      pixel_mask(experiment),
+      current_detector_setup(0),
+      data_processing_settings(DiffractionExperiment::DefaultDataProcessingSettings()),
+      pixel_mask_statistics({0,0,0}) {
+    SupressTIFFErrors();
 }
 
 bool JFJochStateMachine::ImportPedestalG0(const JFJochReceiverOutput &receiver_output) {
@@ -75,7 +78,8 @@ void JFJochStateMachine::TakePedestalInternalAll(std::unique_lock<std::mutex> &u
             }
         }
         services.ConfigureDetector(experiment);
-        pixel_mask.LoadDetectorBadPixelMask(calibration->CalculateMask());
+        pixel_mask.LoadDetectorBadPixelMask(experiment, calibration.get());
+        UpdatePixelMaskStatistics(pixel_mask.GetStatistics());
     } catch (const std::exception &e) {
         logger.Error("Pedestal sequence error {}", e.what());
         state = JFJochState::Error;
@@ -201,7 +205,7 @@ void JFJochStateMachine::TakePedestalInternalG2(std::unique_lock<std::mutex> &ul
 }
 
 void JFJochStateMachine::Initialize() {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (IsRunning())
         throw WrongDAQStateException ("Cannot initialize during measurement");
@@ -219,7 +223,7 @@ void JFJochStateMachine::Initialize() {
 }
 
 void JFJochStateMachine::Pedestal() {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (state != JFJochState::Idle)
         throw WrongDAQStateException ("Must be idle to take pedestal");
@@ -243,13 +247,13 @@ void JFJochStateMachine::InitializeThread(std::unique_lock<std::mutex> ul) {
 }
 
 void JFJochStateMachine::Trigger() {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     if (state == JFJochState::Measuring)
         services.Trigger();
 }
 
 void JFJochStateMachine::Start(const DatasetSettings& settings) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (state != JFJochState::Idle)
         throw WrongDAQStateException ("Must be idle to start measurement");
@@ -281,15 +285,25 @@ void JFJochStateMachine::Start(const DatasetSettings& settings) {
     }
 }
 
+void JFJochStateMachine::UpdatePixelMaskStatistics(const PixelMaskStatistics &input) {
+    std::unique_lock ul(pixel_mask_statistics_mutex);
+    pixel_mask_statistics = input;
+}
+
+PixelMaskStatistics JFJochStateMachine::GetPixelMaskStatistics() const {
+    std::unique_lock ul(pixel_mask_statistics_mutex);
+    return pixel_mask_statistics;
+}
+
 void JFJochStateMachine::MeasurementThread() {
     try {
         auto tmp_output = services.Stop();
         {
-            std::unique_lock<std::mutex> ul(m);
+            std::unique_lock ul(m);
             state = JFJochState::Idle;
         }
     } catch (...) {
-        std::unique_lock<std::mutex> ul(m);
+        std::unique_lock ul(m);
         state = JFJochState::Error;
     }
     c.notify_all();
@@ -297,7 +311,7 @@ void JFJochStateMachine::MeasurementThread() {
 
 void JFJochStateMachine::Cancel() {
     // This is inconsistency in naming - need to solve later
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     if ((state == JFJochState::Pedestal) || (state == JFJochState::Measuring)) {
         services.Cancel();
         cancel_sequence = true;
@@ -305,12 +319,12 @@ void JFJochStateMachine::Cancel() {
 }
 
 void JFJochStateMachine::DebugOnly_SetState(JFJochState in_state) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     state = in_state;
 }
 
 void JFJochStateMachine::Deactivate() {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     try {
         if (measurement.valid())
             measurement.get();
@@ -359,27 +373,27 @@ std::optional<MeasurementStatistics> JFJochStateMachine::GetMeasurementStatistic
 }
 
 std::vector<JFCalibrationModuleStatistics> JFJochStateMachine::GetCalibrationStatistics() const {
-    std::unique_lock<std::mutex> ul(calibration_statistics_mutex);
+    std::unique_lock ul(calibration_statistics_mutex);
     return calibration_statistics;
 }
 
 void JFJochStateMachine::SetCalibrationStatistics(const std::vector<JFCalibrationModuleStatistics> &input) {
-    std::unique_lock<std::mutex> ul(calibration_statistics_mutex);
+    std::unique_lock ul(calibration_statistics_mutex);
     calibration_statistics = input;
 }
 
 DetectorSettings JFJochStateMachine::GetDetectorSettings() const {
-    std::unique_lock<std::mutex> ul(experiment_detector_settings_mutex);
+    std::unique_lock ul(experiment_detector_settings_mutex);
     return experiment.GetDetectorSettings();
 }
 
 void JFJochStateMachine::ImportDetectorSettings(const DetectorSettings &input) {
-    std::unique_lock<std::mutex> ul(experiment_detector_settings_mutex);
+    std::unique_lock ul(experiment_detector_settings_mutex);
     experiment.ImportDetectorSettings(input);
 }
 
 void JFJochStateMachine::LoadDetectorSettings(const DetectorSettings &settings) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     switch (state) {
         case JFJochState::Inactive:
         case JFJochState::Error:
@@ -413,14 +427,14 @@ MultiLinePlot JFJochStateMachine::GetPlots(const PlotRequest &request) const {
 }
 
 void JFJochStateMachine::SetSpotFindingSettings(const SpotFindingSettings &settings) {
-    std::unique_lock<std::mutex> ul(data_processing_settings_mutex);
+    std::unique_lock ul(data_processing_settings_mutex);
     DiffractionExperiment::CheckDataProcessingSettings(settings);
     data_processing_settings = settings;
     services.SetSpotFindingSettings(settings);
 }
 
 SpotFindingSettings JFJochStateMachine::GetSpotFindingSettings() const {
-    std::unique_lock<std::mutex> ul(data_processing_settings_mutex);
+    std::unique_lock ul(data_processing_settings_mutex);
     return data_processing_settings;
 }
 
@@ -429,19 +443,19 @@ JFJochState JFJochStateMachine::GetState() const {
 }
 
 void JFJochStateMachine::AddDetectorSetup(const DetectorSetup &setup) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (detector_setup.empty()) {
         experiment.Detector(setup);
         gain_calibration = setup.GetGainCalibration();
         current_detector_setup = 0;
-        pixel_mask = PixelMask(setup);
+        pixel_mask = PixelMask(experiment);
     }
     detector_setup.emplace_back(setup);
 }
 
 DetectorList JFJochStateMachine::GetDetectorsList() const {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     DetectorList ret;
 
     for (const auto & i : detector_setup) {
@@ -465,7 +479,7 @@ std::optional<DetectorStatus> JFJochStateMachine::GetDetectorStatus() const {
 }
 
 void JFJochStateMachine::SelectDetector(int64_t id) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if ((id < 0) || (id >= detector_setup.size()))
         throw JFJochException(JFJochExceptionCategory::ArrayOutOfBounds, "Detector doesn't exist");
@@ -476,7 +490,7 @@ void JFJochStateMachine::SelectDetector(int64_t id) {
     try {
         experiment.Detector(detector_setup[id]);
         gain_calibration = detector_setup[id].GetGainCalibration();
-        pixel_mask = PixelMask(detector_setup[id]);
+        pixel_mask = PixelMask(experiment);
         state = JFJochState::Inactive;
         current_detector_setup = id;
     } catch (JFJochException &e) {
@@ -486,7 +500,7 @@ void JFJochStateMachine::SelectDetector(int64_t id) {
 }
 
 void JFJochStateMachine::SetRadialIntegrationSettings(const AzimuthalIntegrationSettings &settings) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (IsRunning())
         throw WrongDAQStateException ("Cannot change radial integration settings during data collection");
@@ -495,7 +509,7 @@ void JFJochStateMachine::SetRadialIntegrationSettings(const AzimuthalIntegration
 }
 
 AzimuthalIntegrationSettings JFJochStateMachine::GetRadialIntegrationSettings() const {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     return experiment.GetRadialIntegrationSettings();
 }
 
@@ -515,7 +529,7 @@ bool JFJochStateMachine::IsRunning() const {
 }
 
 JFJochState JFJochStateMachine::WaitTillMeasurementDone() {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     c.wait(ul, [&] { return !IsRunning(); });
 
@@ -523,7 +537,7 @@ JFJochState JFJochStateMachine::WaitTillMeasurementDone() {
 }
 
 JFJochState JFJochStateMachine::WaitTillMeasurementDone(std::chrono::milliseconds timeout) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     c.wait_for(ul, timeout, [&] { return !IsRunning(); });
 
@@ -549,7 +563,7 @@ std::string JFJochStateMachine::GetPreviewTIFF(bool calibration) const {
 }
 
 std::string JFJochStateMachine::GetPedestalTIFF(size_t gain_level, size_t sc) const {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (state != JFJochState::Idle)
         throw WrongDAQStateException ("Pedestal can be only retrieved in Idle state");
@@ -563,7 +577,7 @@ std::string JFJochStateMachine::GetPedestalTIFF(size_t gain_level, size_t sc) co
 }
 
 void JFJochStateMachine::LoadInternalGeneratorImage(const void *data, size_t size, uint64_t image_number) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (state != JFJochState::Idle)
         throw WrongDAQStateException ("Can change internal generator image only when detector in Idle state");
@@ -583,7 +597,7 @@ void JFJochStateMachine::LoadInternalGeneratorImage(const void *data, size_t siz
 }
 
 void JFJochStateMachine::LoadInternalGeneratorImageTIFF(const std::string &s, uint64_t image_number) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (state != JFJochState::Idle)
         throw WrongDAQStateException ("Can change internal generator image only when detector in Idle state");
@@ -598,7 +612,7 @@ void JFJochStateMachine::LoadInternalGeneratorImageTIFF(const std::string &s, ui
 }
 
 void JFJochStateMachine::SetBoxROI(const std::vector<ROIBox> &input) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (IsRunning())
         throw WrongDAQStateException ("ROI can be modified only when detector is not running");
@@ -607,7 +621,7 @@ void JFJochStateMachine::SetBoxROI(const std::vector<ROIBox> &input) {
 }
 
 void JFJochStateMachine::SetCircleROI(const std::vector<ROICircle> &input) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (IsRunning())
         throw WrongDAQStateException ("ROI can be modified only when detector is not running");
@@ -616,12 +630,12 @@ void JFJochStateMachine::SetCircleROI(const std::vector<ROICircle> &input) {
 }
 
 std::vector<ROIBox> JFJochStateMachine::GetBoxROI() const {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     return experiment.ROI().GetROIBox();
 }
 
 std::vector<ROICircle> JFJochStateMachine::GetCircleROI() const {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     return experiment.ROI().GetROICircle();
 }
 
@@ -638,29 +652,38 @@ std::vector<uint64_t> JFJochStateMachine::GetXFELEventCode() const {
 }
 
 std::string JFJochStateMachine::GetFullPixelMaskTIFF() const {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     std::vector v = pixel_mask.GetMask(experiment);
     return WriteTIFFToString(v.data(), experiment.GetXPixelsNum(), experiment.GetYPixelsNum(),
                              sizeof(uint32_t), false);
 }
 
 std::string JFJochStateMachine::GetUserPixelMaskTIFF() const {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     std::vector v = pixel_mask.GetUserMask(experiment);
     return WriteTIFFToString(v.data(), experiment.GetXPixelsNum(), experiment.GetYPixelsNum(),
                              sizeof(uint32_t), false);
 }
 
-void JFJochStateMachine::SetUserPixelMask(const std::string &s) {
-    std::unique_lock<std::mutex> ul(m);
+std::vector<uint32_t> JFJochStateMachine::GetFullPixelMask() const {
+    std::unique_lock ul(m);
+    return pixel_mask.GetMask(experiment);
+}
+
+std::vector<uint32_t> JFJochStateMachine::GetUserPixelMask() const {
+    std::unique_lock ul(m);
+    return pixel_mask.GetUserMask(experiment);
+}
+
+void JFJochStateMachine::SetUserPixelMask(const std::vector<uint32_t> &v) {
+    std::unique_lock ul(m);
 
     if (state != JFJochState::Idle)
         throw WrongDAQStateException ("User mask can be only modified in Idle state");
 
     try {
-        uint32_t cols, lines;
-        auto v = ReadTIFFFromString32(s, cols, lines);
         pixel_mask.LoadUserMask(experiment, v);
+        UpdatePixelMaskStatistics(pixel_mask.GetStatistics());
     } catch (const JFJochException &e) {
         throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
                               "Problem handling user mask " + std::string(e.what()));
@@ -668,12 +691,12 @@ void JFJochStateMachine::SetUserPixelMask(const std::string &s) {
 }
 
 InstrumentMetadata JFJochStateMachine::GetInstrumentMetadata() const {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     return experiment.GetInstrumentMetadata();
 }
 
 void JFJochStateMachine::LoadInstrumentMetadata(const InstrumentMetadata &settings) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (IsRunning())
         throw WrongDAQStateException ("Cannot change instrument metadata during data collection");
@@ -682,21 +705,23 @@ void JFJochStateMachine::LoadInstrumentMetadata(const InstrumentMetadata &settin
 }
 
 ImageFormatSettings JFJochStateMachine::GetImageFormatSettings() const {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
     return experiment.GetImageFormatSettings();
 }
 
 void JFJochStateMachine::LoadImageFormatSettings(const ImageFormatSettings &settings) {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (IsRunning())
-        throw WrongDAQStateException ("Cannot change instrument metadata during data collection");
+        throw WrongDAQStateException ("Cannot change image format settings during data collection");
 
     experiment.ImportImageFormatSettings(settings);
+    pixel_mask.Update(settings);
+    UpdatePixelMaskStatistics(pixel_mask.GetStatistics());
 }
 
 void JFJochStateMachine::RawImageFormatSettings() {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (IsRunning())
         throw WrongDAQStateException ("Cannot change instrument metadata during data collection");
@@ -705,7 +730,7 @@ void JFJochStateMachine::RawImageFormatSettings() {
 }
 
 void JFJochStateMachine::ConvImageFormatSettings() {
-    std::unique_lock<std::mutex> ul(m);
+    std::unique_lock ul(m);
 
     if (IsRunning())
         throw WrongDAQStateException ("Cannot change instrument metadata during data collection");
@@ -724,3 +749,11 @@ void JFJochStateMachine::SetPreviewSocketSettings(const ZMQPreviewSettings &inpu
 ZMQPreviewSettings JFJochStateMachine::GetPreviewSocketSettings() {
     return services.GetPreviewSocketSettings();
 }
+
+void JFJochStateMachine::SetMetadataSocketSettings(const ZMQMetadataSettings &input) {
+    services.SetMetadataSocketSettings(input);
+}
+
+ZMQMetadataSettings JFJochStateMachine::GetMetadataSocketSettings() {
+    return services.GetMetadataSocketSettings();
+}

broker/JFJochStateMachine.h

@@ -1,4 +1,5 @@
-// Copyright (2019-2023) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #ifndef JUNGFRAUJOCH_JFJOCHSTATEMACHINE_H
 #define JUNGFRAUJOCH_JFJOCHSTATEMACHINE_H
@@ -93,6 +94,11 @@ class JFJochStateMachine {
     mutable std::mutex data_processing_settings_mutex;
     SpotFindingSettings data_processing_settings;
 
+    mutable std::mutex pixel_mask_statistics_mutex;
+    PixelMaskStatistics pixel_mask_statistics;
+
+    void UpdatePixelMaskStatistics(const PixelMaskStatistics &input);
+
     // Private functions assume that lock m is acquired
     void MeasurementThread();
     void PedestalThread(std::unique_lock<std::mutex> ul);
@@ -177,11 +183,20 @@ public:
 
     std::string GetFullPixelMaskTIFF() const;
     std::string GetUserPixelMaskTIFF() const;
-    void SetUserPixelMask(const std::string &v);
+    std::vector<uint32_t> GetFullPixelMask() const;
+    std::vector<uint32_t> GetUserPixelMask() const;
+
+    void SetUserPixelMask(const std::vector<uint32_t> &v);
+
     std::vector<DeviceStatus> GetDeviceStatus() const;
 
     void SetPreviewSocketSettings(const ZMQPreviewSettings &input);
     ZMQPreviewSettings GetPreviewSocketSettings();
+
+    void SetMetadataSocketSettings(const ZMQMetadataSettings &input);
+    ZMQMetadataSettings GetMetadataSocketSettings();
+
+    PixelMaskStatistics GetPixelMaskStatistics() const;
 };
 
 

broker/OpenAPIConvert.cpp

@@ -1,4 +1,5 @@
-// Copyright (2019-2024) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #include "OpenAPIConvert.h"
 
@@ -139,7 +140,9 @@ DetectorSettings Convert(const org::openapitools::server::model::Detector_settin
     ret.PedestalG1Frames(input.getJungfrauPedestalG1Frames());
     ret.PedestalG2Frames(input.getJungfrauPedestalG2Frames());
     ret.PedestalMinImageCount(input.getJungfrauPedestalMinImageCount());
-    ret.PedestalG0RMSLimit(input.getJungfrauPedestalG0RmsLimit());
+
+    if (input.eigerBitDepthIsSet())
+            ret.EigerBitDepth(input.getEigerBitDepth());
 
     if (input.eigerThresholdKeVIsSet())
         ret.EigerThreshold_keV(input.getEigerThresholdKeV());
@@ -171,10 +174,11 @@ org::openapitools::server::model::Detector_settings Convert(const DetectorSettin
     ret.setJungfrauPedestalMinImageCount(input.GetPedestalMinImageCount());
 
     ret.setJungfrauStorageCellDelayNs(input.GetStorageCellDelay().count());
-    ret.setJungfrauPedestalG0RmsLimit(input.GetPedestalG0RMSLimit());
-    if (input.GetEIGERThreshold_keV().has_value())
-        ret.setEigerThresholdKeV(input.GetEIGERThreshold_keV().value());
-    
+    if (input.GetEigerThreshold_keV().has_value())
+        ret.setEigerThresholdKeV(input.GetEigerThreshold_keV().value());
+    if (input.GetEigerBitDepth().has_value())
+        ret.setEigerBitDepth(input.GetEigerBitDepth().value());
+
     ret.setTiming(Convert(input.GetTiming()));
     return ret;
 }
@@ -423,6 +427,9 @@ ImageFormatSettings Convert(const org::openapitools::server::model::Image_format
     ret.JungfrauConversion(input.isJungfrauConversion());
     ret.MaskChipEdges(input.isMaskChipEdges());
     ret.MaskModuleEdges(input.isMaskModuleEdges());
+    ret.ApplyPixelMask(input.isApplyMask());
+    ret.PedestalG0RMSLimit(input.getJungfrauPedestalG0RmsLimit());
+    ret.MaskPixelsWithoutG0(input.isJungfrauMaskPixelsWithoutG0());
     if (input.signedOutputIsSet())
         ret.PixelSigned(input.isSignedOutput());
     if (input.jungfrauConversionFactorKeVIsSet())
@@ -439,6 +446,9 @@ org::openapitools::server::model::Image_format_settings Convert(const ImageForma
     ret.setJungfrauConversion(input.IsJungfrauConversion());
     ret.setMaskChipEdges(input.IsMaskChipEdges());
     ret.setMaskModuleEdges(input.IsMaskModuleEdges());
+    ret.setApplyMask(input.IsApplyPixelMask());
+    ret.setJungfrauMaskPixelsWithoutG0(input.IsMaskPixelsWithoutG0());
+    ret.setJungfrauPedestalG0RmsLimit(input.GetPedestalG0RMSLimit());
     if (input.IsPixelSigned().has_value())
         ret.setSignedOutput(input.IsPixelSigned().value());
     if (input.GetJungfrauConvFactor_keV().has_value())
@@ -542,6 +552,7 @@ std::vector<org::openapitools::server::model::Fpga_status_inner> Convert(const s
         org::openapitools::server::model::Fpga_status_inner tmp;
         tmp.setPciDevId(d.device_number);
         tmp.setSerialNumber(d.serial_number);
+        tmp.setFwVersion(d.fpga_firmware_version);
         tmp.setBaseMacAddr(MacAddressToStr(d.fpga_default_mac_addr));
         tmp.setPacketsSls(d.packets_sls);
         tmp.setPacketsUdp(d.packets_udp);
@@ -567,6 +578,16 @@ ZMQPreviewSettings Convert(const org::openapitools::server::model::Zeromq_previe
     return ret;
 }
 
+ZMQMetadataSettings Convert(const org::openapitools::server::model::Zeromq_metadata_settings &input) {
+    ZMQMetadataSettings ret;
+    if (input.isEnabled())
+        ret.period = std::chrono::milliseconds(input.getPeriodMs());
+    else
+        ret.period = {};
+    ret.address = "";
+    return ret;
+}
+
 org::openapitools::server::model::Zeromq_preview_settings Convert(const ZMQPreviewSettings &settings) {
     org::openapitools::server::model::Zeromq_preview_settings ret;
     ret.setEnabled(settings.period.has_value());
@@ -575,3 +596,20 @@ org::openapitools::server::model::Zeromq_preview_settings Convert(const ZMQPrevi
     ret.setSocketAddress(settings.address);
     return ret;
 }
+
+org::openapitools::server::model::Zeromq_metadata_settings Convert(const ZMQMetadataSettings &settings) {
+    org::openapitools::server::model::Zeromq_metadata_settings ret;
+    ret.setEnabled(settings.period.has_value());
+    if (settings.period.has_value())
+        ret.setPeriodMs(settings.period.value().count() / 1000);
+    ret.setSocketAddress(settings.address);
+    return ret;
+}
+
+org::openapitools::server::model::Pixel_mask_statistics Convert(const PixelMaskStatistics& input) {
+    org::openapitools::server::model::Pixel_mask_statistics ret;
+    ret.setUserMask(input.user_mask);
+    ret.setWrongGain(input.wrong_gain);
+    ret.setTooHighPedestalRms(input.too_high_pedestal_rms);
+    return ret;
+}

broker/OpenAPIConvert.h

@@ -1,4 +1,5 @@
-// Copyright (2019-2024) Paul Scherrer Institute
+// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
+// SPDX-License-Identifier: GPL-3.0-only
 
 #ifndef JFJOCH_OPENAPICONVERT_H
 #define JFJOCH_OPENAPICONVERT_H
@@ -20,6 +21,9 @@
 #include "gen/model/Preview_settings.h"
 #include "gen/model/Dataset_settings.h"
 #include "gen/model/Fpga_status_inner.h"
+#include "gen/model/Pixel_mask_statistics.h"
+#include "gen/model/Zeromq_preview_settings.h"
+#include "gen/model/Zeromq_metadata_settings.h"
 
 #include "../common/DatasetSettings.h"
 #include "../common/ImageFormatSettings.h"
@@ -28,7 +32,6 @@
 #include "../common/DetectorSettings.h"
 #include "../jungfrau/JFCalibration.h"
 #include "../common/InstrumentMetadata.h"
-#include "Zeromq_preview_settings.h"
 
 SpotFindingSettings Convert(const org::openapitools::server::model::Spot_finding_settings &input);
 org::openapitools::server::model::Spot_finding_settings Convert(const SpotFindingSettings &input);
@@ -57,8 +60,11 @@ ImageFormatSettings Convert(const org::openapitools::server::model::Image_format
 org::openapitools::server::model::Image_format_settings Convert(const ImageFormatSettings& input);
 DatasetSettings Convert(const org::openapitools::server::model::Dataset_settings& input);
 std::vector<org::openapitools::server::model::Fpga_status_inner> Convert(const std::vector<DeviceStatus> &input);
+org::openapitools::server::model::Pixel_mask_statistics Convert(const PixelMaskStatistics& input);
 
 org::openapitools::server::model::Zeromq_preview_settings Convert(const ZMQPreviewSettings& settings);
 ZMQPreviewSettings Convert(const org::openapitools::server::model::Zeromq_preview_settings& input);
+org::openapitools::server::model::Zeromq_metadata_settings Convert(const ZMQMetadataSettings& settings);
+ZMQMetadataSettings Convert(const org::openapitools::server::model::Zeromq_metadata_settings& input);
 
 #endif //JFJOCH_OPENAPICONVERT_H

broker/README.md

@@ -1,66 +0,0 @@
-# Jungfraujoch service (jfjoch_broker)
-
-'jfjoch_broker' is the main service for the Jungfraujoch application. It is responsible for:
-
-* Providing user interface via HTTP and OpenAPI
-* Configuring FPGA firmware
-* Building images from FPGA output and forwarding the results over ZeroMQ
-
-## External interfaces
-Broker operates three external interfaces.
-
-**Data interface** ZeroMQ PULL socket with CBOR serialization is used to send images, metadata and processing results for writing or downstream 
-processing. See [here](../frame_serialize/README.md) for description of the format.
-
-**Preview interface** as above, but limited to subset of frames (1 image/s by default).
-
-**Configuration, status and results** HTTP/REST interface described in the OpenAPI format.
-Description of the API is presented in the `redoc-static.html` file. 
-Due to limitations of GitLab/GitHub the file cannot be viewed directly from the repository, but needs to be downloaded.
-## Broker configuration
-'jfjoch_broker' requires JSON configuration files. The file is described by OpenAPI structure `jfjoch_settings` defined in [jfjoch_api.yaml](jfjoch_api.yaml) file.
-It is recommended to go through example files in the [etc/](../etc/).
-
-## Setting up a local test for Jungfraujoch
-For development, it is possible to setup a local installation of Jungfraujoch. 
-This will work without FPGA installed in the computer and allows to test Jungfraujoch software layer, including
-ZeroMQ streaming and file writing. 
-
-The workflow simulates FPGA behavior, by running high-level synthesis code on the CPU - the performance is therefore 
-very low, as fixed-point calculations have large performance penalty on CPU. In the CPU simulation mode, one can simulate 
-using only a single FPGA device. 
-
-To run the test:
-
-### Compile Jungfraujoch with frontend
-```
-mkdir build
-cd build
-cmake ..
-make jfjoch
-make frontend
-```
-### Start services
-Start broker:
-```
-cd build/broker
-./jfjoch_broker ../../etc/broker_local.json 5232
-```
-
-Start writer:
-```
-cd build/writer
-./jfjoch_writer tcp://127.0.0.1:5500
-```
-
-### Run tests
-To run test a Python script is provided:
-```
-cd tests/test_data
-python jfjoch_broker_test.py
-```
-The script will initialize Jungfraujoch, import test image and start data collection.
-
-### Expected result
-You can observe online data analysis by opening the following web page: [http://localhost:5232](http://localhost:5232).
-Also in the `build/writer` subdirectory a dataset with images should be written.

broker/gen/api/ApiBase.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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

broker/gen/api/DefaultApi.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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -46,13 +46,18 @@ void DefaultApi::setupRoutes() {
     Routes::Put(*router, base + "/config/instrument", Routes::bind(&DefaultApi::config_instrument_put_handler, this));
     Routes::Put(*router, base + "/config/internal_generator_image", Routes::bind(&DefaultApi::config_internal_generator_image_put_handler, this));
     Routes::Put(*router, base + "/config/internal_generator_image.tiff", Routes::bind(&DefaultApi::config_internal_generator_image_tiff_put_handler, this));
+    Routes::Get(*router, base + "/config/mask", Routes::bind(&DefaultApi::config_mask_get_handler, this));
     Routes::Get(*router, base + "/config/mask.tiff", Routes::bind(&DefaultApi::config_mask_tiff_get_handler, this));
     Routes::Get(*router, base + "/config/select_detector", Routes::bind(&DefaultApi::config_select_detector_get_handler, this));
     Routes::Put(*router, base + "/config/select_detector", Routes::bind(&DefaultApi::config_select_detector_put_handler, this));
     Routes::Get(*router, base + "/config/spot_finding", Routes::bind(&DefaultApi::config_spot_finding_get_handler, this));
     Routes::Put(*router, base + "/config/spot_finding", Routes::bind(&DefaultApi::config_spot_finding_put_handler, this));
+    Routes::Get(*router, base + "/config/user_mask", Routes::bind(&DefaultApi::config_user_mask_get_handler, this));
+    Routes::Put(*router, base + "/config/user_mask", Routes::bind(&DefaultApi::config_user_mask_put_handler, this));
     Routes::Get(*router, base + "/config/user_mask.tiff", Routes::bind(&DefaultApi::config_user_mask_tiff_get_handler, this));
     Routes::Put(*router, base + "/config/user_mask.tiff", Routes::bind(&DefaultApi::config_user_mask_tiff_put_handler, this));
+    Routes::Get(*router, base + "/config/zeromq_metadata", Routes::bind(&DefaultApi::config_zeromq_metadata_get_handler, this));
+    Routes::Put(*router, base + "/config/zeromq_metadata", Routes::bind(&DefaultApi::config_zeromq_metadata_put_handler, this));
     Routes::Get(*router, base + "/config/zeromq_preview", Routes::bind(&DefaultApi::config_zeromq_preview_get_handler, this));
     Routes::Put(*router, base + "/config/zeromq_preview", Routes::bind(&DefaultApi::config_zeromq_preview_put_handler, this));
     Routes::Post(*router, base + "/deactivate", Routes::bind(&DefaultApi::deactivate_post_handler, this));
@@ -65,6 +70,8 @@ void DefaultApi::setupRoutes() {
     Routes::Get(*router, base + "/plot/error_pixel", Routes::bind(&DefaultApi::plot_error_pixel_get_handler, this));
     Routes::Get(*router, base + "/plot/image_collection_efficiency", Routes::bind(&DefaultApi::plot_image_collection_efficiency_get_handler, this));
     Routes::Get(*router, base + "/plot/indexing_rate", Routes::bind(&DefaultApi::plot_indexing_rate_get_handler, this));
+    Routes::Get(*router, base + "/plot/indexing_unit_cell_angle", Routes::bind(&DefaultApi::plot_indexing_unit_cell_angle_get_handler, this));
+    Routes::Get(*router, base + "/plot/indexing_unit_cell", Routes::bind(&DefaultApi::plot_indexing_unit_cell_get_handler, this));
     Routes::Get(*router, base + "/plot/receiver_delay", Routes::bind(&DefaultApi::plot_receiver_delay_get_handler, this));
     Routes::Get(*router, base + "/plot/receiver_free_send_buffers", Routes::bind(&DefaultApi::plot_receiver_free_send_buffers_get_handler, this));
     Routes::Get(*router, base + "/plot/roi_max_count", Routes::bind(&DefaultApi::plot_roi_max_count_get_handler, this));
@@ -418,6 +425,25 @@ void DefaultApi::config_internal_generator_image_tiff_put_handler(const Pistache
         response.send(Pistache::Http::Code::Internal_Server_Error, e.what());
     }
 
+}
+void DefaultApi::config_mask_get_handler(const Pistache::Rest::Request &, Pistache::Http::ResponseWriter response) {
+    try {
+
+
+    try {
+        this->config_mask_get(response);
+    } catch (Pistache::Http::HttpError &e) {
+        response.send(static_cast<Pistache::Http::Code>(e.code()), e.what());
+        return;
+    } catch (std::exception &e) {
+        this->handleOperationException(e, response);
+        return;
+    }
+
+    } catch (std::exception &e) {
+        response.send(Pistache::Http::Code::Internal_Server_Error, e.what());
+    }
+
 }
 void DefaultApi::config_mask_tiff_get_handler(const Pistache::Rest::Request &, Pistache::Http::ResponseWriter response) {
     try {
@@ -537,6 +563,43 @@ void DefaultApi::config_spot_finding_put_handler(const Pistache::Rest::Request &
         response.send(Pistache::Http::Code::Internal_Server_Error, e.what());
     }
 
+}
+void DefaultApi::config_user_mask_get_handler(const Pistache::Rest::Request &, Pistache::Http::ResponseWriter response) {
+    try {
+
+
+    try {
+        this->config_user_mask_get(response);
+    } catch (Pistache::Http::HttpError &e) {
+        response.send(static_cast<Pistache::Http::Code>(e.code()), e.what());
+        return;
+    } catch (std::exception &e) {
+        this->handleOperationException(e, response);
+        return;
+    }
+
+    } catch (std::exception &e) {
+        response.send(Pistache::Http::Code::Internal_Server_Error, e.what());
+    }
+
+}
+void DefaultApi::config_user_mask_put_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response) {
+    try {
+
+    try {
+      this->config_user_mask_put(request, response);
+    } catch (Pistache::Http::HttpError &e) {
+        response.send(static_cast<Pistache::Http::Code>(e.code()), e.what());
+        return;
+    } catch (std::exception &e) {
+        this->handleOperationException(e, response);
+        return;
+    }
+
+    } catch (std::exception &e) {
+        response.send(Pistache::Http::Code::Internal_Server_Error, e.what());
+    }
+
 }
 void DefaultApi::config_user_mask_tiff_get_handler(const Pistache::Rest::Request &, Pistache::Http::ResponseWriter response) {
     try {
@@ -574,6 +637,56 @@ void DefaultApi::config_user_mask_tiff_put_handler(const Pistache::Rest::Request
         response.send(Pistache::Http::Code::Internal_Server_Error, e.what());
     }
 
+}
+void DefaultApi::config_zeromq_metadata_get_handler(const Pistache::Rest::Request &, Pistache::Http::ResponseWriter response) {
+    try {
+
+
+    try {
+        this->config_zeromq_metadata_get(response);
+    } catch (Pistache::Http::HttpError &e) {
+        response.send(static_cast<Pistache::Http::Code>(e.code()), e.what());
+        return;
+    } catch (std::exception &e) {
+        this->handleOperationException(e, response);
+        return;
+    }
+
+    } catch (std::exception &e) {
+        response.send(Pistache::Http::Code::Internal_Server_Error, e.what());
+    }
+
+}
+void DefaultApi::config_zeromq_metadata_put_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response) {
+    try {
+
+
+    // Getting the body param
+    
+    Zeromq_metadata_settings zeromqMetadataSettings;
+    
+    try {
+        nlohmann::json::parse(request.body()).get_to(zeromqMetadataSettings);
+        zeromqMetadataSettings.validate();
+    } catch (std::exception &e) {
+        this->handleParsingException(e, response);
+        return;
+    }
+
+    try {
+        this->config_zeromq_metadata_put(zeromqMetadataSettings, response);
+    } catch (Pistache::Http::HttpError &e) {
+        response.send(static_cast<Pistache::Http::Code>(e.code()), e.what());
+        return;
+    } catch (std::exception &e) {
+        this->handleOperationException(e, response);
+        return;
+    }
+
+    } catch (std::exception &e) {
+        response.send(Pistache::Http::Code::Internal_Server_Error, e.what());
+    }
+
 }
 void DefaultApi::config_zeromq_preview_get_handler(const Pistache::Rest::Request &, Pistache::Http::ResponseWriter response) {
     try {
@@ -896,6 +1009,80 @@ void DefaultApi::plot_indexing_rate_get_handler(const Pistache::Rest::Request &r
         response.send(Pistache::Http::Code::Internal_Server_Error, e.what());
     }
 
+}
+void DefaultApi::plot_indexing_unit_cell_angle_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response) {
+    try {
+
+
+    // Getting the query params
+    auto binningQuery = request.query().get("binning");
+    std::optional<int32_t> binning;
+    if(binningQuery.has_value()){
+        int32_t valueQuery_instance;
+        if(fromStringValue(binningQuery.value(), valueQuery_instance)){
+            binning = valueQuery_instance;
+        }
+    }
+    auto compressionQuery = request.query().get("compression");
+    std::optional<bool> compression;
+    if(compressionQuery.has_value()){
+        bool valueQuery_instance;
+        if(fromStringValue(compressionQuery.value(), valueQuery_instance)){
+            compression = valueQuery_instance;
+        }
+    }
+    
+    try {
+        this->plot_indexing_unit_cell_angle_get(binning, compression, response);
+    } catch (Pistache::Http::HttpError &e) {
+        response.send(static_cast<Pistache::Http::Code>(e.code()), e.what());
+        return;
+    } catch (std::exception &e) {
+        this->handleOperationException(e, response);
+        return;
+    }
+
+    } catch (std::exception &e) {
+        response.send(Pistache::Http::Code::Internal_Server_Error, e.what());
+    }
+
+}
+void DefaultApi::plot_indexing_unit_cell_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response) {
+    try {
+
+
+    // Getting the query params
+    auto binningQuery = request.query().get("binning");
+    std::optional<int32_t> binning;
+    if(binningQuery.has_value()){
+        int32_t valueQuery_instance;
+        if(fromStringValue(binningQuery.value(), valueQuery_instance)){
+            binning = valueQuery_instance;
+        }
+    }
+    auto compressionQuery = request.query().get("compression");
+    std::optional<bool> compression;
+    if(compressionQuery.has_value()){
+        bool valueQuery_instance;
+        if(fromStringValue(compressionQuery.value(), valueQuery_instance)){
+            compression = valueQuery_instance;
+        }
+    }
+    
+    try {
+        this->plot_indexing_unit_cell_get(binning, compression, response);
+    } catch (Pistache::Http::HttpError &e) {
+        response.send(static_cast<Pistache::Http::Code>(e.code()), e.what());
+        return;
+    } catch (std::exception &e) {
+        this->handleOperationException(e, response);
+        return;
+    }
+
+    } catch (std::exception &e) {
+        response.send(Pistache::Http::Code::Internal_Server_Error, e.what());
+    }
+
 }
 void DefaultApi::plot_receiver_delay_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response) {
     try {

broker/gen/api/DefaultApi.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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -47,6 +47,7 @@
 #include "Roi_box_list.h"
 #include "Roi_circle_list.h"
 #include "Spot_finding_settings.h"
+#include "Zeromq_metadata_settings.h"
 #include "Zeromq_preview_settings.h"
 #include <string>
 #include <vector>
@@ -78,13 +79,18 @@ private:
     void config_instrument_put_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void config_internal_generator_image_put_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void config_internal_generator_image_tiff_put_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
+    void config_mask_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void config_mask_tiff_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void config_select_detector_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void config_select_detector_put_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void config_spot_finding_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void config_spot_finding_put_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
+    void config_user_mask_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
+    void config_user_mask_put_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void config_user_mask_tiff_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void config_user_mask_tiff_put_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
+    void config_zeromq_metadata_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
+    void config_zeromq_metadata_put_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void config_zeromq_preview_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void config_zeromq_preview_put_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void deactivate_post_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
@@ -97,6 +103,8 @@ private:
     void plot_error_pixel_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void plot_image_collection_efficiency_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void plot_indexing_rate_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
+    void plot_indexing_unit_cell_angle_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
+    void plot_indexing_unit_cell_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void plot_receiver_delay_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void plot_receiver_free_send_buffers_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
     void plot_roi_max_count_get_handler(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter response);
@@ -249,7 +257,14 @@ private:
     /// </remarks>
     virtual void config_internal_generator_image_tiff_put(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter &response) = 0;
     /// <summary>
-    /// Get mask of the detector
+    /// Get mask of the detector (binary)
+    /// </summary>
+    /// <remarks>
+    /// Get full pixel mask of the detector See NXmx standard for meaning of pixel values 
+    /// </remarks>
+    virtual void config_mask_get(Pistache::Http::ResponseWriter &response) = 0;
+    /// <summary>
+    /// Get mask of the detector (TIFF)
     /// </summary>
     /// <remarks>
     /// Get full pixel mask of the detector See NXmx standard for meaning of pixel values 
@@ -286,7 +301,21 @@ private:
     /// <param name="spotFindingSettings"> (optional)</param>
     virtual void config_spot_finding_put(const org::openapitools::server::model::Spot_finding_settings &spotFindingSettings, Pistache::Http::ResponseWriter &response) = 0;
     /// <summary>
-    /// Get user mask of the detector
+    /// Get user mask of the detector (binary)
+    /// </summary>
+    /// <remarks>
+    /// Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked
+    /// </remarks>
+    virtual void config_user_mask_get(Pistache::Http::ResponseWriter &response) = 0;
+    /// <summary>
+    /// Upload user mask of the detector (binary)
+    /// </summary>
+    /// <remarks>
+    /// Should be in &#x60;Idle&#x60; state. Upload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions. If detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates. In the latter case - module gaps are ignored and don&#39;t need to be assigned value. Mask is expected as binary array (4-byte; unsigned). 0 - good pixel, other value - masked User mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration. 
+    /// </remarks>
+    virtual void config_user_mask_put(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter &response) = 0;
+    /// <summary>
+    /// Get user mask of the detector (TIFF)
     /// </summary>
     /// <remarks>
     /// Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked
@@ -300,6 +329,21 @@ private:
     /// </remarks>
     virtual void config_user_mask_tiff_put(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter &response) = 0;
     /// <summary>
+    /// Get ZeroMQ metadata socket settings
+    /// </summary>
+    /// <remarks>
+    /// 
+    /// </remarks>
+    virtual void config_zeromq_metadata_get(Pistache::Http::ResponseWriter &response) = 0;
+    /// <summary>
+    /// Set ZeroMQ metadata settings
+    /// </summary>
+    /// <remarks>
+    /// Jungfraujoch can generate metadata message stream on ZeroMQ PUB socket. This stream covers all images. Here settings of the socket can be adjusted. While the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request. 
+    /// </remarks>
+    /// <param name="zeromqMetadataSettings"> (optional)</param>
+    virtual void config_zeromq_metadata_put(const org::openapitools::server::model::Zeromq_metadata_settings &zeromqMetadataSettings, Pistache::Http::ResponseWriter &response) = 0;
+    /// <summary>
     /// Get ZeroMQ preview settings
     /// </summary>
     /// <remarks>
@@ -361,7 +405,7 @@ private:
     /// Generate background estimate plot
     /// </summary>
     /// <remarks>
-    /// Mean intensity for d &#x3D; 3 - 5 A per image; binning is configurable
+    /// Mean intensity for d &#x3D; 3 - 5 A per image; binning is configurable 
     /// </remarks>
     /// <param name="binning">Binning of frames for the plot (0 &#x3D; default binning) (optional, default to 0)</param>
     /// <param name="compression">Enable DEFLATE compression of output data. (optional, default to true)</param>
@@ -394,6 +438,24 @@ private:
     /// <param name="compression">Enable DEFLATE compression of output data. (optional, default to true)</param>
     virtual void plot_indexing_rate_get(const std::optional<int32_t> &binning, const std::optional<bool> &compression, Pistache::Http::ResponseWriter &response) = 0;
     /// <summary>
+    /// Generate indexing unit cell angle plot
+    /// </summary>
+    /// <remarks>
+    /// Crystal unit cell based on indexing results; binning is configurable
+    /// </remarks>
+    /// <param name="binning">Binning of frames for the plot (0 &#x3D; default binning) (optional, default to 0)</param>
+    /// <param name="compression">Enable DEFLATE compression of output data. (optional, default to true)</param>
+    virtual void plot_indexing_unit_cell_angle_get(const std::optional<int32_t> &binning, const std::optional<bool> &compression, Pistache::Http::ResponseWriter &response) = 0;
+    /// <summary>
+    /// Generate indexing unit cell length plots
+    /// </summary>
+    /// <remarks>
+    /// Crystal unit cell based on indexing results; binning is configurable
+    /// </remarks>
+    /// <param name="binning">Binning of frames for the plot (0 &#x3D; default binning) (optional, default to 0)</param>
+    /// <param name="compression">Enable DEFLATE compression of output data. (optional, default to true)</param>
+    virtual void plot_indexing_unit_cell_get(const std::optional<int32_t> &binning, const std::optional<bool> &compression, Pistache::Http::ResponseWriter &response) = 0;
+    /// <summary>
     /// Generate receiver delay plot
     /// </summary>
     /// <remarks>
@@ -486,7 +548,7 @@ private:
     /// </remarks>
     virtual void preview_image_tiff_get(Pistache::Http::ResponseWriter &response) = 0;
     /// <summary>
-    /// Get pedestal G0 in TIFF format
+    /// Get pedestal in TIFF format
     /// </summary>
     /// <remarks>
     /// 
@@ -569,7 +631,7 @@ private:
     /// </remarks>
     virtual void trigger_post(Pistache::Http::ResponseWriter &response) = 0;
     /// <summary>
-    /// 
+    /// Get Jungfraujoch version of jfjoch_broker
     /// </summary>
     /// <remarks>
     /// 
@@ -579,7 +641,7 @@ private:
     /// Wait for acquisition done
     /// </summary>
     /// <remarks>
-    /// Block execution of external script till initialization, data collection or pedestal is finished. Running this command does not affect (cancel) running data collection, it is only to ensure synchronous execution of other software.          To not block web server for a indefinite period of time, the procedure is provided with a timeout. Extending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection. 
+    /// Block execution of external script till initialization, data collection or pedestal is finished. Running this command does not affect (cancel) running data collection, it is only to ensure synchronous execution of other software.  To not block web server for a indefinite period of time, the procedure is provided with a timeout. Extending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection. 
     /// </remarks>
     /// <param name="timeout">Timeout in seconds (0 &#x3D;&#x3D; immediate response) (optional, default to 60)</param>
     virtual void wait_till_done_post(const std::optional<int32_t> &timeout, Pistache::Http::ResponseWriter &response) = 0;

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -117,7 +117,7 @@ public:
     bool imagesPerFileIsSet() const;
     void unsetImages_per_file();
     /// <summary>
-    /// 
+    /// Number of space group for the crystal. Currently used solely as metadata, not relevant for image processing done in Jungfraujoch.
     /// </summary>
     int64_t getSpaceGroupNumber() const;
     void setSpaceGroupNumber(int64_t const value);
@@ -131,7 +131,7 @@ public:
     bool sampleNameIsSet() const;
     void unsetSample_name();
     /// <summary>
-    /// 
+    /// Compression type for the images transferred over ZeroMQ and saved to HDF5 file. 
     /// </summary>
     std::string getCompression() const;
     void setCompression(std::string const& value);
@@ -159,14 +159,14 @@ public:
     bool goniometerIsSet() const;
     void unsetGoniometer();
     /// <summary>
-    /// Header appendix, added as user_data/user to start message (can be any valid JSON)
+    /// Header appendix, added as user_data/user to start ZeroMQ message (can be any valid JSON) In general, it is not saved in HDF5 file.  However, if values are placed in \&quot;hdf5\&quot; object, &#x60;jfjoch_writer&#x60; will write them in /entry/data of the HDF5 file.  This applies solely to string and number (double floating-point). No arrays/sub-objects is allowed. For example {\&quot;hdf5\&quot;: {\&quot;val1\&quot;:1, \&quot;val2\&quot;:\&quot;xyz\&quot;}}, will write /entry/user/val1 and /entry/user/val2. 
     /// </summary>
     nlohmann::json getHeaderAppendix() const;
     void setHeaderAppendix(nlohmann::json const& value);
     bool headerAppendixIsSet() const;
     void unsetHeader_appendix();
     /// <summary>
-    /// Image appendix, added as user_data to image message (can be any valid JSON)
+    /// Image appendix, added as user_data to image ZeroMQ message (can be any valid JSON) Not saved in HDF5 file 
     /// </summary>
     nlohmann::json getImageAppendix() const;
     void setImageAppendix(nlohmann::json const& value);

broker/gen/model/Dataset_settings_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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

broker/gen/model/Dataset_settings_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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,7 +12,7 @@
 /*
  * Dataset_settings_unit_cell.h
  *
- * Units of angstrom and degree
+ * Unit cell parameters. Necessary to run indexing. Units of angstrom and degree
  */
 
 #ifndef Dataset_settings_unit_cell_H_
@@ -25,7 +25,7 @@ namespace org::openapitools::server::model
 {
 
 /// <summary>
-/// Units of angstrom and degree
+/// Unit cell parameters. Necessary to run indexing. Units of angstrom and degree
 /// </summary>
 class  Dataset_settings_unit_cell
 {

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

broker/gen/model/Detector_list_detectors_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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

broker/gen/model/Detector_list_detectors_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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -33,14 +33,14 @@ Detector_settings::Detector_settings()
     m_TimingIsSet = false;
     m_Eiger_threshold_keV = 0.0f;
     m_Eiger_threshold_keVIsSet = false;
+    m_Eiger_bit_depth = 0L;
+    m_Eiger_bit_depthIsSet = false;
     m_Jungfrau_pedestal_g0_frames = 2000L;
     m_Jungfrau_pedestal_g0_framesIsSet = false;
     m_Jungfrau_pedestal_g1_frames = 300L;
     m_Jungfrau_pedestal_g1_framesIsSet = false;
     m_Jungfrau_pedestal_g2_frames = 300L;
     m_Jungfrau_pedestal_g2_framesIsSet = false;
-    m_Jungfrau_pedestal_g0_rms_limit = 100L;
-    m_Jungfrau_pedestal_g0_rms_limitIsSet = false;
     m_Jungfrau_pedestal_min_image_count = 128L;
     m_Jungfrau_pedestal_min_image_countIsSet = false;
     m_Jungfrau_storage_cell_count = 1L;
@@ -99,10 +99,10 @@ bool Detector_settings::validate(std::stringstream& msg, const std::string& path
             success = false;
             msg << currentValuePath << ": must be greater than or equal to 1;";
         }
-        if (value > 128ll)
+        if (value > 64ll)
         {
             success = false;
-            msg << currentValuePath << ": must be less than or equal to 128;";
+            msg << currentValuePath << ": must be less than or equal to 64;";
         }
 
     }
@@ -139,7 +139,7 @@ bool Detector_settings::validate(std::stringstream& msg, const std::string& path
         }
 
     }
-         
+             
     if (jungfrauPedestalG0FramesIsSet())
     {
         const int64_t& value = m_Jungfrau_pedestal_g0_frames;
@@ -182,20 +182,6 @@ bool Detector_settings::validate(std::stringstream& msg, const std::string& path
 
     }
          
-    if (jungfrauPedestalG0RmsLimitIsSet())
-    {
-        const int64_t& value = m_Jungfrau_pedestal_g0_rms_limit;
-        const std::string currentValuePath = _pathPrefix + ".jungfrauPedestalG0RmsLimit";
-                
-        
-        if (value < 0ll)
-        {
-            success = false;
-            msg << currentValuePath << ": must be greater than or equal to 0;";
-        }
-
-    }
-         
     if (jungfrauPedestalMinImageCountIsSet())
     {
         const int64_t& value = m_Jungfrau_pedestal_min_image_count;
@@ -273,6 +259,9 @@ bool Detector_settings::operator==(const Detector_settings& rhs) const
     ((!eigerThresholdKeVIsSet() && !rhs.eigerThresholdKeVIsSet()) || (eigerThresholdKeVIsSet() && rhs.eigerThresholdKeVIsSet() && getEigerThresholdKeV() == rhs.getEigerThresholdKeV())) &&
     
     
+    ((!eigerBitDepthIsSet() && !rhs.eigerBitDepthIsSet()) || (eigerBitDepthIsSet() && rhs.eigerBitDepthIsSet() && getEigerBitDepth() == rhs.getEigerBitDepth())) &&
+    
+    
     ((!jungfrauPedestalG0FramesIsSet() && !rhs.jungfrauPedestalG0FramesIsSet()) || (jungfrauPedestalG0FramesIsSet() && rhs.jungfrauPedestalG0FramesIsSet() && getJungfrauPedestalG0Frames() == rhs.getJungfrauPedestalG0Frames())) &&
     
     
@@ -282,9 +271,6 @@ bool Detector_settings::operator==(const Detector_settings& rhs) const
     ((!jungfrauPedestalG2FramesIsSet() && !rhs.jungfrauPedestalG2FramesIsSet()) || (jungfrauPedestalG2FramesIsSet() && rhs.jungfrauPedestalG2FramesIsSet() && getJungfrauPedestalG2Frames() == rhs.getJungfrauPedestalG2Frames())) &&
     
     
-    ((!jungfrauPedestalG0RmsLimitIsSet() && !rhs.jungfrauPedestalG0RmsLimitIsSet()) || (jungfrauPedestalG0RmsLimitIsSet() && rhs.jungfrauPedestalG0RmsLimitIsSet() && getJungfrauPedestalG0RmsLimit() == rhs.getJungfrauPedestalG0RmsLimit())) &&
-    
-    
     ((!jungfrauPedestalMinImageCountIsSet() && !rhs.jungfrauPedestalMinImageCountIsSet()) || (jungfrauPedestalMinImageCountIsSet() && rhs.jungfrauPedestalMinImageCountIsSet() && getJungfrauPedestalMinImageCount() == rhs.getJungfrauPedestalMinImageCount())) &&
     
     
@@ -323,14 +309,14 @@ void to_json(nlohmann::json& j, const Detector_settings& o)
         j["timing"] = o.m_Timing;
     if(o.eigerThresholdKeVIsSet())
         j["eiger_threshold_keV"] = o.m_Eiger_threshold_keV;
+    if(o.eigerBitDepthIsSet())
+        j["eiger_bit_depth"] = o.m_Eiger_bit_depth;
     if(o.jungfrauPedestalG0FramesIsSet())
         j["jungfrau_pedestal_g0_frames"] = o.m_Jungfrau_pedestal_g0_frames;
     if(o.jungfrauPedestalG1FramesIsSet())
         j["jungfrau_pedestal_g1_frames"] = o.m_Jungfrau_pedestal_g1_frames;
     if(o.jungfrauPedestalG2FramesIsSet())
         j["jungfrau_pedestal_g2_frames"] = o.m_Jungfrau_pedestal_g2_frames;
-    if(o.jungfrauPedestalG0RmsLimitIsSet())
-        j["jungfrau_pedestal_g0_rms_limit"] = o.m_Jungfrau_pedestal_g0_rms_limit;
     if(o.jungfrauPedestalMinImageCountIsSet())
         j["jungfrau_pedestal_min_image_count"] = o.m_Jungfrau_pedestal_min_image_count;
     if(o.jungfrauStorageCellCountIsSet())
@@ -377,6 +363,11 @@ void from_json(const nlohmann::json& j, Detector_settings& o)
         j.at("eiger_threshold_keV").get_to(o.m_Eiger_threshold_keV);
         o.m_Eiger_threshold_keVIsSet = true;
     } 
+    if(j.find("eiger_bit_depth") != j.end())
+    {
+        j.at("eiger_bit_depth").get_to(o.m_Eiger_bit_depth);
+        o.m_Eiger_bit_depthIsSet = true;
+    } 
     if(j.find("jungfrau_pedestal_g0_frames") != j.end())
     {
         j.at("jungfrau_pedestal_g0_frames").get_to(o.m_Jungfrau_pedestal_g0_frames);
@@ -392,11 +383,6 @@ void from_json(const nlohmann::json& j, Detector_settings& o)
         j.at("jungfrau_pedestal_g2_frames").get_to(o.m_Jungfrau_pedestal_g2_frames);
         o.m_Jungfrau_pedestal_g2_framesIsSet = true;
     } 
-    if(j.find("jungfrau_pedestal_g0_rms_limit") != j.end())
-    {
-        j.at("jungfrau_pedestal_g0_rms_limit").get_to(o.m_Jungfrau_pedestal_g0_rms_limit);
-        o.m_Jungfrau_pedestal_g0_rms_limitIsSet = true;
-    } 
     if(j.find("jungfrau_pedestal_min_image_count") != j.end())
     {
         j.at("jungfrau_pedestal_min_image_count").get_to(o.m_Jungfrau_pedestal_min_image_count);
@@ -535,6 +521,23 @@ void Detector_settings::unsetEiger_threshold_keV()
 {
     m_Eiger_threshold_keVIsSet = false;
 }
+int64_t Detector_settings::getEigerBitDepth() const
+{
+    return m_Eiger_bit_depth;
+}
+void Detector_settings::setEigerBitDepth(int64_t const value)
+{
+    m_Eiger_bit_depth = value;
+    m_Eiger_bit_depthIsSet = true;
+}
+bool Detector_settings::eigerBitDepthIsSet() const
+{
+    return m_Eiger_bit_depthIsSet;
+}
+void Detector_settings::unsetEiger_bit_depth()
+{
+    m_Eiger_bit_depthIsSet = false;
+}
 int64_t Detector_settings::getJungfrauPedestalG0Frames() const
 {
     return m_Jungfrau_pedestal_g0_frames;
@@ -586,23 +589,6 @@ void Detector_settings::unsetJungfrau_pedestal_g2_frames()
 {
     m_Jungfrau_pedestal_g2_framesIsSet = false;
 }
-int64_t Detector_settings::getJungfrauPedestalG0RmsLimit() const
-{
-    return m_Jungfrau_pedestal_g0_rms_limit;
-}
-void Detector_settings::setJungfrauPedestalG0RmsLimit(int64_t const value)
-{
-    m_Jungfrau_pedestal_g0_rms_limit = value;
-    m_Jungfrau_pedestal_g0_rms_limitIsSet = true;
-}
-bool Detector_settings::jungfrauPedestalG0RmsLimitIsSet() const
-{
-    return m_Jungfrau_pedestal_g0_rms_limitIsSet;
-}
-void Detector_settings::unsetJungfrau_pedestal_g0_rms_limit()
-{
-    m_Jungfrau_pedestal_g0_rms_limitIsSet = false;
-}
 int64_t Detector_settings::getJungfrauPedestalMinImageCount() const
 {
     return m_Jungfrau_pedestal_min_image_count;

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -59,12 +59,12 @@ public:
     /// Detector_settings members
 
     /// <summary>
-    /// Interval between consecutive frames.
+    /// Interval between consecutive frames. This is internal frame time for the JUNGFRAU detector, image time has to be integer multiply of this number. For EIGER detector this is default frame time, not used otherwise 
     /// </summary>
     int64_t getFrameTimeUs() const;
     void setFrameTimeUs(int64_t const value);
     /// <summary>
-    /// Integration time of the detector. If not provided count time will be set to maximum value for a given frame time.
+    /// Integration time of the detector.  If not provided count time will be set to maximum value for a given frame time. 
     /// </summary>
     int64_t getCountTimeUs() const;
     void setCountTimeUs(int64_t const value);
@@ -78,7 +78,7 @@ public:
     bool internalFrameGeneratorIsSet() const;
     void unsetInternal_frame_generator();
     /// <summary>
-    /// 
+    /// Number of images stored in the internal frame generator.
     /// </summary>
     int64_t getInternalFrameGeneratorImages() const;
     void setInternalFrameGeneratorImages(int64_t const value);
@@ -99,13 +99,20 @@ public:
     bool timingIsSet() const;
     void unsetTiming();
     /// <summary>
-    /// 
+    /// Threshold for the EIGER detector. If value is provided, it will be used for all subsequent acquisitions, irrespective of beam energy. If value is not provided, threshold will be determined on start of acquisition as half of incident energy.  This might lead to increased start time. 
     /// </summary>
     float getEigerThresholdKeV() const;
     void setEigerThresholdKeV(float const value);
     bool eigerThresholdKeVIsSet() const;
     void unsetEiger_threshold_keV();
     /// <summary>
+    /// Bit depth of EIGER read-out.  If value is not provided bit depth is adjusted automatically based on the image time. 
+    /// </summary>
+    int64_t getEigerBitDepth() const;
+    void setEigerBitDepth(int64_t const value);
+    bool eigerBitDepthIsSet() const;
+    void unsetEiger_bit_depth();
+    /// <summary>
     /// 
     /// </summary>
     int64_t getJungfrauPedestalG0Frames() const;
@@ -127,13 +134,6 @@ public:
     bool jungfrauPedestalG2FramesIsSet() const;
     void unsetJungfrau_pedestal_g2_frames();
     /// <summary>
-    /// Pixels with pedestal G0 RMS above the threshold are marked as masked pixels
-    /// </summary>
-    int64_t getJungfrauPedestalG0RmsLimit() const;
-    void setJungfrauPedestalG0RmsLimit(int64_t const value);
-    bool jungfrauPedestalG0RmsLimitIsSet() const;
-    void unsetJungfrau_pedestal_g0_rms_limit();
-    /// <summary>
     /// Minimum number of collected images for pedestal to consider it viable
     /// </summary>
     int64_t getJungfrauPedestalMinImageCount() const;
@@ -186,14 +186,14 @@ protected:
     bool m_TimingIsSet;
     float m_Eiger_threshold_keV;
     bool m_Eiger_threshold_keVIsSet;
+    int64_t m_Eiger_bit_depth;
+    bool m_Eiger_bit_depthIsSet;
     int64_t m_Jungfrau_pedestal_g0_frames;
     bool m_Jungfrau_pedestal_g0_framesIsSet;
     int64_t m_Jungfrau_pedestal_g1_frames;
     bool m_Jungfrau_pedestal_g1_framesIsSet;
     int64_t m_Jungfrau_pedestal_g2_frames;
     bool m_Jungfrau_pedestal_g2_framesIsSet;
-    int64_t m_Jungfrau_pedestal_g0_rms_limit;
-    bool m_Jungfrau_pedestal_g0_rms_limitIsSet;
     int64_t m_Jungfrau_pedestal_min_image_count;
     bool m_Jungfrau_pedestal_min_image_countIsSet;
     int64_t m_Jungfrau_storage_cell_count;

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,6 +23,7 @@ Fpga_status_inner::Fpga_status_inner()
 {
     m_Pci_dev_id = "";
     m_Serial_number = "";
+    m_Fw_version = "";
     m_Base_mac_addr = "";
     m_Eth_link_count = 0L;
     m_Eth_link_status = 0L;
@@ -54,7 +55,7 @@ bool Fpga_status_inner::validate(std::stringstream& msg, const std::string& path
     bool success = true;
     const std::string _pathPrefix = pathPrefix.empty() ? "Fpga_status_inner" : pathPrefix;
 
-                                                
+                                                    
     return success;
 }
 
@@ -69,6 +70,9 @@ bool Fpga_status_inner::operator==(const Fpga_status_inner& rhs) const
     (getSerialNumber() == rhs.getSerialNumber())
      &&
     
+    (getFwVersion() == rhs.getFwVersion())
+     &&
+    
     (getBaseMacAddr() == rhs.getBaseMacAddr())
      &&
     
@@ -109,6 +113,7 @@ void to_json(nlohmann::json& j, const Fpga_status_inner& o)
     j = nlohmann::json::object();
     j["pci_dev_id"] = o.m_Pci_dev_id;
     j["serial_number"] = o.m_Serial_number;
+    j["fw_version"] = o.m_Fw_version;
     j["base_mac_addr"] = o.m_Base_mac_addr;
     j["eth_link_count"] = o.m_Eth_link_count;
     j["eth_link_status"] = o.m_Eth_link_status;
@@ -125,6 +130,7 @@ void from_json(const nlohmann::json& j, Fpga_status_inner& o)
 {
     j.at("pci_dev_id").get_to(o.m_Pci_dev_id);
     j.at("serial_number").get_to(o.m_Serial_number);
+    j.at("fw_version").get_to(o.m_Fw_version);
     j.at("base_mac_addr").get_to(o.m_Base_mac_addr);
     j.at("eth_link_count").get_to(o.m_Eth_link_count);
     j.at("eth_link_status").get_to(o.m_Eth_link_status);
@@ -153,6 +159,14 @@ void Fpga_status_inner::setSerialNumber(std::string const& value)
 {
     m_Serial_number = value;
 }
+std::string Fpga_status_inner::getFwVersion() const
+{
+    return m_Fw_version;
+}
+void Fpga_status_inner::setFwVersion(std::string const& value)
+{
+    m_Fw_version = value;
+}
 std::string Fpga_status_inner::getBaseMacAddr() const
 {
     return m_Base_mac_addr;

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -71,6 +71,11 @@ public:
     /// <summary>
     /// 
     /// </summary>
+    std::string getFwVersion() const;
+    void setFwVersion(std::string const& value);
+    /// <summary>
+    /// 
+    /// </summary>
     std::string getBaseMacAddr() const;
     void setBaseMacAddr(std::string const& value);
     /// <summary>
@@ -121,6 +126,8 @@ protected:
 
     std::string m_Serial_number;
 
+    std::string m_Fw_version;
+
     std::string m_Base_mac_addr;
 
     int64_t m_Eth_link_count;

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,6 +32,11 @@ Image_format_settings::Image_format_settings()
     m_Signed_outputIsSet = false;
     m_Mask_module_edges = true;
     m_Mask_chip_edges = true;
+    m_Jungfrau_mask_pixels_without_g0 = true;
+    m_Jungfrau_mask_pixels_without_g0IsSet = false;
+    m_Apply_mask = false;
+    m_Jungfrau_pedestal_g0_rms_limit = 100L;
+    m_Jungfrau_pedestal_g0_rms_limitIsSet = false;
     
 }
 
@@ -73,7 +78,21 @@ bool Image_format_settings::validate(std::stringstream& msg, const std::string&
         }
 
     }
-                    
+                                 
+    if (jungfrauPedestalG0RmsLimitIsSet())
+    {
+        const int64_t& value = m_Jungfrau_pedestal_g0_rms_limit;
+        const std::string currentValuePath = _pathPrefix + ".jungfrauPedestalG0RmsLimit";
+                
+        
+        if (value < 0ll)
+        {
+            success = false;
+            msg << currentValuePath << ": must be greater than or equal to 0;";
+        }
+
+    }
+    
     return success;
 }
 
@@ -104,8 +123,17 @@ bool Image_format_settings::operator==(const Image_format_settings& rhs) const
      &&
     
     (isMaskChipEdges() == rhs.isMaskChipEdges())
+     &&
     
     
+    ((!jungfrauMaskPixelsWithoutG0IsSet() && !rhs.jungfrauMaskPixelsWithoutG0IsSet()) || (jungfrauMaskPixelsWithoutG0IsSet() && rhs.jungfrauMaskPixelsWithoutG0IsSet() && isJungfrauMaskPixelsWithoutG0() == rhs.isJungfrauMaskPixelsWithoutG0())) &&
+    
+    (isApplyMask() == rhs.isApplyMask())
+     &&
+    
+    
+    ((!jungfrauPedestalG0RmsLimitIsSet() && !rhs.jungfrauPedestalG0RmsLimitIsSet()) || (jungfrauPedestalG0RmsLimitIsSet() && rhs.jungfrauPedestalG0RmsLimitIsSet() && getJungfrauPedestalG0RmsLimit() == rhs.getJungfrauPedestalG0RmsLimit()))
+    
     ;
 }
 
@@ -128,6 +156,11 @@ void to_json(nlohmann::json& j, const Image_format_settings& o)
         j["signed_output"] = o.m_Signed_output;
     j["mask_module_edges"] = o.m_Mask_module_edges;
     j["mask_chip_edges"] = o.m_Mask_chip_edges;
+    if(o.jungfrauMaskPixelsWithoutG0IsSet())
+        j["jungfrau_mask_pixels_without_g0"] = o.m_Jungfrau_mask_pixels_without_g0;
+    j["apply_mask"] = o.m_Apply_mask;
+    if(o.jungfrauPedestalG0RmsLimitIsSet())
+        j["jungfrau_pedestal_g0_rms_limit"] = o.m_Jungfrau_pedestal_g0_rms_limit;
     
 }
 
@@ -153,6 +186,17 @@ void from_json(const nlohmann::json& j, Image_format_settings& o)
     } 
     j.at("mask_module_edges").get_to(o.m_Mask_module_edges);
     j.at("mask_chip_edges").get_to(o.m_Mask_chip_edges);
+    if(j.find("jungfrau_mask_pixels_without_g0") != j.end())
+    {
+        j.at("jungfrau_mask_pixels_without_g0").get_to(o.m_Jungfrau_mask_pixels_without_g0);
+        o.m_Jungfrau_mask_pixels_without_g0IsSet = true;
+    } 
+    j.at("apply_mask").get_to(o.m_Apply_mask);
+    if(j.find("jungfrau_pedestal_g0_rms_limit") != j.end())
+    {
+        j.at("jungfrau_pedestal_g0_rms_limit").get_to(o.m_Jungfrau_pedestal_g0_rms_limit);
+        o.m_Jungfrau_pedestal_g0_rms_limitIsSet = true;
+    } 
     
 }
 
@@ -247,6 +291,48 @@ void Image_format_settings::setMaskChipEdges(bool const value)
 {
     m_Mask_chip_edges = value;
 }
+bool Image_format_settings::isJungfrauMaskPixelsWithoutG0() const
+{
+    return m_Jungfrau_mask_pixels_without_g0;
+}
+void Image_format_settings::setJungfrauMaskPixelsWithoutG0(bool const value)
+{
+    m_Jungfrau_mask_pixels_without_g0 = value;
+    m_Jungfrau_mask_pixels_without_g0IsSet = true;
+}
+bool Image_format_settings::jungfrauMaskPixelsWithoutG0IsSet() const
+{
+    return m_Jungfrau_mask_pixels_without_g0IsSet;
+}
+void Image_format_settings::unsetJungfrau_mask_pixels_without_g0()
+{
+    m_Jungfrau_mask_pixels_without_g0IsSet = false;
+}
+bool Image_format_settings::isApplyMask() const
+{
+    return m_Apply_mask;
+}
+void Image_format_settings::setApplyMask(bool const value)
+{
+    m_Apply_mask = value;
+}
+int64_t Image_format_settings::getJungfrauPedestalG0RmsLimit() const
+{
+    return m_Jungfrau_pedestal_g0_rms_limit;
+}
+void Image_format_settings::setJungfrauPedestalG0RmsLimit(int64_t const value)
+{
+    m_Jungfrau_pedestal_g0_rms_limit = value;
+    m_Jungfrau_pedestal_g0_rms_limitIsSet = true;
+}
+bool Image_format_settings::jungfrauPedestalG0RmsLimitIsSet() const
+{
+    return m_Jungfrau_pedestal_g0_rms_limitIsSet;
+}
+void Image_format_settings::unsetJungfrau_pedestal_g0_rms_limit()
+{
+    m_Jungfrau_pedestal_g0_rms_limitIsSet = false;
+}
 
 
 } // namespace org::openapitools::server::model

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -80,7 +80,7 @@ public:
     bool jungfrauConversionFactorKeVIsSet() const;
     void unsetJungfrau_conversion_factor_keV();
     /// <summary>
-    /// Bit depth of resulting image (it doesn&#39;t affect the original detector value) If not provided value is adjusted automatically 
+    /// Bit depth of resulting image (it doesn&#39;t affect the detector read-out value) If not provided value is adjusted automatically 
     /// </summary>
     int64_t getBitDepthImage() const;
     void setBitDepthImage(int64_t const value);
@@ -103,6 +103,25 @@ public:
     /// </summary>
     bool isMaskChipEdges() const;
     void setMaskChipEdges(bool const value);
+    /// <summary>
+    /// JUNGFRAU: mask pixels that don&#39;t operate in G0, but do operate in G1 and G1. This should be turned off for cases, where detector is operated at room temperature with long exposure time. 
+    /// </summary>
+    bool isJungfrauMaskPixelsWithoutG0() const;
+    void setJungfrauMaskPixelsWithoutG0(bool const value);
+    bool jungfrauMaskPixelsWithoutG0IsSet() const;
+    void unsetJungfrau_mask_pixels_without_g0();
+    /// <summary>
+    /// Masked pixels are set to special value in the images produced by Jungfraujoch 
+    /// </summary>
+    bool isApplyMask() const;
+    void setApplyMask(bool const value);
+    /// <summary>
+    /// Pixels with pedestal G0 RMS above the threshold are marked as masked pixels
+    /// </summary>
+    int64_t getJungfrauPedestalG0RmsLimit() const;
+    void setJungfrauPedestalG0RmsLimit(int64_t const value);
+    bool jungfrauPedestalG0RmsLimitIsSet() const;
+    void unsetJungfrau_pedestal_g0_rms_limit();
 
     friend  void to_json(nlohmann::json& j, const Image_format_settings& o);
     friend  void from_json(const nlohmann::json& j, Image_format_settings& o);
@@ -123,6 +142,12 @@ protected:
 
     bool m_Mask_chip_edges;
 
+    bool m_Jungfrau_mask_pixels_without_g0;
+    bool m_Jungfrau_mask_pixels_without_g0IsSet;
+    bool m_Apply_mask;
+
+    int64_t m_Jungfrau_pedestal_g0_rms_limit;
+    bool m_Jungfrau_pedestal_g0_rms_limitIsSet;
     
 };
 

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -35,6 +35,7 @@ Jfjoch_settings::Jfjoch_settings()
     m_Numa_policyIsSet = false;
     m_Frontend_directory = "";
     m_Zeromq_previewIsSet = false;
+    m_Zeromq_metadataIsSet = false;
     
 }
 
@@ -132,7 +133,7 @@ bool Jfjoch_settings::validate(std::stringstream& msg, const std::string& pathPr
         }
 
     }
-                    
+                        
     return success;
 }
 
@@ -178,7 +179,10 @@ bool Jfjoch_settings::operator==(const Jfjoch_settings& rhs) const
      &&
     
     
-    ((!zeromqPreviewIsSet() && !rhs.zeromqPreviewIsSet()) || (zeromqPreviewIsSet() && rhs.zeromqPreviewIsSet() && getZeromqPreview() == rhs.getZeromqPreview()))
+    ((!zeromqPreviewIsSet() && !rhs.zeromqPreviewIsSet()) || (zeromqPreviewIsSet() && rhs.zeromqPreviewIsSet() && getZeromqPreview() == rhs.getZeromqPreview())) &&
+    
+    
+    ((!zeromqMetadataIsSet() && !rhs.zeromqMetadataIsSet()) || (zeromqMetadataIsSet() && rhs.zeromqMetadataIsSet() && getZeromqMetadata() == rhs.getZeromqMetadata()))
     
     ;
 }
@@ -214,6 +218,8 @@ void to_json(nlohmann::json& j, const Jfjoch_settings& o)
     j["image_pusher"] = o.m_Image_pusher;
     if(o.zeromqPreviewIsSet())
         j["zeromq_preview"] = o.m_Zeromq_preview;
+    if(o.zeromqMetadataIsSet())
+        j["zeromq_metadata"] = o.m_Zeromq_metadata;
     
 }
 
@@ -272,6 +278,11 @@ void from_json(const nlohmann::json& j, Jfjoch_settings& o)
         j.at("zeromq_preview").get_to(o.m_Zeromq_preview);
         o.m_Zeromq_previewIsSet = true;
     } 
+    if(j.find("zeromq_metadata") != j.end())
+    {
+        j.at("zeromq_metadata").get_to(o.m_Zeromq_metadata);
+        o.m_Zeromq_metadataIsSet = true;
+    } 
     
 }
 
@@ -469,6 +480,23 @@ void Jfjoch_settings::unsetZeromq_preview()
 {
     m_Zeromq_previewIsSet = false;
 }
+org::openapitools::server::model::Zeromq_metadata_settings Jfjoch_settings::getZeromqMetadata() const
+{
+    return m_Zeromq_metadata;
+}
+void Jfjoch_settings::setZeromqMetadata(org::openapitools::server::model::Zeromq_metadata_settings const& value)
+{
+    m_Zeromq_metadata = value;
+    m_Zeromq_metadataIsSet = true;
+}
+bool Jfjoch_settings::zeromqMetadataIsSet() const
+{
+    return m_Zeromq_metadataIsSet;
+}
+void Jfjoch_settings::unsetZeromq_metadata()
+{
+    m_Zeromq_metadataIsSet = false;
+}
 
 
 } // namespace org::openapitools::server::model

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,6 +27,7 @@
 #include "Zeromq_settings.h"
 #include "Azim_int_settings.h"
 #include "Image_format_settings.h"
+#include "Zeromq_metadata_settings.h"
 #include "Detector_settings.h"
 #include "Instrument_metadata.h"
 #include <vector>
@@ -153,6 +154,13 @@ public:
     void setZeromqPreview(org::openapitools::server::model::Zeromq_preview_settings const& value);
     bool zeromqPreviewIsSet() const;
     void unsetZeromq_preview();
+    /// <summary>
+    /// 
+    /// </summary>
+    org::openapitools::server::model::Zeromq_metadata_settings getZeromqMetadata() const;
+    void setZeromqMetadata(org::openapitools::server::model::Zeromq_metadata_settings const& value);
+    bool zeromqMetadataIsSet() const;
+    void unsetZeromq_metadata();
 
     friend  void to_json(nlohmann::json& j, const Jfjoch_settings& o);
     friend  void from_json(const nlohmann::json& j, Jfjoch_settings& o);
@@ -183,6 +191,8 @@ protected:
 
     org::openapitools::server::model::Zeromq_preview_settings m_Zeromq_preview;
     bool m_Zeromq_previewIsSet;
+    org::openapitools::server::model::Zeromq_metadata_settings m_Zeromq_metadata;
+    bool m_Zeromq_metadataIsSet;
     
 };
 

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,6 +32,8 @@ Jfjoch_statistics::Jfjoch_statistics()
     m_FpgaIsSet = false;
     m_CalibrationIsSet = false;
     m_Zeromq_previewIsSet = false;
+    m_Zeromq_metadataIsSet = false;
+    m_Pixel_maskIsSet = false;
     
 }
 
@@ -96,7 +98,7 @@ bool Jfjoch_statistics::validate(std::stringstream& msg, const std::string& path
         }
 
     }
-        
+                
     return success;
 }
 
@@ -136,7 +138,13 @@ bool Jfjoch_statistics::operator==(const Jfjoch_statistics& rhs) const
     ((!calibrationIsSet() && !rhs.calibrationIsSet()) || (calibrationIsSet() && rhs.calibrationIsSet() && getCalibration() == rhs.getCalibration())) &&
     
     
-    ((!zeromqPreviewIsSet() && !rhs.zeromqPreviewIsSet()) || (zeromqPreviewIsSet() && rhs.zeromqPreviewIsSet() && getZeromqPreview() == rhs.getZeromqPreview()))
+    ((!zeromqPreviewIsSet() && !rhs.zeromqPreviewIsSet()) || (zeromqPreviewIsSet() && rhs.zeromqPreviewIsSet() && getZeromqPreview() == rhs.getZeromqPreview())) &&
+    
+    
+    ((!zeromqMetadataIsSet() && !rhs.zeromqMetadataIsSet()) || (zeromqMetadataIsSet() && rhs.zeromqMetadataIsSet() && getZeromqMetadata() == rhs.getZeromqMetadata())) &&
+    
+    
+    ((!pixelMaskIsSet() && !rhs.pixelMaskIsSet()) || (pixelMaskIsSet() && rhs.pixelMaskIsSet() && getPixelMask() == rhs.getPixelMask()))
     
     ;
 }
@@ -171,6 +179,10 @@ void to_json(nlohmann::json& j, const Jfjoch_statistics& o)
         j["calibration"] = o.m_Calibration;
     if(o.zeromqPreviewIsSet())
         j["zeromq_preview"] = o.m_Zeromq_preview;
+    if(o.zeromqMetadataIsSet())
+        j["zeromq_metadata"] = o.m_Zeromq_metadata;
+    if(o.pixelMaskIsSet())
+        j["pixel_mask"] = o.m_Pixel_mask;
     
 }
 
@@ -231,6 +243,16 @@ void from_json(const nlohmann::json& j, Jfjoch_statistics& o)
         j.at("zeromq_preview").get_to(o.m_Zeromq_preview);
         o.m_Zeromq_previewIsSet = true;
     } 
+    if(j.find("zeromq_metadata") != j.end())
+    {
+        j.at("zeromq_metadata").get_to(o.m_Zeromq_metadata);
+        o.m_Zeromq_metadataIsSet = true;
+    } 
+    if(j.find("pixel_mask") != j.end())
+    {
+        j.at("pixel_mask").get_to(o.m_Pixel_mask);
+        o.m_Pixel_maskIsSet = true;
+    } 
     
 }
 
@@ -421,6 +443,40 @@ void Jfjoch_statistics::unsetZeromq_preview()
 {
     m_Zeromq_previewIsSet = false;
 }
+org::openapitools::server::model::Zeromq_metadata_settings Jfjoch_statistics::getZeromqMetadata() const
+{
+    return m_Zeromq_metadata;
+}
+void Jfjoch_statistics::setZeromqMetadata(org::openapitools::server::model::Zeromq_metadata_settings const& value)
+{
+    m_Zeromq_metadata = value;
+    m_Zeromq_metadataIsSet = true;
+}
+bool Jfjoch_statistics::zeromqMetadataIsSet() const
+{
+    return m_Zeromq_metadataIsSet;
+}
+void Jfjoch_statistics::unsetZeromq_metadata()
+{
+    m_Zeromq_metadataIsSet = false;
+}
+org::openapitools::server::model::Pixel_mask_statistics Jfjoch_statistics::getPixelMask() const
+{
+    return m_Pixel_mask;
+}
+void Jfjoch_statistics::setPixelMask(org::openapitools::server::model::Pixel_mask_statistics const& value)
+{
+    m_Pixel_mask = value;
+    m_Pixel_maskIsSet = true;
+}
+bool Jfjoch_statistics::pixelMaskIsSet() const
+{
+    return m_Pixel_maskIsSet;
+}
+void Jfjoch_statistics::unsetPixel_mask()
+{
+    m_Pixel_maskIsSet = false;
+}
 
 
 } // namespace org::openapitools::server::model

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -20,17 +20,19 @@
 
 
 #include "Calibration_statistics_inner.h"
-#include "Detector_status.h"
 #include "Broker_status.h"
+#include "Pixel_mask_statistics.h"
 #include "Measurement_statistics.h"
 #include "Spot_finding_settings.h"
 #include "Zeromq_preview_settings.h"
 #include "Detector_list.h"
-#include "Fpga_status_inner.h"
 #include "Image_format_settings.h"
+#include "Zeromq_metadata_settings.h"
 #include "Detector_settings.h"
-#include "Instrument_metadata.h"
 #include <vector>
+#include "Detector_status.h"
+#include "Fpga_status_inner.h"
+#include "Instrument_metadata.h"
 #include <nlohmann/json.hpp>
 
 namespace org::openapitools::server::model
@@ -146,6 +148,20 @@ public:
     void setZeromqPreview(org::openapitools::server::model::Zeromq_preview_settings const& value);
     bool zeromqPreviewIsSet() const;
     void unsetZeromq_preview();
+    /// <summary>
+    /// 
+    /// </summary>
+    org::openapitools::server::model::Zeromq_metadata_settings getZeromqMetadata() const;
+    void setZeromqMetadata(org::openapitools::server::model::Zeromq_metadata_settings const& value);
+    bool zeromqMetadataIsSet() const;
+    void unsetZeromq_metadata();
+    /// <summary>
+    /// 
+    /// </summary>
+    org::openapitools::server::model::Pixel_mask_statistics getPixelMask() const;
+    void setPixelMask(org::openapitools::server::model::Pixel_mask_statistics const& value);
+    bool pixelMaskIsSet() const;
+    void unsetPixel_mask();
 
     friend  void to_json(nlohmann::json& j, const Jfjoch_statistics& o);
     friend  void from_json(const nlohmann::json& j, Jfjoch_statistics& o);
@@ -172,6 +188,10 @@ protected:
     bool m_CalibrationIsSet;
     org::openapitools::server::model::Zeromq_preview_settings m_Zeromq_preview;
     bool m_Zeromq_previewIsSet;
+    org::openapitools::server::model::Zeromq_metadata_settings m_Zeromq_metadata;
+    bool m_Zeromq_metadataIsSet;
+    org::openapitools::server::model::Pixel_mask_statistics m_Pixel_mask;
+    bool m_Pixel_maskIsSet;
     
 };
 

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

broker/gen/model/Pixel_mask_statistics.cpp

@@ -0,0 +1,206 @@
+/**
+* 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. 
+*
+* The version of the OpenAPI document: 1.0.0-rc.26
+* Contact: filip.leonarski@psi.ch
+*
+* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+* https://openapi-generator.tech
+* Do not edit the class manually.
+*/
+
+
+#include "Pixel_mask_statistics.h"
+#include "Helpers.h"
+
+#include <sstream>
+
+namespace org::openapitools::server::model
+{
+
+Pixel_mask_statistics::Pixel_mask_statistics()
+{
+    m_User_mask = 0L;
+    m_User_maskIsSet = false;
+    m_Too_high_pedestal_rms = 0L;
+    m_Too_high_pedestal_rmsIsSet = false;
+    m_Wrong_gain = 0L;
+    m_Wrong_gainIsSet = false;
+    
+}
+
+void Pixel_mask_statistics::validate() const
+{
+    std::stringstream msg;
+    if (!validate(msg))
+    {
+        throw org::openapitools::server::helpers::ValidationException(msg.str());
+    }
+}
+
+bool Pixel_mask_statistics::validate(std::stringstream& msg) const
+{
+    return validate(msg, "");
+}
+
+bool Pixel_mask_statistics::validate(std::stringstream& msg, const std::string& pathPrefix) const
+{
+    bool success = true;
+    const std::string _pathPrefix = pathPrefix.empty() ? "Pixel_mask_statistics" : pathPrefix;
+
+         
+    if (userMaskIsSet())
+    {
+        const int64_t& value = m_User_mask;
+        const std::string currentValuePath = _pathPrefix + ".userMask";
+                
+        
+        if (value < 0ll)
+        {
+            success = false;
+            msg << currentValuePath << ": must be greater than or equal to 0;";
+        }
+
+    }
+         
+    if (tooHighPedestalRmsIsSet())
+    {
+        const int64_t& value = m_Too_high_pedestal_rms;
+        const std::string currentValuePath = _pathPrefix + ".tooHighPedestalRms";
+                
+        
+        if (value < 0ll)
+        {
+            success = false;
+            msg << currentValuePath << ": must be greater than or equal to 0;";
+        }
+
+    }
+         
+    if (wrongGainIsSet())
+    {
+        const int64_t& value = m_Wrong_gain;
+        const std::string currentValuePath = _pathPrefix + ".wrongGain";
+                
+        
+        if (value < 0ll)
+        {
+            success = false;
+            msg << currentValuePath << ": must be greater than or equal to 0;";
+        }
+
+    }
+    
+    return success;
+}
+
+bool Pixel_mask_statistics::operator==(const Pixel_mask_statistics& rhs) const
+{
+    return
+    
+    
+    
+    ((!userMaskIsSet() && !rhs.userMaskIsSet()) || (userMaskIsSet() && rhs.userMaskIsSet() && getUserMask() == rhs.getUserMask())) &&
+    
+    
+    ((!tooHighPedestalRmsIsSet() && !rhs.tooHighPedestalRmsIsSet()) || (tooHighPedestalRmsIsSet() && rhs.tooHighPedestalRmsIsSet() && getTooHighPedestalRms() == rhs.getTooHighPedestalRms())) &&
+    
+    
+    ((!wrongGainIsSet() && !rhs.wrongGainIsSet()) || (wrongGainIsSet() && rhs.wrongGainIsSet() && getWrongGain() == rhs.getWrongGain()))
+    
+    ;
+}
+
+bool Pixel_mask_statistics::operator!=(const Pixel_mask_statistics& rhs) const
+{
+    return !(*this == rhs);
+}
+
+void to_json(nlohmann::json& j, const Pixel_mask_statistics& o)
+{
+    j = nlohmann::json::object();
+    if(o.userMaskIsSet())
+        j["user_mask"] = o.m_User_mask;
+    if(o.tooHighPedestalRmsIsSet())
+        j["too_high_pedestal_rms"] = o.m_Too_high_pedestal_rms;
+    if(o.wrongGainIsSet())
+        j["wrong_gain"] = o.m_Wrong_gain;
+    
+}
+
+void from_json(const nlohmann::json& j, Pixel_mask_statistics& o)
+{
+    if(j.find("user_mask") != j.end())
+    {
+        j.at("user_mask").get_to(o.m_User_mask);
+        o.m_User_maskIsSet = true;
+    } 
+    if(j.find("too_high_pedestal_rms") != j.end())
+    {
+        j.at("too_high_pedestal_rms").get_to(o.m_Too_high_pedestal_rms);
+        o.m_Too_high_pedestal_rmsIsSet = true;
+    } 
+    if(j.find("wrong_gain") != j.end())
+    {
+        j.at("wrong_gain").get_to(o.m_Wrong_gain);
+        o.m_Wrong_gainIsSet = true;
+    } 
+    
+}
+
+int64_t Pixel_mask_statistics::getUserMask() const
+{
+    return m_User_mask;
+}
+void Pixel_mask_statistics::setUserMask(int64_t const value)
+{
+    m_User_mask = value;
+    m_User_maskIsSet = true;
+}
+bool Pixel_mask_statistics::userMaskIsSet() const
+{
+    return m_User_maskIsSet;
+}
+void Pixel_mask_statistics::unsetUser_mask()
+{
+    m_User_maskIsSet = false;
+}
+int64_t Pixel_mask_statistics::getTooHighPedestalRms() const
+{
+    return m_Too_high_pedestal_rms;
+}
+void Pixel_mask_statistics::setTooHighPedestalRms(int64_t const value)
+{
+    m_Too_high_pedestal_rms = value;
+    m_Too_high_pedestal_rmsIsSet = true;
+}
+bool Pixel_mask_statistics::tooHighPedestalRmsIsSet() const
+{
+    return m_Too_high_pedestal_rmsIsSet;
+}
+void Pixel_mask_statistics::unsetToo_high_pedestal_rms()
+{
+    m_Too_high_pedestal_rmsIsSet = false;
+}
+int64_t Pixel_mask_statistics::getWrongGain() const
+{
+    return m_Wrong_gain;
+}
+void Pixel_mask_statistics::setWrongGain(int64_t const value)
+{
+    m_Wrong_gain = value;
+    m_Wrong_gainIsSet = true;
+}
+bool Pixel_mask_statistics::wrongGainIsSet() const
+{
+    return m_Wrong_gainIsSet;
+}
+void Pixel_mask_statistics::unsetWrong_gain()
+{
+    m_Wrong_gainIsSet = false;
+}
+
+
+} // namespace org::openapitools::server::model
+

broker/gen/model/Pixel_mask_statistics.h

@@ -0,0 +1,96 @@
+/**
+* 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. 
+*
+* The version of the OpenAPI document: 1.0.0-rc.26
+* Contact: filip.leonarski@psi.ch
+*
+* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+* https://openapi-generator.tech
+* Do not edit the class manually.
+*/
+/*
+ * Pixel_mask_statistics.h
+ *
+ * 
+ */
+
+#ifndef Pixel_mask_statistics_H_
+#define Pixel_mask_statistics_H_
+
+
+#include <nlohmann/json.hpp>
+
+namespace org::openapitools::server::model
+{
+
+/// <summary>
+/// 
+/// </summary>
+class  Pixel_mask_statistics
+{
+public:
+    Pixel_mask_statistics();
+    virtual ~Pixel_mask_statistics() = default;
+
+
+    /// <summary>
+    /// Validate the current data in the model. Throws a ValidationException on failure.
+    /// </summary>
+    void validate() const;
+
+    /// <summary>
+    /// Validate the current data in the model. Returns false on error and writes an error
+    /// message into the given stringstream.
+    /// </summary>
+    bool validate(std::stringstream& msg) const;
+
+    /// <summary>
+    /// Helper overload for validate. Used when one model stores another model and calls it's validate.
+    /// Not meant to be called outside that case.
+    /// </summary>
+    bool validate(std::stringstream& msg, const std::string& pathPrefix) const;
+
+    bool operator==(const Pixel_mask_statistics& rhs) const;
+    bool operator!=(const Pixel_mask_statistics& rhs) const;
+
+    /////////////////////////////////////////////
+    /// Pixel_mask_statistics members
+
+    /// <summary>
+    /// Number of pixels masked using the user mask
+    /// </summary>
+    int64_t getUserMask() const;
+    void setUserMask(int64_t const value);
+    bool userMaskIsSet() const;
+    void unsetUser_mask();
+    /// <summary>
+    /// Number of pixels with G0 pedestal RMS higher than provided threshold
+    /// </summary>
+    int64_t getTooHighPedestalRms() const;
+    void setTooHighPedestalRms(int64_t const value);
+    bool tooHighPedestalRmsIsSet() const;
+    void unsetToo_high_pedestal_rms();
+    /// <summary>
+    /// Number of pixels that show wrong gain level during the pedestal procedure
+    /// </summary>
+    int64_t getWrongGain() const;
+    void setWrongGain(int64_t const value);
+    bool wrongGainIsSet() const;
+    void unsetWrong_gain();
+
+    friend  void to_json(nlohmann::json& j, const Pixel_mask_statistics& o);
+    friend  void from_json(const nlohmann::json& j, Pixel_mask_statistics& o);
+protected:
+    int64_t m_User_mask;
+    bool m_User_maskIsSet;
+    int64_t m_Too_high_pedestal_rms;
+    bool m_Too_high_pedestal_rmsIsSet;
+    int64_t m_Wrong_gain;
+    bool m_Wrong_gainIsSet;
+    
+};
+
+} // namespace org::openapitools::server::model
+
+#endif /* Pixel_mask_statistics_H_ */

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

broker/gen/model/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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

broker/gen/model/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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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. 
 *
-* The version of the OpenAPI document: 1.0.0-rc.21
+* The version of the OpenAPI document: 1.0.0-rc.26
 * Contact: filip.leonarski@psi.ch
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).