version 1.0.0-rc.16

This commit is contained in:
2024-10-11 11:11:37 +02:00
parent 040c43084e
commit b605b95127
227 changed files with 3881 additions and 2176 deletions

View File

@@ -45,15 +45,24 @@ build:x86:driver:
- gcc
- x86
needs: []
artifacts:
paths:
- "jfjoch_driver.tar.gz"
expire_in: 1 week
script:
- cd fpga/pcie_driver
- make
- bash pack.sh
- mv jfjoch_driver.tar.gz ../..
build:x86:python_client:
stage: build
needs: []
tags:
- python
script:
- cd python-client
- python3 setup.py sdist bdist_wheel
- mv dist/* ..
artifacts:
paths:
- jfjoch_client-*whl
- jfjoch_client-*tar.gz
expire_in: 1 week
build:x86:vitis_hls:
stage: build
@@ -313,106 +322,8 @@ release:
dependencies:
- synthesis:vivado_pcie_8x10g
- synthesis:vivado_pcie_100g
- build:x86:python_client
- build:x86:frontend
- build:x86:driver
- build:x86:rpm
script:
- export PACKAGE_VERSION_SEM=`head -n1 VERSION`
- export PACKAGE_VERSION=${PACKAGE_VERSION_SEM//-/_}
- export PACKAGE_REGISTRY_URL="${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/jungfraujoch/${PACKAGE_VERSION_SEM}"
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch-driver-dkms-${PACKAGE_VERSION}-1.el8.noarch.rpm "${PACKAGE_REGISTRY_URL}/jfjoch-driver-dkms-${PACKAGE_VERSION}-1.el8.noarch.rpm"'
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch-writer-${PACKAGE_VERSION}-1.el8.x86_64.rpm "${PACKAGE_REGISTRY_URL}/jfjoch-writer-${PACKAGE_VERSION}-1.el8.x86_64.rpm"'
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch-${PACKAGE_VERSION}-1.el8.x86_64.rpm "${PACKAGE_REGISTRY_URL}/jfjoch-${PACKAGE_VERSION}-1.el8.x86_64.rpm"'
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch_driver.tar.gz "${PACKAGE_REGISTRY_URL}/jfjoch_driver.tar.gz"'
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch_frontend.tar.gz "${PACKAGE_REGISTRY_URL}/jfjoch_frontend.tar.gz"'
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch_fpga_pcie_100g.mcs "${PACKAGE_REGISTRY_URL}/jfjoch_fpga_pcie_100g.mcs"'
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch_fpga_pcie_8x10g.mcs "${PACKAGE_REGISTRY_URL}/jfjoch_fpga_pcie_8x10g.mcs"'
- >
release-cli create --name "Release $PACKAGE_VERSION_SEM" --tag-name $PACKAGE_VERSION_SEM
--assets-link "{\"name\":\"jfjoch_driver.tar.gz\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch_driver.tar.gz\"}"
--assets-link "{\"name\":\"jfjoch_frontend.tar.gz\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch_frontend.tar.gz\"}"
--assets-link "{\"name\":\"jfjoch_fpga_pcie_8x10g.mcs\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch_fpga_pcie_8x10g.mcs\"}"
--assets-link "{\"name\":\"jfjoch_fpga_pcie_100g.mcs\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch_fpga_pcie_100g.mcs\"}"
--assets-link "{\"name\":\"jfjoch-${PACKAGE_VERSION}-1.el8.x86_64.rpm\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch-${PACKAGE_VERSION}-1.el8.x86_64.rpm\",\"link_type\":\"package\"}"
--assets-link "{\"name\":\"jfjoch-writer-${PACKAGE_VERSION}-1.el8.x86_64.rpm\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch-writer-${PACKAGE_VERSION}-1.el8.x86_64.rpm\",\"link_type\":\"package\"}"
--assets-link "{\"name\":\"jfjoch-driver-dkms-${PACKAGE_VERSION}-1.el8.noarch.rpm\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch-driver-dkms-${PACKAGE_VERSION}-1.el8.noarch.rpm\",\"link_type\":\"package\"}"
release_no_fpga:
stage: release
rules:
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
when: manual
tags:
- x86
dependencies:
- build:x86:frontend
- build:x86:driver
- build:x86:rpm
script:
- export PACKAGE_VERSION_SEM=`head -n1 VERSION`
- export PACKAGE_VERSION=${PACKAGE_VERSION_SEM//-/_}
- export PACKAGE_REGISTRY_URL="${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/jungfraujoch/${PACKAGE_VERSION_SEM}"
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch-driver-dkms-${PACKAGE_VERSION}-1.el8.noarch.rpm "${PACKAGE_REGISTRY_URL}/jfjoch-driver-dkms-${PACKAGE_VERSION}-1.el8.noarch.rpm"'
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch-writer-${PACKAGE_VERSION}-1.el8.x86_64.rpm "${PACKAGE_REGISTRY_URL}/jfjoch-writer-${PACKAGE_VERSION}-1.el8.x86_64.rpm"'
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch-${PACKAGE_VERSION}-1.el8.x86_64.rpm "${PACKAGE_REGISTRY_URL}/jfjoch-${PACKAGE_VERSION}-1.el8.x86_64.rpm"'
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch_driver.tar.gz "${PACKAGE_REGISTRY_URL}/jfjoch_driver.tar.gz"'
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch_frontend.tar.gz "${PACKAGE_REGISTRY_URL}/jfjoch_frontend.tar.gz"'
- >
release-cli create --name "Release $PACKAGE_VERSION_SEM" --tag-name $PACKAGE_VERSION_SEM
--assets-link "{\"name\":\"jfjoch_driver.tar.gz\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch_driver.tar.gz\"}"
--assets-link "{\"name\":\"jfjoch_frontend.tar.gz\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch_frontend.tar.gz\"}"
--assets-link "{\"name\":\"jfjoch-${PACKAGE_VERSION}-1.el8.x86_64.rpm\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch-${PACKAGE_VERSION}-1.el8.x86_64.rpm\",\"link_type\":\"package\"}"
--assets-link "{\"name\":\"jfjoch-writer-${PACKAGE_VERSION}-1.el8.x86_64.rpm\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch-writer-${PACKAGE_VERSION}-1.el8.x86_64.rpm\",\"link_type\":\"package\"}"
--assets-link "{\"name\":\"jfjoch-driver-dkms-${PACKAGE_VERSION}-1.el8.noarch.rpm\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch-driver-dkms-${PACKAGE_VERSION}-1.el8.noarch.rpm\",\"link_type\":\"package\"}"
--assets-link "{\"name\":\"jfjoch_fpga_pcie_8x10g.mcs\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch_fpga_pcie_8x10g.mcs\"}"
--assets-link "{\"name\":\"jfjoch_fpga_pcie_100g.mcs\",\"url\":\"${PACKAGE_REGISTRY_URL}/jfjoch_fpga_pcie_100g.mcs\"}"
upload_fpga_100g:
stage: release
rules:
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
when: manual
- if: $CI_COMMIT_MESSAGE =~ /^FPGA/
when: manual
- if: $CI_PIPELINE_SOURCE == "push"
changes:
- fpga/hls/*
- fpga/hdl/*
- fpga/scripts/*
- fpga/xdc/*
- fpga/pcie_driver/jfjoch_fpga.h
when: manual
tags:
- x86
dependencies:
- synthesis:vivado_pcie_100g
script:
- export PACKAGE_VERSION_SEM=`head -n1 VERSION`
- export PACKAGE_VERSION=${PACKAGE_VERSION_SEM//-/_}
- export PACKAGE_REGISTRY_URL="${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/jungfraujoch/${PACKAGE_VERSION_SEM}"
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch_fpga_pcie_100g.mcs "${PACKAGE_REGISTRY_URL}/jfjoch_fpga_pcie_100g.mcs"'
upload_fpga_8x10g:
stage: release
rules:
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
when: manual
- if: $CI_COMMIT_MESSAGE =~ /^FPGA/
when: manual
- if: $CI_PIPELINE_SOURCE == "push"
changes:
- fpga/hls/*
- fpga/hdl/*
- fpga/scripts/*
- fpga/xdc/*
- fpga/pcie_driver/jfjoch_fpga.h
when: manual
tags:
- x86
dependencies:
- synthesis:vivado_pcie_8x10g
script:
- export PACKAGE_VERSION_SEM=`head -n1 VERSION`
- export PACKAGE_VERSION=${PACKAGE_VERSION_SEM//-/_}
- export PACKAGE_REGISTRY_URL="${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/jungfraujoch/${PACKAGE_VERSION_SEM}"
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file jfjoch_fpga_pcie_8x10g.mcs "${PACKAGE_REGISTRY_URL}/jfjoch_fpga_pcie_8x10g.mcs"'
- bash gitlab_upload_release.sh

144
DEPLOYMENT.md Normal file
View File

@@ -0,0 +1,144 @@
# Deployment of Jungfraujoch
To deploy Jungfraujoch, one needs to follow four steps:
1. Flash the U55C FPGA card with a proper image and install Linux kernel driver
2. Install main Jungfraujoch code and frontend web interface
3. Install Jungfraujoch writer
4. Install Python OpenAPI client
Installation procedure depend a lot on the operating system. For RedHat Enterprise Linux 8, Rocky 8, or compatible
installation can be done with prebuilt RPMs and is relatively straightforward. For other systems one needs to build
software from source. Both ways will be presented.
## Flash the U55C FPGA card with a proper image and install Linux kernel driver.
### Firmware flashing
1. Install the `xbflash2` tool from Xilinx, which allows to flash the firmware through PCIe connector.
It can be downloaded as RPM/DEB file from [Alveo product page](https://www.xilinx.com/products/boards-and-kits/alveo/u55c.html#xbflash2). For RHEL9 this needs to built from source - [Xilinx/XRT github repository](https://github.com/Xilinx/XRT).
2. Check that the card is detected by OS with "lspci |grep Xilinx" and check the PCIe slot number (`11:00.0` in this case):
```
$ lspci |grep Xilinx
23:00.0 Processing accelerators: Xilinx Corporation Device 3450 (rev 58)
```
Note the device number `3450` that identifies Jungfraujoch device (Jungfraujoch pass is 3450 m above sea level) and `rev 58` identifying release of the firmware.
3. Check the speed of the card, that it is detected as PCIe Gen4x8 device (needs to be done as root, otherwise configuration details are not given):
```
$ sudo lspci -vv -s <PCIe slot number>
23:00.0 Processing accelerators: Xilinx Corporation Device 3450
(...)
LnkSta: Speed 16GT/s (ok), Width x8 (ok)
(...)
```
4. Download the MCS image from release files or build it using Vivado (WARNING! building time can be about 8 hours and doesn't allways reach correct timing).
5. Flash the card with xbflash2. For fresh card use:
```
sudo xbflash2 program --spi --image <path to MCS file> --bar-offset 0x1f06000 -d <PCIe slot from above>
```
For card that was already flashed with Jungfraujoch images:
```
sudo xbflash2 program --spi --image <path to MCS file> -d <PCIe slot from above>
```
It is necessary to confirm the operation by pressing `Y` key.
It is safe to run multiple flashing processes in parallel for different cards, for example in separate screen sessions.
6. Cold reboot:
```
sudo ipmitool chassis power cycle
```
### Install PCIe driver
For first run it is though recommended to try the driver without installing to the kernel directory:
```
$ cd fpga/pcie_driver
$ make
$ sudo insmod jfjoch.ko
```
Check with `dmesg` that the device was properly found:
```
$ dmesg |grep jfjoch
[ 431.624933] jfjoch 0000:23:00.0: enabling device (0140 -> 0142)
[ 431.919147] misc jfjoch0: Jungfraujoch FPGA loaded with FW build: 5610030a
```
If things work, it is recommended to install the driver with DKMS, so it is rebuilt for kernel updates.
On RHEL 8 you can install prebuilt RPM provided in the Gitlab package registry. On other systems follow procedure in
[PCIe driver](fpga/pcie_driver/README.md).
NOTE: Driver installation procedure on non-RHEL 8 systems is not well understood/optimized at the moment.
NOTE: In case driver is included in the init RAM-disk image, it is necessary to rebuild the RAM-disk if driver is updated:
```
$ sudo dracut -f
```
### Configure network
Configure switch according to [FPGA network guide](fpga/NETWORK.md) - specifically set manual speed and turn off auto-negotiation
for the port used to connect U55C card and connect card to switch.
## Install main Jungfraujoch code and frontend web interface
On RHEL 8 systems there is a `jfjoch-<version>-1.el8.x86_64.rpm` that needs to be installed and contains all the necessary software and web interface.
On other OSes one needs to compile Jungfraujoch from source (from the repo directory):
```
$ mkdir build
$ cd build
$ cmake .. -DCMAKE_INSTALL_PREFIX=<directory to install>
$ make
$ sudo make install
```
For manual installation, we recommend to use non-standard directory (like `/opt/jfjoch`), to facilitate upgrades and removal.
Frontend web user interface has to be built separately with:
```
$ cd build
$ make frontend
```
Frontend files (.html and .js) will be placed in `frontend/dist` (outside of `build/` directory!) and has to be copied to a general location, e.g. `/usr/local/jfjoch/frontend` or `/opt/jfjoch/frotend`.
### Running Jungfraujoch software
Main Jungfraujoch service is called `jfjoch_broker`. It is responsible for handling data from FPGAs, doing processing, analysis, compression and sending images on ZeroMQ output.
It is recommended to run the service as `systemd` service.
`jfjoch_broker` takes two parameters: JSON configuration file and HTTP port (default is 5232).
Example JSON files are placed in [etc](etc) folder. JSON file format is also explained in the OpenAPI definition, as `jfjoch_settings` data structure.
When running the service can be accessed via HTTP interface from a web browser for configuration and monitoring.
To prepare the configuration file one also needs to reference calibration files: gain files for PSI JUNGFRAU and trim-bit files for PSI EIGER.
These need to be obtained from the PSI Detector Group.
### Card verification
To test that FPGA board is working properly without access to a JUNGFRAU detector, you can use `jfjoch_action_test` tool.
For example to simulate 10M pixel system with 4 FPGA cards and 200k images on a 2 CPU system with 2 GPUs:
```
jfjoch_action_test ~/nextgendcu/ -m20 -s4 -i 200000 -Pn2g2
```
Or 1M pixel system with one FPGA card:
```
jfjoch_action_test ~/nextgendcu/ -m2 -s1 -i 200000
```
## Install Jungfraujoch writer
Jungfraujoch writer is an additional service, that can connect to `jfjoch_broker` ZeroMQ interface and writes files according to NeXus/NXmx HDF5 standard.
At the moment it is better to have a separate machine, with access to distributed file system, for writing images.
Writer can be installed with a dedicated RPM file or compiled from source. For compilation, you can use the following commands:
```
mkdir build
cd build
cmake -DJFJOCH_WRITER_ONLY=ON -DCMAKE_INSTALL_PREFIX=<directory to install> ..
make jfjoch
```
## Install Jungfraujoch Python client
This is under development.

55
HARDWARE.md Normal file
View File

@@ -0,0 +1,55 @@
# Hardware requirements
Operating Jungfraujoch requires the following:
1. High performance server
2. FPGA board(s) installed in the server
3. (optionally) GPU boards
4. (optionally) 100G switch to connect FPGA and the detector
Unfortunately, at the moment it is not possible to purchase server configuration from a major vendor that would include
AMD FPGA boards. Therefore, the two has to be purchases separately. This might have impact on the warranty for the hardware
and has to be clarified with the vendor. PSI only supports the system on the best effort basis and doesn't take any responsibility
for warranty limitations for operating FPGA boards in the server. Having said this - we didn't encounter any hardware issues so far.
## High performance server
PSI is using HPE DL380 Gen11 servers are the moment to operate Jungfraujoch systems. However, this is because of general
preference for this vendor, there is no Jungfraujoch-specific reason to buy from this vendor. We do expect that system
from any other vendor with similar specification should work as well.
At PSI, we use the following configuration of HPE DL380 Gen11 to operate 9M pixel detectors at 2 kHz is as follows:
* 2 x Intel Xeon 8558P
* 512 GB RAM
* 2 x Nvidia L4 GPU (for indexing)
* 1 x Nvidia Connect-X 6 200G ethernet/IB network (for outgoing traffic; this can be substituted according to facility needs)
* Copper 1G/10G network
### PCI slots
When ordering the system it is important to ensure enough PCIe cards can be accommodated in the system.
In case of our system we need to put at least seven PCIe cards: 4 x FPGA, 2x GPU, 1x network
Note - for FPGA x8 lane electrically/x16 lane mechanically PCIe slots are OK.
## FPGA
Jungfraujoch is built for [AMD/Xilinx U55C](https://www.amd.com/en/products/accelerators/alveo/u55c/a-u55c-p00g-pq-g.html)
(A-U55C-P00G-PQ-G) card. Other FPGA cards are currently not supported.
Single U55C card supports roughly 5 detector modules (2.5M pixels) at 2 kHz and 10 detector modules (5M pixels) at 1 kHz.
For detectors operating at lower frame rates (e.g., 100 Hz) larger detectors can be supported by a single U55C card, though it requires
using TX delay functionality in the detector.
## GPUs
Operating fast-feedback indexer code requires operation of a graphic processing unit from Nvidia.
For practical reasons, i.e. power consumption and cost, we choose inference grade card Nvidia L4.
In the past we have also used T4 cards. So, in principle any recent CUDA compatible GPU should work.
## Network switch
Small detectors (up to 4M pixel) can be in principle operated without switch. In this case one needs `8x10g` variant
of the Jungfraujoch FPGA image, which allows to directly connect 4 JUNGFRAU modules to one U55C card.
Such configuration is however
impractical for larger systems or more complex deployments, like multiple detectors operated from one Jungfraujochs server.
In this case one needs a network switch.
We currently use Nvidia/Mellanox SN2100 switch, though there is no reason not to use other models/other vendors.
For switches with only 100G ports it is important to ensure, that these can be split into 4x10G ports to connect the detector.

View File

@@ -12,14 +12,17 @@ The project is supported by :
## License
Operating Jungfraujoch requires license from the Paul Scherrer Institute.
Specifically, non-profit research facilities operating PSI JUNGFRAU and PSI EIGER detectors are granted the license to use the
code and binary images within their facilities, as well as to modify the code according to their needs.
Sharing the code requires explicit permission from the Paul Scherrer Institute.
## Hardware requirements
1. PSI JUNGFRAU or EIGER detector
2. Server system with AMD/Xilinx Alveo U55C cards and optionally Nvidia GPUs
## Compatible detectors
Currently, Jungfraujoch supports PSI JUNGFRAU and PSI EIGER detectors.
At the moment only AMD Alveo U55C card is supported by Jungfraujoch.
Nvidia L4 GPU is recommended for indexing and used for performance tuning.
## Hardware requirements
See [hardware requirements](HARDWARE.md) documentation.
## FPGA bitstream
Instructions see [here](fpga/README.md)
@@ -28,18 +31,22 @@ Instructions see [here](fpga/README.md)
Jungfraujoch supports PSI JUNGFRAU and EIGER detectors. Jungfruajoch controls the detector via statically compiled `slsDetectorPackage` into its source code.
It is important that detector firmware has to match `slsDetectorPackage` version used in Jungfraujoch (8.0.2 at the moment).
See [PSI Detector group website](https://www.psi.ch/en/lxn/software-releases) for details.
## Software
Recommended operating system is Red Hat Enterprise Linux (RHEL) / Rocky Linux versions 8 and 9 (both are tested on a regular basis).
## Operating system
Recommended operating system is Red Hat Enterprise Linux (RHEL) / Rocky Linux versions 8.
For this operating system we provide RPMs with pre-built binaries to simplify deployment.
We do also operate one of the systems with Rocky 9 without issues.
Running Jungfraujoch on Red Hat Enterprise Linux 7 is currently not tested and not recommended,
but likely possible with providing multiple packages from external repositories.
but likely possible with providing some packages from external repositories.
There are some limited tests with recent Ubuntu and Fedora distributions, though these are not systematic.
Other linux platforms should work, but no tests were done so far.
### Dependencies
### Software dependencies
Required:
* C++20 compiler and C++20 standard library; recommended GCC 11+ or clang 14+ (Intel OneAPI, AMD AOCC)
* CMake version 3.21 or newer + GNU make tool
* JPEG library (turbo-jpeg is also OK)
* JPEG library (turbo-jpeg is OK)
Optional:
* CUDA compiler version 11 or newer - required for MX fast feedback indexer
@@ -69,6 +76,9 @@ Directly included in the repository:
For license check LICENSE file in respective directory
## Installation guide
Follow [Installation guide](INSTALL.md).
### Software components
* `jfjoch_broker` in `broker` - main service running on the Jungfraujoch server, responsible for control of the detector and data acquisition;
@@ -76,32 +86,6 @@ For license check LICENSE file in respective directory
* `jfjoch_writer` in `writer` - HDF5 writer; HDF5 writer is designed to work on the same or separate server system. It has rather limited requirements in terms of performance and memory.
The goal is to separate data acquisition node with custom FPGA hardware and file system node with stronger security/stability requirements. See [details](writer/README.md).
### Compilation
Use the following commands:
```
mkdir build
cd build
cmake ..
make jfjoch
```
### Compilation (writer only)
In most use cases it is better to have a separate machine, with access to distributed file system, for writing.
Such machine needs only a HDF5 writer service with fewer dependencies. For compilation use the following commands:
```
mkdir build
cd build
cmake -DJFJOCH_WRITER_ONLY=ON ..
make jfjoch
```
## Versions
**FPGA release** is as hexadecimal number indicted in the [jfjoch_fpga.h](fpga/pcie_driver/jfjoch_fpga.h) as JFJOCH_FPGA_RELEASE constant. This number indicated breaking changes in the FPGA firmware interface.
FPGA release has to be consistent between FPGA firmware, kernel driver and `jfjoch_broker` - both kernel driver and software won't work in case of version mismatch.
Commits to `main` branch with the same FPGA release version are OK to mix between components.
## Web Frontend
Jungfraujoch is equipped with React-based web frontend for user-friendly experience. Frontend has the following options:
* Presenting current state of the detector
@@ -112,14 +96,8 @@ Jungfraujoch is equipped with React-based web frontend for user-friendly experie
Frontend is written in TypeScript. For details see [frontend/](frontend) directory.
Jungfraujoch Cmake scripts have an option to start frontend build with the following command:
```
mkdir build
cd build
cmake ..
make frontend
```
Contrary to standard CMake way, frontend will be built in "source" `frontend/build` directory, not in `build/` subdirectory.
## OpenAPI python client
Jungfraujoch is controlled with HTTP/REST interface defined with an OpenAPI specification. For convenience, we provide Python client in [python_client](python_client/) directory.
## Tests

View File

@@ -1 +1 @@
1.0.0-rc.15
1.0.0-rc.16

View File

@@ -147,7 +147,8 @@ int64_t AcquisitionCounters::CalculateDelay(size_t curr_frame, uint16_t module_n
slowest_head_tmp = GetSlowestFrameNumber();
else
slowest_head_tmp = GetCurrFrameNumber(module_number);
if (slowest_head_tmp < curr_frame)
return 0;
return slowest_head_tmp - curr_frame;
}

View File

@@ -7,6 +7,7 @@
#include "../image_pusher/HDF5FilePusher.h"
#include "OpenAPIConvert.h"
#include "Detector_type.h"
#include "../image_pusher/NonePusher.h"
DetectorGeometry ParseStandardDetectorGeometry(const org::openapitools::server::model::Detector &j) {
auto s = j.getStandardGeometry();
@@ -114,8 +115,18 @@ void ParseFacilityConfiguration(const org::openapitools::server::model::Jfjoch_s
std::unique_ptr<ImagePusher> ParseZMQImagePusher(const org::openapitools::server::model::Jfjoch_settings &j) {
if (!j.zeromqIsSet())
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "ZeroMQ settings must be provided");
std::optional<int32_t> send_buffer_size;
if (j.getZeromq().sendBufferSizeIsSet())
send_buffer_size = j.getZeromq().getSendBufferSize();
std::optional<int32_t> send_watermark;
if (j.getZeromq().sendWatermarkIsSet())
send_watermark = j.getZeromq().getSendWatermark();
auto tmp = std::make_unique<ZMQStream2Pusher>(j.getZeromq().getImageSocket(),
j.getZeromq().getSendWatermark());
send_watermark,
send_buffer_size);
if (j.getZeromq().previewSocketIsSet())
tmp->PreviewSocket(j.getZeromq().getPreviewSocket());
@@ -132,7 +143,7 @@ std::unique_ptr<ImagePusher> ParseImagePusher(const org::openapitools::server::m
case org::openapitools::server::model::Image_pusher_type::eImage_pusher_type::HDF5:
return std::make_unique<HDF5FilePusher>();
case org::openapitools::server::model::Image_pusher_type::eImage_pusher_type::NONE:
return {};
return std::make_unique<NonePusher>();
case org::openapitools::server::model::Image_pusher_type::eImage_pusher_type::CBOR:
return std::make_unique<CBORFilePusher>();
default:

View File

@@ -73,9 +73,49 @@ org::openapitools::server::model::Measurement_statistics Convert(const Measureme
ret.setBkgEstimate(input.bkg_estimate.value());
ret.setUnitCell(input.unit_cell);
ret.setRunNumber(input.run_number);
return ret;
}
DetectorTiming Convert(const org::openapitools::server::model::Detector_timing& input) {
switch (input.getValue()) {
case org::openapitools::server::model::Detector_timing::eDetector_timing::AUTO:
return DetectorTiming::Auto;
case org::openapitools::server::model::Detector_timing::eDetector_timing::TRIGGER:
return DetectorTiming::Trigger;
case org::openapitools::server::model::Detector_timing::eDetector_timing::BURST:
return DetectorTiming::Burst;
case org::openapitools::server::model::Detector_timing::eDetector_timing::GATED:
return DetectorTiming::Gated;
default:
case org::openapitools::server::model::Detector_timing::eDetector_timing::INVALID_VALUE_OPENAPI_GENERATED:
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "invalid input");
}
}
org::openapitools::server::model::Detector_timing Convert(DetectorTiming input) {
org::openapitools::server::model::Detector_timing val;
switch (input) {
case DetectorTiming::Auto:
val.setValue(org::openapitools::server::model::Detector_timing::eDetector_timing::AUTO);
break;
case DetectorTiming::Trigger:
val.setValue(org::openapitools::server::model::Detector_timing::eDetector_timing::TRIGGER);
break;
case DetectorTiming::Burst:
val.setValue(org::openapitools::server::model::Detector_timing::eDetector_timing::BURST);
break;
case DetectorTiming::Gated:
val.setValue(org::openapitools::server::model::Detector_timing::eDetector_timing::GATED);
break;
default:
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid, "invalid input");
}
return val;
}
DetectorSettings Convert(const org::openapitools::server::model::Detector_settings &input) {
DetectorSettings ret{};
@@ -85,22 +125,29 @@ DetectorSettings Convert(const org::openapitools::server::model::Detector_settin
else
ret.FrameTime(std::chrono::microseconds(input.getFrameTimeUs()));
ret.StorageCells(input.getStorageCellCount());
ret.StorageCellDelay(std::chrono::nanoseconds(input.getStorageCellDelayNs()));
ret.FixGainG1(input.isFixedGainG1());
ret.UseGainHG0(input.isUseGainHg0());
ret.InternalGeneratorEnable(input.isInternalFrameGenerator());
ret.InternalGeneratorImages(input.getInternalFrameGeneratorImages());
ret.PedestalG0Frames(input.getPedestalG0Frames());
ret.PedestalG1Frames(input.getPedestalG1Frames());
ret.PedestalG2Frames(input.getPedestalG2Frames());
ret.PedestalMinImageCount(input.getPedestalMinImageCount());
ret.PedestalG0RMSLimit(input.getPedestalG0RmsLimit());
ret.DetectorDelay(std::chrono::nanoseconds(input.getDetectorTriggerDelayNs()));
ret.StorageCells(input.getJungfrauStorageCellCount());
ret.StorageCellDelay(std::chrono::nanoseconds(input.getJungfrauStorageCellDelayNs()));
ret.FixGainG1(input.isJungfrauFixedGainG1());
ret.UseGainHG0(input.isJungfrauUseGainHg0());
ret.PedestalG0Frames(input.getJungfrauPedestalG0Frames());
ret.PedestalG1Frames(input.getJungfrauPedestalG1Frames());
ret.PedestalG2Frames(input.getJungfrauPedestalG2Frames());
ret.PedestalMinImageCount(input.getJungfrauPedestalMinImageCount());
ret.PedestalG0RMSLimit(input.getJungfrauPedestalG0RmsLimit());
if (input.eigerThresholdKeVIsSet())
ret.EigerThreshold_keV(input.getEigerThresholdKeV());
if (input.timingIsSet())
ret.Timing(Convert(input.getTiming()));
else
ret.Timing(DetectorTiming::Trigger);
return ret;
}
@@ -110,21 +157,25 @@ org::openapitools::server::model::Detector_settings Convert(const DetectorSettin
ret.setFrameTimeUs(input.GetFrameTime().count());
if (input.GetCountTime().has_value())
ret.setCountTimeUs(input.GetCountTime()->count());
ret.setStorageCellCount(input.GetStorageCells());
ret.setInternalFrameGenerator(input.IsInternalGeneratorEnable());
ret.setFixedGainG1(input.IsFixGainG1());
ret.setUseGainHg0(input.IsUseGainHG0());
ret.setPedestalG0Frames(input.GetPedestalG0Frames());
ret.setPedestalG1Frames(input.GetPedestalG1Frames());
ret.setPedestalG2Frames(input.GetPedestalG2Frames());
ret.setPedestalMinImageCount(input.GetPedestalMinImageCount());
ret.setStorageCellDelayNs(input.GetStorageCellDelay().count());
ret.setDetectorTriggerDelayNs(input.GetDetectorDelay().count());
ret.setInternalFrameGeneratorImages(input.GetInternalGeneratorImages());
ret.setPedestalG0RmsLimit(input.GetPedestalG0RMSLimit());
ret.setInternalFrameGenerator(input.IsInternalGeneratorEnable());
ret.setJungfrauStorageCellCount(input.GetStorageCells());
ret.setJungfrauFixedGainG1(input.IsFixGainG1());
ret.setJungfrauUseGainHg0(input.IsUseGainHG0());
ret.setJungfrauPedestalG0Frames(input.GetPedestalG0Frames());
ret.setJungfrauPedestalG1Frames(input.GetPedestalG1Frames());
ret.setJungfrauPedestalG2Frames(input.GetPedestalG2Frames());
ret.setJungfrauPedestalMinImageCount(input.GetPedestalMinImageCount());
ret.setJungfrauStorageCellDelayNs(input.GetStorageCellDelay().count());
ret.setJungfrauPedestalG0RmsLimit(input.GetPedestalG0RMSLimit());
if (input.GetEIGERThreshold_keV().has_value())
ret.setEigerThresholdKeV(input.GetEIGERThreshold_keV().value());
ret.setTiming(Convert(input.GetTiming()));
return ret;
}
@@ -191,38 +242,55 @@ InstrumentMetadata Convert(const org::openapitools::server::model::Instrument_me
return output;
}
org::openapitools::server::model::Detector_state Convert(DetectorState input) {
org::openapitools::server::model::Detector_state ret;
switch (input) {
case DetectorState::IDLE:
ret.setValue(org::openapitools::server::model::Detector_state::eDetector_state::IDLE);
break;
case DetectorState::ERROR:
ret.setValue(org::openapitools::server::model::Detector_state::eDetector_state::ERROR);
break;
case DetectorState::BUSY:
ret.setValue(org::openapitools::server::model::Detector_state::eDetector_state::BUSY);
break;
case DetectorState::WAITING:
ret.setValue(org::openapitools::server::model::Detector_state::eDetector_state::WAITING);
break;
default:
case DetectorState::NOT_CONNECTED:
ret.setValue(org::openapitools::server::model::Detector_state::eDetector_state::NOT_CONNECTED);
break;
}
return ret;
}
org::openapitools::server::model::Detector_power_state Convert(DetectorPowerState input) {
org::openapitools::server::model::Detector_power_state ret;
switch (input) {
case DetectorPowerState::ON:
ret.setValue(org::openapitools::server::model::Detector_power_state::eDetector_power_state::POWERON);
break;
case DetectorPowerState::PARTIAL:
ret.setValue(org::openapitools::server::model::Detector_power_state::eDetector_power_state::PARTIAL);
break;
default:
case DetectorPowerState::OFF:
ret.setValue(org::openapitools::server::model::Detector_power_state::eDetector_power_state::POWEROFF);
break;
}
return ret;
}
org::openapitools::server::model::Detector_status Convert(const DetectorStatus &input) {
org::openapitools::server::model::Detector_status output;
output.setServerVersion(input.detector_server_version);
output.setNumberOfTriggersLeft(input.remaining_triggers);
output.setFpgaTempDegC(input.temperature_fpga_degC);
output.setHighVoltageV(input.high_voltage_V);
switch (input.power_state) {
case DetectorPowerState::ON:
output.setPowerchip("PowerOn");
break;
case DetectorPowerState::OFF:
output.setPowerchip("PowerOff");
break;
case DetectorPowerState::PARTIAL:
output.setPowerchip("Partial");
break;
}
switch (input.detector_state) {
case DetectorState::IDLE:
output.setState("Idle");
break;
case DetectorState::ERROR:
output.setState("Error");
break;
case DetectorState::BUSY:
output.setState("Busy");
break;
case DetectorState::WAITING:
output.setState("Waiting");
break;
}
output.setPowerchip(Convert(input.power_state));
output.setState(Convert(input.detector_state));
return output;
}

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -0,0 +1,122 @@
/**
* Jungfraujoch
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
#include "Detector_power_state.h"
#include "Helpers.h"
#include <stdexcept>
#include <sstream>
namespace org::openapitools::server::model
{
Detector_power_state::Detector_power_state()
{
}
void Detector_power_state::validate() const
{
std::stringstream msg;
if (!validate(msg))
{
throw org::openapitools::server::helpers::ValidationException(msg.str());
}
}
bool Detector_power_state::validate(std::stringstream& msg) const
{
return validate(msg, "");
}
bool Detector_power_state::validate(std::stringstream& msg, const std::string& pathPrefix) const
{
bool success = true;
const std::string _pathPrefix = pathPrefix.empty() ? "Detector_power_state" : pathPrefix;
if (m_value == Detector_power_state::eDetector_power_state::INVALID_VALUE_OPENAPI_GENERATED)
{
success = false;
msg << _pathPrefix << ": has no value;";
}
return success;
}
bool Detector_power_state::operator==(const Detector_power_state& rhs) const
{
return
getValue() == rhs.getValue()
;
}
bool Detector_power_state::operator!=(const Detector_power_state& rhs) const
{
return !(*this == rhs);
}
void to_json(nlohmann::json& j, const Detector_power_state& o)
{
j = nlohmann::json::object();
switch (o.getValue())
{
case Detector_power_state::eDetector_power_state::INVALID_VALUE_OPENAPI_GENERATED:
j = "INVALID_VALUE_OPENAPI_GENERATED";
break;
case Detector_power_state::eDetector_power_state::POWERON:
j = "PowerOn";
break;
case Detector_power_state::eDetector_power_state::POWEROFF:
j = "PowerOff";
break;
case Detector_power_state::eDetector_power_state::PARTIAL:
j = "Partial";
break;
}
}
void from_json(const nlohmann::json& j, Detector_power_state& o)
{
auto s = j.get<std::string>();
if (s == "PowerOn") {
o.setValue(Detector_power_state::eDetector_power_state::POWERON);
}
else if (s == "PowerOff") {
o.setValue(Detector_power_state::eDetector_power_state::POWEROFF);
}
else if (s == "Partial") {
o.setValue(Detector_power_state::eDetector_power_state::PARTIAL);
} else {
std::stringstream ss;
ss << "Unexpected value " << s << " in json"
<< " cannot be converted to enum of type"
<< " Detector_power_state::eDetector_power_state";
throw std::invalid_argument(ss.str());
}
}
Detector_power_state::eDetector_power_state Detector_power_state::getValue() const
{
return m_value;
}
void Detector_power_state::setValue(Detector_power_state::eDetector_power_state value)
{
m_value = value;
}
} // namespace org::openapitools::server::model

View File

@@ -0,0 +1,80 @@
/**
* Jungfraujoch
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/*
* Detector_power_state.h
*
* Power on of ASICs
*/
#ifndef Detector_power_state_H_
#define Detector_power_state_H_
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
/// Power on of ASICs
/// </summary>
class Detector_power_state
{
public:
Detector_power_state();
virtual ~Detector_power_state() = default;
enum class eDetector_power_state {
// To have a valid default value.
// Avoiding name clashes with user defined
// enum values
INVALID_VALUE_OPENAPI_GENERATED = 0,
POWERON,
POWEROFF,
PARTIAL
};
/// <summary>
/// Validate the current data in the model. Throws a ValidationException on failure.
/// </summary>
void validate() const;
/// <summary>
/// Validate the current data in the model. Returns false on error and writes an error
/// message into the given stringstream.
/// </summary>
bool validate(std::stringstream& msg) const;
/// <summary>
/// Helper overload for validate. Used when one model stores another model and calls it's validate.
/// Not meant to be called outside that case.
/// </summary>
bool validate(std::stringstream& msg, const std::string& pathPrefix) const;
bool operator==(const Detector_power_state& rhs) const;
bool operator!=(const Detector_power_state& rhs) const;
/////////////////////////////////////////////
/// Detector_power_state members
Detector_power_state::eDetector_power_state getValue() const;
void setValue(Detector_power_state::eDetector_power_state value);
friend void to_json(nlohmann::json& j, const Detector_power_state& o);
friend void from_json(const nlohmann::json& j, Detector_power_state& o);
protected:
Detector_power_state::eDetector_power_state m_value = Detector_power_state::eDetector_power_state::INVALID_VALUE_OPENAPI_GENERATED;
};
} // namespace org::openapitools::server::model
#endif /* Detector_power_state_H_ */

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -24,21 +24,33 @@ Detector_settings::Detector_settings()
m_Frame_time_us = 0L;
m_Count_time_us = 0L;
m_Count_time_usIsSet = false;
m_Storage_cell_count = 1L;
m_Internal_frame_generator = false;
m_Internal_frame_generatorIsSet = false;
m_Internal_frame_generator_images = 1L;
m_Pedestal_g0_frames = 2000L;
m_Pedestal_g1_frames = 300L;
m_Pedestal_g2_frames = 300L;
m_Pedestal_g0_rms_limit = 100L;
m_Pedestal_min_image_count = 128L;
m_Storage_cell_delay_ns = 5000L;
m_Internal_frame_generator_imagesIsSet = false;
m_Detector_trigger_delay_ns = 0L;
m_Detector_trigger_delay_nsIsSet = false;
m_Fixed_gain_g1 = false;
m_Fixed_gain_g1IsSet = false;
m_Use_gain_hg0 = false;
m_Use_gain_hg0IsSet = false;
m_TimingIsSet = false;
m_Eiger_threshold_keV = 0.0f;
m_Eiger_threshold_keVIsSet = false;
m_Jungfrau_pedestal_g0_frames = 2000L;
m_Jungfrau_pedestal_g0_framesIsSet = false;
m_Jungfrau_pedestal_g1_frames = 300L;
m_Jungfrau_pedestal_g1_framesIsSet = false;
m_Jungfrau_pedestal_g2_frames = 300L;
m_Jungfrau_pedestal_g2_framesIsSet = false;
m_Jungfrau_pedestal_g0_rms_limit = 100L;
m_Jungfrau_pedestal_g0_rms_limitIsSet = false;
m_Jungfrau_pedestal_min_image_count = 128L;
m_Jungfrau_pedestal_min_image_countIsSet = false;
m_Jungfrau_storage_cell_count = 1L;
m_Jungfrau_storage_cell_countIsSet = false;
m_Jungfrau_storage_cell_delay_ns = 5000L;
m_Jungfrau_storage_cell_delay_nsIsSet = false;
m_Jungfrau_fixed_gain_g1 = false;
m_Jungfrau_fixed_gain_g1IsSet = false;
m_Jungfrau_use_gain_hg0 = false;
m_Jungfrau_use_gain_hg0IsSet = false;
}
@@ -75,28 +87,9 @@ bool Detector_settings::validate(std::stringstream& msg, const std::string& path
}
}
/* Storage_cell_count */ {
const int64_t& value = m_Storage_cell_count;
const std::string currentValuePath = _pathPrefix + ".storageCellCount";
if (value < 1ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 1;";
}
if (value > 16ll)
{
success = false;
msg << currentValuePath << ": must be less than or equal to 16;";
}
}
/* Internal_frame_generator_images */ {
if (internalFrameGeneratorImagesIsSet())
{
const int64_t& value = m_Internal_frame_generator_images;
const std::string currentValuePath = _pathPrefix + ".internalFrameGeneratorImages";
@@ -114,90 +107,6 @@ bool Detector_settings::validate(std::stringstream& msg, const std::string& path
}
/* Pedestal_g0_frames */ {
const int64_t& value = m_Pedestal_g0_frames;
const std::string currentValuePath = _pathPrefix + ".pedestalG0Frames";
if (value < 0ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 0;";
}
}
/* Pedestal_g1_frames */ {
const int64_t& value = m_Pedestal_g1_frames;
const std::string currentValuePath = _pathPrefix + ".pedestalG1Frames";
if (value < 0ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 0;";
}
}
/* Pedestal_g2_frames */ {
const int64_t& value = m_Pedestal_g2_frames;
const std::string currentValuePath = _pathPrefix + ".pedestalG2Frames";
if (value < 0ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 0;";
}
}
/* Pedestal_g0_rms_limit */ {
const int64_t& value = m_Pedestal_g0_rms_limit;
const std::string currentValuePath = _pathPrefix + ".pedestalG0RmsLimit";
if (value < 0ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 0;";
}
}
/* Pedestal_min_image_count */ {
const int64_t& value = m_Pedestal_min_image_count;
const std::string currentValuePath = _pathPrefix + ".pedestalMinImageCount";
if (value < 32ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 32;";
}
}
/* Storage_cell_delay_ns */ {
const int64_t& value = m_Storage_cell_delay_ns;
const std::string currentValuePath = _pathPrefix + ".storageCellDelayNs";
if (value < 2100ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 2100;";
}
}
if (detectorTriggerDelayNsIsSet())
{
const int64_t& value = m_Detector_trigger_delay_ns;
@@ -211,6 +120,128 @@ bool Detector_settings::validate(std::stringstream& msg, const std::string& path
}
}
if (eigerThresholdKeVIsSet())
{
const float& value = m_Eiger_threshold_keV;
const std::string currentValuePath = _pathPrefix + ".eigerThresholdKeV";
if (value < static_cast<float>(1.0))
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 1.0;";
}
if (value > static_cast<float>(100.0))
{
success = false;
msg << currentValuePath << ": must be less than or equal to 100.0;";
}
}
if (jungfrauPedestalG0FramesIsSet())
{
const int64_t& value = m_Jungfrau_pedestal_g0_frames;
const std::string currentValuePath = _pathPrefix + ".jungfrauPedestalG0Frames";
if (value < 0ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 0;";
}
}
if (jungfrauPedestalG1FramesIsSet())
{
const int64_t& value = m_Jungfrau_pedestal_g1_frames;
const std::string currentValuePath = _pathPrefix + ".jungfrauPedestalG1Frames";
if (value < 0ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 0;";
}
}
if (jungfrauPedestalG2FramesIsSet())
{
const int64_t& value = m_Jungfrau_pedestal_g2_frames;
const std::string currentValuePath = _pathPrefix + ".jungfrauPedestalG2Frames";
if (value < 0ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 0;";
}
}
if (jungfrauPedestalG0RmsLimitIsSet())
{
const int64_t& value = m_Jungfrau_pedestal_g0_rms_limit;
const std::string currentValuePath = _pathPrefix + ".jungfrauPedestalG0RmsLimit";
if (value < 0ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 0;";
}
}
if (jungfrauPedestalMinImageCountIsSet())
{
const int64_t& value = m_Jungfrau_pedestal_min_image_count;
const std::string currentValuePath = _pathPrefix + ".jungfrauPedestalMinImageCount";
if (value < 32ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 32;";
}
}
if (jungfrauStorageCellCountIsSet())
{
const int64_t& value = m_Jungfrau_storage_cell_count;
const std::string currentValuePath = _pathPrefix + ".jungfrauStorageCellCount";
if (value < 1ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 1;";
}
if (value > 16ll)
{
success = false;
msg << currentValuePath << ": must be less than or equal to 16;";
}
}
if (jungfrauStorageCellDelayNsIsSet())
{
const int64_t& value = m_Jungfrau_storage_cell_delay_ns;
const std::string currentValuePath = _pathPrefix + ".jungfrauStorageCellDelayNs";
if (value < 2100ll)
{
success = false;
msg << currentValuePath << ": must be greater than or equal to 2100;";
}
}
return success;
}
@@ -226,41 +257,47 @@ bool Detector_settings::operator==(const Detector_settings& rhs) const
((!countTimeUsIsSet() && !rhs.countTimeUsIsSet()) || (countTimeUsIsSet() && rhs.countTimeUsIsSet() && getCountTimeUs() == rhs.getCountTimeUs())) &&
(getStorageCellCount() == rhs.getStorageCellCount())
&&
(isInternalFrameGenerator() == rhs.isInternalFrameGenerator())
&&
((!internalFrameGeneratorIsSet() && !rhs.internalFrameGeneratorIsSet()) || (internalFrameGeneratorIsSet() && rhs.internalFrameGeneratorIsSet() && isInternalFrameGenerator() == rhs.isInternalFrameGenerator())) &&
(getInternalFrameGeneratorImages() == rhs.getInternalFrameGeneratorImages())
&&
(getPedestalG0Frames() == rhs.getPedestalG0Frames())
&&
(getPedestalG1Frames() == rhs.getPedestalG1Frames())
&&
(getPedestalG2Frames() == rhs.getPedestalG2Frames())
&&
(getPedestalG0RmsLimit() == rhs.getPedestalG0RmsLimit())
&&
(getPedestalMinImageCount() == rhs.getPedestalMinImageCount())
&&
(getStorageCellDelayNs() == rhs.getStorageCellDelayNs())
&&
((!internalFrameGeneratorImagesIsSet() && !rhs.internalFrameGeneratorImagesIsSet()) || (internalFrameGeneratorImagesIsSet() && rhs.internalFrameGeneratorImagesIsSet() && getInternalFrameGeneratorImages() == rhs.getInternalFrameGeneratorImages())) &&
((!detectorTriggerDelayNsIsSet() && !rhs.detectorTriggerDelayNsIsSet()) || (detectorTriggerDelayNsIsSet() && rhs.detectorTriggerDelayNsIsSet() && getDetectorTriggerDelayNs() == rhs.getDetectorTriggerDelayNs())) &&
((!fixedGainG1IsSet() && !rhs.fixedGainG1IsSet()) || (fixedGainG1IsSet() && rhs.fixedGainG1IsSet() && isFixedGainG1() == rhs.isFixedGainG1())) &&
((!timingIsSet() && !rhs.timingIsSet()) || (timingIsSet() && rhs.timingIsSet() && getTiming() == rhs.getTiming())) &&
((!useGainHg0IsSet() && !rhs.useGainHg0IsSet()) || (useGainHg0IsSet() && rhs.useGainHg0IsSet() && isUseGainHg0() == rhs.isUseGainHg0()))
((!eigerThresholdKeVIsSet() && !rhs.eigerThresholdKeVIsSet()) || (eigerThresholdKeVIsSet() && rhs.eigerThresholdKeVIsSet() && getEigerThresholdKeV() == rhs.getEigerThresholdKeV())) &&
((!jungfrauPedestalG0FramesIsSet() && !rhs.jungfrauPedestalG0FramesIsSet()) || (jungfrauPedestalG0FramesIsSet() && rhs.jungfrauPedestalG0FramesIsSet() && getJungfrauPedestalG0Frames() == rhs.getJungfrauPedestalG0Frames())) &&
((!jungfrauPedestalG1FramesIsSet() && !rhs.jungfrauPedestalG1FramesIsSet()) || (jungfrauPedestalG1FramesIsSet() && rhs.jungfrauPedestalG1FramesIsSet() && getJungfrauPedestalG1Frames() == rhs.getJungfrauPedestalG1Frames())) &&
((!jungfrauPedestalG2FramesIsSet() && !rhs.jungfrauPedestalG2FramesIsSet()) || (jungfrauPedestalG2FramesIsSet() && rhs.jungfrauPedestalG2FramesIsSet() && getJungfrauPedestalG2Frames() == rhs.getJungfrauPedestalG2Frames())) &&
((!jungfrauPedestalG0RmsLimitIsSet() && !rhs.jungfrauPedestalG0RmsLimitIsSet()) || (jungfrauPedestalG0RmsLimitIsSet() && rhs.jungfrauPedestalG0RmsLimitIsSet() && getJungfrauPedestalG0RmsLimit() == rhs.getJungfrauPedestalG0RmsLimit())) &&
((!jungfrauPedestalMinImageCountIsSet() && !rhs.jungfrauPedestalMinImageCountIsSet()) || (jungfrauPedestalMinImageCountIsSet() && rhs.jungfrauPedestalMinImageCountIsSet() && getJungfrauPedestalMinImageCount() == rhs.getJungfrauPedestalMinImageCount())) &&
((!jungfrauStorageCellCountIsSet() && !rhs.jungfrauStorageCellCountIsSet()) || (jungfrauStorageCellCountIsSet() && rhs.jungfrauStorageCellCountIsSet() && getJungfrauStorageCellCount() == rhs.getJungfrauStorageCellCount())) &&
((!jungfrauStorageCellDelayNsIsSet() && !rhs.jungfrauStorageCellDelayNsIsSet()) || (jungfrauStorageCellDelayNsIsSet() && rhs.jungfrauStorageCellDelayNsIsSet() && getJungfrauStorageCellDelayNs() == rhs.getJungfrauStorageCellDelayNs())) &&
((!jungfrauFixedGainG1IsSet() && !rhs.jungfrauFixedGainG1IsSet()) || (jungfrauFixedGainG1IsSet() && rhs.jungfrauFixedGainG1IsSet() && isJungfrauFixedGainG1() == rhs.isJungfrauFixedGainG1())) &&
((!jungfrauUseGainHg0IsSet() && !rhs.jungfrauUseGainHg0IsSet()) || (jungfrauUseGainHg0IsSet() && rhs.jungfrauUseGainHg0IsSet() && isJungfrauUseGainHg0() == rhs.isJungfrauUseGainHg0()))
;
}
@@ -276,21 +313,34 @@ void to_json(nlohmann::json& j, const Detector_settings& o)
j["frame_time_us"] = o.m_Frame_time_us;
if(o.countTimeUsIsSet())
j["count_time_us"] = o.m_Count_time_us;
j["storage_cell_count"] = o.m_Storage_cell_count;
j["internal_frame_generator"] = o.m_Internal_frame_generator;
j["internal_frame_generator_images"] = o.m_Internal_frame_generator_images;
j["pedestal_g0_frames"] = o.m_Pedestal_g0_frames;
j["pedestal_g1_frames"] = o.m_Pedestal_g1_frames;
j["pedestal_g2_frames"] = o.m_Pedestal_g2_frames;
j["pedestal_g0_rms_limit"] = o.m_Pedestal_g0_rms_limit;
j["pedestal_min_image_count"] = o.m_Pedestal_min_image_count;
j["storage_cell_delay_ns"] = o.m_Storage_cell_delay_ns;
if(o.internalFrameGeneratorIsSet())
j["internal_frame_generator"] = o.m_Internal_frame_generator;
if(o.internalFrameGeneratorImagesIsSet())
j["internal_frame_generator_images"] = o.m_Internal_frame_generator_images;
if(o.detectorTriggerDelayNsIsSet())
j["detector_trigger_delay_ns"] = o.m_Detector_trigger_delay_ns;
if(o.fixedGainG1IsSet())
j["fixed_gain_g1"] = o.m_Fixed_gain_g1;
if(o.useGainHg0IsSet())
j["use_gain_hg0"] = o.m_Use_gain_hg0;
if(o.timingIsSet())
j["timing"] = o.m_Timing;
if(o.eigerThresholdKeVIsSet())
j["eiger_threshold_keV"] = o.m_Eiger_threshold_keV;
if(o.jungfrauPedestalG0FramesIsSet())
j["jungfrau_pedestal_g0_frames"] = o.m_Jungfrau_pedestal_g0_frames;
if(o.jungfrauPedestalG1FramesIsSet())
j["jungfrau_pedestal_g1_frames"] = o.m_Jungfrau_pedestal_g1_frames;
if(o.jungfrauPedestalG2FramesIsSet())
j["jungfrau_pedestal_g2_frames"] = o.m_Jungfrau_pedestal_g2_frames;
if(o.jungfrauPedestalG0RmsLimitIsSet())
j["jungfrau_pedestal_g0_rms_limit"] = o.m_Jungfrau_pedestal_g0_rms_limit;
if(o.jungfrauPedestalMinImageCountIsSet())
j["jungfrau_pedestal_min_image_count"] = o.m_Jungfrau_pedestal_min_image_count;
if(o.jungfrauStorageCellCountIsSet())
j["jungfrau_storage_cell_count"] = o.m_Jungfrau_storage_cell_count;
if(o.jungfrauStorageCellDelayNsIsSet())
j["jungfrau_storage_cell_delay_ns"] = o.m_Jungfrau_storage_cell_delay_ns;
if(o.jungfrauFixedGainG1IsSet())
j["jungfrau_fixed_gain_g1"] = o.m_Jungfrau_fixed_gain_g1;
if(o.jungfrauUseGainHg0IsSet())
j["jungfrau_use_gain_hg0"] = o.m_Jungfrau_use_gain_hg0;
}
@@ -302,29 +352,75 @@ void from_json(const nlohmann::json& j, Detector_settings& o)
j.at("count_time_us").get_to(o.m_Count_time_us);
o.m_Count_time_usIsSet = true;
}
j.at("storage_cell_count").get_to(o.m_Storage_cell_count);
j.at("internal_frame_generator").get_to(o.m_Internal_frame_generator);
j.at("internal_frame_generator_images").get_to(o.m_Internal_frame_generator_images);
j.at("pedestal_g0_frames").get_to(o.m_Pedestal_g0_frames);
j.at("pedestal_g1_frames").get_to(o.m_Pedestal_g1_frames);
j.at("pedestal_g2_frames").get_to(o.m_Pedestal_g2_frames);
j.at("pedestal_g0_rms_limit").get_to(o.m_Pedestal_g0_rms_limit);
j.at("pedestal_min_image_count").get_to(o.m_Pedestal_min_image_count);
j.at("storage_cell_delay_ns").get_to(o.m_Storage_cell_delay_ns);
if(j.find("internal_frame_generator") != j.end())
{
j.at("internal_frame_generator").get_to(o.m_Internal_frame_generator);
o.m_Internal_frame_generatorIsSet = true;
}
if(j.find("internal_frame_generator_images") != j.end())
{
j.at("internal_frame_generator_images").get_to(o.m_Internal_frame_generator_images);
o.m_Internal_frame_generator_imagesIsSet = true;
}
if(j.find("detector_trigger_delay_ns") != j.end())
{
j.at("detector_trigger_delay_ns").get_to(o.m_Detector_trigger_delay_ns);
o.m_Detector_trigger_delay_nsIsSet = true;
}
if(j.find("fixed_gain_g1") != j.end())
if(j.find("timing") != j.end())
{
j.at("fixed_gain_g1").get_to(o.m_Fixed_gain_g1);
o.m_Fixed_gain_g1IsSet = true;
j.at("timing").get_to(o.m_Timing);
o.m_TimingIsSet = true;
}
if(j.find("use_gain_hg0") != j.end())
if(j.find("eiger_threshold_keV") != j.end())
{
j.at("use_gain_hg0").get_to(o.m_Use_gain_hg0);
o.m_Use_gain_hg0IsSet = true;
j.at("eiger_threshold_keV").get_to(o.m_Eiger_threshold_keV);
o.m_Eiger_threshold_keVIsSet = true;
}
if(j.find("jungfrau_pedestal_g0_frames") != j.end())
{
j.at("jungfrau_pedestal_g0_frames").get_to(o.m_Jungfrau_pedestal_g0_frames);
o.m_Jungfrau_pedestal_g0_framesIsSet = true;
}
if(j.find("jungfrau_pedestal_g1_frames") != j.end())
{
j.at("jungfrau_pedestal_g1_frames").get_to(o.m_Jungfrau_pedestal_g1_frames);
o.m_Jungfrau_pedestal_g1_framesIsSet = true;
}
if(j.find("jungfrau_pedestal_g2_frames") != j.end())
{
j.at("jungfrau_pedestal_g2_frames").get_to(o.m_Jungfrau_pedestal_g2_frames);
o.m_Jungfrau_pedestal_g2_framesIsSet = true;
}
if(j.find("jungfrau_pedestal_g0_rms_limit") != j.end())
{
j.at("jungfrau_pedestal_g0_rms_limit").get_to(o.m_Jungfrau_pedestal_g0_rms_limit);
o.m_Jungfrau_pedestal_g0_rms_limitIsSet = true;
}
if(j.find("jungfrau_pedestal_min_image_count") != j.end())
{
j.at("jungfrau_pedestal_min_image_count").get_to(o.m_Jungfrau_pedestal_min_image_count);
o.m_Jungfrau_pedestal_min_image_countIsSet = true;
}
if(j.find("jungfrau_storage_cell_count") != j.end())
{
j.at("jungfrau_storage_cell_count").get_to(o.m_Jungfrau_storage_cell_count);
o.m_Jungfrau_storage_cell_countIsSet = true;
}
if(j.find("jungfrau_storage_cell_delay_ns") != j.end())
{
j.at("jungfrau_storage_cell_delay_ns").get_to(o.m_Jungfrau_storage_cell_delay_ns);
o.m_Jungfrau_storage_cell_delay_nsIsSet = true;
}
if(j.find("jungfrau_fixed_gain_g1") != j.end())
{
j.at("jungfrau_fixed_gain_g1").get_to(o.m_Jungfrau_fixed_gain_g1);
o.m_Jungfrau_fixed_gain_g1IsSet = true;
}
if(j.find("jungfrau_use_gain_hg0") != j.end())
{
j.at("jungfrau_use_gain_hg0").get_to(o.m_Jungfrau_use_gain_hg0);
o.m_Jungfrau_use_gain_hg0IsSet = true;
}
}
@@ -354,14 +450,6 @@ void Detector_settings::unsetCount_time_us()
{
m_Count_time_usIsSet = false;
}
int64_t Detector_settings::getStorageCellCount() const
{
return m_Storage_cell_count;
}
void Detector_settings::setStorageCellCount(int64_t const value)
{
m_Storage_cell_count = value;
}
bool Detector_settings::isInternalFrameGenerator() const
{
return m_Internal_frame_generator;
@@ -369,6 +457,15 @@ bool Detector_settings::isInternalFrameGenerator() const
void Detector_settings::setInternalFrameGenerator(bool const value)
{
m_Internal_frame_generator = value;
m_Internal_frame_generatorIsSet = true;
}
bool Detector_settings::internalFrameGeneratorIsSet() const
{
return m_Internal_frame_generatorIsSet;
}
void Detector_settings::unsetInternal_frame_generator()
{
m_Internal_frame_generatorIsSet = false;
}
int64_t Detector_settings::getInternalFrameGeneratorImages() const
{
@@ -377,54 +474,15 @@ int64_t Detector_settings::getInternalFrameGeneratorImages() const
void Detector_settings::setInternalFrameGeneratorImages(int64_t const value)
{
m_Internal_frame_generator_images = value;
m_Internal_frame_generator_imagesIsSet = true;
}
int64_t Detector_settings::getPedestalG0Frames() const
bool Detector_settings::internalFrameGeneratorImagesIsSet() const
{
return m_Pedestal_g0_frames;
return m_Internal_frame_generator_imagesIsSet;
}
void Detector_settings::setPedestalG0Frames(int64_t const value)
void Detector_settings::unsetInternal_frame_generator_images()
{
m_Pedestal_g0_frames = value;
}
int64_t Detector_settings::getPedestalG1Frames() const
{
return m_Pedestal_g1_frames;
}
void Detector_settings::setPedestalG1Frames(int64_t const value)
{
m_Pedestal_g1_frames = value;
}
int64_t Detector_settings::getPedestalG2Frames() const
{
return m_Pedestal_g2_frames;
}
void Detector_settings::setPedestalG2Frames(int64_t const value)
{
m_Pedestal_g2_frames = value;
}
int64_t Detector_settings::getPedestalG0RmsLimit() const
{
return m_Pedestal_g0_rms_limit;
}
void Detector_settings::setPedestalG0RmsLimit(int64_t const value)
{
m_Pedestal_g0_rms_limit = value;
}
int64_t Detector_settings::getPedestalMinImageCount() const
{
return m_Pedestal_min_image_count;
}
void Detector_settings::setPedestalMinImageCount(int64_t const value)
{
m_Pedestal_min_image_count = value;
}
int64_t Detector_settings::getStorageCellDelayNs() const
{
return m_Storage_cell_delay_ns;
}
void Detector_settings::setStorageCellDelayNs(int64_t const value)
{
m_Storage_cell_delay_ns = value;
m_Internal_frame_generator_imagesIsSet = false;
}
int64_t Detector_settings::getDetectorTriggerDelayNs() const
{
@@ -443,39 +501,192 @@ void Detector_settings::unsetDetector_trigger_delay_ns()
{
m_Detector_trigger_delay_nsIsSet = false;
}
bool Detector_settings::isFixedGainG1() const
org::openapitools::server::model::Detector_timing Detector_settings::getTiming() const
{
return m_Fixed_gain_g1;
return m_Timing;
}
void Detector_settings::setFixedGainG1(bool const value)
void Detector_settings::setTiming(org::openapitools::server::model::Detector_timing const& value)
{
m_Fixed_gain_g1 = value;
m_Fixed_gain_g1IsSet = true;
m_Timing = value;
m_TimingIsSet = true;
}
bool Detector_settings::fixedGainG1IsSet() const
bool Detector_settings::timingIsSet() const
{
return m_Fixed_gain_g1IsSet;
return m_TimingIsSet;
}
void Detector_settings::unsetFixed_gain_g1()
void Detector_settings::unsetTiming()
{
m_Fixed_gain_g1IsSet = false;
m_TimingIsSet = false;
}
bool Detector_settings::isUseGainHg0() const
float Detector_settings::getEigerThresholdKeV() const
{
return m_Use_gain_hg0;
return m_Eiger_threshold_keV;
}
void Detector_settings::setUseGainHg0(bool const value)
void Detector_settings::setEigerThresholdKeV(float const value)
{
m_Use_gain_hg0 = value;
m_Use_gain_hg0IsSet = true;
m_Eiger_threshold_keV = value;
m_Eiger_threshold_keVIsSet = true;
}
bool Detector_settings::useGainHg0IsSet() const
bool Detector_settings::eigerThresholdKeVIsSet() const
{
return m_Use_gain_hg0IsSet;
return m_Eiger_threshold_keVIsSet;
}
void Detector_settings::unsetUse_gain_hg0()
void Detector_settings::unsetEiger_threshold_keV()
{
m_Use_gain_hg0IsSet = false;
m_Eiger_threshold_keVIsSet = false;
}
int64_t Detector_settings::getJungfrauPedestalG0Frames() const
{
return m_Jungfrau_pedestal_g0_frames;
}
void Detector_settings::setJungfrauPedestalG0Frames(int64_t const value)
{
m_Jungfrau_pedestal_g0_frames = value;
m_Jungfrau_pedestal_g0_framesIsSet = true;
}
bool Detector_settings::jungfrauPedestalG0FramesIsSet() const
{
return m_Jungfrau_pedestal_g0_framesIsSet;
}
void Detector_settings::unsetJungfrau_pedestal_g0_frames()
{
m_Jungfrau_pedestal_g0_framesIsSet = false;
}
int64_t Detector_settings::getJungfrauPedestalG1Frames() const
{
return m_Jungfrau_pedestal_g1_frames;
}
void Detector_settings::setJungfrauPedestalG1Frames(int64_t const value)
{
m_Jungfrau_pedestal_g1_frames = value;
m_Jungfrau_pedestal_g1_framesIsSet = true;
}
bool Detector_settings::jungfrauPedestalG1FramesIsSet() const
{
return m_Jungfrau_pedestal_g1_framesIsSet;
}
void Detector_settings::unsetJungfrau_pedestal_g1_frames()
{
m_Jungfrau_pedestal_g1_framesIsSet = false;
}
int64_t Detector_settings::getJungfrauPedestalG2Frames() const
{
return m_Jungfrau_pedestal_g2_frames;
}
void Detector_settings::setJungfrauPedestalG2Frames(int64_t const value)
{
m_Jungfrau_pedestal_g2_frames = value;
m_Jungfrau_pedestal_g2_framesIsSet = true;
}
bool Detector_settings::jungfrauPedestalG2FramesIsSet() const
{
return m_Jungfrau_pedestal_g2_framesIsSet;
}
void Detector_settings::unsetJungfrau_pedestal_g2_frames()
{
m_Jungfrau_pedestal_g2_framesIsSet = false;
}
int64_t Detector_settings::getJungfrauPedestalG0RmsLimit() const
{
return m_Jungfrau_pedestal_g0_rms_limit;
}
void Detector_settings::setJungfrauPedestalG0RmsLimit(int64_t const value)
{
m_Jungfrau_pedestal_g0_rms_limit = value;
m_Jungfrau_pedestal_g0_rms_limitIsSet = true;
}
bool Detector_settings::jungfrauPedestalG0RmsLimitIsSet() const
{
return m_Jungfrau_pedestal_g0_rms_limitIsSet;
}
void Detector_settings::unsetJungfrau_pedestal_g0_rms_limit()
{
m_Jungfrau_pedestal_g0_rms_limitIsSet = false;
}
int64_t Detector_settings::getJungfrauPedestalMinImageCount() const
{
return m_Jungfrau_pedestal_min_image_count;
}
void Detector_settings::setJungfrauPedestalMinImageCount(int64_t const value)
{
m_Jungfrau_pedestal_min_image_count = value;
m_Jungfrau_pedestal_min_image_countIsSet = true;
}
bool Detector_settings::jungfrauPedestalMinImageCountIsSet() const
{
return m_Jungfrau_pedestal_min_image_countIsSet;
}
void Detector_settings::unsetJungfrau_pedestal_min_image_count()
{
m_Jungfrau_pedestal_min_image_countIsSet = false;
}
int64_t Detector_settings::getJungfrauStorageCellCount() const
{
return m_Jungfrau_storage_cell_count;
}
void Detector_settings::setJungfrauStorageCellCount(int64_t const value)
{
m_Jungfrau_storage_cell_count = value;
m_Jungfrau_storage_cell_countIsSet = true;
}
bool Detector_settings::jungfrauStorageCellCountIsSet() const
{
return m_Jungfrau_storage_cell_countIsSet;
}
void Detector_settings::unsetJungfrau_storage_cell_count()
{
m_Jungfrau_storage_cell_countIsSet = false;
}
int64_t Detector_settings::getJungfrauStorageCellDelayNs() const
{
return m_Jungfrau_storage_cell_delay_ns;
}
void Detector_settings::setJungfrauStorageCellDelayNs(int64_t const value)
{
m_Jungfrau_storage_cell_delay_ns = value;
m_Jungfrau_storage_cell_delay_nsIsSet = true;
}
bool Detector_settings::jungfrauStorageCellDelayNsIsSet() const
{
return m_Jungfrau_storage_cell_delay_nsIsSet;
}
void Detector_settings::unsetJungfrau_storage_cell_delay_ns()
{
m_Jungfrau_storage_cell_delay_nsIsSet = false;
}
bool Detector_settings::isJungfrauFixedGainG1() const
{
return m_Jungfrau_fixed_gain_g1;
}
void Detector_settings::setJungfrauFixedGainG1(bool const value)
{
m_Jungfrau_fixed_gain_g1 = value;
m_Jungfrau_fixed_gain_g1IsSet = true;
}
bool Detector_settings::jungfrauFixedGainG1IsSet() const
{
return m_Jungfrau_fixed_gain_g1IsSet;
}
void Detector_settings::unsetJungfrau_fixed_gain_g1()
{
m_Jungfrau_fixed_gain_g1IsSet = false;
}
bool Detector_settings::isJungfrauUseGainHg0() const
{
return m_Jungfrau_use_gain_hg0;
}
void Detector_settings::setJungfrauUseGainHg0(bool const value)
{
m_Jungfrau_use_gain_hg0 = value;
m_Jungfrau_use_gain_hg0IsSet = true;
}
bool Detector_settings::jungfrauUseGainHg0IsSet() const
{
return m_Jungfrau_use_gain_hg0IsSet;
}
void Detector_settings::unsetJungfrau_use_gain_hg0()
{
m_Jungfrau_use_gain_hg0IsSet = false;
}

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -19,6 +19,7 @@
#define Detector_settings_H_
#include "Detector_timing.h"
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
@@ -70,50 +71,19 @@ public:
bool countTimeUsIsSet() const;
void unsetCount_time_us();
/// <summary>
///
/// </summary>
int64_t getStorageCellCount() const;
void setStorageCellCount(int64_t const value);
/// <summary>
/// Use internal frame generator in FPGA instead of getting data from a real detector
/// </summary>
bool isInternalFrameGenerator() const;
void setInternalFrameGenerator(bool const value);
bool internalFrameGeneratorIsSet() const;
void unsetInternal_frame_generator();
/// <summary>
///
/// </summary>
int64_t getInternalFrameGeneratorImages() const;
void setInternalFrameGeneratorImages(int64_t const value);
/// <summary>
///
/// </summary>
int64_t getPedestalG0Frames() const;
void setPedestalG0Frames(int64_t const value);
/// <summary>
///
/// </summary>
int64_t getPedestalG1Frames() const;
void setPedestalG1Frames(int64_t const value);
/// <summary>
///
/// </summary>
int64_t getPedestalG2Frames() const;
void setPedestalG2Frames(int64_t const value);
/// <summary>
/// Pixels with pedestal G0 RMS above the threshold are marked as masked pixels
/// </summary>
int64_t getPedestalG0RmsLimit() const;
void setPedestalG0RmsLimit(int64_t const value);
/// <summary>
/// Minimum number of collected images for pedestal to consider it viable
/// </summary>
int64_t getPedestalMinImageCount() const;
void setPedestalMinImageCount(int64_t const value);
/// <summary>
/// Delay between two storage cells [ns]
/// </summary>
int64_t getStorageCellDelayNs() const;
void setStorageCellDelayNs(int64_t const value);
bool internalFrameGeneratorImagesIsSet() const;
void unsetInternal_frame_generator_images();
/// <summary>
/// Delay between TTL trigger and acquisition start [ns]
/// </summary>
@@ -122,19 +92,82 @@ public:
bool detectorTriggerDelayNsIsSet() const;
void unsetDetector_trigger_delay_ns();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Detector_timing getTiming() const;
void setTiming(org::openapitools::server::model::Detector_timing const& value);
bool timingIsSet() const;
void unsetTiming();
/// <summary>
///
/// </summary>
float getEigerThresholdKeV() const;
void setEigerThresholdKeV(float const value);
bool eigerThresholdKeVIsSet() const;
void unsetEiger_threshold_keV();
/// <summary>
///
/// </summary>
int64_t getJungfrauPedestalG0Frames() const;
void setJungfrauPedestalG0Frames(int64_t const value);
bool jungfrauPedestalG0FramesIsSet() const;
void unsetJungfrau_pedestal_g0_frames();
/// <summary>
///
/// </summary>
int64_t getJungfrauPedestalG1Frames() const;
void setJungfrauPedestalG1Frames(int64_t const value);
bool jungfrauPedestalG1FramesIsSet() const;
void unsetJungfrau_pedestal_g1_frames();
/// <summary>
///
/// </summary>
int64_t getJungfrauPedestalG2Frames() const;
void setJungfrauPedestalG2Frames(int64_t const value);
bool jungfrauPedestalG2FramesIsSet() const;
void unsetJungfrau_pedestal_g2_frames();
/// <summary>
/// Pixels with pedestal G0 RMS above the threshold are marked as masked pixels
/// </summary>
int64_t getJungfrauPedestalG0RmsLimit() const;
void setJungfrauPedestalG0RmsLimit(int64_t const value);
bool jungfrauPedestalG0RmsLimitIsSet() const;
void unsetJungfrau_pedestal_g0_rms_limit();
/// <summary>
/// Minimum number of collected images for pedestal to consider it viable
/// </summary>
int64_t getJungfrauPedestalMinImageCount() const;
void setJungfrauPedestalMinImageCount(int64_t const value);
bool jungfrauPedestalMinImageCountIsSet() const;
void unsetJungfrau_pedestal_min_image_count();
/// <summary>
///
/// </summary>
int64_t getJungfrauStorageCellCount() const;
void setJungfrauStorageCellCount(int64_t const value);
bool jungfrauStorageCellCountIsSet() const;
void unsetJungfrau_storage_cell_count();
/// <summary>
/// Delay between two storage cells [ns]
/// </summary>
int64_t getJungfrauStorageCellDelayNs() const;
void setJungfrauStorageCellDelayNs(int64_t const value);
bool jungfrauStorageCellDelayNsIsSet() const;
void unsetJungfrau_storage_cell_delay_ns();
/// <summary>
/// Fix gain to G1 (can be useful for storage cells)
/// </summary>
bool isFixedGainG1() const;
void setFixedGainG1(bool const value);
bool fixedGainG1IsSet() const;
void unsetFixed_gain_g1();
bool isJungfrauFixedGainG1() const;
void setJungfrauFixedGainG1(bool const value);
bool jungfrauFixedGainG1IsSet() const;
void unsetJungfrau_fixed_gain_g1();
/// <summary>
/// Use high G0 (for low energy applications)
/// </summary>
bool isUseGainHg0() const;
void setUseGainHg0(bool const value);
bool useGainHg0IsSet() const;
void unsetUse_gain_hg0();
bool isJungfrauUseGainHg0() const;
void setJungfrauUseGainHg0(bool const value);
bool jungfrauUseGainHg0IsSet() const;
void unsetJungfrau_use_gain_hg0();
friend void to_json(nlohmann::json& j, const Detector_settings& o);
friend void from_json(const nlohmann::json& j, Detector_settings& o);
@@ -143,30 +176,34 @@ protected:
int64_t m_Count_time_us;
bool m_Count_time_usIsSet;
int64_t m_Storage_cell_count;
bool m_Internal_frame_generator;
bool m_Internal_frame_generatorIsSet;
int64_t m_Internal_frame_generator_images;
int64_t m_Pedestal_g0_frames;
int64_t m_Pedestal_g1_frames;
int64_t m_Pedestal_g2_frames;
int64_t m_Pedestal_g0_rms_limit;
int64_t m_Pedestal_min_image_count;
int64_t m_Storage_cell_delay_ns;
bool m_Internal_frame_generator_imagesIsSet;
int64_t m_Detector_trigger_delay_ns;
bool m_Detector_trigger_delay_nsIsSet;
bool m_Fixed_gain_g1;
bool m_Fixed_gain_g1IsSet;
bool m_Use_gain_hg0;
bool m_Use_gain_hg0IsSet;
org::openapitools::server::model::Detector_timing m_Timing;
bool m_TimingIsSet;
float m_Eiger_threshold_keV;
bool m_Eiger_threshold_keVIsSet;
int64_t m_Jungfrau_pedestal_g0_frames;
bool m_Jungfrau_pedestal_g0_framesIsSet;
int64_t m_Jungfrau_pedestal_g1_frames;
bool m_Jungfrau_pedestal_g1_framesIsSet;
int64_t m_Jungfrau_pedestal_g2_frames;
bool m_Jungfrau_pedestal_g2_framesIsSet;
int64_t m_Jungfrau_pedestal_g0_rms_limit;
bool m_Jungfrau_pedestal_g0_rms_limitIsSet;
int64_t m_Jungfrau_pedestal_min_image_count;
bool m_Jungfrau_pedestal_min_image_countIsSet;
int64_t m_Jungfrau_storage_cell_count;
bool m_Jungfrau_storage_cell_countIsSet;
int64_t m_Jungfrau_storage_cell_delay_ns;
bool m_Jungfrau_storage_cell_delay_nsIsSet;
bool m_Jungfrau_fixed_gain_g1;
bool m_Jungfrau_fixed_gain_g1IsSet;
bool m_Jungfrau_use_gain_hg0;
bool m_Jungfrau_use_gain_hg0IsSet;
};

View File

@@ -0,0 +1,134 @@
/**
* Jungfraujoch
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
#include "Detector_state.h"
#include "Helpers.h"
#include <stdexcept>
#include <sstream>
namespace org::openapitools::server::model
{
Detector_state::Detector_state()
{
}
void Detector_state::validate() const
{
std::stringstream msg;
if (!validate(msg))
{
throw org::openapitools::server::helpers::ValidationException(msg.str());
}
}
bool Detector_state::validate(std::stringstream& msg) const
{
return validate(msg, "");
}
bool Detector_state::validate(std::stringstream& msg, const std::string& pathPrefix) const
{
bool success = true;
const std::string _pathPrefix = pathPrefix.empty() ? "Detector_state" : pathPrefix;
if (m_value == Detector_state::eDetector_state::INVALID_VALUE_OPENAPI_GENERATED)
{
success = false;
msg << _pathPrefix << ": has no value;";
}
return success;
}
bool Detector_state::operator==(const Detector_state& rhs) const
{
return
getValue() == rhs.getValue()
;
}
bool Detector_state::operator!=(const Detector_state& rhs) const
{
return !(*this == rhs);
}
void to_json(nlohmann::json& j, const Detector_state& o)
{
j = nlohmann::json::object();
switch (o.getValue())
{
case Detector_state::eDetector_state::INVALID_VALUE_OPENAPI_GENERATED:
j = "INVALID_VALUE_OPENAPI_GENERATED";
break;
case Detector_state::eDetector_state::IDLE:
j = "Idle";
break;
case Detector_state::eDetector_state::WAITING:
j = "Waiting";
break;
case Detector_state::eDetector_state::BUSY:
j = "Busy";
break;
case Detector_state::eDetector_state::ERROR:
j = "Error";
break;
case Detector_state::eDetector_state::NOT_CONNECTED:
j = "Not connected";
break;
}
}
void from_json(const nlohmann::json& j, Detector_state& o)
{
auto s = j.get<std::string>();
if (s == "Idle") {
o.setValue(Detector_state::eDetector_state::IDLE);
}
else if (s == "Waiting") {
o.setValue(Detector_state::eDetector_state::WAITING);
}
else if (s == "Busy") {
o.setValue(Detector_state::eDetector_state::BUSY);
}
else if (s == "Error") {
o.setValue(Detector_state::eDetector_state::ERROR);
}
else if (s == "Not connected") {
o.setValue(Detector_state::eDetector_state::NOT_CONNECTED);
} else {
std::stringstream ss;
ss << "Unexpected value " << s << " in json"
<< " cannot be converted to enum of type"
<< " Detector_state::eDetector_state";
throw std::invalid_argument(ss.str());
}
}
Detector_state::eDetector_state Detector_state::getValue() const
{
return m_value;
}
void Detector_state::setValue(Detector_state::eDetector_state value)
{
m_value = value;
}
} // namespace org::openapitools::server::model

View File

@@ -0,0 +1,82 @@
/**
* Jungfraujoch
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/*
* Detector_state.h
*
* Current state of the detector
*/
#ifndef Detector_state_H_
#define Detector_state_H_
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
/// Current state of the detector
/// </summary>
class Detector_state
{
public:
Detector_state();
virtual ~Detector_state() = default;
enum class eDetector_state {
// To have a valid default value.
// Avoiding name clashes with user defined
// enum values
INVALID_VALUE_OPENAPI_GENERATED = 0,
IDLE,
WAITING,
BUSY,
ERROR,
NOT_CONNECTED
};
/// <summary>
/// Validate the current data in the model. Throws a ValidationException on failure.
/// </summary>
void validate() const;
/// <summary>
/// Validate the current data in the model. Returns false on error and writes an error
/// message into the given stringstream.
/// </summary>
bool validate(std::stringstream& msg) const;
/// <summary>
/// Helper overload for validate. Used when one model stores another model and calls it's validate.
/// Not meant to be called outside that case.
/// </summary>
bool validate(std::stringstream& msg, const std::string& pathPrefix) const;
bool operator==(const Detector_state& rhs) const;
bool operator!=(const Detector_state& rhs) const;
/////////////////////////////////////////////
/// Detector_state members
Detector_state::eDetector_state getValue() const;
void setValue(Detector_state::eDetector_state value);
friend void to_json(nlohmann::json& j, const Detector_state& o);
friend void from_json(const nlohmann::json& j, Detector_state& o);
protected:
Detector_state::eDetector_state m_value = Detector_state::eDetector_state::INVALID_VALUE_OPENAPI_GENERATED;
};
} // namespace org::openapitools::server::model
#endif /* Detector_state_H_ */

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,8 +21,6 @@ namespace org::openapitools::server::model
Detector_status::Detector_status()
{
m_State = "";
m_Powerchip = "";
m_Server_version = "";
m_Number_of_triggers_left = 0L;
@@ -147,19 +145,19 @@ void from_json(const nlohmann::json& j, Detector_status& o)
}
std::string Detector_status::getState() const
org::openapitools::server::model::Detector_state Detector_status::getState() const
{
return m_State;
}
void Detector_status::setState(std::string const& value)
void Detector_status::setState(org::openapitools::server::model::Detector_state const& value)
{
m_State = value;
}
std::string Detector_status::getPowerchip() const
org::openapitools::server::model::Detector_power_state Detector_status::getPowerchip() const
{
return m_Powerchip;
}
void Detector_status::setPowerchip(std::string const& value)
void Detector_status::setPowerchip(org::openapitools::server::model::Detector_power_state const& value)
{
m_Powerchip = value;
}

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -19,7 +19,9 @@
#define Detector_status_H_
#include "Detector_state.h"
#include <string>
#include "Detector_power_state.h"
#include <vector>
#include <nlohmann/json.hpp>
@@ -60,15 +62,15 @@ public:
/// Detector_status members
/// <summary>
/// Current state of the detector
///
/// </summary>
std::string getState() const;
void setState(std::string const& value);
org::openapitools::server::model::Detector_state getState() const;
void setState(org::openapitools::server::model::Detector_state const& value);
/// <summary>
/// Power on of ASICs
///
/// </summary>
std::string getPowerchip() const;
void setPowerchip(std::string const& value);
org::openapitools::server::model::Detector_power_state getPowerchip() const;
void setPowerchip(org::openapitools::server::model::Detector_power_state const& value);
/// <summary>
/// Detector server (on read-out boards) version
/// </summary>
@@ -93,9 +95,9 @@ public:
friend void to_json(nlohmann::json& j, const Detector_status& o);
friend void from_json(const nlohmann::json& j, Detector_status& o);
protected:
std::string m_State;
org::openapitools::server::model::Detector_state m_State;
std::string m_Powerchip;
org::openapitools::server::model::Detector_power_state m_Powerchip;
std::string m_Server_version;

View File

@@ -0,0 +1,128 @@
/**
* Jungfraujoch
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
#include "Detector_timing.h"
#include "Helpers.h"
#include <stdexcept>
#include <sstream>
namespace org::openapitools::server::model
{
Detector_timing::Detector_timing()
{
}
void Detector_timing::validate() const
{
std::stringstream msg;
if (!validate(msg))
{
throw org::openapitools::server::helpers::ValidationException(msg.str());
}
}
bool Detector_timing::validate(std::stringstream& msg) const
{
return validate(msg, "");
}
bool Detector_timing::validate(std::stringstream& msg, const std::string& pathPrefix) const
{
bool success = true;
const std::string _pathPrefix = pathPrefix.empty() ? "Detector_timing" : pathPrefix;
if (m_value == Detector_timing::eDetector_timing::INVALID_VALUE_OPENAPI_GENERATED)
{
success = false;
msg << _pathPrefix << ": has no value;";
}
return success;
}
bool Detector_timing::operator==(const Detector_timing& rhs) const
{
return
getValue() == rhs.getValue()
;
}
bool Detector_timing::operator!=(const Detector_timing& rhs) const
{
return !(*this == rhs);
}
void to_json(nlohmann::json& j, const Detector_timing& o)
{
j = nlohmann::json::object();
switch (o.getValue())
{
case Detector_timing::eDetector_timing::INVALID_VALUE_OPENAPI_GENERATED:
j = "INVALID_VALUE_OPENAPI_GENERATED";
break;
case Detector_timing::eDetector_timing::AUTO:
j = "auto";
break;
case Detector_timing::eDetector_timing::TRIGGER:
j = "trigger";
break;
case Detector_timing::eDetector_timing::BURST:
j = "burst";
break;
case Detector_timing::eDetector_timing::GATED:
j = "gated";
break;
}
}
void from_json(const nlohmann::json& j, Detector_timing& o)
{
auto s = j.get<std::string>();
if (s == "auto") {
o.setValue(Detector_timing::eDetector_timing::AUTO);
}
else if (s == "trigger") {
o.setValue(Detector_timing::eDetector_timing::TRIGGER);
}
else if (s == "burst") {
o.setValue(Detector_timing::eDetector_timing::BURST);
}
else if (s == "gated") {
o.setValue(Detector_timing::eDetector_timing::GATED);
} else {
std::stringstream ss;
ss << "Unexpected value " << s << " in json"
<< " cannot be converted to enum of type"
<< " Detector_timing::eDetector_timing";
throw std::invalid_argument(ss.str());
}
}
Detector_timing::eDetector_timing Detector_timing::getValue() const
{
return m_value;
}
void Detector_timing::setValue(Detector_timing::eDetector_timing value)
{
m_value = value;
}
} // namespace org::openapitools::server::model

View File

@@ -0,0 +1,81 @@
/**
* Jungfraujoch
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/*
* Detector_timing.h
*
*
*/
#ifndef Detector_timing_H_
#define Detector_timing_H_
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
///
/// </summary>
class Detector_timing
{
public:
Detector_timing();
virtual ~Detector_timing() = default;
enum class eDetector_timing {
// To have a valid default value.
// Avoiding name clashes with user defined
// enum values
INVALID_VALUE_OPENAPI_GENERATED = 0,
AUTO,
TRIGGER,
BURST,
GATED
};
/// <summary>
/// Validate the current data in the model. Throws a ValidationException on failure.
/// </summary>
void validate() const;
/// <summary>
/// Validate the current data in the model. Returns false on error and writes an error
/// message into the given stringstream.
/// </summary>
bool validate(std::stringstream& msg) const;
/// <summary>
/// Helper overload for validate. Used when one model stores another model and calls it's validate.
/// Not meant to be called outside that case.
/// </summary>
bool validate(std::stringstream& msg, const std::string& pathPrefix) const;
bool operator==(const Detector_timing& rhs) const;
bool operator!=(const Detector_timing& rhs) const;
/////////////////////////////////////////////
/// Detector_timing members
Detector_timing::eDetector_timing getValue() const;
void setValue(Detector_timing::eDetector_timing value);
friend void to_json(nlohmann::json& j, const Detector_timing& o);
friend void from_json(const nlohmann::json& j, Detector_timing& o);
protected:
Detector_timing::eDetector_timing m_value = Detector_timing::eDetector_timing::INVALID_VALUE_OPENAPI_GENERATED;
};
} // namespace org::openapitools::server::model
#endif /* Detector_timing_H_ */

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -110,11 +110,6 @@ bool Jfjoch_settings::validate(std::stringstream& msg, const std::string& pathPr
success = false;
msg << currentValuePath << ": must be greater than or equal to 128;";
}
if (value > 16384)
{
success = false;
msg << currentValuePath << ": must be less than or equal to 16384;";
}
}

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,6 +23,8 @@ Zeromq_settings::Zeromq_settings()
{
m_Send_watermark = 100L;
m_Send_watermarkIsSet = false;
m_Send_buffer_size = 0L;
m_Send_buffer_sizeIsSet = false;
m_Image_socketIsSet = false;
m_Preview_socket = "";
m_Preview_socketIsSet = false;
@@ -69,7 +71,7 @@ bool Zeromq_settings::validate(std::stringstream& msg, const std::string& pathPr
}
}
if (imageSocketIsSet())
{
const std::vector<std::string>& value = m_Image_socket;
@@ -103,6 +105,9 @@ bool Zeromq_settings::operator==(const Zeromq_settings& rhs) const
((!sendWatermarkIsSet() && !rhs.sendWatermarkIsSet()) || (sendWatermarkIsSet() && rhs.sendWatermarkIsSet() && getSendWatermark() == rhs.getSendWatermark())) &&
((!sendBufferSizeIsSet() && !rhs.sendBufferSizeIsSet()) || (sendBufferSizeIsSet() && rhs.sendBufferSizeIsSet() && getSendBufferSize() == rhs.getSendBufferSize())) &&
((!imageSocketIsSet() && !rhs.imageSocketIsSet()) || (imageSocketIsSet() && rhs.imageSocketIsSet() && getImageSocket() == rhs.getImageSocket())) &&
@@ -124,6 +129,8 @@ void to_json(nlohmann::json& j, const Zeromq_settings& o)
j = nlohmann::json::object();
if(o.sendWatermarkIsSet())
j["send_watermark"] = o.m_Send_watermark;
if(o.sendBufferSizeIsSet())
j["send_buffer_size"] = o.m_Send_buffer_size;
if(o.imageSocketIsSet() || !o.m_Image_socket.empty())
j["image_socket"] = o.m_Image_socket;
if(o.previewSocketIsSet())
@@ -140,6 +147,11 @@ void from_json(const nlohmann::json& j, Zeromq_settings& o)
j.at("send_watermark").get_to(o.m_Send_watermark);
o.m_Send_watermarkIsSet = true;
}
if(j.find("send_buffer_size") != j.end())
{
j.at("send_buffer_size").get_to(o.m_Send_buffer_size);
o.m_Send_buffer_sizeIsSet = true;
}
if(j.find("image_socket") != j.end())
{
j.at("image_socket").get_to(o.m_Image_socket);
@@ -175,6 +187,23 @@ void Zeromq_settings::unsetSend_watermark()
{
m_Send_watermarkIsSet = false;
}
int64_t Zeromq_settings::getSendBufferSize() const
{
return m_Send_buffer_size;
}
void Zeromq_settings::setSendBufferSize(int64_t const value)
{
m_Send_buffer_size = value;
m_Send_buffer_sizeIsSet = true;
}
bool Zeromq_settings::sendBufferSizeIsSet() const
{
return m_Send_buffer_sizeIsSet;
}
void Zeromq_settings::unsetSend_buffer_size()
{
m_Send_buffer_sizeIsSet = false;
}
std::vector<std::string> Zeromq_settings::getImageSocket() const
{
return m_Image_socket;

View File

@@ -1,8 +1,8 @@
/**
* Jungfraujoch
* Jungfraujoch Broker Web API
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.15
* The version of the OpenAPI document: 1.0.0-rc.16
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -67,6 +67,13 @@ public:
bool sendWatermarkIsSet() const;
void unsetSend_watermark();
/// <summary>
/// Send buffer size for ZeroMQ socket
/// </summary>
int64_t getSendBufferSize() const;
void setSendBufferSize(int64_t const value);
bool sendBufferSizeIsSet() const;
void unsetSend_buffer_size();
/// <summary>
/// PUSH ZeroMQ socket for images. In case multiple sockets are provided, images are streamed over multiple sockets. Images are serialized using CBOR. Address follows ZeroMQ convention for sockets - in practice ipc://&lt;socket file&gt; and tpc://&lt;IP address&gt;:&lt;port&gt; sockets are OK. 0.0.0.0 instead of IP address is accepted and means listening on all network interfaces.
/// </summary>
std::vector<std::string> getImageSocket() const;
@@ -93,6 +100,8 @@ public:
protected:
int64_t m_Send_watermark;
bool m_Send_watermarkIsSet;
int64_t m_Send_buffer_size;
bool m_Send_buffer_sizeIsSet;
std::vector<std::string> m_Image_socket;
bool m_Image_socketIsSet;
std::string m_Preview_socket;

View File

@@ -1,10 +1,17 @@
openapi: 3.0.3
info:
title: Jungfraujoch
description: Jungfraujoch Broker Web API
version: 1.0.0-rc.15
description: |
API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland).
Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU.
Jungfraujoch uses FPGA boards to acquire data at high data rates.
version: 1.0.0-rc.16
contact:
name: Filip Leonarski (Paul Scherrer Institute)
email: filip.leonarski@psi.ch
servers:
- url: http://localhost:5232
description: Test Jungfraujoch system
components:
schemas:
rotation_axis:
@@ -308,6 +315,14 @@ components:
default: true
description: |
Mask multipixels on chip boundary
detector_power_state:
type: string
description: Power on of ASICs
enum: [ "PowerOn", "PowerOff", "Partial" ]
detector_state:
type: string
description: Current state of the detector
enum: [ "Idle", "Waiting", "Busy", "Error", "Not connected"]
detector_status:
type: object
required:
@@ -319,13 +334,9 @@ components:
- high_voltage_V
properties:
state:
type: string
description: Current state of the detector
enum: ["Idle", "Waiting", "Busy", "Error"]
$ref: '#/components/schemas/detector_state'
powerchip:
type: string
description: Power on of ASICs
enum: ["PowerOn", "PowerOff", "Partial"]
$ref: '#/components/schemas/detector_power_state'
server_version:
type: string
description: Detector server (on read-out boards) version
@@ -345,19 +356,14 @@ components:
items:
type: integer
format: int64
detector_timing:
type: string
enum: [auto, trigger, burst, gated]
default: trigger
detector_settings:
type: object
required:
- frame_time_us
- storage_cell_count
- storage_cell_delay_ns
- internal_frame_generator
- internal_frame_generator_images
- pedestal_g0_frames
- pedestal_g1_frames
- pedestal_g2_frames
- pedestal_g0_rms_limit
- pedestal_min_image_count
properties:
frame_time_us:
type: integer
@@ -368,12 +374,6 @@ components:
type: integer
description: Integration time of the detector. If not provided count time will be set to maximum value for a given frame time.
format: int64
storage_cell_count:
type: integer
format: int64
default: 1
minimum: 1
maximum: 16
internal_frame_generator:
type: boolean
default: false
@@ -384,50 +384,63 @@ components:
default: 1
minimum: 1
maximum: 128
pedestal_g0_frames:
type: integer
format: int64
default: 2000
minimum: 0
pedestal_g1_frames:
type: integer
format: int64
default: 300
minimum: 0
pedestal_g2_frames:
type: integer
format: int64
default: 300
minimum: 0
pedestal_g0_rms_limit:
type: integer
format: int64
default: 100
minimum: 0
description: Pixels with pedestal G0 RMS above the threshold are marked as masked pixels
pedestal_min_image_count:
type: integer
format: int64
default: 128
minimum: 32
description: Minimum number of collected images for pedestal to consider it viable
storage_cell_delay_ns:
type: integer
format: int64
minimum: 2100
default: 5000
description: Delay between two storage cells [ns]
detector_trigger_delay_ns:
type: integer
format: int64
minimum: 0
default: 0
description: Delay between TTL trigger and acquisition start [ns]
fixed_gain_g1:
timing:
$ref: '#/components/schemas/detector_timing'
eiger_threshold_keV:
type: number
format: float
minimum: 1.0
maximum: 100.0
jungfrau_pedestal_g0_frames:
type: integer
format: int64
default: 2000
minimum: 0
jungfrau_pedestal_g1_frames:
type: integer
format: int64
default: 300
minimum: 0
jungfrau_pedestal_g2_frames:
type: integer
format: int64
default: 300
minimum: 0
jungfrau_pedestal_g0_rms_limit:
type: integer
format: int64
default: 100
minimum: 0
description: Pixels with pedestal G0 RMS above the threshold are marked as masked pixels
jungfrau_pedestal_min_image_count:
type: integer
format: int64
default: 128
minimum: 32
description: Minimum number of collected images for pedestal to consider it viable
jungfrau_storage_cell_count:
type: integer
format: int64
default: 1
minimum: 1
maximum: 16
jungfrau_storage_cell_delay_ns:
type: integer
format: int64
minimum: 2100
default: 5000
description: Delay between two storage cells [ns]
jungfrau_fixed_gain_g1:
type: boolean
default: false
description: Fix gain to G1 (can be useful for storage cells)
use_gain_hg0:
jungfrau_use_gain_hg0:
type: boolean
default: false
description: Use high G0 (for low energy applications)
@@ -1090,6 +1103,10 @@ components:
maximum: 16384
default: 100
description: Watermark for ZeroMQ send queue (number of outstanding messages queued on Jungfraujoch server per queue)
send_buffer_size:
type: integer
format: int64
description: Send buffer size for ZeroMQ socket
image_socket:
type: array
items:
@@ -1163,7 +1180,6 @@ components:
image_buffer_MiB:
type: integer
minimum: 128
maximum: 16384
default: 2048
description: Size of internal buffer in MiB for images before they are sent to a stream
receiver_threads:

File diff suppressed because one or more lines are too long

View File

@@ -171,3 +171,34 @@ DetectorSettings &DetectorSettings::PedestalMinImageCount(uint32_t input) {
pedestal_min_image_count = input;
return *this;
}
std::optional<float> DetectorSettings::GetEIGERThreshold_keV() const {
return eiger_threshold_keV;
}
DetectorSettings &DetectorSettings::EigerThreshold_keV(const std::optional<float> &input) {
check_min("EIGER Threshold (keV)", input, 1.0);
check_max("EIGER Threshold (keV)", input, 100.0);
eiger_threshold_keV = input;
return *this;
}
DetectorSettings &DetectorSettings::Timing(DetectorTiming input) {
switch(input) {
case DetectorTiming::Auto:
case DetectorTiming::Trigger:
case DetectorTiming::Burst:
case DetectorTiming::Gated:
timing = input;
break;
default:
// Handle invalid input, e.g., throw an exception, log an error, set a default value, etc.
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
"Invalid DetectorTiming value");
}
return *this;
}
DetectorTiming DetectorSettings::GetTiming() const {
return timing;
}

View File

@@ -9,6 +9,8 @@
#include "../common/Definitions.h"
enum class DetectorTiming {Auto, Trigger, Burst, Gated};
class DetectorSettings {
bool internal_fpga_packet_generator = false;
int64_t internal_fpga_packet_generator_images = 1;
@@ -26,6 +28,10 @@ class DetectorSettings {
std::optional<std::chrono::microseconds> count_time;
float pedestal_g0_rms_limit = UINT16_MAX;
int64_t pedestal_min_image_count = PEDESTAL_MIN_IMAGE_COUNT;
std::optional<float> eiger_threshold_keV;
DetectorTiming timing = DetectorTiming::Trigger;
public:
DetectorSettings& InternalGeneratorEnable(bool input);
DetectorSettings& InternalGeneratorImages(int64_t input);
@@ -45,7 +51,9 @@ public:
const std::optional<std::chrono::microseconds> &count_time);
DetectorSettings& PedestalG0RMSLimit(float value);
DetectorSettings& PedestalMinImageCount(uint32_t input);
DetectorSettings& EigerThreshold_keV(const std::optional<float> &input);
DetectorSettings& Timing(DetectorTiming input);
[[nodiscard]] bool IsInternalGeneratorEnable() const;
[[nodiscard]] int64_t GetInternalGeneratorImages() const;
[[nodiscard]] int64_t GetStorageCells() const;
@@ -61,6 +69,8 @@ public:
[[nodiscard]] std::optional<std::chrono::microseconds> GetCountTime() const;
[[nodiscard]] float GetPedestalG0RMSLimit() const;
[[nodiscard]] uint32_t GetPedestalMinImageCount() const;
[[nodiscard]] std::optional<float> GetEIGERThreshold_keV() const;
[[nodiscard]] DetectorTiming GetTiming() const;
};

View File

@@ -149,7 +149,7 @@ DiffractionExperiment &DiffractionExperiment::MaskChipEdges(bool input) {
}
DiffractionExperiment& DiffractionExperiment::LowResForAzimInt_A(float input) {
radial_integration_settings.LowQ_recipA(2 * static_cast<float>(M_PI) / input);
radial_integration_settings.LowQ_recipA(2 * static_cast<float>(M_PI) / input);
return *this;
}
@@ -364,7 +364,7 @@ int64_t DiffractionExperiment::GetDataStreamsNum() const {
}
int64_t DiffractionExperiment::GetModulesNum(uint16_t data_stream) const {
if (data_stream >= GetDataStreamsNum())
if (data_stream >= GetDataStreamsNum())
throw JFJochException(JFJochExceptionCategory::ArrayOutOfBounds, "Non existing data stream");
return (detector.GetModulesNum() + (GetDataStreamsNum() - 1) - data_stream) / GetDataStreamsNum();
@@ -1012,7 +1012,7 @@ InstrumentMetadata DiffractionExperiment::GetInstrumentMetadata() const {
}
bool DiffractionExperiment::IsGeometryTransformed() const {
return image_format_settings.IsGeometryTransformed();
return image_format_settings.IsGeometryTransformed();
}
DiffractionExperiment &DiffractionExperiment::GeometryTransformation(bool input) {
@@ -1086,6 +1086,13 @@ void DiffractionExperiment::Raw() {
}
DiffractionExperiment &DiffractionExperiment::ImportDetectorSettings(const DetectorSettings &input) {
auto det_type = detector.GetDetectorType();
if (det_type == DetectorType::JUNGFRAU) {
if ((input.GetTiming() == DetectorTiming::Burst) ||
(input.GetTiming() == DetectorTiming::Gated))
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
"Burst and gated timing modes not supported in JUNGFRAU");
}
detector_settings = input;
return *this;
}
@@ -1133,3 +1140,11 @@ float DiffractionExperiment::GetPedestalG0RMSLimit() const {
uint32_t DiffractionExperiment::GetPedestalMinImageCount() const {
return detector_settings.GetPedestalMinImageCount();
}
std::optional<float> DiffractionExperiment::GetEIGERThreshold_keV() const {
return detector_settings.GetEIGERThreshold_keV();
}
DetectorTiming DiffractionExperiment::GetDetectorTiming() const {
return detector_settings.GetTiming();
}

View File

@@ -318,6 +318,8 @@ public:
float GetPedestalG0RMSLimit() const;
uint32_t GetPedestalMinImageCount() const;
std::optional<float> GetEIGERThreshold_keV() const;
DetectorTiming GetDetectorTiming() const;
};
#endif //DIFFRACTIONEXPERIMENT_H

View File

@@ -113,11 +113,11 @@ void DetectorWrapper::Initialize(const DiffractionExperiment& experiment,
det.loadTrimbits(trim_files[2 * i + 1], {2 * i + 1});
}
}
det.setTimingMode(slsDetectorDefs::timingMode::BURST_TRIGGER);
auto energy_threshold = experiment.GetEIGERThreshold_keV();
if (energy_threshold.has_value())
det.setThresholdEnergy(std::lround(energy_threshold.value() * 1000.0));
}
if (det_type == DetectorType::JUNGFRAU) {
auto tx_delay = experiment.GetDetectorSetup().GetTxDelay();
if (tx_delay.size() == experiment.GetModulesNum()) {
@@ -140,6 +140,27 @@ void DetectorWrapper::Initialize(const DiffractionExperiment& experiment,
}
}
switch (experiment.GetDetectorTiming()) {
case DetectorTiming::Auto:
det.setTimingMode(slsDetectorDefs::timingMode::AUTO_TIMING);
break;
case DetectorTiming::Trigger:
det.setTimingMode(slsDetectorDefs::timingMode::TRIGGER_EXPOSURE);
break;
case DetectorTiming::Burst:
if (det_type == DetectorType::JUNGFRAU)
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
"Burst timing mode not supported with JUNGFRAU");
det.setTimingMode(slsDetectorDefs::timingMode::BURST_TRIGGER);
break;
case DetectorTiming::Gated:
if (det_type == DetectorType::JUNGFRAU)
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
"Gated timing mode not supported with JUNGFRAU");
det.setTimingMode(slsDetectorDefs::timingMode::GATED);
break;
}
det.setHighVoltage(experiment.GetDetectorSetup().GetHighVoltage());
} catch (const std::exception &e) {
logger.ErrorException(e);
@@ -159,7 +180,13 @@ void DetectorWrapper::Start(const DiffractionExperiment& experiment) {
if (det.size() != 2 * experiment.GetModulesNum())
throw JFJochException(JFJochExceptionCategory::Detector,
"Discrepancy in module number between DAQ and detector");
// det.setThresholdEnergy(std::lround(experiment.GetPhotonEnergy_keV() * 1000.0/ 2.0));
auto energy_threshold = experiment.GetEIGERThreshold_keV();
if (!experiment.GetEIGERThreshold_keV().has_value()) {
int expected_threshold = std::lround(experiment.GetPhotonEnergy_keV() * 1000.0 / 2.0);
if (det.getThresholdEnergy().squash(0) != expected_threshold)
det.setThresholdEnergy(expected_threshold);
}
}
try {
@@ -240,6 +267,8 @@ void DetectorWrapper::Trigger() {
}
DetectorState DetectorWrapper::GetState() const {
if (det.empty())
return DetectorState::NOT_CONNECTED;
try {
bool is_idle = true;
bool is_waiting = true;
@@ -333,7 +362,15 @@ std::vector<int64_t> DetectorWrapper::GetHighVoltage() const {
}
DetectorStatus DetectorWrapper::GetStatus() const {
DetectorStatus status;
DetectorStatus status{};
if (det.empty())
return DetectorStatus{
.detector_state = DetectorState::NOT_CONNECTED,
.power_state = DetectorPowerState::OFF,
.detector_server_version = "N/A"
};
status.detector_server_version = GetDetectorServerVersion();
status.detector_state = GetState();
if (det_type == DetectorType::JUNGFRAU) {

View File

@@ -10,7 +10,7 @@
#define BASE_DETECTOR_MAC 0xAABBCCDDEE10 // little-endian!
#define THRESHOLD_TEMPERATURE_DEGC 55
enum class DetectorState {IDLE, ERROR, BUSY, WAITING};
enum class DetectorState {IDLE, ERROR, BUSY, WAITING, NOT_CONNECTED};
enum class DetectorPowerState {ON, OFF, PARTIAL};
struct DetectorStatus {

View File

@@ -1,70 +0,0 @@
# Installation of new U55C card for Jungfraujoch
1. Install the `xbflash2` tool from Xilinx, which allows to flash the firmware through PCIe connector.
It can be downloaded as RPM/DEB file from [Alveo product page](https://www.xilinx.com/products/boards-and-kits/alveo/u55c.html#xbflash2). For RHEL9 this needs to built from source - [Xilinx/XRT github repository](https://github.com/Xilinx/XRT).
2. Check that the card is detected by OS with "lspci |grep Xilinx" and check the PCIe slot number (`11:00.0` in this case):
```
$ lspci |grep Xilinx
23:00.0 Processing accelerators: Xilinx Corporation Device 3450 (rev 58)
```
Note the device number `3450` that identifies Jungfraujoch device (Jungfraujoch pass is 3450 m above sea level) and `rev 58` identifying release of the firmware.
3. Check the speed of the card, that it is detected as PCIe Gen4x8 device (needs to be done as root, otherwise configuration details are not given):
```
$ sudo lspci -vv -s <PCIe slot number>
23:00.0 Processing accelerators: Xilinx Corporation Device 3450
(...)
LnkSta: Speed 16GT/s (ok), Width x8 (ok)
(...)
```
4. Download the MCS image from release files.
5. Flash the card with xbflash2. For fresh card use:
```
sudo xbflash2 program --spi --image <path to MCS file> --bar-offset 0x1f06000 -d <PCIe slot from above>
```
For card that was already flashed with Jungfraujoch images:
```
sudo xbflash2 program --spi --image <path to MCS file> -d <PCIe slot from above>
```
It is necessary to confirm the operation by pressing `Y` key.
It is safe to run multiple flashing processes in parallel for different cards, for example in separate screen sessions.
6. Cold reboot:
```
sudo ipmitool chassis power cycle
```
7. Install PCIe driver. See [pcie_driver/README.md](pcie_driver/README.md) for details. For first run it is though recommended to try the driver without installing to the kernel directory:
```
$ cd fpga/pcie_driver
$ make
$ sudo insmod jfjoch.ko
```
8. Check with `dmesg` that the device was properly found:
```
$ dmesg |grep jfjoch
[ 431.624933] jfjoch 0000:23:00.0: enabling device (0140 -> 0142)
[ 431.919147] misc jfjoch0: Jungfraujoch FPGA loaded with FW build: 5610030a
```
9. Configure switch according to [network guide](NETWORK.md) - specifically set manual speed and turn off auto-negotiation
for the port used to connect U55C card.
10. Connect card to switch.
## Card verification
To test that FPGA board is working properly without access to a JUNGFRAU detector, you can use `jfjoch_action_test` tool.
## Card release number
To ensure compatibility of the card with driver and user application, each design is marked by **release number**.
This number is incremented after each change of functionality of the card or interface to communicate with the host.
This ensures consistency between the FPGA card, driver and user application. Changes within the design (e.g. size of FIFOs),
that are invisible to interactions with host do not require change in release number.
To check release number, look for constant `RELEASE_NUMBER` in [pcie_driver/jfjoch_fpga.h](pcie_driver/jfjoch_fpga.h) header file.
For FPGA design, release number is saved as PCIe revision.
In case there is mismatch in release number between card and kernel driver, the latter will not create the character device and return error (check `dmesg`).
It is recommended to use the same git commit hash for building the design and user application, though it is not strictly necessary in case care is made to have same release number.

View File

@@ -1,6 +1,6 @@
# FPGA Smart Network Interface Card
See separate document for [installation instructions](INSTALL.md).
See separate document for [installation instructions](../DEPLOYMENT.md).
## Hardware
Currently supported FPGA is only **Xilinx Alveo U55C**.
@@ -64,13 +64,20 @@ make hls
```
### Synthesis
Create PCIe bitstream with the following command:
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.

View File

@@ -212,8 +212,6 @@ void HLSDevice::FPGA_StartAction(const DiffractionExperiment &experiment) {
action_thread.join();
run_counter += 1;
impl_->run_data_collection = 1;
impl_->cancel_data_collection = 0;
idle = false;
while (!impl_->din_frame_generator.empty())
@@ -292,56 +290,57 @@ void HLSDevice::HLSMainThread() {
std::vector<std::thread> hls_cores;
STREAM_512 ip1, udp1, udp2, icmp1, arp1;
STREAM_512 ip1("ip1"), udp1("udp1"), udp2("udp2"), icmp1("icmp1"), arp1("arp1");
STREAM_512 network0;
STREAM_512 network0("network0");
STREAM_768 stream_768_0;
STREAM_768 stream_768_1;
STREAM_768 stream_768_2;
STREAM_768 stream_768_3;
STREAM_768 stream_768_4;
STREAM_768 stream_768_5;
STREAM_768 stream_768_6;
STREAM_768 stream_768_7;
STREAM_768 stream_768_0("stream_768_0");
STREAM_768 stream_768_1("stream_768_1");
STREAM_768 stream_768_2("stream_768_2");
STREAM_768 stream_768_3("stream_768_3");
STREAM_768 stream_768_4("stream_768_4");
STREAM_768 stream_768_5("stream_768_5");
STREAM_768 stream_768_6("stream_768_6");
STREAM_768 stream_768_7("stream_768_7");
STREAM_512 data_0;
hls::stream<ap_axiu<512, 1, 1, 1>, 2> data_1;
STREAM_512 data_3;
STREAM_512 data_4;
STREAM_512 data_5;
STREAM_512 data_6;
STREAM_512 data_7;
STREAM_512 data_8;
STREAM_512 data_9;
STREAM_512 data_10;
STREAM_512 data_12;
STREAM_512 data_13;
STREAM_512 data_0("data_0");
hls::stream<ap_axiu<512, 1, 1, 1>, 2> data_1("data_1");
STREAM_512 data_3("data_3");
STREAM_512 data_4("data_4");
STREAM_512 data_5("data_5");
STREAM_512 data_6("data_6");
STREAM_512 data_7("data_7");
STREAM_512 data_8("data_8");
STREAM_512 data_9("data_9");
STREAM_512 data_10("data_10");
STREAM_512 data_12("data_12");
STREAM_512 data_13("data_13");
hls::stream<axis_addr> addr0;
hls::stream<axis_addr> addr1;
hls::stream<axis_addr> addr2;
hls::stream<axis_addr> addr3;
hls::stream<axis_addr> addr0("addr0");
hls::stream<axis_addr> addr1("addr1");
hls::stream<axis_addr> addr2("addr2");
hls::stream<axis_addr> addr3("addr3");
hls::stream<axis_completion> axi_compl[12];
hls::stream<ap_uint<16>> hbm_handles;
hls::stream<ap_uint<512>> adu_histo_result;
hls::stream<ap_uint<16>> hbm_handles("hbm_handles");
hls::stream<ap_uint<512>> adu_histo_result("adu_histo_result");
hls::stream<ap_axiu<64,1,1,1>> integration_result_0;
hls::stream<ap_uint<512>> integration_result_1;
hls::stream<ap_axiu<64,1,1,1>> integration_result_0("integration_result_0");
hls::stream<ap_uint<512>> integration_result_1("integration_result_1");
hls::stream<ap_axiu<32,1,1,1>> spot_finder_result_0;
hls::stream<ap_axiu<32,1,1,1>> spot_finder_result_1;
hls::stream<ap_uint<32>> spot_finder_conn_0;
hls::stream<ap_axiu<32,1,1,1>> spot_finder_result_2;
hls::stream<ap_uint<512>> spot_finder_result_3;
hls::stream<ap_axiu<32,1,1,1>> spot_finder_result_0("spot_finder_result_0");
hls::stream<ap_axiu<32,1,1,1>> spot_finder_result_1("spot_finder_result_1");
hls::stream<ap_uint<32>> spot_finder_conn_0("spot_finder_conn_0");
hls::stream<ap_axiu<32,1,1,1>> spot_finder_result_2("spot_finder_result_2");
hls::stream<ap_uint<512>> spot_finder_result_3("spot_finder_result_3");
hls::stream<ap_uint<32>> spot_finder_mask_0;
hls::stream<ap_uint<32>> spot_finder_mask_0("spot_finder_mask_0");
hls::stream<ap_uint<256>> roi_calc_result_0;
hls::stream<ap_uint<256>> roi_calc_result_0("roi_calc_result_0");
hls::stream<ap_uint<UDP_METADATA_STREAM_WIDTH> > udp_metadata("udp_metadata");
hls::stream<ap_uint<UDP_METADATA_STREAM_WIDTH> > udp_metadata;
volatile ap_uint<1> idle_data_collection = 1;
ap_uint<1> load_to_hbm_idle;
ap_uint<1> save_to_hbm_idle;
@@ -359,6 +358,31 @@ void HLSDevice::HLSMainThread() {
Logger logger_hls("HLS");
volatile rcv_state_t state = RCV_INIT;
impl_->run_data_collection = 0;
// Read state, check if ready to start
data_collection_fsm(data_0, data_1,
addr0, addr1,
impl_->run_data_collection,
impl_->cancel_data_collection,
idle_data_collection,
cfg.mode,
float2uint(cfg.energy_kev),
cfg.nframes,
cfg.nmodules,
cfg.nstorage_cells,
cfg.nsummation ,
cfg.sqrtmult,
cfg.pxlthreshold,
state);
impl_->run_data_collection = 1;
impl_->cancel_data_collection = 0;
if (state != rcv_state_t::RCV_WAIT_FOR_START)
throw JFJochException(JFJochExceptionCategory::WrongDAQState,
"HLS device not ready to receive data");
// Start data collection
data_collection_fsm(data_0, data_1,
addr0, addr1,

View File

@@ -42,6 +42,7 @@ namespace hls {
std::queue<T> data;
constexpr const static std::chrono::seconds timeout = std::chrono::minutes(30);
size_t max_elements;
const std::string name;
void internal_read(T& head) {
head = data.front();
@@ -53,15 +54,18 @@ namespace hls {
c_empty.notify_one();
}
public:
explicit stream(size_t nelem = UINT64_MAX)
: max_elements(nelem), data(){};
explicit stream(const char* in_name = "", size_t nelem = UINT64_MAX)
: name(in_name), max_elements(nelem), data(){};
void write(const T& tail) {
std::unique_lock<std::mutex> ul(m);
while (data.size() >= max_elements) {
if (c_full.wait_for(ul, timeout)
== std::cv_status::timeout)
throw std::runtime_error("Likely deadlock");
auto start_time = std::chrono::system_clock::now();
if (c_full.wait_for(ul, timeout) == std::cv_status::timeout) {
auto now_time = std::chrono::system_clock::now();
std::chrono::duration<double> elapsed_seconds = now_time - start_time;
throw std::runtime_error(name + ": likely deadlock to write to FIFO, timeout: " + std::to_string(elapsed_seconds.count()));
}
}
internal_write(tail);
}
@@ -83,9 +87,13 @@ namespace hls {
void read(T& head) {
std::unique_lock<std::mutex> ul(m);
while (data.empty()) {
if (c_empty.wait_for(ul, timeout)
== std::cv_status::timeout)
throw std::runtime_error("Likely deadlock");
auto start_time = std::chrono::system_clock::now();
if (c_empty.wait_for(ul, timeout) == std::cv_status::timeout) {
auto now_time = std::chrono::system_clock::now();
std::chrono::duration<double> elapsed_seconds = now_time - start_time;
throw std::runtime_error(name + ": likely deadlock to read from FIFO, timeout: " + std::to_string(elapsed_seconds.count()));
}
}
internal_read(head);
}
@@ -108,7 +116,8 @@ namespace hls {
template<class T, int DEPTH> class stream : public stream<T> {
public:
stream() : stream<T>(DEPTH) {}
explicit stream(const char* name) : stream<T>(name, DEPTH) {}
stream() : stream<T>("", DEPTH) {}
};
}

View File

@@ -1,4 +1,4 @@
// Copyright (2019-2023) Paul Scherrer Institute
// Copyright (2019-2024) Paul Scherrer Institute
#include <unistd.h>
#include <fcntl.h>

View File

@@ -33,7 +33,10 @@ KERNEL=="jfjoch*" GROUP="jungfrau"
## DKMS
To avoid problems with updating the kernel, it is possible to use DKMS to autobuild Jungfraujoch kernel
module, when new kernel is installed. This first requires to install DKMS - for RHEL it is available via EPEL repository:
module, when new kernel is installed. For RHEL 8 it is well tested to use the RPM module built automatically from Jungfraujoch source.
For other systems, it is necessary to follow the procedure below, though it is not well tested.
This first requires to install DKMS - for RHEL it is available via EPEL repository:
```
sudo dnf install dkms
```
@@ -43,7 +46,7 @@ Then use script provided in the driver directory to copy driver code to DKMS dir
```
If upgrading the driver, please first remove current driver from DKMS system:
```
dkms remove jfjoch -v 1.0.0 --all
dkms remove jfjoch -v <version> --all
```
## Driver parameters

View File

@@ -1,5 +1,5 @@
PACKAGE_NAME=jfjoch
PACKAGE_VERSION=1.0.0-rc.15
PACKAGE_VERSION=1.0.0-rc.16
DEST_MODULE_LOCATION=/extra
BUILT_MODULE_NAME=jfjoch

Some files were not shown because too many files have changed in this diff Show More