mx/Jungfraujoch
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases 33 Wiki Activity

v1.0.0-rc.71

Browse Source
This commit is contained in:
leonarski_f
2025-08-28 07:07:01 +02:00
parent 4e3b54f0b0
commit dba807fadd
185 changed files with 267 additions and 1649 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/python_client/README.md
View File

@@ -22,8 +22,8 @@ communicate through network calls or other mechanisms.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0-rc.70
- Package version: 1.0.0-rc.70
- API version: 1.0.0-rc.71
- Package version: 1.0.0-rc.71
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

1
docs/python_client/docs/BrokerStatus.md
View File

@@ -10,7 +10,6 @@ Name | Type | Description | Notes
**message** | **str** | Message to display besides state of the jfjoch_broker; mostly used for errors and warnings This matters especially for async functions (start/initialize), where API won't return reason for the error during async operation. | [optional]
**message_severity** | **str** | Level of the message to display | [optional] [default to 'error']
**gpu_count** | **int** | Number of installed GPUs | [optional]
**ml_resolution_estimation** | **bool** | ML resolution estimation available | [optional]
## Example

3
docs/python_client/docs/DetectorListDetectorsInner.md
View File

@@ -13,6 +13,9 @@ Name | Type | Description | Notes
**nmodules** | **int** | |
**width** | **int** | |
**height** | **int** | |
**readout_time_us** | **int** | |
**min_frame_time_us** | **int** | |
**min_count_time_us** | **int** | |
## Example

10
docs/python_client/docs/GridScanResult.md
View File

@@ -6,17 +6,13 @@ Results of a grid scan
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**det_img** | **List[int]** | Detector image number for a given cell |
**bkg_estimate** | **List[float]** | |
**spot_count** | **List[int]** | |
**indexed_lattices** | **List[int]** | |
**mosaicity** | **List[float]** | |
**b_factor** | **List[float]** | |
**file_prefix** | **str** | | [optional]
**images** | [**List[GridScanResultImagesInner]**](GridScanResultImagesInner.md) | |
## Example
```python
from jfjoch_client.models.grid_scan_result import GridScanResult
from jfjoch_client.models.scan_result import GridScanResult
# TODO update the JSON string below
json = "{}"

1
docs/python_client/docs/JfjochSettings.md
View File

@@ -20,7 +20,6 @@ Name | Type | Description | Notes
**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 |
**inference_server_addr** | **List[str]** | Address to ML-based inference servers | [optional]
**ssl** | [**JfjochSettingsSsl**](JfjochSettingsSsl.md) | | [optional]
**image_pusher** | [**ImagePusherType**](ImagePusherType.md) | | [default to ImagePusherType.NONE]
**zeromq_preview** | [**ZeromqPreviewSettings**](ZeromqPreviewSettings.md) | | [optional]

2
docs/python_client/docs/PreviewSettings.md
View File

@@ -10,9 +10,9 @@ Name | Type | Description | Notes
**show_spots** | **bool** | Show spot finding results on the image | [optional] [default to True]
**show_roi** | **bool** | Show ROI areas on the image | [optional] [default to False]
**jpeg_quality** | **int** | Quality of JPEG image (100 - highest; 0 - lowest) | [optional] [default to 100]
**show_indexed** | **bool** | Preview indexed images only | [optional] [default to False]
**show_user_mask** | **bool** | Show user mask | [optional] [default to False]
**resolution_ring** | **float** | | [optional] [default to 0.1]
**scale** | [**ColorScale**](ColorScale.md) | | [optional] [default to ColorScale.INDIGO]
## Example

2
docs/python_client/docs/ScanResultImagesInner.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
**max** | **int** | Max viable pixel | [optional]
**sat** | **int** | Number of saturated pixels | [optional]
**err** | **int** | Number of error pixels | [optional]
**res** | **float** | Resolution estimate from ML algorithm | [optional]
**res** | **float** | Diffraction resolution estimate | [optional]
## Example

1
docs/python_client/docs/SpotFindingSettings.md
View File

@@ -14,7 +14,6 @@ Name | Type | Description | Notes
**high_resolution_limit** | **float** | High resolution limit for spot finding [Angstrom] |
**low_resolution_limit** | **float** | Low resolution limit for spot finding [Angstrom] |
**high_resolution_limit_for_spot_count_low_res** | **float** | High resolution threshold to consider spot \"low resolution\" [Angstrom] |
**resolution_estimate** | **bool** | Diffraction image resolution estimation using ML model from SSRL; `jfjoch_broker` must be compiled with libtorch support and path to .pt file configured in `jfjoch_broker` configuration file. If enabled it will likely reduce performance of Jungfraujoch to below 100 Hz. (experimental feature) | [optional] [default to True]
**quick_integration** | **bool** | Quick integration of Bragg spots in diffraction images. If enabled it will likely reduce performance of Jungfraujoch for datasets with a very high indexing rate. (experimental feature) | [default to False]
## Example