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 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UqXYdHHZ4cogS1mrGUtfN7
This commit is contained in:
leonarski_fandClaude Opus 5.5 committed 2026-11-18 17:25:26 +01:00
1 parent 4c9cc48382
commit c1ddc1abb4
4 files changed
+8 -5

No files matched your search

+1 -1
View File
@@ -81,7 +81,7 @@ public:
bool ntriggerIsSet() const;
void unsetNtrigger();
/// <summary>
/// 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.
/// </summary>
int64_t getImageTimeUs() const;
void setImageTimeUs(int64_t const value);
+2 -1
View File
@@ -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:
+1 -1
View File
@@ -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] |
+4 -2
View File
@@ -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.
*