Files
Jungfraujoch/docs/python_client/docs/DetectorSettings.md
Filip Leonarski 224cc8b89c
All checks were successful
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 7m46s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 8m45s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 6m56s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 5m58s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 6m59s
Build Packages / build:rpm (rocky8) (push) Successful in 7m33s
Build Packages / Generate python client (push) Successful in 19s
Build Packages / Build documentation (push) Successful in 41s
Build Packages / Create release (push) Has been skipped
Build Packages / build:rpm (rocky9) (push) Successful in 8m45s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 7m51s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 7m12s
Build Packages / Unit tests (push) Successful in 1h8m51s
v1.0.0-rc.110 (#16)
This is an UNSTABLE release.

* jfjoch_broker: Add auto-contrast option for preview images
* Frontend: Add logo image
* jfjoch_viewer: Add logo image
* jfjoch_viewer: For image chart allow to set min value to zero
* jfjoch_viewer: For resolution estimation plots, visualization uses 1/d^2 as measure
* jfjoch_viewer: Add 3D unit cell visualization (experimental/WIP/not really there)
* Documentation: Add logo image

Reviewed-on: #16
Co-authored-by: Filip Leonarski <filip.leonarski@psi.ch>
Co-committed-by: Filip Leonarski <filip.leonarski@psi.ch>
2025-11-28 12:47:35 +01:00

3.3 KiB

DetectorSettings

Properties

Name Type Description Notes
frame_time_us int Interval between consecutive frames. This is internal frame time for the JUNGFRAU detector, image time has to be integer multiply of this number. For EIGER detector this is default frame time, not used otherwise
count_time_us int Integration time of the detector. If not provided count time will be set to maximum value for a given frame time. [optional]
internal_frame_generator bool Use internal frame generator in FPGA instead of getting data from a real detector [optional] [default to False]
internal_frame_generator_images int Number of images stored in the internal frame generator. [optional] [default to 1]
detector_trigger_delay_ns int Delay between TTL trigger and acquisition start [ns] [optional] [default to 0]
timing DetectorTiming [optional] [default to DetectorTiming.TRIGGER]
eiger_threshold_ke_v float Threshold for the PSI EIGER detector and all DECTRIS detectors. If value is provided, it will be used for all subsequent acquisitions, irrespective of beam energy. If value is not provided, threshold will be determined on start of acquisition as half of incident energy. This might lead to increased start time. [optional]
eiger_bit_depth int Bit depth of PSI EIGER read-out. This is If value is not provided, depth will be determined based on the image time: * Exposure time < 500 microseconds depth of 8 bit will be used, * 500 <= exposure time < 2622 microseconds depth of 16 bit will be used * Exposure time >= 2622 microseconds depth of 32 bit will be used. [optional]
jungfrau_pedestal_g0_frames int [optional] [default to 2000]
jungfrau_pedestal_g1_frames int [optional] [default to 300]
jungfrau_pedestal_g2_frames int [optional] [default to 300]
jungfrau_pedestal_min_image_count int Minimum number of collected images for pedestal to consider it viable [optional] [default to 128]
jungfrau_storage_cell_count int [optional] [default to 1]
jungfrau_storage_cell_delay_ns int Delay between two storage cells [ns] [optional] [default to 5000]
jungfrau_fixed_gain_g1 bool Fix gain to G1 (can be useful for storage cells) [optional] [default to False]
jungfrau_use_gain_hg0 bool Use high G0 (for low energy applications) [optional] [default to False]

Example

from jfjoch_client.models.detector_settings import DetectorSettings

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

# convert the object into a dict
detector_settings_dict = detector_settings_instance.to_dict()
# create an instance of DetectorSettings from a dict
detector_settings_from_dict = DetectorSettings.from_dict(detector_settings_dict)

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