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

v1.0.0-rc.61

Browse Source
This commit is contained in:
leonarski_f
2025-07-08 07:16:59 +02:00
parent 3c67b5a900
commit e4ec9fb38f
163 changed files with 448 additions and 346 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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 = "{}"

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

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

@@ -9,7 +9,9 @@ Name | Type | Description | Notes
**number** | **int** | Detector image number for a given cell |
**bkg** | **float** | Background estimate | [optional]
**spots** | **int** | Spot count | [optional]
**spots_low_res** | **int** | Spot count in low resolution range (default 50.0 - 4.5 A) | [optional]
**spots_low_res** | **int** | Spot count in low resolution range | [optional]
**spots_indexed** | **int** | Spot count within indexing tolerance | [optional]
**spots_ice** | **int** | Spot count within common ice ring resolutions | [optional]
**index** | **int** | Indexing solution | [optional]
**mos** | **float** | Mosaicity estimate | [optional]
**b** | **float** | B-Factor estimate | [optional]

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

@@ -7,14 +7,13 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enable** | **bool** | Enable spot finding. This is temporary setting, i.e. can be changed anytime during data collection. Even if disabled spot finding information will still be send and written, though always with zero spots. | [default to True]
**indexing** | **bool** | Enable indexing. This is temporary setting, i.e. can be changed anytime during data collection. | [default to True]
**filter_powder_rings** | **bool** | Filter spots which form powder rings (e.g., ice rings) | [optional] [default to False]
**min_spot_count_powder_ring** | **int** | Minimum number of spots to consider a thin resolution shell (0.01 A^-1) a powder ring and filter out. | [optional]
**signal_to_noise_threshold** | **float** | |
**photon_count_threshold** | **int** | |
**min_pix_per_spot** | **int** | |
**max_pix_per_spot** | **int** | |
**high_resolution_limit** | **float** | |
**low_resolution_limit** | **float** | |
**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]