generated: regenerate the API clients for the analysis mode, the grid settings and the crystal list
Output of update_version.sh. The five lanes each reverted their generated trees before handing back, so that two independently regenerated copies never had to be merged; this is the single pass that replaces them. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EFEJG6WBQv8th4UJFNe53N
This commit is contained in:
Claude Opus 5
@@ -102,16 +102,22 @@ All URIs are relative to *http://localhost:5232*
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
*DefaultApi* | [**cancel_post**](docs/DefaultApi.md#cancel_post) | **POST** /cancel | Cancel running data collection
|
||||
*DefaultApi* | [**config_analysis_get**](docs/DefaultApi.md#config_analysis_get) | **GET** /config/analysis | Get analysis configuration
|
||||
*DefaultApi* | [**config_analysis_put**](docs/DefaultApi.md#config_analysis_put) | **PUT** /config/analysis | Change analysis settings
|
||||
*DefaultApi* | [**config_azim_int_get**](docs/DefaultApi.md#config_azim_int_get) | **GET** /config/azim_int | Get azimuthal integration configuration
|
||||
*DefaultApi* | [**config_azim_int_put**](docs/DefaultApi.md#config_azim_int_put) | **PUT** /config/azim_int | Configure azimuthal integration
|
||||
*DefaultApi* | [**config_bragg_integration_get**](docs/DefaultApi.md#config_bragg_integration_get) | **GET** /config/bragg_integration | Get Bragg integration configuration
|
||||
*DefaultApi* | [**config_bragg_integration_put**](docs/DefaultApi.md#config_bragg_integration_put) | **PUT** /config/bragg_integration | Change Bragg integration settings
|
||||
*DefaultApi* | [**config_calibration_get**](docs/DefaultApi.md#config_calibration_get) | **GET** /config/calibration | Get powder calibration configuration
|
||||
*DefaultApi* | [**config_calibration_put**](docs/DefaultApi.md#config_calibration_put) | **PUT** /config/calibration | Change powder calibration settings
|
||||
*DefaultApi* | [**config_dark_mask_get**](docs/DefaultApi.md#config_dark_mask_get) | **GET** /config/dark_mask | Get settings for dark data collection to calculate mask
|
||||
*DefaultApi* | [**config_dark_mask_put**](docs/DefaultApi.md#config_dark_mask_put) | **PUT** /config/dark_mask | Set configuration for dark data collection to calculate mask
|
||||
*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_grid_scan_analysis_get**](docs/DefaultApi.md#config_grid_scan_analysis_get) | **GET** /config/grid_scan_analysis | Get grid scan analysis configuration
|
||||
*DefaultApi* | [**config_grid_scan_analysis_put**](docs/DefaultApi.md#config_grid_scan_analysis_put) | **PUT** /config/grid_scan_analysis | Change grid scan analysis 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
|
||||
@@ -169,9 +175,13 @@ Class | Method | HTTP request | Description
|
||||
|
||||
## Documentation For Models
|
||||
|
||||
- [AnalysisMode](docs/AnalysisMode.md)
|
||||
- [AnalysisSettings](docs/AnalysisSettings.md)
|
||||
- [AzimIntSettings](docs/AzimIntSettings.md)
|
||||
- [BraggIntegrationSettings](docs/BraggIntegrationSettings.md)
|
||||
- [BrokerStatus](docs/BrokerStatus.md)
|
||||
- [CalibrationMethod](docs/CalibrationMethod.md)
|
||||
- [CalibrationSettings](docs/CalibrationSettings.md)
|
||||
- [CalibrationStatisticsInner](docs/CalibrationStatisticsInner.md)
|
||||
- [DarkMaskSettings](docs/DarkMaskSettings.md)
|
||||
- [DatasetSettings](docs/DatasetSettings.md)
|
||||
@@ -195,6 +205,9 @@ Class | Method | HTTP request | Description
|
||||
- [FpgaStatusInner](docs/FpgaStatusInner.md)
|
||||
- [GeomRefinementAlgorithm](docs/GeomRefinementAlgorithm.md)
|
||||
- [GridScan](docs/GridScan.md)
|
||||
- [GridScanAnalysisSettings](docs/GridScanAnalysisSettings.md)
|
||||
- [GridScanCrystal](docs/GridScanCrystal.md)
|
||||
- [GridScanResult](docs/GridScanResult.md)
|
||||
- [ImageBufferStatus](docs/ImageBufferStatus.md)
|
||||
- [ImageFormatSettings](docs/ImageFormatSettings.md)
|
||||
- [ImagePusherStatus](docs/ImagePusherStatus.md)
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# AnalysisMode
|
||||
|
||||
What analysis jfjoch_broker runs over the images. One setting replaces the several independent switches - spot finding on/off in two places, indexing on/off, rotation on/off - that used to be composed at each site into an answer nobody had written down. None - images are received, written and streamed; nothing is analysed. MXStills - spot finding, per-image indexing, refinement and integration. The default, and what an out-of-the-box broker has always done. Azint - azimuthal integration only; no spots are found. Grid - grid scan: per-image scoring and crystal selection. PowderCalibration - detector geometry from a calibrant's powder rings. Forces azimuthal integration onto the CPU, since the FPGA core cannot hold enough bins for the sectored profile a ring fit needs; a calibration exposure is a few images at a few Hz, so the cost does not matter. Rotation MX analysis is deliberately absent: jfjoch_broker has no rotation analysis path, so this API cannot express it. Rotation data is collected here and processed offline with rugnux.
|
||||
|
||||
## Enum
|
||||
|
||||
* `NONE` (value: `'None'`)
|
||||
|
||||
* `MXSTILLS` (value: `'MXStills'`)
|
||||
|
||||
* `AZINT` (value: `'Azint'`)
|
||||
|
||||
* `GRID` (value: `'Grid'`)
|
||||
|
||||
* `POWDERCALIBRATION` (value: `'PowderCalibration'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# AnalysisSettings
|
||||
|
||||
What every analysis method shares, and nothing else. Each method's own parameters have their own settings object and their own endpoint - grid_scan_analysis_settings (/config/grid_scan_analysis), calibration_settings (/config/calibration) - so that adding a parameter to one method does not widen the structure every method reads. Persistent: it survives a data collection, unlike the per-dataset settings given to /start.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**mode** | [**AnalysisMode**](AnalysisMode.md) | | [default to AnalysisMode.MXSTILLS]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from jfjoch_client.models.analysis_settings import AnalysisSettings
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AnalysisSettings from a JSON string
|
||||
analysis_settings_instance = AnalysisSettings.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AnalysisSettings.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
analysis_settings_dict = analysis_settings_instance.to_dict()
|
||||
# create an instance of AnalysisSettings from a dict
|
||||
analysis_settings_from_dict = AnalysisSettings.from_dict(analysis_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# CalibrationMethod
|
||||
|
||||
How the powder rings the detector geometry is fitted to are measured. Rings - the run-summed (q x azimuth) azimuthal profile: the ring measured at every azimuth. Spots - the pooled per-image spot lists: the ring sampled wherever the spot finder bit.
|
||||
|
||||
## Enum
|
||||
|
||||
* `RINGS` (value: `'Rings'`)
|
||||
|
||||
* `SPOTS` (value: `'Spots'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# CalibrationSettings
|
||||
|
||||
Settings for analysis mode PowderCalibration and nothing else. Selecting that mode also moves azimuthal integration onto the CPU and, where fewer than four azimuthal sectors were asked for, sets a usable count. Ring positions are read off a (q x azimuth) profile, and the FPGA integration core holds 2048 bins in total - at 32 sectors that leaves 64 q bins, far too coarse to locate a ring. The frame rate this costs is not frame rate a calibration exposure needs.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**calibrant** | **str** | Which calibrant's ring d-spacings the geometry is fitted against. Empty selects the processing program's own default rather than meaning \"no calibrant\". | [optional]
|
||||
**method** | [**CalibrationMethod**](CalibrationMethod.md) | | [default to CalibrationMethod.RINGS]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from jfjoch_client.models.calibration_settings import CalibrationSettings
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CalibrationSettings from a JSON string
|
||||
calibration_settings_instance = CalibrationSettings.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(CalibrationSettings.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
calibration_settings_dict = calibration_settings_instance.to_dict()
|
||||
# create an instance of CalibrationSettings from a dict
|
||||
calibration_settings_from_dict = CalibrationSettings.from_dict(calibration_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)
|
||||
|
||||
|
||||
@@ -40,7 +40,7 @@ Name | Type | Description | Notes
|
||||
**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** | [**UnitCell**](UnitCell.md) | | [optional]
|
||||
**spot_finding** | **bool** | Enable spot finding and save spots | [optional] [default to True]
|
||||
**spot_finding** | **bool** | Enable spot finding and save spots. DEPRECATED - use the analysis mode instead (/config/analysis). The mode takes precedence: a mode that analyses no spots (None, Azint, PowderCalibration) switches spot finding off whatever this says, and under a mode that does find spots this remains a finer control that can still turn it off. It is kept while callers move over. | [optional] [default to True]
|
||||
**smargon** | [**DatasetSettingsSmargon**](DatasetSettingsSmargon.md) | | [optional]
|
||||
**max_spot_count** | **int** | Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected | [optional] [default to 250]
|
||||
**detect_ice_rings** | **bool** | Flag spots as ice rings and reduce their effect on indexing | [optional]
|
||||
|
||||
@@ -5,16 +5,22 @@ All URIs are relative to *http://localhost:5232*
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**cancel_post**](DefaultApi.md#cancel_post) | **POST** /cancel | Cancel running data collection
|
||||
[**config_analysis_get**](DefaultApi.md#config_analysis_get) | **GET** /config/analysis | Get analysis configuration
|
||||
[**config_analysis_put**](DefaultApi.md#config_analysis_put) | **PUT** /config/analysis | Change analysis settings
|
||||
[**config_azim_int_get**](DefaultApi.md#config_azim_int_get) | **GET** /config/azim_int | Get azimuthal integration configuration
|
||||
[**config_azim_int_put**](DefaultApi.md#config_azim_int_put) | **PUT** /config/azim_int | Configure azimuthal integration
|
||||
[**config_bragg_integration_get**](DefaultApi.md#config_bragg_integration_get) | **GET** /config/bragg_integration | Get Bragg integration configuration
|
||||
[**config_bragg_integration_put**](DefaultApi.md#config_bragg_integration_put) | **PUT** /config/bragg_integration | Change Bragg integration settings
|
||||
[**config_calibration_get**](DefaultApi.md#config_calibration_get) | **GET** /config/calibration | Get powder calibration configuration
|
||||
[**config_calibration_put**](DefaultApi.md#config_calibration_put) | **PUT** /config/calibration | Change powder calibration settings
|
||||
[**config_dark_mask_get**](DefaultApi.md#config_dark_mask_get) | **GET** /config/dark_mask | Get settings for dark data collection to calculate mask
|
||||
[**config_dark_mask_put**](DefaultApi.md#config_dark_mask_put) | **PUT** /config/dark_mask | Set configuration for dark data collection to calculate mask
|
||||
[**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_grid_scan_analysis_get**](DefaultApi.md#config_grid_scan_analysis_get) | **GET** /config/grid_scan_analysis | Get grid scan analysis configuration
|
||||
[**config_grid_scan_analysis_put**](DefaultApi.md#config_grid_scan_analysis_put) | **PUT** /config/grid_scan_analysis | Change grid scan analysis 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
|
||||
@@ -136,6 +142,140 @@ 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_analysis_get**
|
||||
> AnalysisSettings config_analysis_get()
|
||||
|
||||
Get analysis configuration
|
||||
|
||||
Can be done anytime
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import jfjoch_client
|
||||
from jfjoch_client.models.analysis_settings import AnalysisSettings
|
||||
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 analysis configuration
|
||||
api_response = api_instance.config_analysis_get()
|
||||
print("The response of DefaultApi->config_analysis_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling DefaultApi->config_analysis_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**AnalysisSettings**](AnalysisSettings.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_analysis_put**
|
||||
> config_analysis_put(analysis_settings=analysis_settings)
|
||||
|
||||
Change analysis settings
|
||||
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
The mode is persistent - it is not reset by a data collection.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import jfjoch_client
|
||||
from jfjoch_client.models.analysis_settings import AnalysisSettings
|
||||
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)
|
||||
analysis_settings = jfjoch_client.AnalysisSettings() # AnalysisSettings | (optional)
|
||||
|
||||
try:
|
||||
# Change analysis settings
|
||||
api_instance.config_analysis_put(analysis_settings=analysis_settings)
|
||||
except Exception as e:
|
||||
print("Exception when calling DefaultApi->config_analysis_put: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**analysis_settings** | [**AnalysisSettings**](AnalysisSettings.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_azim_int_get**
|
||||
> AzimIntSettings config_azim_int_get()
|
||||
|
||||
@@ -401,6 +541,140 @@ 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_calibration_get**
|
||||
> CalibrationSettings config_calibration_get()
|
||||
|
||||
Get powder calibration configuration
|
||||
|
||||
Can be done anytime
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import jfjoch_client
|
||||
from jfjoch_client.models.calibration_settings import CalibrationSettings
|
||||
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 powder calibration configuration
|
||||
api_response = api_instance.config_calibration_get()
|
||||
print("The response of DefaultApi->config_calibration_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling DefaultApi->config_calibration_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**CalibrationSettings**](CalibrationSettings.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_calibration_put**
|
||||
> config_calibration_put(calibration_settings=calibration_settings)
|
||||
|
||||
Change powder calibration settings
|
||||
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
Persistent - not reset by a data collection.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import jfjoch_client
|
||||
from jfjoch_client.models.calibration_settings import CalibrationSettings
|
||||
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)
|
||||
calibration_settings = jfjoch_client.CalibrationSettings() # CalibrationSettings | (optional)
|
||||
|
||||
try:
|
||||
# Change powder calibration settings
|
||||
api_instance.config_calibration_put(calibration_settings=calibration_settings)
|
||||
except Exception as e:
|
||||
print("Exception when calling DefaultApi->config_calibration_put: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**calibration_settings** | [**CalibrationSettings**](CalibrationSettings.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_dark_mask_get**
|
||||
> DarkMaskSettings config_dark_mask_get()
|
||||
|
||||
@@ -802,6 +1076,140 @@ 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_grid_scan_analysis_get**
|
||||
> GridScanAnalysisSettings config_grid_scan_analysis_get()
|
||||
|
||||
Get grid scan analysis configuration
|
||||
|
||||
Can be done anytime
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import jfjoch_client
|
||||
from jfjoch_client.models.grid_scan_analysis_settings import GridScanAnalysisSettings
|
||||
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 analysis configuration
|
||||
api_response = api_instance.config_grid_scan_analysis_get()
|
||||
print("The response of DefaultApi->config_grid_scan_analysis_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling DefaultApi->config_grid_scan_analysis_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**GridScanAnalysisSettings**](GridScanAnalysisSettings.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_grid_scan_analysis_put**
|
||||
> config_grid_scan_analysis_put(grid_scan_analysis_settings=grid_scan_analysis_settings)
|
||||
|
||||
Change grid scan analysis settings
|
||||
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
Persistent - not reset by a data collection.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import jfjoch_client
|
||||
from jfjoch_client.models.grid_scan_analysis_settings import GridScanAnalysisSettings
|
||||
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)
|
||||
grid_scan_analysis_settings = jfjoch_client.GridScanAnalysisSettings() # GridScanAnalysisSettings | (optional)
|
||||
|
||||
try:
|
||||
# Change grid scan analysis settings
|
||||
api_instance.config_grid_scan_analysis_put(grid_scan_analysis_settings=grid_scan_analysis_settings)
|
||||
except Exception as e:
|
||||
print("Exception when calling DefaultApi->config_grid_scan_analysis_put: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**grid_scan_analysis_settings** | [**GridScanAnalysisSettings**](GridScanAnalysisSettings.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()
|
||||
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
# GridScanAnalysisSettings
|
||||
|
||||
Settings for analysis mode Grid and nothing else: how the per-image protein score is turned into a list of crystals, and whether the raster indexes as well as scores.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**protein_score_threshold** | **float** | A raster cell counts as protein above this. The per-image protein score saturates, so this only has to separate \"something diffracted here\" from \"nothing did\". | [default to 0.5]
|
||||
**min_blob_cells** | **int** | How many cells above that threshold make a shape rather than a coincidence. Two cells can be the two ends of a single hit lying on a cell boundary; three is the smallest patch that is not. | [default to 3]
|
||||
**decisive_single_cell_score** | **float** | ...unless one cell on its own is decisive. The rule above is about coincidences, and a lone cell scoring near the top of a saturating score is not one - a crystal smaller than the grid step lights exactly one cell, and refusing it would lose precisely the samples a fine raster is run to find. Set well above protein_score_threshold: this admits the obvious case, it does not lower the general threshold by the back door. | [default to 0.9]
|
||||
**max_crystals** | **int** | Most crystals reported. A raster over a loop full of shards can label dozens of blobs, and past the first few the list is no longer a ranking anyone acts on. Crystals are sorted by score, so this keeps the best. | [default to 10]
|
||||
**indexing** | **bool** | Whether each raster cell is indexed as well as scored. On by default: a raster runs at up to 100 Hz, which the FFT indexer keeps up with, and it is additive - blobs are still found on the protein score, so indexing changes nothing about which cells are called crystals and only adds what was found in them. The lattice count per cell is the cheapest multi-lattice or cracked-crystal signal there is, and on a fixed-target serial experiment with a known cell a raster that indexes is most of the measurement. Turn it off for a very large raster where the GPU is the constraint. | [default to True]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from jfjoch_client.models.grid_scan_analysis_settings import GridScanAnalysisSettings
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of GridScanAnalysisSettings from a JSON string
|
||||
grid_scan_analysis_settings_instance = GridScanAnalysisSettings.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(GridScanAnalysisSettings.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
grid_scan_analysis_settings_dict = grid_scan_analysis_settings_instance.to_dict()
|
||||
# create an instance of GridScanAnalysisSettings from a dict
|
||||
grid_scan_analysis_settings_from_dict = GridScanAnalysisSettings.from_dict(grid_scan_analysis_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
# GridScanCrystal
|
||||
|
||||
One crystal found in a grid scan.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**nx** | **float** | Centre, fractional grid coordinate along the fast grid axis |
|
||||
**ny** | **float** | Centre, fractional grid coordinate along the slow grid axis |
|
||||
**x_um** | **float** | Centre, signed offset along the fast grid axis, in micrometres | [optional]
|
||||
**y_um** | **float** | Centre, signed offset along the slow grid axis, in micrometres | [optional]
|
||||
**image_number** | **int** | The grid point at the centre, as an image ordinal | [optional]
|
||||
**major_um** | **float** | Extent along the crystal's major principal axis, in micrometres | [optional]
|
||||
**minor_um** | **float** | Extent along its minor principal axis, in micrometres | [optional]
|
||||
**angle_deg** | **float** | Direction of the major axis from the +x grid axis, counter-clockwise, in degrees. This is an AXIS, not a direction: it lives in [0, 180) and wraps, so 179 and 0 are adjacent. Averaging two of these arithmetically across the wrap turns two nearly parallel needles into a right angle - combine them on the doubled angle (mean of 2*theta, halved), or not at all. | [optional]
|
||||
**score** | **float** | Diffraction score the crystal was ranked on |
|
||||
**ice_score** | **float** | Ice-ring score over the crystal's grid points | [optional]
|
||||
**res_a** | **float** | Resolution estimate over the crystal's grid points, in Angstrom | [optional]
|
||||
**n_images** | **int** | Grid points that fell in this crystal | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from jfjoch_client.models.grid_scan_crystal import GridScanCrystal
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of GridScanCrystal from a JSON string
|
||||
grid_scan_crystal_instance = GridScanCrystal.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(GridScanCrystal.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
grid_scan_crystal_dict = grid_scan_crystal_instance.to_dict()
|
||||
# create an instance of GridScanCrystal from a dict
|
||||
grid_scan_crystal_from_dict = GridScanCrystal.from_dict(grid_scan_crystal_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
# GridScanResult
|
||||
|
||||
What a grid scan found. The list is sorted by score, best first, and may hold any number of crystals - a consumer must not assume at most one.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**crystals** | [**List[GridScanCrystal]**](GridScanCrystal.md) | |
|
||||
**beam_size_x_um** | **float** | The beam the crystal extents were measured with, along the fast grid axis. Those extents still contain it, so this says what a consumer has to take back out. | [optional]
|
||||
**beam_size_y_um** | **float** | The same along the slow grid axis | [optional]
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
@@ -14,6 +14,9 @@ Name | Type | Description | Notes
|
||||
**detector** | [**List[Detector]**](Detector.md) | |
|
||||
**indexing** | [**IndexingSettings**](IndexingSettings.md) | | [optional]
|
||||
**bragg_integration** | [**BraggIntegrationSettings**](BraggIntegrationSettings.md) | | [optional]
|
||||
**analysis** | [**AnalysisSettings**](AnalysisSettings.md) | | [optional]
|
||||
**grid_scan_analysis** | [**GridScanAnalysisSettings**](GridScanAnalysisSettings.md) | | [optional]
|
||||
**calibration_settings** | [**CalibrationSettings**](CalibrationSettings.md) | | [optional]
|
||||
**detector_settings** | [**DetectorSettings**](DetectorSettings.md) | | [optional]
|
||||
**azim_int** | [**AzimIntSettings**](AzimIntSettings.md) | | [optional]
|
||||
**image_format** | [**ImageFormatSettings**](ImageFormatSettings.md) | | [optional]
|
||||
|
||||
@@ -26,6 +26,9 @@ Name | Type | Description | Notes
|
||||
**buffer** | [**ImageBufferStatus**](ImageBufferStatus.md) | | [optional]
|
||||
**indexing** | [**IndexingSettings**](IndexingSettings.md) | | [optional]
|
||||
**bragg_integration** | [**BraggIntegrationSettings**](BraggIntegrationSettings.md) | | [optional]
|
||||
**analysis** | [**AnalysisSettings**](AnalysisSettings.md) | | [optional]
|
||||
**grid_scan_analysis** | [**GridScanAnalysisSettings**](GridScanAnalysisSettings.md) | | [optional]
|
||||
**calibration_settings** | [**CalibrationSettings**](CalibrationSettings.md) | | [optional]
|
||||
**image_pusher** | [**ImagePusherStatus**](ImagePusherStatus.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
@@ -10,6 +10,8 @@ Name | Type | Description | Notes
|
||||
**rotation_unit_cell** | [**UnitCell**](UnitCell.md) | | [optional]
|
||||
**rotation_crystal_lattice** | **List[float]** | Real-space crystal lattice 3D vectors in Angstrom. Order is 1st vector (x,y,z), 2nd vector (x,y,z) and 3rd vector (x,y,z) | [optional]
|
||||
**rotation_bravais** | **str** | Bravais lattice type of the global rotation-indexing solution: crystal-system letter + centering, e.g. \"tP\", \"oC\", \"cF\", \"hR\", \"mP\". Empty if not determined. | [optional]
|
||||
**grid** | [**GridScanResult**](GridScanResult.md) | | [optional]
|
||||
**calibration** | [**PowderCalibrationOutput**](PowderCalibrationOutput.md) | | [optional]
|
||||
**images** | [**List[ScanResultImagesInner]**](ScanResultImagesInner.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -17,6 +17,8 @@ Name | Type | Description | Notes
|
||||
**spots_indexed** | **int** | Spot count within indexing tolerance | [optional]
|
||||
**spots_ice** | **int** | Spot count within common ice ring resolutions | [optional]
|
||||
**ice** | **float** | Strongest hexagonal-ice ring intensity over the smooth radial background (1 = no ice) | [optional]
|
||||
**protein_score** | **float** | Protein diffraction detection score (0 = none, 1 = certain); saturating, not a quality measure | [optional]
|
||||
**ice_score** | **float** | Crystalline ice detection score (0 = none, 1 = certain); saturating, not a quality measure | [optional]
|
||||
**index** | **int** | Indexing solution | [optional]
|
||||
**latt_count** | **int** | Indexing lattice count | [optional]
|
||||
**pr** | **float** | Profile radius, i.e. how far reflections are from the Ewald sphere | [optional]
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enable** | **bool** | Enable spot finding. This is temporary setting, i.e. can be changed anytime during data collection. Even if disabled spot finding information will still be send and written, though always with zero spots. | [default to True]
|
||||
**enable** | **bool** | Enable spot finding. This is temporary setting, i.e. can be changed anytime during data collection. Even if disabled spot finding information will still be send and written, though always with zero spots. DEPRECATED - use the analysis mode instead (/config/analysis). The mode takes precedence: a mode that analyses no spots (None, Azint, PowderCalibration) switches spot finding off whatever this says, and under a mode that does find spots this remains a finer control that can still turn it off. It is kept while callers move over. | [default to True]
|
||||
**indexing** | **bool** | Enable indexing. This is temporary setting, i.e. can be changed anytime during data collection. | [default to True]
|
||||
**signal_to_noise_threshold** | **float** | |
|
||||
**photon_count_threshold** | **int** | |
|
||||
|
||||
Reference in New Issue
Block a user