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

jfjoch_broker: Improve API to get raw plot (for viewer and other applications)

Browse Source
This commit is contained in:
leonarski_f
2025-12-09 10:51:21 +01:00
parent 36d0507758
commit c5ff6b89af
18 changed files with 154 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -3140,7 +3140,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_bin_get**
> bytearray preview_plot_bin_get(type, azint_unit=azint_unit, binning=binning)
> bytearray preview_plot_bin_get(type, roi=roi)
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.
@@ -3164,12 +3164,11 @@ 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)
roi = 'roi_example' # str | Name of ROI for which plot is requested (optional)
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)
api_response = api_instance.preview_plot_bin_get(type, roi=roi)
print("The response of DefaultApi->preview_plot_bin_get:\n")
pprint(api_response)
except Exception as e:
@@ -3184,8 +3183,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
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] [default to 1]
**roi** | **str**| Name of ROI for which plot is requested | [optional]
### Return type