OpenAPI: Use generator 7.20.0
Some checks failed
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 12m6s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 13m5s
Build Packages / build:rpm (rocky8) (push) Successful in 13m47s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 14m2s
Build Packages / Generate python client (push) Successful in 17s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 14m12s
Build Packages / Create release (push) Has been skipped
Build Packages / Build documentation (push) Successful in 32s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 14m42s
Build Packages / build:rpm (rocky9) (push) Successful in 14m50s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 14m59s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 8m16s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 8m16s
Build Packages / Unit tests (push) Has been cancelled
Some checks failed
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 12m6s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 13m5s
Build Packages / build:rpm (rocky8) (push) Successful in 13m47s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 14m2s
Build Packages / Generate python client (push) Successful in 17s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 14m12s
Build Packages / Create release (push) Has been skipped
Build Packages / Build documentation (push) Successful in 32s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 14m42s
Build Packages / build:rpm (rocky9) (push) Successful in 14m50s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 14m59s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 8m16s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 8m16s
Build Packages / Unit tests (push) Has been cancelled
This commit is contained in:
@@ -24,12 +24,12 @@ This Python package is automatically generated by the [OpenAPI Generator](https:
|
||||
|
||||
- API version: 1.0.0-rc.124
|
||||
- Package version: 1.0.0-rc.124
|
||||
- Generator version: 7.8.0
|
||||
- Generator version: 7.20.0
|
||||
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
||||
|
||||
## Requirements.
|
||||
|
||||
Python 3.7+
|
||||
Python 3.9+
|
||||
|
||||
## Installation & Usage
|
||||
### pip install
|
||||
|
||||
@@ -71,7 +71,12 @@ Method | HTTP request | Description
|
||||
|
||||
Cancel running data collection
|
||||
|
||||
Command will inform FPGA network card to stop pedestal or data collection at the current stage. Any frame that is currently being processed by CPU will be finished and sent to writer. Given the command is making sure to gracefully stop data acquisition and detector, it might take some time to switch back after command finished to `Idle` state. If data collection is not running, the command has no effect.
|
||||
Command will inform FPGA network card to stop pedestal or data collection at the current stage.
|
||||
Any frame that is currently being processed by CPU will be finished and sent to writer.
|
||||
Given the command is making sure to gracefully stop data acquisition and detector, it might take some time to switch back after command finished to `Idle` state.
|
||||
|
||||
If data collection is not running, the command has no effect.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -326,7 +331,9 @@ No authorization required
|
||||
|
||||
Set configuration for dark data collection to calculate mask
|
||||
|
||||
This is only possible when operating DECTRIS detectors at the moment; it will be also available for PSI EIGER at some point. This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
This is only possible when operating DECTRIS detectors at the moment; it will be also available for PSI EIGER at some point.
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -458,7 +465,11 @@ No authorization required
|
||||
|
||||
Change detector configuration
|
||||
|
||||
Detector settings are ones that have effect on calibration, i.e., pedestal has to be collected again after changing these settings. This can only be done when detector is `Idle`, `Error` or `Inactive` states. If detector is in `Idle` state , pedestal procedure will be executed automatically - there must be no X-rays on the detector during the operation. If detector is in `Inactive` or `Error` states, new settings will be saved, but no calibration will be executed.
|
||||
Detector settings are ones that have effect on calibration, i.e., pedestal has to be collected again after changing these settings.
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
If detector is in `Idle` state , pedestal procedure will be executed automatically - there must be no X-rays on the detector during the operation.
|
||||
If detector is in `Inactive` or `Error` states, new settings will be saved, but no calibration will be executed.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -590,7 +601,8 @@ No authorization required
|
||||
|
||||
Change file writer settings
|
||||
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -658,7 +670,8 @@ No authorization required
|
||||
|
||||
Configure format for data collection with full conversion
|
||||
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -784,7 +797,8 @@ No authorization required
|
||||
|
||||
Change image output format
|
||||
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -852,7 +866,8 @@ No authorization required
|
||||
|
||||
Configure format for raw data collection
|
||||
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -978,7 +993,8 @@ No authorization required
|
||||
|
||||
Change indexing algorithm settings
|
||||
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -1110,7 +1126,8 @@ No authorization required
|
||||
|
||||
Change instrument metadata
|
||||
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
This can only be done when detector is `Idle`, `Error` or `Inactive` states.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -1178,7 +1195,10 @@ No authorization required
|
||||
|
||||
Load binary image for internal FPGA generator
|
||||
|
||||
Load image for internal FPGA generator. This can only happen in Idle state of the detector. Requires binary blob with 16-bit integer numbers of size of detector in raw/converted coordinates (depending on detector settings).
|
||||
Load image for internal FPGA generator. This can only happen in Idle state of the detector.
|
||||
Requires binary blob with 16-bit integer numbers of size of detector in raw/converted coordinates
|
||||
(depending on detector settings).
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -1246,7 +1266,10 @@ No authorization required
|
||||
|
||||
Load TIFF image for internal FPGA generator
|
||||
|
||||
Load image for internal FPGA generator. This can only happen in Idle state of the detector. Requires TIFF with 16-bit integer numbers of size of detector in raw/converted coordinates (depending on detector settings).
|
||||
Load image for internal FPGA generator. This can only happen in Idle state of the detector.
|
||||
Requires TIFF with 16-bit integer numbers of size of detector in raw/converted coordinates
|
||||
(depending on detector settings).
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -1314,7 +1337,10 @@ No authorization required
|
||||
|
||||
Get mask of the detector (binary)
|
||||
|
||||
Detector must be Initialized. Get full pixel mask of the detector. See NXmx standard for meaning of pixel values.
|
||||
Detector must be Initialized.
|
||||
Get full pixel mask of the detector.
|
||||
See NXmx standard for meaning of pixel values.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -1377,7 +1403,10 @@ No authorization required
|
||||
|
||||
Get mask of the detector (TIFF)
|
||||
|
||||
Should be in `Idle` state. Get full pixel mask of the detector See NXmx standard for meaning of pixel values
|
||||
Should be in `Idle` state.
|
||||
Get full pixel mask of the detector
|
||||
See NXmx standard for meaning of pixel values
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -1632,7 +1661,10 @@ No authorization required
|
||||
|
||||
Select detector
|
||||
|
||||
Jungfraujoch allows to control multiple detectors and/or region-of-interests. The command allows to choose one detector from the list (ID has to be consistent with one provided by GET response). Changing detector will set detector to `Inactive` state and will require reinitialization.
|
||||
Jungfraujoch allows to control multiple detectors and/or region-of-interests.
|
||||
The command allows to choose one detector from the list (ID has to be consistent with one provided by GET response).
|
||||
Changing detector will set detector to `Inactive` state and will require reinitialization.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -1894,7 +1926,14 @@ No authorization required
|
||||
|
||||
Upload user mask of the detector (binary)
|
||||
|
||||
Should be in `Idle` state. Upload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions. If detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates. In the latter case - module gaps are ignored and don't need to be assigned value. Mask is expected as binary array (4-byte; unsigned). 0 - good pixel, other value - masked User mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.
|
||||
Should be in `Idle` state.
|
||||
Upload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.
|
||||
If detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.
|
||||
In the latter case - module gaps are ignored and don't need to be assigned value.
|
||||
Mask is expected as binary array (4-byte; unsigned).
|
||||
0 - good pixel, other value - masked
|
||||
User mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -2023,7 +2062,15 @@ No authorization required
|
||||
|
||||
Upload user mask of the detector
|
||||
|
||||
Should be in `Idle` state. Upload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions. If detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates. In the latter case - module gaps are ignored and don't need to be assigned value. Mask is expected as TIFF (4-byte; unsigned). 0 - good pixel, other value - masked User mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration. User mask is not automatically applied - i.e. pixels with user mask will have a valid pixel value in the images.
|
||||
Should be in `Idle` state.
|
||||
Upload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions.
|
||||
If detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates.
|
||||
In the latter case - module gaps are ignored and don't need to be assigned value.
|
||||
Mask is expected as TIFF (4-byte; unsigned).
|
||||
0 - good pixel, other value - masked
|
||||
User mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.
|
||||
User mask is not automatically applied - i.e. pixels with user mask will have a valid pixel value in the images.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -2151,7 +2198,10 @@ No authorization required
|
||||
|
||||
Set ZeroMQ metadata settings
|
||||
|
||||
Jungfraujoch can generate metadata message stream on ZeroMQ PUB socket. This stream covers all images. Here settings of the socket can be adjusted. While the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request.
|
||||
Jungfraujoch can generate metadata message stream on ZeroMQ PUB socket. This stream covers all images.
|
||||
Here settings of the socket can be adjusted.
|
||||
While the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -2281,7 +2331,11 @@ No authorization required
|
||||
|
||||
Set ZeroMQ preview settings
|
||||
|
||||
Jungfraujoch can generate preview message stream on ZeroMQ SUB socket. Here settings of the socket can be adjusted. While the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request. Options set with this PUT request have no effect on HTTP based preview.
|
||||
Jungfraujoch can generate preview message stream on ZeroMQ SUB socket.
|
||||
Here settings of the socket can be adjusted.
|
||||
While the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request.
|
||||
Options set with this PUT request have no effect on HTTP based preview.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -2349,7 +2403,10 @@ No authorization required
|
||||
|
||||
Prepare detector to turn off
|
||||
|
||||
Should be in `Idle` or `Error` state. Command deactivates data acquisition and turns off detector high voltage and ASIC. Should be used always before turning off power from the detector.
|
||||
Should be in `Idle` or `Error` state.
|
||||
Command deactivates data acquisition and turns off detector high voltage and ASIC.
|
||||
Should be used always before turning off power from the detector.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -2887,7 +2944,10 @@ No authorization required
|
||||
|
||||
Get status of the image buffers
|
||||
|
||||
Can be run at any stage of Jungfraujoch operation, including during data collection. The status of the image buffer is volatile during data collection - if data collection goes for more images than available buffer slots, then image might be replaced in the buffer between calling /images and /image.cbor.
|
||||
Can be run at any stage of Jungfraujoch operation, including during data collection.
|
||||
The status of the image buffer is volatile during data collection - if data collection goes for more images than available buffer slots,
|
||||
then image might be replaced in the buffer between calling /images and /image.cbor.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -2952,7 +3012,16 @@ No authorization required
|
||||
|
||||
Initialize detector and data acquisition
|
||||
|
||||
Should be used in two cases: - Detector is in `Inactive` state - Detector is in `Error` state X-ray shutter must be closed. This operation will reconfigure network interface of the detector. During operation of the detector it is recommended to use the `POST /pedestal` operation instead. If storage cells are used, the execution time might be few minutes. This is async function - one needs to use `POST /wait_till_done` to ensure operation is done.
|
||||
Should be used in two cases:
|
||||
- Detector is in `Inactive` state
|
||||
- Detector is in `Error` state
|
||||
X-ray shutter must be closed.
|
||||
This operation will reconfigure network interface of the detector.
|
||||
During operation of the detector it is recommended to use the `POST /pedestal` operation instead.
|
||||
If storage cells are used, the execution time might be few minutes.
|
||||
|
||||
This is async function - one needs to use `POST /wait_till_done` to ensure operation is done.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -3014,7 +3083,12 @@ No authorization required
|
||||
|
||||
Collect dark current for the detector
|
||||
|
||||
Updates calibration of the JUNGFRAU detector. Must be in `Idle` state. X-ray shutter must be closed. Recommended to run once per hour for long integration times (> 100 us). This is async function - one needs to use `POST /wait_till_done` to ensure operation is done.
|
||||
Updates calibration of the JUNGFRAU detector. Must be in `Idle` state.
|
||||
|
||||
X-ray shutter must be closed. Recommended to run once per hour for long integration times (> 100 us).
|
||||
|
||||
This is async function - one needs to use `POST /wait_till_done` to ensure operation is done.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -3353,7 +3427,11 @@ No authorization required
|
||||
|
||||
Start detector
|
||||
|
||||
Start data acquisition. Detector must be in `Idle` state. Doesn't run calibration procedure. When the function returns, detector is ready to accept soft/TTL triggers.
|
||||
Start data acquisition.
|
||||
Detector must be in `Idle` state.
|
||||
Doesn't run calibration procedure.
|
||||
When the function returns, detector is ready to accept soft/TTL triggers.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
@@ -3802,7 +3880,12 @@ No authorization required
|
||||
|
||||
Wait for acquisition done
|
||||
|
||||
Block execution of external script till initialization, data collection or pedestal is finished. Running this command does not affect (cancel) running data collection, it is only to ensure synchronous execution of other software. To not block web server for a indefinite period of time, the procedure is provided with a timeout. Extending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.
|
||||
Block execution of external script till initialization, data collection or pedestal is finished.
|
||||
Running this command does not affect (cancel) running data collection, it is only to ensure synchronous execution of other software.
|
||||
|
||||
To not block web server for a indefinite period of time, the procedure is provided with a timeout.
|
||||
Extending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
Reference in New Issue
Block a user