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

v1.0.0-rc.44

Browse Source
This commit is contained in:
leonarski_f
2025-06-15 17:46:46 +02:00
parent 50fd15c678
commit b59a03ff02
180 changed files with 1531 additions and 1779 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -35,7 +35,7 @@ Name | Type | Description | Notes
**poni_rot1_rad** | **float** | PONI angle rot1 (see PyFAI documentation for details) in radians | [optional] [default to 0.0]
**poni_rot2_rad** | **float** | PONI angle rot2 (see PyFAI documentation for details) in radians | [optional] [default to 0.0]
**poni_rot3_rad** | **float** | PONI angle rot3 (see PyFAI documentation for details) in radians | [optional] [default to 0.0]
**unit_cell** | [**DatasetSettingsUnitCell**](DatasetSettingsUnitCell.md) | | [optional]
**unit_cell** | [**UnitCell**](UnitCell.md) | | [optional]
## Example

21
docs/python_client/docs/DefaultApi.md
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)

3
docs/python_client/docs/DetectorListDetectorsInner.md
View File

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

10
docs/python_client/docs/GridScanResult.md
View File

@@ -6,17 +6,13 @@ Results of a grid scan
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]** | |
**file_prefix** | **str** | | [optional]
**images** | [**List[GridScanResultImagesInner]**](GridScanResultImagesInner.md) | |
## Example
```python
from jfjoch_client.models.grid_scan_result import GridScanResult
from jfjoch_client.models.scan_result import GridScanResult
# TODO update the JSON string below
json = "{}"

36
docs/python_client/docs/GridScanResultImagesInner.md Normal file
View File

@@ -0,0 +1,36 @@
# GridScanResultImagesInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**efficiency** | **float** | |
**number** | **int** | Detector image number for a given cell |
**bkg** | **float** | Background estimate | [optional]
**spots** | **int** | Spot count | [optional]
**index** | **int** | Indexing solution | [optional]
**mos** | **float** | Mosaicity estimate | [optional]
**b** | **float** | B-Factor estimate | [optional]
**uc** | [**UnitCell**](UnitCell.md) | | [optional]
## Example
```python
from jfjoch_client.models.grid_scan_result_images_inner import GridScanResultImagesInner
# TODO update the JSON string below
json = "{}"
# create an instance of GridScanResultImagesInner from a JSON string
grid_scan_result_images_inner_instance = GridScanResultImagesInner.from_json(json)
# print the JSON string representation of the object
print(GridScanResultImagesInner.to_json())
# convert the object into a dict
grid_scan_result_images_inner_dict = grid_scan_result_images_inner_instance.to_dict()
# create an instance of GridScanResultImagesInner from a dict
grid_scan_result_images_inner_from_dict = GridScanResultImagesInner.from_dict(grid_scan_result_images_inner_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)

48
docs/python_client/docs/PlotTypeEnum.md
View File

@@ -1,48 +0,0 @@
# PlotTypeEnum
## Enum
* `BKG_ESTIMATE` (value: `'bkg_estimate'`)
* `AZINT` (value: `'azint'`)
* `SPOT_COUNT` (value: `'spot_count'`)
* `INDEXING_RATE` (value: `'indexing_rate'`)
* `INDEXING_UNIT_CELL_LENGTH` (value: `'indexing_unit_cell_length'`)
* `INDEXING_UNIT_CELL_ANGLE` (value: `'indexing_unit_cell_angle'`)
* `ERROR_PIXELS` (value: `'error_pixels'`)
* `IMAGE_COLLECTION_EFFICIENCY` (value: `'image_collection_efficiency'`)
* `RECEIVER_DELAY` (value: `'receiver_delay'`)
* `RECEIVER_FREE_SEND_BUF` (value: `'receiver_free_send_buf'`)
* `STRONG_PIXELS` (value: `'strong_pixels'`)
* `ROI_SUM` (value: `'roi_sum'`)
* `ROI_MEAN` (value: `'roi_mean'`)
* `ROI_MAX_COUNT` (value: `'roi_max_count'`)
* `ROI_PIXELS` (value: `'roi_pixels'`)
* `ROI_WEIGHTED_X` (value: `'roi_weighted_x'`)
* `ROI_WEIGHTED_Y` (value: `'roi_weighted_y'`)
* `PACKETS_RECEIVED` (value: `'packets_received'`)
* `MAX_PIXEL_VALUE` (value: `'max_pixel_value'`)
* `RESOLUTION_ESTIMATE` (value: `'resolution_estimate'`)
[[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/PreviewSettings.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

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

@@ -0,0 +1,31 @@
# ScanResult
Results of a grid scan
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**file_prefix** | **str** | | [optional]
**images** | [**List[ScanResultImagesInner]**](ScanResultImagesInner.md) | |
## Example
```python
from jfjoch_client.models.scan_result import ScanResult
# TODO update the JSON string below
json = "{}"
# create an instance of ScanResult from a JSON string
scan_result_instance = ScanResult.from_json(json)
# print the JSON string representation of the object
print(ScanResult.to_json())
# convert the object into a dict
scan_result_dict = scan_result_instance.to_dict()
# create an instance of ScanResult from a dict
scan_result_from_dict = ScanResult.from_dict(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)

41
docs/python_client/docs/ScanResultImagesInner.md Normal file
View File

@@ -0,0 +1,41 @@
# ScanResultImagesInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**efficiency** | **float** | |
**number** | **int** | Detector image number for a given cell |
**bkg** | **float** | Background estimate | [optional]
**spots** | **int** | Spot count | [optional]
**index** | **int** | Indexing solution | [optional]
**mos** | **float** | Mosaicity estimate | [optional]
**b** | **float** | B-Factor estimate | [optional]
**uc** | [**UnitCell**](UnitCell.md) | | [optional]
**xfel_pulseid** | **int** | XFEL pulse ID | [optional]
**pixel_sum** | **int** | Total sum of all pixels | [optional]
**max** | **int** | Max viable pixel | [optional]
**sat** | **int** | Number of saturated pixels | [optional]
**err** | **int** | Number of error pixels | [optional]
## Example
```python
from jfjoch_client.models.scan_result_images_inner import ScanResultImagesInner
# TODO update the JSON string below
json = "{}"
# create an instance of ScanResultImagesInner from a JSON string
scan_result_images_inner_instance = ScanResultImagesInner.from_json(json)
# print the JSON string representation of the object
print(ScanResultImagesInner.to_json())
# convert the object into a dict
scan_result_images_inner_dict = scan_result_images_inner_instance.to_dict()
# create an instance of ScanResultImagesInner from a dict
scan_result_images_inner_from_dict = ScanResultImagesInner.from_dict(scan_result_images_inner_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)

35
docs/python_client/docs/UnitCell.md Normal file
View File

@@ -0,0 +1,35 @@
# UnitCell
Unit cell parameters. Necessary to run indexing. Units of angstrom and degree
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**a** | **float** | |
**b** | **float** | |
**c** | **float** | |
**alpha** | **float** | |
**beta** | **float** | |
**gamma** | **float** | |
## Example
```python
from jfjoch_client.models.unit_cell import UnitCell
# TODO update the JSON string below
json = "{}"
# create an instance of UnitCell from a JSON string
unit_cell_instance = UnitCell.from_json(json)
# print the JSON string representation of the object
print(UnitCell.to_json())
# convert the object into a dict
unit_cell_dict = unit_cell_instance.to_dict()
# create an instance of UnitCell from a dict
unit_cell_from_dict = UnitCell.from_dict(unit_cell_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)