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

version 1.0.0-rc.29

Browse Source
This commit is contained in:
leonarski_f
2024-12-08 13:26:13 +01:00
parent 6ec126d65a
commit 7564619574
165 changed files with 2061 additions and 1155 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/python_client/docs/BrokerStatus.md
+2 -1
View File
@@ -7,7 +7,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**state** | **str** | |
**progress** | **float** | Progress of data collection (only available if receiving is running) | [optional]
**error_message** | **str** | Last error message in case detector is in the Error state This matters especially for async functions (start/initialize), where API won't return reason for the error during async operation. | [optional]
**message** | **str** | Message to display besides state of the jfjoch_broker; mostly used for errors and warnings This matters especially for async functions (start/initialize), where API won't return reason for the error during async operation. | [optional]
**message_severity** | **str** | Level of the message to display | [optional] [default to 'error']
## Example
docs/python_client/docs/DefaultApi.md
+130 -260
View File
@@ -19,6 +19,8 @@ Method | HTTP request | Description
[**config_internal_generator_image_tiff_put**](DefaultApi.md#config_internal_generator_image_tiff_put) | **PUT** /config/internal_generator_image.tiff | Load TIFF image for internal FPGA generator
[**config_mask_get**](DefaultApi.md#config_mask_get) | **GET** /config/mask | Get mask of the detector (binary)
[**config_mask_tiff_get**](DefaultApi.md#config_mask_tiff_get) | **GET** /config/mask.tiff | Get mask of the detector (TIFF)
[**config_roi_get**](DefaultApi.md#config_roi_get) | **GET** /config/roi | Get ROI definitions
[**config_roi_put**](DefaultApi.md#config_roi_put) | **PUT** /config/roi | Upload ROI definitions
[**config_select_detector_get**](DefaultApi.md#config_select_detector_get) | **GET** /config/select_detector | List available detectors
[**config_select_detector_put**](DefaultApi.md#config_select_detector_put) | **PUT** /config/select_detector | Select detector
[**config_spot_finding_get**](DefaultApi.md#config_spot_finding_get) | **GET** /config/spot_finding | Get data processing configuration
@@ -55,10 +57,6 @@ Method | HTTP request | Description
[**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
[**roi_box_get**](DefaultApi.md#roi_box_get) | **GET** /roi/box | Get box ROIs
[**roi_box_put**](DefaultApi.md#roi_box_put) | **PUT** /roi/box | Upload box ROIs
[**roi_circle_get**](DefaultApi.md#roi_circle_get) | **GET** /roi/circle | Get circular ROI
[**roi_circle_put**](DefaultApi.md#roi_circle_put) | **PUT** /roi/circle | Upload circular ROI
[**start_post**](DefaultApi.md#start_post) | **POST** /start | Start detector
[**statistics_calibration_get**](DefaultApi.md#statistics_calibration_get) | **GET** /statistics/calibration | Get calibration statistics
[**statistics_data_collection_get**](DefaultApi.md#statistics_data_collection_get) | **GET** /statistics/data_collection | Get data collection statistics
@@ -1046,6 +1044,134 @@ 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_roi_get**
> RoiDefinitions config_roi_get()
Get ROI definitions
### Example
```python
import jfjoch_client
from jfjoch_client.models.roi_definitions import RoiDefinitions
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 ROI definitions
api_response = api_instance.config_roi_get()
print("The response of DefaultApi->config_roi_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->config_roi_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**RoiDefinitions**](RoiDefinitions.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | 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_roi_put**
> config_roi_put(roi_definitions=roi_definitions)
Upload ROI definitions
### Example
```python
import jfjoch_client
from jfjoch_client.models.roi_definitions import RoiDefinitions
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)
roi_definitions = jfjoch_client.RoiDefinitions() # RoiDefinitions | (optional)
try:
# Upload ROI definitions
api_instance.config_roi_put(roi_definitions=roi_definitions)
except Exception as e:
print("Exception when calling DefaultApi->config_roi_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**roi_definitions** | [**RoiDefinitions**](RoiDefinitions.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_select_detector_get**
> DetectorList config_select_detector_get()
@@ -3457,262 +3583,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)
# **roi_box_get**
> RoiBoxList roi_box_get()
Get box ROIs
### Example
```python
import jfjoch_client
from jfjoch_client.models.roi_box_list import RoiBoxList
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 box ROIs
api_response = api_instance.roi_box_get()
print("The response of DefaultApi->roi_box_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->roi_box_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**RoiBoxList**](RoiBoxList.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | 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)
# **roi_box_put**
> roi_box_put(roi_box_list=roi_box_list)
Upload box ROIs
### Example
```python
import jfjoch_client
from jfjoch_client.models.roi_box_list import RoiBoxList
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)
roi_box_list = jfjoch_client.RoiBoxList() # RoiBoxList | (optional)
try:
# Upload box ROIs
api_instance.roi_box_put(roi_box_list=roi_box_list)
except Exception as e:
print("Exception when calling DefaultApi->roi_box_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**roi_box_list** | [**RoiBoxList**](RoiBoxList.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)
# **roi_circle_get**
> RoiCircleList roi_circle_get()
Get circular ROI
### Example
```python
import jfjoch_client
from jfjoch_client.models.roi_circle_list import RoiCircleList
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 circular ROI
api_response = api_instance.roi_circle_get()
print("The response of DefaultApi->roi_circle_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->roi_circle_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**RoiCircleList**](RoiCircleList.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | 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)
# **roi_circle_put**
> roi_circle_put(roi_circle_list=roi_circle_list)
Upload circular ROI
### Example
```python
import jfjoch_client
from jfjoch_client.models.roi_circle_list import RoiCircleList
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)
roi_circle_list = jfjoch_client.RoiCircleList() # RoiCircleList | (optional)
try:
# Upload circular ROI
api_instance.roi_circle_put(roi_circle_list=roi_circle_list)
except Exception as e:
print("Exception when calling DefaultApi->roi_circle_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**roi_circle_list** | [**RoiCircleList**](RoiCircleList.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)
# **start_post**
> start_post(dataset_settings=dataset_settings)
docs/python_client/docs/Detector.md
+2 -1
View File
@@ -12,7 +12,8 @@ Name | Type | Description | Notes
**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]
**calibration_file** | **List[str]** | Gain file (JUNGFRAU) or trimbit file (EIGER). One entry per module. Either empty or number of module entries. | [optional]
**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]
**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']
**tx_delay** | **List[int]** | | [optional]
docs/python_client/docs/DetectorList.md
+1 -1
View File
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**detectors** | [**List[DetectorListDetectorsInner]**](DetectorListDetectorsInner.md) | |
**detectors** | [**List[DetectorListElement]**](DetectorListElement.md) | |
**current_id** | **int** | |
## Example
docs/python_client/docs/DetectorListDetectorsInner.md
+3
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
docs/python_client/docs/DetectorListElement.md
+39
View File
@@ -0,0 +1,39 @@
# DetectorListElement
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | |
**description** | **str** | |
**serial_number** | **str** | |
**base_ipv4_addr** | **str** | |
**udp_interface_count** | **int** | Number of UDP interfaces per detector module |
**nmodules** | **int** | |
**width** | **int** | |
**height** | **int** | |
**readout_time_us** | **int** | |
**min_frame_time_us** | **int** | |
**min_count_time_us** | **int** | |
## Example
```python
from jfjoch_client.models.detector_list_element import DetectorListElement
# TODO update the JSON string below
json = "{}"
# create an instance of DetectorListElement from a JSON string
detector_list_element_instance = DetectorListElement.from_json(json)
# print the JSON string representation of the object
print(DetectorListElement.to_json())
# convert the object into a dict
detector_list_element_dict = detector_list_element_instance.to_dict()
# create an instance of DetectorListElement from a dict
detector_list_element_from_dict = DetectorListElement.from_dict(detector_list_element_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/python_client/docs/JfjochStatistics.md
+1
View File
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
**zeromq_preview** | [**ZeromqPreviewSettings**](ZeromqPreviewSettings.md) | | [optional]
**zeromq_metadata** | [**ZeromqMetadataSettings**](ZeromqMetadataSettings.md) | | [optional]
**pixel_mask** | [**PixelMaskStatistics**](PixelMaskStatistics.md) | | [optional]
**roi** | [**RoiDefinitions**](RoiDefinitions.md) | | [optional]
## Example
docs/python_client/docs/RoiDefinitions.md
+31
View File
@@ -0,0 +1,31 @@
# RoiDefinitions
ROI defintions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**box** | [**RoiBoxList**](RoiBoxList.md) | |
**circle** | [**RoiCircleList**](RoiCircleList.md) | |
## Example
```python
from jfjoch_client.models.roi_definitions import RoiDefinitions
# TODO update the JSON string below
json = "{}"
# create an instance of RoiDefinitions from a JSON string
roi_definitions_instance = RoiDefinitions.from_json(json)
# print the JSON string representation of the object
print(RoiDefinitions.to_json())
# convert the object into a dict
roi_definitions_dict = roi_definitions_instance.to_dict()
# create an instance of RoiDefinitions from a dict
roi_definitions_from_dict = RoiDefinitions.from_dict(roi_definitions_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)