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

v1.0.0-rc.31

Browse Source
This commit is contained in:
leonarski_f
2025-03-02 13:15:28 +01:00
parent aeabc81a4c
commit ddf4c75645
309 changed files with 8705 additions and 1421 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -9,6 +9,8 @@ Method | HTTP request | Description
[**config_azim_int_put**](DefaultApi.md#config_azim_int_put) | **PUT** /config/azim_int | Configure radial integration
[**config_detector_get**](DefaultApi.md#config_detector_get) | **GET** /config/detector | Get detector configuration
[**config_detector_put**](DefaultApi.md#config_detector_put) | **PUT** /config/detector | Change detector configuration
[**config_file_writer_get**](DefaultApi.md#config_file_writer_get) | **GET** /config/file_writer | Get file writer settings
[**config_file_writer_put**](DefaultApi.md#config_file_writer_put) | **PUT** /config/file_writer | Change file writer settings
[**config_image_format_conversion_post**](DefaultApi.md#config_image_format_conversion_post) | **POST** /config/image_format/conversion | Configure format for data collection with full conversion
[**config_image_format_get**](DefaultApi.md#config_image_format_get) | **GET** /config/image_format | Get image output format
[**config_image_format_put**](DefaultApi.md#config_image_format_put) | **PUT** /config/image_format | Change image output format
@@ -36,6 +38,10 @@ Method | HTTP request | Description
[**deactivate_post**](DefaultApi.md#deactivate_post) | **POST** /deactivate | Prepare detector to turn off
[**detector_status_get**](DefaultApi.md#detector_status_get) | **GET** /detector/status | Get detector status
[**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_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
[**pedestal_post**](DefaultApi.md#pedestal_post) | **POST** /pedestal | Collect dark current for the detector
[**plot_azim_int_get**](DefaultApi.md#plot_azim_int_get) | **GET** /plot/azim_int | Generate radial integration profile
@@ -45,6 +51,8 @@ Method | HTTP request | Description
[**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_max_value_get**](DefaultApi.md#plot_max_value_get) | **GET** /plot/max_value | Generate maximum pixel value plot
[**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_roi_max_count_get**](DefaultApi.md#plot_roi_max_count_get) | **GET** /plot/roi_max_count | Generate plot of ROI max count
@@ -394,6 +402,138 @@ 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_file_writer_get**
> FileWriterSettings config_file_writer_get()
Get file writer settings
Can be done anytime
### Example
```python
import jfjoch_client
from jfjoch_client.models.file_writer_settings import FileWriterSettings
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 file writer settings
api_response = api_instance.config_file_writer_get()
print("The response of DefaultApi->config_file_writer_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->config_file_writer_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**FileWriterSettings**](FileWriterSettings.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_file_writer_put**
> config_file_writer_put(file_writer_settings=file_writer_settings)
Change file writer settings
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
### Example
```python
import jfjoch_client
from jfjoch_client.models.file_writer_settings import FileWriterSettings
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)
file_writer_settings = jfjoch_client.FileWriterSettings() # FileWriterSettings | (optional)
try:
# Change file writer settings
api_instance.config_file_writer_put(file_writer_settings=file_writer_settings)
except Exception as e:
print("Exception when calling DefaultApi->config_file_writer_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**file_writer_settings** | [**FileWriterSettings**](FileWriterSettings.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_image_format_conversion_post**
> config_image_format_conversion_post()
@@ -2143,6 +2283,267 @@ 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_clear_post**
> image_buffer_clear_post()
Clear image buffer
Turns off image buffer for the last data collection. Can be only run when Jungfraujoch is not collecting data.
### 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:
# Clear image buffer
api_instance.image_buffer_clear_post()
except Exception as e:
print("Exception when calling DefaultApi->image_buffer_clear_post: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Done | - |
**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_cbor_get**
> bytearray image_buffer_image_cbor_get(image_number=image_number)
Get image message in CBOR format
Contains full image data and metadata. The image must come from the latest data collection.
### 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)
image_number = 56 # int | Image number. If omitted, the image with the highest number in the image buffer will be provided. (optional)
try:
# Get image message in CBOR format
api_response = api_instance.image_buffer_image_cbor_get(image_number=image_number)
print("The response of DefaultApi->image_buffer_image_cbor_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->image_buffer_image_cbor_get: %s\n" % e)
```
### Parameters
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]
### Return type
**bytearray**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/cbor, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Return image message | - |
**404** | Image not present in the buffer - either not yet measured or already replaced by a next image. | - |
**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_start_cbor_get**
> bytearray image_buffer_start_cbor_get()
Get Start message in CBOR format
Contains metadata for a dataset (e.g., experimental geometry)
### 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 Start message in CBOR format
api_response = api_instance.image_buffer_start_cbor_get()
print("The response of DefaultApi->image_buffer_start_cbor_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->image_buffer_start_cbor_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**: application/cbor, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Return start message | - |
**404** | No measurement so far | - |
**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_status_get**
> ImageBufferStatus image_buffer_status_get()
Get status of the image buffers
Can be run at any stage of Jungfraujoch operation, including during data collection. The status of the image buffer is volatile during data collection - if data collection goes for more images than available buffer slots, then image might be replaced in the buffer between calling /images and /image.cbor.
### Example
```python
import jfjoch_client
from jfjoch_client.models.image_buffer_status import ImageBufferStatus
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 status of the image buffers
api_response = api_instance.image_buffer_status_get()
print("The response of DefaultApi->image_buffer_status_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->image_buffer_status_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**ImageBufferStatus**](ImageBufferStatus.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Done | - |
**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)
# **initialize_post**
> initialize_post()
@@ -2761,6 +3162,148 @@ 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_max_value_get**
> Plots plot_max_value_get(binning=binning, compression=compression)
Generate maximum pixel value plot
Provides maximum viable pixel value (excluding overloads and error pixels); binning is configurable and maximum of a bin is returned
### 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 maximum pixel value plot
api_response = api_instance.plot_max_value_get(binning=binning, compression=compression)
print("The response of DefaultApi->plot_max_value_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->plot_max_value_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** | 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_packets_received_get**
> Plots plot_packets_received_get(binning=binning, compression=compression)
Generate plot with number of received packets per image
Number of collected packets per image; 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 plot with number of received packets per image
api_response = api_instance.plot_packets_received_get(binning=binning, compression=compression)
print("The response of DefaultApi->plot_packets_received_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->plot_packets_received_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 | - |
**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_receiver_delay_get**
> Plots plot_receiver_delay_get(binning=binning, compression=compression)