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

version 1.0.0-rc.17

Browse Source
This commit is contained in:
leonarski_f
2024-10-14 15:03:38 +02:00
parent ad579f5d22
commit ce19996874
183 changed files with 2155 additions and 954 deletions
Download Patch File Download Diff File Expand all files Collapse all files

115
python-client/docs/DefaultApi.md
View File

@@ -53,6 +53,7 @@ Method | HTTP request | Description
[**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
[**statistics_get**](DefaultApi.md#statistics_get) | **GET** /statistics | Get general statistics
[**status_get**](DefaultApi.md#status_get) | **GET** /status | Get Jungfraujoch status
[**trigger_post**](DefaultApi.md#trigger_post) | **POST** /trigger | Send soft trigger to the detector
[**version_get**](DefaultApi.md#version_get) | **GET** /version |
@@ -1708,7 +1709,7 @@ 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)
compression = True # bool | Enable DEFLATE compression of output data (optional) (default to True)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate radial integration profile
@@ -1726,7 +1727,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**compression** | **bool**| Enable DEFLATE compression of output data | [optional] [default to True]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
@@ -1777,7 +1778,7 @@ 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)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate background estimate plot
@@ -1796,7 +1797,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
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]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
@@ -1848,7 +1849,7 @@ 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)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate error pixels plot
@@ -1867,7 +1868,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
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]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
@@ -1919,7 +1920,7 @@ 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)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate image collection efficiency plot
@@ -1938,7 +1939,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
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]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
@@ -1990,7 +1991,7 @@ 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)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate indexing rate plot
@@ -2009,7 +2010,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
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]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
@@ -2061,7 +2062,7 @@ 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)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate receiver delay plot
@@ -2080,7 +2081,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
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]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
@@ -2132,7 +2133,7 @@ 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)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate receiver free send buffer plot
@@ -2151,7 +2152,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
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]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
@@ -2203,7 +2204,7 @@ 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)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate plot of ROI max count
@@ -2222,7 +2223,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
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]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
@@ -2274,7 +2275,7 @@ 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)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate ROI sum plot
@@ -2293,7 +2294,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
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]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
@@ -2345,7 +2346,7 @@ 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)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate plot of ROI valid pixels
@@ -2364,7 +2365,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
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]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
@@ -2416,7 +2417,7 @@ 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)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate spot count plot
@@ -2435,7 +2436,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
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]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
@@ -2487,7 +2488,7 @@ 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)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Generate strong pixels plot
@@ -2506,7 +2507,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
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]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
@@ -3308,6 +3309,72 @@ 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)
# **statistics_get**
> JfjochStatistics statistics_get(compression=compression)
Get general statistics
### Example
```python
import jfjoch_client
from jfjoch_client.models.jfjoch_statistics import JfjochStatistics
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)
compression = True # bool | Enable DEFLATE compression of output data. (optional) (default to True)
try:
# Get general statistics
api_response = api_instance.statistics_get(compression=compression)
print("The response of DefaultApi->statistics_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->statistics_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to True]
### Return type
[**JfjochStatistics**](JfjochStatistics.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)
# **status_get**
> BrokerStatus status_get()

34
python-client/docs/JfjochStatistics.md Normal file
View File

@@ -0,0 +1,34 @@
# JfjochStatistics
Pool statistics for Jungfraujoch to reduce transfers between frontend and jfjoch_broker
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**detector** | [**DetectorStatus**](DetectorStatus.md) | | [optional]
**measurement** | [**MeasurementStatistics**](MeasurementStatistics.md) | | [optional]
**broker** | [**BrokerStatus**](BrokerStatus.md) | | [optional]
**fpga** | [**List[FpgaStatusInner]**](FpgaStatusInner.md) | | [optional]
**calibration** | [**List[CalibrationStatisticsInner]**](CalibrationStatisticsInner.md) | | [optional]
## Example
```python
from jfjoch_client.models.jfjoch_statistics import JfjochStatistics
# TODO update the JSON string below
json = "{}"
# create an instance of JfjochStatistics from a JSON string
jfjoch_statistics_instance = JfjochStatistics.from_json(json)
# print the JSON string representation of the object
print(JfjochStatistics.to_json())
# convert the object into a dict
jfjoch_statistics_dict = jfjoch_statistics_instance.to_dict()
# create an instance of JfjochStatistics from a dict
jfjoch_statistics_from_dict = JfjochStatistics.from_dict(jfjoch_statistics_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)