mx/Jungfraujoch
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases 33 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

14
docs/python_client/README.md
View File

@@ -6,8 +6,8 @@ Jungfraujoch uses FPGA boards to acquire data at high data rates.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0-rc.30
- Package version: 1.0.0-rc.30
- API version: 1.0.0-rc.31
- Package version: 1.0.0-rc.31
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
@@ -90,6 +90,8 @@ Class | Method | HTTP request | Description
*DefaultApi* | [**config_azim_int_put**](docs/DefaultApi.md#config_azim_int_put) | **PUT** /config/azim_int | Configure radial integration
*DefaultApi* | [**config_detector_get**](docs/DefaultApi.md#config_detector_get) | **GET** /config/detector | Get detector configuration
*DefaultApi* | [**config_detector_put**](docs/DefaultApi.md#config_detector_put) | **PUT** /config/detector | Change detector configuration
*DefaultApi* | [**config_file_writer_get**](docs/DefaultApi.md#config_file_writer_get) | **GET** /config/file_writer | Get file writer settings
*DefaultApi* | [**config_file_writer_put**](docs/DefaultApi.md#config_file_writer_put) | **PUT** /config/file_writer | Change file writer settings
*DefaultApi* | [**config_image_format_conversion_post**](docs/DefaultApi.md#config_image_format_conversion_post) | **POST** /config/image_format/conversion | Configure format for data collection with full conversion
*DefaultApi* | [**config_image_format_get**](docs/DefaultApi.md#config_image_format_get) | **GET** /config/image_format | Get image output format
*DefaultApi* | [**config_image_format_put**](docs/DefaultApi.md#config_image_format_put) | **PUT** /config/image_format | Change image output format
@@ -117,6 +119,10 @@ Class | Method | HTTP request | Description
*DefaultApi* | [**deactivate_post**](docs/DefaultApi.md#deactivate_post) | **POST** /deactivate | Prepare detector to turn off
*DefaultApi* | [**detector_status_get**](docs/DefaultApi.md#detector_status_get) | **GET** /detector/status | Get detector status
*DefaultApi* | [**fpga_status_get**](docs/DefaultApi.md#fpga_status_get) | **GET** /fpga_status | Get status of FPGA devices
*DefaultApi* | [**image_buffer_clear_post**](docs/DefaultApi.md#image_buffer_clear_post) | **POST** /image_buffer/clear | Clear image buffer
*DefaultApi* | [**image_buffer_image_cbor_get**](docs/DefaultApi.md#image_buffer_image_cbor_get) | **GET** /image_buffer/image.cbor | Get image message in CBOR format
*DefaultApi* | [**image_buffer_start_cbor_get**](docs/DefaultApi.md#image_buffer_start_cbor_get) | **GET** /image_buffer/start.cbor | Get Start message in CBOR format
*DefaultApi* | [**image_buffer_status_get**](docs/DefaultApi.md#image_buffer_status_get) | **GET** /image_buffer/status | Get status of the image buffers
*DefaultApi* | [**initialize_post**](docs/DefaultApi.md#initialize_post) | **POST** /initialize | Initialize detector and data acquisition
*DefaultApi* | [**pedestal_post**](docs/DefaultApi.md#pedestal_post) | **POST** /pedestal | Collect dark current for the detector
*DefaultApi* | [**plot_azim_int_get**](docs/DefaultApi.md#plot_azim_int_get) | **GET** /plot/azim_int | Generate radial integration profile
@@ -126,6 +132,8 @@ Class | Method | HTTP request | Description
*DefaultApi* | [**plot_indexing_rate_get**](docs/DefaultApi.md#plot_indexing_rate_get) | **GET** /plot/indexing_rate | Generate indexing rate plot
*DefaultApi* | [**plot_indexing_unit_cell_angle_get**](docs/DefaultApi.md#plot_indexing_unit_cell_angle_get) | **GET** /plot/indexing_unit_cell_angle | Generate indexing unit cell angle plot
*DefaultApi* | [**plot_indexing_unit_cell_get**](docs/DefaultApi.md#plot_indexing_unit_cell_get) | **GET** /plot/indexing_unit_cell | Generate indexing unit cell length plots
*DefaultApi* | [**plot_max_value_get**](docs/DefaultApi.md#plot_max_value_get) | **GET** /plot/max_value | Generate maximum pixel value plot
*DefaultApi* | [**plot_packets_received_get**](docs/DefaultApi.md#plot_packets_received_get) | **GET** /plot/packets_received | Generate plot with number of received packets per image
*DefaultApi* | [**plot_receiver_delay_get**](docs/DefaultApi.md#plot_receiver_delay_get) | **GET** /plot/receiver_delay | Generate receiver delay plot
*DefaultApi* | [**plot_receiver_free_send_buffers_get**](docs/DefaultApi.md#plot_receiver_free_send_buffers_get) | **GET** /plot/receiver_free_send_buffers | Generate receiver free send buffer plot
*DefaultApi* | [**plot_roi_max_count_get**](docs/DefaultApi.md#plot_roi_max_count_get) | **GET** /plot/roi_max_count | Generate plot of ROI max count
@@ -170,7 +178,9 @@ Class | Method | HTTP request | Description
- [DetectorTiming](docs/DetectorTiming.md)
- [DetectorType](docs/DetectorType.md)
- [ErrorMessage](docs/ErrorMessage.md)
- [FileWriterSettings](docs/FileWriterSettings.md)
- [FpgaStatusInner](docs/FpgaStatusInner.md)
- [ImageBufferStatus](docs/ImageBufferStatus.md)
- [ImageFormatSettings](docs/ImageFormatSettings.md)
- [ImagePusherType](docs/ImagePusherType.md)
- [InstrumentMetadata](docs/InstrumentMetadata.md)

2
docs/python_client/docs/DatasetSettings.md
View File

@@ -29,7 +29,7 @@ Name | Type | Description | Notes
**experiment_group** | **str** | Name of group owning the data (e.g. p-group or proposal number). Transferred over CBOR stream, though not saved in HDF5 file. | [optional]
**poisson_compression** | **int** | Enable lossy compression of pixel values that preserves Poisson statistics. Requires to provide a numerical factor SQ. Pixel value P will be transformed to round(sqrt(P) * SQ), with rounding to the closest integer. Compression is turned off if the value is missing or it is set to zero. | [optional]
**write_nxmx_hdf5_master** | **bool** | Write NXmx formatted HDF5 master file. Recommended to use for macromolecular crystallography experiments and to turn off for other experiments. | [optional] [default to True]
**save_calibration** | **bool** | Forward image calibration (at the moment pedestal and pedestal RMS for JUNGFRAU) using the ZeroMQ stream to writer. If parameter is not provided calibration will be saved only if more than 4 images are recorded. | [optional]
**save_calibration** | **bool** | Forward image calibration (at the moment pedestal and pedestal RMS for JUNGFRAU) using the ZeroMQ stream to writer. If parameter is not provided calibration will be saved only if more than 4 images are recorded. | [optional]
**unit_cell** | [**DatasetSettingsUnitCell**](DatasetSettingsUnitCell.md) | | [optional]
## Example

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)

30
docs/python_client/docs/FileWriterSettings.md Normal file
View File

@@ -0,0 +1,30 @@
# FileWriterSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**overwrite** | **bool** | Inform jfjoch_write to overwrite existing files. Otherwise files would be saved with .h5.{timestamp}.tmp suffix. | [optional] [default to False]
**file_writer_version** | **int** | version 1 - legacy format with soft links to data files in the master file; necessary for DECTRIS Albula 4.0 and DECTRIS Neggia version 2 - newer format with virtual dataset linking data files in the master file, also includes better metadata handling | [optional] [default to 2]
## Example
```python
from jfjoch_client.models.file_writer_settings import FileWriterSettings
# TODO update the JSON string below
json = "{}"
# create an instance of FileWriterSettings from a JSON string
file_writer_settings_instance = FileWriterSettings.from_json(json)
# print the JSON string representation of the object
print(FileWriterSettings.to_json())
# convert the object into a dict
file_writer_settings_dict = file_writer_settings_instance.to_dict()
# create an instance of FileWriterSettings from a dict
file_writer_settings_from_dict = FileWriterSettings.from_dict(file_writer_settings_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)

2
docs/python_client/docs/FpgaStatusInner.md
View File

@@ -17,6 +17,8 @@ Name | Type | Description | Notes
**packets_udp** | **int** | |
**packets_sls** | **int** | |
**idle** | **bool** | |
**pcie_link_speed** | **int** | PCIe link speed measured by generation (expected value is 4 == PCIe Gen4) |
**pcie_link_width** | **int** | PCIe link width (expected value is 8 == x8) |
## Example

31
docs/python_client/docs/ImageBufferStatus.md Normal file
View File

@@ -0,0 +1,31 @@
# ImageBufferStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**image_numbers** | **List[int]** | Image numbers currently present in the buffer. |
**total_slots** | **int** | Number of slots in the image buffer. This number, compared to number of images in data collection and frame rate will determine \"retention\" rate of the image buffer. |
**available_slots** | **int** | Slots available for the data collection |
## Example
```python
from jfjoch_client.models.image_buffer_status import ImageBufferStatus
# TODO update the JSON string below
json = "{}"
# create an instance of ImageBufferStatus from a JSON string
image_buffer_status_instance = ImageBufferStatus.from_json(json)
# print the JSON string representation of the object
print(ImageBufferStatus.to_json())
# convert the object into a dict
image_buffer_status_dict = image_buffer_status_instance.to_dict()
# create an instance of ImageBufferStatus from a dict
image_buffer_status_from_dict = ImageBufferStatus.from_dict(image_buffer_status_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)

1
docs/python_client/docs/JfjochSettings.md
View File

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
**pcie** | [**List[PcieDevicesInner]**](PcieDevicesInner.md) | | [optional]
**zeromq** | [**ZeromqSettings**](ZeromqSettings.md) | | [optional]
**instrument** | [**InstrumentMetadata**](InstrumentMetadata.md) | | [optional]
**file_writer** | [**FileWriterSettings**](FileWriterSettings.md) | | [optional]
**detector** | [**List[Detector]**](Detector.md) | |
**detector_settings** | [**DetectorSettings**](DetectorSettings.md) | | [optional]
**azim_int** | [**AzimIntSettings**](AzimIntSettings.md) | | [optional]

1
docs/python_client/docs/JfjochStatistics.md
View File

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
**detector_settings** | [**DetectorSettings**](DetectorSettings.md) | | [optional]
**image_format_settings** | [**ImageFormatSettings**](ImageFormatSettings.md) | | [optional]
**instrument_metadata** | [**InstrumentMetadata**](InstrumentMetadata.md) | | [optional]
**file_writer_settings** | [**FileWriterSettings**](FileWriterSettings.md) | | [optional]
**data_processing_settings** | [**SpotFindingSettings**](SpotFindingSettings.md) | | [optional]
**measurement** | [**MeasurementStatistics**](MeasurementStatistics.md) | | [optional]
**broker** | [**BrokerStatus**](BrokerStatus.md) | | [optional]

4
docs/python_client/docs/MeasurementStatistics.md
View File

@@ -23,6 +23,10 @@ Name | Type | Description | Notes
**detector_pixel_depth** | **int** | | [optional]
**bkg_estimate** | **float** | | [optional]
**unit_cell** | **str** | | [optional]
**error_pixels** | **float** | Moving average of 1000 images counting number of error pixels on the detector | [optional]
**saturated_pixels** | **float** | Moving average of 1000 images counting number of saturated pixels on the detector | [optional]
**roi_beam_pixels** | **float** | If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images for number of valid pixels within this ROI | [optional]
**roi_beam_sum** | **float** | If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images for sum of valid pixels within this ROI | [optional]
## Example