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

version 1.0.0-rc.14

Browse Source
This commit is contained in:
leonarski_f
2024-10-07 11:56:40 +02:00
parent 9e21d312b2
commit 3be959f272
217 changed files with 1299 additions and 2429 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -30,12 +30,10 @@ Method | HTTP request | Description
[**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
[**plot_azim_int_per_file_get**](DefaultApi.md#plot_azim_int_per_file_get) | **GET** /plot/azim_int_per_file | Generate radial integration profiles per file
[**plot_bkg_estimate_get**](DefaultApi.md#plot_bkg_estimate_get) | **GET** /plot/bkg_estimate | Generate background estimate plot
[**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_rate_per_file_get**](DefaultApi.md#plot_indexing_rate_per_file_get) | **GET** /plot/indexing_rate_per_file | Generate indexing rate per file
[**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
@@ -1722,70 +1720,6 @@ with openapi_client.ApiClient(configuration) as api_client:
### Parameters
This endpoint does not need any parameter.
### Return type
[**Plots**](Plots.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)
# **plot_azim_int_per_file_get**
> Plots plot_azim_int_per_file_get()
Generate radial integration profiles per file
Radial integration plots for both the whole dataset and per file; useful for time-resolved measurements
### Example
```python
import openapi_client
from openapi_client.models.plots import Plots
from openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.DefaultApi(api_client)
try:
# Generate radial integration profiles per file
api_response = api_instance.plot_azim_int_per_file_get()
print("The response of DefaultApi->plot_azim_int_per_file_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->plot_azim_int_per_file_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
@@ -2087,70 +2021,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)
# **plot_indexing_rate_per_file_get**
> Plots plot_indexing_rate_per_file_get()
Generate indexing rate per file
Indexing rate per each of data files; useful for example for time resolved data
### Example
```python
import openapi_client
from openapi_client.models.plots import Plots
from openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.DefaultApi(api_client)
try:
# Generate indexing rate per file
api_response = api_instance.plot_indexing_rate_per_file_get()
print("The response of DefaultApi->plot_indexing_rate_per_file_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->plot_indexing_rate_per_file_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**Plots**](Plots.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)
# **plot_receiver_delay_get**
> Plots plot_receiver_delay_get(binning=binning)

2
python-client/docs/DetectorSettings.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
**pedestal_g1_frames** | **int** | | [default to 300]
**pedestal_g2_frames** | **int** | | [default to 300]
**pedestal_g0_rms_limit** | **int** | Pixels with pedestal G0 RMS above the threshold are marked as masked pixels | [default to 100]
**pedestal_window_size** | **int** | Running average window size for pedestal calculations | [default to 128]
**pedestal_min_image_count** | **int** | Minimum number of collected images for pedestal to consider it viable | [default to 128]
**storage_cell_delay_ns** | **int** | Delay between two storage cells [ns] | [default to 5000]
**detector_trigger_delay_ns** | **int** | Delay between TTL trigger and acquisition start [ns] | [optional] [default to 0]
**fixed_gain_g1** | **bool** | Fix gain to G1 (can be useful for storage cells) | [optional] [default to False]

15
python-client/docs/FpgaStatusInner.md
View File

@@ -5,11 +5,16 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**eth_link_count** | **int** | | [optional]
**eth_link_status** | **int** | | [optional]
**power_usage_w** | **float** | | [optional]
**fpga_temp_c** | **float** | | [optional]
**hbm_temp_c** | **float** | | [optional]
**pci_dev_id** | **str** | |
**serial_number** | **str** | |
**base_mac_addr** | **str** | |
**eth_link_count** | **int** | |
**eth_link_status** | **int** | |
**power_usage_w** | **float** | |
**fpga_temp_c** | **float** | |
**hbm_temp_c** | **float** | |
**packets_udp** | **int** | |
**packets_sls** | **int** | |
## Example