Files
Jungfraujoch/docs/python_client/docs/Detector.md
T
leonarski_f 75e401f0e5
Build Packages / Unit tests (push) Successful in 1h31m59s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 8m43s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 10m5s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 9m27s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 8m56s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 9m24s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 10m27s
Build Packages / build:rpm (rocky8) (push) Successful in 9m20s
Build Packages / build:rpm (rocky9) (push) Successful in 10m50s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 9m54s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 8m38s
Build Packages / DIALS test (push) Successful in 12m13s
Build Packages / XDS test (durin plugin) (push) Successful in 7m8s
Build Packages / XDS test (JFJoch plugin) (push) Successful in 7m8s
Build Packages / XDS test (neggia plugin) (push) Successful in 7m50s
Build Packages / Generate python client (push) Successful in 16s
Build Packages / Build documentation (push) Successful in 50s
Build Packages / Create release (push) Skipped
v1.0.0-rc.153 (#63)
This is an UNSTABLE release. It includes many experimental features, as well as many AI generated fixes. We recommend using rc.152 for production use.

* jfjoch_broker: Add EXPERIMENTAL pixelrefine mode for image processing
* jfjoch_broker: Allow to load user mask from 8-bit and 16-bit TIFF files
* jfjoch_broker: Add ROI calculation in non-FPGA workflow
* jfjoch_broker: Fixes to TCP image pusher
* jfjoch_broker: Remove NUMA bindings
* jfjoch_broker: Improvements to indexing
* jfjoch_broker: For PSI EIGER, trimming energies are taken from the detector configuration (now compulsory) instead of hardcoded values
* jfjoch_writer: Save ROI definitions and the per-pixel ROI bitmap in the master file; azimuthal ROIs support phi (angular) sectors
* jfjoch_viewer: Major redesign with dockable panels and saved layouts, plus on-canvas creation/move/resize of box, circle and azimuthal ROIs
* jfjoch_viewer: Run jfjoch_process reprocessing jobs from inside the GUI and overlay per-run results

Reviewed-on: #63
2026-06-23 20:29:49 +02:00

3.0 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]
trim_energies_e_v List[int] List of energies at which trimming calibration is provided. Only needed for PSI EIGER and compulsory in this case [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]