Files
Jungfraujoch/docs/python_client/docs/JfjochSettings.md
Filip Leonarski 4dbbf0e365
Some checks failed
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 8m11s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 9m9s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 9m18s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 10m14s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 10m3s
Build Packages / Generate python client (push) Successful in 15s
Build Packages / Build documentation (push) Successful in 50s
Build Packages / Create release (push) Has been skipped
Build Packages / build:rpm (rocky8) (push) Successful in 8m31s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 8m21s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 7m42s
Build Packages / build:rpm (rocky9) (push) Successful in 9m11s
Build Packages / Unit tests (push) Failing after 1h13m19s
v1.0.0-rc.97
This is an UNSTABLE release and not recommended for production use (please use rc.96 instead).

* jfjoch_broker: For DECTRIS detectors add dark data collection during initialization for bad pixel mask
* jfjoch_broker: Refactor of calibration logic for more clear code (likely to introduce problems)
* jfjoch_viewer: Add option to handle user pixel mask (experimental)
* jfjoch_viewer: More options for ROI
* jfjoch_viewer: Add window to display calibration

Reviewed-on: #2
Co-authored-by: Filip Leonarski <filip.leonarski@psi.ch>
Co-committed-by: Filip Leonarski <filip.leonarski@psi.ch>
2025-11-09 12:42:27 +01:00

2.5 KiB

JfjochSettings

Default settings for Jungfraujoch software. This structure is used to provide default settings using configuration JSON file and is not used in HTTP.

Properties

Name Type Description Notes
pcie List[PcieDevicesInner] [optional]
zeromq ZeromqSettings [optional]
instrument InstrumentMetadata [optional]
file_writer FileWriterSettings [optional]
detector List[Detector]
indexing IndexingSettings [optional]
detector_settings DetectorSettings [optional]
azim_int AzimIntSettings [optional]
image_format ImageFormatSettings [optional]
image_buffer_mi_b int Size of internal buffer in MiB for images before they are sent to a stream [optional] [default to 2048]
verbose bool Print extra debug information [optional] [default to False]
receiver_threads int Number of threads used by the receiver [optional] [default to 64]
numa_policy str NUMA policy to bind CPUs [optional]
frontend_directory str Location of built JavaScript web frontend
ssl JfjochSettingsSsl [optional]
image_pusher ImagePusherType [default to ImagePusherType.NONE]
zeromq_preview ZeromqPreviewSettings [optional]
zeromq_metadata ZeromqMetadataSettings [optional]
dark_mask DarkMaskSettings [optional]

Example

from jfjoch_client.models.jfjoch_settings import JfjochSettings

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

# convert the object into a dict
jfjoch_settings_dict = jfjoch_settings_instance.to_dict()
# create an instance of JfjochSettings from a dict
jfjoch_settings_from_dict = JfjochSettings.from_dict(jfjoch_settings_dict)

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