diff --git a/.gitea/workflows/build_and_test.yml b/.gitea/workflows/build_and_test.yml index e428b70b9..cfa1566bb 100644 --- a/.gitea/workflows/build_and_test.yml +++ b/.gitea/workflows/build_and_test.yml @@ -680,9 +680,11 @@ jobs: set -o pipefail # ends with one line per set (rugnux / reference, a tick or cross on the space group); # exits non-zero when a ci-tier set failed. The wrong-model null is the next step. + # --no-refine: the placed model is not refined - refinement runs after every decision this battery + # scores, and a large model's refinement took most of the job (4nwv ~50 min on the runner's card). JFJOCH_BATTERY_SITE=/tmp/site.json /tmp/bvenv/bin/python tools/battery/battery.py run \ --rugnux build/rugnux/rugnux --build-dir build --label "$LABEL" --no-nullmodel \ - $SUBSET 2>&1 | tee battery.log + --extra=--no-refine $SUBSET 2>&1 | tee battery.log - name: Wrong-model null if: ${{ !cancelled() && steps.build.outcome == 'success' && contains(env.SUBSET, '--tier ci') }} shell: bash diff --git a/CLAUDE.md b/CLAUDE.md index d90043cb0..bdb92e88b 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -16,7 +16,7 @@ changing CLI behaviour, update the parser, that page and, for a basic option, th ## Build Out-of-source CMake build, C++20, heavy use of `FetchContent` (spdlog, zstd, HDF5, -slsDetectorPackage, Catch2, cpp-httplib, libzmq, libtiff, FFTW, Ceres (with abseil), zlib-ng and Eigen are +slsDetectorPackage, Catch2, cpp-httplib, libzmq, libtiff, Ceres (with abseil), zlib-ng and Eigen are downloaded and statically linked — the **first configure needs network access** and is slow; the fast-feedback indexer behind FFBIDX is vendored in `image_analysis/indexing/fast-feedback-indexer/`). **No library has to come from the host**: `zlib-devel`/`eigen3-devel` are no longer needed. @@ -38,8 +38,11 @@ make -j$(nproc) jfjoch_broker # the main service; build other targets by na Key CMake options: - `JFJOCH_USE_CUDA` (default ON) — GPU path. Needs CUDA ≥ 12.8 (older is warned about and ignored). Provides the `ffbidx` and `fft` GPU indexers; without it the indexers are the CPU `fftw` - and a CPU port of the fast-feedback indexer (`FFBIDXIndexerCPU`, always built). FFTW is fetched and - `JFJOCH_USE_FFTW` defined unconditionally, so `fftw` is always there. CUDA absence is not a build + and a CPU port of the fast-feedback indexer (`FFBIDXIndexerCPU`, always built). Every CPU FFT (the + `fftw` indexer, beam-centre search, tNCS, model maps, MR, the viewer's chart) goes through + `common/CpuFFT` on the pocketfft header vendored with gemmi - FFTW is no longer a dependency, the + `fftw`/`FFTW` name is kept for the CPU indexer only for back compatibility. pocketfft vectorises + with GCC/Clang vector extensions and runs scalar under MSVC. CUDA absence is not a build error — nvcc is looked for on `PATH`, `CUDA_PATH`, `CUDA_HOME`, `CUDA_ROOT`, `/usr/local/cuda` and `/opt/cuda`. - `JFJOCH_WRITER_ONLY` (default OFF) — builds only the HDF5 writer (with the detector control, @@ -314,9 +317,12 @@ Check first and do not duplicate a credit an adjacent comment already carries. ## Local end-to-end run (no detector / no FPGA) -The FPGA HLS logic can be simulated on the CPU (`HLSSimulatedDevice`), so the full software -stack runs without hardware (slowly — fixed-point math on CPU). See -`docs/JFJOCH_BROKER.md` for the canonical walkthrough. +Without a `pcie` entry in its config the broker runs on `MockAcquisitionDevice` +(`acquisition_device/`), a black-box mock of the FPGA card: it reproduces the card's interface +towards the host (frames, completions, counters, start/stop/cancel, internal frame generator, the +error and timeout paths) but computes nothing — the images are the uploaded generator images as +given, and the card's spot-finding/ROI/azimuthal results are zero. The same mock carries the +receiver, state-machine and writer tests. See `docs/JFJOCH_BROKER.md` for the canonical walkthrough. ``` cd build/broker @@ -393,14 +399,14 @@ CXX_THREADS). The indexer is chosen with `-X` (`Auto|FFT|cuFFT|FFTW|FFBIDX|None`, default `Auto`, which resolves to a GPU indexer when one is present and `fftw` otherwise): `ffbidx` wants a known cell (`-C`) and suits sparse serial stills; `fft` indexes de novo and suits strong rotation data - it is the algorithm, run -with cuFFT on a GPU and with FFTW without one (or under `--no-gpu`), while `cufft`/`fftw` name one +with cuFFT on a GPU and with pocketfft without one (or under `--no-gpu`), while `cufft`/`fftw` name one implementation each. Only rugnux's CLI spells it this way: internally (and in the broker's OpenAPI) `FFT` is the GPU implementation, which the CLI's `cufft` maps onto. -**FPGA** (`fpga/`): `hls/` is the Vitis HLS source (image-analysis kernels), `hls_simulation/` -runs that same HLS on CPU for hardware-free testing, `hdl/` is the Verilog RTL, `host_library/` is -the host-side driver, `pcie_driver/` is the kernel module. The HLS algorithms are documented in -`docs/FPGA_DATA_ANALYSIS.md`. +**FPGA** (`fpga/`): `hls/` is the Vitis HLS source (image-analysis kernels), kept as reference: nothing +builds it - the tree has no firmware build targets and carries no Xilinx headers (`ap_int.h` etc.). `hdl/` is the Verilog RTL, `host_library/` is the +host-side driver, `pcie_driver/` is the kernel module. The HLS algorithms are documented in `docs/FPGA_DATA_ANALYSIS.md`. The software is +tested without hardware on `MockAcquisitionDevice`, not on a simulation of the firmware. **Detector control** (`detector_control/`): wrappers for SLS (JUNGFRAU) and DECTRIS SIMPLON (EIGER). **`jungfrau/`**: JUNGFRAU ADU→energy gain/pedestal calibration. diff --git a/CMakeLists.txt b/CMakeLists.txt index bceae25a0..88e03e81b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2023 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only + CMAKE_MINIMUM_REQUIRED(VERSION 3.26) # The VERSION file is the single source of truth for the version, and JFJOCH_VERSION carries it @@ -471,44 +474,6 @@ FetchContent_Declare(tiff EXCLUDE_FROM_ALL) FetchContent_MakeAvailable(tiff) -# FFTW single precision (target fftw3f): the CPU fallback indexer, enables JFJOCH_USE_FFTW. -# Built from the release tarball -- the git repo ships no pre-generated codelets (needs the -# OCaml genfft). -SET(ENABLE_FLOAT ON CACHE BOOL "" FORCE) -SET(BUILD_TESTS OFF CACHE BOOL "" FORCE) -# SIMD codelets are runtime-dispatched (cpuid), so enabling AVX2 does NOT require an AVX2 CPU -# -- FFTW falls back at runtime. The codelet sets are arch-specific, so guard by processor: -# x86 gets SSE2/AVX/AVX2, aarch64 (Apple Silicon, Grace on DGX Spark) gets NEON - added below the -# FetchContent, as FFTW's CMake build has no switch for it; other arches build scalar. -IF (CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|AMD64|amd64") - SET(ENABLE_SSE2 ON CACHE BOOL "" FORCE) - SET(ENABLE_AVX ON CACHE BOOL "" FORCE) - SET(ENABLE_AVX2 ON CACHE BOOL "" FORCE) -ENDIF() -FetchContent_Declare(fftw - URL https://www.fftw.org/fftw-3.3.10.tar.gz - URL_HASH SHA256=56c932549852cddcfafdab3820b0200c7742675be92179e59e6215b340e26467 - EXCLUDE_FROM_ALL) -FetchContent_MakeAvailable(fftw) -# FFTW exposes fftw3.h only via $, so consuming fftw3f straight from -# the build tree (FetchContent) leaves the header unreachable. On Linux a system-installed -# fftw3.h masks this; on Windows it does not. Add the source-tree api/ dir for build-tree use. -TARGET_INCLUDE_DIRECTORIES(fftw3f INTERFACE $) -# NEON: only FFTW's autotools build knows it (--enable-neon); its CMake build silently builds scalar -# code on ARM (and ignores an ENABLE_NEON, as this file once set). So the NEON codelets are added -# the way its CMakeLists adds the SSE2/AVX ones: the sources, and HAVE_NEON so that dft/conf.c and -# rdft/conf.c register them - as a definition, because its config.h template carries HAVE_NEON only -# as a comment. NEON is part of every aarch64 CPU, so no compiler flag is needed. It is single -# precision, which is all that is built here. Measured on Apple Silicon against the scalar build -# (same results to 1e-8): the indexer's batched 1D r2c 1.8x faster at a power-of-two length and 1.3x -# at 730, the 2D r2c of the beam-centre search 1.9x, a 128^3 c2r map 2.6x. -IF (CMAKE_SYSTEM_PROCESSOR MATCHES "aarch64|arm64|ARM64") - FILE(GLOB _fftw_neon_sources ${fftw_SOURCE_DIR}/dft/simd/neon/*.c ${fftw_SOURCE_DIR}/rdft/simd/neon/*.c) - TARGET_SOURCES(fftw3f PRIVATE ${_fftw_neon_sources}) - TARGET_COMPILE_DEFINITIONS(fftw3f PRIVATE HAVE_NEON=1) -ENDIF() -ADD_COMPILE_DEFINITIONS(JFJOCH_USE_FFTW) - # Eigen (header-only), consumed by the analysis libraries (the vendored fast-feedback indexer among them) # directly and by Ceres through its own find_package(Eigen3). The headers are fetched here and a two-file config package for # them is written into the build tree; Eigen3_DIR then points at it, so every find_package(Eigen3) @@ -685,7 +650,7 @@ IF (NOT JFJOCH_WRITER_ONLY AND NOT JFJOCH_PORTABLE_ONLY) INSTALL(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/fpga/pcie_driver/ DESTINATION /usr/src/jfjoch-${JFJOCH_VERSION}/src COMPONENT driver-dkms - FILES_MATCHING PATTERN "*.c" PATTERN "*.h" PATTERN "Makefile") + FILES_MATCHING PATTERN "*.c" PATTERN "*.h" PATTERN "Makefile" PATTERN "LICENSE") ENDIF() FILE(MAKE_DIRECTORY ${CMAKE_SOURCE_DIR}/frontend/dist/) INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/frontend/dist/ DESTINATION share/jfjoch/frontend COMPONENT jfjoch ) diff --git a/LICENSE b/LICENSE index 393e82ea7..940d82edb 100644 --- a/LICENSE +++ b/LICENSE @@ -1,5 +1,7 @@ Jungfraujoch software is licensed with GPLv3 license. Jungfraujoch FPGA is licensed with CERN OHL-S license (see fpga/LICENSE). +Jungfraujoch PCIe kernel driver (fpga/pcie_driver) is licensed with GPLv2 or later license +(see fpga/pcie_driver/LICENSE). GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 diff --git a/README.md b/README.md index e68e1741a..ef41d23df 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Rugnux is one executable in an archive on the release page, it into a directory of its own. On Linux x86-64, with or without an NVIDIA GPU: ``` -VERSION=1.0.0-rc.184 # the newest release on the page +VERSION=1.0.0 curl -L -O https://gitea.psi.ch/mx/jungfraujoch/releases/download/$VERSION/rugnux-$VERSION-linux-x86_64-cuda12.tgz mkdir -p rugnux-$VERSION && tar xzf rugnux-$VERSION-linux-x86_64-cuda12.tgz -C rugnux-$VERSION export PATH=$PWD/rugnux-$VERSION/bin:$PATH diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md index bbbebff74..1c5533de2 100644 --- a/THIRD_PARTY_NOTICES.md +++ b/THIRD_PARTY_NOTICES.md @@ -1,7 +1,8 @@ # Third-party software notices Jungfraujoch is licensed under **GPL-3.0** (see [`LICENSE`](LICENSE)); the FPGA design is -licensed under **CERN-OHL-S-2.0** (see [`fpga/LICENSE`](fpga/LICENSE)). It builds on a number of +licensed under **CERN-OHL-S-2.0** (see [`fpga/LICENSE`](fpga/LICENSE)), and the PCIe kernel driver +(`fpga/pcie_driver/`) under **GPL-2.0-or-later** (see [`fpga/pcie_driver/LICENSE`](fpga/pcie_driver/LICENSE)). It builds on a number of third-party components, acknowledged below as required by their licenses. This file is the human-readable manifest. The verbatim license texts live in the @@ -19,19 +20,20 @@ linked into the Jungfraujoch executables. | Component | Version | Copyright | License (SPDX) | License text | |---|---|---|---|---| | [spdlog](https://github.com/gabime/spdlog) | 1.17.0 | Gabi Melman | MIT | [spdlog.txt](licenses/spdlog.txt) | -| [Zstandard](https://github.com/facebook/zstd) | 1.5.7 | Meta Platforms, Inc. | BSD-3-Clause | [zstd.txt](licenses/zstd.txt) | +| [Zstandard](https://github.com/facebook/zstd) | 1.5.7 | Meta Platforms, Inc. | BSD-3-Clause OR GPL-2.0-only (used under BSD-3-Clause) | [zstd.txt](licenses/zstd.txt) | | [HDF5](https://github.com/HDFGroup/hdf5) | 2.2.0 | The HDF Group; UIUC | BSD-3-Clause-style + Apache-2.0 | [hdf5.txt](licenses/hdf5.txt) | | [slsDetectorPackage](https://github.com/slsdetectorgroup/slsDetectorPackage) | 8.0.2 / 9.2.0 | PSI | LGPL-3.0-or-later | [LGPL](licenses/slsDetectorPackage-LGPL-3.0.txt), [GPL](licenses/slsDetectorPackage-GPL-3.0.txt) | | [cpp-httplib](https://github.com/yhirose/cpp-httplib) | 0.56.0 | Yuji Hirose | MIT | [cpp-httplib.txt](licenses/cpp-httplib.txt) | | [libzmq (ZeroMQ)](https://github.com/zeromq/libzmq) | 4.3.5 | iMatix and contributors | MPL-2.0 | [libzmq.txt](licenses/libzmq.txt) | | [libtiff](https://gitlab.com/libtiff/libtiff) | 4.7.2 | Sam Leffler; SGI | libtiff (BSD-like) | [libtiff.txt](licenses/libtiff.txt) | -| [FFTW](https://www.fftw.org/) | 3.3.10 | Matteo Frigo; MIT | GPL-2.0-or-later | [fftw.txt](licenses/fftw.txt) | -| [Ceres Solver](https://github.com/ceres-solver/ceres-solver) | (pinned) | Google Inc. and contributors | BSD-3-Clause | [ceres-solver.txt](licenses/ceres-solver.txt) | +| [Ceres Solver](https://github.com/ceres-solver/ceres-solver) | commit 0c70ed3a1a2d | Google Inc. and contributors | BSD-3-Clause | [ceres-solver.txt](licenses/ceres-solver.txt) | | [Abseil](https://github.com/abseil/abseil-cpp) | 20250127 (required by Ceres) | Google Inc. | Apache-2.0 | [abseil.txt](licenses/abseil.txt) | | [Mbed TLS](https://github.com/Mbed-TLS/mbedtls) (with TF-PSA-Crypto) | 4.2.0 | The Mbed TLS Contributors | Apache-2.0 OR GPL-2.0-or-later (used under Apache-2.0) | [mbedtls.txt](licenses/mbedtls.txt), [tf-psa-crypto.txt](licenses/tf-psa-crypto.txt) | | [Catch2](https://github.com/catchorg/Catch2) | 3.16.0 | Catch2 Authors | BSL-1.0 | [catch2.txt](licenses/catch2.txt) | | [zlib-ng](https://github.com/zlib-ng/zlib-ng) | 2.3.3 | Jean-loup Gailly and Mark Adler; the zlib-ng contributors | Zlib | [zlib.txt](licenses/zlib.txt) | | [Eigen](https://gitlab.com/libeigen/eigen) | 3.4.1 | Benoit Jacob, Gael Guennebaud and contributors | MPL-2.0 (+ BSD parts) | [eigen.txt](licenses/eigen.txt), [README](licenses/eigen-README.txt) | +| MD5 implementation (from OpenSSL), bundled in slsDetectorPackage | `slsSupportLib/src/md5.c` of slsDetectorPackage | The OpenSSL Project Authors; modifications PSI | Apache-2.0 | [slsDetectorPackage-md5-Apache-2.0.txt](licenses/slsDetectorPackage-md5-Apache-2.0.txt) | +| [RapidJSON](https://github.com/Tencent/rapidjson), bundled in slsDetectorPackage | `libs/rapidjson/` of slsDetectorPackage | THL A29 Limited, a Tencent company, and Milo Yip | MIT | [rapidjson.txt](licenses/rapidjson.txt) | Mbed TLS is fetched and statically linked only for viewer builds (`JFJOCH_VIEWER_BUILD` / `JFJOCH_VIEWER_ONLY`), where it is the TLS backend of `jfjoch_viewer`'s cpp-httplib client; the @@ -47,21 +49,23 @@ either way. Eigen is header-only: only its headers reach the binaries, and no Ei ## Vendored directly in the repository -These live in the source tree (see the path) rather than being fetched; traccc and the Ceres-derived minimiser are the exceptions - code adapted into first-party files rather than a vendored directory, see the notes at the end of this file. +These live in the source tree (see the path) rather than being fetched; traccc and the GEMMI-, Ceres- and fast-feedback-indexer-derived files are the exceptions - code adapted into first-party files rather than a vendored directory, see the notes at the end of this file. | Component | Path | Copyright | License (SPDX) | License text | |---|---|---|---|---| -| [nlohmann/json](https://github.com/nlohmann/json) | `include/nlohmann/` | Niels Lohmann | MIT | [nlohmann-json.txt](licenses/nlohmann-json.txt) | +| [nlohmann/json](https://github.com/nlohmann/json) (3.12.0) | `include/nlohmann/` | Niels Lohmann | MIT | [nlohmann-json.txt](licenses/nlohmann-json.txt) | | [Macaron Base64](https://gist.github.com/tomykaira/f0fd86b6c73063283afe550bc5d77594) | `include/base64/` | tomykaira | MIT | [base64-macaron.txt](licenses/base64-macaron.txt) | -| [TinyCBOR](https://github.com/intel/tinycbor) | `frame_serialize/tinycbor/` | Intel Corporation | MIT | [tinycbor.txt](licenses/tinycbor.txt) | +| [TinyCBOR](https://github.com/intel/tinycbor) (0.6.0) | `frame_serialize/tinycbor/` | Intel Corporation | MIT | [tinycbor.txt](licenses/tinycbor.txt) | | [Bitshuffle](https://github.com/kiyo-masui/bitshuffle) | `compression/bitshuffle/` | Kiyoshi Masui | MIT | [bitshuffle.txt](licenses/bitshuffle.txt) | | [Bitshuffle (h-perf)](https://github.com/kalcutter/bitshuffle) | `compression/bitshuffle_hperf/` | Kal Conley | Apache-2.0 | [bitshuffle-hperf.txt](licenses/bitshuffle-hperf.txt) | -| [LZ4](https://github.com/lz4/lz4) | `compression/lz4/` | Yann Collet | BSD-2-Clause | [lz4.txt](licenses/lz4.txt) | +| [LZ4](https://github.com/lz4/lz4) (1.9.4) | `compression/lz4/` | Yann Collet | BSD-2-Clause | [lz4.txt](licenses/lz4.txt) | | [stb_image_write](https://github.com/nothings/stb) (v1.16, commit 31c1ad3) | `preview/stb/` | Sean Barrett | MIT OR Unlicense | [stb_image_write.txt](licenses/stb_image_write.txt) | -| [HLS arbitrary-precision types](https://github.com/Xilinx/HLS_arbitrary_Precision_Types) | `fpga/include/` | Xilinx, Inc. | Apache-2.0 | [xilinx-hls-headers.txt](licenses/xilinx-hls-headers.txt) | +| ICMP responder and IP header checksum (HPCN Group, UAM) | `fpga/hls/icmp.cpp`, `fpga/hls/ip_header_checksum.h` | HPCN Group, UAM Spain; modifications PSI | BSD-3-Clause | [hpcn-uam.txt](licenses/hpcn-uam.txt) | | [fast-feedback-indexer](https://github.com/paulscherrerinstitute/fast-feedback-indexer) (commit a94fd4f) | `image_analysis/indexing/fast-feedback-indexer/` | PSI | BSD-3-Clause | [fast-feedback-indexer.txt](licenses/fast-feedback-indexer.txt) | -| [GEMMI](https://github.com/project-gemmi/gemmi) | `gemmi_gph/` | Global Phasing Ltd. | MPL-2.0 | [gemmi.txt](licenses/gemmi.txt) | -| [CCP4 Monomer Library](https://github.com/MonomerLibrary/monomers) (subset: restraint dictionary data) | `image_analysis/structure_refinement/monomers/` | CCP4 / the Monomer Library authors (Vagin et al.) | LGPL-3.0-only | [ccp4-monomer-library.txt](licenses/ccp4-monomer-library.txt) | +| [GEMMI](https://github.com/project-gemmi/gemmi) (0.7.5, trimmed) | `gemmi_gph/` | Global Phasing Ltd. | MPL-2.0 | [gemmi.txt](licenses/gemmi.txt) | +| [stb_sprintf](https://github.com/nothings/stb) (v1.10, bundled with GEMMI) | `gemmi_gph/stb/stb_sprintf.h` | Jeff Roberts / RAD Game Tools; Sean Barrett | MIT OR Unlicense | [stb_sprintf.txt](licenses/stb_sprintf.txt) | +| 3x3 symmetric eigensolver (Connelly Barnes, after JAMA; bundled with GEMMI) | `gemmi_gph/eig3.cpp` | — | public domain (no SPDX id) | — | +| [CCP4 Monomer Library](https://github.com/MonomerLibrary/monomers) (modified subset: restraint dictionary data) | `image_analysis/structure_refinement/monomers/` | CCP4 / the Monomer Library authors (Vagin et al.) | LGPL-3.0-only | [ccp4-monomer-library.txt](licenses/ccp4-monomer-library.txt) | | [Larch](https://github.com/xraypy/xraylarch) (its Cromer-Liberman routines, as GEMMI ports them) | `gemmi_gph/fprime.cpp` | Matthew Newville, The University of Chicago, et al. | MIT | [larch.txt](licenses/larch.txt) | | [PEGTL](https://github.com/taocpp/PEGTL) | `gemmi_gph/gemmi/third_party/tao/` | Dr. Colin Hirsch and Daniel Frey | MIT | [pegtl.txt](licenses/pegtl.txt) | | [sajson](https://github.com/chadaustin/sajson) | `gemmi_gph/gemmi/third_party/sajson.h` | Chad Austin | MIT | [sajson.txt](licenses/sajson.txt) | @@ -72,6 +76,8 @@ These live in the source tree (see the path) rather than being fetched; traccc a | [traccc (ACTS)](https://github.com/acts-project/traccc) | `image_analysis/spot_finding/StrongPixelSet.cpp`, `SpotExtractorGPU.cu` | CERN, for the benefit of the ACTS project | MPL-2.0 | [traccc.txt](licenses/traccc.txt) | | [fast-feedback-indexer](https://github.com/paulscherrerinstitute/fast-feedback-indexer) (adapted) | `image_analysis/indexing/FFBIDXIndexerCPU.cpp` | PSI | BSD-3-Clause | [fast-feedback-indexer.txt](licenses/fast-feedback-indexer.txt) | | [Ceres Solver](https://github.com/ceres-solver/ceres-solver) (adapted) | `image_analysis/geom_refinement/LMSolver.h`, `LMSolver.cpp` | Google Inc. | BSD-3-Clause | [ceres-solver.txt](licenses/ceres-solver.txt) | +| [GEMMI](https://github.com/project-gemmi/gemmi) (adapted) | `image_analysis/structure_refinement/ModelScaling.cpp`, `ModelMaskGPU.cu`, `ModelStructureFactorsGPU.cpp`, `ModelDensityMetal.metal`, `AtomGradientMetal.metal` | Global Phasing Ltd. | MPL-2.0 | [gemmi.txt](licenses/gemmi.txt) | +| [Durin](https://github.com/DiamondLightSource/durin) (adapted) | `xds-plugin/plugin.h`, `plugin.cpp` | Diamond Light Source Ltd.; Global Phasing Ltd. | BSD-3-Clause | [durin.txt](licenses/durin.txt) | | [xbflash.qspi](https://github.com/Xilinx/XRT) | `tools/xbflash.qspi/` | Xilinx / AMD | Apache-2.0 | [xbflash-qspi.txt](licenses/xbflash-qspi.txt) | | [wingetopt](https://github.com/alex85k/wingetopt) | `tools/wingetopt/` | Todd C. Miller; The NetBSD Foundation | ISC AND BSD-2-Clause | [wingetopt.txt](licenses/wingetopt.txt) | @@ -88,6 +94,19 @@ Not code and not linked into any binary: input files of the battery's timing ben The deposited entries are the reference models the benchmark's placements are checked against, and 4NWV's is also moved by a fixed transform at run time to make one start model. +## FPGA bitstreams + +The prebuilt FPGA images in `fpga/images/` (`jfjoch_fpga_pcie_100g.mcs.gz`, +`jfjoch_fpga_pcie_8x10g.mcs.gz`) are generated from the CERN-OHL-S-2.0 design together with AMD/Xilinx +IP cores, which are licensed by Xilinx under its own terms and not under CERN-OHL-S-2.0: + +| Component | Image | Copyright | Terms | +|---|---|---|---| +| UltraScale+ Integrated 100G Ethernet (CMAC) | `jfjoch_fpga_pcie_100g.mcs.gz` | AMD / Xilinx, Inc. | Xilinx IP licence ("Non-cost license ... has to be requested from AMD/Xilinx website", [docs/FPGA.md](docs/FPGA.md)) | +| 10G/25G Ethernet Subsystem for UltraScale+ | `jfjoch_fpga_pcie_8x10g.mcs.gz` | AMD / Xilinx, Inc. | Xilinx IP licence, received by PSI from the Xilinx University Program; per [docs/FPGA.md](docs/FPGA.md): "usage of bitstreams generated by PSI continuous integration pipeline for `8x10g` is only allowed for non-commercial use" | + +Both images also contain the IP cores included with Vivado, under Xilinx's terms. + ## Runtime libraries and SDKs (shipped in binaries, not in the source tree) | Component | Used by | License | Notice | @@ -130,16 +149,30 @@ served frontend, so the shipped web UI carries its own attribution. * **fast-feedback-indexer** is also vendored and linked in CUDA builds (table above); separately, `FFBIDXIndexerCPU.cpp` ports its CUDA kernels to the CPU. The file names the origin at the top and is covered by `licenses/fast-feedback-indexer.txt`. -* **FFTW** is GPL-2.0-or-later — compatible with, and absorbed by, this project's GPL-3.0 license. +* **GEMMI** is also vendored (table above); separately, `ModelScaling.cpp`, `ModelMaskGPU.cu`, + `ModelStructureFactorsGPU.cpp`, `ModelDensityMetal.metal` and `AtomGradientMetal.metal` in + `image_analysis/structure_refinement/` follow GEMMI's scaling, Levenberg-Marquardt, solvent-mask, reciprocal-grid and form-factor code. + Each names the GEMMI source it follows and is covered by `licenses/gemmi.txt`. +* **Durin** (`xds-plugin/plugin.h`/`.cpp`): the XDS plugin's entry points are based on the Durin plugin + of Diamond Light Source and Global Phasing; both files name the origin at the top and are covered by + `licenses/durin.txt`. +* **slsDetectorPackage's bundled code**: the slsDetectorPackage sources compiled into the binaries + include an MD5 implementation taken from OpenSSL (Apache-2.0) and the RapidJSON headers (MIT); their + `msinttypes/` headers (BSD-3-Clause) are for old MSVC compilers only. * **Apache-2.0** components: where upstream ships a `NOTICE` file, it is reproduced in the corresponding `licenses/` text. * **CCP4 Monomer Library (LGPL-3.0)** is data, not code: the restraint dictionaries of the compounds - rugnux's refinement restrains, copied unmodified per compound into - `image_analysis/structure_refinement/monomers/` (`links_and_mods.cif` and `ener_lib.cif` cut down to - the entries those compounds use, and the library's metal-site distances of `metals.json` for its ions as - `metals.cif`), with the library's own `COPYING`. The build embeds them in the binary - as text, and `image_analysis/structure_refinement/monomers/update_monomers.py` regenerates the subset from the upstream library, so the - copy can be replaced by a user with a version of their own. + rugnux's refinement restrains, in `image_analysis/structure_refinement/monomers/`, with the library's + own `COPYING`. The subset is a **modified** version of the library: the per-compound files are copied + unmodified, while `links_and_mods.cif` and `ener_lib.cif` are cut down to the entries those compounds + use and `metals.json` is converted to `metals.cif` holding only the metal-site distances of its ions. + Each of these three files says so in a comment at its top, with the date it was generated. + `image_analysis/structure_refinement/monomers/update_monomers.py` regenerates the subset from the + upstream library. The build embeds the files in the binary as text. As the LGPL-3.0 requires, the + modified files remain under LGPL-3.0 (with the GPL-3.0 text in `LICENSE`), the source tree carries + them in their preferred (text) form together with the script that makes them, and a user can replace + the embedded copy with a version of their own by replacing the files in that directory (or rerunning + the script on another library version) and rebuilding. * **Qt (LGPL-3.0)** and **NVIDIA CUDA (EULA)** carry redistribution conditions beyond a copyright notice; see their dedicated notice files. The verbatim LGPL-3.0 and CUDA EULA texts are bundled (`licenses/Qt6-LGPL-3.0.txt`, `licenses/NVIDIA-CUDA-EULA.txt`); the CUDA EULA is the one shipped diff --git a/VERSION b/VERSION index 40cd959ac..994ba47c8 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.0.0-rc.186 +1.0.0-rc.187 diff --git a/acquisition_device/AcquisitionCounters.cpp b/acquisition_device/AcquisitionCounters.cpp index 966751706..9d1cb5d74 100644 --- a/acquisition_device/AcquisitionCounters.cpp +++ b/acquisition_device/AcquisitionCounters.cpp @@ -31,7 +31,7 @@ void AcquisitionCounters::Reset(const DiffractionExperiment &experiment, uint16_ curr_frame_number[i] = 0; handle_for_frame = std::vector(expected_frames * nmodules, HandleNotFound); - packets_collected = std::vector(expected_frames * nmodules); + packets_collected = std::vector(expected_frames * nmodules); packets_per_module = std::vector(nmodules); total_packets = 0; expected_packets_per_module = 512 * experiment.GetFPGASummation(); diff --git a/acquisition_device/AcquisitionCounters.h b/acquisition_device/AcquisitionCounters.h index 5e978bd4f..6cb53fe06 100644 --- a/acquisition_device/AcquisitionCounters.h +++ b/acquisition_device/AcquisitionCounters.h @@ -21,7 +21,7 @@ class AcquisitionCounters { mutable std::condition_variable_any data_updated; std::vector handle_for_frame; - std::vector packets_collected; + std::vector packets_collected; uint64_t total_packets; std::vector packets_per_module; diff --git a/acquisition_device/AcquisitionDevice.cpp b/acquisition_device/AcquisitionDevice.cpp index 7e2d070a3..ea823b719 100644 --- a/acquisition_device/AcquisitionDevice.cpp +++ b/acquisition_device/AcquisitionDevice.cpp @@ -1,6 +1,7 @@ // SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute // SPDX-License-Identifier: GPL-3.0-only +#include #include #include #include @@ -54,6 +55,7 @@ void AcquisitionDevice::StartAction(const DiffractionExperiment &experiment, uin counters.Reset(experiment, data_stream); expected_frames = experiment.GetFrameNum() / experiment.GetFPGASummation(); + fpga_summation = experiment.GetFPGASummation(); // Ensure internal WR queue is empty work_request_queue.Clear(); @@ -92,6 +94,14 @@ void AcquisitionDevice::WaitForActionComplete() { } if (!skip_analysis) { + // The card counts the packets of a summed module in 16 bits, which wraps from 128 frames on (512 a frame): + // counted here from those present in all the frames + if (512 * fpga_summation > UINT16_MAX) { + uint32_t packets = 0; + for (const auto &mask: output->module_statistics.packet_mask) + packets += std::popcount(mask); + output->module_statistics.packet_count = packets * fpga_summation; + } c.module_number = output->module_statistics.module_number; c.packet_count = output->module_statistics.packet_count; c.frame_number = output->module_statistics.frame_number; diff --git a/acquisition_device/AcquisitionDevice.h b/acquisition_device/AcquisitionDevice.h index 41f2d30ee..3763182d0 100644 --- a/acquisition_device/AcquisitionDevice.h +++ b/acquisition_device/AcquisitionDevice.h @@ -38,6 +38,7 @@ class AcquisitionDevice { std::chrono::time_point end_time; int64_t expected_frames; + int64_t fpga_summation = 1; virtual void Start(const DiffractionExperiment& experiment, uint32_t flags) = 0; virtual void Finalize() {}; // do clean-up after action is done @@ -50,7 +51,7 @@ protected: ThreadSafeFIFO work_request_queue; // Non-owning view of the per-buffer addresses. Each device subclass owns the backing memory - // and its lifecycle: PCIExpressDevice mmap's/munmap's kernel DMA buffers, HLSSimulatedDevice + // and its lifecycle: PCIExpressDevice mmap's/munmap's kernel DMA buffers, MockAcquisitionDevice // points these at plain heap buffers it owns. std::vector buffer_device; Logger *logger; @@ -123,5 +124,6 @@ public: void RunInternalGenerator(const DiffractionExperiment& experiment); // The module frame of the internal frame generator's images, throws if the card memory cannot hold it void CheckInternalGeneratorFrame(size_t module_frame) const; + uint64_t GetInternalGeneratorModuleFrames() const { return internal_generator_module_frames; } }; diff --git a/acquisition_device/AcquisitionDeviceGroup.cpp b/acquisition_device/AcquisitionDeviceGroup.cpp index 9decc8da4..64c7a3ab2 100644 --- a/acquisition_device/AcquisitionDeviceGroup.cpp +++ b/acquisition_device/AcquisitionDeviceGroup.cpp @@ -3,7 +3,7 @@ #include "AcquisitionDeviceGroup.h" #include "PCIExpressDevice.h" -#include "HLSSimulatedDevice.h" +#include "MockAcquisitionDevice.h" AcquisitionDevice &AcquisitionDeviceGroup::operator[](int idx) { if ((idx < 0) || (idx >= aq_devices.size())) @@ -28,8 +28,8 @@ void AcquisitionDeviceGroup::AddPCIeDevice(const std::string &device_name, std:: aq_devices.emplace_back(std::move(tmp)); } -void AcquisitionDeviceGroup::AddHLSDevice(int64_t buffer_size_modules) { - aq_devices.emplace_back(std::make_unique(aq_devices.size(), buffer_size_modules)); +void AcquisitionDeviceGroup::AddMockDevice(int64_t buffer_size_modules) { + aq_devices.emplace_back(std::make_unique(aq_devices.size(), buffer_size_modules)); } std::vector AcquisitionDeviceGroup::GetNetworkConfig() { diff --git a/acquisition_device/AcquisitionDeviceGroup.h b/acquisition_device/AcquisitionDeviceGroup.h index 7044936a5..318d16917 100644 --- a/acquisition_device/AcquisitionDeviceGroup.h +++ b/acquisition_device/AcquisitionDeviceGroup.h @@ -14,7 +14,8 @@ public: size_t size(); void Add(std::unique_ptr &&device); void AddPCIeDevice(const std::string &device_name, std::optional ipv4_addr = {}); - void AddHLSDevice(int64_t buffer_size_modules); + // The mock of the card, for the broker without hardware + void AddMockDevice(int64_t buffer_size_modules); std::vector GetNetworkConfig(); std::vector GetDeviceStatus() const; void EnableLogging(Logger *logger); diff --git a/acquisition_device/CMakeLists.txt b/acquisition_device/CMakeLists.txt index 020a8f684..1b55695e7 100644 --- a/acquisition_device/CMakeLists.txt +++ b/acquisition_device/CMakeLists.txt @@ -1,11 +1,14 @@ +# SPDX-FileCopyrightText: 2023 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only + ADD_LIBRARY(JFJochAcquisitionDevice STATIC AcquisitionDevice.cpp AcquisitionDevice.h AcquisitionCounters.cpp AcquisitionCounters.h - HLSSimulatedDevice.cpp HLSSimulatedDevice.h + MockAcquisitionDevice.cpp MockAcquisitionDevice.h Completion.cpp Completion.h ../fpga/pcie_driver/jfjoch_fpga.h PCIExpressDevice.cpp PCIExpressDevice.h FPGAAcquisitionDevice.cpp FPGAAcquisitionDevice.h AcquisitionDeviceGroup.cpp AcquisitionDeviceGroup.h) -TARGET_LINK_LIBRARIES(JFJochAcquisitionDevice JFJochDevice JFJochCommon JFJochHLSSimulation JFCalibration) \ No newline at end of file +TARGET_LINK_LIBRARIES(JFJochAcquisitionDevice JFJochDevice JFJochCommon JFCalibration) \ No newline at end of file diff --git a/acquisition_device/Completion.h b/acquisition_device/Completion.h index 200716ef0..47d6129c6 100644 --- a/acquisition_device/Completion.h +++ b/acquisition_device/Completion.h @@ -14,7 +14,7 @@ struct Completion { uint64_t frame_number; uint32_t handle; - uint16_t packet_count; + uint32_t packet_count; uint16_t data_collection_id; uint16_t module_number; }; diff --git a/acquisition_device/FPGAAcquisitionDevice.cpp b/acquisition_device/FPGAAcquisitionDevice.cpp index f7b24a08b..f866807c3 100644 --- a/acquisition_device/FPGAAcquisitionDevice.cpp +++ b/acquisition_device/FPGAAcquisitionDevice.cpp @@ -40,15 +40,8 @@ void FPGAAcquisitionDevice::ReadWorkCompletionThread() { } if (read) { + // Frame and module of an image completion are read from its buffer later (WaitForActionComplete) c = parse_hw_completion(values); - if (logger) { - logger->Debug("Stream {} Completion data collection ID {} type {} frame {} module {}", - data_stream, - c.data_collection_id, - (int)c.type, - c.frame_number, - c.module_number); - } if (c.data_collection_id == data_collection_id) { work_completion_queue.PutBlocking(c); if (c.type == Completion::Type::End) diff --git a/acquisition_device/HLSSimulatedDevice.cpp b/acquisition_device/HLSSimulatedDevice.cpp deleted file mode 100644 index e36a794dd..000000000 --- a/acquisition_device/HLSSimulatedDevice.cpp +++ /dev/null @@ -1,117 +0,0 @@ -// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute -// SPDX-License-Identifier: GPL-3.0-only - -#include "HLSSimulatedDevice.h" - -HLSSimulatedDevice::HLSSimulatedDevice(uint16_t data_stream, size_t in_frame_buffer_size_modules) - : FPGAAcquisitionDevice(data_stream) { - mac_addr = 0xCCAA11223344; - ipv4_addr = 0x0132010A; - - max_modules = MAX_MODULES_FPGA; - - buffers.reserve(in_frame_buffer_size_modules); - for (size_t i = 0; i < in_frame_buffer_size_modules; i++) { - buffers.push_back(std::make_unique()); // zero-initialised, 64-byte aligned - buffer_device.push_back(reinterpret_cast(buffers.back().get())); - } - - device = std::make_unique(buffer_device); - internal_generator_module_frames = GeneratorModuleFrames(device->GetDataCollectionStatus().hbm_size_bytes); -} - -void HLSSimulatedDevice::CreateFinalPacket(const DiffractionExperiment& 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(frame_number, eth_packet, module_number, data, adjust_axis, user); -} - -void HLSSimulatedDevice::CreateJFPackets(const DiffractionExperiment& experiment, uint64_t frame_number_0, uint64_t frames, - uint32_t module_number, const uint16_t *data) { - for (uint64_t i = 0; i < frames; i++) { - for (int j = 0; j < 128; j++) - CreateJFPacket(experiment, frame_number_0 + i, j, module_number, data + (i * 128 + j) * 4096, 0, 0); - } -} - -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(frame_number, eth_packet, module_number, col, row, data); -} - -void HLSSimulatedDevice::HW_ReadActionRegister(DataCollectionConfig *job) { - device->HW_ReadActionRegister(job); -} - -void HLSSimulatedDevice::HW_WriteActionRegister(const DataCollectionConfig *job) { - device->HW_WriteActionRegister(job); -} - -void HLSSimulatedDevice::FPGA_StartAction(const DiffractionExperiment &experiment) { - device->FPGA_StartAction(); -} - -void HLSSimulatedDevice::HW_RunInternalGenerator(const FrameGeneratorConfig &config) { - device->HW_RunInternalGenerator(config); -} - -void HLSSimulatedDevice::FPGA_EndAction() { - device->FPGA_EndAction(); - if (const int result = device->GetFrameGeneratorResult(); result != 0) - throw JFJochException(JFJochExceptionCategory::AcquisitionDeviceError, - "Internal frame generator refused its configuration, error code " + std::to_string(result)); -} - - -bool HLSSimulatedDevice::HW_ReadMailbox(uint32_t *values) { - return device->HW_ReadMailbox(values); -} - -void HLSSimulatedDevice::Cancel() { - device->Cancel(); -} - -bool HLSSimulatedDevice::HW_IsIdle() const { - return device->HW_IsIdle(); -} - - -bool HLSSimulatedDevice::HW_SendWorkRequest(uint32_t handle) { - return device->HW_SendWorkRequest(handle); -} - -DataCollectionStatus HLSSimulatedDevice::GetDataCollectionStatus() const { - return device->GetDataCollectionStatus(); -} - -void HLSSimulatedDevice::HW_LoadCalibration(const LoadCalibrationConfig &config) { - device->HW_LoadCalibration(config); -} - -void HLSSimulatedDevice::HW_SetSpotFinderParameters(const SpotFinderParameters ¶ms) { - device->HW_SetSpotFinderParameters(params); -} - -void HLSSimulatedDevice::CreateXfelBunchIDPacket(double pulse_id, uint32_t event_code) { - device->CreateXfelBunchIDPacket(pulse_id, event_code); -} - -DeviceStatus HLSSimulatedDevice::GetDeviceStatus() const { - DeviceStatus status{}; - - strncpy(status.serial_number, "HLS1", sizeof(status.device_number)); - strncpy(status.device_number, "HLS device", sizeof(status.device_number)); - status.fpga_default_mac_addr = mac_addr; - status.eth_link_count = 1; - status.eth_link_status = 1; - status.packets_sls = device->GetSLSPackets(); - status.packets_udp = device->GetUDPPackets(); - status.hbm_0_temp_C = 0; - status.hbm_1_temp_C = 0; - status.fpga_temp_C = 0; - return status; -} \ No newline at end of file diff --git a/acquisition_device/HLSSimulatedDevice.h b/acquisition_device/HLSSimulatedDevice.h deleted file mode 100644 index 83e40ef98..000000000 --- a/acquisition_device/HLSSimulatedDevice.h +++ /dev/null @@ -1,49 +0,0 @@ -// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute -// SPDX-License-Identifier: GPL-3.0-only - -#pragma once - -#include - -#include "../common/DiffractionExperiment.h" -#include "../fpga/hls_simulation/HLSDevice.h" - -#include "FPGAAcquisitionDevice.h" - -class HLSSimulatedDevice : public FPGAAcquisitionDevice { - // Owns the simulated frame buffers. Plain heap (this path is not performance-critical, so no - // NUMA placement and no mmap), but page-aligned (4 KiB) to match the real device's kernel DMA - // buffers - more than enough for the data path's alignment needs (AXI datamover 64 B, - // FPGAIntegrationTest 128 B). Declared before `device` so the buffers outlive the HLSDevice - // action thread that writes into them; buffer_device points into these. - struct alignas(4096) FrameBuffer { uint8_t data[FPGA_BUFFER_LOCATION_SIZE]; }; - std::vector> buffers; - std::unique_ptr device; - - void HW_ReadActionRegister(DataCollectionConfig *job) override; - void HW_WriteActionRegister(const DataCollectionConfig *job) override; - - void FPGA_StartAction(const DiffractionExperiment &experiment) override; - void FPGA_EndAction() override; - bool HW_IsIdle() const override; - bool HW_ReadMailbox(uint32_t *values) override; - bool HW_SendWorkRequest(uint32_t handle) override; - void HW_LoadCalibration(const LoadCalibrationConfig &config) override; - void HW_SetSpotFinderParameters(const SpotFinderParameters ¶ms) override; - void HW_RunInternalGenerator(const FrameGeneratorConfig &config) override; -public: - HLSSimulatedDevice(uint16_t data_stream, size_t in_frame_buffer_size_modules); - ~HLSSimulatedDevice() override = default; - void CreateJFPacket(const DiffractionExperiment& experiment, uint64_t frame_number, uint32_t eth_packet, - uint32_t module_number, const uint16_t *data, int8_t adjust_axis = 0, uint8_t user = 0); - void CreateJFPackets(const DiffractionExperiment& experiment, uint64_t frame_number_0, uint64_t frames, - uint32_t module_number, const uint16_t *data); - void 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); - void CreateXfelBunchIDPacket(double bunchid, uint32_t event_code); - void CreateFinalPacket(const DiffractionExperiment& experiment); - DataCollectionStatus GetDataCollectionStatus() const override; - void Cancel() override; - DeviceStatus GetDeviceStatus() const override; -}; diff --git a/acquisition_device/MockAcquisitionDevice.cpp b/acquisition_device/MockAcquisitionDevice.cpp new file mode 100644 index 000000000..b4fb3bb69 --- /dev/null +++ b/acquisition_device/MockAcquisitionDevice.cpp @@ -0,0 +1,560 @@ +// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +// SPDX-License-Identifier: GPL-3.0-only + +#include + +#include "MockAcquisitionDevice.h" + +namespace { + bool MaskEmpty(const uint64_t packet_mask[8]) { + for (int i = 0; i < 8; i++) { + if (packet_mask[i] != 0) + return false; + } + return true; + } +} + +MockAcquisitionDevice::MockAcquisitionDevice(uint16_t data_stream, size_t in_frame_buffer_size_modules, + uint32_t in_card_memory_bytes) + : FPGAAcquisitionDevice(data_stream), + card_memory_bytes(in_card_memory_bytes), + collected_modules(2 * MAX_MODULES_FPGA), + summation_completions(MAX_MODULES_FPGA * MAX_FPGA_SUMMATION), + summation_mask(MAX_MODULES_FPGA, std::vector(MAX_FPGA_SUMMATION)), + summation_count(MAX_MODULES_FPGA), + summation_frame_prefix(MAX_MODULES_FPGA) { + mac_addr = 0xCCAA11223344; + ipv4_addr = 0x0132010A; + + max_modules = MAX_MODULES_FPGA; + internal_generator_module_frames = GeneratorModuleFrames(card_memory_bytes); + generator_frames.resize(internal_generator_module_frames); + + buffers.reserve(in_frame_buffer_size_modules); + for (size_t i = 0; i < in_frame_buffer_size_modules; i++) { + buffers.push_back(std::make_unique()); + buffer_device.push_back(reinterpret_cast(buffers.back().get())); + } +} + +MockAcquisitionDevice::~MockAcquisitionDevice() { + if (action_thread.joinable()) + action_thread.join(); + stop_frame_generator = true; +} + +void MockAcquisitionDevice::SetOutput(uint64_t image, uint32_t module_number, const DeviceOutput &output) { + if (outputs.size() <= image) + outputs.resize(image + 1); + if (outputs[image].size() <= module_number) + outputs[image].resize(module_number + 1); + outputs[image][module_number] = std::make_unique(output); +} + +void MockAcquisitionDevice::AddPacket(const Packet &packet) { + std::unique_lock ul(packets_mutex); + packets.push_back(packet); +} + +void MockAcquisitionDevice::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) { + uint32_t half_module = ((eth_packet >= 64) ? 1 : 0); + AddPacket(Packet{ + .frame_number = frame_number, + .packet_number = eth_packet % 64, + .udp_port = static_cast(2 * module_number + half_module), + .column = 0, + .detector_type = SLS_DETECTOR_TYPE_JUNGFRAU, + .exptime = 0, + .bunchid = 0x1234567898765431L, + .timestamp = 0xABCDEF0000FEDCBAL, + .debug = 0, + .eth_error = (user % 2 == 1), + .len_error = (adjust_axis != 0), + .generator_slot = NoGeneratorSlot + }); +} + +void MockAcquisitionDevice::CreateJFPackets(const DiffractionExperiment &experiment, uint64_t frame_number_0, + uint64_t frames, uint32_t module_number, const uint16_t *data) { + for (uint64_t i = 0; i < frames; i++) { + for (int j = 0; j < 128; j++) + CreateJFPacket(experiment, frame_number_0 + i, j, module_number, nullptr, 0, 0); + } +} + +void MockAcquisitionDevice::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) { + AddPacket(Packet{ + .frame_number = frame_number, + .packet_number = eth_packet % 128, + .udp_port = static_cast(2 * module_number + row), + .column = static_cast(col % 2), + .detector_type = SLS_DETECTOR_TYPE_EIGER, + .exptime = 0, + .bunchid = 0x1234567898765431L, + .timestamp = 0xABCDEF0000FEDCBAL, + .debug = 0, + .generator_slot = NoGeneratorSlot + }); +} + +void MockAcquisitionDevice::CreateXfelBunchIDPacket(double pulse_id, uint32_t event_code) { + Packet packet{.bunchid_packet = true, .generator_slot = NoGeneratorSlot}; + memcpy(&packet.bunchid, &pulse_id, sizeof(uint64_t)); + AddPacket(packet); +} + +void MockAcquisitionDevice::CreateFinalPacket(const DiffractionExperiment &experiment) { + CreateJFPacket(experiment, UINT64_MAX, 0, 0, nullptr, false); +} + +void MockAcquisitionDevice::HW_ReadActionRegister(DataCollectionConfig *job) { + memcpy(job, &cfg, sizeof(DataCollectionConfig)); +} + +void MockAcquisitionDevice::HW_WriteActionRegister(const DataCollectionConfig *job) { + memcpy(&cfg, job, sizeof(DataCollectionConfig)); +} + +void MockAcquisitionDevice::FPGA_StartAction(const DiffractionExperiment &experiment) { + if (action_thread.joinable()) + action_thread.join(); + + run_counter += 1; + idle = false; + action_thread = std::thread(&MockAcquisitionDevice::DataCollectionThread, this); +} + +void MockAcquisitionDevice::FPGA_EndAction() { + if (action_thread.joinable()) + action_thread.join(); + if (frame_generator_result != 0) + throw JFJochException(JFJochExceptionCategory::AcquisitionDeviceError, + "Internal frame generator refused its configuration, error code " + + std::to_string(frame_generator_result)); +} + +bool MockAcquisitionDevice::HW_IsIdle() const { + return idle; +} + +bool MockAcquisitionDevice::HW_ReadMailbox(uint32_t *values) { + return completions.Get(*values); +} + +bool MockAcquisitionDevice::HW_SendWorkRequest(uint32_t handle) { + work_requests.Put(handle); + return true; +} + +void MockAcquisitionDevice::Cancel() { + cancel = true; +} + +// The mock does not process data: of what the host loads into the card only the frames of the internal +// generator are kept +void MockAcquisitionDevice::HW_LoadCalibration(const LoadCalibrationConfig &config) { + const DeviceOutput *input = buffer_device[config.handle]; + if (input->module_statistics.load_calibration_destination != LOAD_CALIBRATION_DEST_FRAME_GEN) + return; + auto &frame = generator_frames.at(input->module_statistics.module_number); + frame.resize(RAW_MODULE_SIZE); + memcpy(frame.data(), input->pixels, RAW_MODULE_SIZE * sizeof(uint16_t)); +} + +void MockAcquisitionDevice::HW_SetSpotFinderParameters(const SpotFinderParameters ¶ms) {} + +void MockAcquisitionDevice::HW_RunInternalGenerator(const FrameGeneratorConfig &config) { + frame_generator_result = 0; + frame_generator_future = std::async(std::launch::async, [this, config] { + frame_generator_result = FrameGenerator(config); + // A generator that refused its configuration sends no frame: the data collection ends instead of waiting + if (frame_generator_result != 0) + cancel = true; + }); +} + +int MockAcquisitionDevice::FrameGenerator(FrameGeneratorConfig config) { + // frame_generator.cpp: its checks and return codes, then packet headers only + if ((config.modules > MAX_MODULES_FPGA) || (config.modules == 0)) + return 1; + if ((config.detector_type != SLS_DETECTOR_TYPE_EIGER) && (config.detector_type != SLS_DETECTOR_TYPE_JUNGFRAU)) + return 2; + if ((config.detector_type == SLS_DETECTOR_TYPE_EIGER) + && (config.eiger_bit_depth != 8) && (config.eiger_bit_depth != 16) && (config.eiger_bit_depth != 32)) + return 2; + if (config.frames == 0) + return 0; + // The frames for the generator have to fit in the card memory + uint32_t module_slots = config.modules * (config.images_in_memory + 1); + if ((config.detector_type == SLS_DETECTOR_TYPE_EIGER) && (config.eiger_bit_depth == 32)) + module_slots *= 2; + if (module_slots >= internal_generator_module_frames) + return 3; + + double pulse_id = config.pulse_id; + uint16_t data_stream_port = (config.data_stream & UINT8_MAX) << 8; + + // The packets wait until the data collection takes them - only a limited number of them + auto send = [this] (const Packet &packet) { + while (!cancel && !stop_frame_generator) { + { + std::unique_lock ul(packets_mutex); + if (packets.size() < 16384) { + packets.push_back(packet); + return; + } + } + std::this_thread::sleep_for(std::chrono::microseconds(10)); + } + }; + + // One packet with TUSER = 1, to reset the network cores on the way - it is dropped as an Ethernet error + send(Packet{.frame_number = 1, .udp_port = data_stream_port, .detector_type = SLS_DETECTOR_TYPE_JUNGFRAU, + .eth_error = true, .generator_slot = NoGeneratorSlot}); + + uint32_t frame_cell = 0; + for (uint32_t f = 0; f < config.frames; f++) { + if (cancel || stop_frame_generator) + break; + uint64_t bunchid; + memcpy(&bunchid, &pulse_id, sizeof(uint64_t)); + + for (uint32_t m = 0; m < config.modules; m++) { + if (config.detector_type == SLS_DETECTOR_TYPE_JUNGFRAU) { + for (uint32_t p = 0; p < 128; p++) + send(Packet{ + .frame_number = f + 1, + .packet_number = p, + .udp_port = static_cast(data_stream_port | (2 * m)), + .column = 0, + .detector_type = SLS_DETECTOR_TYPE_JUNGFRAU, + .exptime = config.exptime, + .bunchid = bunchid, + .timestamp = config.exptime * f, + .debug = config.debug, + .generator_slot = frame_cell * config.modules + m + }); + } else { + uint32_t bit_depth = config.eiger_bit_depth; + for (uint32_t p = 0; p < 16 * bit_depth; p++) { + uint32_t half_module = (p >= 8 * bit_depth) ? 1 : 0; + send(Packet{ + .frame_number = f + 1, + .packet_number = (p / 2) % (4 * bit_depth), + .udp_port = static_cast(data_stream_port | (2 * m + half_module)), + .column = static_cast(p % 2), + .detector_type = SLS_DETECTOR_TYPE_EIGER, + .exptime = config.exptime, + .bunchid = 0, + .timestamp = config.exptime * f, + .debug = config.debug, + .generator_slot = (bit_depth == 32 ? 2 : 1) * (frame_cell * config.modules + m) + }); + } + } + } + pulse_id += 1.0; + frame_cell = (frame_cell == config.images_in_memory) ? 0 : frame_cell + 1; + } + return 0; +} + +void MockAcquisitionDevice::DataCollectionThread() { + cancel = false; + stop_frame_generator = false; + stalls_host = 0; + + for (auto &c: collected_modules) + c = ModuleCompletion{.frame_number = UINT64_MAX}; + for (int m = 0; m < MAX_MODULES_FPGA; m++) { + summation_mask[m].assign(MAX_FPGA_SUMMATION, false); + summation_count[m] = 0; + summation_frame_prefix[m] = 0; + } + frames_in_group = 0; + handle_to_complete = HANDLE_START; + + uint32_t data_collection_id = (cfg.mode >> 16) & UINT16_MAX; + + // host_writer.cpp: work requests left from the previous data collection are returned unused + uint32_t handle; + while (work_requests.Get(handle)) + completions.Put((DATA_COLLECTION_ID_PURGE << 16) | handle); + completions.Put((data_collection_id << 16) | HANDLE_START); + + // data_collection_fsm.cpp: cancel is checked between packets + while (!cancel) { + Packet packet; + bool received = false; + { + std::unique_lock ul(packets_mutex); + if (!packets.empty()) { + packet = packets.front(); + packets.pop_front(); + received = true; + } + } + if (!received) + std::this_thread::sleep_for(std::chrono::microseconds(10)); + else if (!ReceivePacket(packet)) + break; + } + + EndDataCollection(); + + // Packets after the end of the data collection are dropped + stop_frame_generator = true; + if (frame_generator_future.valid()) + frame_generator_future.get(); + { + std::unique_lock ul(packets_mutex); + packets.clear(); + } + idle = true; +} + +bool MockAcquisitionDevice::ReceivePacket(const Packet &packet) { + // udp.cpp and sls_detector.cpp + udp_packets++; + if (packet.bunchid_packet) { + current_pulse_id = packet.bunchid; + return true; + } + if (packet.eth_error || packet.len_error) + return true; + if ((((packet.udp_port >> 8) & 0xF) != (cfg.data_stream & 0xF)) || (packet.frame_number == 0)) + return true; + sls_packets++; + + // data_collection_fsm.cpp: a frame far enough after the last one ends the data collection + uint64_t frame_number = packet.frame_number - 1; + if (frame_number >= static_cast(cfg.nframes) - 1 + DELAY_FRAMES_STOP_AND_QUIT) + return false; + + // stream512to768.cpp: location of the packet in the module, in units of 32 beats = 1024 pixels + uint32_t module = (packet.udp_port >> 1) & 0x1F; + uint32_t row = packet.udp_port & 1; + uint32_t column = packet.column & 1; + uint32_t eth_packet = packet.packet_number & 0x1FF; + uint32_t packet_parts; + + if (packet.detector_type == SLS_DETECTOR_TYPE_JUNGFRAU) { + packet_parts = 4; + eth_packet = (eth_packet % 128) | (row * 64); + } else if (cfg.mode & MODE_EIGER_8BIT) { + packet_parts = 4; + eth_packet = (row ? (64 + (eth_packet % 32) * 2) : (62 - (eth_packet % 32) * 2)) | column; + } else if (cfg.mode & MODE_EIGER_32BIT) { + packet_parts = 1; + uint32_t pos_of_4_line = (eth_packet % 128) / 2; + uint32_t pos_within_2_lines = eth_packet % 2; + eth_packet = (row ? (256 + pos_of_4_line * 4) : (252 - pos_of_4_line * 4)) | (2 * column) | pos_within_2_lines; + } else { + packet_parts = 2; + eth_packet = (row ? (128 + (eth_packet % 64) * 2) : (126 - (eth_packet % 64) * 2)) | column; + } + + // save_to_hbm.cpp: a module is complete only when the next frame of the same parity arrives + // for that module, or at the end of the data collection + ModuleCompletion &c = collected_modules[module * 2 + frame_number % 2]; + if (c.frame_number != frame_number) { + if (!MaskEmpty(c.packet_mask)) + SendCompletion(c); + c = ModuleCompletion{ + .frame_number = frame_number, + .exptime = packet.exptime, + .timestamp = packet.timestamp, + .bunchid = packet.bunchid, + .debug = packet.debug, + .module = module, + .detector_type = packet.detector_type, + .generator_slot = packet.generator_slot + }; + } + for (uint32_t i = eth_packet * packet_parts; i < (eth_packet + 1) * packet_parts; i++) + c.packet_mask[i / 64] |= (1LU << (i % 64)); + c.packet_count += packet_parts; + return true; +} + +void MockAcquisitionDevice::SendCompletion(const ModuleCompletion &c) { + // frame_summation_reorder_compl.cpp: with summation, frames are grouped per module and only complete + // groups are written + uint32_t sum = cfg.nsummation & UINT8_MAX; + if (sum == 0) { + LoadModule(c); + return; + } + + uint64_t frame_prefix = c.frame_number / (sum + 1); + uint32_t frame_loc = c.frame_number % (sum + 1); + uint32_t m = c.module; + + if (frame_prefix > summation_frame_prefix[m]) { + SendSummationGroup(m); + summation_mask[m].assign(MAX_FPGA_SUMMATION, false); + summation_completions[m * MAX_FPGA_SUMMATION + frame_loc] = c; + summation_mask[m][frame_loc] = true; + summation_count[m] = 1; + summation_frame_prefix[m] = frame_prefix; + } else if (frame_prefix == summation_frame_prefix[m]) { + summation_completions[m * MAX_FPGA_SUMMATION + frame_loc] = c; + summation_mask[m][frame_loc] = true; + summation_count[m] += 1; + } else { + ModuleCompletion late = c; + late.ignore = true; + LoadModule(late); + } +} + +void MockAcquisitionDevice::SendSummationGroup(uint32_t m) { + uint32_t sum = cfg.nsummation & UINT8_MAX; + for (int i = 0; i <= sum; i++) { + if (summation_mask[m][i]) { + ModuleCompletion c = summation_completions[m * MAX_FPGA_SUMMATION + i]; + if (summation_count[m] != sum + 1) + c.ignore = true; + LoadModule(c); + } + } +} + +void MockAcquisitionDevice::LoadModule(const ModuleCompletion &c) { + // load_from_hbm.cpp: an incomplete summation group is dropped + if (c.ignore) + return; + + // frame_summation.cpp: one module per group, with the header of the first frame and the packets + // present in all frames + uint32_t sum = cfg.nsummation & UINT8_MAX; + if (sum == 0) { + WriteToHost(c); + return; + } + if (frames_in_group == 0) { + group_completion = c; + group_completion.frame_number = c.frame_number / (sum + 1); + } else { + for (int i = 0; i < 8; i++) + group_completion.packet_mask[i] &= c.packet_mask[i]; + group_completion.packet_count += c.packet_count; + } + frames_in_group++; + if (frames_in_group == sum + 1) { + frames_in_group = 0; + WriteToHost(group_completion); + } +} + +void MockAcquisitionDevice::WriteToHost(const ModuleCompletion &c) { + // host_writer.cpp: waits for a host buffer; only when the data collection is cancelled the module + // is dropped instead + uint32_t handle; + const auto t0 = std::chrono::steady_clock::now(); + while (!work_requests.Get(handle)) { + if (cancel) + return; + std::this_thread::sleep_for(std::chrono::microseconds(10)); + } + // timer_host: the wait in cycles of the card's 200 MHz clock + stalls_host += std::chrono::duration_cast(std::chrono::steady_clock::now() - t0).count() / 5; + if (handle >= buffer_device.size()) + return; + DeviceOutput *output = buffer_device[handle]; + + const DeviceOutput *ready_output = nullptr; + if (!outputs.empty()) { + auto &image = outputs[c.frame_number % outputs.size()]; + if (c.module < image.size()) + ready_output = image[c.module].get(); + } + if (ready_output != nullptr) + memcpy(output, ready_output, sizeof(DeviceOutput)); + else { + memset(output, 0, sizeof(DeviceOutput)); + if ((c.generator_slot != NoGeneratorSlot) && !generator_frames[c.generator_slot].empty()) + memcpy(output->pixels, generator_frames[c.generator_slot].data(), RAW_MODULE_SIZE * sizeof(uint16_t)); + } + + ModuleStatistics &stats = output->module_statistics; + stats.frame_number = c.frame_number; + stats.timestamp = c.timestamp; + memcpy(&stats.pulse_id, &c.bunchid, sizeof(uint64_t)); + stats.detector_type = c.detector_type; + stats.exptime = c.exptime; + stats.debug = c.debug; + stats.pedestal = 0; + stats.packet_count = c.packet_count; + stats.module_number = c.module; + stats.load_calibration_destination = 0; + memcpy(stats.packet_mask, c.packet_mask, sizeof(stats.packet_mask)); + + // host_writer.cpp: a module is announced to the host only when the next one is written, or at the end + uint32_t data_collection_id = (cfg.mode >> 16) & UINT16_MAX; + if (handle_to_complete != HANDLE_START) + completions.Put((data_collection_id << 16) | handle_to_complete); + handle_to_complete = handle; +} + +void MockAcquisitionDevice::EndDataCollection() { + // save_to_hbm.cpp: modules still being collected, for each module the older frame first + for (int m = 0; m < MAX_MODULES_FPGA; m++) { + const ModuleCompletion &c0 = collected_modules[2 * m]; + const ModuleCompletion &c1 = collected_modules[2 * m + 1]; + const ModuleCompletion &first = (c0.frame_number < c1.frame_number) ? c0 : c1; + const ModuleCompletion &second = (c0.frame_number < c1.frame_number) ? c1 : c0; + if (!MaskEmpty(first.packet_mask)) + SendCompletion(first); + if (!MaskEmpty(second.packet_mask)) + SendCompletion(second); + } + + // frame_summation_reorder_compl.cpp + if ((cfg.nsummation & UINT8_MAX) > 0) { + for (int m = 0; m < MAX_MODULES_FPGA; m++) + SendSummationGroup(m); + } + + // host_writer.cpp + uint32_t data_collection_id = (cfg.mode >> 16) & UINT16_MAX; + if (handle_to_complete != HANDLE_START) + completions.Put((data_collection_id << 16) | handle_to_complete); + completions.Put((data_collection_id << 16) | HANDLE_END); +} + +DataCollectionStatus MockAcquisitionDevice::GetDataCollectionStatus() const { + DataCollectionStatus status{}; + + uint64_t pulse_id_u64 = current_pulse_id; + double pulse_id; + memcpy(&pulse_id, &pulse_id_u64, sizeof(double)); + + status.ctrl_reg = idle ? (1 << 4) : 0; + status.max_modules = MAX_MODULES_FPGA; + status.hbm_size_bytes = card_memory_bytes; + status.run_counter = run_counter; + status.current_pulseid = pulse_id; + status.packets_udp = udp_packets; + status.packets_sls = sls_packets; + status.pipeline_stalls_host = stalls_host; + return status; +} + +DeviceStatus MockAcquisitionDevice::GetDeviceStatus() const { + DeviceStatus status{}; + + strncpy(status.serial_number, "MOCK1", sizeof(status.serial_number)); + strncpy(status.device_number, "Mock device", sizeof(status.device_number)); + status.fpga_default_mac_addr = mac_addr; + status.eth_link_count = 1; + status.eth_link_status = 1; + status.packets_sls = sls_packets; + status.packets_udp = udp_packets; + return status; +} diff --git a/acquisition_device/MockAcquisitionDevice.h b/acquisition_device/MockAcquisitionDevice.h new file mode 100644 index 000000000..97757c718 --- /dev/null +++ b/acquisition_device/MockAcquisitionDevice.h @@ -0,0 +1,149 @@ +// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +// SPDX-License-Identifier: GPL-3.0-only + +#pragma once + +#include +#include +#include + +#include "FPGAAcquisitionDevice.h" + +// Behavioural mock of the FPGA card, for tests and for the broker without hardware. The card is a black +// box: the mock computes nothing (no conversion, summation, spot finding, integration or ROI), it +// reproduces what the host sees of the card - which module is written to which host buffer and when, the +// order of completions, packet counts and masks, frames that are missing or late, summation groups, +// counters, the end of the data collection, cancel and the internal frame generator with its refusals. +// +// The packets are given with CreateJFPacket() etc., or come from the internal frame generator; their +// pixel content is ignored. What the card writes for a module - pixels, spot finder, integration, ADU +// histogram, ROI and pixel statistics - is given ready-made with SetOutput(): the module written for +// frame (after summation) F and module M is the output set for image F % (number of images set) and M. +// Without one, the pixels are the frame the internal generator sent for it (as loaded with +// SetInternalGeneratorFrame(), 16-bit, not reordered), or zeros for a packet made by a test, and every +// result is zero. The header part of ModuleStatistics (frame number, timestamp, pulse ID, exposure time, +// debug, detector type, module number, packet count and mask) is filled by the mock from the packets. +// +// Any number of these devices can run at the same time. +class MockAcquisitionDevice : public FPGAAcquisitionDevice { + struct alignas(4096) FrameBuffer { uint8_t data[FPGA_BUFFER_LOCATION_SIZE]; }; + std::vector> buffers; + + // Header of one UDP packet, as the network cores of the card see it + struct Packet { + uint64_t frame_number; // as in the detector header, i.e. counted from one + uint32_t packet_number; + uint16_t udp_port; + uint16_t column; + uint8_t detector_type; + uint32_t exptime; + uint64_t bunchid; + uint64_t timestamp; + uint32_t debug; + bool eth_error; + bool len_error; + bool bunchid_packet; + uint32_t generator_slot; // frame of the internal generator the packet carries, NoGeneratorSlot if none + }; + static constexpr uint32_t NoGeneratorSlot = UINT32_MAX; + + // axis_completion in fpga/hls/hls_jfjoch.h + struct ModuleCompletion { + uint64_t packet_mask[8]; + uint64_t frame_number; + uint64_t exptime; + uint64_t timestamp; + uint64_t bunchid; + uint32_t debug; + uint16_t packet_count; + uint32_t module; + uint32_t detector_type; + bool ignore; + uint32_t generator_slot; + }; + + const uint32_t card_memory_bytes; + std::vector>> outputs; + // The frames of the internal generator, by slot (module frame of the card memory) + std::vector> generator_frames; + + std::mutex packets_mutex; + std::deque packets; + + ThreadSafeFIFO work_requests; + ThreadSafeFIFO completions; + + DataCollectionConfig cfg{}; + + // save_to_hbm.cpp: module being collected, for each module and frame parity + std::vector collected_modules; + + // frame_summation_reorder_compl.cpp and frame_summation.cpp + std::vector summation_completions; + std::vector> summation_mask; + std::vector summation_count; + std::vector summation_frame_prefix; + uint32_t frames_in_group = 0; + ModuleCompletion group_completion{}; + + // host_writer.cpp + uint32_t handle_to_complete = HANDLE_START; + + std::thread action_thread; + std::future frame_generator_future; + std::atomic cancel = false; + std::atomic stop_frame_generator = false; + std::atomic frame_generator_result = 0; + std::atomic idle = true; + + uint32_t run_counter = 0; + std::atomic current_pulse_id = UINT64_MAX; + std::atomic udp_packets = 0; + std::atomic sls_packets = 0; + std::atomic stalls_host = 0; + + void HW_ReadActionRegister(DataCollectionConfig *job) override; + void HW_WriteActionRegister(const DataCollectionConfig *job) override; + void FPGA_StartAction(const DiffractionExperiment &experiment) override; + void FPGA_EndAction() override; + bool HW_IsIdle() const override; + bool HW_ReadMailbox(uint32_t *values) override; + bool HW_SendWorkRequest(uint32_t handle) override; + void HW_LoadCalibration(const LoadCalibrationConfig &config) override; + void HW_SetSpotFinderParameters(const SpotFinderParameters ¶ms) override; + void HW_RunInternalGenerator(const FrameGeneratorConfig &config) override; + + void AddPacket(const Packet &packet); + // frame_generator.cpp: its return code, 0 when it ran + int FrameGenerator(FrameGeneratorConfig config); + + void DataCollectionThread(); + bool ReceivePacket(const Packet &packet); + void SendCompletion(const ModuleCompletion &c); + void SendSummationGroup(uint32_t module); + void LoadModule(const ModuleCompletion &c); + void WriteToHost(const ModuleCompletion &c); + void EndDataCollection(); +public: + // Memory of one HBM interface, as the HLS simulation had it: 64 module frames for the internal generator + static constexpr uint32_t DefaultCardMemoryBytes = 32 * 1024 * 1024; + + MockAcquisitionDevice(uint16_t data_stream, size_t in_frame_buffer_size_modules, + uint32_t card_memory_bytes = DefaultCardMemoryBytes); + ~MockAcquisitionDevice() override; + + void SetOutput(uint64_t image, uint32_t module_number, const DeviceOutput &output); + + void CreateJFPacket(const DiffractionExperiment& experiment, uint64_t frame_number, uint32_t eth_packet, + uint32_t module_number, const uint16_t *data, int8_t adjust_axis = 0, uint8_t user = 0); + void CreateJFPackets(const DiffractionExperiment& experiment, uint64_t frame_number_0, uint64_t frames, + uint32_t module_number, const uint16_t *data); + void 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); + void CreateXfelBunchIDPacket(double bunchid, uint32_t event_code); + void CreateFinalPacket(const DiffractionExperiment& experiment); + DataCollectionStatus GetDataCollectionStatus() const override; + void Cancel() override; + DeviceStatus GetDeviceStatus() const override; +}; diff --git a/broker/CMakeLists.txt b/broker/CMakeLists.txt index ef27ff36c..45745fb89 100644 --- a/broker/CMakeLists.txt +++ b/broker/CMakeLists.txt @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2023 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only + # OpenAPI model AUX_SOURCE_DIRECTORY(gen/model MODEL_SOURCES) ADD_LIBRARY(JFJochAPI STATIC ${MODEL_SOURCES}) diff --git a/broker/JFJochBrokerHttp.cpp b/broker/JFJochBrokerHttp.cpp index bbbba1e94..8113cf325 100644 --- a/broker/JFJochBrokerHttp.cpp +++ b/broker/JFJochBrokerHttp.cpp @@ -1018,6 +1018,8 @@ void JFJochBrokerHttp::config_rugnux_get(httplib::Response &response) { ret.setDeadlineS(s.deadline_s); ret.setRefineSolvent(s.refine_solvent); ret.setForceStill(s.force_still); + ret.setStillsDownsample(s.stills_downsample); + ret.setStillsPrepassImages(s.stills_prepass_images); ret.setModelLoaded(s.model != nullptr); if (s.model) ret.setModelSizeBytes(s.model_size_bytes); @@ -1028,7 +1030,8 @@ void JFJochBrokerHttp::config_rugnux_put(const Rugnux_settings &rugnuxSettings, httplib::Response &response) { state_machine.SetRugnuxLive(rugnuxSettings.isEnable(), rugnuxSettings.getReservedCpus(), rugnuxSettings.getDeadlineS(), rugnuxSettings.isRefineSolvent(), - rugnuxSettings.isForceStill()); + rugnuxSettings.isForceStill(), rugnuxSettings.getStillsDownsample(), + rugnuxSettings.getStillsPrepassImages()); response.status = 200; } diff --git a/broker/JFJochBrokerParser.cpp b/broker/JFJochBrokerParser.cpp index ffbd460fa..9ffe0d121 100644 --- a/broker/JFJochBrokerParser.cpp +++ b/broker/JFJochBrokerParser.cpp @@ -252,7 +252,7 @@ std::unique_ptr ParseImagePusher(const org::openapitools::server::m void ParseAcquisitionDeviceGroup(const org::openapitools::server::model::Jfjoch_settings &input, AcquisitionDeviceGroup &aq_devices) { if (!input.pcieIsSet()) - aq_devices.AddHLSDevice(256); + aq_devices.AddMockDevice(256); else for (auto &p: input.getPcie()) { std::optional ipv4_addr = {}; if (p.ipv4IsSet()) @@ -283,7 +283,9 @@ void ParseRugnuxSettings(const org::openapitools::server::model::Jfjoch_settings .reserved_cpus = input.getRugnux().getReservedCpus(), .deadline_s = input.getRugnux().getDeadlineS(), .refine_solvent = input.getRugnux().isRefineSolvent(), - .force_still = input.getRugnux().isForceStill() + .force_still = input.getRugnux().isForceStill(), + .stills_downsample = input.getRugnux().getStillsDownsample(), + .stills_prepass_images = input.getRugnux().getStillsPrepassImages() }); } diff --git a/broker/JFJochServices.cpp b/broker/JFJochServices.cpp index f992be1de..16b3462fb 100644 --- a/broker/JFJochServices.cpp +++ b/broker/JFJochServices.cpp @@ -385,7 +385,7 @@ void JFJochServices::SetupIndexing(const IndexingSettings &input) { void JFJochServices::SetRugnuxLive(const RugnuxLiveSettings &input) { if (receiver) receiver->RugnuxLive(input.enable, input.model, input.reserved_cpus, input.deadline_s, input.refine_solvent, - input.force_still); + input.force_still, input.stills_downsample, input.stills_prepass_images); rugnux = input; } diff --git a/broker/JFJochServices.h b/broker/JFJochServices.h index 22d2e777e..c670eed5a 100644 --- a/broker/JFJochServices.h +++ b/broker/JFJochServices.h @@ -20,6 +20,8 @@ struct RugnuxLiveSettings { double deadline_s = 60; // the analysis is cut this long after the last image (0 = never) bool refine_solvent = false; // the refinement of a placed model builds the solvent (rugnux --refine-solvent) bool force_still = false; // rotation collections are processed as stills (rugnux --force-still) + int64_t stills_downsample = 1; // serial collections: 1 of every this many images analysed on average + int64_t stills_prepass_images = STILLS_PREPASS_IMAGES; // serial collections: the first images the pre-pass looks at std::shared_ptr model; // null = no model int64_t model_size_bytes = 0; // as uploaded }; diff --git a/broker/JFJochStateMachine.cpp b/broker/JFJochStateMachine.cpp index 1097063ea..890d91982 100644 --- a/broker/JFJochStateMachine.cpp +++ b/broker/JFJochStateMachine.cpp @@ -343,6 +343,8 @@ void JFJochStateMachine::Initialize() { s.enable = false; s.refine_solvent = false; s.force_still = false; + s.stills_downsample = 1; + s.stills_prepass_images = STILLS_PREPASS_IMAGES; s.model = nullptr; s.model_size_bytes = 0; services.SetRugnuxLive(s); @@ -1226,7 +1228,8 @@ IndexingSettings JFJochStateMachine::GetIndexingSettings() const { } void JFJochStateMachine::SetRugnuxLive(bool enable, int64_t reserved_cpus, double deadline_s, bool refine_solvent, - bool force_still) { + bool force_still, int64_t stills_downsample, + int64_t stills_prepass_images) { std::unique_lock ul(m); if (IsRunning()) throw WrongDAQStateException("Cannot change rugnux settings during data collection"); @@ -1237,6 +1240,8 @@ void JFJochStateMachine::SetRugnuxLive(bool enable, int64_t reserved_cpus, doubl s.deadline_s = deadline_s; s.refine_solvent = refine_solvent; s.force_still = force_still; + s.stills_downsample = stills_downsample; + s.stills_prepass_images = stills_prepass_images; services.SetRugnuxLive(s); } diff --git a/broker/JFJochStateMachine.h b/broker/JFJochStateMachine.h index 10ac694ee..c86dfc01b 100644 --- a/broker/JFJochStateMachine.h +++ b/broker/JFJochStateMachine.h @@ -248,7 +248,8 @@ public: void SetIndexingSettings(const IndexingSettings &input); IndexingSettings GetIndexingSettings() const; - void SetRugnuxLive(bool enable, int64_t reserved_cpus, double deadline_s, bool refine_solvent, bool force_still); + void SetRugnuxLive(bool enable, int64_t reserved_cpus, double deadline_s, bool refine_solvent, bool force_still, + int64_t stills_downsample = 1, int64_t stills_prepass_images = STILLS_PREPASS_IMAGES); void SetRugnuxModel(std::shared_ptr model, int64_t size_bytes); // null = remove the model RugnuxLiveSettings GetRugnuxLive() const; RugnuxLiveSnapshot GetRugnuxStatus() const; diff --git a/broker/OpenAPIConvert.cpp b/broker/OpenAPIConvert.cpp index bae930389..daefb8d72 100644 --- a/broker/OpenAPIConvert.cpp +++ b/broker/OpenAPIConvert.cpp @@ -728,7 +728,8 @@ DatasetSettings Convert(const org::openapitools::server::model::Dataset_settings ret.SampleTemperature_K(input.getSampleTemperatureK()); ret.SpotFindingEnable(input.isSpotFinding()); - ret.MaxSpotCount(input.getMaxSpotCount()); + if (input.maxSpotCountIsSet()) + ret.MaxSpotCount(input.getMaxSpotCount()); if (input.detectIceRingsIsSet()) ret.DetectIceRings(input.isDetectIceRings()); @@ -957,6 +958,7 @@ PlotType ConvertPlotType(const std::optional& input) { if (input == "image_scale_cc") return PlotType::ImageScaleCC; if (input == "compression_ratio") return PlotType::CompressionRatio; if (input == "indexing_lattice_count") return PlotType::IndexingLatticeCount; + if (input == "image_merged") return PlotType::ImageMerged; throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "Plot type not recognized"); } @@ -1322,6 +1324,8 @@ org::openapitools::server::model::Rugnux_live_status Convert(const RugnuxLiveSna ret.setSpaceGroup(input.space_group); if (input.d_min) ret.setDMin(input.d_min.value()); + if (input.resolution_fit) + ret.setResolutionFit(input.resolution_fit.value()); if (input.isa) ret.setIsa(input.isa.value()); if (input.stills) { @@ -1447,6 +1451,8 @@ org::openapitools::server::model::Rugnux_live_status Convert(const RugnuxLiveSna blob.setNearestAtom(b.nearest_atom); if (b.nearest_atom_distance_A) blob.setNearestAtomDistanceA(*b.nearest_atom_distance_A); + if (b.anomalous_sigma) + blob.setAnomalousSigma(*b.anomalous_sigma); blobs.push_back(blob); } refinement.setBlobs(blobs); diff --git a/broker/gen/model/Azim_int_settings.cpp b/broker/gen/model/Azim_int_settings.cpp index 600ddd6f5..a5d4df866 100644 --- a/broker/gen/model/Azim_int_settings.cpp +++ b/broker/gen/model/Azim_int_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Azim_int_settings.h b/broker/gen/model/Azim_int_settings.h index ed5714309..fba2e442f 100644 --- a/broker/gen/model/Azim_int_settings.h +++ b/broker/gen/model/Azim_int_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Bragg_integration_settings.cpp b/broker/gen/model/Bragg_integration_settings.cpp index b83cf807d..3cde6a6e2 100644 --- a/broker/gen/model/Bragg_integration_settings.cpp +++ b/broker/gen/model/Bragg_integration_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Bragg_integration_settings.h b/broker/gen/model/Bragg_integration_settings.h index 625b48b36..10b61b397 100644 --- a/broker/gen/model/Bragg_integration_settings.h +++ b/broker/gen/model/Bragg_integration_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Broker_status.cpp b/broker/gen/model/Broker_status.cpp index 3bcab994c..223ea1085 100644 --- a/broker/gen/model/Broker_status.cpp +++ b/broker/gen/model/Broker_status.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Broker_status.h b/broker/gen/model/Broker_status.h index 07e5e8f7c..edbd91ae3 100644 --- a/broker/gen/model/Broker_status.h +++ b/broker/gen/model/Broker_status.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Calibration_statistics_inner.cpp b/broker/gen/model/Calibration_statistics_inner.cpp index a43191373..b870a837f 100644 --- a/broker/gen/model/Calibration_statistics_inner.cpp +++ b/broker/gen/model/Calibration_statistics_inner.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Calibration_statistics_inner.h b/broker/gen/model/Calibration_statistics_inner.h index c57a80ae4..564ea8926 100644 --- a/broker/gen/model/Calibration_statistics_inner.h +++ b/broker/gen/model/Calibration_statistics_inner.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Dark_mask_settings.cpp b/broker/gen/model/Dark_mask_settings.cpp index fab840343..e6a329f3a 100644 --- a/broker/gen/model/Dark_mask_settings.cpp +++ b/broker/gen/model/Dark_mask_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Dark_mask_settings.h b/broker/gen/model/Dark_mask_settings.h index 5703a7364..634eedc94 100644 --- a/broker/gen/model/Dark_mask_settings.h +++ b/broker/gen/model/Dark_mask_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Dataset_settings.cpp b/broker/gen/model/Dataset_settings.cpp index abf474ec9..570d8a360 100644 --- a/broker/gen/model/Dataset_settings.cpp +++ b/broker/gen/model/Dataset_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -85,7 +85,7 @@ Dataset_settings::Dataset_settings() m_Spot_finding = true; m_Spot_findingIsSet = false; m_SmargonIsSet = false; - m_Max_spot_count = 250; + m_Max_spot_count = 0; m_Max_spot_countIsSet = false; m_Detect_ice_rings = false; m_Detect_ice_ringsIsSet = false; diff --git a/broker/gen/model/Dataset_settings.h b/broker/gen/model/Dataset_settings.h index 6a91d8d51..700aa563e 100644 --- a/broker/gen/model/Dataset_settings.h +++ b/broker/gen/model/Dataset_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -81,7 +81,7 @@ public: bool ntriggerIsSet() const; void unsetNtrigger(); /// - /// Image time. If not provided (or zero value) the frame time is assumed as default. For JUNGFRAU image time must be multiple of frame time and max value is 256 * frame_time. In XFEL mode: summation happens for frames collected with multiple triggers. Ignored for storage cells and if raw data are saved. + /// Image time. If not provided (or zero value) the frame time is assumed as default. For JUNGFRAU image time must be multiple of frame time. Up to 256 frames are summed on the FPGA. Above that the FPGA sums the largest number of frames up to 256 that divides the frames of an image (250 of 1000) and the host adds up the rest; the more the host sums, the slower (a prime number of frames is summed on the host entirely). In XFEL mode: summation happens for frames collected with multiple triggers. Ignored for storage cells and if raw data are saved. /// int64_t getImageTimeUs() const; void setImageTimeUs(int64_t const value); @@ -318,7 +318,7 @@ public: bool smargonIsSet() const; void unsetSmargon(); /// - /// Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected + /// Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected. Left out, the broker's per-image indexing keeps 250 and rugnux live stills 1000. /// int32_t getMaxSpotCount() const; void setMaxSpotCount(int32_t const value); diff --git a/broker/gen/model/Dataset_settings_smargon.cpp b/broker/gen/model/Dataset_settings_smargon.cpp index 1a69c3c84..fff0ba7ac 100644 --- a/broker/gen/model/Dataset_settings_smargon.cpp +++ b/broker/gen/model/Dataset_settings_smargon.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Dataset_settings_smargon.h b/broker/gen/model/Dataset_settings_smargon.h index 615fcb860..0f7e4b1be 100644 --- a/broker/gen/model/Dataset_settings_smargon.h +++ b/broker/gen/model/Dataset_settings_smargon.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.cpp b/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.cpp index a540c4f87..fa61daeb6 100644 --- a/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.cpp +++ b/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.h b/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.h index ba28a236b..a7aa7890c 100644 --- a/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.h +++ b/broker/gen/model/Dataset_settings_xray_fluorescence_spectrum.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector.cpp b/broker/gen/model/Detector.cpp index 300a30deb..45f3f9aec 100644 --- a/broker/gen/model/Detector.cpp +++ b/broker/gen/model/Detector.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector.h b/broker/gen/model/Detector.h index ee386987a..296d1a6ea 100644 --- a/broker/gen/model/Detector.h +++ b/broker/gen/model/Detector.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_list.cpp b/broker/gen/model/Detector_list.cpp index 939ec2c1d..c2cf38f85 100644 --- a/broker/gen/model/Detector_list.cpp +++ b/broker/gen/model/Detector_list.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_list.h b/broker/gen/model/Detector_list.h index cbb283a9a..ac285167e 100644 --- a/broker/gen/model/Detector_list.h +++ b/broker/gen/model/Detector_list.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_list_element.cpp b/broker/gen/model/Detector_list_element.cpp index 5516d38fb..d47a07201 100644 --- a/broker/gen/model/Detector_list_element.cpp +++ b/broker/gen/model/Detector_list_element.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_list_element.h b/broker/gen/model/Detector_list_element.h index 8bbea1eb8..b75ad9ee8 100644 --- a/broker/gen/model/Detector_list_element.h +++ b/broker/gen/model/Detector_list_element.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_module.cpp b/broker/gen/model/Detector_module.cpp index f9c872e70..1058008c4 100644 --- a/broker/gen/model/Detector_module.cpp +++ b/broker/gen/model/Detector_module.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_module.h b/broker/gen/model/Detector_module.h index aa596fc89..1f2194a96 100644 --- a/broker/gen/model/Detector_module.h +++ b/broker/gen/model/Detector_module.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_module_direction.cpp b/broker/gen/model/Detector_module_direction.cpp index 9d274e254..de4c1926c 100644 --- a/broker/gen/model/Detector_module_direction.cpp +++ b/broker/gen/model/Detector_module_direction.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_module_direction.h b/broker/gen/model/Detector_module_direction.h index 522ff0145..3c04685de 100644 --- a/broker/gen/model/Detector_module_direction.h +++ b/broker/gen/model/Detector_module_direction.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_module_placement.cpp b/broker/gen/model/Detector_module_placement.cpp index 979b21382..a4e9beade 100644 --- a/broker/gen/model/Detector_module_placement.cpp +++ b/broker/gen/model/Detector_module_placement.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_module_placement.h b/broker/gen/model/Detector_module_placement.h index da8ea65f4..02dfeb382 100644 --- a/broker/gen/model/Detector_module_placement.h +++ b/broker/gen/model/Detector_module_placement.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_power_state.cpp b/broker/gen/model/Detector_power_state.cpp index 39ea54fc7..775bcefa6 100644 --- a/broker/gen/model/Detector_power_state.cpp +++ b/broker/gen/model/Detector_power_state.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_power_state.h b/broker/gen/model/Detector_power_state.h index f9f687bd6..7b23494d3 100644 --- a/broker/gen/model/Detector_power_state.h +++ b/broker/gen/model/Detector_power_state.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_selection.cpp b/broker/gen/model/Detector_selection.cpp index e6564d49c..05dec8729 100644 --- a/broker/gen/model/Detector_selection.cpp +++ b/broker/gen/model/Detector_selection.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_selection.h b/broker/gen/model/Detector_selection.h index 3166bceec..b99bb3962 100644 --- a/broker/gen/model/Detector_selection.h +++ b/broker/gen/model/Detector_selection.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_settings.cpp b/broker/gen/model/Detector_settings.cpp index 0461e0cb3..bf6b8c34a 100644 --- a/broker/gen/model/Detector_settings.cpp +++ b/broker/gen/model/Detector_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_settings.h b/broker/gen/model/Detector_settings.h index 0bcd0dc90..5ae75f0c5 100644 --- a/broker/gen/model/Detector_settings.h +++ b/broker/gen/model/Detector_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_state.cpp b/broker/gen/model/Detector_state.cpp index 64bb76ff7..005d79bad 100644 --- a/broker/gen/model/Detector_state.cpp +++ b/broker/gen/model/Detector_state.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_state.h b/broker/gen/model/Detector_state.h index d2dd810e6..6deaeee04 100644 --- a/broker/gen/model/Detector_state.h +++ b/broker/gen/model/Detector_state.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_status.cpp b/broker/gen/model/Detector_status.cpp index b091fd096..b7d7ea768 100644 --- a/broker/gen/model/Detector_status.cpp +++ b/broker/gen/model/Detector_status.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_status.h b/broker/gen/model/Detector_status.h index 1e772ed6b..a7029b50a 100644 --- a/broker/gen/model/Detector_status.h +++ b/broker/gen/model/Detector_status.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_timing.cpp b/broker/gen/model/Detector_timing.cpp index bbdbffcbe..3ae923f2b 100644 --- a/broker/gen/model/Detector_timing.cpp +++ b/broker/gen/model/Detector_timing.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_timing.h b/broker/gen/model/Detector_timing.h index a73b85840..d0a8beb4b 100644 --- a/broker/gen/model/Detector_timing.h +++ b/broker/gen/model/Detector_timing.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_type.cpp b/broker/gen/model/Detector_type.cpp index a7704271c..315d25a50 100644 --- a/broker/gen/model/Detector_type.cpp +++ b/broker/gen/model/Detector_type.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Detector_type.h b/broker/gen/model/Detector_type.h index ae2803899..a70ffc2a6 100644 --- a/broker/gen/model/Detector_type.h +++ b/broker/gen/model/Detector_type.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Error_message.cpp b/broker/gen/model/Error_message.cpp index aa04b7ded..8464cee66 100644 --- a/broker/gen/model/Error_message.cpp +++ b/broker/gen/model/Error_message.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Error_message.h b/broker/gen/model/Error_message.h index e4c1f7171..b26507f32 100644 --- a/broker/gen/model/Error_message.h +++ b/broker/gen/model/Error_message.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/File_writer_format.cpp b/broker/gen/model/File_writer_format.cpp index e865d0f78..482401520 100644 --- a/broker/gen/model/File_writer_format.cpp +++ b/broker/gen/model/File_writer_format.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/File_writer_format.h b/broker/gen/model/File_writer_format.h index e2fcab9e0..77e91e0e4 100644 --- a/broker/gen/model/File_writer_format.h +++ b/broker/gen/model/File_writer_format.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/File_writer_settings.cpp b/broker/gen/model/File_writer_settings.cpp index 40e163b3c..9486eeb79 100644 --- a/broker/gen/model/File_writer_settings.cpp +++ b/broker/gen/model/File_writer_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/File_writer_settings.h b/broker/gen/model/File_writer_settings.h index e1f86db35..bc8af0be0 100644 --- a/broker/gen/model/File_writer_settings.h +++ b/broker/gen/model/File_writer_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Fpga_status_inner.cpp b/broker/gen/model/Fpga_status_inner.cpp index 6018cae63..42c6ca1a7 100644 --- a/broker/gen/model/Fpga_status_inner.cpp +++ b/broker/gen/model/Fpga_status_inner.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Fpga_status_inner.h b/broker/gen/model/Fpga_status_inner.h index accea61c7..6b03daf50 100644 --- a/broker/gen/model/Fpga_status_inner.h +++ b/broker/gen/model/Fpga_status_inner.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Geom_refinement_algorithm.cpp b/broker/gen/model/Geom_refinement_algorithm.cpp index 7c5badd93..4068e401e 100644 --- a/broker/gen/model/Geom_refinement_algorithm.cpp +++ b/broker/gen/model/Geom_refinement_algorithm.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Geom_refinement_algorithm.h b/broker/gen/model/Geom_refinement_algorithm.h index daca2d14d..ba25e4974 100644 --- a/broker/gen/model/Geom_refinement_algorithm.h +++ b/broker/gen/model/Geom_refinement_algorithm.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Grid_scan.cpp b/broker/gen/model/Grid_scan.cpp index 436d7daf8..11c4b06a1 100644 --- a/broker/gen/model/Grid_scan.cpp +++ b/broker/gen/model/Grid_scan.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Grid_scan.h b/broker/gen/model/Grid_scan.h index 38fccb353..0d8642ba6 100644 --- a/broker/gen/model/Grid_scan.h +++ b/broker/gen/model/Grid_scan.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Helpers.cpp b/broker/gen/model/Helpers.cpp index ceb17cd43..b89cdadd0 100644 --- a/broker/gen/model/Helpers.cpp +++ b/broker/gen/model/Helpers.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Helpers.h b/broker/gen/model/Helpers.h index 3e109e54b..0cc7c607e 100644 --- a/broker/gen/model/Helpers.h +++ b/broker/gen/model/Helpers.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Image_buffer_status.cpp b/broker/gen/model/Image_buffer_status.cpp index 14b9273e2..58720c905 100644 --- a/broker/gen/model/Image_buffer_status.cpp +++ b/broker/gen/model/Image_buffer_status.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Image_buffer_status.h b/broker/gen/model/Image_buffer_status.h index 965dbac31..a6e60f883 100644 --- a/broker/gen/model/Image_buffer_status.h +++ b/broker/gen/model/Image_buffer_status.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Image_format_settings.cpp b/broker/gen/model/Image_format_settings.cpp index d4f314568..b7161b9cf 100644 --- a/broker/gen/model/Image_format_settings.cpp +++ b/broker/gen/model/Image_format_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Image_format_settings.h b/broker/gen/model/Image_format_settings.h index b9c5fd8d5..94b465872 100644 --- a/broker/gen/model/Image_format_settings.h +++ b/broker/gen/model/Image_format_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Image_pusher_status.cpp b/broker/gen/model/Image_pusher_status.cpp index 56a1fc38e..9306f7965 100644 --- a/broker/gen/model/Image_pusher_status.cpp +++ b/broker/gen/model/Image_pusher_status.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Image_pusher_status.h b/broker/gen/model/Image_pusher_status.h index d469285f2..9787416d0 100644 --- a/broker/gen/model/Image_pusher_status.h +++ b/broker/gen/model/Image_pusher_status.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Image_pusher_type.cpp b/broker/gen/model/Image_pusher_type.cpp index 48bca090b..2be473b45 100644 --- a/broker/gen/model/Image_pusher_type.cpp +++ b/broker/gen/model/Image_pusher_type.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Image_pusher_type.h b/broker/gen/model/Image_pusher_type.h index ba74071f5..dfa872ce1 100644 --- a/broker/gen/model/Image_pusher_type.h +++ b/broker/gen/model/Image_pusher_type.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Indexing_algorithm.cpp b/broker/gen/model/Indexing_algorithm.cpp index 8173be3f6..cd4b5b488 100644 --- a/broker/gen/model/Indexing_algorithm.cpp +++ b/broker/gen/model/Indexing_algorithm.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Indexing_algorithm.h b/broker/gen/model/Indexing_algorithm.h index 92743375a..172d9faf5 100644 --- a/broker/gen/model/Indexing_algorithm.h +++ b/broker/gen/model/Indexing_algorithm.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Indexing_settings.cpp b/broker/gen/model/Indexing_settings.cpp index 2d8c37790..b9c8704f6 100644 --- a/broker/gen/model/Indexing_settings.cpp +++ b/broker/gen/model/Indexing_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Indexing_settings.h b/broker/gen/model/Indexing_settings.h index f6d62f294..0d3b73522 100644 --- a/broker/gen/model/Indexing_settings.h +++ b/broker/gen/model/Indexing_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Instrument_metadata.cpp b/broker/gen/model/Instrument_metadata.cpp index cbb48acfd..4ae46223f 100644 --- a/broker/gen/model/Instrument_metadata.cpp +++ b/broker/gen/model/Instrument_metadata.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Instrument_metadata.h b/broker/gen/model/Instrument_metadata.h index ba003c554..9e3bfec13 100644 --- a/broker/gen/model/Instrument_metadata.h +++ b/broker/gen/model/Instrument_metadata.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Integration_model.cpp b/broker/gen/model/Integration_model.cpp index ea4242ad3..1d1eb8438 100644 --- a/broker/gen/model/Integration_model.cpp +++ b/broker/gen/model/Integration_model.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Integration_model.h b/broker/gen/model/Integration_model.h index cd0eae3bc..20158f7da 100644 --- a/broker/gen/model/Integration_model.h +++ b/broker/gen/model/Integration_model.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Jfjoch_settings.cpp b/broker/gen/model/Jfjoch_settings.cpp index e5f77e727..d903207cc 100644 --- a/broker/gen/model/Jfjoch_settings.cpp +++ b/broker/gen/model/Jfjoch_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Jfjoch_settings.h b/broker/gen/model/Jfjoch_settings.h index 0315594fc..dd8a78fde 100644 --- a/broker/gen/model/Jfjoch_settings.h +++ b/broker/gen/model/Jfjoch_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Jfjoch_statistics.cpp b/broker/gen/model/Jfjoch_statistics.cpp index a9f5a6395..b0688fd5c 100644 --- a/broker/gen/model/Jfjoch_statistics.cpp +++ b/broker/gen/model/Jfjoch_statistics.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Jfjoch_statistics.h b/broker/gen/model/Jfjoch_statistics.h index cb0b4775c..da979ad96 100644 --- a/broker/gen/model/Jfjoch_statistics.h +++ b/broker/gen/model/Jfjoch_statistics.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Measurement_statistics.cpp b/broker/gen/model/Measurement_statistics.cpp index aa1219a99..1801e2f9d 100644 --- a/broker/gen/model/Measurement_statistics.cpp +++ b/broker/gen/model/Measurement_statistics.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Measurement_statistics.h b/broker/gen/model/Measurement_statistics.h index 8151ee667..aa7e82504 100644 --- a/broker/gen/model/Measurement_statistics.h +++ b/broker/gen/model/Measurement_statistics.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Pcie_devices_inner.cpp b/broker/gen/model/Pcie_devices_inner.cpp index b290956c1..91fe5484c 100644 --- a/broker/gen/model/Pcie_devices_inner.cpp +++ b/broker/gen/model/Pcie_devices_inner.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Pcie_devices_inner.h b/broker/gen/model/Pcie_devices_inner.h index accc1be55..c8ac397c3 100644 --- a/broker/gen/model/Pcie_devices_inner.h +++ b/broker/gen/model/Pcie_devices_inner.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Pixel_mask_statistics.cpp b/broker/gen/model/Pixel_mask_statistics.cpp index 860de6055..4c47347fa 100644 --- a/broker/gen/model/Pixel_mask_statistics.cpp +++ b/broker/gen/model/Pixel_mask_statistics.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Pixel_mask_statistics.h b/broker/gen/model/Pixel_mask_statistics.h index 7b1c49da8..222ebb9d9 100644 --- a/broker/gen/model/Pixel_mask_statistics.h +++ b/broker/gen/model/Pixel_mask_statistics.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Plot.cpp b/broker/gen/model/Plot.cpp index 6337cd32f..c36917329 100644 --- a/broker/gen/model/Plot.cpp +++ b/broker/gen/model/Plot.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Plot.h b/broker/gen/model/Plot.h index 7ae09cb8e..bb912c5d7 100644 --- a/broker/gen/model/Plot.h +++ b/broker/gen/model/Plot.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Plot_unit_x.cpp b/broker/gen/model/Plot_unit_x.cpp index 2a85b178c..1c578b562 100644 --- a/broker/gen/model/Plot_unit_x.cpp +++ b/broker/gen/model/Plot_unit_x.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Plot_unit_x.h b/broker/gen/model/Plot_unit_x.h index 21d8b1922..388f3270e 100644 --- a/broker/gen/model/Plot_unit_x.h +++ b/broker/gen/model/Plot_unit_x.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Plots.cpp b/broker/gen/model/Plots.cpp index eb0c2c51b..aba24a65f 100644 --- a/broker/gen/model/Plots.cpp +++ b/broker/gen/model/Plots.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Plots.h b/broker/gen/model/Plots.h index 484029f51..a4a711795 100644 --- a/broker/gen/model/Plots.h +++ b/broker/gen/model/Plots.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Powder_calibration_fit_sigma.cpp b/broker/gen/model/Powder_calibration_fit_sigma.cpp index 229059c05..5fe5cb3d9 100644 --- a/broker/gen/model/Powder_calibration_fit_sigma.cpp +++ b/broker/gen/model/Powder_calibration_fit_sigma.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Powder_calibration_fit_sigma.h b/broker/gen/model/Powder_calibration_fit_sigma.h index 39e483f5f..12d4e254b 100644 --- a/broker/gen/model/Powder_calibration_fit_sigma.h +++ b/broker/gen/model/Powder_calibration_fit_sigma.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Powder_calibration_output.cpp b/broker/gen/model/Powder_calibration_output.cpp index 98f4df8ce..2f07c4093 100644 --- a/broker/gen/model/Powder_calibration_output.cpp +++ b/broker/gen/model/Powder_calibration_output.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Powder_calibration_output.h b/broker/gen/model/Powder_calibration_output.h index 3f65c541b..8bc0d5c43 100644 --- a/broker/gen/model/Powder_calibration_output.h +++ b/broker/gen/model/Powder_calibration_output.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Powder_calibration_quality.cpp b/broker/gen/model/Powder_calibration_quality.cpp index 0e69e88d4..7fcd670f8 100644 --- a/broker/gen/model/Powder_calibration_quality.cpp +++ b/broker/gen/model/Powder_calibration_quality.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Powder_calibration_quality.h b/broker/gen/model/Powder_calibration_quality.h index 75c74ace3..0c084a9f9 100644 --- a/broker/gen/model/Powder_calibration_quality.h +++ b/broker/gen/model/Powder_calibration_quality.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Powder_calibration_spot_check.cpp b/broker/gen/model/Powder_calibration_spot_check.cpp index 997d0db0b..2a812cac4 100644 --- a/broker/gen/model/Powder_calibration_spot_check.cpp +++ b/broker/gen/model/Powder_calibration_spot_check.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Powder_calibration_spot_check.h b/broker/gen/model/Powder_calibration_spot_check.h index baf6307d5..6734a9a6d 100644 --- a/broker/gen/model/Powder_calibration_spot_check.h +++ b/broker/gen/model/Powder_calibration_spot_check.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Q_binning.cpp b/broker/gen/model/Q_binning.cpp index e08db8da9..07532ea67 100644 --- a/broker/gen/model/Q_binning.cpp +++ b/broker/gen/model/Q_binning.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Q_binning.h b/broker/gen/model/Q_binning.h index 58ca2fcd6..ef10e6a7d 100644 --- a/broker/gen/model/Q_binning.h +++ b/broker/gen/model/Q_binning.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_azim_list.cpp b/broker/gen/model/Roi_azim_list.cpp index d82c77e7c..1491bb201 100644 --- a/broker/gen/model/Roi_azim_list.cpp +++ b/broker/gen/model/Roi_azim_list.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_azim_list.h b/broker/gen/model/Roi_azim_list.h index 2a4cf0f1c..1b545ec4c 100644 --- a/broker/gen/model/Roi_azim_list.h +++ b/broker/gen/model/Roi_azim_list.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_azimuthal.cpp b/broker/gen/model/Roi_azimuthal.cpp index 4a7bcd238..f217bb711 100644 --- a/broker/gen/model/Roi_azimuthal.cpp +++ b/broker/gen/model/Roi_azimuthal.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_azimuthal.h b/broker/gen/model/Roi_azimuthal.h index f7f2fe5c1..8aaa973dc 100644 --- a/broker/gen/model/Roi_azimuthal.h +++ b/broker/gen/model/Roi_azimuthal.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_box.cpp b/broker/gen/model/Roi_box.cpp index caa631213..d55e23d7c 100644 --- a/broker/gen/model/Roi_box.cpp +++ b/broker/gen/model/Roi_box.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_box.h b/broker/gen/model/Roi_box.h index 57ce3f7a8..bc10951de 100644 --- a/broker/gen/model/Roi_box.h +++ b/broker/gen/model/Roi_box.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_box_list.cpp b/broker/gen/model/Roi_box_list.cpp index ca7560a70..caf59e71f 100644 --- a/broker/gen/model/Roi_box_list.cpp +++ b/broker/gen/model/Roi_box_list.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_box_list.h b/broker/gen/model/Roi_box_list.h index bed58373c..7d051695e 100644 --- a/broker/gen/model/Roi_box_list.h +++ b/broker/gen/model/Roi_box_list.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_circle.cpp b/broker/gen/model/Roi_circle.cpp index 68e3c96bd..4d758ae5a 100644 --- a/broker/gen/model/Roi_circle.cpp +++ b/broker/gen/model/Roi_circle.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_circle.h b/broker/gen/model/Roi_circle.h index 9e3394824..d1aefadf6 100644 --- a/broker/gen/model/Roi_circle.h +++ b/broker/gen/model/Roi_circle.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_circle_list.cpp b/broker/gen/model/Roi_circle_list.cpp index afdbf4ba4..d7fedb571 100644 --- a/broker/gen/model/Roi_circle_list.cpp +++ b/broker/gen/model/Roi_circle_list.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_circle_list.h b/broker/gen/model/Roi_circle_list.h index 339ff3530..63288030b 100644 --- a/broker/gen/model/Roi_circle_list.h +++ b/broker/gen/model/Roi_circle_list.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_definitions.cpp b/broker/gen/model/Roi_definitions.cpp index bf76aebe4..c6923eb72 100644 --- a/broker/gen/model/Roi_definitions.cpp +++ b/broker/gen/model/Roi_definitions.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Roi_definitions.h b/broker/gen/model/Roi_definitions.h index 0be5ee43a..790d73773 100644 --- a/broker/gen/model/Roi_definitions.h +++ b/broker/gen/model/Roi_definitions.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rotation_axis.cpp b/broker/gen/model/Rotation_axis.cpp index bede3f120..3ac3ea74b 100644 --- a/broker/gen/model/Rotation_axis.cpp +++ b/broker/gen/model/Rotation_axis.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rotation_axis.h b/broker/gen/model/Rotation_axis.h index 07d72c1d9..9ff1a594d 100644 --- a/broker/gen/model/Rotation_axis.h +++ b/broker/gen/model/Rotation_axis.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_live_blob.cpp b/broker/gen/model/Rugnux_live_blob.cpp index 187896f0b..5af3784b3 100644 --- a/broker/gen/model/Rugnux_live_blob.cpp +++ b/broker/gen/model/Rugnux_live_blob.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -30,6 +30,8 @@ Rugnux_live_blob::Rugnux_live_blob() m_Nearest_atom = ""; m_Nearest_atom_distance_A = 0.0; m_Nearest_atom_distance_AIsSet = false; + m_Anomalous_sigma = 0.0; + m_Anomalous_sigmaIsSet = false; } @@ -52,7 +54,7 @@ bool Rugnux_live_blob::validate(std::stringstream& msg, const std::string& pathP bool success = true; const std::string _pathPrefix = pathPrefix.empty() ? "Rugnux_live_blob" : pathPrefix; - + return success; } @@ -83,7 +85,10 @@ bool Rugnux_live_blob::operator==(const Rugnux_live_blob& rhs) const && - ((!nearestAtomDistanceAIsSet() && !rhs.nearestAtomDistanceAIsSet()) || (nearestAtomDistanceAIsSet() && rhs.nearestAtomDistanceAIsSet() && getNearestAtomDistanceA() == rhs.getNearestAtomDistanceA())) + ((!nearestAtomDistanceAIsSet() && !rhs.nearestAtomDistanceAIsSet()) || (nearestAtomDistanceAIsSet() && rhs.nearestAtomDistanceAIsSet() && getNearestAtomDistanceA() == rhs.getNearestAtomDistanceA())) && + + + ((!anomalousSigmaIsSet() && !rhs.anomalousSigmaIsSet()) || (anomalousSigmaIsSet() && rhs.anomalousSigmaIsSet() && getAnomalousSigma() == rhs.getAnomalousSigma())) ; } @@ -105,6 +110,8 @@ void to_json(nlohmann::json& j, const Rugnux_live_blob& o) j["nearest_atom"] = o.m_Nearest_atom; if(o.nearestAtomDistanceAIsSet()) j["nearest_atom_distance_A"] = o.m_Nearest_atom_distance_A; + if(o.anomalousSigmaIsSet()) + j["anomalous_sigma"] = o.m_Anomalous_sigma; } @@ -122,6 +129,11 @@ void from_json(const nlohmann::json& j, Rugnux_live_blob& o) j.at("nearest_atom_distance_A").get_to(o.m_Nearest_atom_distance_A); o.m_Nearest_atom_distance_AIsSet = true; } + if(j.find("anomalous_sigma") != j.end()) + { + j.at("anomalous_sigma").get_to(o.m_Anomalous_sigma); + o.m_Anomalous_sigmaIsSet = true; + } } @@ -198,6 +210,23 @@ void Rugnux_live_blob::unsetNearest_atom_distance_A() { m_Nearest_atom_distance_AIsSet = false; } +double Rugnux_live_blob::getAnomalousSigma() const +{ + return m_Anomalous_sigma; +} +void Rugnux_live_blob::setAnomalousSigma(double const value) +{ + m_Anomalous_sigma = value; + m_Anomalous_sigmaIsSet = true; +} +bool Rugnux_live_blob::anomalousSigmaIsSet() const +{ + return m_Anomalous_sigmaIsSet; +} +void Rugnux_live_blob::unsetAnomalous_sigma() +{ + m_Anomalous_sigmaIsSet = false; +} } // namespace org::openapitools::server::model diff --git a/broker/gen/model/Rugnux_live_blob.h b/broker/gen/model/Rugnux_live_blob.h index a56f3c977..e4c7280e0 100644 --- a/broker/gen/model/Rugnux_live_blob.h +++ b/broker/gen/model/Rugnux_live_blob.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -100,6 +100,13 @@ public: void setNearestAtomDistanceA(double const value); bool nearestAtomDistanceAIsSet() const; void unsetNearest_atom_distance_A(); + /// + /// The anomalous difference map's peak height within 1 Angstrom of the blob's peak, in the map's sigma. Absent where there is no anomalous map (`anomalous_map`); a measure of the blob only where the data carry anomalous signal (`anomalous_signal`), noise otherwise. + /// + double getAnomalousSigma() const; + void setAnomalousSigma(double const value); + bool anomalousSigmaIsSet() const; + void unsetAnomalous_sigma(); friend void to_json(nlohmann::json& j, const Rugnux_live_blob& o); friend void from_json(const nlohmann::json& j, Rugnux_live_blob& o); @@ -120,6 +127,8 @@ protected: double m_Nearest_atom_distance_A; bool m_Nearest_atom_distance_AIsSet; + double m_Anomalous_sigma; + bool m_Anomalous_sigmaIsSet; }; diff --git a/broker/gen/model/Rugnux_live_frame_range.cpp b/broker/gen/model/Rugnux_live_frame_range.cpp index 2f767fb33..bdf2f8ecd 100644 --- a/broker/gen/model/Rugnux_live_frame_range.cpp +++ b/broker/gen/model/Rugnux_live_frame_range.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_live_frame_range.h b/broker/gen/model/Rugnux_live_frame_range.h index 4420507de..edae53d4c 100644 --- a/broker/gen/model/Rugnux_live_frame_range.h +++ b/broker/gen/model/Rugnux_live_frame_range.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_live_model.cpp b/broker/gen/model/Rugnux_live_model.cpp index e521df6b9..c9424c621 100644 --- a/broker/gen/model/Rugnux_live_model.cpp +++ b/broker/gen/model/Rugnux_live_model.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_live_model.h b/broker/gen/model/Rugnux_live_model.h index 23052ae7b..c9b18479e 100644 --- a/broker/gen/model/Rugnux_live_model.h +++ b/broker/gen/model/Rugnux_live_model.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_live_refinement.cpp b/broker/gen/model/Rugnux_live_refinement.cpp index 1f4b8e118..814cd6e55 100644 --- a/broker/gen/model/Rugnux_live_refinement.cpp +++ b/broker/gen/model/Rugnux_live_refinement.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_live_refinement.h b/broker/gen/model/Rugnux_live_refinement.h index 42e010854..5732a4048 100644 --- a/broker/gen/model/Rugnux_live_refinement.h +++ b/broker/gen/model/Rugnux_live_refinement.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_live_shell.cpp b/broker/gen/model/Rugnux_live_shell.cpp index 835153be9..abe620c20 100644 --- a/broker/gen/model/Rugnux_live_shell.cpp +++ b/broker/gen/model/Rugnux_live_shell.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_live_shell.h b/broker/gen/model/Rugnux_live_shell.h index 78a6c4af0..459762807 100644 --- a/broker/gen/model/Rugnux_live_shell.h +++ b/broker/gen/model/Rugnux_live_shell.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_live_status.cpp b/broker/gen/model/Rugnux_live_status.cpp index 0eb575857..f197a42a6 100644 --- a/broker/gen/model/Rugnux_live_status.cpp +++ b/broker/gen/model/Rugnux_live_status.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -38,6 +38,8 @@ Rugnux_live_status::Rugnux_live_status() m_Space_groupIsSet = false; m_D_min = 0.0; m_D_minIsSet = false; + m_Resolution_fit = 0.0; + m_Resolution_fitIsSet = false; m_Isa = 0.0; m_IsaIsSet = false; m_Probe = ""; @@ -149,7 +151,7 @@ bool Rugnux_live_status::validate(std::stringstream& msg, const std::string& pat } } - + if (stepProgressIsSet()) { const float& value = m_Step_progress; @@ -304,6 +306,9 @@ bool Rugnux_live_status::operator==(const Rugnux_live_status& rhs) const ((!dMinIsSet() && !rhs.dMinIsSet()) || (dMinIsSet() && rhs.dMinIsSet() && getDMin() == rhs.getDMin())) && + ((!resolutionFitIsSet() && !rhs.resolutionFitIsSet()) || (resolutionFitIsSet() && rhs.resolutionFitIsSet() && getResolutionFit() == rhs.getResolutionFit())) && + + ((!isaIsSet() && !rhs.isaIsSet()) || (isaIsSet() && rhs.isaIsSet() && getIsa() == rhs.getIsa())) && (getProbe() == rhs.getProbe()) @@ -397,6 +402,8 @@ void to_json(nlohmann::json& j, const Rugnux_live_status& o) j["space_group"] = o.m_Space_group; if(o.dMinIsSet()) j["d_min"] = o.m_D_min; + if(o.resolutionFitIsSet()) + j["resolution_fit"] = o.m_Resolution_fit; if(o.isaIsSet()) j["isa"] = o.m_Isa; j["probe"] = o.m_Probe; @@ -482,6 +489,11 @@ void from_json(const nlohmann::json& j, Rugnux_live_status& o) j.at("d_min").get_to(o.m_D_min); o.m_D_minIsSet = true; } + if(j.find("resolution_fit") != j.end()) + { + j.at("resolution_fit").get_to(o.m_Resolution_fit); + o.m_Resolution_fitIsSet = true; + } if(j.find("isa") != j.end()) { j.at("isa").get_to(o.m_Isa); @@ -738,6 +750,23 @@ void Rugnux_live_status::unsetD_min() { m_D_minIsSet = false; } +double Rugnux_live_status::getResolutionFit() const +{ + return m_Resolution_fit; +} +void Rugnux_live_status::setResolutionFit(double const value) +{ + m_Resolution_fit = value; + m_Resolution_fitIsSet = true; +} +bool Rugnux_live_status::resolutionFitIsSet() const +{ + return m_Resolution_fitIsSet; +} +void Rugnux_live_status::unsetResolution_fit() +{ + m_Resolution_fitIsSet = false; +} double Rugnux_live_status::getIsa() const { return m_Isa; diff --git a/broker/gen/model/Rugnux_live_status.h b/broker/gen/model/Rugnux_live_status.h index 4bb87eb98..6fb829ed4 100644 --- a/broker/gen/model/Rugnux_live_status.h +++ b/broker/gen/model/Rugnux_live_status.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -113,7 +113,7 @@ public: bool shellsMergeIsSet() const; void unsetShells_merge(); /// - /// Merging statistics by resolution shell of the latest merge, coarse to fine, as the shell table of `_report.txt`. Rotation: once the run is over; serial: at each provisional merge and at the end. `overall` is the same table's \"Overall\" row (whole-merge completeness, multiplicity, I/sigma, CC1/2, R_meas or R_split, CCref, and the R-free of the final model - refined where rugnux refined it, as `model.refinement.r_free`, else as placed, as `model.r_free`), present with `shells`. + /// Merging statistics by resolution shell of the latest merge, coarse to fine, as the shell table of `_report.txt`. Rotation: once the collection is scaled and merged (before the model work), again at the end; serial: at each provisional merge and at the end. `overall` is the same table's \"Overall\" row (whole-merge completeness, multiplicity, I/sigma, CC1/2, R_meas or R_split, CCref, and the R-free of the final model - refined where rugnux refined it, as `model.refinement.r_free`, else as placed, as `model.r_free`), present with `shells`. /// std::vector getShells() const; void setShells(std::vector const& value); @@ -141,21 +141,28 @@ public: bool frameRangesIsSet() const; void unsetFrame_ranges(); /// - /// Space group of the result (the summary's \"Space group\" row); absent until the run is over + /// Space group of the result (the summary's \"Space group\" row); absent until the collection is scaled and merged /// std::string getSpaceGroup() const; void setSpaceGroup(std::string const& value); bool spaceGroupIsSet() const; void unsetSpace_group(); /// - /// High-resolution limit of the merge, in Angstrom; absent until the run is over, or without a merge + /// High-resolution limit of the merge, in Angstrom; absent until the collection is scaled and merged, or without a merge /// double getDMin() const; void setDMin(double const value); bool dMinIsSet() const; void unsetD_min(); /// - /// ISa of the error model; absent until the run is over, or where it was not determined + /// Where the CC1/2 fall-off is fitted, in Angstrom: the resolution to quote. The written range (`d_min`) deliberately reaches one shell beyond it. Absent without a fit (a serial merge's `d_min` is the fit itself). + /// + double getResolutionFit() const; + void setResolutionFit(double const value); + bool resolutionFitIsSet() const; + void unsetResolution_fit(); + /// + /// ISa of the error model; absent until the collection is scaled and merged, or where it was not determined /// double getIsa() const; void setIsa(double const value); @@ -306,6 +313,8 @@ protected: bool m_Space_groupIsSet; double m_D_min; bool m_D_minIsSet; + double m_Resolution_fit; + bool m_Resolution_fitIsSet; double m_Isa; bool m_IsaIsSet; std::string m_Probe; diff --git a/broker/gen/model/Rugnux_live_step.cpp b/broker/gen/model/Rugnux_live_step.cpp index b78da5844..2277992e4 100644 --- a/broker/gen/model/Rugnux_live_step.cpp +++ b/broker/gen/model/Rugnux_live_step.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_live_step.h b/broker/gen/model/Rugnux_live_step.h index 4682b9b3e..47f05b14e 100644 --- a/broker/gen/model/Rugnux_live_step.h +++ b/broker/gen/model/Rugnux_live_step.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_live_stills.cpp b/broker/gen/model/Rugnux_live_stills.cpp index 7adf22968..0ce78b00a 100644 --- a/broker/gen/model/Rugnux_live_stills.cpp +++ b/broker/gen/model/Rugnux_live_stills.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_live_stills.h b/broker/gen/model/Rugnux_live_stills.h index 5e4eaba9e..00bafcc88 100644 --- a/broker/gen/model/Rugnux_live_stills.h +++ b/broker/gen/model/Rugnux_live_stills.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_settings.cpp b/broker/gen/model/Rugnux_settings.cpp index 9e71fb5df..2bb2ec675 100644 --- a/broker/gen/model/Rugnux_settings.cpp +++ b/broker/gen/model/Rugnux_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -31,6 +31,10 @@ Rugnux_settings::Rugnux_settings() m_Refine_solventIsSet = false; m_Force_still = false; m_Force_stillIsSet = false; + m_Stills_downsample = 1L; + m_Stills_downsampleIsSet = false; + m_Stills_prepass_images = 1000L; + m_Stills_prepass_imagesIsSet = false; } @@ -81,7 +85,40 @@ bool Rugnux_settings::validate(std::stringstream& msg, const std::string& pathPr } } - + + if (stillsDownsampleIsSet()) + { + const int64_t& value = m_Stills_downsample; + const std::string currentValuePath = _pathPrefix + ".stillsDownsample"; + + + if (value < 1ll) + { + success = false; + msg << currentValuePath << ": must be greater than or equal to 1;"; + } + + } + + if (stillsPrepassImagesIsSet()) + { + const int64_t& value = m_Stills_prepass_images; + const std::string currentValuePath = _pathPrefix + ".stillsPrepassImages"; + + + if (value < 100ll) + { + success = false; + msg << currentValuePath << ": must be greater than or equal to 100;"; + } + if (value > 20000ll) + { + success = false; + msg << currentValuePath << ": must be less than or equal to 20000;"; + } + + } + return success; } @@ -103,7 +140,13 @@ bool Rugnux_settings::operator==(const Rugnux_settings& rhs) const ((!refineSolventIsSet() && !rhs.refineSolventIsSet()) || (refineSolventIsSet() && rhs.refineSolventIsSet() && isRefineSolvent() == rhs.isRefineSolvent())) && - ((!forceStillIsSet() && !rhs.forceStillIsSet()) || (forceStillIsSet() && rhs.forceStillIsSet() && isForceStill() == rhs.isForceStill())) + ((!forceStillIsSet() && !rhs.forceStillIsSet()) || (forceStillIsSet() && rhs.forceStillIsSet() && isForceStill() == rhs.isForceStill())) && + + + ((!stillsDownsampleIsSet() && !rhs.stillsDownsampleIsSet()) || (stillsDownsampleIsSet() && rhs.stillsDownsampleIsSet() && getStillsDownsample() == rhs.getStillsDownsample())) && + + + ((!stillsPrepassImagesIsSet() && !rhs.stillsPrepassImagesIsSet()) || (stillsPrepassImagesIsSet() && rhs.stillsPrepassImagesIsSet() && getStillsPrepassImages() == rhs.getStillsPrepassImages())) ; } @@ -126,6 +169,10 @@ void to_json(nlohmann::json& j, const Rugnux_settings& o) j["refine_solvent"] = o.m_Refine_solvent; if(o.forceStillIsSet()) j["force_still"] = o.m_Force_still; + if(o.stillsDownsampleIsSet()) + j["stills_downsample"] = o.m_Stills_downsample; + if(o.stillsPrepassImagesIsSet()) + j["stills_prepass_images"] = o.m_Stills_prepass_images; } @@ -156,6 +203,16 @@ void from_json(const nlohmann::json& j, Rugnux_settings& o) j.at("force_still").get_to(o.m_Force_still); o.m_Force_stillIsSet = true; } + if(j.find("stills_downsample") != j.end()) + { + j.at("stills_downsample").get_to(o.m_Stills_downsample); + o.m_Stills_downsampleIsSet = true; + } + if(j.find("stills_prepass_images") != j.end()) + { + j.at("stills_prepass_images").get_to(o.m_Stills_prepass_images); + o.m_Stills_prepass_imagesIsSet = true; + } } @@ -244,6 +301,40 @@ void Rugnux_settings::unsetForce_still() { m_Force_stillIsSet = false; } +int64_t Rugnux_settings::getStillsDownsample() const +{ + return m_Stills_downsample; +} +void Rugnux_settings::setStillsDownsample(int64_t const value) +{ + m_Stills_downsample = value; + m_Stills_downsampleIsSet = true; +} +bool Rugnux_settings::stillsDownsampleIsSet() const +{ + return m_Stills_downsampleIsSet; +} +void Rugnux_settings::unsetStills_downsample() +{ + m_Stills_downsampleIsSet = false; +} +int64_t Rugnux_settings::getStillsPrepassImages() const +{ + return m_Stills_prepass_images; +} +void Rugnux_settings::setStillsPrepassImages(int64_t const value) +{ + m_Stills_prepass_images = value; + m_Stills_prepass_imagesIsSet = true; +} +bool Rugnux_settings::stillsPrepassImagesIsSet() const +{ + return m_Stills_prepass_imagesIsSet; +} +void Rugnux_settings::unsetStills_prepass_images() +{ + m_Stills_prepass_imagesIsSet = false; +} } // namespace org::openapitools::server::model diff --git a/broker/gen/model/Rugnux_settings.h b/broker/gen/model/Rugnux_settings.h index d3c2cdc85..182574cdc 100644 --- a/broker/gen/model/Rugnux_settings.h +++ b/broker/gen/model/Rugnux_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -92,6 +92,20 @@ public: void setForceStill(bool const value); bool forceStillIsSet() const; void unsetForce_still(); + /// + /// Serial collections: analyse on average 1 of every this many images, to keep up with a fast stream. Each image is chosen on its own with probability 1 / stills_downsample from a hash of its number - not a stride, which would be in step with periodic patterns (pump-probe on/off, storage cells). The images the pre-pass looks at (the first `stills_prepass_images`) are all analysed. Images not chosen are written as they came, without their analysis. 1: every image. Reset to 1 by `POST /initialize`. + /// + int64_t getStillsDownsample() const; + void setStillsDownsample(int64_t const value); + bool stillsDownsampleIsSet() const; + void unsetStills_downsample(); + /// + /// Serial collections: the first images the pre-pass looks at. They are held in the image buffer, and the stream waits, while the pre-pass measures the mask, polarization and integration settings on them and, where at least 6 of them are strong indexed frames (a unit cell given), refines the beam centre, distance and cell; with fewer, the distance and cell of the dataset settings are used, at the beam centre (the stated one or the scattered background's) that indexes better. Each image waits in a slot of the image buffer of its own, and the pre-pass may take half of the slots: N images need 2N slots in the buffer. Where they do not fit, `/start` refuses a serial collection (with the image buffer size it needs). Rotation collections are not affected. Reset to 1000 by `POST /initialize`. + /// + int64_t getStillsPrepassImages() const; + void setStillsPrepassImages(int64_t const value); + bool stillsPrepassImagesIsSet() const; + void unsetStills_prepass_images(); friend void to_json(nlohmann::json& j, const Rugnux_settings& o); friend void from_json(const nlohmann::json& j, Rugnux_settings& o); @@ -106,6 +120,10 @@ protected: bool m_Refine_solventIsSet; bool m_Force_still; bool m_Force_stillIsSet; + int64_t m_Stills_downsample; + bool m_Stills_downsampleIsSet; + int64_t m_Stills_prepass_images; + bool m_Stills_prepass_imagesIsSet; }; diff --git a/broker/gen/model/Rugnux_status.cpp b/broker/gen/model/Rugnux_status.cpp index d418e0032..719d98c49 100644 --- a/broker/gen/model/Rugnux_status.cpp +++ b/broker/gen/model/Rugnux_status.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -27,6 +27,10 @@ Rugnux_status::Rugnux_status() m_Deadline_sIsSet = false; m_Refine_solvent = false; m_Force_still = false; + m_Stills_downsample = 0L; + m_Stills_downsampleIsSet = false; + m_Stills_prepass_images = 0L; + m_Stills_prepass_imagesIsSet = false; m_Model_loaded = false; m_Model_size_bytes = 0L; m_Model_size_bytesIsSet = false; @@ -52,7 +56,7 @@ bool Rugnux_status::validate(std::stringstream& msg, const std::string& pathPref bool success = true; const std::string _pathPrefix = pathPrefix.empty() ? "Rugnux_status" : pathPrefix; - + return success; } @@ -76,6 +80,12 @@ bool Rugnux_status::operator==(const Rugnux_status& rhs) const (isForceStill() == rhs.isForceStill()) && + + ((!stillsDownsampleIsSet() && !rhs.stillsDownsampleIsSet()) || (stillsDownsampleIsSet() && rhs.stillsDownsampleIsSet() && getStillsDownsample() == rhs.getStillsDownsample())) && + + + ((!stillsPrepassImagesIsSet() && !rhs.stillsPrepassImagesIsSet()) || (stillsPrepassImagesIsSet() && rhs.stillsPrepassImagesIsSet() && getStillsPrepassImages() == rhs.getStillsPrepassImages())) && + (isModelLoaded() == rhs.isModelLoaded()) && @@ -99,6 +109,10 @@ void to_json(nlohmann::json& j, const Rugnux_status& o) j["deadline_s"] = o.m_Deadline_s; j["refine_solvent"] = o.m_Refine_solvent; j["force_still"] = o.m_Force_still; + if(o.stillsDownsampleIsSet()) + j["stills_downsample"] = o.m_Stills_downsample; + if(o.stillsPrepassImagesIsSet()) + j["stills_prepass_images"] = o.m_Stills_prepass_images; j["model_loaded"] = o.m_Model_loaded; if(o.modelSizeBytesIsSet()) j["model_size_bytes"] = o.m_Model_size_bytes; @@ -116,6 +130,16 @@ void from_json(const nlohmann::json& j, Rugnux_status& o) } j.at("refine_solvent").get_to(o.m_Refine_solvent); j.at("force_still").get_to(o.m_Force_still); + if(j.find("stills_downsample") != j.end()) + { + j.at("stills_downsample").get_to(o.m_Stills_downsample); + o.m_Stills_downsampleIsSet = true; + } + if(j.find("stills_prepass_images") != j.end()) + { + j.at("stills_prepass_images").get_to(o.m_Stills_prepass_images); + o.m_Stills_prepass_imagesIsSet = true; + } j.at("model_loaded").get_to(o.m_Model_loaded); if(j.find("model_size_bytes") != j.end()) { @@ -174,6 +198,40 @@ void Rugnux_status::setForceStill(bool const value) { m_Force_still = value; } +int64_t Rugnux_status::getStillsDownsample() const +{ + return m_Stills_downsample; +} +void Rugnux_status::setStillsDownsample(int64_t const value) +{ + m_Stills_downsample = value; + m_Stills_downsampleIsSet = true; +} +bool Rugnux_status::stillsDownsampleIsSet() const +{ + return m_Stills_downsampleIsSet; +} +void Rugnux_status::unsetStills_downsample() +{ + m_Stills_downsampleIsSet = false; +} +int64_t Rugnux_status::getStillsPrepassImages() const +{ + return m_Stills_prepass_images; +} +void Rugnux_status::setStillsPrepassImages(int64_t const value) +{ + m_Stills_prepass_images = value; + m_Stills_prepass_imagesIsSet = true; +} +bool Rugnux_status::stillsPrepassImagesIsSet() const +{ + return m_Stills_prepass_imagesIsSet; +} +void Rugnux_status::unsetStills_prepass_images() +{ + m_Stills_prepass_imagesIsSet = false; +} bool Rugnux_status::isModelLoaded() const { return m_Model_loaded; diff --git a/broker/gen/model/Rugnux_status.h b/broker/gen/model/Rugnux_status.h index d32d0d459..528ed0b1e 100644 --- a/broker/gen/model/Rugnux_status.h +++ b/broker/gen/model/Rugnux_status.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -85,6 +85,20 @@ public: bool isForceStill() const; void setForceStill(bool const value); /// + /// Serial collections, 1 of every this many images analysed on average + /// + int64_t getStillsDownsample() const; + void setStillsDownsample(int64_t const value); + bool stillsDownsampleIsSet() const; + void unsetStills_downsample(); + /// + /// Serial collections, the first images the pre-pass looks at + /// + int64_t getStillsPrepassImages() const; + void setStillsPrepassImages(int64_t const value); + bool stillsPrepassImagesIsSet() const; + void unsetStills_prepass_images(); + /// /// A model was uploaded with `PUT /config/rugnux/model` /// bool isModelLoaded() const; @@ -110,6 +124,10 @@ protected: bool m_Force_still; + int64_t m_Stills_downsample; + bool m_Stills_downsampleIsSet; + int64_t m_Stills_prepass_images; + bool m_Stills_prepass_imagesIsSet; bool m_Model_loaded; int64_t m_Model_size_bytes; diff --git a/broker/gen/model/Rugnux_summary_row.cpp b/broker/gen/model/Rugnux_summary_row.cpp index 49894dbdb..f0976f69e 100644 --- a/broker/gen/model/Rugnux_summary_row.cpp +++ b/broker/gen/model/Rugnux_summary_row.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_summary_row.h b/broker/gen/model/Rugnux_summary_row.h index 15867dad6..d10a9d32f 100644 --- a/broker/gen/model/Rugnux_summary_row.h +++ b/broker/gen/model/Rugnux_summary_row.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_triage_item.cpp b/broker/gen/model/Rugnux_triage_item.cpp index f2af0945f..717f46a62 100644 --- a/broker/gen/model/Rugnux_triage_item.cpp +++ b/broker/gen/model/Rugnux_triage_item.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Rugnux_triage_item.h b/broker/gen/model/Rugnux_triage_item.h index 9bed5573c..482f1e473 100644 --- a/broker/gen/model/Rugnux_triage_item.h +++ b/broker/gen/model/Rugnux_triage_item.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Scan_result.cpp b/broker/gen/model/Scan_result.cpp index a44acf378..491a906e0 100644 --- a/broker/gen/model/Scan_result.cpp +++ b/broker/gen/model/Scan_result.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Scan_result.h b/broker/gen/model/Scan_result.h index e5d81a126..34f865b86 100644 --- a/broker/gen/model/Scan_result.h +++ b/broker/gen/model/Scan_result.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Scan_result_images_inner.cpp b/broker/gen/model/Scan_result_images_inner.cpp index e2941db20..6431028f1 100644 --- a/broker/gen/model/Scan_result_images_inner.cpp +++ b/broker/gen/model/Scan_result_images_inner.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Scan_result_images_inner.h b/broker/gen/model/Scan_result_images_inner.h index d8bcb6efa..dda23b897 100644 --- a/broker/gen/model/Scan_result_images_inner.h +++ b/broker/gen/model/Scan_result_images_inner.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Spot_finding_settings.cpp b/broker/gen/model/Spot_finding_settings.cpp index 8062a6a26..b3eb1aece 100644 --- a/broker/gen/model/Spot_finding_settings.cpp +++ b/broker/gen/model/Spot_finding_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Spot_finding_settings.h b/broker/gen/model/Spot_finding_settings.h index 564854041..7c0478884 100644 --- a/broker/gen/model/Spot_finding_settings.h +++ b/broker/gen/model/Spot_finding_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Standard_detector_geometry.cpp b/broker/gen/model/Standard_detector_geometry.cpp index 853772b3a..9084c7902 100644 --- a/broker/gen/model/Standard_detector_geometry.cpp +++ b/broker/gen/model/Standard_detector_geometry.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Standard_detector_geometry.h b/broker/gen/model/Standard_detector_geometry.h index 7daf7c07e..3e6a1c32f 100644 --- a/broker/gen/model/Standard_detector_geometry.h +++ b/broker/gen/model/Standard_detector_geometry.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Tcp_settings.cpp b/broker/gen/model/Tcp_settings.cpp index da5ad49f9..a7d1de3b3 100644 --- a/broker/gen/model/Tcp_settings.cpp +++ b/broker/gen/model/Tcp_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Tcp_settings.h b/broker/gen/model/Tcp_settings.h index 86f877ab0..01399b422 100644 --- a/broker/gen/model/Tcp_settings.h +++ b/broker/gen/model/Tcp_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Unit_cell.cpp b/broker/gen/model/Unit_cell.cpp index e28ab161b..85c37629f 100644 --- a/broker/gen/model/Unit_cell.cpp +++ b/broker/gen/model/Unit_cell.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Unit_cell.h b/broker/gen/model/Unit_cell.h index 68d6950c3..72169885b 100644 --- a/broker/gen/model/Unit_cell.h +++ b/broker/gen/model/Unit_cell.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Zeromq_metadata_settings.cpp b/broker/gen/model/Zeromq_metadata_settings.cpp index e32317724..517c37882 100644 --- a/broker/gen/model/Zeromq_metadata_settings.cpp +++ b/broker/gen/model/Zeromq_metadata_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Zeromq_metadata_settings.h b/broker/gen/model/Zeromq_metadata_settings.h index 147209f4c..07425a88d 100644 --- a/broker/gen/model/Zeromq_metadata_settings.h +++ b/broker/gen/model/Zeromq_metadata_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Zeromq_preview_settings.cpp b/broker/gen/model/Zeromq_preview_settings.cpp index 87673b362..bbbd806a0 100644 --- a/broker/gen/model/Zeromq_preview_settings.cpp +++ b/broker/gen/model/Zeromq_preview_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Zeromq_preview_settings.h b/broker/gen/model/Zeromq_preview_settings.h index 8764c63d1..dd866368d 100644 --- a/broker/gen/model/Zeromq_preview_settings.h +++ b/broker/gen/model/Zeromq_preview_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Zeromq_settings.cpp b/broker/gen/model/Zeromq_settings.cpp index ac8616564..cbd4fb670 100644 --- a/broker/gen/model/Zeromq_settings.cpp +++ b/broker/gen/model/Zeromq_settings.cpp @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/gen/model/Zeromq_settings.h b/broker/gen/model/Zeromq_settings.h index 83e4f52e3..9de75ee4b 100644 --- a/broker/gen/model/Zeromq_settings.h +++ b/broker/gen/model/Zeromq_settings.h @@ -2,7 +2,7 @@ * Jungfraujoch * API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates. # License Clarification While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing. This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL. This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. * -* The version of the OpenAPI document: 1.0.0-rc.186 +* The version of the OpenAPI document: 1.0.0-rc.187 * Contact: filip.leonarski@psi.ch * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/broker/jfjoch_api.yaml b/broker/jfjoch_api.yaml index a7464ef6e..45ee70403 100644 --- a/broker/jfjoch_api.yaml +++ b/broker/jfjoch_api.yaml @@ -22,7 +22,7 @@ info: requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. - version: 1.0.0-rc.186 + version: 1.0.0-rc.187 contact: name: Filip Leonarski (Paul Scherrer Institute) email: filip.leonarski@psi.ch @@ -130,6 +130,7 @@ components: - image_scale_cc - compression_ratio - ice_ring_score + - image_merged roi: in: query name: roi @@ -409,7 +410,10 @@ components: description: | Image time. If not provided (or zero value) the frame time is assumed as default. - For JUNGFRAU image time must be multiple of frame time and max value is 256 * frame_time. + For JUNGFRAU image time must be multiple of frame time. Up to 256 frames are summed on the FPGA. + Above that the FPGA sums the largest number of frames up to 256 that divides the frames of an image + (250 of 1000) and the host adds up the rest; the more the host sums, the slower (a prime number of + frames is summed on the host entirely). In XFEL mode: summation happens for frames collected with multiple triggers. Ignored for storage cells and if raw data are saved. beam_x_pxl: @@ -473,7 +477,7 @@ components: "bszstd_rle", "bszstd_rlehuf", "none" - ] + ] default: "bslz4" description: | Compression type for the images transferred over ZeroMQ and saved to HDF5 file. @@ -667,8 +671,9 @@ components: type: integer minimum: 10 maximum: 2000 - default: 250 - description: Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected + description: | + Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected. + Left out, the broker's per-image indexing keeps 250 and rugnux live stills 1000. detect_ice_rings: type: boolean description: | @@ -2841,6 +2846,32 @@ components: description: | Process DECTRIS rotation collections as stills, on the serial path (pre-pass, GPU analysis, stills merge), as `rugnux --force-still` does. The written file keeps its goniometer. Reset to false by `POST /initialize`. + stills_downsample: + type: integer + format: int64 + minimum: 1 + default: 1 + description: | + Serial collections: analyse on average 1 of every this many images, to keep up with a fast stream. Each + image is chosen on its own with probability 1 / stills_downsample from a hash of its number - not a stride, + which would be in step with periodic patterns (pump-probe on/off, storage cells). The images the pre-pass + looks at (the first `stills_prepass_images`) are all analysed. Images not chosen are written as they came, + without their analysis. 1: every image. Reset to 1 by `POST /initialize`. + stills_prepass_images: + type: integer + format: int64 + minimum: 100 + maximum: 20000 + default: 1000 + description: | + Serial collections: the first images the pre-pass looks at. They are held in the image buffer, and the + stream waits, while the pre-pass measures the mask, polarization and integration settings on them and, + where at least 6 of them are strong indexed frames (a unit cell given), refines the beam centre, + distance and cell; with fewer, the distance and cell of the dataset settings are used, at the beam centre + (the stated one or the scattered background's) that indexes better. Each image waits + in a slot of the image buffer of its own, and the pre-pass may take half of the slots: N images need 2N + slots in the buffer. Where they do not fit, `/start` refuses a serial collection (with the image + buffer size it needs). Rotation collections are not affected. Reset to 1000 by `POST /initialize`. rugnux_status: type: object required: @@ -2867,6 +2898,14 @@ components: force_still: type: boolean description: DECTRIS rotation collections are processed as stills + stills_downsample: + type: integer + format: int64 + description: Serial collections, 1 of every this many images analysed on average + stills_prepass_images: + type: integer + format: int64 + description: Serial collections, the first images the pre-pass looks at model_loaded: type: boolean description: A model was uploaded with `PUT /config/rugnux/model` @@ -3130,6 +3169,13 @@ components: type: number format: double description: Absent where no atom is within 12 Angstrom + anomalous_sigma: + type: number + format: double + description: | + The anomalous difference map's peak height within 1 Angstrom of the blob's peak, in the map's sigma. + Absent where there is no anomalous map (`anomalous_map`); a measure of the blob only where the data + carry anomalous signal (`anomalous_signal`), noise otherwise. rugnux_live_stills: type: object description: | @@ -3344,7 +3390,8 @@ components: type: array description: | Merging statistics by resolution shell of the latest merge, coarse to fine, as the shell table of - `_report.txt`. Rotation: once the run is over; serial: at each provisional merge and at the end. + `_report.txt`. Rotation: once the collection is scaled and merged (before the model work), again at + the end; serial: at each provisional merge and at the end. `overall` is the same table's "Overall" row (whole-merge completeness, multiplicity, I/sigma, CC1/2, R_meas or R_split, CCref, and the R-free of the final model - refined where rugnux refined it, as `model.refinement.r_free`, else as placed, as `model.r_free`), present with `shells`. @@ -3371,15 +3418,21 @@ components: $ref: '#/components/schemas/rugnux_live_frame_range' space_group: type: string - description: Space group of the result (the summary's "Space group" row); absent until the run is over + description: Space group of the result (the summary's "Space group" row); absent until the collection is scaled and merged d_min: type: number format: double - description: High-resolution limit of the merge, in Angstrom; absent until the run is over, or without a merge + description: High-resolution limit of the merge, in Angstrom; absent until the collection is scaled and merged, or without a merge + resolution_fit: + type: number + format: double + description: | + Where the CC1/2 fall-off is fitted, in Angstrom: the resolution to quote. The written range (`d_min`) + deliberately reaches one shell beyond it. Absent without a fit (a serial merge's `d_min` is the fit itself). isa: type: number format: double - description: ISa of the error model; absent until the run is over, or where it was not determined + description: ISa of the error model; absent until the collection is scaled and merged, or where it was not determined probe: type: string description: Answer of the early lattice probe on the first 60 degrees; empty until it answers, and the run's own lattice once the run has indexed diff --git a/broker/redoc-static.html b/broker/redoc-static.html index 016f2833b..778113661 100644 --- a/broker/redoc-static.html +++ b/broker/redoc-static.html @@ -1,5 +1,5 @@ - + @@ -12,1156 +12,540 @@ margin: 0; } - - -

Jungfraujoch (1.0.0-rc.186)

Download OpenAPI specification:

Filip Leonarski (Paul Scherrer Institute): filip.leonarski@psi.ch License: GPL-3.0

API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). -Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. -Jungfraujoch uses FPGA boards to acquire data at high data rates.

-

License Clarification

While this API definition is licensed under GPL-3.0, the GPL copyleft provisions do not apply -when this file is used solely to generate OpenAPI clients or when implementing applications that -interact with the API. Generated client code and applications using this API definition are not -subject to the GPL license requirements and may be distributed under terms of your choosing.

-

This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and -the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that -user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not -derivative works of the kernel and are not subject to the terms of the GPL.

-

This exception is intended to allow wider use of this API specification without imposing GPL -requirements on applications that merely interact with the API, regardless of whether they -communicate through network calls or other mechanisms.

-

Initialize detector and data acquisition

Should be used in two cases:

-
    -
  • Detector is in Inactive state
  • -
  • Detector is in Error state -X-ray shutter must be closed. -This operation will reconfigure network interface of the detector. -During operation of the detector it is recommended to use the POST /pedestal operation instead. -If storage cells are used, the execution time might be few minutes. -It also clears the image buffer, the previous collection's plots and live rugnux status, disables live rugnux analysis and removes the rugnux model. -It drops the previous dataset's bearer tokens and resets its settings, so nothing of that dataset stays readable.
  • -
-

This is async function - one needs to use POST /wait_till_done to ensure operation is done.

-

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Collect dark current for the detector

Updates calibration of the JUNGFRAU detector. Must be in Idle state.

-

X-ray shutter must be closed. Recommended to run once per hour for long integration times (> 100 us).

-

This is async function - one needs to use POST /wait_till_done to ensure operation is done.

-

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Start detector

Start data acquisition. -Detector must be in Idle state. -Default behavior is for the call to block until detector is ready to accept soft/TTL triggers. -However, this behavior can be changed by settings async_start to true in the request body, -in which case the call will return immediately and one needs to use /wait_until_running to ensure detector is ready to run. -Optional tokens protect the dataset: while set, its statistics, buffered images and plots -require Authorization: Bearer <token>.

-
Request Body schema: application/json
images_per_trigger
integer <int64> >= 1
Default: 1

For standard synchrotron data collection - this is number of images collected per one TTL trigger -For XFEL (pulsed source) - this number is ignored and set to 1 -For storage cell mode - this number is ignored and set to number of storage cells

-
ntrigger
integer <int64> >= 1
Default: 1

Number of TTL trigger that the detector is expected to receive during data collection

-
image_time_us
integer <int64> >= 0

Image time. -If not provided (or zero value) the frame time is assumed as default. -For JUNGFRAU image time must be multiple of frame time and max value is 256 * frame_time.
In XFEL mode: summation happens for frames collected with multiple triggers. -Ignored for storage cells and if raw data are saved.

-
beam_x_pxl
required
number <float>

/entry/detector/beam_center_x in NXmx -Beam center in X direction [pixels]

-
beam_y_pxl
required
number <float>

/entry/detector/beam_center_y in NXmx -Beam center in X direction [pixels]

-
detector_distance_mm
required
number <float> >= 0

/entry/detector/distance in NXmx Detector distance [mm]

-
incident_energy_keV
required
number <float> [ 0.001 .. 500 ]

Used to calculate /entry/beam/incident_wavelength in NXmx -Incident particle (photon, electron) energy in keV

-
file_prefix
string
Default: ""

Prefix for filenames. If left empty, no file will be saved.

-
images_per_file
integer <int64> >= 1

Number of images in a single HDF5 data file, taken literally when given. -If omitted, it is chosen from the acquisition: a rotation sweep of at most 20000 images -goes into a single data file, so the dataset stays readable by programs that follow only -the first data file of a legacy master; a grid scan is split on a whole number of fast-axis -rows; anything else (stills, serial) uses 1000.

-
space_group_number
integer <int64> [ 1 .. 230 ]

Number of space group for the crystal. Currently used solely as metadata, not relevant for image processing done in Jungfraujoch.

-
sample_name
string
Default: ""

/entry/sample/name in NXmx -Sample name

-
compression
string
Default: "bslz4"
Enum: "bslz4" "bszstd" "bszstd_rle" "bszstd_rlehuf" "none"

Compression type for the images transferred over ZeroMQ and saved to HDF5 file.

-
total_flux
number <float> >= 0

/entry/beam/total_flux in NXmx -Flux incident on beam plane in photons per second. In other words this is the flux integrated over area. [photons/s]

-
transmission
number <float> [ 0 .. 1 ]

/entry/instrument/attenuator/attenuator_transmission -Transmission of attenuator (filter) [no units]

-
beam_size_x_um
number <float> >= 0

First element of /entry/instrument/beam/incident_beam_size in NXmx -Horizontal size of the X-ray beam where it meets the sample - the FWHM of a focused beam, -the full width of a slit-defined one. [um]

-
beam_size_y_um
number <float> >= 0

Second element of /entry/instrument/beam/incident_beam_size in NXmx -Vertical size of the X-ray beam where it meets the sample. [um]

-
object (rotation_axis)

Definition of a crystal rotation axis

-
object (grid_scan)

Definition of a grid scan. Combine it with a goniometer axis to state the angle the spindle -stood at: send goniometer with step 0 and the start angle of the grid scan, and that -angle is written per image into the NXmx sample transformation chain. Without one the -spindle is recorded at 0, which says that nobody stated an angle rather than that the -spindle stood at 0.

-
header_appendix
any

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 "hdf5" object, jfjoch_writer will write them in /entry/user of the HDF5 file. -This applies solely to string and number (double floating-point). No arrays/sub-objects is allowed. -For example {"hdf5": {"val1":1, "val2":"xyz"}}, will write /entry/user/val1 and /entry/user/val2.

-
image_appendix
any

Image appendix, added as user_data to image ZeroMQ message (can be any valid JSON) -Not saved in HDF5 file

-
data_reduction_factor_serialmx
number <float> [ 0 .. 1 ]
Default: 1

Rate at which non-indexed images are accepted to be forwarded to writer. -Value of 1.0 (default) means that all images are written. -Values below zero mean that non-indexed images will be accepted with a given probability.

-
pixel_value_low_threshold
integer <int64> >= 0

Set all counts lower than the value to zero. -When the value is set, negative numbers other than error pixel value are always set to zero. -Setting to zero is equivalent to turning the option off.

-
run_number
integer <int64> >= 0

Number of run within an experimental session. -Transferred over CBOR stream as "series ID", though not saved in HDF5 file. -It is highly recommended to keep this number unique for each data collection during experimental series. -If not provided, the number will be automatically incremented.

-
run_name
string

Unique ID of run. -Transferred over CBOR stream as "unique series ID", though not saved in HDF5 file. -It is highly recommended to keep this name unique for each data collection during experimental series. -If not provided, the name will be automatically generated as number + colon + file_prefix.

-
experiment_group
string

Name of group owning the data (e.g. p-group or proposal number). -Transferred over CBOR stream, though not saved in HDF5 file.

-
poisson_compression
integer <int64> [ 0 .. 16 ]

Enable lossy compression of pixel values that preserves Poisson statistics. -Requires to provide a numerical factor SQ. -Pixel value P will be transformed to round(sqrt(P) * SQ), with rounding to the closest integer. -Compression is turned off if the value is missing or it is set to zero.

-
write_nxmx_hdf5_master
boolean
Default: true

Write NXmx formatted HDF5 master file. Recommended to use for macromolecular crystallography experiments -and to turn off for other experiments.

-
save_calibration
boolean

Forward image calibration (at the moment pedestal and pedestal RMS for JUNGFRAU) using the ZeroMQ stream to writer. -If parameter is not provided calibration will be saved only if more than 4 images are recorded.

-
polarization_factor
number <float> [ -1 .. 1 ]

Polarization factor for integration; 1.0 is horizontal polarization; -1.0 is vertical polarization

-
ring_current_mA
number <float> >= 0

Ring current at the beginning of the data collection

-
sample_temperature_K
number <float> >= 0

Sample temperature in Kelvin

-
poni_rot1_rad
number <float> [ -6.28318530718 .. 6.28318530718 ]
Default: 0

PONI angle rot1 (see PyFAI documentation for details) in radians

-
poni_rot2_rad
number <float> [ -6.28318530718 .. 6.28318530718 ]
Default: 0

PONI angle rot2 (see PyFAI documentation for details) in radians

-
poni_rot3_rad
number <float> [ -6.28318530718 .. 6.28318530718 ]
Default: 0

PONI angle rot3 (see PyFAI documentation for details) in radians

-
object (unit_cell)

Unit cell parameters. Necessary to run indexing. Units of angstrom and degree

-
spot_finding
boolean
Default: true

Enable spot finding and save spots

-
object

Geometry of Smargon goniometer at SLS 2.0 / MX beamlines. -Assuming that Smargon is used as static positioner and not moving during the scan, allowing to reconstruct geometry.

-
max_spot_count
integer [ 10 .. 2000 ]
Default: 250

Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected

-
detect_ice_rings
boolean

Flag spots as ice rings and reduce their effect on indexing. Left out, the broker's own -spot finding treats no spot as an ice ring, rugnux live decides as a bare rugnux would (on -for a rotation sweep, off for stills), and the master file carries no detect_ice_rings.

-
async_start
boolean
Default: false

When set to true, /start will not wait for detector and Jungfraujoch to be ready for the measurement.

-
Array of objects (detector_module_placement)

Where the detector's modules lie for this dataset, as rugnux measures them: rugnux writes -<prefix>_module_placement.json, which holds exactly this field, to be merged into the dataset settings. -Each entry names its module by its readout pixel 0 and readout axes in the stored image (x0, y0, -fast_axis, slow_axis, after mirror_y; see detector_module_placement), in any order; every -module must be named once, and only modules of the detector, else /start fails with 400. The image -is assembled as configured (custom_geometry); the placement goes into the start message and the -NXmx module_NN groups, and the analysis takes it. Omitted or empty: -modules as assembled.

-
tokens
Array of strings[ items non-empty ]

Bearer tokens that protect this dataset: any number, all equivalent (e.g. a beamline -secret and a dataset-specific user secret). While set, the endpoints marked with the -bearerAuth security scheme require Authorization: Bearer <token> and answer 401 otherwise. -Every accepted /start replaces the previous dataset's tokens; omitted or empty means no -protection. Never returned by any endpoint.

-
object

Responses

Request samples

Content type
application/json
{
  • "images_per_trigger": 1,
  • "ntrigger": 1,
  • "image_time_us": 0,
  • "beam_x_pxl": 0.1,
  • "beam_y_pxl": 0.1,
  • "detector_distance_mm": 0.1,
  • "incident_energy_keV": 0.001,
  • "file_prefix": "",
  • "images_per_file": 1,
  • "space_group_number": 1,
  • "sample_name": "",
  • "compression": "bslz4",
  • "total_flux": 0.1,
  • "transmission": 1,
  • "beam_size_x_um": 0.1,
  • "beam_size_y_um": 0.1,
  • "goniometer": {
    },
  • "grid_scan": {
    },
  • "header_appendix": null,
  • "image_appendix": null,
  • "data_reduction_factor_serialmx": 1,
  • "pixel_value_low_threshold": 0,
  • "run_number": 0,
  • "run_name": "string",
  • "experiment_group": "string",
  • "poisson_compression": 16,
  • "write_nxmx_hdf5_master": true,
  • "save_calibration": true,
  • "polarization_factor": -1,
  • "ring_current_mA": 0.1,
  • "sample_temperature_K": 0.1,
  • "poni_rot1_rad": 0,
  • "poni_rot2_rad": 0,
  • "poni_rot3_rad": 0,
  • "unit_cell": {
    },
  • "spot_finding": true,
  • "smargon": {
    },
  • "max_spot_count": 250,
  • "detect_ice_rings": true,
  • "async_start": false,
  • "module_placement": [
    ],
  • "tokens": [
    ],
  • "xray_fluorescence_spectrum": {
    }
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Wait for acquisition running

Block execution of external script till detector and Jungfraujoch are ready to collect data. -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.

-
query Parameters
timeout
integer [ 0 .. 3600 ]
Default: 60

Timeout in seconds (0 == immediate response)

-

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Wait for acquisition done

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.

-
query Parameters
timeout
integer [ 0 .. 3600 ]
Default: 60

Timeout in seconds (0 == immediate response)

-

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Send soft trigger to the detector

Generate soft trigger

-

Responses

Cancel running data collection

Command will inform FPGA network card to stop pedestal or data collection at the current stage. -Any frame that is currently being processed by CPU will be finished and sent to writer. -Given the command is making sure to gracefully stop data acquisition and detector, it might take some time to switch back after command finished to Idle state.

-

With rugnux live mode (/config/rugnux) the command also cuts the rugnux analysis, during the collection -or after its last image alike: the collection ends with what the analysis has established -(see cut in /rugnux/status). After the last image the collection itself is complete and is not -marked as cancelled.

-

If data collection is not running, the command has no effect.

-

Responses

Prepare detector to turn off

Should be in Idle or Error state. -Command deactivates data acquisition and turns off detector high voltage and ASIC. -Should be used always before turning off power from the detector.

-

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Change detector configuration

Detector settings are ones that have effect on calibration, i.e., pedestal has to be collected again after changing these settings. -This can only be done when detector is Idle, Error or Inactive states. -If detector is in Idle state , pedestal procedure will be executed automatically - there must be no X-rays on the detector during the operation. -If detector is in Inactive or Error states, new settings will be saved, but no calibration will be executed.

-
Request Body schema: application/json
frame_time_us
required
integer <int64> >= 1

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

-
count_time_us
integer <int64>

Integration time of the detector. -If not provided count time will be set to maximum value for a given frame time.

-
internal_frame_generator
boolean
Default: false

Use internal frame generator in FPGA instead of getting data from a real detector

-
internal_frame_generator_images
integer <int64> [ 1 .. 64 ]
Default: 1

Number of images stored in the internal frame generator.

-
detector_trigger_delay_ns
integer <int64> >= 0
Default: 0

Delay between TTL trigger and acquisition start [ns]

-
timing
string (detector_timing)
Default: "trigger"
Enum: "auto" "trigger" "burst" "gated"
eiger_threshold_keV
number <float> [ 1 .. 100 ]

Threshold for the PSI EIGER detector and all DECTRIS detectors. -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.

-
eiger_bit_depth
integer <int64>
Enum: 8 16 32

Bit depth of PSI EIGER read-out. This is
If value is not provided, depth will be determined based on the image time:

-
    -
  • Exposure time < 500 microseconds depth of 8 bit will be used,
  • -
  • 500 <= exposure time < 2622 microseconds depth of 16 bit will be used
  • -
  • Exposure time >= 2622 microseconds depth of 32 bit will be used.
  • -
-
jungfrau_pedestal_g0_frames
integer <int64> >= 0
Default: 2000
jungfrau_pedestal_g1_frames
integer <int64> >= 0
Default: 300
jungfrau_pedestal_g2_frames
integer <int64> >= 0
Default: 300
jungfrau_pedestal_min_image_count
integer <int64> >= 32
Default: 128

Minimum number of collected images for pedestal to consider it viable

-
jungfrau_storage_cell_count
integer <int64> [ 1 .. 16 ]
Default: 1
jungfrau_storage_cell_delay_ns
integer <int64> >= 2100
Default: 5000

Delay between two storage cells [ns]

-
jungfrau_fixed_gain_g1
boolean
Default: false

Fix gain to G1 (can be useful for storage cells)

-
jungfrau_use_gain_hg0
boolean
Default: false

Use high G0 (for low energy applications)

-

Responses

Request samples

Content type
application/json
{
  • "frame_time_us": 1,
  • "count_time_us": 0,
  • "internal_frame_generator": false,
  • "internal_frame_generator_images": 1,
  • "detector_trigger_delay_ns": 0,
  • "timing": "auto",
  • "eiger_threshold_keV": 1,
  • "eiger_bit_depth": 8,
  • "jungfrau_pedestal_g0_frames": 2000,
  • "jungfrau_pedestal_g1_frames": 300,
  • "jungfrau_pedestal_g2_frames": 300,
  • "jungfrau_pedestal_min_image_count": 128,
  • "jungfrau_storage_cell_count": 1,
  • "jungfrau_storage_cell_delay_ns": 5000,
  • "jungfrau_fixed_gain_g1": false,
  • "jungfrau_use_gain_hg0": false
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get detector configuration

Can be done anytime

-

Responses

Response samples

Content type
application/json
{
  • "frame_time_us": 1,
  • "count_time_us": 0,
  • "internal_frame_generator": false,
  • "internal_frame_generator_images": 1,
  • "detector_trigger_delay_ns": 0,
  • "timing": "auto",
  • "eiger_threshold_keV": 1,
  • "eiger_bit_depth": 8,
  • "jungfrau_pedestal_g0_frames": 2000,
  • "jungfrau_pedestal_g1_frames": 300,
  • "jungfrau_pedestal_g2_frames": 300,
  • "jungfrau_pedestal_min_image_count": 128,
  • "jungfrau_storage_cell_count": 1,
  • "jungfrau_storage_cell_delay_ns": 5000,
  • "jungfrau_fixed_gain_g1": false,
  • "jungfrau_use_gain_hg0": false
}

Change indexing algorithm settings

This can only be done when detector is Idle, Error or Inactive states.

-
Request Body schema: application/json
algorithm
required
string (indexing_algorithm)
Default: "FFBIDX"
Enum: "FFBIDX" "FFT" "FFTW" "Auto" "None"

Selection of an indexing algorithm used by Jungfraujoch

-
fft_max_unit_cell_A
required
number <float> [ 50 .. 500 ]
Default: 250

Largest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT

-
fft_min_unit_cell_A
required
number <float> [ 5 .. 40 ]
Default: 10

Smallest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT

-
fft_high_resolution_A
required
number <float> [ 0.5 .. 6 ]
Default: 2

Sets how finely the FFT samples each search direction: it fixes the extent of the projection -histogram, and with it the transform size, so it affects execution time and memory of FFT. -It does NOT filter spots - every spot is projected whatever its resolution, so raising it -does not make the transform see a coarser subset of the data. -There is also correlation between smallest unit cell and this value, which need to be checked for very small systems.

-
fft_num_vectors
required
integer <int64> >= 128
Default: 16384

Number of search directions for the FFT algorithm; parameter value affects execution time of FFT.

-
tolerance
required
number <float> [ 0 .. 0.5 ]

Acceptance tolerance for spots after the indexing run - the larger the number, the more spots will be accepted

-
thread_count
required
integer <int64> [ 1 .. 64 ]

Thread count for indexing algorithm

-
geom_refinement_algorithm
required
string (geom_refinement_algorithm)
Enum: "BeamCenter" "OrientationOnly" "Flex" "None"

Selection of an post-indexing least-square diffraction geometry refinement algorithm used by Jungfraujoch. -BeamCenter - This option is refining both beam center and lattice (restricted to a chosen/detected Bravais lattice). -OrientationOnly - This option is refining only orientation of the lattice. -Flex - Tries all per-image refinements and keeps whichever indexes the most spots, letting the pipeline decide (the rugnux flex mode).

-
unit_cell_dist_tolerance
required
number <float> [ 0.0001 .. 0.2001 ]
Default: 0.05

Relative distance tolerance for unit cell vs. reference; Lattices outside given tolerance will be ignored

-
viable_cell_min_spots
required
integer <int64> >= 5
Default: 10

Minimum number of indexed spots required for a cell to be considered viable

-
index_ice_rings
required
boolean
Default: false

Include spots marked as ice rings in the indexing run. -If dataset_settings doesn't have detect_ice_rings on, this option will have no effect on processing.

-
rotation_indexing
boolean
Deprecated
Default: false

Ignored: accepted on input and always returned as false; will be removed in a future release. -The Lite and FPGA workflows index each image on its own, rotation or not; rotation indexing is done by rugnux live.

-
rotation_indexing_min_angular_range_deg
number <float> >= 1
Deprecated
Default: 20

Ignored, as rotation_indexing; always returned as 20.0.

-
rotation_indexing_angular_stride_deg
number <float> >= 0
Deprecated
Default: 0.5

Ignored, as rotation_indexing; always returned as 0.5.

-
blocking
required
boolean
Default: true

Indexing in Jungfraujoch goes with a dedicated thread pool. -If set to false, the thread pool is non-blocking, i.e. if there are no threads available, image indexing will be skipped. This option is recommended for real-time processing at high frame rates. -If set to true, the thread pool will block until a thread is available.

-

Responses

Request samples

Content type
application/json
{
  • "algorithm": "FFBIDX",
  • "fft_max_unit_cell_A": 250,
  • "fft_min_unit_cell_A": 10,
  • "fft_high_resolution_A": 2,
  • "fft_num_vectors": 16384,
  • "tolerance": 0.5,
  • "thread_count": 1,
  • "geom_refinement_algorithm": "BeamCenter",
  • "unit_cell_dist_tolerance": 0.05,
  • "viable_cell_min_spots": 10,
  • "index_ice_rings": false,
  • "rotation_indexing": false,
  • "rotation_indexing_min_angular_range_deg": 20,
  • "rotation_indexing_angular_stride_deg": 0.5,
  • "blocking": true
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get indexing configuration

Can be done anytime

-

Responses

Response samples

Content type
application/json
{
  • "algorithm": "FFBIDX",
  • "fft_max_unit_cell_A": 250,
  • "fft_min_unit_cell_A": 10,
  • "fft_high_resolution_A": 2,
  • "fft_num_vectors": 16384,
  • "tolerance": 0.5,
  • "thread_count": 1,
  • "geom_refinement_algorithm": "BeamCenter",
  • "unit_cell_dist_tolerance": 0.05,
  • "viable_cell_min_spots": 10,
  • "index_ice_rings": false,
  • "rotation_indexing": false,
  • "rotation_indexing_min_angular_range_deg": 20,
  • "rotation_indexing_angular_stride_deg": 0.5,
  • "blocking": true
}

Change Bragg integration settings

This can only be done when detector is Idle, Error or Inactive states.

-
Request Body schema: application/json
integration_model
required
string (integration_model)
Default: "ProfileGaussian"
Enum: "ProfileGaussian" "ProfileEmpirical" "BoxSum"

Bragg spot integration model. -ProfileGaussian - profile fit with a measured-width Gaussian (Kabsch-style), the default; more - accurate intensities than box summation. -ProfileEmpirical - profile fit with a per-resolution-shell empirical profile learned from strong spots. -BoxSum - classical uniform box summation minus a ring-mean background; the simpler, faster fallback.

-
max_hkl
integer [ 1 .. 511 ]
Default: 100

How far the Bragg predictor walks the lattice: reflections with |h|,|k|,|l| above this are -never predicted. An axis is truncated once a/d_min exceeds it, so a long axis - or a short -one taken to high resolution - loses its outermost reflections. The cost grows as the cube -(2n+1)^3 of candidates per image, which is why online keeps a fixed, predictable value -instead of taking it from whichever crystal is mounted.

-

Omitting the field selects the default above; it is never interpreted as "choose per -crystal". The offline tools (rugnux, viewer) do derive it from the refined cell when it is -left unset there, but that is their own default and is not reachable through this API.

-

Responses

Request samples

Content type
application/json
{
  • "integration_model": "ProfileGaussian",
  • "max_hkl": 100
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get Bragg integration configuration

Can be done anytime

-

Responses

Response samples

Content type
application/json
{
  • "integration_model": "ProfileGaussian",
  • "max_hkl": 100
}

Change file writer settings

This can only be done when detector is Idle, Error or Inactive states.

-
Request Body schema: application/json
overwrite
boolean
Default: false

Inform jfjoch_write to overwrite existing files. Otherwise files would be saved with .h5.{timestamp}.tmp suffix.

-
format
string (file_writer_format)
Default: "NXmxVDS"
Enum: "NXmxOnlyData" "NXmxLegacy" "NXmxVDS" "NXmxIntegrated" "CBF" "TIFF" "NoFileWritten"

NoFileWritten - no files are written at all -NXmxOnlyData - only data files are written, no master file -NXmxLegacy - legacy format with soft links to data files in the master file; necessary for DECTRIS Albula 4.0 and DECTRIS Neggia -NXmxVDS - newer format with virtual dataset linking data files in the master file, also includes better metadata handling -NXmxIntegrated - single HDF5 per dataset -CBF - DEPRECATED, no longer supported; kept for back compatibility only. Requests using this value are rejected. Only HDF5 formats are written. -TIFF - DEPRECATED, no longer supported; kept for back compatibility only. Requests using this value are rejected. Only HDF5 formats are written.

-

Responses

Request samples

Content type
application/json
{
  • "overwrite": false,
  • "format": "NXmxOnlyData"
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get file writer settings

Can be done anytime

-

Responses

Response samples

Content type
application/json
{
  • "overwrite": false,
  • "format": "NXmxOnlyData"
}

Change instrument metadata

This can only be done when detector is Idle, Error or Inactive states.

-
Request Body schema: application/json
source_name
required
string
source_type
string
Default: ""

Type of radiation source. NXmx gives a fixed dictionary, though Jungfraujoch is not enforcing compliance. -https://manual.nexusformat.org/classes/base_classes/NXsource.html#nxsource -NXsource allows the following:

-

Spallation Neutron Source -Pulsed Reactor Neutron Source -Reactor Neutron Source -Synchrotron X-ray Source -Pulsed Muon Source -Rotating Anode X-ray -Fixed Tube X-ray -UV Laser -Free-Electron Laser -Optical Laser -Ion Source -UV Plasma Source -Metal Jet X-ray

-
instrument_name
required
string
pulsed_source
boolean
Default: false

Settings specific to XFEL (e.g., every image has to come from TTL trigger, save pulse ID and event code)

-
electron_source
boolean
Default: false

Settings specific to electron source (e.g., wavelength definition)

-

Responses

Request samples

Content type
application/json
{
  • "source_name": "Swiss Light Source",
  • "source_type": "Synchrotron X-ray Source",
  • "instrument_name": "CristallinaMX",
  • "pulsed_source": false,
  • "electron_source": false
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get instrument metadata

Can be done anytime

-

Responses

Response samples

Content type
application/json
{
  • "source_name": "Swiss Light Source",
  • "source_type": "Synchrotron X-ray Source",
  • "instrument_name": "CristallinaMX",
  • "pulsed_source": false,
  • "electron_source": false
}

Change image output format

This can only be done when detector is Idle, Error or Inactive states.

-
Request Body schema: application/json
summation
required
boolean

Enable summation of images to a given image_time -If disabled images are saved according to original detector speed, but image count is adjusted

-
geometry_transform
required
boolean

Place module read-out into their location on composed detector and extend multipixels

-
jungfrau_conversion
required
boolean

Convert pixel value in ADU to photon counts/energy -Only affects JUNGFRAU detector

-
jungfrau_conversion_factor_keV
number <float> [ 0.001 .. 500 ]

Used to convert energy deposited into pixel to counts -If not provided incident_energy_keV is used

-
bit_depth_image
integer <int64>
Enum: 8 16 32

Bit depth of resulting image (it doesn't affect the detector read-out value) -If not provided value is adjusted automatically

-
signed_output
boolean

Controls if pixels have signed output -If not provided value is adjusted automatically

-
mask_module_edges
required
boolean
Default: true

Mask 1 pixel on the module boundary

-
mask_chip_edges
required
boolean
Default: true

Mask multipixels on chip boundary

-
jungfrau_mask_pixels_without_g0
boolean
Default: true

JUNGFRAU: mask pixels that don'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.

-
apply_mask
required
boolean
Default: false

Masked pixels are set to special value in the images produced by Jungfraujoch

-
jungfrau_pedestal_g0_rms_limit
integer <int64> >= 0
Default: 100

Pixels with pedestal G0 RMS above the threshold are marked as masked pixels

-

Responses

Request samples

Content type
application/json
{
  • "summation": true,
  • "geometry_transform": true,
  • "jungfrau_conversion": true,
  • "jungfrau_conversion_factor_keV": 0.001,
  • "bit_depth_image": 8,
  • "signed_output": true,
  • "mask_module_edges": true,
  • "mask_chip_edges": true,
  • "jungfrau_mask_pixels_without_g0": true,
  • "apply_mask": false,
  • "jungfrau_pedestal_g0_rms_limit": 100
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get image output format

Can be done anytime

-

Responses

Response samples

Content type
application/json
{
  • "summation": true,
  • "geometry_transform": true,
  • "jungfrau_conversion": true,
  • "jungfrau_conversion_factor_keV": 0.001,
  • "bit_depth_image": 8,
  • "signed_output": true,
  • "mask_module_edges": true,
  • "mask_chip_edges": true,
  • "jungfrau_mask_pixels_without_g0": true,
  • "apply_mask": false,
  • "jungfrau_pedestal_g0_rms_limit": 100
}

Configure format for raw data collection

This can only be done when detector is Idle, Error or Inactive states.

-

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Configure format for data collection with full conversion

This can only be done when detector is Idle, Error or Inactive states.

-

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Configure spot finding

Can be done anytime, also while data collection is running

-
Request Body schema: application/json
enable
required
boolean
Default: true

Enable spot finding. This is temporary setting, i.e. can be changed anytime during data collection. -Even if disabled spot finding information will still be send and written, though always with zero spots.

-
indexing
required
boolean
Default: true

Enable indexing. This is temporary setting, i.e. can be changed anytime during data collection.

-
signal_to_noise_threshold
required
number <float> >= 0
photon_count_threshold
required
integer <int64> >= 0
min_pix_per_spot
required
integer <int64> >= 1
max_pix_per_spot
required
integer <int64> >= 1
high_resolution_limit
number <float>

High resolution limit for spot finding [Angstrom]. Optional: if omitted, spot finding extends -as far as the detector reaches, i.e. the detection is not clipped in resolution.

-
low_resolution_limit
number <float>

Low resolution limit for spot finding [Angstrom]. Optional: if omitted, spot finding is not -clipped at the low-resolution end. A value of 0 is accepted and means the same thing.

-
high_resolution_limit_for_spot_count_low_res
required
number <float> [ 2 .. 8 ]

High resolution threshold to consider spot "low resolution" [Angstrom]

-
quick_integration
boolean
Deprecated
Default: false

Ignored: accepted on input and always returned as false; will be removed in a future release. -The Lite and FPGA workflows index images but do not integrate them; integration is done by rugnux live.

-
ice_ring_width_q_recipA
required
number <float> [ 0 .. 1 ]
Default: 0.03

Half-width of the ice ring band in q (1/A). Matches the offline default in image_analysis/spot_finding/SpotFindingSettings.h, which was set from a measured ring FWHM of ~0.06; the two must agree or the same data gets a narrower ice band online.

-
high_res_gap_Q_recipA
number <float> [ 0.1 .. 5 ]
Default: 1.5

This parameter is used to remove spurious spots at a very high resolution, that sometimes appear due to very low background close to the edge of the detector. -If there is a gap in (1/d)-space between spots of at least this size, spots on the side of the gap with high resolution will be discarded. This is optional parameter. -This option should be turned OFF for small molecule datasets or for crystals with very low mosaicity, when it is expected to see only few spots in any case.

-
adaptive_threshold
boolean
Default: false

Self-calibrating spot detection: replace the fixed photon_count_threshold by a per-resolution-ring -threshold derived from each image's own noise, so the same setting works across datasets without -per-dataset tuning. photon_count_threshold is then ignored and false_pixels_per_frame sets the -operating point instead. -Used only on detectors whose images are analysed in software (the DECTRIS/SIMPLON workflow). -The JUNGFRAU and EIGER workflows find spots on the FPGA, which applies its own fixed threshold; -there the setting is accepted and ignored, so the same settings can be shared across detectors.

-
false_pixels_per_frame
number <float> [ 1 .. 100000 ]
Default: 100

Operating point of the adaptive threshold: the number of noise pixels tolerated per frame. -About 100 suits a multi-megapixel detector. Ignored unless adaptive_threshold is set.

-

Responses

Request samples

Content type
application/json
{
  • "enable": true,
  • "indexing": true,
  • "signal_to_noise_threshold": 0.1,
  • "photon_count_threshold": 0,
  • "min_pix_per_spot": 1,
  • "max_pix_per_spot": 1,
  • "high_resolution_limit": 0.1,
  • "low_resolution_limit": 0.1,
  • "high_resolution_limit_for_spot_count_low_res": 2,
  • "quick_integration": false,
  • "ice_ring_width_q_recipA": 0.03,
  • "high_res_gap_Q_recipA": 1.5,
  • "adaptive_threshold": false,
  • "false_pixels_per_frame": 100
}

Get data processing configuration

Can be done anytime

-

Responses

Response samples

Content type
application/json
{
  • "enable": true,
  • "indexing": true,
  • "signal_to_noise_threshold": 0.1,
  • "photon_count_threshold": 0,
  • "min_pix_per_spot": 1,
  • "max_pix_per_spot": 1,
  • "high_resolution_limit": 0.1,
  • "low_resolution_limit": 0.1,
  • "high_resolution_limit_for_spot_count_low_res": 2,
  • "quick_integration": false,
  • "ice_ring_width_q_recipA": 0.03,
  • "high_res_gap_Q_recipA": 1.5,
  • "adaptive_threshold": false,
  • "false_pixels_per_frame": 100
}

Configure azimuthal integration

Can be done when detector is Inactive or Idle

-
Request Body schema: application/json
polarization_corr
required
boolean
Default: true

Apply polarization correction for azimuthal integration (polarization factor must be configured in dataset settings)

-
solid_angle_corr
required
boolean
Default: true

Apply solid angle correction for azimuthal integration

-
high_q_recipA
number <float> [ 0.00002 .. 10 ]

Upper q limit of the azimuthal integration [1/Angstrom]. Optional: if omitted, the integration -(and the adaptive spot detection that shares these q bins) extends to the highest q the -detector reaches.

-
low_q_recipA
required
number <float> [ 0.00001 .. 10 ]
q_spacing
number <float> >= 0.00001

Width of a Q bin [1/Angstrom], for linear binning only. Linear binning takes either this or -q_bins, not both; with neither, the spacing is 0.01 1/Angstrom.

-
q_bins
integer <int64> [ 1 .. 65534 ]

Number of Q bins between low and high Q. Required for log10 binning; for linear binning -an alternative to q_spacing.

-
q_binning
string (q_binning)
Default: "linear"
Enum: "linear" "log10"

How the Q bins of azimuthal integration are laid out between low and high Q. -linear - equal steps in Q. -log10 - equal steps in log10(Q): fine bins at low Q, coarse at high Q. Needs q_bins.

-
azimuthal_bins
integer <int64> [ 1 .. 512 ]
Default: 1

Numer of azimuthal (phi) bins; 1 = standard 1D azimuthal integration

-
force_cpu
boolean
Default: false

Force CPU processing of azimuthal integration in the FPGA data acquisition workflow. -This allows to extend number of azimuthal integration bins, as well as to calculate standard deviation -of the azimuthal integration results.

-

Responses

Request samples

Content type
application/json
{
  • "polarization_corr": true,
  • "solid_angle_corr": true,
  • "high_q_recipA": 0.00002,
  • "low_q_recipA": 0.00001,
  • "q_spacing": 0.00001,
  • "q_bins": 1,
  • "q_binning": "linear",
  • "azimuthal_bins": 1,
  • "force_cpu": false
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get azimuthal integration configuration

Can be done anytime

-

Responses

Response samples

Content type
application/json
{
  • "polarization_corr": true,
  • "solid_angle_corr": true,
  • "high_q_recipA": 0.00002,
  • "low_q_recipA": 0.00001,
  • "q_spacing": 0.00001,
  • "q_bins": 1,
  • "q_binning": "linear",
  • "azimuthal_bins": 1,
  • "force_cpu": false
}

Load binary image for internal FPGA generator

Load image for internal FPGA generator. This can only happen in Idle state of the detector. -Requires binary blob with 16-bit integer numbers of size of detector in raw/converted coordinates -(depending on detector settings).

-
query Parameters
id
integer <int64> [ 0 .. 127 ]

Image id to upload

-
Request Body schema: application/octet-stream
string <binary>

Responses

Load TIFF image for internal FPGA generator

Load image for internal FPGA generator. This can only happen in Idle state of the detector. -Requires TIFF with 16-bit integer numbers of size of detector in raw/converted coordinates -(depending on detector settings).

-
query Parameters
id
integer [ 0 .. 127 ]

Image ID to upload

-
Request Body schema: image/tiff
string <binary>

Responses

Select detector

Jungfraujoch allows to control multiple detectors and/or region-of-interests. -The command allows to choose one detector from the list (ID has to be consistent with one provided by GET response). -Changing detector will set detector to Inactive state and will require reinitialization.

-
Request Body schema: application/json
id
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": 1
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

List available detectors

Configured detectors that can be selected by used

-

Responses

Response samples

Content type
application/json
{
  • "detectors": [
    ],
  • "current_id": 0
}

Change rugnux live mode settings

This can only be done when detector is Idle, Error or Inactive states.

-
Request Body schema: application/json
enable
boolean
Default: false

Process DECTRIS rotation collections with rugnux live, and serial collections on the GPU after a pre-pass

-
reserved_cpus
integer <int64> >= 0
Default: 4

CPU threads left to the receiver and the image pusher while rugnux runs

-
deadline_s
number <double> >= 0
Default: 60

Fixed cutoff: this long after the last image the analysis is cut, and the collection ends -with what it has established (as POST /cancel after the last image does). 0 means no cutoff.

-
refine_solvent
boolean
Default: false

With a model: the refinement also builds the solvent - waters added at difference-map peaks and removed -where the maps no longer hold them, waters and ions relabelled (as rugnux --refine-solvent). -Reset to false by POST /initialize.

-
force_still
boolean
Default: false

Process DECTRIS rotation collections as stills, on the serial path (pre-pass, GPU analysis, stills merge), -as rugnux --force-still does. The written file keeps its goniometer. Reset to false by POST /initialize.

-

Responses

Request samples

Content type
application/json
{
  • "enable": false,
  • "reserved_cpus": 4,
  • "deadline_s": 60,
  • "refine_solvent": false,
  • "force_still": false
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get rugnux live mode settings and model status

Can be done anytime

-

Responses

Response samples

Content type
application/json
{
  • "enable": true,
  • "reserved_cpus": 0,
  • "deadline_s": 0.1,
  • "refine_solvent": true,
  • "force_still": true,
  • "model_loaded": true,
  • "model_size_bytes": 0
}

Upload the model used by rugnux live mode

This can only be done when detector is Idle, Error or Inactive states. -The model (PDB or mmCIF, optionally gzipped; at most 64 MiB) is used for molecular replacement -and validation of every following rugnux live collection, until it is removed with -DELETE /config/rugnux/model or replaced by another upload.

-
Request Body schema: application/octet-stream
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Remove the model used by rugnux live mode

This can only be done when detector is Idle, Error or Inactive states.

-

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get live rugnux processing status of the last collection

Can be done anytime

-
Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "state": "Idle",
  • "placed_model": true,
  • "refined_model": true,
  • "anomalous_map": true,
  • "anomalous_signal": true,
  • "model": {
    },
  • "stills": {
    },
  • "shells_merge": "string",
  • "shells": [
    ],
  • "overall": {
    },
  • "frame_scales": [
    ],
  • "frame_ranges": [
    ],
  • "space_group": "string",
  • "d_min": 0.1,
  • "isa": 0.1,
  • "probe": "string",
  • "probe_s": 0.1,
  • "start_to_first_image_s": 0.1,
  • "message": "string",
  • "images_expected": 0,
  • "expected_collection_s": 0.1,
  • "images_received": 0,
  • "elapsed_s": 0.1,
  • "step_progress": 1,
  • "steps": [
    ],
  • "last_image_s": 0.1,
  • "cut": "string",
  • "cut_s": 0.1,
  • "last_image_to_written_s": 0.1,
  • "verdict": "string",
  • "verdict_text": "string",
  • "summary": [
    ],
  • "warnings": [
    ],
  • "triage": [
    ]
}

Clear the live rugnux result of the last collection

Puts /rugnux/status back to Idle with nothing of the last run - its merge, model, maps, steps and notes - -as before any collection. The collection's images, plots and the rugnux live settings are kept. -Can be only run when Jungfraujoch is not collecting data.

-

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get the model as placed by the last rugnux live run

The model placed against the data by molecular replacement or validation, as mmCIF - the same text as the -_model.cif file written beside the data: the data's cell and space group, with the input model's own -metadata (entities, sequences, references, authors, software) kept. Kept as long as /rugnux/status. -Where the run refined the model, the refined model unless asked for stage=placed.

-
Authorizations:
bearerAuth
query Parameters
stage
string
Enum: "placed" "refined"

placed: the model as placed; refined: the model refined (refined_model in /rugnux/status). -Default: the refined model where there is one, otherwise the placed one.

-

Responses

Get an electron-density map of the last rugnux live run

The map of the placed model (/rugnux/model.cif) in CCP4 format (mode 2, float), made from the map -coefficients written to _maps.mtz (FWT/PHWT, DELFWT/PHDELWT, ANOM/PHANOM). It covers one unit cell centred on the model - along an axis where -the model reaches further than the cell, the model plus 5 A instead - sampled every d_min/3; the mean and -RMS in its header are those of the unit cell, so contour levels in sigma are the usual ones. Where the run -refined the model, the 2mFo-DFc and mFo-DFc maps are the refined model's unless asked for stage=placed; -the anomalous map stays on the placed model's phases.

-
Authorizations:
bearerAuth
query Parameters
type
string
Default: "2fofc"
Enum: "2fofc" "fofc" "anom"

2fofc: the 2mFo-DFc map; fofc: the mFo-DFc difference map; anom: the anomalous difference map, -(F(+) - F(-)) on the model phases less 90 degrees, where the merge kept the Bijvoet pairs (anomalous_map -in /rugnux/status)

-
stage
string
Enum: "placed" "refined"

placed: the model as placed; refined: the model refined (refined_model in /rugnux/status). -Default: the refined model where there is one, otherwise the placed one.

-

Responses

Set ZeroMQ preview settings

Jungfraujoch can generate preview message stream on ZeroMQ SUB socket. -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. -Options set with this PUT request have no effect on HTTP based preview.

-
Request Body schema: application/json
enabled
required
boolean
Default: true

ZeroMQ preview socket is enabled.

-
period_ms
required
integer <int64>
Default: 1000

Period for generating preview image sent to the ZeroMQ interface in milliseconds. Default is 1 second. -If set to zero, all images will be sent ZeroMQ (should be used only in case of relatively slow data collection). -This has no effect on HTTP based preview, which updates always at rate of 1 second.

-
socket_address
string

PUB ZeroMQ socket for preview images. This socket operates at a reduced frame rate. -Images are serialized using CBOR. -Address follows ZeroMQ convention for sockets - in practice ipc:// and tcp://: sockets are OK. -0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.

-

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "period_ms": 1000,
  • "socket_address": "string"
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get ZeroMQ preview settings

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "period_ms": 1000,
  • "socket_address": "string"
}

Set ZeroMQ metadata settings

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.

-
Request Body schema: application/json
enabled
required
boolean
Default: true

ZeroMQ metadata socket is enabled.

-
period_ms
required
integer <int64> >= 1
Default: 1000

Period for generating metadata package sent to the ZeroMQ interface in milliseconds.

-
socket_address
string

PUB ZeroMQ socket for image metadata information. -Image metadata are serialized using CBOR. -Address follows ZeroMQ convention for sockets - in practice ipc:// and tcp://: sockets are OK. -0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.

-

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "period_ms": 1000,
  • "socket_address": "string"
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get ZeroMQ metadata socket settings

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "period_ms": 1000,
  • "socket_address": "string"
}

Set configuration for dark data collection to calculate mask

This is only possible when operating DECTRIS detectors at the moment; it will be also available for PSI EIGER at some point. -This can only be done when detector is Idle, Error or Inactive states.

-
Request Body schema: application/json
detector_threshold_keV
required
number <float> [ 2.5 .. 100 ]
Default: 3.5

Energy threshold for dark image collection

-
frame_time_us
required
integer <int64> [ 500 .. 100000 ]
Default: 10000

Time between frames for dark image collection

-
number_of_frames
required
integer <int64> >= 0
Default: 1000

Number of frames for dark image collection; zero means no dark collection

-
max_allowed_pixel_count
required
integer <int64> >= 0
Default: 1

Maximum count in a pixel considered normal (not-masked)

-
max_frames_with_signal
required
integer <int64> >= 0
Default: 10

Maximum number of frames with signal in a pixel considered normal (not-masked)

-

Responses

Request samples

Content type
application/json
{
  • "detector_threshold_keV": 3.5,
  • "frame_time_us": 10000,
  • "number_of_frames": 1000,
  • "max_allowed_pixel_count": 1,
  • "max_frames_with_signal": 10
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get settings for dark data collection to calculate mask

Responses

Response samples

Content type
application/json
{
  • "detector_threshold_keV": 3.5,
  • "frame_time_us": 10000,
  • "number_of_frames": 1000,
  • "max_allowed_pixel_count": 1,
  • "max_frames_with_signal": 10
}

Get Jungfraujoch status

Status of the data acquisition

-

Responses

Response samples

Content type
application/json
{
  • "state": "Inactive",
  • "progress": 1,
  • "message": "string",
  • "message_severity": "success",
  • "gpu_count": 0,
  • "broker_version": "1.0.0-rc.128"
}

Get status of FPGA devices

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return XFEL pulse IDs for the current data acquisition

Return array of XFEL pulse IDs - (-1) if image not recorded

-

Responses

Response samples

Content type
application/json
[
  • 0
]

Return XFEL event codes for the current data acquisition

Return array of XFEL event codes

-

Responses

Response samples

Content type
application/json
[
  • 0
]

Get status of image pusher

Responses

Response samples

Content type
application/json
{
  • "pusher_type": "ZeroMQ",
  • "addr": [
    ],
  • "connected_writers": 0,
  • "images_written": 0,
  • "images_write_error": 0,
  • "writer_fifo_utilization": [
    ]
}

Get detector status

Status of the JUNGFRAU detector

-

Responses

Response samples

Content type
application/json
{
  • "state": "Idle",
  • "powerchip": "PowerOn",
  • "server_version": "string",
  • "number_of_triggers_left": 0,
  • "fpga_temp_degC": [
    ],
  • "high_voltage_V": [
    ]
}

Get ROI definitions

Responses

Response samples

Content type
application/json
{
  • "box": {
    },
  • "circle": {
    },
  • "azim": {
    }
}

Upload ROI definitions

Request Body schema: application/json
required
object (roi_box_list)

List of box ROIs

-
required
object (roi_circle_list)

List of circular ROIs

-
required
object (roi_azim_list)

List of azimuthal ROIs

-

Responses

Request samples

Content type
application/json
{
  • "box": {
    },
  • "circle": {
    },
  • "azim": {
    }
}

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get general statistics

measurement is omitted unless the request carries a valid bearer token for a protected -dataset (see tokens in /start).

-

Responses

Response samples

Content type
application/json
{
  • "detector": {
    },
  • "detector_list": {
    },
  • "detector_settings": {
    },
  • "image_format_settings": {
    },
  • "instrument_metadata": {
    },
  • "file_writer_settings": {
    },
  • "data_processing_settings": {
    },
  • "measurement": {
    },
  • "broker": {
    },
  • "fpga": [
    ],
  • "calibration": [
    ],
  • "zeromq_preview": {
    },
  • "zeromq_metadata": {
    },
  • "dark_mask": {
    },
  • "pixel_mask": {
    },
  • "roi": {
    },
  • "az_int": {
    },
  • "buffer": {
    },
  • "indexing": {
    },
  • "bragg_integration": {
    },
  • "image_pusher": {
    }
}

Get data collection statistics

Results of the last data collection (dataset name, unit cell, ...)

-
Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "file_prefix": "string",
  • "run_number": 0,
  • "experiment_group": "string",
  • "images_expected": 0,
  • "images_collected": 0,
  • "images_sent": 0,
  • "images_written": 0,
  • "images_discarded_lossy_compression": 0,
  • "max_image_number_sent": 0,
  • "collection_efficiency": 1,
  • "compression_ratio": 5.3,
  • "cancelled": true,
  • "max_receiver_delay": 0,
  • "indexing_rate": 0.1,
  • "detector_width": 0,
  • "detector_height": 0,
  • "detector_pixel_depth": 2,
  • "bkg_estimate": 0.1,
  • "unit_cell": "string",
  • "error_pixels": 0.1,
  • "saturated_pixels": 0.1,
  • "roi_beam_pixels": 0.1,
  • "roi_beam_sum": 0.1
}

Get calibration statistics

Statistics are provided for each module/storage cell separately

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get mask of the detector (binary)

Detector must be Initialized. -Get full pixel mask of the detector. -See NXmx standard for meaning of pixel values.

-

Responses

Detector must be Initialized. -Get user mask of the detector (binary) -

Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked

-

Responses

Upload user mask of the detector (binary)

Should be in Idle 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'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.

-
Request Body schema: application/octet-stream
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get mask of the detector (TIFF)

Should be in Idle state. -Get full pixel mask of the detector -See NXmx standard for meaning of pixel values

-

Responses

Detector must be Initialized. -Get user mask of the detector (TIFF) -

Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked

-

Responses

Upload user mask of the detector

Should be in Idle 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't need to be assigned value. -Mask is expected as a single-channel TIFF (8-, 16- or 32-bit integer, signed or 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. -User mask is not automatically applied - i.e. pixels with user mask will have a valid pixel value in the images.

-
Request Body schema: image/tiff
string <binary>

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get pedestal in TIFF format

query Parameters
gain_level
required
integer

Gain level (0, 1, 2)

-
sc
integer

Storage cell number

-

Responses

Generate 1D plot from Jungfraujoch

Authorizations:
bearerAuth
query Parameters
binning
integer
Default: 1

Binning of frames for the plot (0 = default binning)

-
type
required
string
Enum: "bkg_estimate" "spindle_blind_fraction" "azint" "azint_1d" "spot_count" "spot_count_low_res" "spot_count_indexed" "spot_count_ice" "indexing_rate" "indexing_lattice_count" "indexing_unit_cell_length" "indexing_unit_cell_angle" "profile_radius" "mosaicity" "b_factor" "error_pixels" "saturated_pixels" "image_collection_efficiency" "receiver_delay" "receiver_free_send_buf" "strong_pixels" "roi_sum" "roi_mean" "roi_max_count" "roi_pixels" "roi_weighted_x" "roi_weighted_y" "packets_received" "max_pixel_value" "resolution_estimate" "pixel_sum" "processing_time" "beam_center_x" "beam_center_y" "integrated_reflections" "image_scale_factor" "image_scale_cc" "compression_ratio" "ice_ring_score"

Type of requested plot

-
fill
number <float>

Fill value for elements that were missed during data collection

-
experimental_coord
boolean
Default: false

If measurement has goniometer axis defined, plot X-axis will represent rotation angle -If measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value -For still measurement the number is ignored

-
azint_unit
string
Default: "Q_recipA"
Enum: "Q_recipA" "d_A" "two_theta_deg"

Unit used for azim int.

-

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "unit_x": "image_number",
  • "size_x": 0.1,
  • "size_y": 0.1,
  • "plot": [
    ]
}

Generate 1D plot from Jungfraujoch and send in raw binary format. -Data are provided as (32-bit) float binary array. -This format doesn't transmit information about X-axis, only values, so it is of limited use for azimuthal integration. -

Authorizations:
bearerAuth
query Parameters
type
required
string
Enum: "bkg_estimate" "spindle_blind_fraction" "azint" "azint_1d" "spot_count" "spot_count_low_res" "spot_count_indexed" "spot_count_ice" "indexing_rate" "indexing_lattice_count" "indexing_unit_cell_length" "indexing_unit_cell_angle" "profile_radius" "mosaicity" "b_factor" "error_pixels" "saturated_pixels" "image_collection_efficiency" "receiver_delay" "receiver_free_send_buf" "strong_pixels" "roi_sum" "roi_mean" "roi_max_count" "roi_pixels" "roi_weighted_x" "roi_weighted_y" "packets_received" "max_pixel_value" "resolution_estimate" "pixel_sum" "processing_time" "beam_center_x" "beam_center_y" "integrated_reflections" "image_scale_factor" "image_scale_cc" "compression_ratio" "ice_ring_score"

Type of requested plot

-
roi
string non-empty

Name of ROI for which plot is requested

-

Responses

Get full scan result

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "file_prefix": "string",
  • "rotation_unit_cell": {
    },
  • "rotation_crystal_lattice": [
    ],
  • "rotation_bravais": "string",
  • "images": [
    ]
}

Get Start message in CBOR format

Contains metadata for a dataset (e.g., experimental geometry)

-
Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Event stream of the collection, for a reader following it

Server-sent events (text/event-stream) for the current collection, from the moment /start has -accepted it: first its whole history, then every change, until it ends or a new collection -begins. Only one reader at a time. Events, each with a JSON data line:

-
    -
  • start {run_number, run_name, file_prefix, number_of_images, images_per_file, cbor} - first, -once the start message is known: at once for a JUNGFRAU, when the detector sends its own for -a DECTRIS. cbor is the start message the writer of the master file received, CBOR in base64; -a reader builds the dataset from it;
  • -
  • file {file_number, file, first_image, image_count} - a data file closed and renamed into -place; file is relative to the collection's root, as the writer named it;
  • -
  • end {images, error?} - every writer acknowledged the end: the data files and the master -file are in place; images is the number of images collected. Also sent, with error, when -the measurement ends any other way - before the start message, for one. The stream then closes;
  • -
  • superseded {run_number} - a new collection began. The stream then closes. -A comment line (: keepalive) every 10 s when nothing happens.
  • -
-
Authorizations:
bearerAuth

Responses

Get image message in CBOR format

Contains full image data and metadata. The image must come from the latest data collection.

-
Authorizations:
bearerAuth
query Parameters
id
integer <int64> >= -2
Default: -1

Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer

-

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get preview image in JPEG format using custom settings

Authorizations:
bearerAuth
query Parameters
id
integer <int64> >= -2
Default: -1

Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer

-
show_user_mask
boolean
Default: false

Show user mask

-
show_roi
boolean
Default: false

Show ROI areas on the image

-
show_spots
boolean
Default: true

Show spot finding results on the image

-
show_predictions
boolean
Default: false

Show Bragg spot predictions on the image (if available for the image)

-
show_beam_center
boolean
Default: true

Show beam center on the image

-
saturation
number <float> [ -32767 .. 32767 ]

Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used

-
jpeg_quality
integer <int64> [ 0 .. 100 ]
Default: 100

Quality of JPEG image (100 - highest; 0 - lowest)

-
show_res_ring
number <float> [ 0.1 .. 100 ]
Default: 0.1

Show resolution ring, provided in Angstrom

-
color
string
Default: "indigo"
Enum: "indigo" "viridis" "bw" "wb" "green" "heat" "magma" "inferno"

Color scale for preview image

-
show_res_est
boolean
Default: false

Show resolution estimation as a ring

-

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get preview image in TIFF format

Authorizations:
bearerAuth
query Parameters
id
integer <int64> >= -2
Default: -1

Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer

-

Responses

Clear image buffer

Turns off image buffer for the last data collection. Can be only run when Jungfraujoch is not collecting data.

-

Responses

Response samples

Content type
application/json
{
  • "msg": "Detector in wrong state",
  • "reason": "WrongDAQState"
}

Get status of the image buffers

Can be run at any stage of Jungfraujoch operation, including during data collection. -The status of the image buffer is volatile during data collection - if data collection goes for more images than available buffer slots, -then image might be replaced in the buffer between calling /images and /image.cbor.

-

Responses

Response samples

Content type
application/json
{
  • "min_image_number": 0,
  • "max_image_number": 0,
  • "image_numbers": [
    ],
  • "total_slots": 0,
  • "available_slots": 0,
  • "in_preparation_slots": 0,
  • "in_sending_slots": 0,
  • "current_counter": 0
}

Get Jungfraujoch version of jfjoch_broker

Responses

- diff --git a/common/CMakeLists.txt b/common/CMakeLists.txt index f9e2c71fa..767c4f2b7 100644 --- a/common/CMakeLists.txt +++ b/common/CMakeLists.txt @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2023 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only + # git header # the commit's SHA1, and whether the building workspace was dirty or not @@ -73,6 +76,7 @@ ADD_LIBRARY(JFJochZMQ STATIC ZMQWrappers.cpp ZMQWrappers.h) ADD_LIBRARY(JFJochCommon STATIC Coord.cpp Coord.h + CpuFFT.cpp CpuFFT.h DiffractionExperiment.cpp DiffractionExperiment.h RawToConvertedGeometry.h JFJochException.h diff --git a/common/CorrelationCoefficient.cpp b/common/CorrelationCoefficient.cpp index 7c21dbb26..62bd3df02 100644 --- a/common/CorrelationCoefficient.cpp +++ b/common/CorrelationCoefficient.cpp @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +// SPDX-License-Identifier: GPL-3.0-only + // // Created by leonarski_f on 18.05.2026. // diff --git a/common/CpuFFT.cpp b/common/CpuFFT.cpp new file mode 100644 index 000000000..cef90287a --- /dev/null +++ b/common/CpuFFT.cpp @@ -0,0 +1,75 @@ +// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +// SPDX-License-Identifier: GPL-3.0-only + +#include "CpuFFT.h" + +// Under a name of its own: gemmi includes the same header with POCKETFFT_NO_MULTITHREADING, and its +// templates and ours must not be merged by the linker into one (single-threaded or not) copy. +#define pocketfft jfjoch_pocketfft +// MSVC: the scalar code (pocketfft vectorises only with the GCC/Clang vector extension, and decides so +// itself; said here so that it stays so). +#ifdef _MSC_VER +#define POCKETFFT_NO_VECTORS +#endif +#include "../gemmi_gph/gemmi/third_party/pocketfft_hdronly.h" + +namespace cpu_fft { + +namespace { + +// pocketfft counts strides in bytes. +pocketfft::stride_t Bytes(const Strides &s, size_t element) { + pocketfft::stride_t out(s.size()); + for (size_t i = 0; i < s.size(); i++) + out[i] = s[i] * static_cast(element); + return out; +} + +Strides Contiguous(const Shape &shape) { + Strides s(shape.size()); + std::ptrdiff_t step = 1; + for (size_t i = shape.size(); i-- > 0;) { + s[i] = step; + step *= static_cast(shape[i]); + } + return s; +} + +Shape Halved(Shape shape, size_t axis) { + shape[axis] = shape[axis] / 2 + 1; + return shape; +} + +} // namespace + +void R2C(const Shape &shape, const Strides &stride_in, const Strides &stride_out, const Shape &axes, + const float *in, std::complex *out, size_t nthreads) { + pocketfft::r2c(shape, Bytes(stride_in, sizeof(float)), Bytes(stride_out, sizeof(std::complex)), + axes, pocketfft::FORWARD, in, out, 1.0f, nthreads); +} + +void R2C(const Shape &shape, const Shape &axes, const float *in, std::complex *out, size_t nthreads) { + R2C(shape, Contiguous(shape), Contiguous(Halved(shape, axes.back())), axes, in, out, nthreads); +} + +void C2R(const Shape &shape, const Shape &axes, std::complex *in, float *out, size_t nthreads) { + const Shape half = Halved(shape, axes.back()); + const pocketfft::stride_t stride_in = Bytes(Contiguous(half), sizeof(std::complex)); + if (axes.size() > 1) + pocketfft::c2c(half, stride_in, stride_in, Shape(axes.begin(), axes.end() - 1), pocketfft::BACKWARD, + in, in, 1.0f, nthreads); + pocketfft::c2r(shape, stride_in, Bytes(Contiguous(shape), sizeof(float)), axes.back(), + pocketfft::BACKWARD, in, out, 1.0f, nthreads); +} + +void C2C(const Shape &shape, const Strides &stride, const Shape &axes, bool forward, std::complex *data, + size_t nthreads) { + const pocketfft::stride_t s = Bytes(stride, sizeof(std::complex)); + pocketfft::c2c(shape, s, s, axes, forward, data, data, 1.0f, nthreads); +} + +void C2C(const Shape &shape, const Shape &axes, bool forward, std::complex *data, size_t nthreads) { + C2C(shape, Contiguous(shape), axes, forward, data, nthreads); +} + +} // namespace cpu_fft diff --git a/common/CpuFFT.h b/common/CpuFFT.h new file mode 100644 index 000000000..c1cebdb61 --- /dev/null +++ b/common/CpuFFT.h @@ -0,0 +1,36 @@ +// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +// SPDX-License-Identifier: GPL-3.0-only + +#pragma once + +#include +#include +#include + +// Single-precision CPU FFTs on pocketfft (the header vendored with gemmi). There are no plans to make: +// every call is a whole transform, safe from several threads at once. +// +// Arrays are row-major (the last axis fastest) and the transforms unnormalised, the forward one with +// exp(-2 pi i k.x), as FFTW's. A real transform halves the last axis in `axes` (n/2 + 1 complex values +// along it). Strides count elements of the array they belong to - floats on the real side, complex values +// on the complex side; without them the array is contiguous. `nthreads` splits one transform's lines. +namespace cpu_fft { + +using Shape = std::vector; +using Strides = std::vector; + +// Real -> complex, forward. `shape` is the real array's. +void R2C(const Shape &shape, const Strides &stride_in, const Strides &stride_out, const Shape &axes, + const float *in, std::complex *out, size_t nthreads = 1); +void R2C(const Shape &shape, const Shape &axes, const float *in, std::complex *out, size_t nthreads = 1); + +// Complex -> real, backward (exp(+2 pi i k.x)). `shape` is the real array's. `in` is overwritten, as by +// FFTW's c2r: the complex axes are transformed in place before the real one. +void C2R(const Shape &shape, const Shape &axes, std::complex *in, float *out, size_t nthreads = 1); + +// Complex -> complex, in place. +void C2C(const Shape &shape, const Strides &stride, const Shape &axes, bool forward, std::complex *data, + size_t nthreads = 1); +void C2C(const Shape &shape, const Shape &axes, bool forward, std::complex *data, size_t nthreads = 1); + +} // namespace cpu_fft diff --git a/common/DatasetSettings.cpp b/common/DatasetSettings.cpp index 601b5114b..97501d354 100644 --- a/common/DatasetSettings.cpp +++ b/common/DatasetSettings.cpp @@ -29,7 +29,6 @@ DatasetSettings::DatasetSettings() { poni_rot_2_rad = 0.0f; poni_rot_3_rad = 0.0f; - max_spot_count = std::min(MAX_SPOT_COUNT, 250); } DatasetSettings &DatasetSettings::ImagesPerTrigger(int64_t input) { @@ -557,6 +556,10 @@ const XrayFluorescenceSpectrum & DatasetSettings::GetFluorescenceSpectrum() cons } int64_t DatasetSettings::GetMaxSpotCount() const { + return max_spot_count.value_or(DEFAULT_MAX_SPOT_COUNT); +} + +std::optional DatasetSettings::GetMaxSpotCountGiven() const { return max_spot_count; } diff --git a/common/DatasetSettings.h b/common/DatasetSettings.h index 208c521ca..e0d88c8c2 100644 --- a/common/DatasetSettings.h +++ b/common/DatasetSettings.h @@ -73,7 +73,7 @@ class DatasetSettings { float poni_rot_3_rad; bool spot_finding_enable; - int64_t max_spot_count; + std::optional max_spot_count; // unset: each analysis takes its own default // Special handling of ice rings; unset where the user did not ask either way, so that the analysis takes its own // default (rugnux: on for a rotation sweep, off for stills) and the master file carries no detect_ice_rings @@ -186,7 +186,8 @@ public: std::optional GetSampleTemperature_K() const; bool IsSpotFindingEnabled() const; - int64_t GetMaxSpotCount() const; + int64_t GetMaxSpotCount() const; // DEFAULT_MAX_SPOT_COUNT where none is given + std::optional GetMaxSpotCountGiven() const; bool IsDetectIceRings() const; // false where unset std::optional GetDetectIceRings() const; diff --git a/common/Definitions.h b/common/Definitions.h index 6380efae5..ffdc0073b 100644 --- a/common/Definitions.h +++ b/common/Definitions.h @@ -47,6 +47,8 @@ constexpr float DEFAULT_G2_FACTOR = -0.1145f; constexpr float DEFAULT_HG0_FACTOR = 100.0f; constexpr int MAX_SPOT_COUNT = 64 * 1024; +// Spots kept per image where none is given: the broker's per-image indexing (rugnux live stills takes its own default) +constexpr int DEFAULT_MAX_SPOT_COUNT = 250; // Three spots fit any lattice at all; one short of ViableCellMinSpots (default 9) is where a fitted // lattice stops being distinguishable from a random one, so a spot list shorter than this is never diff --git a/common/DetectorSettings.cpp b/common/DetectorSettings.cpp index a4bf1c26e..2f30ccf63 100644 --- a/common/DetectorSettings.cpp +++ b/common/DetectorSettings.cpp @@ -13,9 +13,9 @@ DetectorSettings &DetectorSettings::InternalGeneratorEnable(bool input) { return *this; } -DetectorSettings &DetectorSettings::InternalGeneratorImages(int64_t input) { +DetectorSettings &DetectorSettings::InternalGeneratorImages(int64_t input, int64_t max_images) { check_min("Internal packet generator images", input, 1); - check_max("Internal packet generator images", input, 64); + check_max("Internal packet generator images", input, max_images); internal_fpga_packet_generator_images = input; return *this; } diff --git a/common/DetectorSettings.h b/common/DetectorSettings.h index dbd56f185..9a5034d65 100644 --- a/common/DetectorSettings.h +++ b/common/DetectorSettings.h @@ -37,7 +37,9 @@ class DetectorSettings { DetectorTiming timing = DetectorTiming::Trigger; public: DetectorSettings& InternalGeneratorEnable(bool input); - DetectorSettings& InternalGeneratorImages(int64_t input); + // The broker's limit; the firmware's own is FPGA_INTERNAL_GENERATOR_MAX_IMAGES + static constexpr int64_t DefaultMaxInternalGeneratorImages = 64; + DetectorSettings& InternalGeneratorImages(int64_t input, int64_t max_images = DefaultMaxInternalGeneratorImages); DetectorSettings& StorageCells(int64_t input); DetectorSettings& StorageCellStart(int64_t input); DetectorSettings& StorageCellDelay(const std::chrono::nanoseconds &input); diff --git a/common/DiffractionExperiment.cpp b/common/DiffractionExperiment.cpp index d31d4926e..d025d79bf 100644 --- a/common/DiffractionExperiment.cpp +++ b/common/DiffractionExperiment.cpp @@ -599,6 +599,10 @@ DiffractionExperiment &DiffractionExperiment::MaxSpotCount(int64_t input) { return *this; } +std::optional DiffractionExperiment::GetMaxSpotCountGiven() const { + return dataset.GetMaxSpotCountGiven(); +} + int64_t DiffractionExperiment::GetMaxSpotCount() const { if (!IsSpotFindingEnabled()) return 0; @@ -795,12 +799,12 @@ void DiffractionExperiment::FillMessage(StartMessage &message) const { if (GetSummation() == 1) message.summation_mode = "none"; - else { - if (IsCPUSummation()) - message.summation_mode = "cpu"; - else - message.summation_mode = "fpga"; - } + else if (!IsCPUSummation()) + message.summation_mode = "fpga"; + else if (GetFPGASummation() > 1) + message.summation_mode = "hybrid"; + else + message.summation_mode = "cpu"; } float DiffractionExperiment::GetPixelSize_mm() const { @@ -877,14 +881,23 @@ int64_t DiffractionExperiment::GetSummation() const { } int64_t DiffractionExperiment::GetFPGASummation() const { - if (IsCPUSummation()) + const int64_t n = GetSummation(); + if (cpu_summation) return 1; - return GetSummation(); + for (int64_t d = std::min(n, MAX_FPGA_SUMMATION); d > 1; d--) + if (n % d == 0) + return d; + return 1; +} + +int64_t DiffractionExperiment::GetHostSummation() const { + return GetSummation() / GetFPGASummation(); } int64_t DiffractionExperiment::GetByteDepthFPGA() const { + // Summed on the card as well: 32-bit, the host adds to it if (IsCPUSummation()) - return 2; + return (GetFPGASummation() > 1) ? 4 : 2; return GetByteDepthImage(); } @@ -1094,8 +1107,8 @@ float DiffractionExperiment::GetPhotonEnergyForConversion_keV() const { return GetIncidentEnergy_keV(); } -DiffractionExperiment &DiffractionExperiment::InternalPacketGeneratorImages(int64_t input) { - detector_settings.InternalGeneratorImages(input); +DiffractionExperiment &DiffractionExperiment::InternalPacketGeneratorImages(int64_t input, int64_t max_images) { + detector_settings.InternalGeneratorImages(input, max_images); return *this; } @@ -1634,11 +1647,7 @@ DiffractionExperiment &DiffractionExperiment::ApplyPixelMask(bool input) { } bool DiffractionExperiment::IsCPUSummation() const { - if (summation == 1) - return false; - if (summation >= MAX_FPGA_SUMMATION) - return true; - return cpu_summation; + return GetHostSummation() > 1; } DiffractionExperiment & DiffractionExperiment::ElectronSource(bool input) { diff --git a/common/DiffractionExperiment.h b/common/DiffractionExperiment.h index e8e689642..197455730 100644 --- a/common/DiffractionExperiment.h +++ b/common/DiffractionExperiment.h @@ -119,7 +119,8 @@ public: DiffractionExperiment& ZMQPreviewPeriod(const std::optional &input); DiffractionExperiment& UseInternalPacketGenerator(bool input); - DiffractionExperiment& InternalPacketGeneratorImages(int64_t input); + DiffractionExperiment& InternalPacketGeneratorImages(int64_t input, + int64_t max_images = DetectorSettings::DefaultMaxInternalGeneratorImages); DiffractionExperiment& MaskModuleEdges(bool input); DiffractionExperiment& MaskChipEdges(bool input); @@ -304,6 +305,7 @@ public: int64_t GetStorageCellStart() const; int64_t GetMaxSpotCount() const; + std::optional GetMaxSpotCountGiven() const; // as the user gave it, unset where not float GetPixelSize_mm() const; std::string GetSourceName() const; @@ -355,7 +357,10 @@ public: std::optional GetSpaceGroupNumber() const; bool GetSaveCalibration() const; int64_t GetSummation() const; + // The card sums the largest divisor of the summation up to MAX_FPGA_SUMMATION, the host the card's images of + // one image: GetSummation() = GetFPGASummation() * GetHostSummation() int64_t GetFPGASummation() const; + int64_t GetHostSummation() const; std::string GetSampleName() const; float GetIncidentEnergy_keV() const; float GetWavelength_A() const; @@ -422,7 +427,9 @@ public: [[nodiscard]] bool IsMaskPixelsWithoutG0() const; [[nodiscard]] bool IsApplyPixelMask() const; + // All of the summation on the host (tests) DiffractionExperiment& CPUSummation(bool input); + // The host sums part of the image (GetHostSummation() > 1) [[nodiscard]] bool IsCPUSummation() const; [[nodiscard]] FileWriterFormat GetFileWriterFormat() const; diff --git a/common/FFTWPlannerLock.h b/common/FFTWPlannerLock.h deleted file mode 100644 index a432b7971..000000000 --- a/common/FFTWPlannerLock.h +++ /dev/null @@ -1,14 +0,0 @@ -// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute -// SPDX-License-Identifier: GPL-3.0-only - -#pragma once - -#include - -// FFTW's planner - every fftwf_plan_* and fftwf_destroy_plan call - shares global state and is not -// thread-safe; executing a plan is. So every piece of code that makes or destroys a plan takes this -// one lock, not a lock of its own: two private locks do not stop two planners running at once. -inline std::mutex &FFTWPlannerMutex() { - static std::mutex m; - return m; -} diff --git a/common/GitInfoStamp.cmake b/common/GitInfoStamp.cmake index 148993a98..fdd7395c1 100644 --- a/common/GitInfoStamp.cmake +++ b/common/GitInfoStamp.cmake @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only + # Stamps GitInfo.cpp with the SHA of HEAD as it is NOW. Run with `cmake -P` on every build (see the # JFJochGitInfo target in CMakeLists.txt here), so the hash a binary reports is the commit it was # built from, not the one the tree held when it was last configured - a configure-time stamp once diff --git a/common/IndexingSettings.cpp b/common/IndexingSettings.cpp index 62f79b8e7..c9fe61982 100644 --- a/common/IndexingSettings.cpp +++ b/common/IndexingSettings.cpp @@ -233,3 +233,12 @@ IndexingSettings &IndexingSettings::MaxExtraLattices(int64_t input) { max_extra_lattices = input; return *this; } + +IndexingSettings &IndexingSettings::FixedLatticeSystem(const std::optional &input) { + fixed_lattice_system = input; + return *this; +} + +std::optional IndexingSettings::GetFixedLatticeSystem() const { + return fixed_lattice_system; +} diff --git a/common/IndexingSettings.h b/common/IndexingSettings.h index 6a5e9c508..8c945598c 100644 --- a/common/IndexingSettings.h +++ b/common/IndexingSettings.h @@ -4,6 +4,9 @@ #pragma once #include +#include + +namespace gemmi { enum class CrystalSystem : unsigned char; } // gemmi/symmetry.hpp // Upper bound accepted by IndexingSettings::RefineThreads. Callers deriving a thread count from the // machine must clamp to it - on a big host -N/2 exceeds it and the setter throws. @@ -69,6 +72,7 @@ private: // spot positions place to ~0.1 %, so on a small cell a genuinely orthorhombic crystal is // integrated with a = b imposed and nothing downstream can recover from it. bool lattice_class_demoted = false; + std::optional fixed_lattice_system; bool enable_rotation_indexing = false; @@ -94,6 +98,8 @@ public: IndexingSettings& BlockingBehavior(bool input); IndexingSettings& MaxExtraLattices(int64_t input); IndexingSettings& LatticeClassDemoted(bool input); + // The crystal system a cell given with -C (and no -S) fixes: the lattice is indexed in it, never above or below. + IndexingSettings& FixedLatticeSystem(const std::optional &input); [[nodiscard]] int64_t GetViableCellMinSpots() const; [[nodiscard]] IndexingAlgorithmEnum GetAlgorithm() const; @@ -114,4 +120,6 @@ public: [[nodiscard]] bool GetBlockingBehavior() const; [[nodiscard]] int64_t GetMaxExtraLattices() const; [[nodiscard]] bool GetLatticeClassDemoted() const; + // By value: DiffractionExperiment::GetIndexingSettings() returns a copy, which a reference would outlive. + [[nodiscard]] std::optional GetFixedLatticeSystem() const; }; diff --git a/common/JFJochMessages.h b/common/JFJochMessages.h index 9498895dc..cc3154d7f 100644 --- a/common/JFJochMessages.h +++ b/common/JFJochMessages.h @@ -499,6 +499,9 @@ struct EndMessage { std::vector spot_count_low_res; std::vector spot_count_indexed; std::vector image_indexed; + // 1 where the image's observations reached the merged data, 0 where none did (MergeStatistics::image_merged); + // empty where no merge ran. Offline (rugnux) only. + std::vector image_merged; std::vector indexed_lattice_count; std::vector v_bkg_estimate; // Per-image spindle_blind_fraction; NaN where the frame had no value. NaN is the CANNOT-SAY diff --git a/common/JFJochReceiverPlots.cpp b/common/JFJochReceiverPlots.cpp index 963970aca..5e289c503 100644 --- a/common/JFJochReceiverPlots.cpp +++ b/common/JFJochReceiverPlots.cpp @@ -88,6 +88,7 @@ void JFJochReceiverPlots::ClearVectors_i(size_t r) { bkg_estimate.Clear(r); spindle_blind_fraction.Clear(r); ice_ring_score.Clear(r); + image_merged.Clear(r); spot_count.Clear(r); spot_count_low_res.Clear(r); spot_count_indexed.Clear(r); @@ -230,6 +231,11 @@ void JFJochReceiverPlots::Add(const DataMessage &msg, const AzimuthalIntegration } } +void JFJochReceiverPlots::SetImageMerged(const std::vector &merged) { + for (size_t i = 0; i < merged.size(); ++i) + image_merged.AddElement(static_cast(i), static_cast(merged[i])); +} + void JFJochReceiverPlots::AddEmptyImage(const DataMessage &msg) { image_collection_efficiency.AddElement(msg.number, msg.image_collection_efficiency); } @@ -301,6 +307,9 @@ MultiLinePlot JFJochReceiverPlots::GetPlots(const PlotRequest &request) { case PlotType::IceRingScore: ret = ice_ring_score.GetMeanPlot(nbins, start, incr, request.fill_value); break; + case PlotType::ImageMerged: + ret = image_merged.GetMeanPlot(nbins, start, incr, request.fill_value); + break; case PlotType::ResolutionEstimate: ret = resolution_estimate.GetMeanPlot(nbins, start, incr, request.fill_value); break; @@ -608,6 +617,9 @@ void JFJochReceiverPlots::GetPlotRaw(std::vector &v, PlotType type, const case PlotType::IceRingScore: v = ice_ring_score.ExportArray(); break; + case PlotType::ImageMerged: + v = image_merged.ExportArray(); + break; case PlotType::ResolutionEstimate: v = resolution_estimate.ExportArray(); break; diff --git a/common/JFJochReceiverPlots.h b/common/JFJochReceiverPlots.h index 1b5f65fdf..9f4f5eaca 100644 --- a/common/JFJochReceiverPlots.h +++ b/common/JFJochReceiverPlots.h @@ -73,6 +73,7 @@ class JFJochReceiverPlots { StatusVector image_scale_factor; StatusVector image_scale_cc; StatusVector compression_ratio; + StatusVector image_merged; // known once the run's merge is made (SetImageMerged) // StatusVector objects are fully thread-safe (protected by internal mutex) // It is OK to have concurrent access to StatusVector @@ -118,6 +119,8 @@ public: void Clear(); void Add(const DataMessage& msg, const AzimuthalIntegrationProfile &profile); + // Per image, whether its observations reached the merge (MergeStatistics::image_merged). + void SetImageMerged(const std::vector &merged); void AddEmptyImage(const DataMessage& msg); MultiLinePlot GetPlots(const PlotRequest& request); diff --git a/common/Logger.cpp b/common/Logger.cpp index cccee71f4..52c95c625 100644 --- a/common/Logger.cpp +++ b/common/Logger.cpp @@ -53,9 +53,7 @@ Logger::Logger(const std::string &service_name, const std::string &file_name) { #ifdef JFJOCH_USE_CUDA variant += "C"; #endif -#ifdef JFJOCH_USE_FFTW variant += "F"; -#endif std::vector sinks; sinks.push_back(std::make_shared()); diff --git a/common/ModuleSummation.cpp b/common/ModuleSummation.cpp index 50866ae77..b05310401 100644 --- a/common/ModuleSummation.cpp +++ b/common/ModuleSummation.cpp @@ -17,6 +17,13 @@ ModuleSummation::ModuleSummation(bool in_pixel_signed, uint32_t in_fpga_depth_by throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "FPGA byte depth can be only 1, 2 or 4"); output = std::make_unique(); + Clear(); +} + +void ModuleSummation::Clear() { + std::unique_lock ul(module_summation_mutex); + first = true; + is_empty = false; memset(output.get(), 0, sizeof(DeviceOutput)); } @@ -69,6 +76,7 @@ void ModuleSummation::AddFPGAOutput(const DeviceOutput &input, const std::option output->module_statistics.err_pixels += input.module_statistics.err_pixels; output->module_statistics.saturated_pixels += input.module_statistics.saturated_pixels; output->module_statistics.packet_count += input.module_statistics.packet_count; + output->module_statistics.pixel_sum += input.module_statistics.pixel_sum; } // The only function not handled is spot finding diff --git a/common/ModuleSummation.h b/common/ModuleSummation.h index 31d63b178..cf59a3ec3 100644 --- a/common/ModuleSummation.h +++ b/common/ModuleSummation.h @@ -23,6 +23,8 @@ public: void AddFPGAOutput(const DeviceOutput& input, const std::optional &in_fpga_depth_bytes = {}); void AddEmptyOutput(); + // Empty, for the next image + void Clear(); [[nodiscard]] const DeviceOutput& GetOutput() const; [[nodiscard]] DeviceOutput& GetOutput(); diff --git a/common/Plot.h b/common/Plot.h index 3ae807f5e..a6cb66917 100644 --- a/common/Plot.h +++ b/common/Plot.h @@ -15,7 +15,7 @@ enum class PlotType { ROISum, ROIMean, ROIMaxCount, ROIPixels, ROIWeightedX, ROIWeightedY, PacketsReceived, MaxValue, ResolutionEstimate, ProfileRadius, Mosaicity, BFactor, PixelSum, StrongPixels, RefinementBeamX, RefinementBeamY, ImageProcessingTime, IntegratedReflections, - ImageScaleFactor, ImageScaleCC, CompressionRatio, IndexingLatticeCount, IceRingScore + ImageScaleFactor, ImageScaleCC, CompressionRatio, IndexingLatticeCount, IceRingScore, ImageMerged }; enum class PlotAzintUnit { diff --git a/common/ROIDefinition.cpp b/common/ROIDefinition.cpp index 2e00abb69..7149bf53d 100644 --- a/common/ROIDefinition.cpp +++ b/common/ROIDefinition.cpp @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute +// SPDX-License-Identifier: GPL-3.0-only + // Copyright (2019-2024) Paul Scherrer Institute #include "ROIDefinition.h" diff --git a/common/ROIDefinition.h b/common/ROIDefinition.h index 0c197de05..53aa53897 100644 --- a/common/ROIDefinition.h +++ b/common/ROIDefinition.h @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute +// SPDX-License-Identifier: GPL-3.0-only + // Copyright (2019-2024) Paul Scherrer Institute #pragma once diff --git a/common/RawToConvertedGeometry.h b/common/RawToConvertedGeometry.h index a3a179f1f..21a997ca9 100644 --- a/common/RawToConvertedGeometry.h +++ b/common/RawToConvertedGeometry.h @@ -8,6 +8,18 @@ #include "Coord.h" #include "DiffractionExperiment.h" +// An assembled image back to raw module frames, the multipixels summed (SqueezeMultipixelsToModule) +template +void SqueezeToRawGeometry(const DiffractionExperiment &experiment, Td *destination, const Ts *source, + Ts min, Ts max, Td dest_min, Td dest_max) { + for (size_t module_number = 0; module_number < experiment.GetModulesNum(); module_number++) + SqueezeMultipixelsToModule(destination + module_number * RAW_MODULE_SIZE, source, + experiment.GetModuleSlowDirectionStep(module_number), min, max, + dest_min, dest_max, + experiment.GetModuleFastDirectionStep(module_number), + experiment.GetPixel0OfModuleConv(module_number)); +} + // Input coord is column + 1024 * (line + 512 * module) // Copies result over multipixel - can be used for example for mask calculation template diff --git a/common/RawToConvertedGeometryCore.h b/common/RawToConvertedGeometryCore.h index c7692f715..ca11dd33d 100644 --- a/common/RawToConvertedGeometryCore.h +++ b/common/RawToConvertedGeometryCore.h @@ -139,6 +139,56 @@ void TransferModuleAdjustMultipixels(Td *destination, const Ts *source, int64_t } } +// Inverse of TransferModuleAdjustMultipixels: each raw pixel of the module is the sum of the pixels its value was +// split over (2 for a multipixel, 4 at a chip corner), as the split conserves the count. A raw pixel is an error +// pixel where any of them is at or below min, saturated where any is at or above max or the sum reaches dest_max. +template +void SqueezeMultipixelsToModule(Td *destination, const Ts *source, int64_t slow_dir_step, Ts min, Ts max, + Td dest_min, Td dest_max, int64_t fast_dir_step = 1, int64_t offset_0 = 0) { + for (int64_t line = 0; line < RAW_MODULE_LINES; line++) { + int64_t y[2] = {line + ((line > 255) ? 2 : 0), -1}; + if (line == 255) + y[1] = 256; + else if (line == 256) + y[1] = 257; + + for (int64_t col = 0; col < RAW_MODULE_COLS; col++) { + const int64_t chip = col / 256, i = col % 256; + int64_t x[2] = {i + chip * 258, -1}; + if ((i == 255) && (chip < 3)) + x[1] = x[0] + 1; + else if ((i == 0) && (chip > 0)) + x[1] = x[0] - 1; + + int64_t sum = 0; + bool error = false, saturated = false; + for (int64_t yy: y) { + for (int64_t xx: x) { + if ((yy < 0) || (xx < 0)) + continue; + const Ts v = source[offset_0 + yy * slow_dir_step + xx * fast_dir_step]; + if (v <= min) + error = true; + else if (v >= max) + saturated = true; + else + sum += v; + } + } + + Td &out = destination[line * RAW_MODULE_COLS + col]; + if (error) + out = dest_min; + else if (saturated || (sum >= dest_max)) + out = dest_max; + else if (sum <= dest_min) + out = dest_min + 1; + else + out = static_cast(sum); + } + } +} + template void LineConvtToRaw(T *destination, const T *source, size_t fast_direction_step) { for (int chip = 0; chip < 4; chip++) { diff --git a/compression/CMakeLists.txt b/compression/CMakeLists.txt index 91ca775f0..a1d967ff5 100644 --- a/compression/CMakeLists.txt +++ b/compression/CMakeLists.txt @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2023 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only + ADD_LIBRARY(Compression STATIC lz4/lz4.c lz4/lz4.h diff --git a/detector_control/CMakeLists.txt b/detector_control/CMakeLists.txt index 1354cbb71..f686189b8 100644 --- a/detector_control/CMakeLists.txt +++ b/detector_control/CMakeLists.txt @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2023 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only + ADD_LIBRARY(JFJochDetector STATIC SLSDetectorWrapper.cpp SLSDetectorWrapper.h DectrisSimplonClient.cpp DectrisSimplonClient.h diff --git a/docker/build_images.sh b/docker/build_images.sh index d823bb75e..97a6bfe39 100755 --- a/docker/build_images.sh +++ b/docker/build_images.sh @@ -1,4 +1,6 @@ #!/usr/bin/env bash +# SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only # Build (and optionally push) the jungfraujoch build-environment images, in parallel. # # Each docker//Dockerfile is a *self-contained build environment* (toolchain, static Qt, diff --git a/docker/build_in_rocky9.sh b/docker/build_in_rocky9.sh index 6f02a7a9d..698affaac 100755 --- a/docker/build_in_rocky9.sh +++ b/docker/build_in_rocky9.sh @@ -1,4 +1,6 @@ #!/usr/bin/env bash +# SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only # Manually build the viewer inside one of the build-environment images and inspect its runtime .so # deps -- the quick way to confirm the static-libdbus + glib-off changes actually dropped the # dbus/systemd/glib/selinux tail. Defaults to the rocky9 image built by build_images.sh. diff --git a/docker/common/build-dbus.sh b/docker/common/build-dbus.sh index 481e52609..a4b989228 100755 --- a/docker/common/build-dbus.sh +++ b/docker/common/build-dbus.sh @@ -1,4 +1,6 @@ #!/usr/bin/env bash +# SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only # Static libdbus, so the viewer links D-Bus in rather than pulling libdbus-1.so.3 -- and with it # libsystemd and libselinux -- at runtime. The viewer is a pure session-bus client, so the daemon-side # systemd/selinux features are off; built -fPIC so the archive links into Qt's PIE tools. diff --git a/docker/common/build-openssl.sh b/docker/common/build-openssl.sh index 756114d12..90fc7e837 100755 --- a/docker/common/build-openssl.sh +++ b/docker/common/build-openssl.sh @@ -1,4 +1,6 @@ #!/usr/bin/env bash +# SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only # Static OpenSSL into /opt/openssl-$OPENSSL_VERSION. # # Shared by all four build images (docker/*/Dockerfile). The build context is docker/, so each diff --git a/docker/common/build-qt.sh b/docker/common/build-qt.sh index 9f20b4ee6..0ced1b47a 100755 --- a/docker/common/build-qt.sh +++ b/docker/common/build-qt.sh @@ -1,4 +1,6 @@ #!/usr/bin/env bash +# SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only # Static Qt 6 (Core, Gui, Widgets, Charts, DBus) into $QT_PREFIX. # # Shared by all four build images (docker/*/Dockerfile). The build context is docker/, so each diff --git a/docker/common/install-cmake.sh b/docker/common/install-cmake.sh index efca13b61..6c9cedd6a 100755 --- a/docker/common/install-cmake.sh +++ b/docker/common/install-cmake.sh @@ -1,4 +1,6 @@ #!/usr/bin/env bash +# SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only # CMake, pinned, from Kitware's own download host. # # Shared by all four build images (docker/*/Dockerfile). The build context is docker/, so each diff --git a/docker/common/install-eigen.sh b/docker/common/install-eigen.sh index e0d3d512f..a79f98441 100755 --- a/docker/common/install-eigen.sh +++ b/docker/common/install-eigen.sh @@ -1,4 +1,6 @@ #!/usr/bin/env bash +# SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only # Eigen, the external find_package(Eigen3 3.4) dependency, into /opt/eigen-3.4. Header-only; # 3.4.x is required because Eigen's same-major-version rule rejects 5.x. # diff --git a/docker/common/install-ninja.sh b/docker/common/install-ninja.sh index 2582ce376..89ca4a8e7 100755 --- a/docker/common/install-ninja.sh +++ b/docker/common/install-ninja.sh @@ -1,4 +1,6 @@ #!/usr/bin/env bash +# SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only # Ninja, pinned, from the upstream release binary. # # Shared by all four build images (docker/*/Dockerfile). The build context is docker/, so each diff --git a/docker/ubuntu2404/Dockerfile b/docker/ubuntu2404/Dockerfile index c84fc9d38..046e6f304 100644 --- a/docker/ubuntu2404/Dockerfile +++ b/docker/ubuntu2404/Dockerfile @@ -162,7 +162,7 @@ ENV CMAKE_PREFIX_PATH=/opt/qt-${QT_VERSION}-static:/opt/dbus-${DBUS_VERSION}-sta # qemu-user-static HDF5 runs two try_run() probes (config/ConfigureChecks.cmake) that # need CMAKE_CROSSCOMPILING_EMULATOR. libzmq guards its own run-checks # with NOT CMAKE_CROSSCOMPILING; Ceres, libtiff, zstd, Catch2, spdlog, -# cpp-httplib, FFTW and ffbidx have no run-checks at all. +# cpp-httplib and ffbidx have no run-checks at all. # binutils-aarch64-linux-gnu reading aarch64 ELF on the build host. # :arm64 libraries ZLIB is one of the project's two external dependencies (Eigen, the # other, is header-only and installed above); OpenSSL is needed by the diff --git a/docker/ubuntu2404/aarch64-sbsa.cmake b/docker/ubuntu2404/aarch64-sbsa.cmake index 5c94e3d8c..cd4b90095 100644 --- a/docker/ubuntu2404/aarch64-sbsa.cmake +++ b/docker/ubuntu2404/aarch64-sbsa.cmake @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute +# SPDX-License-Identifier: GPL-3.0-only + # Cross toolchain: x86_64 Ubuntu 24.04 build host -> aarch64 arm64 SBSA. # Covers DGX Spark (GB10, sm_121) and Grace Hopper (GH200, sm_90) alike -- same host architecture, # only the CUDA fatbin differs, and that is chosen with -DJFJOCH_CUDA_ARCHITECTURES. @@ -6,7 +9,7 @@ # /usr/lib/aarch64-linux-gnu and headers are shared in /usr/include, so CMAKE_LIBRARY_ARCHITECTURE # is what steers find_library() rather than CMAKE_SYSROOT. set(CMAKE_SYSTEM_NAME Linux) -set(CMAKE_SYSTEM_PROCESSOR aarch64) # also selects FFTW's NEON codelets in CMakeLists.txt +set(CMAKE_SYSTEM_PROCESSOR aarch64) set(CMAKE_C_COMPILER aarch64-linux-gnu-gcc) set(CMAKE_CXX_COMPILER aarch64-linux-gnu-g++) diff --git a/docs/ACKNOWLEDGEMENT.md b/docs/ACKNOWLEDGEMENT.md index 0a8ddab27..2910d46d3 100644 --- a/docs/ACKNOWLEDGEMENT.md +++ b/docs/ACKNOWLEDGEMENT.md @@ -598,12 +598,22 @@ Cryst. A34, 791-809 [doi:10.1107/S0567739478001618](https://doi.org/10.1107/S056 memory BFGS method for large scale optimization" (1989), Math. Program. 45, 503-528 [doi:10.1007/BF01589116](https://doi.org/10.1007/BF01589116); its two-loop recursion: J. Nocedal, "Updating quasi-Newton matrices with limited storage" (1980), Math. Comp. 35, 773-782 -[doi:10.1090/S0025-5718-1980-0572855-7](https://doi.org/10.1090/S0025-5718-1980-0572855-7). The -initial inverse Hessian is rescaled at each iteration by the latest pair, the self-scaling of -S. S. Oren and D. G. Luenberger, "Self-scaling variable metric (SSVM) algorithms. Part I" (1974), -Management Sci. 20, 845-862 [doi:10.1287/mnsc.20.5.845](https://doi.org/10.1287/mnsc.20.5.845), and -D. F. Shanno and K.-H. Phua, "Matrix conditioning and nonlinear optimization" (1978), Math. Program. -14, 149-160 [doi:10.1007/BF01588962](https://doi.org/10.1007/BF01588962). +[doi:10.1090/S0025-5718-1980-0572855-7](https://doi.org/10.1090/S0025-5718-1980-0572855-7). Its +initial inverse Hessian is the target's sparse normal matrix - the X-ray target's curvature per atom +on the diagonal and the restraints' Gauss-Newton matrix in full - as REFMAC refines on its normal +matrix (Murshudov, Vagin & Dodson 1997, above), solved by conjugate gradients: M. R. Hestenes and +E. Stiefel, "Methods of conjugate gradients for solving linear systems" (1952), J. Res. Natl. Bur. +Stand. 49, 409-436 [doi:10.6028/jres.049.044](https://doi.org/10.6028/jres.049.044), each residual +made orthogonal again to the earlier ones against the loss of orthogonality in rounding described by +C. C. Paige, "Error analysis of the Lanczos algorithm for tridiagonalizing a symmetric matrix" (1976), +J. Inst. Maths Applics 18, 341-349 (DOI not verified here), and A. Greenbaum, "Behavior of +slightly perturbed Lanczos and conjugate-gradient recurrences" (1989), Linear Algebra Appl. 113, 7-63 +[doi:10.1016/0024-3795(89)90285-1](https://doi.org/10.1016/0024-3795(89)90285-1). Each atom's +diagonal is raised to hold its step within the step bound, a trust region per atom after the damping +of K. Levenberg, "A method for the solution of certain non-linear problems in least squares" (1944), +Q. Appl. Math. 2, 164-168 [doi:10.1090/qam/10666](https://doi.org/10.1090/qam/10666), and D. W. +Marquardt, "An algorithm for least-squares estimation of nonlinear parameters" (1963), J. Soc. Ind. +Appl. Math. 11, 431-441 [doi:10.1137/0111030](https://doi.org/10.1137/0111030). **Geometry restraints** — those of the CCP4 Monomer Library, a subset of which rugnux carries (see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md)). A. A. Vagin, R. A. Steiner, A. A. Lebedev, @@ -642,6 +652,16 @@ structure refinement with phenix.refine" (2012), Acta Cryst. D68, 352-367 A. T. Brünger, "Free R value: a novel statistical quantity for assessing the accuracy of crystal structures" (1992), Nature 355, 472-475 [doi:10.1038/355472a0](https://doi.org/10.1038/355472a0). +**What the free set decides** — the free set decides the weights, the displacement model and whether the model +as given is kept, and only where its two measures agree: a candidate is taken where its free $-\ln L$ is lower and its R-free not higher +than the incumbent's by more than the paired standard error of the difference; every other step of the +refinement is taken on the work-set target. The approach of deciding on more than one free measure, and of keeping the +free set for few choices, is PDB-REDO's: R. P. Joosten, K. Joosten, G. N. Murshudov and A. Perrakis, +"PDB_REDO: constructive validation, more than just looking for errors" (2012), Acta Cryst. D68, 484-496 +[doi:10.1107/S0907444911054515](https://doi.org/10.1107/S0907444911054515), and R. P. Joosten, F. Long, +G. N. Murshudov and A. Perrakis, "The PDB_REDO server for macromolecular structure model optimization" (2014), +IUCrJ 1, 213-220 [doi:10.1107/S2052252514009324](https://doi.org/10.1107/S2052252514009324). + **Robust scaling of the model** — the overall scale and anisotropic B are fitted by iteratively reweighted least squares with the pseudo-Huber weight. P. J. Huber, "Robust estimation of a location parameter" (1964), Ann. Math. Statist. 35, 73-101 @@ -682,7 +702,29 @@ SHELXL" (2015), Acta Cryst. C71, 3-8 [doi:10.1107/S2053229614024218](https://doi.org/10.1107/S2053229614024218) documents them. Which displacement model a refinement keeps is decided on the free set rather than by a rule of resolution: E. A. Merritt, "To B or not to B: a question of resolution?" (2012), Acta Cryst. D68, -468-477 [doi:10.1107/S0907444911028320](https://doi.org/10.1107/S0907444911028320). +468-477 [doi:10.1107/S0907444911028320](https://doi.org/10.1107/S0907444911028320). Between a model +with more displacement parameters and one with fewer, the R-factor ratio test of W. C. Hamilton, "Significance +tests on the crystallographic R factor" (1965), Acta Cryst. 18, 502-510 (DOI not verified), decides first, +over a range of restraint weights as Merritt (2012) applies it, with PDB-REDO's (Joosten et al. 2012, above) +95%/30% rule; its F point is from E. Paulson, +"An approximate normalization of the analysis of variance distribution" (1942), Ann. Math. Statist. 13, +233-235 [doi:10.1214/aoms/1177731608](https://doi.org/10.1214/aoms/1177731608). + +**Population and crossover** — the members' refinement on blurred data is a continuation (homotopy) on the +resolution, the deformation of the landscape of L. Piela, J. Kostrowicki and H. A. Scheraga, "On the +multiple-minima problem in the conformational analysis of molecules: deformation of the potential energy +hypersurface by the diffusion equation method" (1989), J. Phys. Chem. 93, 3339-3346 +[doi:10.1021/j100345a090](https://doi.org/10.1021/j100345a090), applied as the "low resolution first" of +A. Jack and M. Levitt, "Refinement of large structures by simultaneous minimization of energy and R factor" +(1978), Acta Cryst. A34, 931-935 [doi:10.1107/S0567739478001904](https://doi.org/10.1107/S0567739478001904). +The kicked members and the map averaged over them follow J. Praznikar, P. V. Afonine, G. Guncar, P. D. Adams +and D. Turk, "Averaged kick maps: less noise, more signal... and probably less bias" (2009), Acta Cryst. D65, +921-931 [doi:10.1107/S0907444909021933](https://doi.org/10.1107/S0907444909021933). Taking each residue from +the member that fits best is the combination of J. C. Nwachukwu, M. R. Southern, J. R. Kiefer, P. V. Afonine, +P. D. Adams, T. C. Terwilliger and K. W. Nettles, "Improved crystallographic +structures using extensive combinatorial refinement" (2013), Structure 21, 1923-1930 +[doi:10.1016/j.str.2013.07.025](https://doi.org/10.1016/j.str.2013.07.025), made on one map inside the +refinement rather than offline on whole models. **NCS restraints** — copies found by sequence alignment with REFMAC5's criterion (Murshudov et al. 2011, above) and restrained locally on pairs of corresponding interatomic distances under the @@ -712,6 +754,18 @@ subspace its site symmetry leaves unchanged. R. W. Grosse-Kunstleve and P. D. Ad deriving crystallographic space-group information. II. Treatment of special positions" (2002), Acta Cryst. A58, 60-65 [doi:10.1107/S0108767301016658](https://doi.org/10.1107/S0108767301016658). +**Side chains as a discrete field** — the rotamers of the side chains searched as a combinatorial problem rather +than by a gradient, with the likelihood of the working reflections as the energy and iterated conditional modes +(each residue in turn put in its best state given the others) as the solver; small residues first and arginine +last, as PDB-REDO rebuilds. J. Desmet, M. De Maeyer, B. Hazes and I. Lasters, "The dead-end elimination theorem +and its use in protein side-chain positioning" (1992), Nature 356, 539-542 +[doi:10.1038/356539a0](https://doi.org/10.1038/356539a0); J. Besag, "On the statistical analysis of dirty +pictures" (1986), J. R. Statist. Soc. B48, 259-279 +[doi:10.1111/j.2517-6161.1986.tb01412.x](https://doi.org/10.1111/j.2517-6161.1986.tb01412.x); R. P. Joosten, +K. Joosten, S. X. Cohen, G. Vriend and A. Perrakis, "Automatic rebuilding and optimization of crystallographic +structures in the Protein Data Bank" (2011), Bioinformatics 27, 3392-3398 +[doi:10.1093/bioinformatics/btr590](https://doi.org/10.1093/bioinformatics/btr590). + ### Solvent, ions and unmodelled density **Unmodelled density** — the connected regions of the difference map above a cutoff, found by flood @@ -803,10 +857,12 @@ jackknife" (1979), Ann. Statist. 7, 1-26 [doi:10.1214/aos/1176344552](https://doi.org/10.1214/aos/1176344552). Its draws are Poisson weights hashed with the SplitMix64 finaliser of G. L. Steele Jr., D. Lea and C. H. Flood, "Fast splittable pseudorandom number generators" (2014), Proc. OOPSLA 2014, 453-472 -[doi:10.1145/2660193.2660195](https://doi.org/10.1145/2660193.2660195). +[doi:10.1145/2660193.2660195](https://doi.org/10.1145/2660193.2660195). The same finaliser chooses the images rugnux live +stills analyses with `stills_downsample`. **Error-free floating-point arithmetic** — the single-precision exp shared between the CPU and an -Apple GPU (`BraggExp.h`): the argument reduction of W. J. Cody and W. Waite, "Software Manual for the +Apple GPU (`BraggExp.h`) and the double-float sums of the refinement's Gauss-Newton products on the GPU +(`RefinementNewtonGPU.cu`): the argument reduction of W. J. Cody and W. Waite, "Software Manual for the Elementary Functions" (1980), Prentice-Hall; the exact product (with Veltkamp's split) and Fast2Sum of T. J. Dekker, "A floating-point technique for extending the available precision" (1971), Numer. Math. 18, 224-242; and the 2Sum of D. E. Knuth, "The Art of Computer Programming, Vol. 2: diff --git a/docs/CBOR.md b/docs/CBOR.md index 4db4e409f..4c81ef0ca 100644 --- a/docs/CBOR.md +++ b/docs/CBOR.md @@ -100,7 +100,7 @@ There are minor differences at the moment: | - attenuator_transmission | float | Attenuator transmission \[\] | | | - total_flux | float | Total flux \[ph/s\] | | | - space_group_number | uint64 | Space group number | | -| - summation_mode | string | Summation mode (internal\|fpga\|cpu) | | +| - summation_mode | string | Summation mode (none\|fpga\|cpu\|hybrid: the card and the host both sum) | | | - overwrite | bool | Overwrite existing HDF5 files | | | - file_format | int | File writer format: 0 = only data files, 1 = NXmx legacy external links, 2 = NXmx VDS, 3 = NXmx integrated, 4 = CBF (retired; rejected), 5 = TIFF (retired; rejected), 6 = no file written | | | - roi | Array(object) | ROI configurations; each has a `name` (the key of its `roi_integrals` entry and of `/entry/roi/` in HDF5) and is one of: | | @@ -305,6 +305,7 @@ Every scalar of the image message is optional: a quantity that was not computed | spot_count_low_res | Array(int32) | Per-image number of low-resolution spots | | | spot_count_indexed | Array(int32) | Per-image number of spots fitting indexing solution | | | image_indexed | Array(uint8) | Per-image indexing result; 0 = not indexed, nonzero = indexed | | +| image_merged | Array(uint8) | Per-image merge result; 1 = the image's observations reached the merged data, 0 = none did. Empty where no merge ran (rugnux) | | | v_bkg_estimate | Array(float) | Per-image background estimate | | | v_spindle_blind_fraction | Array(float) | Per-image spindle_blind_fraction; NaN where the frame had no value (which is "cannot say", not zero) | | | ice_ring_score | Array(float) | Per-image strongest ice-ring intensity over the smooth radial background (1 = no ice) | | @@ -330,7 +331,7 @@ Every scalar of the image message is optional: a quantity that was not computed | placed_model | object (optional) | Atomic model placed against the data, written as `_model.cif` and `_model.pdb`. `name` (string), `unit_cell` (object, as above), `space_group_name` (the data's, gemmi extended H-M), `model_space_group_name` (the coordinates'), then one array per atom: `model_number`, `seq_num`, `charge` (int32), `chain`, `residue_name`, `atom_name`, `element` (Array(string)), `icode` (uint8, space where none), `het_flag` (uint8, `A`, `H` or 0 where unknown), `altloc` (uint8, 0 where none), `x`, `y`, `z` (double, Angstrom), `b_iso`, `occupancy` (float), `aniso` (float, 6 per atom: U11 U22 U33 U12 U13 U23; empty where no atom has one), `subchain`, `entity_id` (Array(string), mmCIF label_asym_id / label_entity_id), `label_seq` (int32, label_seq_id, INT32_MIN where none) - these three optional; `metadata_mmcif` (gzipped string, optional, see [Notes on gzipped text](#notes-on-gzipped-text)): the input model's metadata (entities, sequences, references, authors, software, secondary structure) as mmCIF categories without coordinates, parsed by the writer with gemmi | | | refined_model | object (optional) | The placed model after refinement, written as `_refined_model.cif` and `_refined_model.pdb`; same layout as `placed_model` | | | refined_map_coefficients | object (optional) | Map coefficients of the refined model, written as `_refined_maps.mtz`. An MTZ table (layout below) | | -| blobs | object (optional) | Unexplained blobs of the refined model's mFo-DFc map, strongest first, written as `_blobs.json`. One array per field, one entry per blob: `kind` (Array(string): `WATER`, `ION`, `LIGAND`, `MODEL_ERROR`, `UNASSIGNED`), `x`, `y`, `z` (double, centroid, Angstrom), `peak_sigma` (double, map rms), `volume` (double, Angstrom^3), `score` (double, sigma Angstrom^3), `nearest_atom` (Array(string)), `nearest_atom_distance` (double, Angstrom), `polar_contacts`, `metal_contacts` (int32), `anomalous_sigma` (double, 0 where there is no anomalous map) | | +| blobs | object (optional) | Unexplained blobs of the refined model's mFo-DFc map, strongest first, written as `_blobs.json`. One array per field, one entry per blob: `kind` (Array(string): `WATER`, `ION`, `LIGAND`, `MODEL_ERROR`, `UNASSIGNED`), `x`, `y`, `z` (double, centroid, Angstrom), `peak_sigma` (double, map rms), `volume` (double, Angstrom^3), `score` (double, sigma Angstrom^3), `nearest_atom` (Array(string)), `nearest_atom_distance` (double, Angstrom), `polar_contacts`, `metal_contacts` (int32), `anomalous_sigma` (double, the anomalous difference map's peak height within 1 Angstrom of the blob's peak in its rms, NaN where there is no anomalous map) | | | report | gzipped string (optional) | The in-broker analysis run's results report, written as `_report.txt`: the text `rugnux` writes as its own `_report.txt` (see [RUGNUX_REPORT](RUGNUX_REPORT.md)) | | End-message vector fields are optional. When present, they provide master-file summary data so readers can inspect scan-level and per-image analysis results without opening every linked data file. Missing optional per-image values are encoded by the producer as zero unless otherwise noted. diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index ba8bae5e2..363979836 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,6 +1,21 @@ # Changelog ## 1.0.0 +### 1.0.0-rc.187 + +* Rugnux: Refinement several times faster, one protocol on the CPU and the GPU, parts of it on the Apple GPU; its random draws are the same on every platform. +* Rugnux: Refinement follows common practice: the free set decides only the restraint weights and the displacement model (isotropic, TLS or anisotropic, by Hamilton's test), everything else is decided on the working set; lower R-free for placed and predicted models. +* Rugnux: Restraint dictionaries via `--restraints` (or among the inputs) and more built-in ligands; a model whose space group is a subgroup of the data's is refined in its own group; reflections plus a model select `--mode refine` on their own. +* Rugnux: `-C` fixes the crystal system on the axes as typed; `-S` alone fixes the space group only, the cell is still found and reduced; a space group or cell stored in the input file is ignored, with a line in the log. +* Rugnux: More reliable multi-sweep merging; `--mode scale` merges several stills runs as one; `_plot.txt` and the report name each input; a second crystal form is reported for stills given a cell. +* jfjoch_broker (experimental): Live Rugnux on FPGA detectors (JUNGFRAU) takes the same path as a DECTRIS stream, rotation and serial alike, model step included, with analysis threads per GPU; frames waiting for the analysis can be viewed; no host stage drops a frame - a source faster than the analysis is held at the card. +* jfjoch_broker: Summation of more than 256 frames per image is split between the card and the host (`summation_mode` is then `hybrid`), and live Rugnux runs on such collections; pedestal runs take a receiver of their own. +* jfjoch_broker (experimental): `stills_downsample` analyses 1 of every N serial images (chosen by a hash; the first 2000 all; the others written without analysis; reset to 1 by `/initialize`); `max_spot_count` left out means 250 for per-image indexing and up to 1000 for live stills; the live status gives the merge before the model work, the fitted resolution and the anomalous peak height of each unexplained blob. +* jfjoch_broker: Without a `pcie` entry the broker runs on a mock of the card instead of the HLS simulation; its spot, ROI and azimuthal results are zero then. +* Web frontend: Redesigned Rugnux live page; Vite 8, TypeScript 6, Mol* 5.13 and dependency security updates. +* Tools: `jfjoch_fpga_stills_test` measures live stills on the cards with a stored dataset; `jfjoch_fpga_test` loses the HLS-simulation option. +* Other: FFTW no longer fetched or linked (the CPU FFT indexer keeps the name `FFTW`); PCIe driver now GPL-2.0-or-later and third-party notices complete; several crash fixes. + ### 1.0.0-rc.186 * jfjoch_broker (experimental): Live Rugnux covers serial collections from DECTRIS detectors; a rotation collection too large for the image buffer falls back to standard per-image processing with a warning, and a stream that ends without its end message finishes the collection instead of hanging it. diff --git a/docs/CPU_DATA_ANALYSIS.md b/docs/CPU_DATA_ANALYSIS.md index bfc7217c1..a35c12d3f 100644 --- a/docs/CPU_DATA_ANALYSIS.md +++ b/docs/CPU_DATA_ANALYSIS.md @@ -18,7 +18,7 @@ This document describes the crystallographic algorithms implemented in Jungfrauj 12. auxiliary statistics (Wilson plot, ⟨I/σ(I)⟩, CC1/2, CCref), 13. amplitude estimation (French–Wilson) and R-free test-set flagging, 14. optional model-based validation: rigid-body placement of a supplied model (molecular replacement where the rigid body does not place it, or for a predicted model), R-free against it, sigma_A-weighted 2mFo−DFc / mFo−DFc electron-density maps, and an anomalous difference map with the strongest anomalous sites named. -15. restrained refinement of the placed model (wherever a model is placed): rigid bodies and group B, then positions and B against a maximum-likelihood amplitude target with the dictionary's geometry, the X-ray weight chosen by R-free within geometry bounds, and the unexplained blobs of the refined difference map. +15. restrained refinement of the placed model (wherever a model is placed): rigid bodies and group B, then positions and B against a maximum-likelihood amplitude target with the dictionary's geometry, the X-ray weight and the displacement model chosen on the free set (free -ln L and R-free agreeing) within geometry bounds, every other step taken on the work-set target, and the unexplained blobs of the refined difference map. The reference is split into five parts, in pipeline order; the section numbers run continuously @@ -66,12 +66,14 @@ The methods draw on, and in places reimplement, solutions from: - H. F. Walker & P. Ni, "Anderson acceleration for fixed-point iterations", *SIAM J. Numer. Anal.* **49** (2011), 1715-1735, after D. G. Anderson, "Iterative procedures for nonlinear integral equations", *J. ACM* **12** (1965), 547-560 (the acceleration of the per-frame scaling loops, §10.6). - R. A. Fisher, "Frequency distribution of the values of the correlation coefficient in samples from an indefinitely large population", *Biometrika* **10** (1915), 507-521 (the z-transformation on which the correction surfaces' held-out half-set CC1/2 is compared). - R. C. Agarwal, "A new least-squares refinement technique based on the fast Fourier transform algorithm", *Acta Cryst.* **A34** (1978), 791-809 (the gradient of the refinement target, §15). -- N. S. Pannu & R. J. Read, "Improved structure refinement through maximum likelihood", *Acta Cryst.* **A52** (1996), 659-668, and G. N. Murshudov, A. A. Vagin & E. J. Dodson, "Refinement of macromolecular structures by the maximum-likelihood method", *Acta Cryst.* **D53** (1997), 240-255 (the maximum-likelihood amplitude target and the B restraints, §15). +- N. S. Pannu & R. J. Read, "Improved structure refinement through maximum likelihood", *Acta Cryst.* **A52** (1996), 659-668, and G. N. Murshudov, A. A. Vagin & E. J. Dodson, "Refinement of macromolecular structures by the maximum-likelihood method", *Acta Cryst.* **D53** (1997), 240-255 (the maximum-likelihood amplitude target, the B restraints and the minimiser's sparse normal matrix, §15). - V. Y. Lunin & T. P. Skovoroda, "R-free likelihood-based estimates of errors for phases calculated from atomic models", *Acta Cryst.* **A51** (1995), 880-887 (the likelihood parameters from the free set, §15). - A. A. Vagin et al., "REFMAC5 dictionary: organization of prior chemical knowledge and guidelines for its use", *Acta Cryst.* **D60** (2004), 2184-2195 (the restraint dictionary, §15). - P. V. Afonine et al., "Towards automated crystallographic structure refinement with phenix.refine", *Acta Cryst.* **D68** (2012), 352-367 (the weight chosen among refinements by R-free, §15). - D. C. Liu & J. Nocedal, "On the limited memory BFGS method for large scale optimization", *Math. Program.* **45** (1989), 503-528 (the minimiser, §15). - J. Nocedal, "Updating quasi-Newton matrices with limited storage", *Math. Comp.* **35** (1980), 773-782 (the two-loop recursion of the minimiser, §15.6). +- M. R. Hestenes & E. Stiefel, "Methods of conjugate gradients for solving linear systems", *J. Res. Natl. Bur. Stand.* **49** (1952), 409-436 (the normal equations of the minimiser, §15.6). +- C. C. Paige, "Error analysis of the Lanczos algorithm for tridiagonalizing a symmetric matrix", *J. Inst. Maths Applics* **18** (1976), 341-349, and A. Greenbaum, "Behavior of slightly perturbed Lanczos and conjugate-gradient recurrences", *Linear Algebra Appl.* **113** (1989), 7-63 (the reorthogonalised conjugate gradients of the minimiser, §15.6). - G. N. Murshudov, P. Skubák, A. A. Lebedev et al., "REFMAC5 for the refinement of macromolecular crystal structures", *Acta Cryst.* **D67** (2011), 355-367 (the likelihood's D from the working set and its variance from the free, and the Kullback-Leibler B restraints, §15.3, §15.5). - P. Roversi, E. Blanc, S. Johnson & S. M. Lea, "Tetartohedral twinning could happen to you too", *Acta Cryst.* **D68** (2012), 418-424 (twin refinement with more than two domains, and the free set closed under the twin domains, §15.12). - K. A. Sultana, I. Alexeev, I. Kursula, P. Mäntsälä, J. Niemi & G. Schneider, "Structure determination by multiwavelength anomalous diffraction of aclacinomycin oxidoreductase: indications of multidomain pseudomerohedral twinning", *Acta Cryst.* **D63** (2007), 149-159 (a six-domain twin of a monoclinic crystal on a hexagonal metric, §15.12). @@ -120,7 +122,6 @@ The methods draw on, and in places reimplement, solutions from: - V. Luzzati, "Traitement statistique des erreurs dans la détermination des structures cristallines", *Acta Cryst.* **5** (1952), 802-810 (the fall-off of $\sigma_A$ with resolution for a model's coordinate error, Luzzati's $D$, in the likelihood of a placement, §14.10). - D. Liebschner, P. V. Afonine, A. G. Urzhumtsev & P. D. Adams, "Implementation of the riding hydrogen model in CCTBX to support the next generation of X-ray and neutron joint refinement in Phenix", *Methods Enzymol.* **634** (2020), 177-199 (the riding hydrogens, placed by GEMMI's code, §15.2). - D. L. Theobald, "Rapid calculation of RMSDs using a quaternion-based characteristic polynomial", *Acta Cryst.* **A61** (2005), 478-480, and P. Liu, D. K. Agrafiotis & D. L. Theobald, *J. Comput. Chem.* **31** (2010), 1561-1563 (the QCP superposition behind the NCS rms criterion, via GEMMI, §15.5). -- S. S. Oren & D. G. Luenberger, "Self-scaling variable metric (SSVM) algorithms. Part I", *Management Sci.* **20** (1974), 845-862, and D. F. Shanno & K.-H. Phua, "Matrix conditioning and nonlinear optimization", *Math. Program.* **14** (1978), 149-160 (the rescaling of the L-BFGS initial inverse Hessian by the latest pair, §15.6). (list is not exhaustive; the full citations, with DOIs, are in [ACKNOWLEDGEMENT.md](ACKNOWLEDGEMENT.md)) diff --git a/docs/CPU_DATA_ANALYSIS_DECISIONS.md b/docs/CPU_DATA_ANALYSIS_DECISIONS.md index fae331bb5..6e72d2f07 100644 --- a/docs/CPU_DATA_ANALYSIS_DECISIONS.md +++ b/docs/CPU_DATA_ANALYSIS_DECISIONS.md @@ -158,7 +158,7 @@ $ R = \frac{\sum \big|\,|F_o| - |F_\mathrm{model}|\,\big|}{\sum |F_o|}, $ -with R-free the same sum restricted to the free set. Every parameter $F_\mathrm{model}$ carries — the scaling of §14.2 and the rigid-body placement of §14.8 alike — is fitted on the working set alone, so the free reflections are held out of the fit as well as out of the sum. Two choices are still *selected* with the free set rather than fitted to it, and both are single discrete decisions rather than continuous parameters: the rigid-body step is committed only if it lowers R-free (§14.8), and the alternative indexing of §14.6 is the candidate with the lowest R-free. Both are the conventional use of a test set to accept or reject a step; both leave R-free very slightly optimistic where they fire. +with R-free the same sum restricted to the free set. Every parameter $F_\mathrm{model}$ carries — the scaling of §14.2 and the rigid-body placement of §14.8 alike — is fitted on the working set alone, so the free reflections are held out of the fit as well as out of the sum. A few choices are still *selected* with the free set rather than fitted to it, each a single discrete decision rather than a continuous parameter: the rigid-body step is committed only if it lowers R-free (§14.8), the alternative indexing of §14.6 is the candidate with the lowest R-free, the merge the maps come from where a twin hypothesis was written is the one the model fits better on R-free (§14.9), and molecular replacement ranks its placements, copies and groups by R-free (§14.10). Each is the conventional use of a test set to accept or reject a step; each leaves R-free very slightly optimistic where it fires. Every use of the free set, here and in the refinement, is tabulated in [§15.13](CPU_DATA_ANALYSIS_REFINEMENT.md#1513-where-the-free-set-is-used). ### 14.4 Electron-density maps @@ -275,7 +275,7 @@ The refinement walks a coarse-to-fine ladder, 6 Å → 4.5 Å → 3.5 Å, each z The refinement sees **only the working reflections**. The step is then committed only if it lowers **R-free**, computed at full resolution on the free set it never saw; otherwise the model is put back exactly where it was read and the maps are the ones it would have given. The whole addition costs about two seconds. Note that the origin is a gauge in some space groups — free in all three directions in $P1$, and along the unique axis in a polar group — so those components of the translation are undetermined; nothing is done about that beyond the Levenberg–Marquardt damping and the R-free gate, which between them make an undetermined direction harmless rather than unstable. -Where a CUDA GPU is present, the refinement's target is evaluated on it: the same density, the same composition of $F_\mathrm{calc}$ from one copy of the model, the same bulk-solvent mask with its islands removed, the same scale fit and the same Jacobian, computed on the device, where a fit takes a fraction of a second rather than several seconds. The device is chosen once per validation, before anything is computed, and never revisited - the real fit and every replicate of the null of §14.5 on the same one. What goes on the GPU is decided for all parts at once, on one budget: 80% of the card's total memory (judged on the total, so the same input on the same machine always takes the same path), less what a merge still at work holds there. Every engine is reserved up front and kept to the end, so it is their sum that has to fit: the structure factors to the data's resolution (which also make the maps), one rigid-body engine, the null's structure factors to its coarser limit and one engine for the scale fits of §14.2 each take their place in that order where they still fit, and more rigid-body engines and then more scale-fit engines are added only within half of the budget: they change only how many fits run at once, and on a large cell, where one fit already fills the card, they buy little. A part that does not fit, or a cell too small for the GPU's gridding, runs on the CPU, as everything does where there is no GPU. A CUDA failure ends the validation, not the run: the validation reports why it did not finish, decides nothing, and the reflection files are those of a run without a model. The two agree to rounding and not bit for bit: the device measures distances in single precision and transforms with cuFFT instead of FFTW, and GEMMI's scale fit, whose stopping rule leaves it unconverged at about $10^{-4}$ of $|F|$, can respond to that rounding with a step of its own. A rigid-body step accepted or rejected on an R-free difference below about $5\cdot10^{-4}$ can therefore go either way between the two; every kernel is deterministic, so either one gives the same answer on every run. +Where a CUDA GPU is present, the refinement's target is evaluated on it: the same density, the same composition of $F_\mathrm{calc}$ from one copy of the model, the same bulk-solvent mask with its islands removed, the same scale fit and the same Jacobian, computed on the device, where a fit takes a fraction of a second rather than several seconds. The device is chosen once per validation, before anything is computed, and never revisited - the real fit and every replicate of the null of §14.5 on the same one. What goes on the GPU is decided for all parts at once, on one budget: 80% of the card's total memory (judged on the total, so the same input on the same machine always takes the same path), less what a merge still at work holds there. Every engine is reserved up front and kept to the end, so it is their sum that has to fit: the structure factors to the data's resolution (which also make the maps), one rigid-body engine, the null's structure factors to its coarser limit and one engine for the scale fits of §14.2 each take their place in that order where they still fit, and more rigid-body engines and then more scale-fit engines are added only within half of the budget: they change only how many fits run at once, and on a large cell, where one fit already fills the card, they buy little. A part that does not fit, or a cell too small for the GPU's gridding, runs on the CPU, as everything does where there is no GPU. A CUDA failure ends the validation, not the run: the validation reports why it did not finish, decides nothing, and the reflection files are those of a run without a model. The two agree to rounding and not bit for bit: the device measures distances in single precision and transforms with cuFFT instead of pocketfft, and GEMMI's scale fit, whose stopping rule leaves it unconverged at about $10^{-4}$ of $|F|$, can respond to that rounding with a step of its own. A rigid-body step accepted or rejected on an R-free difference below about $5\cdot10^{-4}$ can therefore go either way between the two; every kernel is deterministic, so either one gives the same answer on every run. The rotation and translation actually taken are reported (`RIGID_BODY_ROTATION_DEG`, `RIGID_BODY_SHIFT_A`), together with the R-free before it (`R_FREE_BEFORE_RIGID_BODY`), so what the placement bought is visible. diff --git a/docs/CPU_DATA_ANALYSIS_IMAGE.md b/docs/CPU_DATA_ANALYSIS_IMAGE.md index ca528af07..ddac0f395 100644 --- a/docs/CPU_DATA_ANALYSIS_IMAGE.md +++ b/docs/CPU_DATA_ANALYSIS_IMAGE.md @@ -182,7 +182,7 @@ margin, not a centre: the surface can be locally flat over tens of pixels, and t peak-to-runner-up margin says so. A **local walk** is then seeded at the capture and refines it; where it declines there it is started again from the file's centre, and only where neither start gives it something to fit does the capture stand alone. The transforms run on the GPU where one is present and -they fit half of the card's total memory, and on FFTW otherwise, with everything that decides anything +they fit half of the card's total memory, and on the CPU FFT (pocketfft) otherwise, with everything that decides anything shared between the two. The run log then carries: diff --git a/docs/CPU_DATA_ANALYSIS_INDEXING.md b/docs/CPU_DATA_ANALYSIS_INDEXING.md index aa83b6b9a..7fac4ebb2 100644 --- a/docs/CPU_DATA_ANALYSIS_INDEXING.md +++ b/docs/CPU_DATA_ANALYSIS_INDEXING.md @@ -295,6 +295,13 @@ re-checks, about a second each. The checks taken on the pre-pass frames - the geometry walk's refits, the metric-symmetry arm and the pre-pass spot-crowding count - stay on those frames in both modes, and their near ties are re-checked once every frame is in on both. +A lattice is promoted to a centred or higher class on its metric alone, and the geometry and +integration are then held to that class. Where the space-group search afterwards finds no symmetry +at all (P 1) on such a lattice, the constraint has nothing left behind it, so a stored rotation run +is made once more with the lattice held triclinic from its first pass (as `-S P1` holds it), and of +the two merges the one whose CC1/2, averaged per resolution shell on Fisher's $z$, is higher is the +answer. + **A first pass that ends with no usable lattice tries a leaner, shallower one.** A crystal sitting in a crystalline powder floods the pass with spots that are not its own — measured, 2112 spots a frame against the 80 a clean crystal on the same beamline gives — and the FFT then takes its cell out of the diff --git a/docs/CPU_DATA_ANALYSIS_INTEGRATION.md b/docs/CPU_DATA_ANALYSIS_INTEGRATION.md index 798b81943..7808c2e15 100644 --- a/docs/CPU_DATA_ANALYSIS_INTEGRATION.md +++ b/docs/CPU_DATA_ANALYSIS_INTEGRATION.md @@ -339,7 +339,7 @@ The partiality applied is fixed by the data type and scaling stage, not chosen f 2. **Unity** ($P_{ij}=1$): used for the scale-on-fulls refit (§10.6), where each observation is already a complete reflection. -3. **Fixed**: use the per-reflection partiality carried from prediction. Still/serial images are predicted with $P=1$, so a single-pass stills scale is effectively unity/fixed — which is exactly what `--simple-stills` keeps. By default the stills path instead **post-refines a physical partiality**: a small per-crystal orientation tilt $(\delta\psi_x,\delta\psi_y)$ about the two axes perpendicular to the beam is refined against the running merge, and every reflection's partiality is then recomputed analytically from the refined lattice through its excitation error $\Delta_\mathrm{Ewald}=\big|\,|\mathbf{q}+\mathbf{S}_0|-1/\lambda\,\big|$ and a Gaussian width $\sigma(d^*)$ — the run's rocking width, measured once on the intensity-weighted excitation errors and shared by every crystal. It is measured per group of frames of similar prediction window (four per shell), each against its own window, the shell taking the median of the groups whose curve is narrower than their window, so the frames with the widest windows do not set it everywhere; and it is measured in eight shells of equal width in $d^*$, made non-decreasing (pool-adjacent-violators, weighted by each shell's summed signal) and interpolated linearly in $d^*$ as a table. The three-term form $\sigma^2=\gamma_0^2+(\gamma_e d^*)^2+(\mathrm{bw}\,|q_z|)^2$ — the reciprocal-lattice point's own radius, the mosaic/divergence spread, and the bandwidth smear along the beam, in quadrature — is still fitted, sets the prediction window (§8.2) and stands in for the table where fewer than three shells are measurable. The curve is centred on the run's **radial scale** of the reciprocal lattice — a wavelength or cell a little off, which the spot positions cannot see since they fix only $\lambda d^*$ — measured from where the curve's centre lies against $d^{*2}$ and applied to $\mathbf{q}$. Where the frames were predicted through the measured window (§8.2), the post-refinement uses that same curve rather than measuring it again; the curve is written to `_process.h5` (`/entry/MX/stillsRockingWidth*`, `stillsRadialScale`), so `--mode scale` merges with it too. A tilt moves reflections on opposite sides of the Ewald sphere in opposite directions, so it reshapes the *spatial* pattern of partialities — a degree of freedom the per-image scale $G$ does not have, and the reason the tilt is refined rather than a scalar partiality width, which would be degenerate with $G$. Nothing is re-integrated (the integrated intensities are fixed); the tilt is hard-bounded at about 1° and held by a soft prior, so it stays inert on sparse or weak crystals. The cycle is merge → per-crystal tilt refinement (with $G$ profiled out by the same robust Cauchy IRLS used for the per-frame scales, §10.3) → recompute $P$ → re-merge, repeated a few times; the refined partiality is adopted on every crystal it was refined on. The per-crystal fits of $G$ and of the tilt measure each residual against its expected variance at the model, background + counting + $(0.3\,I_\mathrm{model})^2$: a still's strong reflections scatter about the model by tens of per cent, and in counting sigmas alone every strong reflection would be an outlier and the scale would be set by the weak ones. +3. **Fixed**: use the per-reflection partiality carried from prediction. Still/serial images are predicted with $P=1$, so a single-pass stills scale is effectively unity/fixed — which is exactly what `--simple-stills` keeps. By default the stills path instead **post-refines a physical partiality**: a small per-crystal orientation tilt $(\delta\psi_x,\delta\psi_y)$ about the two axes perpendicular to the beam is refined against the running merge, and every reflection's partiality is then recomputed analytically from the refined lattice through its excitation error $\Delta_\mathrm{Ewald}=\big|\,|\mathbf{q}+\mathbf{S}_0|-1/\lambda\,\big|$ and a Gaussian width $\sigma(d^*)$ — the run's rocking width, measured once on the intensity-weighted excitation errors and shared by every crystal. It is measured per group of frames of similar prediction window (four per shell), each against its own window, the shell taking the median of the groups whose curve is narrower than their window, so the frames with the widest windows do not set it everywhere; and it is measured in eight shells of equal width in $d^*$, made non-decreasing (pool-adjacent-violators, weighted by each shell's summed signal) and interpolated linearly in $d^*$ as a table. The three-term form $\sigma^2=\gamma_0^2+(\gamma_e d^*)^2+(\mathrm{bw}\,|q_z|)^2$ — the reciprocal-lattice point's own radius, the mosaic/divergence spread, and the bandwidth smear along the beam, in quadrature — is fitted to the same shells, each counting the same in proportion, and sets the prediction window (§8.2). Over the 13–2 Å the shells span the three terms are nearly collinear, so which of them carries the width is not determined and the fit reports one or two of them at zero on most runs; the curve itself is determined, and the curve is all the window and the partiality use. Before the post-refinement each shell of the table is rescaled so that the reflections predicted below half their peak and those above it put the same scale on the run's merge; a shell too sparse to say takes its neighbour's factor. The curve is centred on the run's **radial scale** of the reciprocal lattice — a wavelength or cell a little off, which the spot positions cannot see since they fix only $\lambda d^*$ — measured from where the curve's centre lies against $d^{*2}$ and applied to $\mathbf{q}$. Where the frames were predicted through the measured window (§8.2), the post-refinement uses that same curve rather than measuring it again; the curve is written to `_process.h5` (`/entry/MX/stillsRockingWidth*`, `stillsRadialScale`), so `--mode scale` merges with it too. A tilt moves reflections on opposite sides of the Ewald sphere in opposite directions, so it reshapes the *spatial* pattern of partialities — a degree of freedom the per-image scale $G$ does not have, and the reason the tilt is refined rather than a scalar partiality width, which would be degenerate with $G$. Nothing is re-integrated (the integrated intensities are fixed); the tilt is hard-bounded at about 1° and held by a soft prior, so it stays inert on sparse or weak crystals. The cycle is merge → per-crystal tilt refinement (with $G$ profiled out by the same robust Cauchy IRLS used for the per-frame scales, §10.3) → recompute $P$ → re-merge, repeated a few times; the refined partiality is adopted on every crystal it was refined on. The per-crystal fits of $G$ and of the tilt measure each residual against its expected variance at the model, background + counting + $(0.3\,I_\mathrm{model})^2$: a still's strong reflections scatter about the model by tens of per cent, and in counting sigmas alone every strong reflection would be an outlier and the scale would be set by the weak ones. Reflections below a minimum partiality are left out of the merge (`--min-partiality`, default 0.02 on rotation and 0.5 on stills): the empirical rocking curve of a still has a floor far out on its tail, from mis-oriented crystals, and dividing such an observation by a small model $p$ makes it biased, not merely noisy. On stills this holds for the merges the scale and the partiality are refined against. The final merge, which has the fitted error model, takes every observation: the model's partiality term $c\,((1-p)/p)\,\langle I\rangle$ (§10.5) weights a low-partiality observation by what it is worth. A reflection - each Bijvoet hand under `-A` - is reported only if at least one of its observations reaches $p \ge 0.2$; one seen only far out on its rocking curve rests on the partiality model alone. The error model is fitted on the observations at $p \ge 0.2$. @@ -451,7 +451,7 @@ A fraction of the unique reflections (`rfree_fraction`, default 0.05) is flagged On small data, where `rfree_fraction` (default 0.05) would give too few test reflections for a statistically stable R-free (Brünger's ~500–2000 rule), the fraction is **floored** so at least ~500 distinct reflections are free — capped at 10 % so a large test set never steals working data. For ordinary data this floor is inactive and the fraction stays flat at `rfree_fraction`, preserving the cross-dataset-identical property above; it only lifts the fraction on genuinely small datasets, where per-dataset R-free stability outweighs cross-dataset identity (and a shared reference set is the way to keep exact identity there). -When a reference (`--reference`: an MTZ, or a PDB structure-factor mmCIF, which is converted to one with `_refln.status` `f`/`o` becoming flag 0/1) carries a `FreeR_flag` column, its test set is **imported** instead: every merged reflection whose Laue-ASU index matches the reference takes the reference's flag (reflections absent from the reference keep the hash flag). The match is made in the reference's frame — on rotation data the merge is first put onto the reference's axes, choosing among every description of the lattice on them (and every alternative indexing) by the intensity correlation with the reference — and only where the merge then matches it: an intensity CC of at least 0.5 over at least half of the merged reflections in the reference's resolution range. Below that the reference is not the same crystal form on the same axes, its flags would land on unrelated reflections, and they are not imported (`REFERENCE_MISMATCH`). This lets a whole fragment-screening campaign inherit one shared free set from the apo/reference dataset. The CCP4/refmac convention (test set = flag 0, including the historical 0–19 form) is assumed, with the complement taken automatically if flag 0 would be the majority (a phenix-style file where 1 marks free). +When a reference (`--reference`: an MTZ, or a PDB structure-factor mmCIF, which is converted to one with `_refln.status` `f`/`o` becoming flag 0/1) carries a `FreeR_flag` column, its test set is **imported** instead: every merged reflection whose Laue-ASU index matches the reference takes the reference's flag (reflections absent from the reference keep the hash flag). The match is made in the reference's frame — on rotation data the merge is first put onto the reference's axes, choosing among every description of the lattice on them (and every alternative indexing) by the intensity correlation with the reference — and only where the merge then matches it: an intensity CC of at least 0.5 over at least half of the merged reflections in the reference's resolution range. Below that the reference is not the same crystal form on the same axes, its flags would land on unrelated reflections, and they are not imported (`REFERENCE_MISMATCH`). This lets a whole fragment-screening campaign inherit one shared free set from the apo/reference dataset. The CCP4/refmac convention (test set = flag 0, including the historical 0–19 form) is assumed, with the complement taken automatically if flag 0 would be the majority (a phenix-style file where 1 marks free). `--free-flags ` imports a test set the same way from a file of which nothing else is used - the deposited reflections of a `--model`, typically - applied on the model's axes where the rigid body placed the model (§14.5). Where each flag is then used - what is fitted on the working reflections, which choices the free set takes, and what only reports it - is tabulated in [§15.13](CPU_DATA_ANALYSIS_REFINEMENT.md#1513-where-the-free-set-is-used). ### 10.8 French–Wilson amplitudes diff --git a/docs/CPU_DATA_ANALYSIS_REFINEMENT.md b/docs/CPU_DATA_ANALYSIS_REFINEMENT.md index b0a12e309..d58b195ac 100644 --- a/docs/CPU_DATA_ANALYSIS_REFINEMENT.md +++ b/docs/CPU_DATA_ANALYSIS_REFINEMENT.md @@ -27,12 +27,23 @@ statistics and its map coefficients go out; the restraint dictionary is compiled ### 15.1 What is refined, and in what order The model is taken as the refinement can use it: the first model of the file only, its hydrogens removed, -and every B clamped to the range the refinement allows (2 Ų up to twice the model's largest B, within -100-300 Ų). An atom's anisotropic U (ANISOU, `_atom_site_anisotrop`) is kept. Where the model has TLS +and every B inside the range the refinement allows (2 Ų up to a ceiling of twice the largest B, within 100-300 Ų, +where the largest B is the model's or 2.5 times the Wilson B of the data against its atoms, whichever is higher - a +flat B or a prediction's pLDDT says nothing of where the B factors will refine; a model whose largest B is above +200 Ų - a structure refined at 4-5 Å - gets a ceiling of 1.5 times it instead, so that it is not flattened; the +second round of the weights (§15.7, 5) sets the ceiling again from the refined model). + +The model is refined in the data's space group - except where its own group is a proper subgroup of it: a +P2₁ model whose copies are pseudo-symmetric, validated in its own group against a merge in P4₁2₁2 that the +data could not tell from P2₁. Under the data's group the operators the model does not have would overlay its +copies and R would be the null's, so it is refined in its own group, against the merge expanded to that group +(every reflection the data's group made equivalent, at the merged amplitude and with the same free flag), and +no twin law is tested, the data carrying the larger symmetry exactly. The refined model is written in the group +it was refined in. An atom's anisotropic U (ANISOU, `_atom_site_anisotrop`) is kept. Where the model has TLS groups (`_pdbx_refine_tls*`, PDB `REMARK 3`) whose atoms bring no U of their own, their U is made from the groups, and the B column is read either as the total B (as phenix.refine writes it) or as the residual to the -groups (as REFMAC writes it) - whichever of the two, and of the isotropic B as it stands, scores the lowest -R-free on the model as given (`REFINE_ADP_INPUT`). Occupancies are kept as they are, and +groups (as REFMAC writes it) - whichever of the two, and of the isotropic B as it stands, the free set prefers on +the model as given (§15.7; `REFINE_ADP_INPUT`). Occupancies are kept as they are, and so are alternative conformations, each refined with its own restraints. Two stages follow. @@ -40,11 +51,12 @@ Two stages follow. 1. **Placement.** Each chain of at least 50 non-water atoms is moved as a rigid body - an angle-axis rotation about its centroid, scaled by its rms radius so that a unit of rotation moves a typical atom by about an angstrom, and a translation - against the X-ray target (§15.2), by Ceres' L-BFGS for 30 - iterations. Then one B shift per residue. Each of the two is **kept only where it lowers R-free by more - than 0.001**: a deposited model was refined atom by atom already, and moving its chains or shifting its - B factors residue by residue then only makes it worse. The placement stage needs no dictionary. + iterations. Then one B shift per residue. Each of the two is **kept only where it lowers the $-\ln L$ of the + working reflections**, the target it minimised: the free set decides the weights and the displacement model + alone (§15.7). The placement stage needs no dictionary. 2. **Restrained refinement.** Every atom's position and isotropic B, against the X-ray target and the - geometry of the dictionary (§15.4-§15.5), in weight trials chosen by R-free (§15.7). Residues the + geometry of the dictionary (§15.4-§15.5) - the built-in one with the user's restraint files over it + (`--restraints`) - in weight trials chosen on the free set (§15.7). Residues the dictionary does not describe, and residues with an atom it does not know, are **held fixed**: they stay in the structure factors, in the bulk-solvent mask and in the repulsions the refined atoms see, but they do not move. So do atoms of zero occupancy. @@ -140,15 +152,19 @@ disk, and `$CLIBD` is never consulted): the 20 standard amino acids and MSE; the (H2U), N2-methyl- and N2,N2-dimethylguanosine (2MG, M2G), 7-methylguanosine (7MG) and ribothymidine (5MU), polymer residues joined by the same backbone link; ATP, ADP, AMP, GTP, GDP and GMP; the cofactors NAD⁺ (NAD), NADH (NAI), NADP⁺ (NAP), NADPH (NDP), FAD, FMN, heme (HEM), heme C (HEC), S-adenosylmethionine (SAM) and -S-adenosylhomocysteine (SAH), and dioxygen (OXY); DMSO; the PEG fragments PEG, PGE, PG4 and 1PE; glycerol, +S-adenosylhomocysteine (SAH), and dioxygen (OXY); N-acetyl-D-glucosamine, β and α (NAG, NDG), alone or as +chitobiose/chitotriose; the photoreceptor chromophores retinal (RET), p-coumaric acid (HC4), the GFP-type CRO, +GYS, CR2 and NRQ, and the bilins BLA, LBV and CYC; DMSO; the PEG fragments PEG, PGE, PG4 and 1PE; glycerol, ethylene glycol, MPD, acetate, sulfate and phosphate; water; and the ions Na, K, Mg, Ca, Mn, Fe²⁺, Fe³⁺, Co, Ni, -Cu, Zn, Cd, Cl, Br and I - 84 compounds - with the library's links and modifications that apply to them (among +Cu, Zn, Cd, Cl, Br and I - 95 compounds - with the library's links and modifications that apply to them (among them heme C's two thioethers to its cysteines, HEC-CYS1 and HEC-CYS2, and the covalent links of heme and FAD to -the protein) and the energy types those compounds use. +the protein, and the glycosidic links of the pyranoses and theirs to Asn, Ser and Thr) and the energy types those +compounds use. The model's topology is built from it by GEMMI (`prepare_topology`): the links between residues (the peptide and cis-peptide, the nucleic-acid backbone, disulfides, and the model's LINK records where the library -describes them), the modifications those links imply, and per residue the bonds, angles, torsions, chiral +describes them; a sugar atom within 2 Å of an atom a library link joins it to is linked even without a LINK +record, so a glycan built without them keeps its glycosidic bonds), the modifications those links imply, and per residue the bonds, angles, torsions, chiral volumes and planes. Torsions are restrained where the dictionary gives them an esd, except the main-chain φ/ψ and the sugar puckers it lists as alternatives. The dictionary's **hydrogens** are added to every residue it describes (waters excepted), placed by GEMMI from the dictionary's geometry and moved with their @@ -174,6 +190,18 @@ analytic derivatives: above it, $d_0$ the sum of the energy types' van der Waals radii, 2.6 Å where both atoms can hydrogen-bond and 1.9 Å between a metal and N, O or S. The list is rebuilt at every macro-cycle. +**Side chains placed through another residue.** A predicted model's rotamer, placed by molecular replacement, +can run through the main chain of another copy or of a symmetry mate - atoms within an ångström of each other, +as where the copies' side chains meet on a non-crystallographic axis. The repulsion only pushes the two atoms +apart along the line that joins them, so such a side chain leaves the clash in whatever direction that line +points and settles in a rotamer of the repulsion's choosing, which the density then cannot correct. Before the +refinement, every side chain with an atom more than 2 Å inside its contact distance to another residue (within +about 1.3 Å of one of its atoms: interpenetration, not a contact the gradient resolves) is +turned about its chi angles to the staggered rotamer (the terminal planar group in steps of 30°) with the least +squared overlap against the rest of the model, symmetry mates included; the main chain, the beta carbon and the +B factors stay as given, and the refinement then places the side chain in the density from there. The log +names each side chain turned, with its chi angles before and after (`REFINE_SIDE_CHAINS_TURNED` counts them). + **Special positions.** An atom closer than 0.5 Å to one of its own symmetry images (the depositions put theirs within 0.03 Å of the site) is on a special position: the symmetry operations, each with its lattice translation, that take it onto itself are its site symmetry (Grosse-Kunstleve & Adams 2002). It is placed exactly on the site - @@ -258,26 +286,56 @@ Whether the restraints are used at all, and how tightly ($\sigma$), the weight t ### 15.6 The minimiser -Positions and B factors are minimised in turn, each by an L-BFGS of rugnux's own (`RefinementMinimiser`), -with the two-loop recursion of Nocedal and of Liu and Nocedal, a memory of 20 pairs and a backtracking line -search from the full step to sufficient decrease, its first trial moving no position by more than 0.3 Å and -no B by more than 10 Ų. What sets it apart from a textbook L-BFGS: +Positions, B factors, anisotropic U and TLS parameters are minimised in turn, each by an L-BFGS of rugnux's own +(`RefinementMinimiser`), with the two-loop recursion of Nocedal and of Liu and Nocedal, a memory of 20 pairs and a +backtracking line search from the full step to sufficient decrease, its first trial moving no position by more +than 0.3 Å and no B by more than 10 Ų. What sets it apart from a textbook L-BFGS is its **initial inverse +Hessian: the target's Gauss-Newton normal matrix**, as REFMAC refines on its sparse normal matrix (Murshudov, +Vagin & Dodson 1997). The matrix holds what is known of the curvature in advance; the L-BFGS pairs add what it +leaves out. -- **Its memory is kept from one macro-cycle to the next.** A macro-cycle is a few dozen iterations on a target - whose scale and likelihood parameters were refitted in between; starting each from what the earlier ones - learnt of the curvature, instead of from a steepest-descent step, is what lets two macro-cycles of a - weight trial get as far as many restarted ones. Each weight trial starts with an empty memory. -- **The B steps are scaled by their curvature.** The initial inverse Hessian of the B factors is a - diagonal: the X-ray target's curvature in each atom's B - its shape from the likelihood's curvature in - $|F_\mathrm{model}|$ and the atom's own scattering, summed in resolution shells, calibrated once per trial - against central differences of the gradient along a random $\pm1$ direction - plus the B restraints' - curvature, each element at least a thousandth of the median. The positions take none: their restraints' - curvature is that of stiff bonds and angles, which move atoms together, and as a diagonal it slows the soft - (torsion and X-ray) directions rather than scaling them. +- **The restraints' part is their Gauss-Newton matrix $J^\mathsf{T}J$, in full.** Every restraint is the square of + a residual (or close to it: the NCS distances' robust loss), so its gradient is $2r\,\nabla r$ and + $J = \nabla E / \sqrt{2E}$ is its row of the Jacobian, $\sqrt2\,\nabla r$; a plane contributes one row per + atom. $J^\mathsf{T}J$ is positive semi-definite where the exact Hessian is not (torsions, repulsions), and near + the ideal geometry it is the exact Hessian. Its products $J^\mathsf{T}(Jv)$ are two gathers - over the rows, + then over each atom's entries - on the slot's threads, or on its GPU. +- **The X-ray part is per atom, on the diagonal.** The X-ray target's curvature in an atom's $x$, $y$ and $z$ is + the likelihood's curvature in $|F_\mathrm{model}|$ summed in resolution shells against the atom's own part of + it, $(2\pi)^2 s^2/3\,f(s)^2\,e^{-Bs^2/2}$ (the reflections taken as spread evenly over directions); in its B, + $(s^2/4)^2 f(s)^2 e^{-Bs^2/2}$, a third of it to each element of a U; and a TLS body's dense $20\times20$ block + is that curvature carried through the derivatives of its atoms' U in the body's parameters. Each is calibrated + once per trial against central differences of the gradient along a random $\pm1$ direction. The coupling of + neighbouring atoms through the X-ray target is not in it; the pairs learn it. +- **The anisotropic U restraints** are quadratic in U, so their Hessian is exact by one difference of their + gradient. +- **A trust floor per atom.** Where nothing but the X-ray target curves a mode - a high-B side chain turning about + a single bond, which the restraints leave free and the X-ray target hardly sees - the matrix's inverse would + make a step of tens of ångströms there, and the step bound would then shrink every other atom's step with it. + So each atom's diagonal is raised, once per macro-cycle, to at least $|g_i|/\Delta$ ($g_i$ its gradient, + $\Delta$ the step bound): its step is held by its own curvature, a trust region per atom in the manner of + Levenberg and Marquardt's damping. A U (per atom) and a TLS body's parameters (each) take the same floor. Without it a rounding difference of $10^{-7}$ in the gradient moved a weight + trial's R-free by up to 0.004; with it the perturbation stays where it was. +- **The matrix is solved, not inverted.** Each L-BFGS direction solves the normal equations by a fixed 20 + conjugate-gradient iterations - not to a tolerance, whose iteration count, and with it the direction, a rounding + difference can flip - preconditioned per residue for the positions (the residue's own $J^\mathsf{T}J$ and X-ray + diagonal, by Cholesky: the stiff bonds and angles inside a residue are solved there, what couples residues is + left to the iterations) and by the diagonal elsewhere. Each new residual is made orthogonal again (in the + preconditioner's inner product) to all the earlier ones: the plain recurrence loses that orthogonality in + rounding once its first Ritz values converge (Paige; Greenbaum), and from then on a rounding difference grew + several-fold per iteration, so that two solves of right-hand sides $10^{-14}$ apart ended up to 7% apart - which + is what set the CPU and GPU results apart. With it the solve is a smooth function of its input, and the GPU's + float-pair solve agrees with the CPU's to $10^{-13}$. The Jacobian is taken again at each point the minimiser + stands on. +- **Its memory is kept from one macro-cycle to the next.** Each weight trial starts with an empty memory. -The diagonal is rescaled at each iteration by the latest pair (Oren-Shanno scaling in that metric). A solve -stops after its iteration budget (30 for the positions and 20 for the B factors per macro-cycle) or where an -iteration lowers the target by less than $10^{-7}$ of it. +A solve stops after its iteration budget (10 for the positions and 7 for the B factors, U or TLS per +macro-cycle) or where an iteration lowers the target by less than $10^{-7}$ of it. Against the plain L-BFGS this +replaced (a diagonal initial inverse Hessian for the B factors, none for the positions, 30 and 20 iterations), a +trial takes about a third of the evaluations. With it the population (§15.7) no longer gains, and the protocol +is the same on the CPU and the GPU - two rounds, no population - at a third of the evaluations the GPU's protocol +took before and R-free 0.0014 lower in the mean over 19 refinements, and at fewer evaluations than the CPU's +former one-round protocol. ### 15.7 The weights, decided by trial @@ -286,32 +344,103 @@ $w_B\,T_\mathrm{X\text{-}ray} + E_B$ for the B factors. Rather than fixing $w$ a runs **short refinements at several weights and keeps the one that does best on the free set** - a weight chosen late, on the evidence, instead of early at a rule. +**What the free set decides.** The free set decides the weights - the X-ray weights of the positions and of the B +factors and the NCS restraints' $\sigma$ - the displacement model (§15.7, 6.), the reading of the model's TLS groups +(§15.1) and whether the model as given is kept over the refinement (7.); the one other free-set decision of the +refinement is the twin law against its null (§15.12), and §15.13 tabulates them all. Each of these choices asks +both of its measures: a candidate is preferred to the incumbent only where its $-\ln L$ of the free reflections is +lower **and** its R-free is not higher by more than the standard error of the difference. The two are scored on the +same free reflections, so the difference is paired: R-free is a sum of one term per free reflection (per free twin +group under a twin law, whose members share their $F_\mathrm{calc}$), and the standard error is that of the sum of +the terms' differences - two trials from one start differ far less from reflection to reflection than either +scatters about the truth, so this is narrower than the error of one R-free, $R_\mathrm{free}/\sqrt{2N_\mathrm{free}}$. +One measure alone, or a fixed tie, picks the noise of a few hundred reflections as often as a better model (PDB-REDO +likewise takes a change only where its free measures agree, Joosten et al. 2014). $-\ln L$ free is that of the +refinement's own likelihood parameters - the variance fitted to the free reflections; with D and the variance fitted +to the working reflections instead, it kept out a per-atom U that overfits at 2.2 Å, but held back every +refinement (on 17 structures R-free 0.0016 and R-work 0.008 higher on average), and it is not used. Every other step - a step of the +trajectory, a round, the placement's rigid bodies and B per residue, the solvent build's rounds, the side-chain +field, the population's child - is taken on the **work-set target**: the target the trial minimises, +$w\,T_\mathrm{X\text{-}ray} + E_\mathrm{geometry}$ (with the NCS restraints at their $\sigma$), plus +$w_B\,T_\mathrm{X\text{-}ray} + E_B$ where the B factors are refined, $T_\mathrm{X\text{-}ray}$ the $-\ln L$ of the +working reflections - at the weights the two candidates share, and taken where it lowers that by more than +$10^{-4}$ of it, relative, and the geometry stays within bounds where it was. A step at other weights (X-ray weights +or NCS $\sigma$) is not compared on a target that changed with them - the positions and the B factors minimise +targets of their own, whose sum a change of weight can raise while it lowers each - and the free set decides it as +it decides every weight. The free set thus tests a +handful of choices, each between a few candidates, and the R-free reported is not the best of the many steps the +refinement took. + The starting weights balance the gradients: $w_0 = |\nabla E_\mathrm{geometry}| / |\nabla T_\mathrm{X\text{-}ray}|$, the geometry's gradient taken on the model shaken by 0.1 Å (a refined model's geometry would give none), and $w_{B,0}$ likewise from the B restraints on the B factors shaken by 20%. Each **trial** is two macro-cycles (the scale, solvent and likelihood refitted, then the positions, then the B factors) from where it starts. A trial is **within bounds** where its rmsd from the dictionary is at most 0.02 Å for bonds and 2° for -angles; one trial **displaces** another where it is within bounds and its R-free is lower by more than 0.001 -(differences smaller than that do not decide, and the trial listed first - on a ladder, the tighter -geometry - is kept). The trials -are: +angles; one trial **displaces** another where it is within bounds and the free set prefers it as above (the trial +listed first - on a ladder, the tighter geometry - is kept otherwise). The trials are: 1. **The ladder from the placed model**: $w = w_0 \times \{1/1024, 1/128, 1/16\}$, each with the B factors - held and refined at $w_{B,0}$ - six trials. + held and refined at $w_{B,0} \times \{1/16, 1/4, 1\}$ - twelve trials (the B factors are refined first at + the middle rung only, and at the others unless holding them there displaces refining them). The lower + B weights are for a model whose B factors arrive far from where they refine - a prediction's pLDDT - whose + balanced weight is not the one its B wants: they took 0.002-0.010 off R-free on five such starts, and + nothing off eight deposited models. 2. **The trajectory**: up to eight steps, each a set of trials from where the last step ended - the weights as they are, and in turn the positions' weight halved and doubled (halved because the geometry loosens at one weight as the model improves, until it leaves the bounds) or the B factors' weight divided and - multiplied by four. A step is taken while it lowers R-free or R-work by more than 0.001 and its R-free - stays within 0.001 of the best so far, and the trajectory ends at its best step. On a deposited model, - whose free set the depositor's refinement has already fitted, R-work falls while R-free rises, and the - trajectory ends where it began. -3. **The final ladder**: the trajectory's weights times $\{1, 2\}$, kept where one displaces it (the weight halved + multiplied by four. The step's weights are chosen among its trials on the free set; the step is taken while + that trial lowers the work-set target (or, at other weights, displaces where the last step ended), and the + trajectory ends where the last step taken ended. +3. **The population** (off by default, `RefinementSettings::population`: with the minimiser of §15.6 its members + took nothing off R-free over 19 refinements that the second round did not), from where the trajectory ended: + up to twelve members (at most as many as the trial slots, so that they run in one wave; none below two) refined + side by side, each a trial at the + trajectory's weights but on its own path - the positions as they are or kicked at random by up to 0.2-0.3 Å + in each coordinate, on the data as they are or **blurred** along a schedule, 60 then 20 Ų (the landscape of + 4 Å, then of 2.2 Å), 100 then 30, or 30 then 10. The blur raises the likelihood's variance of each reflection + by $e^{B_h s^2/2}$, which is $F_o$ and $F_\mathrm{model}$ both blurred by $e^{-B_h s^2/4}$ (the Rice + likelihood reads a common scale as nothing else), and the X-ray weight is balanced again for the gradient + left; the B factors refine on the data as they are. A single descent sees the basin it starts in; the + members see those around it. Their **crossover** is made on one 2mFo-DFc map averaged over the members with + the free reflections left out: each residue is taken from the member whose atoms sit in the most density, + the junctions are mended by a macro-cycle at the ladder's tightest rung, and the child is refined by one + trial at the trajectory's weights. The child is taken where it lowers the work-set target, as a step is; the + free set never sees the members. On + 13 predictions placed by MR the child was kept on four (R-free 0.005-0.011 lower) and on one of 22 refined + models (0.009 lower, the rest unchanged); the gain, where there is one, comes mostly in the rounds that + follow from the child. +4. **The side-chain field**, from where the population and the solvent build (§15.10) ended: every side + chain the search can take - a complete amino-acid side chain at full occupancy, refinable, without alternative + conformations and not bound by a LINK - is a discrete variable whose states are its staggered rotamers (the + terminal planar group every 30°), the conformation it has, and *absent* (pruned to CB, its atoms at occupancy 0: + the honest answer where no rotamer fits). The energy of a state is the refinement's own target with the rest of + the model held: $-\ln L$ over the working reflections at the scale, the solvent and the likelihood parameters + as they stand, plus the repulsion term against the rest of the model (symmetry mates and the other copies + included) over the X-ray weight. The structure factors are linear in the atoms, so with the side chain's own + contribution computed by direct summation - a dozen atoms over the group's operators - a change of state + moves F by $dF_{new} - dF_{old}$ and the target is re-evaluated at every reflection for every state in one pass + on the GPU, microseconds per state, no map and no gradient. The field is minimised by iterated conditional + modes: the residues in turn, each put in its state of least energy given the others, small side chains first + and arginine last, until a sweep changes nothing. The copies of a residue related by NCS are one variable, + searched in each rotamer together and each alone - together only, one state holding every copy's atoms, where a + sweep would otherwise take more than $4 \times 10^8$ evaluations (states times reflections, about 3 s on one + card). An FFT gradient cannot carry a side chain 1.5 Å at 1.7 Å + resolution; the field, a search, can, and it is scored by the likelihood rather than by a map, which on an + incomplete model rewards whatever fills unmodelled density. The free reflections are never seen by the field + nor by its test: one step at the trajectory's weights is then taken from it and judged against the same step + from the model as it was, kept only where it lowers the work-set target and the geometry stays within bounds, + undone otherwise (a model whose side chains the data already hold moves nothing and costs the + sweep alone). The log names each side chain moved with its chi angles before and after and the energy the move + took off (`REFINE_SIDE_CHAIN_FIELD_MOVED`, `REFINE_SIDE_CHAIN_FIELD_PRUNED`). Twinned data and a model with + anisotropic atoms are refined without the field. +5. **The final ladder**: the trajectory's weights times $\{1, 2\}$, chosen on the free set, the choice taken where it + advances from where the trajectory ended as a step does (the weight halved was never kept on 55 refinements, and taking it away changed no choice). -4. **The displacement model**, from where the weights ended (the B factors as they are: isotropic, or the model's U +6. **The displacement model**, from where the weights ended (the B factors as they are: isotropic, or the model's U held), each trial as long as a step on the positions where the weights ended, held - only the displacement - parameters refine, so the trials differ in the displacement model alone; the model chosen then takes a step with - the positions refined, kept where it displaces its trial (where the geometry is out of bounds there, which held - positions cannot mend, each trial refines the positions too, a macro-cycle longer than a step): TLS groups with a residual B - the model's own, one per chain + parameters refine, so the trials differ in the displacement model alone (where the geometry is out of bounds + there, which held positions cannot mend, each trial refines the positions too, a macro-cycle longer than a + step): TLS groups with a residual B - the model's own, one per chain of at least 50 refinable atoms, and the chains cut into 4, 8 and 16 contiguous segments of at least 10 residues as TLSMD cuts them (by dynamic programming over the least-squares fit of an isotropic TLS model, a quadratic B(r), to the refined B factors), each cut where it gives more groups than the one before; and a U per atom, at the U @@ -321,16 +450,27 @@ are: reflections from where the weights ended; on 49 refinements of 33 structures neither the cuts' rule nor leaving out the U weight $\times 4$ changed a choice taken. A trial displaces the one before it (the first: where the weights ended) only where its geometry is within bounds - and both its R-free (beyond the tie) and the $-\ln L$ of the free reflections are lower: the free set tests the - parameters a model adds, so the choice is made on the evidence of each run, not at a resolution (Merritt 2012). + and the free set prefers it: the free set tests the parameters a model adds, so the choice is made on the evidence of each run, not at a resolution (Merritt 2012). Between a model with more displacement parameters (TLS over a B per atom, a U per atom over either) and one with fewer, Hamilton's R-ratio test decides first, as Merritt (2012) and PDB-REDO apply it: the larger passes where its R-work is below the smaller's by more than the ratio $\sqrt{b/(n-m)\,F_{b,n-m,0.05} + 1}$, $n$ the working reflections, $m$ its displacement parameters (the positions are held) and $b$ the extra ones (Hamilton 1965; the F point by Paulson's approximation). The restraints are credited as $wR$ observations, $w$ unknown: each model's is scanned from 0 to the bound at which its restraints take every parameter they restrain off its count (Merritt's $N_\mathrm{atoms}/R$ for a B per atom, $6N_\mathrm{atoms}/R$ for a U per atom), six values each, independently. The larger model is taken where it passes more than 95% of the 36 tests, the smaller where it passes fewer than 30%, and in between the free set decides as everywhere else, the larger model then with its R-free lower outright rather than within the tie (the burden of the evidence is on the parameters it adds; PDB-REDO falls back on Z(R-free) and the R-free - R-work gap at fixed cut-offs instead, and the paired rule is the one every other free-set choice here uses). A U per atom is tried wherever it is affordable: where the working reflections outnumber the parameters of the model with it counted unrestrained, nine per atom with the positions as Merritt counts them - the end of the range of weights at which Hamilton's test can be taken at all - rather than above a fixed number of reflections per atom. The refined U are written as ANISOU and the TLS groups as `_pdbx_refine_tls*` and `REMARK 3` (`REFINE_ADP_MODEL`, `REFINE_ANISO_ATOMS`, `REFINE_TLS_GROUPS`). It is decided after the solvent build (§15.10), on the model with its solvent: a water a round put in refines a U of its own in the per-atom trial as every refinable atom does, and no TLS group holds a water. -5. **The model as given** is the first candidate in order of trust: where the refinement does not displace it by the - rule every trial is held to (its geometry within bounds and R-free lower beyond the tie), the model is written as - it came, scaled to the data, and the solvent build's edits are undone (`REFINE_AS_GIVEN`). What comes out is never - worse on the free set than what went in. This holds only where the free set is free to the model as given: a model + Then the weights and the displacement model are **decided again** from the model as it now is, once: the + B ceiling and the balanced weights from its B factors, the ladder from it with its displacements as they are, the + trajectory, and the displacement hypotheses from where that ends. The first choice took its weights with the + B factors as given and its displacement model after them; on a placed prediction, whose B factors are its pLDDT, + the B factors' weight balanced on them is a hundred times too stiff (the B similarity's gradient goes as $1/B$), + the middle rung wins where the tightest wins once the B factors are refined, and the TLS bodies fitted from the + refined B factors come 0.02 lower in R-free than from the B factors as given. A round is taken where it advances as a + step does - on the work-set target where its weights are those it started from, on the free set where it chose + others - and undone otherwise; where its ladder and trajectory leave the model where it was, the + hypotheses would repeat the same trials, and it ends there - from a model refined before, a round is one ladder + and one step. No round runs where the refinement does not displace the model as given. +7. **The model as given** is kept over the refinement where it displaces the refinement on the free set (its geometry + within bounds and the free set preferring it) and the refinement is not better on both R-work and R-free (the + work-set target cannot choose here, the refinement having minimised it from the model as given): the model is + written as it came, scaled to the data, and the solvent build's edits are undone (`REFINE_AS_GIVEN`). What comes + out is never worse on both free measures than what went in. This holds only where the free set is free to the model as given: a model placed as given on a free set drawn by the run (in `--mode refine`, a file without free flags) has most likely been refined against those reflections, and its R-free as given does not compete. @@ -339,7 +479,7 @@ without them, and then with them at $\sigma = 0.1$ Å at the B factors' weight t X-ray weight a rung up as often as not, the B factors' choice it never changed on 39 refinements), and every step of the trajectory also tries them changed - switched on where they are off, and in turn tightened ($\sigma$ halved) and loosened ($\sigma$ doubled, off beyond 0.4 Å) where they are on. Listed after their twin without, the restraints are -kept only where they lower R-free by more than the tie. A model without copies runs exactly the trials it ran before. +kept only where the free set prefers them. A model without copies runs exactly the trials it ran before. $w$ never exceeds $w_0/8$. The trials of one set run side by side - on one GPU, on several, or on the CPU's threads - each from the same start and taking nothing from the one before it, so the result does not depend @@ -369,7 +509,11 @@ The $mF_o - DF_c$ map of the refined model is searched for what the model leaves regions above 3 σ that peak above 4 σ, found by flood fill (GEMMI's `find_blobs_by_flood_fill`, the method of Coot's "unmodelled blobs"), each moved to the copy nearest the model and measured - peak, volume, the density integrated above the cutoff, the nearest atom, the polar (N, O) atoms at 2.4-3.4 Å and the N, O or S -at 1.8-2.6 Å, and the anomalous map at its peak. Each gets one reading, by rules on what is measured: +at 1.8-2.6 Å, and the anomalous difference map's peak height at it: the map's highest point within 1 Å of the +blob's peak, in its rms. The two maps are sampled on different grids and the anomalous scatterer need not be the +difference density's highest point, so the reading looks a little around the peak; 1 Å, half the shortest +metal-ligand bond, keeps a neighbouring modelled sulfur or metal from being read as the blob's own. Each gets one +reading, by rules on what is measured: | Reading | Rule | |---|---| @@ -380,7 +524,8 @@ at 1.8-2.6 Å, and the anomalous map at its peak. Each gets one reading, by rule | `UNASSIGNED` | anything else | They are listed strongest first (by the integrated density) in `_blobs.json`, and the five strongest -in the report, each with the anomalous difference map's height at its peak where there is that map. A blob +in the report, each with its anomalous peak height where the data carry anomalous signal (the SUMMARY's Anomalous +row; without it the reading is noise, and the report and the live page leave it out). A blob read as `LIGAND` is density of ligand size where the model has nothing: a buffer molecule or an unmodelled side chain is that as well as the compound that was soaked. The readings point a person at the density; they do not identify a compound. @@ -457,8 +602,8 @@ and removed and waters and ions relabelled, as phenix.refine builds waters withi trajectory (§15.7) ends, a round reads the maps and the audit of that model and changes its solvent; then the solvent alone - its waters and single-atom ions, the rest held - is refined at the weights the trajectory ended at (its B too, at its balanced weight where the trajectory held B, and 10 iterations a macro-cycle), and the round is kept -where that lowers R-free; where it does not but the round as built does (refining the solvent alone can lose what its -sites gained), it +where that lowers the work-set target at those weights (§15.7); where it does not but the round as built does +(refining the solvent alone can lose what its sites gained), it is kept as built; otherwise it is undone. The rest of the model goes on with its B factors held or refined as the trajectory had them. The rounds stop at one that changes nothing, at one undone, or after two (a third gains nothing measurable); the final ladder of §15.7 then @@ -623,13 +768,78 @@ The keys are `REFINE_TWIN` (`NO_TWIN_LAW`, `FREE_SET_SPLIT`, `ZERO_FRACTION`, `U `REFINE_UNTWINNED_R_WORK`/`_R_FREE`, the last five of the two refinements where they ended. Where `REFINE_TWIN` is `TWINNED`, every other `REFINE_` key, `REFINE_R_FREE_START` and the `REFINE_SCORE_` terms included, is of the twinned refinement. -### 15.13 Not yet +### 15.13 Where the free set is used + +One table for the whole run: how the free set comes about, what is fitted on which reflections, which choices it +decides and which numbers only report it. The merge draws and writes the set (§10.7); model validation and +molecular replacement (§14) and the refinement (§15) read it. Every row states the rule as the code applies it. + +**How the free set is obtained.** `R_FREE_FLAGS` names the set a run's validation and refinement used, and +`REFINE_FREE_FLAGS` the one `--mode refine` read. + +| Source | How | Reported as | +|---|---|---| +| Drawn by the merge (§10.7) | A hash of the reflection index over its orbit under the lattice holohedry, Friedel mates included - symmetry mates, Bijvoet mates and twin-law mates share one flag, so does a re-merge in any subgroup. 5 % of the distinct reflections, lifted towards 500 on small data and never above 10 %; no seed, no resolution shells. Drawn again, by the same rule, on the model's axes where a fitting model moves the setting; an indexing-ambiguity reindex leaves it as it was | `R_FREE_FLAGS= DRAWN` | +| Inherited from the reference (`-z`) | The reference's `FreeR_flag` (or `_refln.status`), matched on the merging group's Laue ASU where the merge matches the reference (CC ≥ 0.5 over at least half of its reflections); a reflection the reference lacks keeps its drawn flag | `REFERENCE`, `REFERENCE_FREE_FLAGS_INHERITED` | +| Taken from `--free-flags` | The same match, nothing else of the file used; applied on the model's axes, and only where the rigid body placed the model (§14.5) | `FILE` | +| Read by `--mode refine` | The file's `FreeR_flag`-like column, 0 the test set (the minority value where 0 is the majority); of an sf-mmCIF's classes 0-19, the class the file marks unless the model as given fits another class as it fits its working reflections; a file without flags gets a 5 % set drawn as above | `REFINE_FREE_FLAGS= FILE` / `GENERATED`, `REFINE_FREE_SET_CLASS` | +| Closed under the lattice's twin domains (§15.12) | Before a twinned refinement, every orbit under the domain operators is put in one set; a split orbit goes free with the probability of its own free share | `REFINE_TWIN_FREE_CLOSED` | +| Carried into another group | A merge expanded to the model's subgroup (§15.1) gives every new mate its parent's flag; the twin hypothesis' file (§13.2) carries the answer's flags | - | + +**What is fitted on which reflections.** The parameters of a fit are never fitted to the free reflections, with +two exceptions that are the convention of likelihood refinement: + +| Fitted quantity | Reflections | +|---|---| +| Overall scale, anisotropic B, bulk solvent (§14.2, §15.3); the rigid body (§14.8); the rotation and translation functions and the likelihood gain of molecular replacement (§14.10); the twin fraction (§14.9, §15.12); the X-ray target and its gradient, so every position, B, U and TLS parameter (§15.2); the side-chain field's energies, the population's averaged map (§15.7); $D$ of the likelihood (§15.3); Hamilton's R-ratio test (§15.7, 6.) | working only | +| $\beta$, the variance of the likelihood, per resolution bin (§15.3) | **free**; below 100 free reflections the working ones join them | +| $\sigma_A$ per shell for the validation's maps (§14.4) | **free**; a shell below 10 free reflections takes the estimate over the whole free set | + +**Decisions the free set takes.** "Paired rule" is the rule of §15.7: the candidate's $-\ln L$ of the free +reflections is lower *and* its R-free is not higher than the incumbent's by more than the standard error of the +paired difference; ties go to the incumbent (the trial listed first). + +| Decision | Compared on | Rule | Reported as | +|---|---|---|---| +| Rigid-body step kept (§14.8) | free | R-free lower than before the step; no standard error | `R_FREE_BEFORE_RIGID_BODY` | +| Indexing ambiguity, with a model and no `-z` (§14.6) | free | the indexing with the lowest R-free, where its lead over the runner-up is 3 σ beyond the leads a randomly oriented model takes; the test's resolution is widened until it holds 1000 free reflections | `MODEL_INDEXING_MARGIN*` | +| Which merge the maps come from, with a twin hypothesis (§14.9) | free | the lower R-free, the subgroup's plain or twinned against the answer's | `MAPS_FROM` | +| Molecular replacement: first copy, further copies, the group, a chain against the whole model, the twin subgroup, a carried placement (§14.10) | free, then both | the lowest R-free; a further copy lowers it by 0.01; another group must trail by 0.03 - within that margin, with as many copies, the paired per-reflection difference over work and free together decides at 3 standard errors, else `UNDECIDED` | `MR_DECISION`, `MR_COPIES` | +| Which symmetry hypothesis the model's choice settles on, where both fit within 0.03 before refinement | free | both refined; the rival replaces the validation's choice where its refined R-free is lower by more than 0.01 | `MODEL_CHOICE_DECIDED_BY`, `RIVAL_REFINE_*` | +| Reading of the model's TLS groups (§15.1) | free | paired rule, B total against B residual against the B as given | `REFINE_ADP_INPUT` | +| X-ray weights of the positions and the B factors, B held or refined (§15.7, 1., 2., 5.) | free | paired rule among the trials of a ladder or a step; a step that keeps the weights is taken on the work-set target instead | `REFINE_XRAY_WEIGHT` | +| NCS restraints on or off, and their σ (§15.5, §15.7) | free | paired rule, each rung and step with against without, tightened against loosened | `REFINE_NCS_SIGMA` | +| Displacement model: isotropic, the model's U, TLS by chain or cut, U per atom (§15.7, 6.) | work, then free | Hamilton's test on R-work decides where it passes more than 95 % or fewer than 30 % of its tests; between those the paired rule, a larger model also with its R-free lower outright. Which trials run is gated on R-free alone (TLS) or $-\ln L$ free alone (the TLS cuts, the full U weight) | `REFINE_ADP_MODEL` | +| Second round of the weights kept (§15.7, 6.) | free or work | as a step: paired rule where its weights or σ changed, the work-set target where they did not | - | +| Model as given kept over the refinement (§15.7, 7.) | free and work | paired rule for the model as given, and the refinement not better on both R-work and R-free; only where the set is free to the model as given (not a rigid-body placement on a drawn set) | `REFINE_AS_GIVEN` | +| Twin law against its null (§15.12) | free | the paired difference of $\lvert F_o - \lvert F\rvert\rvert$ over the free twin groups, 3 standard errors (2 where the L-test reads twinned); the twinned arm is stopped after its first ladder below 0.5; added domains at 3 | `REFINE_TWIN`, `REFINE_TWIN_NULL_Z`, `REFINE_TWIN_MULTI` | + +**Decided without the free set.** Whether the model fits at all, against its null (§14.5): R-work. The placement +stage's rigid bodies and B per residue (§15.1), a trajectory step at unchanged weights, the population's child, the +solvent build's rounds and the side-chain field's step (§15.7, §15.10): the work-set target. The twin fraction +(§14.9, §15.12), and molecular replacement's tNCS half-vector moves: the working reflections, or every reflection +together. + +**Reported only.** `R_WORK`/`R_FREE` and the shell table's `R_FREE` column (the model as placed, §14.3); +`REFINE_R_FREE_START`, `_PLACEMENT`, `REFINE_R_FREE` and the `REFINE_SCORE_` terms; `REFINE_TWIN_R_FREE`, +`REFINE_UNTWINNED_R_FREE` and `REFINE_TWIN_R_FREE_NULL` (the twin decision reads the null's z, never the two +R-frees); `RIVAL_REFINE_R_FREE`; the molecular-replacement table's `R_FREE`; the live page's per-shell and +refined R-free; and the flags themselves, written as `FreeR_flag` (0 free, 1 work) in the merged MTZ and the map +MTZs' `FREE`, and `_refln.status` `f`/`o` in the mmCIF. + +**Small free sets.** Nothing is cross-validated by folds: a small set is met by the floor on the draw (500 +reflections, within 10 %), by the working reflections joining the free ones for the likelihood's variance below +100, by $\sigma_A$ falling back to one estimate below 10 per shell, and by the indexing test widening its +resolution to 1000 free reflections. The paired rule's standard error is taken as 0 where only one free group +is left. + +### 15.14 Not yet What the refinement does not do yet - each a known gap, not a design choice: -- **Custom ligands and other monomer libraries.** Only the 84 compounds of §15.4 are restrained. Any other - residue is held fixed (it stays in $F_\mathrm{calc}$, the mask and the repulsions); no restraints are - generated for a new ligand, and neither a user's restraint CIF nor an external monomer library can be given. +- **Restraints for a new ligand from its chemistry.** Beyond the 95 compounds of §15.4 a ligand is restrained only + by a restraint CIF the user gives (`--restraints`; a PDB CCD entry only to its ideal coordinates' bonds, angles + and planes); any other residue is held fixed (it stays in $F_\mathrm{calc}$, the mask and the repulsions). - **TLS restraints**: a TLS group's T and L are not held positive semi-definite (only every atom's total U is kept positive definite); the TLS groups are contiguous segments of one chain, never a domain made of several. - **Global NCS and NCS of B factors**: copies are restrained locally, on their interatomic distances (§15.5), @@ -641,17 +851,21 @@ What the refinement does not do yet - each a known gap, not a design choice: density, not by refining each in turn. - **Alternative conformations and occupancies**: existing conformers are refined in place; no occupancy is refined and no conformer is added. -- **Rotamer and peptide-flip search**, and **Ramachandran restraints**. +- **Peptide-flip search** and **Ramachandran restraints** (side chains are searched over their staggered rotamers + by the side-chain field, §15.7). - **Real-space refinement**, and **jelly-body or reference-model restraints**. -- **A full Metal (Apple GPU) path**: on macOS the model density is gathered on the GPU and the rest of the - refinement runs on the CPU. +- **A full Metal (Apple GPU) path**: on macOS the model density, the atom-gradient sums, the solvent mask's + shrink and the side-chain field's sums run on the GPU and the rest of the refinement runs on the CPU. - **Validation beyond geometry**: the report gives the bond and angle rmsd, the metal-bond rmsd and the number of clashes, not a MolProbity-style analysis (Ramachandran, rotamer and clashscore statistics). ## References - R. C. Agarwal, "A new least-squares refinement technique based on the fast Fourier transform algorithm", *Acta Cryst.* **A34** (1978), 791-809 (the gradient by the FFT method, §15.2). -- N. S. Pannu & R. J. Read, "Improved structure refinement through maximum likelihood", *Acta Cryst.* **A52** (1996), 659-668, and G. N. Murshudov, A. A. Vagin & E. J. Dodson, "Refinement of macromolecular structures by the maximum-likelihood method", *Acta Cryst.* **D53** (1997), 240-255 (the maximum-likelihood amplitude target and its figure of merit, §15.2, §15.8). +- L. Piela, J. Kostrowicki & H. A. Scheraga, "On the multiple-minima problem in the conformational analysis of molecules: deformation of the potential energy hypersurface by the diffusion equation method", *J. Phys. Chem.* **93** (1989), 3339-3346, and A. Jack & M. Levitt, "Refinement of large structures by simultaneous minimization of energy and R factor", *Acta Cryst.* **A34** (1978), 931-935 (the members refined on blurred data, §15.7). +- J. Praznikar, P. V. Afonine, G. Guncar, P. D. Adams & D. Turk, "Averaged kick maps: less noise, more signal... and probably less bias", *Acta Cryst.* **D65** (2009), 921-931, and J. C. Nwachukwu, M. R. Southern, J. R. Kiefer, P. V. Afonine, P. D. Adams, T. C. Terwilliger & K. W. Nettles, "Improved crystallographic structures using extensive combinatorial refinement", *Structure* **21** (2013), 1923-1930 (the kicked members, their averaged map and the crossover residue by residue, §15.7). +- J. Desmet, M. De Maeyer, B. Hazes & I. Lasters, "The dead-end elimination theorem and its use in protein side-chain positioning", *Nature* **356** (1992), 539-542; J. Besag, "On the statistical analysis of dirty pictures", *J. R. Statist. Soc.* **B48** (1986), 259-279; R. P. Joosten, K. Joosten, S. X. Cohen, G. Vriend & A. Perrakis, "Automatic rebuilding and optimization of crystallographic structures in the Protein Data Bank", *Bioinformatics* **27** (2011), 3392-3398 (the side-chain field: states, the conditional-modes solver and its order, §15.5). +- N. S. Pannu & R. J. Read, "Improved structure refinement through maximum likelihood", *Acta Cryst.* **A52** (1996), 659-668, and G. N. Murshudov, A. A. Vagin & E. J. Dodson, "Refinement of macromolecular structures by the maximum-likelihood method", *Acta Cryst.* **D53** (1997), 240-255 (the maximum-likelihood amplitude target and its figure of merit, §15.2, §15.8; the minimiser's sparse normal matrix, §15.6). - G. N. Murshudov, P. Skubák, A. A. Lebedev, N. S. Pannu, R. A. Steiner, R. A. Nicholls, M. D. Winn, F. Long & A. A. Vagin, "REFMAC5 for the refinement of macromolecular crystal structures", *Acta Cryst.* **D67** (2011), 355-367 (D from the working set and the variance from the free, §15.3; the Kullback-Leibler form of the B restraints, §15.5; the twinned refinement §15.12 simplifies, its twin laws pruned by fraction and its fractions refined by least squares). - R. J. Read, "Improved Fourier coefficients for maps using phases from partial structures with errors", *Acta Cryst.* **A42** (1986), 140-149 (the m, D weighting of the map coefficients, §15.8). - T. O. Yeates, "Detecting and overcoming crystal twinning", *Methods Enzymol.* **276** (1997), 344-358 (the twinned intensity, §15.12). @@ -664,6 +878,7 @@ What the refinement does not do yet - each a known gap, not a design choice: - A. A. Vagin, R. A. Steiner, A. A. Lebedev, L. Potterton, S. McNicholas, F. Long & G. N. Murshudov, "REFMAC5 dictionary: organization of prior chemical knowledge and guidelines for its use", *Acta Cryst.* **D60** (2004), 2184-2195 (the restraint dictionary, §15.4). - M. Wojdyr, "GEMMI: A library for structural biology", *J. Open Source Softw.* **7** (2022), 4200 (the topology, the riding hydrogens and the blob search, §15.4, §15.9). - V. Schomaker & K. N. Trueblood, *Acta Cryst.* **B24** (1968), 63-76, and M. D. Winn, M. N. Isupov & G. N. Murshudov, *Acta Cryst.* **D57** (2001), 122-133 (TLS, and the B column total or residual to it, §15.1, §15.5); J. Painter & E. A. Merritt, *Acta Cryst.* **D62** (2006), 439-450 (TLSMD's segments, §15.7). +- W. C. Hamilton, "Significance tests on the crystallographic R factor", *Acta Cryst.* **18** (1965), 502-510, as E. A. Merritt, "To B or not to B: a question of resolution?", *Acta Cryst.* **D68** (2012), 468-477 [doi:10.1107/S0907444911028320](https://doi.org/10.1107/S0907444911028320) applies it to the displacement model, and E. Paulson, "An approximate normalization of the analysis of variance distribution", *Ann. Math. Statist.* **13** (1942), 233-235 [doi:10.1214/aoms/1177731608](https://doi.org/10.1214/aoms/1177731608) (the F point) (§15.7). - F. L. Hirshfeld, *Acta Cryst.* **A32** (1976), 239-244, A. Thorn, B. Dittrich & G. M. Sheldrick, *Acta Cryst.* **A68** (2012), 448-451, and G. M. Sheldrick, *Acta Cryst.* **C71** (2015), 3-8 (the rigid-bond, similarity and isotropy restraints of anisotropic atoms, §15.5); E. A. Merritt, *Acta Cryst.* **D68** (2012), 468-477 (the displacement model decided by test, §15.7). - A. Blondel & M. Karplus, "New formulation for derivatives of torsion angles and improper torsion angles in molecular mechanics: elimination of singularities", *J. Comput. Chem.* **17** (1996), 1132-1141 (the torsion derivatives, §15.5). - M. M. Harding, "Geometry of metal-ligand interactions in proteins", *Acta Cryst.* **D57** (2001), 401-411, and "Small revisions to predicted distances around metal sites in proteins", *Acta Cryst.* **D62** (2006), 678-682; F. Leonarski, L. D'Ascenzo & P. Auffinger, "Mg2+ ions: do they bind to nucleobase nitrogens?", *Nucleic Acids Res.* **45** (2017), 987-1004 (the metal-site distances, §15.5). @@ -672,9 +887,14 @@ What the refinement does not do yet - each a known gap, not a design choice: - Z. Dauter & M. Dauter, "Entering a new phase: using solvent halide ions in protein structure determination", *Structure* **9** (2001), R21-R26 (halides at sites with few donors, §15.10). - N. Echols et al., "Automated identification of elemental ions in macromolecular crystal structures", *Acta Cryst.* **D70** (2014), 1104-1114 (a light ion flagged by its density above the waters', §15.10). - J. Nocedal, "Updating quasi-Newton matrices with limited storage", *Math. Comp.* **35** (1980), 773-782, and D. C. Liu & J. Nocedal, "On the limited memory BFGS method for large scale optimization", *Math. Program.* **45** (1989), 503-528 (the minimiser, §15.6). +- M. R. Hestenes & E. Stiefel, "Methods of conjugate gradients for solving linear systems", *J. Res. Natl. Bur. Stand.* **49** (1952), 409-436 (the normal equations of the minimiser, §15.6). +- C. C. Paige, "Error analysis of the Lanczos algorithm for tridiagonalizing a symmetric matrix", *J. Inst. Maths Applics* **18** (1976), 341-349, and A. Greenbaum, "Behavior of slightly perturbed Lanczos and conjugate-gradient recurrences", *Linear Algebra Appl.* **113** (1989), 7-63 (the loss of orthogonality the minimiser's conjugate gradients are kept from, §15.6). +- K. Levenberg, "A method for the solution of certain non-linear problems in least squares", *Q. Appl. Math.* **2** (1944), 164-168, and D. W. Marquardt, "An algorithm for least-squares estimation of nonlinear parameters", *J. Soc. Ind. Appl. Math.* **11** (1963), 431-441 (the minimiser's trust floor per atom, §15.6). - A. T. Brünger, M. Karplus & G. A. Petsko, "Crystallographic refinement by simulated annealing: application to crambin", *Acta Cryst.* **A45** (1989), 50-61 (the starting weight from the ratio of the gradients, §15.7). - P. V. Afonine et al., "Towards automated crystallographic structure refinement with phenix.refine", *Acta Cryst.* **D68** (2012), 352-367 (weights chosen among refinements by R-free within geometry bounds, and the overall B moved into the atoms, §15.3, §15.7). - A. T. Brünger, "Free R value: a novel statistical quantity for assessing the accuracy of crystal structures", *Nature* **355** (1992), 472-475 (R-free). +- I. J. Tickle, R. A. Laskowski & D. S. Moss, "Rfree and the Rfree ratio. II. Calculation of the expected values and variances of cross-validation statistics in macromolecular least-squares refinement", *Acta Cryst.* **D56** (2000), 442-450 [doi:10.1107/S0907444999016868](https://doi.org/10.1107/S0907444999016868) (the standard error of one R-free, against which the paired error of §15.7 is set). +- R. P. Joosten, F. Long, G. N. Murshudov & A. Perrakis, "The PDB_REDO server for macromolecular structure model optimization", *IUCrJ* **1** (2014), 213-220 [doi:10.1107/S2052252514009324](https://doi.org/10.1107/S2052252514009324), and R. P. Joosten, K. Joosten, G. N. Murshudov & A. Perrakis, "PDB_REDO: constructive validation, more than just looking for errors", *Acta Cryst.* **D68** (2012), 484-496 [doi:10.1107/S0907444911054515](https://doi.org/10.1107/S0907444911054515) (choices taken only where more than one free measure agrees, §15.7). - G. J. Kleywegt, "Use of non-crystallographic symmetry in protein structure refinement", *Acta Cryst.* **D52** (1996), 842-857; I. Usón, E. Pohl, T. R. Schneider, Z. Dauter, A. Schmidt, H.-J. Fritz & G. M. Sheldrick, "1.7 Å structure of the stabilized REIv mutant T39K. Application of local NCS restraints", *Acta Cryst.* **D55** (1999), 1158-1167; R. A. Nicholls, F. Long & G. N. Murshudov, "Low-resolution refinement tools in REFMAC5", *Acta Cryst.* **D68** (2012), 404-417; J. J. Headd et al., "Flexible torsion-angle noncrystallographic symmetry restraints for improved macromolecular structure refinement", *Acta Cryst.* **D70** (2014), 1346-1356 (local NCS restraints with a robust loss, decided by R-free, and Murshudov et al. 2011 above for the copies found by alignment, §15.5, §15.7). - P. Emsley, B. Lohkamp, W. G. Scott & K. Cowtan, "Features and development of Coot", *Acta Cryst.* **D66** (2010), 486-501 (unmodelled blobs, §15.9). - N. Naleem, A. Henning-Knechtel, S. Kirmizialtin & P. Auffinger, "Cat_Wiz: a stereochemistry-guided toolkit for locating, diagnosing, and annotating Mg2+ ions in RNA structures", *Nucleic Acids Res.* **54** (2026), gkag120; F. Leonarski, L. D'Ascenzo & P. Auffinger, *Nucleic Acids Res.* **45** (2017), 987-1004 and *RNA* **25** (2019), 173-192; F. Leonarski, A. Henning-Knechtel, S. Kirmizialtin, E. Ennifar & P. Auffinger, *Nucleic Acids Res.* **53** (2025), gkae1148 (the coordination bands, distances and exclusion zone of the solvent audit, §15.10). diff --git a/docs/EXTERNAL_TEST_DATA_STILLS.md b/docs/EXTERNAL_TEST_DATA_STILLS.md index d9e62a2f7..9865cb32d 100644 --- a/docs/EXTERNAL_TEST_DATA_STILLS.md +++ b/docs/EXTERNAL_TEST_DATA_STILLS.md @@ -56,7 +56,7 @@ broken download resumes with `curl -C -`. | Set | Files | Images used | Of the entry | Size | |---|---|---|---|---| | `sacla243` | `sacla_243/raw_all/run*.h5`: all 87 files of `243/Complete_dark/` | 52,151 | all (the deposition's 52,151) | 198 GB | -| `sacla237` | `sacla_237/raw/`: the 18 files `run130637-0` to `run130642-2` of `237/SACLA_raw/2022Nov/dark_ref/` | 10,792 | **subset**: 18 of about 1,000 `dark_ref` files, about 1.8% of ~600,000 hits | 48 GB | +| `sacla237` | `sacla_237/raw/run*.h5`: the 90 files `run130637-0` to `run130666-2` of `237/SACLA_raw/2022Nov/dark_ref/` | about 53,000 | **subset**: 90 of about 1,000 `dark_ref` files, about 9% of ~600,000 hits | 230 GB | | `sacla236` | `sacla_236/raw/`: the 18 files `run157084-0` to `run157089-2` of `236/Data/lyso01-apo-bigXtal/` | 16,083 | all (the deposition's 16,083) | 67 GB | | `pal86` | `pal_86/raw/`, `pal_86/raw_more/`: `CXIDB_86_themolysin_{2..25}_SFX_Nam.cxi` (file 1 is truncated on the server and cannot be opened) | 49,193 | all but file 1 (24 of 25 files) | 111 GB | | `pal90` | `pal_90/raw/`: `CXIDB_90-GI_SFX-filter-r00{01..14}-c00.cxi` | 79,805 | all 14 filtered files of the entry | 159 GB | diff --git a/docs/FPGA.md b/docs/FPGA.md index 1a4a0c9b4..d2e8641f8 100644 --- a/docs/FPGA.md +++ b/docs/FPGA.md @@ -22,14 +22,10 @@ are necessary. It is designed for detector directly connected to the Jungfraujoc See [network documentation](FPGA_NETWORK.md) for details of network. -## Building firmware -The firmware build targets are generated by CMake only when `vivado` and `vitis_hls` are detected in -the path, and the Vivado version has to match the one below precisely. - -### Xilinx Vivado -The following procedures require having AMD (Xilinx) Vivado and Vitis HLS toolsets version **2022.2** installed on the machine. -Due to the nature of TCL scripts used to generate board designs Vivado version has to exactly match one provided above - -specifically newer versions of Vivado will not work. +## Firmware +The firmware is not built from this repository: the HLS (`fpga/hls/`) and RTL (`fpga/hdl/`) sources are +kept as a reference of what the card does, and the build has no firmware targets. The bitstreams were +made with AMD (Xilinx) Vivado and Vitis HLS **2022.2**. In addition to the Intellectual Property (IP) cores included in Vivado, two additional licenses are necessary: * Non-cost license for Ultrascale+ 100G core has to be requested from AMD/Xilinx website, see [Xilinx website](https://www.xilinx.com/products/intellectual-property/cmac_usplus.html), to build `100g` design. @@ -37,43 +33,9 @@ In addition to the Intellectual Property (IP) cores included in Vivado, two addi PSI received non-cost licenses from Xilinx University Program for the latter cores. Therefore, usage of bitstreams generated by PSI continuous integration pipeline for `8x10g` is only allowed for non-commercial use. -### HLS compilation -Make HLS routines: -``` -mkdir build -cd build -cmake .. -make hls -``` - -### Synthesis -Create PCIe `100g` bitstream with the following command: -``` -mkdir build -cd build -cmake .. -make pcie_100g -``` -and `8x10g`: -``` -mkdir build -cd build -cmake .. -make pcie_8x10g -``` -### When Vivado is not present - -During CMake execution, the following executables: `vivado` and `vitis_hls` must be present in the path. -If not, build targets will not be generated, and such or similar error message will show up: -``` -$ make pcie_100g -make: *** No rule to make target 'pcie_100g'. Stop. -``` - ### Firmware releases The firmware is stable and is carried from version to version: the MCS files attached to a release -are normally the ones from the release before it (see [Release contents](RELEASE_CONTENTS.md)). When -it does need to change, it is rebuilt with the targets above on a machine with Vivado. +are normally the ones from the release before it (see [Release contents](RELEASE_CONTENTS.md)). ## Frame generator diff --git a/docs/FPGA_LICENSE.md b/docs/FPGA_LICENSE.md index 540a96050..a9cdfe142 100644 --- a/docs/FPGA_LICENSE.md +++ b/docs/FPGA_LICENSE.md @@ -1,6 +1,8 @@ # FPGA license FPGA components of Jungfraujoch are licensed using OHL-S license. See full text below. +The exception is the PCIe kernel driver (`fpga/pcie_driver`), which is software and is licensed under +GPL-2.0-or-later (see `fpga/pcie_driver/LICENSE`). The license is equivalent of GNU Public License with adaptations for hardware. See [OHL webpage](https://ohwr.org/project/cernohl/-/wikis/Documents/CERN-OHL-version-2) for details and FAQs. diff --git a/docs/GPU_DATA_ANALYSIS.md b/docs/GPU_DATA_ANALYSIS.md index 82343dbdb..18d66d690 100644 --- a/docs/GPU_DATA_ANALYSIS.md +++ b/docs/GPU_DATA_ANALYSIS.md @@ -12,7 +12,7 @@ computes. The methods themselves are described once, in the (`JFJOCH_USE_CUDA=OFF`) runs the whole pipeline on it, the `ffbidx` indexer included (an in-tree CPU port of the library's kernels). How closely the two agree is stated engine by engine below and in the source: where the arithmetic is integer, or the order of every sum is fixed to -the host's, the result is the same to the bit; where the GPU uses float distances, cuFFT for FFTW, or a +the host's, the result is the same to the bit; where the GPU uses float distances, cuFFT for pocketfft, or a different (fixed) summation order, the two agree to rounding. Every engine is deterministic on its own - no floating-point atomics decide a result - so the same input gives the same output on every run of a GPU build. @@ -74,7 +74,7 @@ nothing. stays on the host. [§1.4](CPU_DATA_ANALYSIS_IMAGE.md#14-the-beam-centre) - **Beam centre by FFT** (`BeamCenterFFTGPU.cu`) - the self-convolutions that score every candidate centre at once, their combination into one score surface, and the shortlist of its peaks, with only - the shortlist brought back. Runs on FFTW on the host instead where it would need more than half of + the shortlist brought back. Runs on the CPU FFT on the host instead where it would need more than half of the card's total memory, decided before the card is touched and logged. [§1.4](CPU_DATA_ANALYSIS_IMAGE.md#14-the-beam-centre) @@ -158,7 +158,7 @@ total and not on what is free, the same input on the same card always takes the The model's structure factors and the rigid body run on the card where there is one, every part placed on it or on the CPU up front against one budget, 80% of the card's total memory ([§14.8](CPU_DATA_ANALYSIS_DECISIONS.md#148-rigid-body-placement-of-the-model)); the GPU and CPU -agree to rounding (float distances, cuFFT for FFTW, the crystal's symmetry composed in reciprocal +agree to rounding (float distances, cuFFT for pocketfft, the crystal's symmetry composed in reciprocal space instead of by symmetrizing the grid). On a machine with several cards, the rigid-body engines the first card has no room for go on the others, each against its own budget. @@ -217,7 +217,7 @@ reflections, the grids, the symmetry and the restraints resident, and per evalua positions up and one value and one gradient per atom back. Everything that depends on the cell, the group and the reflections - the grids, the operators, the adjoint's lists - is worked out once on the host with gemmi when the engine is made. The GPU and CPU engines compute the same target to rounding (float distances and densities, -cuFFT for FFTW, summation order); the GPU's result is the same from run to run, as no sum of a result is a +cuFFT for pocketfft, summation order); the GPU's result is the same from run to run, as no sum of a result is a floating-point atomic: every per-point, per-reflection and per-atom sum is a gather in a fixed order, and every total a `cub::DeviceReduce` tree, whose order for a given size is fixed. @@ -342,7 +342,7 @@ mask 15-18% at low resolution. Inside a full `rugnux --model` run of a 5,000-ato ## Apple GPUs (Metal) -A macOS build has no CUDA, and three engines run on the Apple GPU instead (none under +A macOS build has no CUDA, and six engines run on the Apple GPU instead (none under `rugnux --no-gpu`; where the GPU fails, the CPU takes over with a warning): - **Bragg integration** (`BraggIntegrationEngineMetal.mm`, `.metal`) - the CPU engine with its @@ -358,6 +358,15 @@ A macOS build has no CUDA, and three engines run on the Apple GPU instead (none for model validation and molecular replacement, as a gather over bricks of the grid as under CUDA; the same grid as the CPU's **to the bit**. [§14.1](CPU_DATA_ANALYSIS_DECISIONS.md#141-model-structure-factors) +- **Refinement gradient** (`AtomGradientMetal.mm`, `.metal`) - the sums of the CPU refinement + engine's gradient over the FFT method's map, each atom's box walked by one SIMD group as under CUDA; + the CPU's points, summed in single precision, so the gradient is the CPU's to a few parts in 1e5 + (a macOS CI step checks it against the CPU's). It halves the time of a refinement on the CPU engine. +- **Side-chain field** (`SideChainFieldMetal.mm`, `.metal`) - the direct sums of every side-chain state's + structure factors over the reflections, one thread per reflection and state; the CPU's sums **to the bit** + (the B factor's exp is `BraggExp.h` on both), which a macOS CI step checks. +- **Bulk-solvent mask shrink** (`ShrinkMaskMetal.mm`, `.metal`) - the mask's shrink by the 0.8 Å radius, + one thread per grid point; the same mask as the CPU's **to the bit**, which a macOS CI step checks. - **Molecular-replacement rotation function** (`MolecularReplacementMetal.mm`, `.metal`) - the rotation function's trial orientations scored from a copy of the molecular transform; equal to the CPU's to rounding. diff --git a/docs/HDF5.md b/docs/HDF5.md index ddbc515dd..fa6640edc 100644 --- a/docs/HDF5.md +++ b/docs/HDF5.md @@ -391,6 +391,7 @@ in the data files only). | `imageScaleMosaicity` | deg | scaling-model mosaicity | | `sweepQuality` | | why this image's stretch of the sweep was flagged — see below | | `frameDisposition` | | what became of this image's observations in the merged data — see below | +| `imageMerged` | | image's observations reached the merged data (0/1); written by rugnux beside the merge (stills: the crystal took part; rotation: the frame is not `rejected` in `frameDisposition`), absent where no merge ran (`--no-merge`) and in files written before it existed | **Per-image lattices:** `latticeIndexed` `[n_images, 9]` (Å) — the real-space lattice (flattened 3×3); `latticeIndexedExtra` `[n_images, max_extra_lattices, 9]` (Å) — additional orientation @@ -595,7 +596,7 @@ one keep them only where every input has them. | Path | Class | Content | |------|-------|---------| -| `/entry/instrument/detector/detectorSpecific` | NXcollection | Dectris-style detector metadata + Jungfraujoch fields: `x_pixels_in_detector`, `y_pixels_in_detector`, `nimages`, `ntrigger`, `nimages_collected`, `nimages_written`, `data_collection_efficiency`, `max_receiver_delay`, `storage_cell_number`, `storage_cell_delay` [ns], `software_git_commit`, `software_git_date`, `jfjoch_release`, `jfjoch_writer_release`, `summation_mode`, `detect_ice_rings`, `gain_file_names`, `data_reduction_factor_serialmx`, `adu_histogram/` (`bin_width` and one vector per storage cell), `data_collection_efficiency_image`, `direct_beam_x`, `direct_beam_y`, `pixel_mask` (hard-linked as `/entry/instrument/detector/pixel_mask`), `storage_cell_image` (VDS, with storage cells) | +| `/entry/instrument/detector/detectorSpecific` | NXcollection | Dectris-style detector metadata + Jungfraujoch fields: `x_pixels_in_detector`, `y_pixels_in_detector`, `nimages`, `ntrigger`, `nimages_collected`, `nimages_written`, `data_collection_efficiency`, `max_receiver_delay`, `storage_cell_number`, `storage_cell_delay` [ns], `software_git_commit`, `software_git_date`, `jfjoch_release`, `jfjoch_writer_release`, `summation_mode` (`none`, `fpga`, `cpu` or `hybrid`: card and host both sum), `detect_ice_rings`, `gain_file_names`, `data_reduction_factor_serialmx`, `adu_histogram/` (`bin_width` and one vector per storage cell), `data_collection_efficiency_image`, `direct_beam_x`, `direct_beam_y`, `pixel_mask` (hard-linked as `/entry/instrument/detector/pixel_mask`), `storage_cell_image` (VDS, with storage cells) | | `/entry/instrument/detector/calibration` | NXcollection | per-channel pedestal / calibration images (bitshuffle-compressed) | | `/entry/instrument/fluorescence` | NXcollection | XRF spectrum: `energy` [eV], `data` | | `/entry/user` | NXcollection | scalar values supplied under `header_appendix.hdf5` | diff --git a/docs/JFJOCH_BROKER.md b/docs/JFJOCH_BROKER.md index f50df98d3..e97402241 100644 --- a/docs/JFJOCH_BROKER.md +++ b/docs/JFJOCH_BROKER.md @@ -204,8 +204,7 @@ back to the broker, so with it the route answers 409. ## Online analysis -Without rugnux live mode, and in the FPGA workflow also for a rotation collection with it, the broker analyses each -image on its own: masking, summation, azimuthal and ROI integration, spot finding, and - with indexing on - indexing +Without rugnux live mode the broker analyses each image on its own: masking, summation, azimuthal and ROI integration, spot finding, and - with indexing on - indexing of the image and refinement of its geometry (`geom_refinement_algorithm`). A rotation collection is indexed image by image, as a serial one. The broker neither integrates Bragg reflections nor determines a lattice for the whole rotation sweep, so the reflections, the per-image B-factor and integrated-reflection count, and the rotation lattice are filled only where @@ -221,7 +220,9 @@ goniometer and the rugnux live setting: | Input | Run | Receiver | What it does | |---|---|---|---| -| FPGA cards (PSI JUNGFRAU, PSI EIGER) | every run | `JFJochReceiverFPGA` | the card's converted pixels, spots, azimuthal and ROI sums into the image; summation on the host above what the card sums; indexing of each image; the calibration to the writer; pedestal runs into the pedestal and its RMS; with rugnux live on, a serial run analysed on the GPU after a rugnux pre-pass (see [Serial collections](#serial-collections-experimental)) | +| FPGA cards (PSI JUNGFRAU, PSI EIGER) | pedestal run | `JFJochReceiverPedestal` | the raw frames into the pedestal and its RMS; nothing on any stream | +| FPGA cards | rugnux live off | `JFJochReceiverFPGA` | the card's converted pixels, spots, azimuthal and ROI sums into the image; summation on the host above what the card sums; indexing of each image; the calibration to the writer | +| FPGA cards | rugnux live on | `FPGAImagePuller`, then `JFJochReceiverRugnuxRotation` or `JFJochReceiverRugnuxStills` (`JFJochReceiverLite` for a rotation run the image buffer cannot hold) | the cards' frames assembled (and summed above what the cards sum) and compressed on the host into a stream as a DECTRIS detector gives, then taken as the DECTRIS rows below; the pedestal and gain calibration is not written to the file on this path | | DECTRIS stream | dark-mask sequence | `JFJochReceiverDarkMask` | the dark frames into the mask; nothing on any stream | | DECTRIS stream | rugnux live off, or a rotation run the image buffer cannot hold | `JFJochReceiverLite` | each image on the GPU: masking, azimuthal and ROI integration, spot finding, indexing | | DECTRIS stream | rugnux live on, rotation that fits the image buffer | `JFJochReceiverRugnuxRotation` | images forwarded as they come; rugnux reads the collection back from the image buffer and runs the whole pipeline | @@ -229,19 +230,27 @@ goniometer and the rugnux live setting: `receiver_threads` is the number of image threads. The Lite receiver uses at most 16 of them for a collection at 100 Hz or slower or of fewer than 256 images (each thread holds a GPU analysis of its -own); the FPGA receiver takes four when it sums images on the host. The GPU FFT indexers and cuFFT +own); the FPGA receiver takes four when it sums images on the host. The rugnux live analysis of a serial +collection does not take its threads from `receiver_threads`: it runs 16 GPU analysis threads a card (fewer on a +card whose memory does not hold 16 of them). The GPU FFT indexers and cuFFT plans the broker's own indexing uses are built once and kept for the life of the process, and the ones built for earlier indexing settings are released when the settings change. `azim_int.force_cpu` moves the azimuthal integration of the FPGA workflow from the card to the host, which a profile with more bins than the card holds needs. +A card sums up to 256 frames into an image. For more, it sums the largest number of frames up to 256 that divides +the frames of an image (250 of 1000) and the host adds up the card's images (4 of 250 each), in 32 bits, saturating; +a pixel in error or saturated in any of them is so in the sum, and a module missing from any of them is missing +from the image. A prime number of frames above 256 is summed on the host entirely, at the cost of reading every +frame. The start message and the master file's `summation_mode` say which: `fpga`, `hybrid` or `cpu`. + ## Rugnux live mode With rugnux live mode on, collections from a DECTRIS detector are processed inside the broker while they arrive: rotation collections by rugnux, and serial (stills) collections on the GPU with the geometry and mask a rugnux pre-pass decided (see [Serial collections](#serial-collections-experimental) below). In the FPGA workflow -(PSI JUNGFRAU and EIGER) serial collections are analysed on the GPU after a pre-pass as well, with the differences -given there; rotation collections run image by image, as with the mode off. It is off by default; the +(PSI JUNGFRAU and EIGER) the frames reach the same receivers through `FPGAImagePuller`, rotation and serial alike. +It is off by default; the configuration file switches it on with `"rugnux": {"enable": true, "reserved_cpus": 4}`, where `reserved_cpus` is the number of CPU threads left to the receiver and the image pusher. @@ -278,7 +287,17 @@ a placed model build the solvent as well: waters added at difference-map peaks a hold them, waters and ions relabelled; `model.refinement` in `/rugnux/status` then carries `waters_added` and `waters_removed`. `force_still` (`rugnux --force-still`) sends a rotation collection from a DECTRIS detector the serial way: pre-pass, GPU analysis and stills merge (see [Serial collections](#serial-collections-experimental)). -The analysis takes the frames without the goniometer; the master file keeps it. It does not change the FPGA workflow. +The analysis takes the frames without the goniometer; the master file keeps it. + +`stills_downsample` (default 1) lets a serial collection analyse on average 1 of every this many images, to keep up +with a stream faster than the analysis. Each image is chosen on its own, with probability 1 / `stills_downsample` +from a hash of its number: not every n-th image, which would be in step with a periodic pattern of the stream +(pump-probe on/off, storage cells) and could take, for example, only the dark frames. The choice is reproducible. +The images the pre-pass looks at (`stills_prepass_images`, below) are all analysed. An image not chosen is written as +it came, without its analysis. Reset to 1 by `POST /initialize`, as `force_still` and `refine_solvent` are. + +`stills_prepass_images` (default 1000, 100 to 20000) is how many of the first images of a serial collection the +pre-pass looks at (see [Serial collections](#serial-collections-experimental)). Reset to 1000 by `POST /initialize`. The end message, and with it the end of the collection, waits for the analysis. `deadline_s` (default 60 s; 0 for no cutoff) bounds that wait: this long after the last image the analysis is cut. `POST /cancel` is @@ -295,7 +314,9 @@ and before the end message - seconds on a GPU, minutes on a broker without one. cut while it runs cuts it short with what its finished weight trials found (`model.refinement.cancelled`). The refined model and its maps stay with the broker: the writer writes the placed model, as without refinement. `GET /rugnux/status` gives the refined R-work and R-free, the bond and angle rmsd, the time it took and the unexplained blobs of the refined difference map -(`model.refinement`), and `/rugnux/model.cif` and `/rugnux/map.ccp4` serve the refined model and its maps +(`model.refinement`; each with the anomalous difference map's peak height at it, `anomalous_sigma`, where the merge +kept the Bijvoet pairs - a reading of the blob only where `anomalous_signal` is set, and the page shows it only +then), and `/rugnux/model.cif` and `/rugnux/map.ccp4` serve the refined model and its maps (`stage=placed` for the model as placed; the anomalous map is always on the placed model's phases). `GET /rugnux/status` reports the live run of the last collection, kept until the next one starts or @@ -306,8 +327,10 @@ found, and once it is over the verdict, the summary, warnings and the time from every result written. `shells` carries the merging statistics by resolution shell - the rows of the shell table of `_report.txt`, on the same shells: multiplicity, ⟨I/σ⟩, completeness, CC1/2, R_meas (rotation), R_split (serial), CCref (with reference data) and the R-free of the placed model as given (with a -model), each absent where the run does not measure it - and `shells_merge` the merge they are of. A rotation -run fills them when it is over; a serial one at each provisional merge and at the end, the R-free once the model +model), each absent where the run does not measure it - and `shells_merge` the merge they are of. With them come +the merge's `d_min`, the written range, and `resolution_fit`, where the CC1/2 fall-off is fitted: the resolution to +quote, which the written range deliberately reaches a shell beyond (the page marks the fit on its shell plots). +A rotation run fills them at the scaling checkpoint, before the model work; a serial one at each provisional merge and at the end, the R-free once the model step on that same merge has its result. A rotation run also leaves `frame_scales`, the per-image scale factor of the merge, and `frame_ranges`, the stretches of the sweep the merge downgraded or rejected (the report's SWEEP section) with the reason it saw there - which frames rugnux left out, and why. The web frontend shows it on the @@ -337,46 +360,65 @@ Live processing of serial collections is **experimental**. With rugnux live mode (non-rotation) collection from a DECTRIS detector, in the standard detector mode, is analysed frame by frame: the frames as the stream delivers them go to GPU spot finding, indexing and integration, with rugnux's stills spot finder (adaptive threshold, single-pixel spots kept). Before any frame is analysed, the first -500 frames are run through rugnux, in memory, as `rugnux --no-merge` would run on them. That pre-pass -decides the beam centre, refines the detector distance (where the dataset settings give a unit cell) and -masks the beam-stop shadow and defective pixels; every frame of the collection is then analysed with that -geometry and mask. The start message waits for the pre-pass, so it states them, and the end message carries -the centre and distance used (`refined_beam_center_x/y`, `refined_detector_distance_mm`, -[CBOR](CBOR.md)). The broker's own distance is taken as the beamline's: unlike offline rugnux, the pre-pass -does not search the whole distance range. It refines the centre and distance for a detector square to the -beam, as the frames are then analysed. At a serial hit rate the distance needs the 500 frames to be refined at -all: on fewer, too few index for the geometry refinement to run, and the stated distance is kept. The pre-pass -holds and fits on at most half the slots of the image buffer (a slot is the size of an uncompressed -frame), so a smaller buffer starts it on as many as that. - -Where a unit cell is given and those frames are too few for the geometry fit (200 indexed frames), frames go on -being held and the pre-pass runs again on all of them each time they have doubled, until the fit has its frames, half -the image buffer or 2000 frames are held, or the collection ends; frames arriving during a run do not make the next -one larger than that, so the last run stays short. The analysis starts when the pre-pass ends and catches up from the -frames waiting, so it starts later on a low hit rate. +`stills_prepass_images` frames (default 1000) are run through rugnux once, in memory, as `rugnux --no-merge` would run +on them. That pre-pass makes one decision about the geometry: where the dataset settings give a unit cell and at least +6 of those frames are strong indexed frames (20 or more spots on the lattice), the beam centre, detector distance and cell are refined on them (the +bundle indexed again at the fitted geometry until it stays put). With fewer, the distance and cell of the dataset +settings are kept, and the beam centre is decided as offline rugnux decides a stills centre: the dataset settings' +against the ones the scattered background points to (its isotropy walk and point-symmetry capture), each indexed on +the same sample of the frames at the stated distance (the live pre-pass does not search the distance). The +background's is taken where it puts materially more spots on the lattice; where nothing indexes, the stated centre +stays. Where the centre moved, the geometry fit is asked again +from it, and refines the geometry if it now finds 6 strong frames. The log and the live status say which: "Geometry +refined from K of N frames", "Fewer than 6 strong frames in the first N: header distance ..., beam centre ... from +the scattered background", or "... header geometry used". Independently of the hits, the same pre-pass measures on the start of those frames (about 60 of them, +empty ones as good as any) what needs only the X-ray beam: the beam-stop shadow, defective pixels, saturation, the +polarization plane, the background ring and signal radius of the integration, and powder rings. Every frame of the +collection is then analysed with that geometry and mask. The start message waits for the pre-pass, so it states them, +and the end message carries the centre and distance used (`refined_beam_center_x/y`, `refined_detector_distance_mm`, +[CBOR](CBOR.md)). The broker's own distance is taken as the beamline's: unlike offline rugnux, the pre-pass does not +search the whole distance range. It refines the centre and distance for a detector square to the beam, as the frames +are then analysed. The pre-pass holds its frames in half of the image buffer's slots, one frame to a slot (below): +where the `stills_prepass_images` frames do not fit there, `/start` refuses the collection (HTTP 400, or the error of `/wait_till_done` after an asynchronous start) before the +detector is armed, saying how large the image buffer must be. +The analysis starts when the pre-pass ends and catches up from the frames waiting. The geometry is fixed when the pre-pass ends and does not change during the collection, so every frame is analysed -and merged at it and the radial profile has one binning throughout. Where the pre-pass could not refine it (too few -of its frames indexed, as with a small image buffer, a low hit rate or a chip whose first frames are empty, or no unit -cell given), the distance in the header is used for the whole run: this is a warning in the log and a note of the -live status, and a wrong header distance then costs resolution and indexed frames. +and merged at it and the radial profile has one binning throughout. Where the pre-pass did not refine it (fewer than 6 +strong frames among its images, as with a low hit rate or a chip whose first frames are empty, or no unit cell +given), the header distance and cell are used for the whole run: a wrong header distance then costs resolution and +indexed frames, and a larger `stills_prepass_images` gives the fit more frames to find. -Frames arriving during the pre-pass, or faster than the analysis, wait in the image buffer, in all its slots but -one per analysis thread, kept for sending; a frame that finds it full is dropped and counted as for a full image -buffer, so analysis slower than the frame rate costs frames, not memory. Where the writer lags behind, the analysis -waits for slots to come back. A pre-pass that fails leaves the stated geometry and +Frames arriving during the pre-pass, or faster than the analysis, wait in the image buffer, one frame to a slot, +whatever its compression; the image routes serve them from there, as images without analysis, while they wait. A +frame takes a slot only while more than half of the slots are free: the other half is for the analysed frames, which +go to the writer from a slot each. A slot is the largest compressed image plus 4 MiB for the per-image metadata, so + + slots = image_buffer_MiB × 1 MiB / (largest compressed image + 4 MiB) + +and N = `stills_prepass_images` frames need N slots, which are half of the buffer's: 2N slots in all, an image +buffer of at least 2 × N × slot. Nothing is written before the pre-pass, so it always holds `slots / 2` frames; a +collection with N larger (and more than N images) is refused at the start. After the pre-pass, frames waiting for the writer use slots too, and fewer frames wait. The +receiver's image memory is the image buffer (`image_buffer_MiB`, `-B` of `jfjoch_fpga_stills_test`) and nothing +beside it. No stage on the host discards a frame: a frame that finds no slot it may take waits until the analysis +has made room, and the wait goes back to the source - from FPGA cards, `FPGAImagePuller` holds the cards' buffers and +the cards wait for the host, so analysis slower than the frame rate costs frames at the card, not memory. An analysed +frame that finds no slot to be written from within 2 s is not written and is counted as for a full image buffer. A pre-pass that fails leaves the stated geometry and mask in use. Where the start message cannot be sent after the pre-pass (no writer listening) or the analysis cannot be set up, the collection ends with that error, reported by `/status` and `/wait_till_done`, and the next `/start` runs as usual. +The frames are indexed on at most `max_spot_count` spots of the dataset settings where it is given; left out, on as +many as the pre-pass measured (at most 1000, as `rugnux`), while the per-image analysis without rugnux live keeps 250. + The indexed frames are also merged, as `rugnux --mode scale` merges stills, in memory - in the consensus cell of the frames indexed by the first merge (the cell of the dataset settings only picks the frames that are -merged) and the space group of the dataset settings (else P1). -At half and at three quarters of the images the frames so far are merged beside the analysis, on 8 threads, and +merged) and the space group of the dataset settings (else P1): a space group given for the collection is binding. +At half of the images the frames so far are merged beside the analysis, on 8 threads, and the result is reported as a provisional step note: crystals, resolution, CC1/2, R_split, completeness and -⟨I/σ⟩. The first of these merges scales and post-refines every crystal so far and decides the indexing +⟨I/σ⟩. This merge scales and post-refines every crystal so far and decides the indexing ambiguity from the data; every crystal after it is placed in its indexing, scaled and post-refined against -the latest of them as it arrives. After the last frame only the error model, the merge, the resolution cut +it as it arrives. After the last frame only the error model, the merge, the resolution cut and the statistics are left to do, on every thread - a few seconds for a chip of 160,000 frames on the full JUNGFRAU 8M, against about half a minute for the same merge made from nothing. The merged data travel to the writer in the end message, as for rotation (`.mtz`), and the run's step "Merge" carries the @@ -414,20 +456,20 @@ pre-pass state and duration, the stated and decided beam centre and distance, th images analysed and indexed with the analysis rate. The "Rugnux live" page of the web frontend shows the same. `tools/jfjoch_stills_gpu_replay` replays a stored serial collection through the same analysis. -In the FPGA workflow (JUNGFRAU), a serial collection with rugnux live mode on is analysed by the receiver of the -card (`JFJochReceiverFPGA`) with the pre-pass, the GPU analysis and the live merge described above, with three -differences: the converted frames wait for the analysis in at most half of the image buffer's slots, a frame that -finds them taken is dropped, and there is no model step - an uploaded model is not placed or refined on these -merges. The end message carries the merged data, as for a DECTRIS stream. +In the FPGA workflow (JUNGFRAU), a serial collection with rugnux live mode on is assembled on the host by +`FPGAImagePuller` and analysed by `JFJochReceiverRugnuxStills` exactly as a DECTRIS stream. +`tools/jfjoch_fpga_stills_test` measures this path on the cards with a stored dataset (see [Tools](TOOLS.md)). ## Setting up a local test for Jungfraujoch For development, it is possible to set up a local installation of Jungfraujoch. This will work without FPGA installed in the computer and allows testing the 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 a large performance penalty on the CPU. In the CPU simulation mode, one can simulate -using only a single FPGA device. +Without a `pcie` entry in the configuration, the broker runs on a mock of the FPGA card (`MockAcquisitionDevice`): +it behaves like the card towards the host - frames, completions, counters, start/stop/cancel, the internal frame +generator - but computes nothing. The images streamed and written are the ones uploaded as the internal generator's +images, unconverted; the card's spot finding, ROI and azimuthal results are zero in this mode (with rugnux live on, +the GPU analysis finds its own spots). To run the test: diff --git a/docs/JFJOCH_VIEWER.md b/docs/JFJOCH_VIEWER.md index 7103a42e2..832f98dfc 100644 --- a/docs/JFJOCH_VIEWER.md +++ b/docs/JFJOCH_VIEWER.md @@ -234,6 +234,8 @@ keyboard without them `Home` / `End` are `Fn`+`←` / `Fn`+`→` and `Page Up` / | Dataset-info plot: `Shift` + hover | Load the hovered image | | Spot / reflection list: double click | Zoom the diffraction image on that spot or prediction | | Image list: double click | Load that image | +| Image list: click a column header | Sort by that column (Index and Merged sort Yes, No, N/A) | +| Image list: right click the Index or Merged header | Filter the rows by that column - tick Yes, No or N/A; a filtered header is marked `*`, and the two filters combine, so Index Yes with Merged No lists the images indexed but not merged. Merged is read from `/entry/MX/imageMerged` of a rugnux `_process.h5` and is N/A for a file without it | ## Opening data diff --git a/docs/LICENSE.md b/docs/LICENSE.md index b5ae8c25b..77bbb130b 100644 --- a/docs/LICENSE.md +++ b/docs/LICENSE.md @@ -2,6 +2,7 @@ Jungfraujoch software is licensed with GPLv3 license. Jungfraujoch FPGA is licensed with CERN OHL-S license (see [FPGA license](FPGA_LICENSE.md)). +Jungfraujoch PCIe kernel driver (`fpga/pcie_driver`) is licensed with GPLv2 or later license (see [FPGA license](FPGA_LICENSE.md)). ## GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 diff --git a/docs/RUGNUX.md b/docs/RUGNUX.md index b426e829a..1696fea56 100644 --- a/docs/RUGNUX.md +++ b/docs/RUGNUX.md @@ -53,7 +53,7 @@ Rugnux is one executable in an archive on the release page, https://gitea.psi.ch On Linux x86-64 (the other platforms are on [Download](RUGNUX_DOWNLOAD.md)): ``` -VERSION=1.0.0-rc.184 +VERSION=1.0.0 curl -L -O https://gitea.psi.ch/mx/jungfraujoch/releases/download/$VERSION/rugnux-$VERSION-linux-x86_64-cuda12.tgz mkdir -p rugnux-$VERSION && tar xzf rugnux-$VERSION-linux-x86_64-cuda12.tgz -C rugnux-$VERSION export PATH=$PWD/rugnux-$VERSION/bin:$PATH diff --git a/docs/RUGNUX_ADVANCED.md b/docs/RUGNUX_ADVANCED.md index 9d8e23b80..bfb6e9b18 100644 --- a/docs/RUGNUX_ADVANCED.md +++ b/docs/RUGNUX_ADVANCED.md @@ -289,7 +289,9 @@ different space group, resolution limit, anomalous setting or outlier rejection. `-o/-N/-s/-e/-S/-A/-z/--scaling-*` options as the full run, and (unlike the full pipeline) does not run a space-group search: it merges in the space group and unit cell the file records, and `-S` / `-C` override them. A `_process.h5` written before the group was stored carries none, and merges -in P1 unless `-S` says otherwise. +in P1 unless `-S` says otherwise. Beside the reflection files and the report it writes +`_plot.txt` for its own merge - per image, the scale and whether the image's observations are +in the merged data (the report's `IMAGES_MERGED` is the sum of that column). A reference MTZ (`-z`) is accepted here on **stills** data, where it fixes the space group and cell, reports CCref and hands over its R-free flags; on rotation data the rotation scaler @@ -311,6 +313,32 @@ from the one each image was indexed in — the file records the change of basis describe the same frame. A file whose stored cell and reflections disagree stops with a message naming both cells and the exact `-S`/`-C` override to merge it in its own setting. +### Several files + +``` +rugnux --mode scale -o combined run1_process.h5 run2_process.h5 run3_process.h5 +``` + +The `_process.h5` files of several stills runs of one crystal are merged as one run, as serial data +from several collections usually are. Each frame keeps the geometry, wavelength and detector of its own +file; the frames are taken file after file, in the order given, and numbered on from one file to the +next, so the frames of different files stay distinct. The union is then merged exactly as one file is: +the frames of the run's crystal form, each put on the run's cell, the indexing ambiguity resolved from +the data over all the crystals together - so crystals of different files indexed in different +alternative indexings, or on permuted axes of the same lattice, end up in one - and one scaling, +post-refinement and merge. The cell, space group, given cell (`/entry/MX/stillsGivenUnitCell`) and +rocking curve merged with are the first file's; the ice-ring gate pools the frames of all of them. + +The files must be of one crystal: each file's cell the first's lattice (in its setting or another) and +the same space group. A run stops with a message naming both cells, or both groups, where they are not - +unless the cell is given (`-C`, or a reference `-z`) and, for the group, `-S` (or the group of a reference +`-z` that states one): then everything is merged in what is given, and the crystals of a file not on that cell are left out. A mix of stills and rotation +files is refused, and so are several rotation files (`--mode scale` merges one sweep at a time; several +sweeps of one crystal are merged together from their masters by `--mode mx`). Under `--force-still` a +rotation file counts as stills. `-s`/`-e` select images of one file and are refused with several. The +log and the report ([`INPUT_nn`](RUGNUX_REPORT.md#the-headline-keys)) give each file's images, indexed +crystals, merged crystals and those left out; the statistics are those of the merge of all of them. + ## The merged mmCIF (`.cif`) The `.cif` follows the PDBx/mmCIF dictionary and holds one data block, `data_sample`: the merged diff --git a/docs/RUGNUX_CLI.md b/docs/RUGNUX_CLI.md index 8c09f27c7..b050c2656 100644 --- a/docs/RUGNUX_CLI.md +++ b/docs/RUGNUX_CLI.md @@ -58,7 +58,12 @@ rugnux --mode refine -o refined data.mtz model.cif ``` Refines a model against merged data that already exist - an MTZ or a structure-factor mmCIF - and -reads no images. The model is required, given among the inputs or with `--model` +reads no images. The model is required, given among the inputs or with `--model`. Without `--mode`, +rugnux takes `--mode refine` when the inputs hold reflections and no images and a model is given - +among the inputs or with `--model` (`rugnux -o refined data.mtz model.cif`, +`rugnux -o refined --model model.cif data.mtz`); the reflections are an input then, not `-z`, which `--mode refine` +does not use (a reflection file given only with `-z` does not select it). A restraint dictionary for a ligand can be given among the +inputs as well (`--restraints`) ([Refining a model against structure factors](RUGNUX_MODEL_AND_REFERENCE.md#refining-a-model-against-structure-factors-rugnux---mode-refine)). ### Detector calibration (`--mode calibration`) @@ -84,10 +89,14 @@ The binning is set by the [azimuthal-integration options](#azimuthal-integration ``` rugnux -o myrun --write-process-h5 dataset_master.h5 # integrate and merge once rugnux --mode scale -o remerged -A myrun_process.h5 # re-merge (on stills, -A keeps the Bijvoet hands apart) +rugnux --mode scale -o combined run1_process.h5 run2_process.h5 run3_process.h5 # stills of several runs, as one ``` Re-scales and merges the reflections already integrated into a `_process.h5`, without re-running spot finding or integration ([Re-scaling and re-merging](RUGNUX_ADVANCED.md#re-scaling-and-re-merging-rugnux---mode-scale)). +Several `_process.h5` files of stills are merged as one run, their crystals scaled together and the indexing +ambiguity resolved over all of them ([Several files](RUGNUX_ADVANCED.md#several-files)); rotation files are +taken one at a time. ## Inputs @@ -97,8 +106,8 @@ one dataset - `rugnux run*.h5` (SACLA), `*.cxi`, `*.xtc` (LCLS) - or several Jun masters of stills - or of rotation sweeps under `--force-still` - read as one run: their images one after another, merged together, with the indexing rate reported per master as well. Such masters must share the detector, wavelength, distance and beam centre. A grid scan an input holds (a fixed-target chip) is not carried into the run: several chips are -not one grid, so the run has no grid map. Several inputs must be one format; any `--mode` other than `mx`, and -following a broker, take one. +not one grid, so the run has no grid map. Several inputs must be one format; `--mode scale` takes several `_process.h5` files of +stills (above), and any other `--mode`, and following a broker, take one. Several rotation sweeps are told apart from the files: one sweep per CBF/marCCD/SMV/SFRM file-name template (the name with its frame number taken out - any frame of a sweep names the whole sweep, so @@ -116,10 +125,14 @@ best; where the lattice allows more than one indexing, which one each sweep take of sweeps at once - and each is judged by its isomorphism ratio with it (see [RUGNUX_REPORT](RUGNUX_REPORT.md)): clearly about 1 it joins, clearly below it (another crystal) it is left out, and in between the merge decides - it joins unless it is shown to hurt: adding it raises the held-out residual of the others' merge by more than 1%, -two standard errors down (a sweep left out is named in the log). The crystal has one cell: a joined sweep whose own cell is more than 0.3% off that of -the joined sweep reaching the finest resolution (where the cell is measured rather than the distance) is -processed a second time, from the distance that would make the two cells agree, and that run replaces the -first where its intensities agree better with that sweep's (a lower held-out residual). Their fulls are +two standard errors down (a sweep left out is named in the log). A sweep that found no lattice of the crystal on its own (it merged nothing, or correlates on no axes) +is processed again given the cell of the joined sweep reaching the finest resolution. The crystal has one cell: +any sweep with a merge - joined or not, the ones just rescued too - whose own cell is more than 0.3% off that +sweep's (where the cell is measured rather than the distance), but not a whole multiple of it in volume, is +processed a second time, from the distance that would make the two cells agree. That run replaces the first only +where it has no fewer fulls and, for a sweep on the reference's axes, its intensities agree better with the +joined sweeps' (a lower held-out residual by more than twice its error); a sweep on none is then judged on its +intensities like every other. Their fulls are scaled and merged together: a per-frame scale within each sweep, the sweeps' dose order read from their relative B factors (not from the input order or the header times), a decay along that order or one B per sweep, whichever predicts held-out frames better, then the space-group search, the @@ -137,8 +150,9 @@ without a geometry file where their own metadata places the detector An atomic model and a reference reflection file can be given among the inputs, in any order, instead of `--model` and `-z`. Each file is told by its contents, not its name: an MTZ (the MTZ magic) or an mmCIF with a `_refln` or `_diffrn_refln` loop is reflections (`-z`; the input itself in -`--mode refine`), a PDB file or an mmCIF with an `_atom_site` loop is a model (`--model`), anything -else is images. An mmCIF holding both coordinates and reflections has to be given with `--model` or +`--mode refine`), a PDB file or an mmCIF with an `_atom_site` loop is a model (`--model`), an mmCIF +with a `_chem_comp_atom`, `_chem_link` or `_chem_mod` loop (and neither) is a restraint dictionary +(`--restraints`; several allowed), anything else is images. An mmCIF holding both coordinates and reflections has to be given with `--model` or `-z`. At most one of each, also counting `--model`/`--mr` and `-z`; gzipped or not. With a broker URL (`http://host:port/`) as the last argument and no input on disk yet, rugnux @@ -162,7 +176,7 @@ With the input already on disk, the URL is ignored. | `-t, --stride ` | Process every *n*-th image (default: 1) | | `-v, --verbose` | Show the whole log on the terminal in place of the steps; `_log.txt` is written either way | | `--simulate-live ` | Read a stored input as the collection it was while being written: image *i* becomes readable (*i*+1)·`ms` ms after the start (0: all at once). The run takes the live path a broker URL takes, with the same result; for testing the live workflow without a broker. `--mode mx` only | -| `--fast-live` | With `--simulate-live` or a broker URL: run as the broker's rugnux live mode does — every decision stands where it was first taken, nothing is re-checked or run again once the sweep is in, the integration radius is fixed, and SIGINT cuts the run to what it has established. A difficult crystal can come out worse | +| `--fast-live` | With `--simulate-live` or a broker URL: run as the broker's rugnux live mode does — every decision stands where it was first taken, nothing is re-checked or run again once the sweep is in (the integration radius from the spot width stays where the pre-pass frames put it), and SIGINT cuts the run to what it has established. A difficult crystal can come out worse | | `--sweeps joint\|separate` | Several rotation sweeps (see Inputs): `joint` (the default) merges them as one dataset into `.*`; `separate` processes each alone into `_s_*` | | `--no-gpu` | Run on the CPU only, as on a machine without a GPU, even where one is present: CUDA is not touched (nor, on macOS, the Apple GPU that Bragg integration, the model density and the molecular-replacement rotation function otherwise run on) and every GPU step takes its CPU path (`-X FFT` indexes with FFTW and `-X FFBIDX` with its CPU implementation; `-X cuFFT` is refused) | @@ -184,7 +198,8 @@ The columns are found, not named - amplitudes with their sigmas (F/SIGF, FP/SIGFP, ...) where the file has them, else intensities (IMEAN/SIGIMEAN, I/SIGI, ...) made into amplitudes by French-Wilson, else the mean of the anomalous pairs; the free set from a FreeR_flag-like column (0 the test set, or the minority value where 0 is the majority, as phenix writes it), drawn by rugnux where the file has none. -The model is taken as placed in the data's cell, and refined in the data's space group. +The model is taken as placed in the data's cell, and refined in the data's space group (in its own where that is a +subgroup of the data's, against the data expanded to it). | Option | Description | | --- | --- | @@ -266,12 +281,12 @@ For very long axes the direction grid's angular resolution binds well below 500 | Option | Description | | --- | --- | | `--force-still` | Treat a rotation (goniometer) dataset as independent stills instead of rotation; several masters are then read as one stills run | -| `-X, --indexing-algorithm ` | `Auto` (default) \| `FFT` \| `cuFFT` \| `FFTW` \| `FFBIDX` \| `None`, case-insensitive. `FFT` is the de-novo FFT search, on the GPU (cuFFT) where there is one and `--no-gpu` is not given, otherwise on the CPU (FFTW); `cuFFT` and `FFTW` name one implementation each; `cuFFT` needs a GPU and is refused without one. `FFBIDX` (known cell, `-C`) runs on the GPU where there is one and otherwise on the CPU. `Auto` takes `FFBIDX` on stills with a known cell, and `FFT` otherwise. `FFBIDX` without a cell (`-C`, or one from `-z`) resolves to `None` and indexes nothing, with no error. On rotation data `-X` is not consulted: the FFT search runs on the GPU where there is one and on the CPU otherwise, so `Auto`, `FFT`, `cuFFT` (with a GPU) and `FFTW` (without one, or under `--no-gpu`) are accepted and any other value stops the run at indexing; `FFBIDX` and `None` are for stills | +| `-X, --indexing-algorithm ` | `Auto` (default) \| `FFT` \| `cuFFT` \| `FFTW` \| `FFBIDX` \| `None`, case-insensitive. `FFT` is the de-novo FFT search, on the GPU (cuFFT) where there is one and `--no-gpu` is not given, otherwise on the CPU (FFTW); `cuFFT` and `FFTW` name one implementation each (`FFTW` keeps its old name: the CPU transforms are pocketfft's); `cuFFT` needs a GPU and is refused without one. `FFBIDX` (known cell, `-C`) runs on the GPU where there is one and otherwise on the CPU. `Auto` takes `FFBIDX` on stills with a known cell, and `FFT` otherwise. `FFBIDX` without a cell (`-C`, or one from `-z`) resolves to `None` and indexes nothing, with no error. On rotation data `-X` is not consulted: the FFT search runs on the GPU where there is one and on the CPU otherwise, so `Auto`, `FFT`, `cuFFT` (with a GPU) and `FFTW` (without one, or under `--no-gpu`) are accepted and any other value stops the run at indexing; `FFBIDX` and `None` are for stills | | `-F` | Short for `-X FFT`, kept for old command lines | -| `-C, --unit-cell ` | Reference unit cell `"a,b,c,alpha,beta,gamma"` (required by `ffbidx`). On rotation data it also widens the FFT search to cover the cell given, at both ends: the longest axis looked for is raised to reach it, and `--fft-min-unit-cell` is lowered to admit it. A candidate that is an integer supercell of the cell given (a twin's coincidence lattice, a row taken at a multiple of its length) is stepped down to it. On stills the run always uses it: the geometry refinement takes it as a prior (1 % on the lengths, 1° on the angles the crystal system leaves free), and the log warns - with both numbers - where the frames refine its shape more than 3 % / 3° away, or where a sample of frames indexed de novo puts materially more spots on the lattice than the cell given ([§7.7](CPU_DATA_ANALYSIS_INDEXING.md#77-stills-a-given-cell-and-the-detector-modules)) | +| `-C, --unit-cell ` | Reference unit cell `"a,b,c,alpha,beta,gamma"` (required by `ffbidx`). On rotation data it also widens the FFT search to cover the cell given, at both ends: the longest axis looked for is raised to reach it, and `--fft-min-unit-cell` is lowered to admit it. A candidate that is an integer supercell of the cell given (a twin's coincidence lattice, a row taken at a multiple of its length) is stepped down to it. On stills the run always uses it: the geometry refinement takes it as a prior (1 % on the lengths, 1° on the angles the crystal system leaves free), and the log warns - with both numbers - where the frames refine its shape more than 3 % / 3° away, or where a sample of frames indexed de novo puts materially more spots on the lattice than the cell given ([§7.7](CPU_DATA_ANALYSIS_INDEXING.md#77-stills-a-given-cell-and-the-detector-modules)). Without `-S` the cell fixes the crystal system, read from the angles as typed: an angle is 90° or 120° only where it is typed so (`90` or `90.00`, not `90.03`). Three 90s: orthorhombic, or tetragonal / cubic where the lengths are equal within tolerance; two 90s and a 120: hexagonal (or rhombohedral in hexagonal axes); two 90s: monoclinic; three equal angles: rhombohedral; anything else: triclinic, and the run behaves as with this cell and `-S P1`. The lattice is indexed in that system, never above or below it, on the axes of the cell as typed (an F- or R-centred one in its conventional setting), and only the space group within it is searched | | `--fft-min-unit-cell ` | Shortest cell axis the FFT search accepts, Å (default: 10; accepted 5-40). A candidate with a shorter axis is discarded — but on rotation data a row shorter than the floor, down to 3 Å, is recognised under the multiple of it the search reports past the floor, so a small-molecule cell is indexed without this flag. `-C` lowers the floor on its own to cover the cell given. On stills a crystal below the floor cannot be indexed unless this is lowered | | `--min-indexed-spots ` | Spots a frame must have on the lattice before it counts as indexed (default: 6, minimum 4). It sets the reported indexing rate and the count the rotation first pass ranks candidate lattices by; whether the run has a lattice at all is decided on the pooled spots instead ([§4.1](CPU_DATA_ANALYSIS_INDEXING.md#41-indexed-spot-decision-inlier-test)), and integration is not gated by it | -| `-S, --space-group ` | Space group number (`96`) or Hermann-Mauguin symbol (`P43212`) — for indexing and scaling. On serial stills whose group admits two indexings, it also lets the crystals be put on one from the data ([the indexing ambiguity](RUGNUX_ADVANCED.md#the-indexing-ambiguity)) | +| `-S, --space-group ` | Space group number (`96`) or Hermann-Mauguin symbol (`P43212`) — for indexing and scaling. On serial stills whose group admits two indexings, it also lets the crystals be put on one from the data ([the indexing ambiguity](RUGNUX_ADVANCED.md#the-indexing-ambiguity)). Without `-C` the group fixes only the symmetry, not the cell: the lattice is found and reduced as in a run without `-S` (a supercell the indexer returns is still stepped down to the crystal's cell, a long axis is still looked for), indexing puts the crystal in the group's own Bravais class, nothing promotes or demotes it past that class, and the group is applied to the cell found, in its conventional setting. With `-C` as well, the lattice and its setting are the ones given and nothing reduces or doubles the cell. A primitive group on a lattice with no primitive cell of its system (P2 on a C-centred monoclinic crystal, P3 on a rhombohedral one) is merged on the centred cell, and the positions the centring extinguishes are kept (they read about zero). With `-C`, the cell is written on the given cell's axes. A space group (and a cell) stored in the input file is ignored, with a line in the log saying so: only `-S` (and `-C`) fix them (`--mode scale` takes the group a `_process.h5` was written in) | | `-r, --geom-refine ` | Geometry refinement: `none` \| `orientation` \| `beam_and_lattice` (default; on rotation data restrained toward the sweep's geometry, [§7.4](CPU_DATA_ANALYSIS_INDEXING.md#74-multi-stage-tightening-of-inlier-tolerance)) \| `flex` (try all three per image, keep whichever indexes the most spots; alias `multi`) | | `-R, --two-pass-rotation[=num]` | Two-pass offline rotation indexing (default for goniometer data; optional first-pass image count, default 100) | | `--force-rotation-lattice ` | Force rotation lattice (9 floats, Å), skipping the first pass | @@ -295,7 +310,7 @@ serial stills; `fft` (GPU) / `fftw` (CPU) index **de novo** and suit strong rota | `--no-scaling-corrections` | rot3d: disable the default-on decay + absorption + modulation correction surfaces fitted on the fulls after scale-fulls | | `--relative-b[=deg]` | rot3d: fit a per-batch relative-*B* beyond the single decay slope over deg-degree batches, cross-validated (default 10° when bare; off otherwise) | | `--simple-stills` | Stills: treat every reflection as a full (*p* = 1, single-pass scale/merge) — disables the default-on physical partiality post-refinement | -| `--live-checkpoints [,...]` | `--mode scale`, stills (for developers): replay the stored frames in image order as the broker's live merge of a serial collection merges them - a merge at each fraction of the images (e.g. `0.5,0.75`), each crystal after the first checkpoint scaled, post-refined and placed in its indexing against the latest checkpoint's merge as it comes, and after the last frame one merge of all of them without a scaling or post-refinement over the whole run. The log gives each checkpoint's statistics and time, and the time of the merge after the last frame; the merge written is that last one. Without it `--mode scale` merges cold, as the broker does when no checkpoint is reached Each fraction 0.01-0.99. | +| `--live-checkpoints [,...]` | `--mode scale`, stills (for developers): replay the stored frames in image order as the broker's live merge of a serial collection merges them - a merge at each fraction of the images (the broker uses `0.5`), each crystal after the first checkpoint scaled, post-refined and placed in its indexing against the latest checkpoint's merge as it comes, and after the last frame one merge of all of them without a scaling or post-refinement over the whole run. The log gives each checkpoint's statistics and time, and the time of the merge after the last frame; the merge written is that last one. With several `_process.h5` files the frames are replayed file after file, in the order given, as one collection. Without it `--mode scale` merges cold, as the broker does when no checkpoint is reached Each fraction 0.01-0.99. | | `--live-final-full` | With `--live-checkpoints`: the merge after the last frame scales and post-refines every crystal over the whole run, as a cold merge does, instead of merging the crystals as they were prepared against the checkpoints - what the broker's live merge would do with a full scaling pass at the end; its time is in the log beside the incremental one's. | | `--no-expected-variance-merge` | Stills: disable the default expected-variance merge weighting (which rebuilds each weak observation's signal variance at the reflection mean to de-bias the inverse-variance merge); restores observed-sigma weighting | | `--capture-uncertainty ` | Systematic sigma num·(1−captured fraction)·⟨I⟩: on rot3d fulls the share of the rocking curve not captured, on stills the share of each partial its partiality does not see (default: 1.0 for rotation, 0 otherwise) | @@ -313,15 +328,16 @@ serial stills; `fft` (GPU) / `fftw` (CPU) index **de novo** and suit strong rota | `--min-image-cc ` | Per-image CC limit, percent (default: no limit) | | `--search-min-zeta ` | De-novo space-group search only: also search a merge of just the observations whose Lorentz geometry \|ζ\| reaches this, and report both answers (default: 0.85 for rotation, 0 = single search). Reflections crossing the Ewald sphere near-tangentially are measured worst and can make a real symmetry operator look like a twin law. Where the two searches disagree, the merge of all the observations decides — as it always has for the systematic absences | | `--mosaicity ` | Diagnostic: fix the scaling mosaicity (°) instead of using the per-image seed | -| `--scaling-iterations ` | Cap on the per-frame scaling iterations; the loop stops earlier once the scales settle, and a merge that hits the cap is flagged `SCALING_NOT_CONVERGED` (default: 100) | +| `--scaling-iterations ` | Cap on the per-frame scaling iterations; the loop stops earlier once the scales settle, and a final merge whose scales were still moving when its loop stopped is flagged `SCALING_NOT_CONVERGED` (default: 100) | | `-z, --reference ` | Reference data of the same crystal form — an MTZ or a PDB structure-factor mmCIF (`-sf.cif`), gzipped or not, recognised by content; `--reference-mtz` is the same option: fixes the space group, its setting and the cell, resolves the [indexing ambiguity](RUGNUX_ADVANCED.md#the-indexing-ambiguity), hands over the R-free set and reports CCref. Not a scale anchor | -| `--free-flags ` | Take only the R-free test set of this MTZ or structure-factor mmCIF - e.g. the deposited reflections of the `--model` - for the validation, the refinement and the merged files; nothing else of the file is used, so unlike `-z` it fixes no space group, cell or frame. Taken on the model's axes where the merge matches the file's intensities (`R_FREE_FLAGS=`, see [Free set and model bias](RUGNUX_MODEL_AND_REFERENCE.md#free-set-and-model-bias)) | +| `--free-flags ` | Take only the R-free test set of this MTZ or structure-factor mmCIF - e.g. the deposited reflections of the `--model` - for the validation, the refinement and the merged files; nothing else of the file is used, so unlike `-z` it fixes no space group, cell or frame. Taken on the model's axes where the rigid body placed the model and the merge matches the file's intensities (`R_FREE_FLAGS=`, see [Free set and model bias](RUGNUX_MODEL_AND_REFERENCE.md#free-set-and-model-bias)) | | `--reference-column