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

v1.0.0-rc.36

Browse Source
This commit is contained in:
leonarski_f
2025-05-05 19:32:22 +02:00
parent 759243d1bf
commit 040cf08386
333 changed files with 22724 additions and 15251 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/python_client/docs/ColorScale.md Normal file
View File

@@ -0,0 +1,16 @@
# ColorScale
## Enum
* `INDIGO` (value: `'Indigo'`)
* `VIRIDIS` (value: `'Viridis'`)
* `BLACKWHITE` (value: `'BlackWhite'`)
* `HEAT` (value: `'Heat'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

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

@@ -40,6 +40,8 @@ Method | HTTP request | Description
[**fpga_status_get**](DefaultApi.md#fpga_status_get) | **GET** /fpga_status | Get status of FPGA devices
[**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_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
[**initialize_post**](DefaultApi.md#initialize_post) | **POST** /initialize | Initialize detector and data acquisition
@@ -55,6 +57,7 @@ Method | HTTP request | Description
[**plot_packets_received_get**](DefaultApi.md#plot_packets_received_get) | **GET** /plot/packets_received | Generate plot with number of received packets per image
[**plot_receiver_delay_get**](DefaultApi.md#plot_receiver_delay_get) | **GET** /plot/receiver_delay | Generate receiver delay plot
[**plot_receiver_free_send_buffers_get**](DefaultApi.md#plot_receiver_free_send_buffers_get) | **GET** /plot/receiver_free_send_buffers | Generate receiver free send buffer plot
[**plot_resolution_estimate_get**](DefaultApi.md#plot_resolution_estimate_get) | **GET** /plot/resolution_estimate | Generate resolution estimate plot
[**plot_roi_max_count_get**](DefaultApi.md#plot_roi_max_count_get) | **GET** /plot/roi_max_count | Generate plot of ROI max count
[**plot_roi_mean_get**](DefaultApi.md#plot_roi_mean_get) | **GET** /plot/roi_mean | Generate plot of ROI mean value
[**plot_roi_sum_get**](DefaultApi.md#plot_roi_sum_get) | **GET** /plot/roi_sum | Generate ROI sum plot
@@ -63,10 +66,6 @@ Method | HTTP request | Description
[**plot_roi_y_get**](DefaultApi.md#plot_roi_y_get) | **GET** /plot/roi_y | Generate plot of ROI weighted Y-coordinate
[**plot_spot_count_get**](DefaultApi.md#plot_spot_count_get) | **GET** /plot/spot_count | Generate spot count plot
[**plot_strong_pixel_get**](DefaultApi.md#plot_strong_pixel_get) | **GET** /plot/strong_pixel | Generate strong pixels plot
[**preview_calibration_tiff_get**](DefaultApi.md#preview_calibration_tiff_get) | **GET** /preview/calibration.tiff | Get last preview image in TIFF format for calibration with PyFAI/Dioptas
[**preview_image_jpeg_get**](DefaultApi.md#preview_image_jpeg_get) | **GET** /preview/image.jpeg | Get last preview image in JPEG format using default settings
[**preview_image_jpeg_post**](DefaultApi.md#preview_image_jpeg_post) | **POST** /preview/image.jpeg | Get last preview image in JPEG format using custom settings
[**preview_image_tiff_get**](DefaultApi.md#preview_image_tiff_get) | **GET** /preview/image.tiff | Get last preview image in TIFF format
[**preview_pedestal_tiff_get**](DefaultApi.md#preview_pedestal_tiff_get) | **GET** /preview/pedestal.tiff | Get pedestal in TIFF format
[**start_post**](DefaultApi.md#start_post) | **POST** /start | Start detector
[**statistics_calibration_get**](DefaultApi.md#statistics_calibration_get) | **GET** /statistics/calibration | Get calibration statistics
@@ -2349,7 +2348,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_cbor_get**
> bytearray image_buffer_image_cbor_get(image_number=image_number)
> bytearray image_buffer_image_cbor_get(id=id)
Get image message in CBOR format
@@ -2374,11 +2373,11 @@ configuration = jfjoch_client.Configuration(
with jfjoch_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jfjoch_client.DefaultApi(api_client)
image_number = 56 # int | Image number. If omitted, the image with the highest number in the image buffer will be provided. (optional)
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)
try:
# Get image message in CBOR format
api_response = api_instance.image_buffer_image_cbor_get(image_number=image_number)
api_response = api_instance.image_buffer_image_cbor_get(id=id)
print("The response of DefaultApi->image_buffer_image_cbor_get:\n")
pprint(api_response)
except Exception as e:
@@ -2392,7 +2391,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**image_number** | **int**| Image number. If omitted, the image with the highest number in the image buffer will be provided. | [optional]
**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]
### Return type
@@ -2417,6 +2416,154 @@ 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)
Get preview image in JPEG 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)
saturation = 56 # int | Saturation value to set contrast in the preview image (optional)
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 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)
print("The response of DefaultApi->image_buffer_image_jpeg_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->image_buffer_image_jpeg_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]
**saturation** | **int**| Saturation value to set contrast in the preview image | [optional]
**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_tiff_get**
> bytearray image_buffer_image_tiff_get(id=id)
Get preview image in TIFF format
### 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)
try:
# Get preview image in TIFF format
api_response = api_instance.image_buffer_image_tiff_get(id=id)
print("The response of DefaultApi->image_buffer_image_tiff_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->image_buffer_image_tiff_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]
### Return type
**bytearray**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: image/tiff
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Preview image | - |
**404** | No preview image recorded so far | - |
[[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_start_cbor_get**
> bytearray image_buffer_start_cbor_get()
@@ -3449,6 +3596,77 @@ 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)
# **plot_resolution_estimate_get**
> Plots plot_resolution_estimate_get(binning=binning, compression=compression)
Generate resolution estimate plot
Diffraction resolution, as estimated by SSRL ML model; binning is configurable
### Example
```python
import jfjoch_client
from jfjoch_client.models.plots import Plots
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)
binning = 56 # int | Binning of frames for the plot (0 = default binning) (optional)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate resolution estimate plot
api_response = api_instance.plot_resolution_estimate_get(binning=binning, compression=compression)
print("The response of DefaultApi->plot_resolution_estimate_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->plot_resolution_estimate_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**binning** | **int**| Binning of frames for the plot (0 = default binning) | [optional]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
[**Plots**](Plots.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Everything OK. Response will be by default compressed with deflate algorithm, if using curl, use --compressed option. | - |
**400** | Input parsing or validation error | - |
[[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)
# **plot_roi_max_count_get**
> Plots plot_roi_max_count_get(binning=binning, compression=compression)
@@ -4017,263 +4235,6 @@ 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)
# **preview_calibration_tiff_get**
> bytearray preview_calibration_tiff_get()
Get last preview image in TIFF format for calibration with PyFAI/Dioptas
Image is reduced to unsigned 16-bit images, all bad pixels are set to 65535 and image is mirrored in vertical direction
### 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)
try:
# Get last preview image in TIFF format for calibration with PyFAI/Dioptas
api_response = api_instance.preview_calibration_tiff_get()
print("The response of DefaultApi->preview_calibration_tiff_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->preview_calibration_tiff_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
**bytearray**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: image/tiff
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Preview image | - |
**404** | No preview image recorded so far | - |
[[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)
# **preview_image_jpeg_get**
> bytearray preview_image_jpeg_get()
Get last preview image in JPEG format using default 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)
try:
# Get last preview image in JPEG format using default settings
api_response = api_instance.preview_image_jpeg_get()
print("The response of DefaultApi->preview_image_jpeg_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->preview_image_jpeg_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
**bytearray**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: image/jpeg
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Preview image | - |
**404** | No preview image recorded so far | - |
[[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)
# **preview_image_jpeg_post**
> bytearray preview_image_jpeg_post(preview_settings=preview_settings)
Get last preview image in JPEG format using custom settings
### Example
```python
import jfjoch_client
from jfjoch_client.models.preview_settings import PreviewSettings
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)
preview_settings = jfjoch_client.PreviewSettings() # PreviewSettings | (optional)
try:
# Get last preview image in JPEG format using custom settings
api_response = api_instance.preview_image_jpeg_post(preview_settings=preview_settings)
print("The response of DefaultApi->preview_image_jpeg_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->preview_image_jpeg_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**preview_settings** | [**PreviewSettings**](PreviewSettings.md)| | [optional]
### Return type
**bytearray**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: image/jpeg, text/plain, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Preview image | - |
**404** | No preview image recorded so far | - |
**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)
# **preview_image_tiff_get**
> bytearray preview_image_tiff_get()
Get last preview image in TIFF format
### 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)
try:
# Get last preview image in TIFF format
api_response = api_instance.preview_image_tiff_get()
print("The response of DefaultApi->preview_image_tiff_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->preview_image_tiff_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
**bytearray**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: image/tiff
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Preview image | - |
**404** | No preview image recorded so far | - |
[[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)
# **preview_pedestal_tiff_get**
> bytearray preview_pedestal_tiff_get(gain_level, sc=sc)

5
docs/python_client/docs/Detector.md
View File

@@ -6,13 +6,15 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | |
**serial_number** | **str** | |
**serial_number** | **str** | | [optional] [default to 'Unknown']
**type** | [**DetectorType**](DetectorType.md) | | [optional]
**high_voltage_v** | **int** | | [optional] [default to 0]
**udp_interface_count** | **int** | | [optional] [default to 1]
**module_sync** | **bool** | Use module 0 as master for timing. Only applies to JUNGFRAU detector (this cannot be turned off for EIGER). | [optional] [default to True]
**sensor_thickness_um** | **float** | | [optional] [default to 320]
**readout_time_us** | **int** | Minimum difference between frame time and count time in microseconds Defaults are 3 us for EIGER and 20 us for JUNGFRAU | [optional]
**minimum_count_time_us** | **int** | Minimum count time available for the detector. | [optional]
**minimum_frame_time_us** | **int** | Minimum frame time available for the detector. | [optional]
**calibration_file** | **List[str]** | Can be empty for all detectors - default calibration used. For JUNGFRAU: list of gain files, one entry per module. For EIGER: one directory (with detector settings) or list of trim bit files, one entry per half-module. | [optional]
**hostname** | **List[str]** | Hostname for detector module. One entry per module One entry per module. Either empty or number of module entries. | [optional]
**sensor_material** | **str** | | [optional] [default to 'Si']
@@ -20,6 +22,7 @@ Name | Type | Description | Notes
**base_data_ipv4_address** | **str** | | [optional]
**standard_geometry** | [**StandardDetectorGeometry**](StandardDetectorGeometry.md) | | [optional]
**custom_geometry** | [**List[DetectorModule]**](DetectorModule.md) | | [optional]
**roi_mode** | **str** | ROI setting for DECTRIS detectors | [optional] [default to '']
**mirror_y** | **bool** | Mirror detector in Y direction to account for MX convention of (0,0) point in top left corner | [optional] [default to True]
## 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

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

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
**readout_time_us** | **int** | |
**min_frame_time_us** | **int** | |
**min_count_time_us** | **int** | |
**type** | [**DetectorType**](DetectorType.md) | | [optional]
## Example

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

@@ -7,6 +7,8 @@
* `JUNGFRAU` (value: `'JUNGFRAU'`)
* `DECTRIS` (value: `'DECTRIS'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

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

@@ -10,6 +10,10 @@ None - no master file written NXmxLegacy - legacy format with soft links to data
* `NXMXVDS` (value: `'NXmxVDS'`)
* `CBF` (value: `'CBF'`)
* `TIFF` (value: `'TIFF'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

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

@@ -5,6 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**min_image_number** | **int** | Smallest image number available in the buffer |
**max_image_number** | **int** | Largest image number available in the buffer |
**image_numbers** | **List[int]** | Image numbers currently present in the buffer. |
**total_slots** | **int** | Number of slots in the image buffer. This number, compared to number of images in data collection and frame rate will determine \"retention\" rate of the image buffer. |
**available_slots** | **int** | Slots available for the data collection |

77
docs/python_client/docs/JfjochBrokerApi.md Normal file
View File

@@ -0,0 +1,77 @@
# jfjoch_client.JfjochBrokerApi
All URIs are relative to *http://localhost:5232*
Method | HTTP request | Description
------------- | ------------- | -------------
[**config_zeromq_metadata_put**](JfjochBrokerApi.md#config_zeromq_metadata_put) | **PUT** /config/zeromq_metadata | Set ZeroMQ metadata settings
# **config_zeromq_metadata_put**
> config_zeromq_metadata_put(zeromq_metadata_settings=zeromq_metadata_settings)
Set ZeroMQ metadata settings
Jungfraujoch can generate metadata message stream on ZeroMQ PUB socket. This stream covers all images. Here settings of the socket can be adjusted. While the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request.
### Example
```python
import jfjoch_client
from jfjoch_client.models.zeromq_metadata_settings import ZeromqMetadataSettings
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.JfjochBrokerApi(api_client)
zeromq_metadata_settings = jfjoch_client.ZeromqMetadataSettings() # ZeromqMetadataSettings | (optional)
try:
# Set ZeroMQ metadata settings
api_instance.config_zeromq_metadata_put(zeromq_metadata_settings=zeromq_metadata_settings)
except Exception as e:
print("Exception when calling JfjochBrokerApi->config_zeromq_metadata_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**zeromq_metadata_settings** | [**ZeromqMetadataSettings**](ZeromqMetadataSettings.md)| | [optional]
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Everything OK | - |
**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)

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

@@ -18,6 +18,7 @@ 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 |
**resonet_model** | **str** | Path to Resonet model | [optional]
**image_pusher** | [**ImagePusherType**](ImagePusherType.md) | | [default to ImagePusherType.NONE]
**zeromq_preview** | [**ZeromqPreviewSettings**](ZeromqPreviewSettings.md) | | [optional]
**zeromq_metadata** | [**ZeromqMetadataSettings**](ZeromqMetadataSettings.md) | | [optional]

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

@@ -22,6 +22,7 @@ Name | Type | Description | Notes
**pixel_mask** | [**PixelMaskStatistics**](PixelMaskStatistics.md) | | [optional]
**roi** | [**RoiDefinitions**](RoiDefinitions.md) | | [optional]
**az_int** | [**AzimIntSettings**](AzimIntSettings.md) | | [optional]
**buffer** | [**ImageBufferStatus**](ImageBufferStatus.md) | | [optional]
## Example

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/RoiDefinitions.md
View File

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**box** | [**RoiBoxList**](RoiBoxList.md) | |
**circle** | [**RoiCircleList**](RoiCircleList.md) | |
**azim** | [**RoiAzimList**](RoiAzimList.md) | | [optional]
**azim** | [**RoiAzimList**](RoiAzimList.md) | |
## Example

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

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
**high_resolution_limit** | **float** | |
**low_resolution_limit** | **float** | |
**indexing_tolerance** | **float** | Acceptance tolerance for spots after the indexing run - the larger the number, the more spots will be accepted |
**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. | [optional] [default to True]
## Example