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

v1.0.0-rc.51

Browse Source
This commit is contained in:
leonarski_f
2025-06-22 13:15:10 +02:00
parent aa13b1cd0b
commit 50eaaaaf29
176 changed files with 954 additions and 194 deletions
Download Patch File Download Diff File Expand all files Collapse all files

91
docs/python_client/docs/DefaultApi.md
View File

@@ -43,6 +43,7 @@ Method | HTTP request | Description
[**image_buffer_clear_post**](DefaultApi.md#image_buffer_clear_post) | **POST** /image_buffer/clear | Clear image buffer
[**image_buffer_image_cbor_get**](DefaultApi.md#image_buffer_image_cbor_get) | **GET** /image_buffer/image.cbor | Get image message in CBOR format
[**image_buffer_image_jpeg_get**](DefaultApi.md#image_buffer_image_jpeg_get) | **GET** /image_buffer/image.jpeg | Get preview image in JPEG format using custom settings
[**image_buffer_image_png_get**](DefaultApi.md#image_buffer_image_png_get) | **GET** /image_buffer/image.png | Get preview image in PNG format using custom settings
[**image_buffer_image_tiff_get**](DefaultApi.md#image_buffer_image_tiff_get) | **GET** /image_buffer/image.tiff | Get preview image in TIFF format
[**image_buffer_start_cbor_get**](DefaultApi.md#image_buffer_start_cbor_get) | **GET** /image_buffer/start.cbor | Get Start message in CBOR format
[**image_buffer_status_get**](DefaultApi.md#image_buffer_status_get) | **GET** /image_buffer/status | Get status of the image buffers
@@ -2533,7 +2534,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **image_buffer_image_jpeg_get**
> bytearray image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color)
> bytearray image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color)
Get preview image in JPEG format using custom settings
@@ -2560,6 +2561,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
show_user_mask = False # bool | Show user mask (optional) (default to False)
show_roi = False # bool | Show ROI areas on the image (optional) (default to False)
show_spots = True # bool | Show spot finding results on the image (optional) (default to True)
show_beam_center = True # bool | Show beam center on the image (optional) (default to True)
saturation = 10 # float | Saturation value to set contrast in the preview image (optional) (default to 10)
jpeg_quality = 100 # int | Quality of JPEG image (100 - highest; 0 - lowest) (optional) (default to 100)
show_res_ring = 0.1 # float | Show resolution ring, provided in Angstrom (optional) (default to 0.1)
@@ -2567,7 +2569,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
try:
# Get preview image in JPEG format using custom settings
api_response = api_instance.image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color)
api_response = api_instance.image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color)
print("The response of DefaultApi->image_buffer_image_jpeg_get:\n")
pprint(api_response)
except Exception as e:
@@ -2585,6 +2587,91 @@ Name | Type | Description | Notes
**show_user_mask** | **bool**| Show user mask | [optional] [default to False]
**show_roi** | **bool**| Show ROI areas on the image | [optional] [default to False]
**show_spots** | **bool**| Show spot finding results on the image | [optional] [default to True]
**show_beam_center** | **bool**| Show beam center on the image | [optional] [default to True]
**saturation** | **float**| Saturation value to set contrast in the preview image | [optional] [default to 10]
**jpeg_quality** | **int**| Quality of JPEG image (100 - highest; 0 - lowest) | [optional] [default to 100]
**show_res_ring** | **float**| Show resolution ring, provided in Angstrom | [optional] [default to 0.1]
**color** | **str**| Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat | [optional] [default to indigo]
### Return type
**bytearray**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: image/jpeg, text/plain, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Preview image | - |
**404** | Image not present in the buffer - either not yet measured or already replaced by a next image. | - |
**400** | Input parsing or validation error | - |
**500** | Error within Jungfraujoch code - see output message. | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **image_buffer_image_png_get**
> bytearray image_buffer_image_png_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color)
Get preview image in PNG format using custom settings
### Example
```python
import jfjoch_client
from jfjoch_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:5232
# See configuration.py for a list of all supported configuration parameters.
configuration = jfjoch_client.Configuration(
host = "http://localhost:5232"
)
# Enter a context with an instance of the API client
with jfjoch_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jfjoch_client.DefaultApi(api_client)
id = -1 # int | Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer (optional) (default to -1)
show_user_mask = False # bool | Show user mask (optional) (default to False)
show_roi = False # bool | Show ROI areas on the image (optional) (default to False)
show_spots = True # bool | Show spot finding results on the image (optional) (default to True)
show_beam_center = True # bool | Show beam center on the image (optional) (default to True)
saturation = 10 # float | Saturation value to set contrast in the preview image (optional) (default to 10)
jpeg_quality = 100 # int | Quality of JPEG image (100 - highest; 0 - lowest) (optional) (default to 100)
show_res_ring = 0.1 # float | Show resolution ring, provided in Angstrom (optional) (default to 0.1)
color = indigo # str | Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat (optional) (default to indigo)
try:
# Get preview image in PNG format using custom settings
api_response = api_instance.image_buffer_image_png_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color)
print("The response of DefaultApi->image_buffer_image_png_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->image_buffer_image_png_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer | [optional] [default to -1]
**show_user_mask** | **bool**| Show user mask | [optional] [default to False]
**show_roi** | **bool**| Show ROI areas on the image | [optional] [default to False]
**show_spots** | **bool**| Show spot finding results on the image | [optional] [default to True]
**show_beam_center** | **bool**| Show beam center on the image | [optional] [default to True]
**saturation** | **float**| Saturation value to set contrast in the preview image | [optional] [default to 10]
**jpeg_quality** | **int**| Quality of JPEG image (100 - highest; 0 - lowest) | [optional] [default to 100]
**show_res_ring** | **float**| Show resolution ring, provided in Angstrom | [optional] [default to 0.1]

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

@@ -9,6 +9,7 @@ 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]
**index** | **int** | Indexing solution | [optional]
**mos** | **float** | Mosaicity estimate | [optional]
**b** | **float** | B-Factor estimate | [optional]
@@ -18,6 +19,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]
## Example

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

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
**high_resolution_limit** | **float** | |
**low_resolution_limit** | **float** | |
**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 collected diffraction images. If enabled it will likely reduce performance of Jungfraujoch for datasets with a very high indexing rate. (experimental feature) | [default to False]
**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