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

version 1.0.0-rc.16

Browse Source
This commit is contained in:
leonarski_f
2024-10-11 11:11:37 +02:00
parent 040c43084e
commit b605b95127
227 changed files with 3881 additions and 2176 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
python-client/docs/AzimIntSettings.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.azim_int_settings import AzimIntSettings
from jfjoch_client.models.azim_int_settings import AzimIntSettings
# TODO update the JSON string below
json = "{}"

2
python-client/docs/BrokerStatus.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.broker_status import BrokerStatus
from jfjoch_client.models.broker_status import BrokerStatus
# TODO update the JSON string below
json = "{}"

2
python-client/docs/CalibrationStatisticsInner.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.calibration_statistics_inner import CalibrationStatisticsInner
from jfjoch_client.models.calibration_statistics_inner import CalibrationStatisticsInner
# TODO update the JSON string below
json = "{}"

2
python-client/docs/DatasetSettings.md
View File

@@ -35,7 +35,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.dataset_settings import DatasetSettings
from jfjoch_client.models.dataset_settings import DatasetSettings
# TODO update the JSON string below
json = "{}"

2
python-client/docs/DatasetSettingsUnitCell.md
View File

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.dataset_settings_unit_cell import DatasetSettingsUnitCell
from jfjoch_client.models.dataset_settings_unit_cell import DatasetSettingsUnitCell
# TODO update the JSON string below
json = "{}"

864
python-client/docs/DefaultApi.md
View File

File diff suppressed because it is too large Load Diff

2
python-client/docs/Detector.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.detector import Detector
from jfjoch_client.models.detector import Detector
# TODO update the JSON string below
json = "{}"

2
python-client/docs/DetectorList.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.detector_list import DetectorList
from jfjoch_client.models.detector_list import DetectorList
# TODO update the JSON string below
json = "{}"

2
python-client/docs/DetectorListDetectorsInner.md
View File

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.detector_list_detectors_inner import DetectorListDetectorsInner
from jfjoch_client.models.detector_list_detectors_inner import DetectorListDetectorsInner
# TODO update the JSON string below
json = "{}"

2
python-client/docs/DetectorModule.md
View File

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.detector_module import DetectorModule
from jfjoch_client.models.detector_module import DetectorModule
# TODO update the JSON string below
json = "{}"

15
python-client/docs/DetectorPowerState.md Normal file
View File

