From c1ddc1abb47c19e78f96d71244d3320211f104c6 Mon Sep 17 00:00:00 2001 From: Filip Leonarski Date: Wed, 18 Nov 2026 17:25:26 +0100 Subject: [PATCH] OpenAPI image_time_us: say where summation runs, drop the 256 * frame_time maximum The text said the image time is at most 256 frame times. Nothing enforces that: summation of 2..255 frames runs on the FPGA (IsCPUSummation, MAX_FPGA_SUMMATION), and anything longer is summed on the host by JFJochReceiverFPGA, which takes no rugnux live analysis (FPGAImagePullerFor). The description now says so. Text only; C++ model comment, frontend client and python client docs regenerated. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01UqXYdHHZ4cogS1mrGUtfN7 --- broker/gen/model/Dataset_settings.h | 2 +- broker/jfjoch_api.yaml | 3 ++- docs/python_client/docs/DatasetSettings.md | 2 +- frontend/src/client/types.gen.ts | 6 ++++-- 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/broker/gen/model/Dataset_settings.h b/broker/gen/model/Dataset_settings.h index 5c9a220e5..ba91eefb2 100644 --- a/broker/gen/model/Dataset_settings.h +++ b/broker/gen/model/Dataset_settings.h @@ -81,7 +81,7 @@ public: bool ntriggerIsSet() const; void unsetNtrigger(); /// - /// Image time. If not provided (or zero value) the frame time is assumed as default. For JUNGFRAU image time must be multiple of frame time and max value is 256 * frame_time. In XFEL mode: summation happens for frames collected with multiple triggers. Ignored for storage cells and if raw data are saved. + /// Image time. If not provided (or zero value) the frame time is assumed as default. For JUNGFRAU image time must be multiple of frame time. Up to 255 frames are summed on the FPGA; a longer image time is summed on the host, which is slower and runs no rugnux live analysis. In XFEL mode: summation happens for frames collected with multiple triggers. Ignored for storage cells and if raw data are saved. /// int64_t getImageTimeUs() const; void setImageTimeUs(int64_t const value); diff --git a/broker/jfjoch_api.yaml b/broker/jfjoch_api.yaml index 8157bb7e4..5abb78447 100644 --- a/broker/jfjoch_api.yaml +++ b/broker/jfjoch_api.yaml @@ -409,7 +409,8 @@ components: description: | Image time. If not provided (or zero value) the frame time is assumed as default. - For JUNGFRAU image time must be multiple of frame time and max value is 256 * frame_time. + For JUNGFRAU image time must be multiple of frame time. Up to 255 frames are summed on the FPGA; + a longer image time is summed on the host, which is slower and runs no rugnux live analysis. In XFEL mode: summation happens for frames collected with multiple triggers. Ignored for storage cells and if raw data are saved. beam_x_pxl: diff --git a/docs/python_client/docs/DatasetSettings.md b/docs/python_client/docs/DatasetSettings.md index 27869f1dc..9e1e77451 100644 --- a/docs/python_client/docs/DatasetSettings.md +++ b/docs/python_client/docs/DatasetSettings.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **images_per_trigger** | **int** | For standard synchrotron data collection - this is number of images collected per one TTL trigger For XFEL (pulsed source) - this number is ignored and set to 1 For storage cell mode - this number is ignored and set to number of storage cells | [optional] [default to 1] **ntrigger** | **int** | Number of TTL trigger that the detector is expected to receive during data collection | [optional] [default to 1] -**image_time_us** | **int** | Image time. If not provided (or zero value) the frame time is assumed as default. For JUNGFRAU image time must be multiple of frame time and max value is 256 * frame_time. In XFEL mode: summation happens for frames collected with multiple triggers. Ignored for storage cells and if raw data are saved. | [optional] +**image_time_us** | **int** | Image time. If not provided (or zero value) the frame time is assumed as default. For JUNGFRAU image time must be multiple of frame time. Up to 255 frames are summed on the FPGA; a longer image time is summed on the host, which is slower and runs no rugnux live analysis. In XFEL mode: summation happens for frames collected with multiple triggers. Ignored for storage cells and if raw data are saved. | [optional] **beam_x_pxl** | **float** | /entry/detector/beam_center_x in NXmx Beam center in X direction [pixels] | **beam_y_pxl** | **float** | /entry/detector/beam_center_y in NXmx Beam center in X direction [pixels] | **detector_distance_mm** | **float** | /entry/detector/distance in NXmx Detector distance [mm] | diff --git a/frontend/src/client/types.gen.ts b/frontend/src/client/types.gen.ts index 049d8cfe9..0473e22cc 100644 --- a/frontend/src/client/types.gen.ts +++ b/frontend/src/client/types.gen.ts @@ -166,7 +166,8 @@ export type dataset_settings = { /** * Image time. * If not provided (or zero value) the frame time is assumed as default. - * For JUNGFRAU image time must be multiple of frame time and max value is 256 * frame_time. + * For JUNGFRAU image time must be multiple of frame time. Up to 255 frames are summed on the FPGA; + * a longer image time is summed on the host, which is slower and runs no rugnux live analysis. * In XFEL mode: summation happens for frames collected with multiple triggers. * Ignored for storage cells and if raw data are saved. * @@ -2641,7 +2642,8 @@ export type dataset_settingsWritable = { /** * Image time. * If not provided (or zero value) the frame time is assumed as default. - * For JUNGFRAU image time must be multiple of frame time and max value is 256 * frame_time. + * For JUNGFRAU image time must be multiple of frame time. Up to 255 frames are summed on the FPGA; + * a longer image time is summed on the host, which is slower and runs no rugnux live analysis. * In XFEL mode: summation happens for frames collected with multiple triggers. * Ignored for storage cells and if raw data are saved. *