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

VERSION: 1.0.0-rc.157

Browse Source
This commit is contained in:
leonarski_f
2026-07-08 20:29:08 +02:00
parent 023a30cb08
commit 1b5ffb4337
139 changed files with 280 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/python_client/README.md
+6 -2
View File
@@ -22,8 +22,8 @@ communicate through network calls or other mechanisms.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0-rc.156
- Package version: 1.0.0-rc.156
- API version: 1.0.0-rc.157
- Package version: 1.0.0-rc.157
- Generator version: 7.20.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
@@ -104,6 +104,8 @@ Class | Method | HTTP request | Description
*DefaultApi* | [**cancel_post**](docs/DefaultApi.md#cancel_post) | **POST** /cancel | Cancel running data collection
*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_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
@@ -168,6 +170,7 @@ Class | Method | HTTP request | Description
## Documentation For Models
- [AzimIntSettings](docs/AzimIntSettings.md)
- [BraggIntegrationSettings](docs/BraggIntegrationSettings.md)
- [BrokerStatus](docs/BrokerStatus.md)
- [CalibrationStatisticsInner](docs/CalibrationStatisticsInner.md)
- [DarkMaskSettings](docs/DarkMaskSettings.md)
@@ -199,6 +202,7 @@ Class | Method | HTTP request | Description
- [IndexingAlgorithm](docs/IndexingAlgorithm.md)
- [IndexingSettings](docs/IndexingSettings.md)
- [InstrumentMetadata](docs/InstrumentMetadata.md)
- [IntegrationModel](docs/IntegrationModel.md)
- [JfjochSettings](docs/JfjochSettings.md)
- [JfjochStatistics](docs/JfjochStatistics.md)
- [MeasurementStatistics](docs/MeasurementStatistics.md)
docs/python_client/docs/DefaultApi.md
+135
View File
@@ -7,6 +7,8 @@ Method | HTTP request | Description
[**cancel_post**](DefaultApi.md#cancel_post) | **POST** /cancel | Cancel running data collection
[**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_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
@@ -266,6 +268,139 @@ 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_bragg_integration_get**
> BraggIntegrationSettings config_bragg_integration_get()
Get Bragg integration configuration
Can be done anytime
### Example
```python
import jfjoch_client
from jfjoch_client.models.bragg_integration_settings import BraggIntegrationSettings
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 Bragg integration configuration
api_response = api_instance.config_bragg_integration_get()
print("The response of DefaultApi->config_bragg_integration_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->config_bragg_integration_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**BraggIntegrationSettings**](BraggIntegrationSettings.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_bragg_integration_put**
> config_bragg_integration_put(bragg_integration_settings=bragg_integration_settings)
Change Bragg integration settings
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
### Example
```python
import jfjoch_client
from jfjoch_client.models.bragg_integration_settings import BraggIntegrationSettings
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)
bragg_integration_settings = jfjoch_client.BraggIntegrationSettings() # BraggIntegrationSettings | (optional)
try:
# Change Bragg integration settings
api_instance.config_bragg_integration_put(bragg_integration_settings=bragg_integration_settings)
except Exception as e:
print("Exception when calling DefaultApi->config_bragg_integration_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**bragg_integration_settings** | [**BraggIntegrationSettings**](BraggIntegrationSettings.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()
docs/python_client/docs/JfjochSettings.md
+1
View File
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
**file_writer** | [**FileWriterSettings**](FileWriterSettings.md) | | [optional]
**detector** | [**List[Detector]**](Detector.md) | |
**indexing** | [**IndexingSettings**](IndexingSettings.md) | | [optional]
**bragg_integration** | [**BraggIntegrationSettings**](BraggIntegrationSettings.md) | | [optional]
**detector_settings** | [**DetectorSettings**](DetectorSettings.md) | | [optional]
**azim_int** | [**AzimIntSettings**](AzimIntSettings.md) | | [optional]
**image_format** | [**ImageFormatSettings**](ImageFormatSettings.md) | | [optional]
docs/python_client/docs/JfjochStatistics.md
+1
View File
@@ -25,6 +25,7 @@ Name | Type | Description | Notes
**az_int** | [**AzimIntSettings**](AzimIntSettings.md) | | [optional]
**buffer** | [**ImageBufferStatus**](ImageBufferStatus.md) | | [optional]
**indexing** | [**IndexingSettings**](IndexingSettings.md) | | [optional]
**bragg_integration** | [**BraggIntegrationSettings**](BraggIntegrationSettings.md) | | [optional]
**image_pusher** | [**ImagePusherStatus**](ImagePusherStatus.md) | | [optional]
## Example
docs/python_client/docs/ScanResult.md
+1
View File
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
**file_prefix** | **str** | | [optional]
**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]
**images** | [**List[ScanResultImagesInner]**](ScanResultImagesInner.md) | |
## Example
docs/python_client/docs/ScanResultImagesInner.md
+1
View File
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
**spots_low_res** | **int** | Spot count in low resolution range | [optional]
**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]
**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]