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

1.0.0-rc.65

Browse Source
This commit is contained in:
leonarski_f
2025-07-16 20:19:48 +02:00
parent 5a6227230a
commit 06c5b9cf7f
184 changed files with 997 additions and 544 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/python_client/README.md
View File

@@ -3,11 +3,27 @@ API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerlan
Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU.
Jungfraujoch uses FPGA boards to acquire data at high data rates.
# License Clarification
While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply**
when this file is used solely to generate OpenAPI clients or when implementing applications that
interact with the API. Generated client code and applications using this API definition are not
subject to the GPL license requirements and may be distributed under terms of your choosing.
This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and
the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that
user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not
derivative works of the kernel and are not subject to the terms of the GPL.
This exception is intended to allow wider use of this API specification without imposing GPL
requirements on applications that merely interact with the API, regardless of whether they
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.64
- Package version: 1.0.0-rc.64
- API version: 1.0.0-rc.65
- Package version: 1.0.0-rc.65
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

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

@@ -3090,7 +3090,7 @@ 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)
# **preview_plot_get**
> Plots preview_plot_get(type, binning=binning, compression=compression, experimental_coord=experimental_coord, azint_unit=azint_unit)
> Plots preview_plot_get(type, binning=binning, compression=compression, fill=fill, experimental_coord=experimental_coord, azint_unit=azint_unit)
Generate 1D plot from Jungfraujoch
@@ -3117,12 +3117,13 @@ with jfjoch_client.ApiClient(configuration) as api_client:
type = 'type_example' # str | Type of requested plot
binning = 56 # int | Binning of frames for the plot (0 = default binning) (optional)
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)
azint_unit = Q_recipA # str | Unit used for azim int. (optional) (default to Q_recipA)
try:
# Generate 1D plot from Jungfraujoch
api_response = api_instance.preview_plot_get(type, binning=binning, compression=compression, experimental_coord=experimental_coord, azint_unit=azint_unit)
api_response = api_instance.preview_plot_get(type, binning=binning, compression=compression, fill=fill, experimental_coord=experimental_coord, azint_unit=azint_unit)
print("The response of DefaultApi->preview_plot_get:\n")
pprint(api_response)
except Exception as e:
@@ -3139,6 +3140,7 @@ Name | Type | Description | Notes
**type** | **str**| Type of requested plot |
**binning** | **int**| Binning of frames for the plot (0 = default binning) | [optional]
**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]
**azint_unit** | **str**| Unit used for azim int. | [optional] [default to Q_recipA]