version 1.0.0-rc.26

2024-11-26 16:04:38 +01:00
parent 9ab5206c12
commit b3e745a8dd
203 changed files with 2969 additions and 1509 deletions
--- a/docs/python_client/docs/DefaultApi.md
+++ b/docs/python_client/docs/DefaultApi.md
@@ -27,6 +27,8 @@ Method | HTTP request | Description
 [**config_user_mask_put**](DefaultApi.md#config_user_mask_put) | **PUT** /config/user_mask | Upload user mask of the detector (binary)
 [**config_user_mask_tiff_get**](DefaultApi.md#config_user_mask_tiff_get) | **GET** /config/user_mask.tiff | Get user mask of the detector (TIFF)
 [**config_user_mask_tiff_put**](DefaultApi.md#config_user_mask_tiff_put) | **PUT** /config/user_mask.tiff | Upload user mask of the detector
+[**config_zeromq_metadata_get**](DefaultApi.md#config_zeromq_metadata_get) | **GET** /config/zeromq_metadata | Get ZeroMQ metadata socket settings
+[**config_zeromq_metadata_put**](DefaultApi.md#config_zeromq_metadata_put) | **PUT** /config/zeromq_metadata | Set ZeroMQ metadata settings
 [**config_zeromq_preview_get**](DefaultApi.md#config_zeromq_preview_get) | **GET** /config/zeromq_preview | Get ZeroMQ preview settings
 [**config_zeromq_preview_put**](DefaultApi.md#config_zeromq_preview_put) | **PUT** /config/zeromq_preview | Set ZeroMQ preview settings
 [**deactivate_post**](DefaultApi.md#deactivate_post) | **POST** /deactivate | Prepare detector to turn off
@@ -39,6 +41,8 @@ Method | HTTP request | Description
 [**plot_error_pixel_get**](DefaultApi.md#plot_error_pixel_get) | **GET** /plot/error_pixel | Generate error pixels plot
 [**plot_image_collection_efficiency_get**](DefaultApi.md#plot_image_collection_efficiency_get) | **GET** /plot/image_collection_efficiency | Generate image collection efficiency plot
 [**plot_indexing_rate_get**](DefaultApi.md#plot_indexing_rate_get) | **GET** /plot/indexing_rate | Generate indexing rate plot
+[**plot_indexing_unit_cell_angle_get**](DefaultApi.md#plot_indexing_unit_cell_angle_get) | **GET** /plot/indexing_unit_cell_angle | Generate indexing unit cell angle plot
+[**plot_indexing_unit_cell_get**](DefaultApi.md#plot_indexing_unit_cell_get) | **GET** /plot/indexing_unit_cell | Generate indexing unit cell length plots
 [**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_roi_max_count_get**](DefaultApi.md#plot_roi_max_count_get) | **GET** /plot/roi_max_count | Generate plot of ROI max count
@@ -1563,6 +1567,136 @@ 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)

+# **config_zeromq_metadata_get**
+> ZeromqMetadataSettings config_zeromq_metadata_get()
+
+Get ZeroMQ metadata socket settings
+
+### 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.DefaultApi(api_client)
+
+    try:
+        # Get ZeroMQ metadata socket settings
+        api_response = api_instance.config_zeromq_metadata_get()
+        print("The response of DefaultApi->config_zeromq_metadata_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DefaultApi->config_zeromq_metadata_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ZeromqMetadataSettings**](ZeromqMetadataSettings.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Everything OK |  -  |
+
+[[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)
+
+# **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.DefaultApi(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 DefaultApi->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)
+
 # **config_zeromq_preview_get**
 > ZeromqPreviewSettings config_zeromq_preview_get()

@@ -2329,6 +2463,148 @@ with jfjoch_client.ApiClient(configuration) as api_client:



+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **binning** | **int**| Binning of frames for the plot (0 &#x3D; 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** | 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_indexing_unit_cell_angle_get**
+> Plots plot_indexing_unit_cell_angle_get(binning=binning, compression=compression)
+
+Generate indexing unit cell angle plot
+
+Crystal unit cell based on indexing results; 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 indexing unit cell angle plot
+        api_response = api_instance.plot_indexing_unit_cell_angle_get(binning=binning, compression=compression)
+        print("The response of DefaultApi->plot_indexing_unit_cell_angle_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DefaultApi->plot_indexing_unit_cell_angle_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **binning** | **int**| Binning of frames for the plot (0 &#x3D; 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** | 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_indexing_unit_cell_get**
+> Plots plot_indexing_unit_cell_get(binning=binning, compression=compression)
+
+Generate indexing unit cell length plots
+
+Crystal unit cell based on indexing results; 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 indexing unit cell length plots
+        api_response = api_instance.plot_indexing_unit_cell_get(binning=binning, compression=compression)
+        print("The response of DefaultApi->plot_indexing_unit_cell_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DefaultApi->plot_indexing_unit_cell_get: %s\n" % e)
+```
+
+
+
 ### Parameters