v1.0.0-rc.44

This commit is contained in:
2025-06-15 17:46:46 +02:00
parent 50fd15c678
commit b59a03ff02
180 changed files with 1531 additions and 1779 deletions

View File

@@ -50,7 +50,7 @@ Method | HTTP request | Description
[**pedestal_post**](DefaultApi.md#pedestal_post) | **POST** /pedestal | Collect dark current for the detector
[**preview_pedestal_tiff_get**](DefaultApi.md#preview_pedestal_tiff_get) | **GET** /preview/pedestal.tiff | Get pedestal in TIFF format
[**preview_plot_get**](DefaultApi.md#preview_plot_get) | **GET** /preview/plot | Generate 1D plot from Jungfraujoch
[**result_grid_scan_get**](DefaultApi.md#result_grid_scan_get) | **GET** /result/grid_scan | Get grid scan result
[**result_scan_get**](DefaultApi.md#result_scan_get) | **GET** /result/scan | Get full scan result
[**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
@@ -3077,17 +3077,17 @@ 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)
# **result_grid_scan_get**
> GridScanResult result_grid_scan_get()
# **result_scan_get**
> ScanResult result_scan_get()
Get grid scan result
Get full scan result
### Example
```python
import jfjoch_client
from jfjoch_client.models.grid_scan_result import GridScanResult
from jfjoch_client.models.scan_result import ScanResult
from jfjoch_client.rest import ApiException
from pprint import pprint
@@ -3104,12 +3104,12 @@ with jfjoch_client.ApiClient(configuration) as api_client:
api_instance = jfjoch_client.DefaultApi(api_client)
try:
# Get grid scan result
api_response = api_instance.result_grid_scan_get()
print("The response of DefaultApi->result_grid_scan_get:\n")
# Get full scan result
api_response = api_instance.result_scan_get()
print("The response of DefaultApi->result_scan_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->result_grid_scan_get: %s\n" % e)
print("Exception when calling DefaultApi->result_scan_get: %s\n" % e)
```
@@ -3120,7 +3120,7 @@ This endpoint does not need any parameter.
### Return type
[**GridScanResult**](GridScanResult.md)
[**ScanResult**](ScanResult.md)
### Authorization
@@ -3137,6 +3137,7 @@ No authorization required
|-------------|-------------|------------------|
**200** | Everything OK. | - |
**404** | No grid scan recorded | - |
**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)