Files
Jungfraujoch/docs/python_client/docs/JfjochSettings.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

50 lines
2.6 KiB
Markdown

# 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]**](PcieDevicesInner.md) | | [optional]
**zeromq** | [**ZeromqSettings**](ZeromqSettings.md) | | [optional]
**tcp** | [**TcpSettings**](TcpSettings.md) | | [optional]
**instrument** | [**InstrumentMetadata**](InstrumentMetadata.md) | | [optional]
**file_writer** | [**FileWriterSettings**](FileWriterSettings.md) | | [optional]
**detector** | [**List[Detector]**](Detector.md) | |
**indexing** | [**IndexingSettings**](IndexingSettings.md) | | [optional]
**detector_settings** | [**DetectorSettings**](DetectorSettings.md) | | [optional]
**azim_int** | [**AzimIntSettings**](AzimIntSettings.md) | | [optional]
**image_format** | [**ImageFormatSettings**](ImageFormatSettings.md) | | [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** | Ignored value | [optional]
**frontend_directory** | **str** | Location of built JavaScript web frontend |
**spot_finding** | [**SpotFindingSettings**](SpotFindingSettings.md) | | [optional]
**image_pusher** | [**ImagePusherType**](ImagePusherType.md) | | [default to ImagePusherType.NONE]
**zeromq_preview** | [**ZeromqPreviewSettings**](ZeromqPreviewSettings.md) | | [optional]
**zeromq_metadata** | [**ZeromqMetadataSettings**](ZeromqMetadataSettings.md) | | [optional]
**dark_mask** | [**DarkMaskSettings**](DarkMaskSettings.md) | | [optional]
## Example
```python
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]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)