v1.0.0-rc.43

This commit is contained in:
2025-06-13 16:00:50 +02:00
parent 32c9e6926e
commit 80251cc5b8
154 changed files with 912 additions and 148 deletions

View File

@@ -50,6 +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
[**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
@@ -3076,6 +3077,69 @@ 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()
Get grid scan result
### Example
```python
import jfjoch_client
from jfjoch_client.models.grid_scan_result import GridScanResult
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 grid scan result
api_response = api_instance.result_grid_scan_get()
print("The response of DefaultApi->result_grid_scan_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->result_grid_scan_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**GridScanResult**](GridScanResult.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. | - |
**404** | No grid scan recorded | - |
[[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)

View File

@@ -13,9 +13,6 @@ 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

View File

@@ -0,0 +1,35 @@
# GridScanResult
Results of a grid scan
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**det_img** | **List[int]** | Detector image number for a given cell |
**bkg_estimate** | **List[float]** | |
**spot_count** | **List[int]** | |
**indexed_lattices** | **List[int]** | |
**mosaicity** | **List[float]** | |
**b_factor** | **List[float]** | |
## Example
```python
from jfjoch_client.models.grid_scan_result import GridScanResult
# TODO update the JSON string below
json = "{}"
# create an instance of GridScanResult from a JSON string
grid_scan_result_instance = GridScanResult.from_json(json)
# print the JSON string representation of the object
print(GridScanResult.to_json())
# convert the object into a dict
grid_scan_result_dict = grid_scan_result_instance.to_dict()
# create an instance of GridScanResult from a dict
grid_scan_result_from_dict = GridScanResult.from_dict(grid_scan_result_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)

View File

@@ -10,9 +10,9 @@ Name | Type | Description | Notes
**show_spots** | **bool** | Show spot finding results on the image | [optional] [default to True]
**show_roi** | **bool** | Show ROI areas on the image | [optional] [default to False]
**jpeg_quality** | **int** | Quality of JPEG image (100 - highest; 0 - lowest) | [optional] [default to 100]
**show_indexed** | **bool** | Preview indexed images only | [optional] [default to False]
**show_user_mask** | **bool** | Show user mask | [optional] [default to False]
**resolution_ring** | **float** | | [optional] [default to 0.1]
**scale** | [**ColorScale**](ColorScale.md) | | [optional] [default to ColorScale.INDIGO]
## Example