Download OpenAPI specification:Download
Download OpenAPI specification:Download
Jungfraujoch Broker Web API
Number of TTL trigger that the detector is expected to receive during data collection
-FPGA frame summation. For summation above two 32-bit pixel format will be used, unless explicitly specified. -Frame summation factor applies only to conversion mode (assumed as 1 for raw data). -In XFEL mode: summation happens for frames collected with multiple triggers. -Ignored for storage cells (assumed as 1).
+Image time. If not provided (or zero value) the frame time is assumed as default.
+For JUNGFRAU, image time must be multiple of frame time, up to 256 * frame_time.
In XFEL mode: summation happens for frames collected with multiple triggers.
+Ignored for storage cells and if raw data are saved.
/entry/detector/beam_center_x in NXmx @@ -473,6 +478,14 @@ If not provided, the number will be automatically incremented.</p> Transferred over CBOR stream as "series ID", though not saved in HDF5 file. It is highly recommended to keep this number unique for each data collection during experimental series. If not provided, the number will be automatically incremented.
+Unique ID of run. +Transferred over CBOR stream as "unique series ID", though not saved in HDF5 file. +It is highly recommended to keep this name unique for each data collection during experimental series. +If not provided, the name will be automatically generated as number + colon + file_prefix.
Name of group owning the data (e.g. p-group or proposal number). @@ -485,7 +498,7 @@ Transferred over CBOR stream, though not saved in HDF5 file.
" class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk">Input parsing or validation error
{- "images_per_trigger": 1,
- "ntrigger": 1,
- "summation": 1,
- "beam_x_pxl": 0.1,
- "beam_y_pxl": 0.1,
- "detector_distance_mm": 0.1,
- "incident_energy_keV": 0.1,
- "file_prefix": "",
- "images_per_file": 1000,
- "space_group_number": 0,
- "sample_name": "string",
- "fpga_output": "auto",
- "compression": "bslz4",
- "total_flux": 0.1,
- "transmission": 1,
- "goniometer": {
- "name": "omega",
- "step": 0.1,
- "start": 50,
- "vector": [
- 0,
- 0,
- 0
]
}, - "header_appendix": null,
- "image_appendix": null,
- "energy_multiplier": 1,
- "data_reduction_factor_serialmx": 1,
- "run_number": 0,
- "experiment_group": "string",
- "unit_cell": {
- "a": 37,
- "b": 37,
- "c": 78,
- "alpha": 90,
- "beta": 90,
- "gamma": 90
}
}{- "msg": "Detector in wrong state",
- "reason": "WrongDAQState"
}{- "images_per_trigger": 1,
- "ntrigger": 1,
- "image_time_us": 0,
- "beam_x_pxl": 0.1,
- "beam_y_pxl": 0.1,
- "detector_distance_mm": 0.1,
- "incident_energy_keV": 0.1,
- "file_prefix": "",
- "images_per_file": 1000,
- "space_group_number": 0,
- "sample_name": "string",
- "fpga_output": "auto",
- "compression": "bslz4",
- "total_flux": 0.1,
- "transmission": 1,
- "goniometer": {
- "name": "omega",
- "step": 0.1,
- "start": 50,
- "vector": [
- 0,
- 0,
- 0
]
}, - "header_appendix": null,
- "image_appendix": null,
- "energy_multiplier": 1,
- "data_reduction_factor_serialmx": 1,
- "run_number": 0,
- "run_name": "string",
- "experiment_group": "string",
- "unit_cell": {
- "a": 37,
- "b": 37,
- "c": 78,
- "alpha": 90,
- "beta": 90,
- "gamma": 90
}
}{- "msg": "Detector in wrong state",
- "reason": "WrongDAQState"
}Block execution of external script till initialization, data collection or pedestal is finished. @@ -859,7 +872,7 @@ User mask is not automatically applied - i.e. pixels with user mask will have a " class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk">
Release number of Jungfraujoch