Files
Jungfraujoch/docs/python_client/docs/Detector.md
T
leonarski_f 4878318c27
Build Packages / Unit tests (push) Successful in 1h17m4s
Build Packages / Generate python client (push) Successful in 1m24s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 12m34s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 12m37s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 11m11s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 12m4s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 11m59s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 13m4s
Build Packages / build:rpm (rocky8) (push) Successful in 13m12s
Build Packages / XDS test (durin plugin) (push) Successful in 9m57s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 11m52s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 12m30s
Build Packages / build:rpm (rocky9) (push) Successful in 13m59s
Build Packages / Build documentation (push) Successful in 1m7s
Build Packages / XDS test (neggia plugin) (push) Successful in 9m24s
Build Packages / Create release (push) Has been skipped
Build Packages / XDS test (JFJoch plugin) (push) Successful in 9m54s
Build Packages / DIALS test (push) Successful in 13m14s
v1.0.0-rc.139 (#49)
This is an UNSTABLE release. The release has significant modifications and bug fixes, if things go wrong, it is better to revert to 1.0.0-rc.132.

* jfjoch_broker: Further reduce startup time for DECTRIS detectors by selectively modifying SIMPLON parameters on `/start`
* jfjoch_broker: Further reduce startup time for DECTRIS detectors by not setting beam center and detector distance via SIMPLON API on '/start'
* jfjoch_broker: Add an extra message to ZeroMQ puller ready to monitor Lite worklow preparation time
* jfjoch_broker: Image buffer configuration is postponed for Lite receiver flow till start message is received
* jfjoch_broker: Use nanoseconds internally for frame/image/readout time
* jfjoch_broker: Extra messages added for receiver operation (to be removed after debugging finished)
* jfojch_broker: Improve profiling of different data analysis steps
* jfjoch_broker: Record integration reflection count
* jfjoch_broker: Fix bug where ZeroMQ preview frequency was confusing time units (micro vs. milliseconds)
* jfjoch_broker: Fix bug where '/wait_till_done' got deadlocked
* jfjoch_writer: Fix confusion between NaN and zero in floating-point datasets

**Breaking changes**: detector definition is now using nanoseconds to define minimum frame time, minimum count time and readout time.

Reviewed-on: #49
2026-04-29 09:50:50 +02:00

2.8 KiB

Detector

Properties

Name Type Description Notes
description str
serial_number str [optional] [default to 'Unknown']
type DetectorType [optional]
high_voltage_v int [optional] [default to 0]
udp_interface_count int [optional] [default to 1]
module_sync bool Use module 0 as master for timing. Only applies to JUNGFRAU detector (this cannot be turned off for EIGER). [optional] [default to True]
sensor_thickness_um float [optional] [default to 320]
readout_time_ns int Minimum difference between frame time and count time in microseconds Defaults are 3'000 ns for EIGER and 20'000 ns for JUNGFRAU [optional]
min_count_time_ns int Minimum count time available for the detector. [optional]
min_frame_time_ns int Minimum frame time available for the detector. [optional]
calibration_file List[str] Can be empty for all detectors - default calibration used. For JUNGFRAU: list of gain files, one entry per module. For EIGER: one directory (with detector settings) or list of trim bit files, one entry per half-module. [optional]
hostname List[str] Hostname for detector module. One entry per module One entry per module. Either empty or number of module entries. [optional]
sensor_material str [optional] [default to 'Si']
tx_delay List[int] [optional]
base_data_ipv4_address str [optional]
standard_geometry StandardDetectorGeometry [optional]
custom_geometry List[DetectorModule] [optional]
roi_mode str ROI setting for DECTRIS detectors [optional] [default to '']
mirror_y bool Mirror detector in Y direction to account for MX convention of (0,0) point in top left corner [optional] [default to True]
temp_thresold_deg_c int Temperature threshold for JUNGFRAU detector modules [optional] [default to 55]
default_settings DetectorSettings [optional]

Example

from jfjoch_client.models.detector import Detector

# TODO update the JSON string below
json = "{}"
# create an instance of Detector from a JSON string
detector_instance = Detector.from_json(json)
# print the JSON string representation of the object
print(Detector.to_json())

# convert the object into a dict
detector_dict = detector_instance.to_dict()
# create an instance of Detector from a dict
detector_from_dict = Detector.from_dict(detector_dict)

[Back to Model list] [Back to API list] [Back to README]