v1.0.0-rc.119 (#26)
Some checks failed
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 10m11s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 10m22s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 10m27s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 8m19s
Build Packages / Generate python client (push) Successful in 17s
Build Packages / Build documentation (push) Successful in 42s
Build Packages / Create release (push) Has been skipped
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 8m44s
Build Packages / build:rpm (rocky8) (push) Successful in 8m44s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 8m33s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 9m11s
Build Packages / build:rpm (rocky9) (push) Successful in 9m54s
Build Packages / Unit tests (push) Failing after 1h11m12s

This is an UNSTABLE release and not recommended for production use (please use rc.111 instead).

* jfjoch_broker: Add binary export of data analysis plots over OpenAPI
* jfjoch_broker: Minor fixes to HTTP error handling
* jfjoch_viewer: Prefer binary plots over JSON plots
* jfjoch_viewer: Change foreground with F button + wheel
* jfjoch_viewer: Change way how angles are displayed
* jfjoch_viewer: Display resolution of the mouse cursor in top left corner

Reviewed-on: #26
Co-authored-by: Filip Leonarski <filip.leonarski@psi.ch>
Co-committed-by: Filip Leonarski <filip.leonarski@psi.ch>
This commit was merged in pull request #26.
This commit is contained in:
2025-12-08 19:53:35 +01:00
committed by leonarski_f
parent b02c412d59
commit 36d0507758
156 changed files with 900 additions and 488 deletions

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.118
- Package version: 1.0.0-rc.118
- API version: 1.0.0-rc.119
- Package version: 1.0.0-rc.119
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
@@ -148,6 +148,7 @@ Class | Method | HTTP request | Description
*DefaultApi* | [**initialize_post**](docs/DefaultApi.md#initialize_post) | **POST** /initialize | Initialize detector and data acquisition
*DefaultApi* | [**pedestal_post**](docs/DefaultApi.md#pedestal_post) | **POST** /pedestal | Collect dark current for the detector
*DefaultApi* | [**preview_pedestal_tiff_get**](docs/DefaultApi.md#preview_pedestal_tiff_get) | **GET** /preview/pedestal.tiff | Get pedestal in TIFF format
*DefaultApi* | [**preview_plot_bin_get**](docs/DefaultApi.md#preview_plot_bin_get) | **GET** /preview/plot.bin | Generate 1D plot from Jungfraujoch and send in raw binary format. Data are provided as (32-bit) float binary array. This format doesn&#39;t transmit information about X-axis, only values, so it is of limited use for azimuthal integration.
*DefaultApi* | [**preview_plot_get**](docs/DefaultApi.md#preview_plot_get) | **GET** /preview/plot | Generate 1D plot from Jungfraujoch
*DefaultApi* | [**result_scan_get**](docs/DefaultApi.md#result_scan_get) | **GET** /result/scan | Get full scan result
*DefaultApi* | [**start_post**](docs/DefaultApi.md#start_post) | **POST** /start | Start detector

View File

@@ -51,6 +51,7 @@ Method | HTTP request | Description
[**initialize_post**](DefaultApi.md#initialize_post) | **POST** /initialize | Initialize detector and data acquisition
[**pedestal_post**](DefaultApi.md#pedestal_post) | **POST** /pedestal | Collect dark current for the detector
[**preview_pedestal_tiff_get**](DefaultApi.md#preview_pedestal_tiff_get) | **GET** /preview/pedestal.tiff | Get pedestal in TIFF format
[**preview_plot_bin_get**](DefaultApi.md#preview_plot_bin_get) | **GET** /preview/plot.bin | Generate 1D plot from Jungfraujoch and send in raw binary format. Data are provided as (32-bit) float binary array. This format doesn&#39;t transmit information about X-axis, only values, so it is of limited use for azimuthal integration.
[**preview_plot_get**](DefaultApi.md#preview_plot_get) | **GET** /preview/plot | Generate 1D plot from Jungfraujoch
[**result_scan_get**](DefaultApi.md#result_scan_get) | **GET** /result/scan | Get full scan result
[**start_post**](DefaultApi.md#start_post) | **POST** /start | Start detector
@@ -3138,6 +3139,76 @@ 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_bin_get**
> bytearray preview_plot_bin_get(type, azint_unit=azint_unit, binning=binning)
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.
### Example
```python
import jfjoch_client
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)
type = 'type_example' # str | Type of requested plot
azint_unit = Q_recipA # str | Unit used for azim int. (optional) (default to Q_recipA)
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.
api_response = api_instance.preview_plot_bin_get(type, azint_unit=azint_unit, binning=binning)
print("The response of DefaultApi->preview_plot_bin_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->preview_plot_bin_get: %s\n" % e)
```
### Parameters
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 &#x3D; default binning) | [optional] [default to 1]
### Return type
**bytearray**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/octet-stream, text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Everything OK. | - |
**400** | Input parsing or validation error | - |
[[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, fill=fill, experimental_coord=experimental_coord, azint_unit=azint_unit)
@@ -3164,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)
@@ -3187,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 &#x3D; default binning) | [optional]
**binning** | **int**| Binning of frames for the plot (0 &#x3D; 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]

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