@@ -0,0 +1,15 @@
# DetectorPowerState
Power on of ASICs
## Enum
* `POWERON` (value: `'PowerOn'`)
* `POWEROFF` (value: `'PowerOff'`)
* `PARTIAL` (value: `'Partial'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2
python-client/docs/DetectorSelection.md
View File

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.detector_selection import DetectorSelection
from jfjoch_client.models.detector_selection import DetectorSelection
# TODO update the JSON string below
json = "{}"

26
python-client/docs/DetectorSettings.md
View File

@@ -7,23 +7,25 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frame_time_us** | **int** | Interval between consecutive frames. |
**count_time_us** | **int** | Integration time of the detector. If not provided count time will be set to maximum value for a given frame time. | [optional]
**storage_cell_count** | **int** | | [default to 1]
**internal_frame_generator** | **bool** | Use internal frame generator in FPGA instead of getting data from a real detector | [default to False]
**internal_frame_generator_images** | **int** | | [default to 1]
**pedestal_g0_frames** | **int** | | [default to 2000]
**pedestal_g1_frames** | **int** | | [default to 300]
**pedestal_g2_frames** | **int** | | [default to 300]
**pedestal_g0_rms_limit** | **int** | Pixels with pedestal G0 RMS above the threshold are marked as masked pixels | [default to 100]
**pedestal_min_image_count** | **int** | Minimum number of collected images for pedestal to consider it viable | [default to 128]
**storage_cell_delay_ns** | **int** | Delay between two storage cells [ns] | [default to 5000]
**internal_frame_generator** | **bool** | Use internal frame generator in FPGA instead of getting data from a real detector | [optional] [default to False]
**internal_frame_generator_images** | **int** | | [optional] [default to 1]
**detector_trigger_delay_ns** | **int** | Delay between TTL trigger and acquisition start [ns] | [optional] [default to 0]
**fixed_gain_g1** | **bool** | Fix gain to G1 (can be useful for storage cells) | [optional] [default to False]
**use_gain_hg0** | **bool** | Use high G0 (for low energy applications) | [optional] [default to False]
**timing** | [**DetectorTiming**](DetectorTiming.md) | | [optional] [default to DetectorTiming.TRIGGER]
**eiger_threshold_ke_v** | **float** | | [optional]
**jungfrau_pedestal_g0_frames** | **int** | | [optional] [default to 2000]
**jungfrau_pedestal_g1_frames** | **int** | | [optional] [default to 300]
**jungfrau_pedestal_g2_frames** | **int** | | [optional] [default to 300]
**jungfrau_pedestal_g0_rms_limit** | **int** | Pixels with pedestal G0 RMS above the threshold are marked as masked pixels | [optional] [default to 100]
**jungfrau_pedestal_min_image_count** | **int** | Minimum number of collected images for pedestal to consider it viable | [optional] [default to 128]
**jungfrau_storage_cell_count** | **int** | | [optional] [default to 1]
**jungfrau_storage_cell_delay_ns** | **int** | Delay between two storage cells [ns] | [optional] [default to 5000]
**jungfrau_fixed_gain_g1** | **bool** | Fix gain to G1 (can be useful for storage cells) | [optional] [default to False]
**jungfrau_use_gain_hg0** | **bool** | Use high G0 (for low energy applications) | [optional] [default to False]
## Example
```python
from openapi_client.models.detector_settings import DetectorSettings
from jfjoch_client.models.detector_settings import DetectorSettings
# TODO update the JSON string below
json = "{}"

19
python-client/docs/DetectorState.md Normal file
View File

@@ -0,0 +1,19 @@
# DetectorState
Current state of the detector
## Enum
* `IDLE` (value: `'Idle'`)
* `WAITING` (value: `'Waiting'`)
* `BUSY` (value: `'Busy'`)
* `ERROR` (value: `'Error'`)
* `NOT_CONNECTED` (value: `'Not connected'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

6
python-client/docs/DetectorStatus.md
View File

@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**state** | **str** | Current state of the detector |
**powerchip** | **str** | Power on of ASICs |
**state** | [**DetectorState**](DetectorState.md) | |
**powerchip** | [**DetectorPowerState**](DetectorPowerState.md) | |
**server_version** | **str** | Detector server (on read-out boards) version |
**number_of_triggers_left** | **int** | Remaining triggers to the detector (max of all modules) |
**fpga_temp_deg_c** | **List[int]** | Temperature of detector FPGAs |
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.detector_status import DetectorStatus
from jfjoch_client.models.detector_status import DetectorStatus
# TODO update the JSON string below
json = "{}"

16
python-client/docs/DetectorTiming.md Normal file
View File

@@ -0,0 +1,16 @@
# DetectorTiming
## Enum
* `AUTO` (value: `'auto'`)
* `TRIGGER` (value: `'trigger'`)
* `BURST` (value: `'burst'`)
* `GATED` (value: `'gated'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2
python-client/docs/ErrorMessage.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.error_message import ErrorMessage
from jfjoch_client.models.error_message import ErrorMessage
# TODO update the JSON string below
json = "{}"

2
python-client/docs/FpgaStatusInner.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.fpga_status_inner import FpgaStatusInner
from jfjoch_client.models.fpga_status_inner import FpgaStatusInner
# TODO update the JSON string below
json = "{}"

2
python-client/docs/ImageFormatSettings.md
View File

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.image_format_settings import ImageFormatSettings
from jfjoch_client.models.image_format_settings import ImageFormatSettings
# TODO update the JSON string below
json = "{}"

2
python-client/docs/InstrumentMetadata.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.instrument_metadata import InstrumentMetadata
from jfjoch_client.models.instrument_metadata import InstrumentMetadata
# TODO update the JSON string below
json = "{}"

2
python-client/docs/JfjochSettings.md
View File

@@ -22,7 +22,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.jfjoch_settings import JfjochSettings
from jfjoch_client.models.jfjoch_settings import JfjochSettings
# TODO update the JSON string below
json = "{}"

2
python-client/docs/MeasurementStatistics.md
View File

@@ -27,7 +27,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.measurement_statistics import MeasurementStatistics
from jfjoch_client.models.measurement_statistics import MeasurementStatistics
# TODO update the JSON string below
json = "{}"

2
python-client/docs/PcieDevicesInner.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.pcie_devices_inner import PcieDevicesInner
from jfjoch_client.models.pcie_devices_inner import PcieDevicesInner
# TODO update the JSON string below
json = "{}"

2
python-client/docs/Plot.md
View File

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.plot import Plot
from jfjoch_client.models.plot import Plot
# TODO update the JSON string below
json = "{}"

2
python-client/docs/Plots.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.plots import Plots
from jfjoch_client.models.plots import Plots
# TODO update the JSON string below
json = "{}"

2
python-client/docs/PreviewSettings.md
View File

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.preview_settings import PreviewSettings
from jfjoch_client.models.preview_settings import PreviewSettings
# TODO update the JSON string below
json = "{}"

2
python-client/docs/RoiBox.md
View File

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.roi_box import RoiBox
from jfjoch_client.models.roi_box import RoiBox
# TODO update the JSON string below
json = "{}"

2
python-client/docs/RoiBoxList.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.roi_box_list import RoiBoxList
from jfjoch_client.models.roi_box_list import RoiBoxList
# TODO update the JSON string below
json = "{}"

2
python-client/docs/RoiCircle.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.roi_circle import RoiCircle
from jfjoch_client.models.roi_circle import RoiCircle
# TODO update the JSON string below
json = "{}"

2
python-client/docs/RoiCircleList.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.roi_circle_list import RoiCircleList
from jfjoch_client.models.roi_circle_list import RoiCircleList
# TODO update the JSON string below
json = "{}"

2
python-client/docs/RotationAxis.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.rotation_axis import RotationAxis
from jfjoch_client.models.rotation_axis import RotationAxis
# TODO update the JSON string below
json = "{}"

2
python-client/docs/SpotFindingSettings.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.spot_finding_settings import SpotFindingSettings
from jfjoch_client.models.spot_finding_settings import SpotFindingSettings
# TODO update the JSON string below
json = "{}"

2
python-client/docs/StandardDetectorGeometry.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.standard_detector_geometry import StandardDetectorGeometry
from jfjoch_client.models.standard_detector_geometry import StandardDetectorGeometry
# TODO update the JSON string below
json = "{}"

3
python-client/docs/ZeromqSettings.md
View File

@@ -7,6 +7,7 @@ ZeroMQ configuration for Jungfraujoch software. This structure is used to provid
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**send_watermark** | **int** | Watermark for ZeroMQ send queue (number of outstanding messages queued on Jungfraujoch server per queue) | [optional] [default to 100]
**send_buffer_size** | **int** | Send buffer size for ZeroMQ socket | [optional]
**image_socket** | **List[str]** | PUSH ZeroMQ socket for images. In case multiple sockets are provided, images are streamed over multiple sockets. Images are serialized using CBOR. Address follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK. 0.0.0.0 instead of IP address is accepted and means listening on all network interfaces. | [optional]
**preview_socket** | **str** | PUB ZeroMQ socket for preview images. This socket operates at a reduced frame rate. Images are serialized using CBOR. Address follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK. 0.0.0.0 instead of IP address is accepted and means listening on all network interfaces. | [optional]
**writer_notification_socket** | **str** | PULL ZeroMQ socket for notifications from writer that it finished operation. This allows Jungfraujoch to operate in a synchronous manner, with end of acquisition being also end of writing. Address follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK. 0.0.0.0 instead of IP address should be avoided, as this socket address is forwarded to the writer process via START ZerOMQ message and in case of multiple ineterfaces the address might be ambigous. Using * (star) instead of port number is allowed and it means a random free port number. | [optional]
@@ -14,7 +15,7 @@ Name | Type | Description | Notes
## Example
```python
from openapi_client.models.zeromq_settings import ZeromqSettings
from jfjoch_client.models.zeromq_settings import ZeromqSettings
# TODO update the JSON string below
json = "{}"