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

v1.0.0-rc.73

Browse Source
This commit is contained in:
leonarski_f
2025-09-09 11:24:19 +02:00
parent e36bac7589
commit a0fee8aec0
142 changed files with 184 additions and 179 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/python_client/README.md
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.72
- Package version: 1.0.0-rc.72
- API version: 1.0.0-rc.73
- Package version: 1.0.0-rc.73
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
@@ -102,8 +102,8 @@ 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_azim_int_get**](docs/DefaultApi.md#config_azim_int_get) | **GET** /config/azim_int | Get radial integration configuration
*DefaultApi* | [**config_azim_int_put**](docs/DefaultApi.md#config_azim_int_put) | **PUT** /config/azim_int | Configure radial integration
*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_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

6
docs/python_client/docs/AzimIntSettings.md
View File

@@ -5,12 +5,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**polarization_corr** | **bool** | Apply polarization correction for radial integration (polarization factor must be configured in dataset settings) | [default to True]
**solid_angle_corr** | **bool** | Apply solid angle correction for radial integration | [default to True]
**polarization_corr** | **bool** | Apply polarization correction for azimuthal integration (polarization factor must be configured in dataset settings) | [default to True]
**solid_angle_corr** | **bool** | Apply solid angle correction for azimuthal integration | [default to True]
**high_q_recip_a** | **float** | |
**low_q_recip_a** | **float** | |
**q_spacing** | **float** | |
**azimuthal_bins** | **int** | Numer of azimuthal (phi) bins; 1 = standard 1D radial integration | [optional] [default to 1]
**azimuthal_bins** | **int** | Numer of azimuthal (phi) bins; 1 = standard 1D azimuthal integration | [optional] [default to 1]
## Example

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

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
**incident_energy_ke_v** | **float** | Used to calculate /entry/beam/incident_wavelength in NXmx Incident particle (photon, electron) energy in keV |
**file_prefix** | **str** | Prefix for filenames. If left empty, no file will be saved. | [optional] [default to '']
**images_per_file** | **int** | Number of files in a single HDF5 data file (0 = write all images to a single data file). | [optional] [default to 1000]
**space_group_number** | **int** | Number of space group for the crystal. Currently used solely as metadata, not relevant for image processing done in Jungfraujoch. | [optional] [default to 0]
**space_group_number** | **int** | Number of space group for the crystal. Currently used solely as metadata, not relevant for image processing done in Jungfraujoch. | [optional]
**sample_name** | **str** | /entry/sample/name in NXmx Sample name | [optional] [default to '']
**compression** | **str** | Compression type for the images transferred over ZeroMQ and saved to HDF5 file. | [optional] [default to 'bslz4']
**total_flux** | **float** | /entry/beam/total_flux in NXmx Flux incident on beam plane in photons per second. In other words this is the flux integrated over area. [photons/s] | [optional]

12
docs/python_client/docs/DefaultApi.md
View File

@@ -5,8 +5,8 @@ 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_azim_int_get**](DefaultApi.md#config_azim_int_get) | **GET** /config/azim_int | Get radial integration configuration
[**config_azim_int_put**](DefaultApi.md#config_azim_int_put) | **PUT** /config/azim_int | Configure radial integration
[**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_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
@@ -128,7 +128,7 @@ No authorization required
# **config_azim_int_get**
> AzimIntSettings config_azim_int_get()
Get radial integration configuration
Get azimuthal integration configuration
Can be done anytime
@@ -154,7 +154,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
api_instance = jfjoch_client.DefaultApi(api_client)
try:
# Get radial integration configuration
# Get azimuthal integration configuration
api_response = api_instance.config_azim_int_get()
print("The response of DefaultApi->config_azim_int_get:\n")
pprint(api_response)
@@ -192,7 +192,7 @@ No authorization required
# **config_azim_int_put**
> config_azim_int_put(azim_int_settings=azim_int_settings)
Configure radial integration
Configure azimuthal integration
Can be done when detector is Inactive or Idle
@@ -219,7 +219,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
azim_int_settings = jfjoch_client.AzimIntSettings() # AzimIntSettings | (optional)
try:
# Configure radial integration
# Configure azimuthal integration
api_instance.config_azim_int_put(azim_int_settings=azim_int_settings)
except Exception as e:
print("Exception when calling DefaultApi->config_azim_int_put: %s\n" % e)

3
docs/python_client/docs/DetectorListDetectorsInner.md
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

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

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

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