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

OpenAPI: for plot y and z are potentially nullable

Browse Source
This commit is contained in:
leonarski_f
2025-12-08 10:11:42 +01:00
parent 3046937399
commit d58b69332a
8 changed files with 19 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -3165,7 +3165,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
api_instance = jfjoch_client.DefaultApi(api_client)
type = 'type_example' # str | Type of requested plot
azint_unit = Q_recipA # str | Unit used for azim int. (optional) (default to Q_recipA)
binning = 56 # int | Binning of frames for the plot (0 = default binning) (optional)
binning = 1 # int | Binning of frames for the plot (0 = default binning) (optional) (default to 1)
try:
# Generate 1D plot from Jungfraujoch and send in raw binary format. Data are provided as (32-bit) float binary array. This format doesn't transmit information about X-axis, only values, so it is of limited use for azimuthal integration.
@@ -3185,7 +3185,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**type** | **str**| Type of requested plot |
**azint_unit** | **str**| Unit used for azim int. | [optional] [default to Q_recipA]
**binning** | **int**| Binning of frames for the plot (0 = default binning) | [optional]
**binning** | **int**| Binning of frames for the plot (0 = default binning) | [optional] [default to 1]
### Return type
@@ -3235,7 +3235,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jfjoch_client.DefaultApi(api_client)
type = 'type_example' # str | Type of requested plot
binning = 56 # int | Binning of frames for the plot (0 = default binning) (optional)
binning = 1 # int | Binning of frames for the plot (0 = default binning) (optional) (default to 1)
compression = False # bool | Enable DEFLATE compression of output data. (optional) (default to False)
fill = 3.4 # float | Fill value for elements that were missed during data collection (optional)
experimental_coord = False # bool | If measurement has goniometer axis defined, plot X-axis will represent rotation angle If measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value For still measurement the number is ignored (optional) (default to False)
@@ -3258,7 +3258,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**type** | **str**| Type of requested plot |
**binning** | **int**| Binning of frames for the plot (0 = default binning) | [optional]
**binning** | **int**| Binning of frames for the plot (0 = default binning) | [optional] [default to 1]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to False]
**fill** | **float**| Fill value for elements that were missed during data collection | [optional]
**experimental_coord** | **bool**| If measurement has goniometer axis defined, plot X-axis will represent rotation angle If measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value For still measurement the number is ignored | [optional] [default to False]

4
docs/python_client/docs/Plot.md
View File

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | | [default to '']
**x** | **List[float]** | |
**y** | **List[float]** | |
**z** | **List[float]** | | [optional]
**y** | **List[Optional[float]]** | |
**z** | **List[Optional[float]]** | | [optional]
## Example