patch to 1.0.0-rc.36

This commit is contained in:
2025-05-07 16:24:35 +02:00
parent 2533499acc
commit 29ecd3515a
151 changed files with 492 additions and 198 deletions

View File

@@ -27,9 +27,9 @@ Method | HTTP request | Description
[**config_select_detector_put**](DefaultApi.md#config_select_detector_put) | **PUT** /config/select_detector | Select detector
[**config_spot_finding_get**](DefaultApi.md#config_spot_finding_get) | **GET** /config/spot_finding | Get data processing configuration
[**config_spot_finding_put**](DefaultApi.md#config_spot_finding_put) | **PUT** /config/spot_finding | Configure spot finding
[**config_user_mask_get**](DefaultApi.md#config_user_mask_get) | **GET** /config/user_mask | Get user mask of the detector (binary)
[**config_user_mask_get**](DefaultApi.md#config_user_mask_get) | **GET** /config/user_mask | Detector must be Initialized. Get user mask of the detector (binary)
[**config_user_mask_put**](DefaultApi.md#config_user_mask_put) | **PUT** /config/user_mask | Upload user mask of the detector (binary)
[**config_user_mask_tiff_get**](DefaultApi.md#config_user_mask_tiff_get) | **GET** /config/user_mask.tiff | Get user mask of the detector (TIFF)
[**config_user_mask_tiff_get**](DefaultApi.md#config_user_mask_tiff_get) | **GET** /config/user_mask.tiff | Detector must be Initialized. Get user mask of the detector (TIFF)
[**config_user_mask_tiff_put**](DefaultApi.md#config_user_mask_tiff_put) | **PUT** /config/user_mask.tiff | Upload user mask of the detector
[**config_zeromq_metadata_get**](DefaultApi.md#config_zeromq_metadata_get) | **GET** /config/zeromq_metadata | Get ZeroMQ metadata socket settings
[**config_zeromq_metadata_put**](DefaultApi.md#config_zeromq_metadata_put) | **PUT** /config/zeromq_metadata | Set ZeroMQ metadata settings
@@ -1065,7 +1065,7 @@ No authorization required
Get mask of the detector (binary)
Get full pixel mask of the detector See NXmx standard for meaning of pixel values
Detector must be Initialized. Get full pixel mask of the detector. See NXmx standard for meaning of pixel values.
### Example
@@ -1128,7 +1128,7 @@ No authorization required
Get mask of the detector (TIFF)
Get full pixel mask of the detector See NXmx standard for meaning of pixel values
Should be in `Idle` state. Get full pixel mask of the detector See NXmx standard for meaning of pixel values
### Example
@@ -1580,7 +1580,7 @@ No authorization required
# **config_user_mask_get**
> bytearray config_user_mask_get()
Get user mask of the detector (binary)
Detector must be Initialized. Get user mask of the detector (binary)
Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked
@@ -1605,7 +1605,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
api_instance = jfjoch_client.DefaultApi(api_client)
try:
# Get user mask of the detector (binary)
# Detector must be Initialized. Get user mask of the detector (binary)
api_response = api_instance.config_user_mask_get()
print("The response of DefaultApi->config_user_mask_get:\n")
pprint(api_response)
@@ -1709,7 +1709,7 @@ No authorization required
# **config_user_mask_tiff_get**
> bytearray config_user_mask_tiff_get()
Get user mask of the detector (TIFF)
Detector must be Initialized. Get user mask of the detector (TIFF)
Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked
@@ -1734,7 +1734,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
api_instance = jfjoch_client.DefaultApi(api_client)
try:
# Get user mask of the detector (TIFF)
# Detector must be Initialized. Get user mask of the detector (TIFF)
api_response = api_instance.config_user_mask_tiff_get()
print("The response of DefaultApi->config_user_mask_tiff_get:\n")
pprint(api_response)

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

@@ -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