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

Deploy site

Browse Source
This commit is contained in:
leonarski_f
2026-05-01 16:49:38 +00:00
commit 5fdda01ff4
366 changed files with 19524 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
_sources/python_client/docs/AzimIntSettings.md.txt
+34
View File
@@ -0,0 +1,34 @@
# AzimIntSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**polarization_corr** | **bool** | Apply polarization correction for azimuthal integration (polarization factor must be configured in dataset settings) | [default to True]
**solid_angle_corr** | **bool** | Apply solid angle correction for azimuthal integration | [default to True]
**high_q_recip_a** | **float** | |
**low_q_recip_a** | **float** | |
**q_spacing** | **float** | |
**azimuthal_bins** | **int** | Numer of azimuthal (phi) bins; 1 = standard 1D azimuthal integration | [optional] [default to 1]
## Example
```python
from jfjoch_client.models.azim_int_settings import AzimIntSettings
# TODO update the JSON string below
json = "{}"
# create an instance of AzimIntSettings from a JSON string
azim_int_settings_instance = AzimIntSettings.from_json(json)
# print the JSON string representation of the object
print(AzimIntSettings.to_json())
# convert the object into a dict
azim_int_settings_dict = azim_int_settings_instance.to_dict()
# create an instance of AzimIntSettings from a dict
azim_int_settings_from_dict = AzimIntSettings.from_dict(azim_int_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/BrokerStatus.md.txt
+34
View File
@@ -0,0 +1,34 @@
# BrokerStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**state** | **str** | |
**progress** | **float** | Progress of data collection (only available if receiving is running) | [optional]
**message** | **str** | Message to display besides state of the jfjoch_broker; mostly used for errors and warnings This matters especially for async functions (start/initialize), where API won't return reason for the error during async operation. | [optional]
**message_severity** | **str** | Level of the message to display | [optional] [default to 'error']
**gpu_count** | **int** | Number of installed GPUs | [optional]
**broker_version** | **str** | Version of the jfjoch_broker | [optional]
## Example
```python
from jfjoch_client.models.broker_status import BrokerStatus
# TODO update the JSON string below
json = "{}"
# create an instance of BrokerStatus from a JSON string
broker_status_instance = BrokerStatus.from_json(json)
# print the JSON string representation of the object
print(BrokerStatus.to_json())
# convert the object into a dict
broker_status_dict = broker_status_instance.to_dict()
# create an instance of BrokerStatus from a dict
broker_status_from_dict = BrokerStatus.from_dict(broker_status_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/CalibrationStatisticsInner.md.txt
+37
View File
@@ -0,0 +1,37 @@
# CalibrationStatisticsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**module_number** | **int** | |
**storage_cell_number** | **int** | |
**pedestal_g0_mean** | **float** | |
**pedestal_g1_mean** | **float** | |
**pedestal_g2_mean** | **float** | |
**gain_g0_mean** | **float** | |
**gain_g1_mean** | **float** | |
**gain_g2_mean** | **float** | |
**masked_pixels** | **int** | |
## Example
```python
from jfjoch_client.models.calibration_statistics_inner import CalibrationStatisticsInner
# TODO update the JSON string below
json = "{}"
# create an instance of CalibrationStatisticsInner from a JSON string
calibration_statistics_inner_instance = CalibrationStatisticsInner.from_json(json)
# print the JSON string representation of the object
print(CalibrationStatisticsInner.to_json())
# convert the object into a dict
calibration_statistics_inner_dict = calibration_statistics_inner_instance.to_dict()
# create an instance of CalibrationStatisticsInner from a dict
calibration_statistics_inner_from_dict = CalibrationStatisticsInner.from_dict(calibration_statistics_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/ColorScale.md.txt
+16
View File
@@ -0,0 +1,16 @@
# ColorScale
## Enum
* `INDIGO` (value: `'Indigo'`)
* `VIRIDIS` (value: `'Viridis'`)
* `BLACKWHITE` (value: `'BlackWhite'`)
* `HEAT` (value: `'Heat'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DarkMaskSettings.md.txt
+34
View File
@@ -0,0 +1,34 @@
# DarkMaskSettings
Settings for collection of dark images to be used for mask calculation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**detector_threshold_ke_v** | **float** | Energy threshold for dark image collection | [default to 3.5]
**frame_time_us** | **int** | Time between frames for dark image collection | [default to 10000]
**number_of_frames** | **int** | Number of frames for dark image collection; zero means no dark collection | [default to 1000]
**max_allowed_pixel_count** | **int** | Maximum count in a pixel considered normal (not-masked) | [default to 1]
**max_frames_with_signal** | **int** | Maximum number of frames with signal in a pixel considered normal (not-masked) | [default to 10]
## Example
```python
from jfjoch_client.models.dark_mask_settings import DarkMaskSettings
# TODO update the JSON string below
json = "{}"
# create an instance of DarkMaskSettings from a JSON string
dark_mask_settings_instance = DarkMaskSettings.from_json(json)
# print the JSON string representation of the object
print(DarkMaskSettings.to_json())
# convert the object into a dict
dark_mask_settings_dict = dark_mask_settings_instance.to_dict()
# create an instance of DarkMaskSettings from a dict
dark_mask_settings_from_dict = DarkMaskSettings.from_dict(dark_mask_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DatasetSettings.md.txt
+66
View File
@@ -0,0 +1,66 @@
# DatasetSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**images_per_trigger** | **int** | For standard synchrotron data collection - this is number of images collected per one TTL trigger For XFEL (pulsed source) - this number is ignored and set to 1 For storage cell mode - this number is ignored and set to number of storage cells | [optional] [default to 1]
**ntrigger** | **int** | Number of TTL trigger that the detector is expected to receive during data collection | [optional] [default to 1]
**image_time_us** | **int** | Image time. If not provided (or zero value) the frame time is assumed as default. For JUNGFRAU image time must be multiple of frame time and max value is 256 * frame_time. In XFEL mode: summation happens for frames collected with multiple triggers. Ignored for storage cells and if raw data are saved. | [optional]
**beam_x_pxl** | **float** | /entry/detector/beam_center_x in NXmx Beam center in X direction [pixels] |
**beam_y_pxl** | **float** | /entry/detector/beam_center_y in NXmx Beam center in X direction [pixels] |
**detector_distance_mm** | **float** | /entry/detector/distance in NXmx Detector distance [mm] |
**incident_energy_ke_v** | **float** | Used to calculate /entry/beam/incident_wavelength in NXmx Incident particle (photon, electron) energy in keV |
**file_prefix** | **str** | Prefix for filenames. If left empty, no file will be saved. | [optional] [default to '']
**images_per_file** | **int** | Number of files in a single HDF5 data file (0 = write all images to a single data file). | [optional] [default to 1000]
**space_group_number** | **int** | Number of space group for the crystal. Currently used solely as metadata, not relevant for image processing done in Jungfraujoch. | [optional]
**sample_name** | **str** | /entry/sample/name in NXmx Sample name | [optional] [default to '']
**compression** | **str** | Compression type for the images transferred over ZeroMQ and saved to HDF5 file. | [optional] [default to 'bslz4']
**total_flux** | **float** | /entry/beam/total_flux in NXmx Flux incident on beam plane in photons per second. In other words this is the flux integrated over area. [photons/s] | [optional]
**transmission** | **float** | /entry/instrument/attenuator/attenuator_transmission Transmission of attenuator (filter) [no units] | [optional]
**goniometer** | [**RotationAxis**](RotationAxis.md) | | [optional]
**grid_scan** | [**GridScan**](GridScan.md) | | [optional]
**header_appendix** | **object** | Header appendix, added as user_data/user to start ZeroMQ message (can be any valid JSON) In general, it is not saved in HDF5 file. However, if values are placed in \"hdf5\" object, `jfjoch_writer` will write them in /entry/data of the HDF5 file. This applies solely to string and number (double floating-point). No arrays/sub-objects is allowed. For example {\"hdf5\": {\"val1\":1, \"val2\":\"xyz\"}}, will write /entry/user/val1 and /entry/user/val2. | [optional]
**image_appendix** | **object** | Image appendix, added as user_data to image ZeroMQ message (can be any valid JSON) Not saved in HDF5 file | [optional]
**data_reduction_factor_serialmx** | **float** | Rate at which non-indexed images are accepted to be forwarded to writer. Value of 1.0 (default) means that all images are written. Values below zero mean that non-indexed images will be accepted with a given probability. | [optional] [default to 1.0]
**pixel_value_low_threshold** | **int** | Set all counts lower than the value to zero. When the value is set, negative numbers other than error pixel value are always set to zero. Setting to zero is equivalent to turning the option off. | [optional]
**run_number** | **int** | Number of run within an experimental session. Transferred over CBOR stream as \"series ID\", though not saved in HDF5 file. It is highly recommended to keep this number unique for each data collection during experimental series. If not provided, the number will be automatically incremented. | [optional]
**run_name** | **str** | Unique ID of run. Transferred over CBOR stream as \"unique series ID\", though not saved in HDF5 file. It is highly recommended to keep this name unique for each data collection during experimental series. If not provided, the name will be automatically generated as number + colon + file_prefix. | [optional]
**experiment_group** | **str** | Name of group owning the data (e.g. p-group or proposal number). Transferred over CBOR stream, though not saved in HDF5 file. | [optional]
**poisson_compression** | **int** | Enable lossy compression of pixel values that preserves Poisson statistics. Requires to provide a numerical factor SQ. Pixel value P will be transformed to round(sqrt(P) * SQ), with rounding to the closest integer. Compression is turned off if the value is missing or it is set to zero. | [optional]
**write_nxmx_hdf5_master** | **bool** | Write NXmx formatted HDF5 master file. Recommended to use for macromolecular crystallography experiments and to turn off for other experiments. | [optional] [default to True]
**save_calibration** | **bool** | Forward image calibration (at the moment pedestal and pedestal RMS for JUNGFRAU) using the ZeroMQ stream to writer. If parameter is not provided calibration will be saved only if more than 4 images are recorded. | [optional]
**polarization_factor** | **float** | Polarization factor for integration; 1.0 is horizontal polarization; -1.0 is vertical polarization | [optional]
**ring_current_m_a** | **float** | Ring current at the beginning of the data collection | [optional]
**sample_temperature_k** | **float** | Sample temperature in Kelvin | [optional]
**poni_rot1_rad** | **float** | PONI angle rot1 (see PyFAI documentation for details) in radians | [optional] [default to 0.0]
**poni_rot2_rad** | **float** | PONI angle rot2 (see PyFAI documentation for details) in radians | [optional] [default to 0.0]
**poni_rot3_rad** | **float** | PONI angle rot3 (see PyFAI documentation for details) in radians | [optional] [default to 0.0]
**unit_cell** | [**UnitCell**](UnitCell.md) | | [optional]
**spot_finding** | **bool** | Enable spot finding and save spots | [optional] [default to True]
**max_spot_count** | **int** | Maximum number of spots that are saved/used for indexing; spots with highest intensity are selected | [optional] [default to 250]
**detect_ice_rings** | **bool** | Flag spots as ice rings and reduce their effect on indexing | [optional]
**async_start** | **bool** | When set to true, `/start` will not wait for detector and Jungfraujoch to be ready for the measurement. | [optional] [default to False]
**xray_fluorescence_spectrum** | [**DatasetSettingsXrayFluorescenceSpectrum**](DatasetSettingsXrayFluorescenceSpectrum.md) | | [optional]
## Example
```python
from jfjoch_client.models.dataset_settings import DatasetSettings
# TODO update the JSON string below
json = "{}"
# create an instance of DatasetSettings from a JSON string
dataset_settings_instance = DatasetSettings.from_json(json)
# print the JSON string representation of the object
print(DatasetSettings.to_json())
# convert the object into a dict
dataset_settings_dict = dataset_settings_instance.to_dict()
# create an instance of DatasetSettings from a dict
dataset_settings_from_dict = DatasetSettings.from_dict(dataset_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DatasetSettingsUnitCell.md.txt
+35
View File
@@ -0,0 +1,35 @@
# DatasetSettingsUnitCell
Unit cell parameters. Necessary to run indexing. Units of angstrom and degree
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**a** | **float** | |
**b** | **float** | |
**c** | **float** | |
**alpha** | **float** | |
**beta** | **float** | |
**gamma** | **float** | |
## Example
```python
from jfjoch_client.models.dataset_settings_unit_cell import DatasetSettingsUnitCell
# TODO update the JSON string below
json = "{}"
# create an instance of DatasetSettingsUnitCell from a JSON string
dataset_settings_unit_cell_instance = DatasetSettingsUnitCell.from_json(json)
# print the JSON string representation of the object
print(DatasetSettingsUnitCell.to_json())
# convert the object into a dict
dataset_settings_unit_cell_dict = dataset_settings_unit_cell_instance.to_dict()
# create an instance of DatasetSettingsUnitCell from a dict
dataset_settings_unit_cell_from_dict = DatasetSettingsUnitCell.from_dict(dataset_settings_unit_cell_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DatasetSettingsXrayFluorescenceSpectrum.md.txt
+30
View File
@@ -0,0 +1,30 @@
# DatasetSettingsXrayFluorescenceSpectrum
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**energy_e_v** | **List[float]** | X-ray fluorescence scan energy for each measurement point |
**data** | **List[float]** | X-ray fluorescence scan result in arbitrary units; must be exactly the same length, as energy_eV |
## Example
```python
from jfjoch_client.models.dataset_settings_xray_fluorescence_spectrum import DatasetSettingsXrayFluorescenceSpectrum
# TODO update the JSON string below
json = "{}"
# create an instance of DatasetSettingsXrayFluorescenceSpectrum from a JSON string
dataset_settings_xray_fluorescence_spectrum_instance = DatasetSettingsXrayFluorescenceSpectrum.from_json(json)
# print the JSON string representation of the object
print(DatasetSettingsXrayFluorescenceSpectrum.to_json())
# convert the object into a dict
dataset_settings_xray_fluorescence_spectrum_dict = dataset_settings_xray_fluorescence_spectrum_instance.to_dict()
# create an instance of DatasetSettingsXrayFluorescenceSpectrum from a dict
dataset_settings_xray_fluorescence_spectrum_from_dict = DatasetSettingsXrayFluorescenceSpectrum.from_dict(dataset_settings_xray_fluorescence_spectrum_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DefaultApi.md.txt
+4213
View File
File diff suppressed because it is too large Load Diff
_sources/python_client/docs/Detector.md.txt
+49
View File
@@ -0,0 +1,49 @@
# Detector
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | |
**serial_number** | **str** | | [optional] [default to 'Unknown']
**type** | [**DetectorType**](DetectorType.md) | | [optional]
**high_voltage_v** | **int** | | [optional] [default to 0]
**udp_interface_count** | **int** | | [optional] [default to 1]
**module_sync** | **bool** | Use module 0 as master for timing. Only applies to JUNGFRAU detector (this cannot be turned off for EIGER). | [optional] [default to True]
**sensor_thickness_um** | **float** | | [optional] [default to 320]
**readout_time_ns** | **int** | Minimum difference between frame time and count time in microseconds Defaults are 3'000 ns for EIGER and 20'000 ns for JUNGFRAU | [optional]
**min_count_time_ns** | **int** | Minimum count time available for the detector. | [optional]
**min_frame_time_ns** | **int** | Minimum frame time available for the detector. | [optional]
**calibration_file** | **List[str]** | Can be empty for all detectors - default calibration used. For JUNGFRAU: list of gain files, one entry per module. For EIGER: one directory (with detector settings) or list of trim bit files, one entry per half-module. | [optional]
**hostname** | **List[str]** | Hostname for detector module. One entry per module One entry per module. Either empty or number of module entries. | [optional]
**sensor_material** | **str** | | [optional] [default to 'Si']
**tx_delay** | **List[int]** | | [optional]
**base_data_ipv4_address** | **str** | | [optional]
**standard_geometry** | [**StandardDetectorGeometry**](StandardDetectorGeometry.md) | | [optional]
**custom_geometry** | [**List[DetectorModule]**](DetectorModule.md) | | [optional]
**roi_mode** | **str** | ROI setting for DECTRIS detectors | [optional] [default to '']
**mirror_y** | **bool** | Mirror detector in Y direction to account for MX convention of (0,0) point in top left corner | [optional] [default to True]
**temp_thresold_deg_c** | **int** | Temperature threshold for JUNGFRAU detector modules | [optional] [default to 55]
**default_settings** | [**DetectorSettings**](DetectorSettings.md) | | [optional]
## Example
```python
from jfjoch_client.models.detector import Detector
# TODO update the JSON string below
json = "{}"
# create an instance of Detector from a JSON string
detector_instance = Detector.from_json(json)
# print the JSON string representation of the object
print(Detector.to_json())
# convert the object into a dict
detector_dict = detector_instance.to_dict()
# create an instance of Detector from a dict
detector_from_dict = Detector.from_dict(detector_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DetectorList.md.txt
+30
View File
@@ -0,0 +1,30 @@
# DetectorList
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**detectors** | [**List[DetectorListElement]**](DetectorListElement.md) | |
**current_id** | **int** | |
## Example
```python
from jfjoch_client.models.detector_list import DetectorList
# TODO update the JSON string below
json = "{}"
# create an instance of DetectorList from a JSON string
detector_list_instance = DetectorList.from_json(json)
# print the JSON string representation of the object
print(DetectorList.to_json())
# convert the object into a dict
detector_list_dict = detector_list_instance.to_dict()
# create an instance of DetectorList from a dict
detector_list_from_dict = DetectorList.from_dict(detector_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DetectorListDetectorsInner.md.txt
+36
View File
@@ -0,0 +1,36 @@
# DetectorListDetectorsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | |
**description** | **str** | |
**serial_number** | **str** | |
**base_ipv4_addr** | **str** | |
**udp_interface_count** | **int** | Number of UDP interfaces per detector module |
**nmodules** | **int** | |
**width** | **int** | |
**height** | **int** | |
## Example
```python
from jfjoch_client.models.detector_list_detectors_inner import DetectorListDetectorsInner
# TODO update the JSON string below
json = "{}"
# create an instance of DetectorListDetectorsInner from a JSON string
detector_list_detectors_inner_instance = DetectorListDetectorsInner.from_json(json)
# print the JSON string representation of the object
print(DetectorListDetectorsInner.to_json())
# convert the object into a dict
detector_list_detectors_inner_dict = detector_list_detectors_inner_instance.to_dict()
# create an instance of DetectorListDetectorsInner from a dict
detector_list_detectors_inner_from_dict = DetectorListDetectorsInner.from_dict(detector_list_detectors_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DetectorListElement.md.txt
+41
View File
@@ -0,0 +1,41 @@
# DetectorListElement
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | |
**description** | **str** | |
**serial_number** | **str** | |
**base_ipv4_addr** | **str** | |
**udp_interface_count** | **int** | Number of UDP interfaces per detector module |
**nmodules** | **int** | |
**width** | **int** | |
**height** | **int** | |
**pixel_size_mm** | **float** | | [optional]
**readout_time_ns** | **int** | |
**min_frame_time_ns** | **int** | |
**min_count_time_ns** | **int** | |
**type** | [**DetectorType**](DetectorType.md) | | [optional]
## Example
```python
from jfjoch_client.models.detector_list_element import DetectorListElement
# TODO update the JSON string below
json = "{}"
# create an instance of DetectorListElement from a JSON string
detector_list_element_instance = DetectorListElement.from_json(json)
# print the JSON string representation of the object
print(DetectorListElement.to_json())
# convert the object into a dict
detector_list_element_dict = detector_list_element_instance.to_dict()
# create an instance of DetectorListElement from a dict
detector_list_element_from_dict = DetectorListElement.from_dict(detector_list_element_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DetectorModule.md.txt
+32
View File
@@ -0,0 +1,32 @@
# DetectorModule
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**x0** | **float** | |
**y0** | **float** | |
**fast_axis** | [**DetectorModuleDirection**](DetectorModuleDirection.md) | |
**slow_axis** | [**DetectorModuleDirection**](DetectorModuleDirection.md) | |
## Example
```python
from jfjoch_client.models.detector_module import DetectorModule
# TODO update the JSON string below
json = "{}"
# create an instance of DetectorModule from a JSON string
detector_module_instance = DetectorModule.from_json(json)
# print the JSON string representation of the object
print(DetectorModule.to_json())
# convert the object into a dict
detector_module_dict = detector_module_instance.to_dict()
# create an instance of DetectorModule from a dict
detector_module_from_dict = DetectorModule.from_dict(detector_module_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DetectorModuleDirection.md.txt
+16
View File
@@ -0,0 +1,16 @@
# DetectorModuleDirection
## Enum
* `XP` (value: `'Xp'`)
* `XN` (value: `'Xn'`)
* `YP` (value: `'Yp'`)
* `YN` (value: `'Yn'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DetectorPowerState.md.txt
+15
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)
_sources/python_client/docs/DetectorSelection.md.txt
+29
View File
@@ -0,0 +1,29 @@
# DetectorSelection
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | |
## Example
```python
from jfjoch_client.models.detector_selection import DetectorSelection
# TODO update the JSON string below
json = "{}"
# create an instance of DetectorSelection from a JSON string
detector_selection_instance = DetectorSelection.from_json(json)
# print the JSON string representation of the object
print(DetectorSelection.to_json())
# convert the object into a dict
detector_selection_dict = detector_selection_instance.to_dict()
# create an instance of DetectorSelection from a dict
detector_selection_from_dict = DetectorSelection.from_dict(detector_selection_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DetectorSettings.md.txt
+44
View File
@@ -0,0 +1,44 @@
# DetectorSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frame_time_us** | **int** | Interval between consecutive frames. This is internal frame time for the JUNGFRAU detector, image time has to be integer multiply of this number. For EIGER detector this is default frame time, not used otherwise |
**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]
**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** | Number of images stored in the internal frame generator. | [optional] [default to 1]
**detector_trigger_delay_ns** | **int** | Delay between TTL trigger and acquisition start [ns] | [optional] [default to 0]
**timing** | [**DetectorTiming**](DetectorTiming.md) | | [optional] [default to DetectorTiming.TRIGGER]
**eiger_threshold_ke_v** | **float** | Threshold for the PSI EIGER detector and all DECTRIS detectors. If value is provided, it will be used for all subsequent acquisitions, irrespective of beam energy. If value is not provided, threshold will be determined on start of acquisition as half of incident energy. This might lead to increased start time. | [optional]
**eiger_bit_depth** | **int** | Bit depth of PSI EIGER read-out. This is If value is not provided, depth will be determined based on the image time: * Exposure time < 500 microseconds depth of 8 bit will be used, * 500 <= exposure time < 2622 microseconds depth of 16 bit will be used * Exposure time >= 2622 microseconds depth of 32 bit will be used. | [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_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 jfjoch_client.models.detector_settings import DetectorSettings
# TODO update the JSON string below
json = "{}"
# create an instance of DetectorSettings from a JSON string
detector_settings_instance = DetectorSettings.from_json(json)
# print the JSON string representation of the object
print(DetectorSettings.to_json())
# convert the object into a dict
detector_settings_dict = detector_settings_instance.to_dict()
# create an instance of DetectorSettings from a dict
detector_settings_from_dict = DetectorSettings.from_dict(detector_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DetectorState.md.txt
+19
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)
_sources/python_client/docs/DetectorStatus.md.txt
+34
View File
@@ -0,0 +1,34 @@
# DetectorStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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 |
**high_voltage_v** | **List[int]** | High voltage for detector modules |
## Example
```python
from jfjoch_client.models.detector_status import DetectorStatus
# TODO update the JSON string below
json = "{}"
# create an instance of DetectorStatus from a JSON string
detector_status_instance = DetectorStatus.from_json(json)
# print the JSON string representation of the object
print(DetectorStatus.to_json())
# convert the object into a dict
detector_status_dict = detector_status_instance.to_dict()
# create an instance of DetectorStatus from a dict
detector_status_from_dict = DetectorStatus.from_dict(detector_status_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/DetectorTiming.md.txt
+16
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)
_sources/python_client/docs/DetectorType.md.txt
+14
View File
@@ -0,0 +1,14 @@
# DetectorType
## Enum
* `EIGER` (value: `'EIGER'`)
* `JUNGFRAU` (value: `'JUNGFRAU'`)
* `DECTRIS` (value: `'DECTRIS'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/ErrorMessage.md.txt
+30
View File
@@ -0,0 +1,30 @@
# ErrorMessage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**msg** | **str** | Human readable message |
**reason** | **str** | Enumerate field for automated analysis |
## Example
```python
from jfjoch_client.models.error_message import ErrorMessage
# TODO update the JSON string below
json = "{}"
# create an instance of ErrorMessage from a JSON string
error_message_instance = ErrorMessage.from_json(json)
# print the JSON string representation of the object
print(ErrorMessage.to_json())
# convert the object into a dict
error_message_dict = error_message_instance.to_dict()
# create an instance of ErrorMessage from a dict
error_message_from_dict = ErrorMessage.from_dict(error_message_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/FileWriterFormat.md.txt
+23
View File
@@ -0,0 +1,23 @@
# FileWriterFormat
NoFileWritten - no files are written at all NXmxOnlyData - only data files are written, no master file NXmxLegacy - legacy format with soft links to data files in the master file; necessary for DECTRIS Albula 4.0 and DECTRIS Neggia NXmxVDS - newer format with virtual dataset linking data files in the master file, also includes better metadata handling NXmxIntegrated - single HDF5 per dataset CBF - CBF format (limited metadata) TIFF - TIFF format (no metadata)
## Enum
* `NXMXONLYDATA` (value: `'NXmxOnlyData'`)
* `NXMXLEGACY` (value: `'NXmxLegacy'`)
* `NXMXVDS` (value: `'NXmxVDS'`)
* `NXMXINTEGRATED` (value: `'NXmxIntegrated'`)
* `CBF` (value: `'CBF'`)
* `TIFF` (value: `'TIFF'`)
* `NOFILEWRITTEN` (value: `'NoFileWritten'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/FileWriterSettings.md.txt
+30
View File
@@ -0,0 +1,30 @@
# FileWriterSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**overwrite** | **bool** | Inform jfjoch_write to overwrite existing files. Otherwise files would be saved with .h5.{timestamp}.tmp suffix. | [optional] [default to False]
**format** | [**FileWriterFormat**](FileWriterFormat.md) | | [optional] [default to FileWriterFormat.NXMXLEGACY]
## Example
```python
from jfjoch_client.models.file_writer_settings import FileWriterSettings
# TODO update the JSON string below
json = "{}"
# create an instance of FileWriterSettings from a JSON string
file_writer_settings_instance = FileWriterSettings.from_json(json)
# print the JSON string representation of the object
print(FileWriterSettings.to_json())
# convert the object into a dict
file_writer_settings_dict = file_writer_settings_instance.to_dict()
# create an instance of FileWriterSettings from a dict
file_writer_settings_from_dict = FileWriterSettings.from_dict(file_writer_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/FpgaStatusInner.md.txt
+42
View File
@@ -0,0 +1,42 @@
# FpgaStatusInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pci_dev_id** | **str** | |
**serial_number** | **str** | |
**fw_version** | **str** | |
**base_mac_addr** | **str** | |
**eth_link_count** | **int** | |
**eth_link_status** | **int** | |
**power_usage_w** | **float** | |
**fpga_temp_c** | **float** | |
**hbm_temp_c** | **float** | |
**packets_udp** | **int** | |
**packets_sls** | **int** | |
**idle** | **bool** | |
**pcie_link_speed** | **int** | PCIe link speed measured by generation (expected value is 4 == PCIe Gen4) |
**pcie_link_width** | **int** | PCIe link width (expected value is 8 == x8) |
## Example
```python
from jfjoch_client.models.fpga_status_inner import FpgaStatusInner
# TODO update the JSON string below
json = "{}"
# create an instance of FpgaStatusInner from a JSON string
fpga_status_inner_instance = FpgaStatusInner.from_json(json)
# print the JSON string representation of the object
print(FpgaStatusInner.to_json())
# convert the object into a dict
fpga_status_inner_dict = fpga_status_inner_instance.to_dict()
# create an instance of FpgaStatusInner from a dict
fpga_status_inner_from_dict = FpgaStatusInner.from_dict(fpga_status_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/GeomRefinementAlgorithm.md.txt
+13
View File
@@ -0,0 +1,13 @@
# GeomRefinementAlgorithm
Selection of an post-indexing detector geometry refinement algorithm used by Jungfraujoch. This option is using non-linear least squares optimization to find unit cell and beam center.
## Enum
* `BEAMCENTER` (value: `'BeamCenter'`)
* `NONE` (value: `'None'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/GridPlot.md.txt
+30
View File
@@ -0,0 +1,30 @@
# GridPlot
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | **List[float]** | |
**width** | **int** | |
## Example
```python
from jfjoch_client.models.grid_plot import GridPlot
# TODO update the JSON string below
json = "{}"
# create an instance of GridPlot from a JSON string
grid_plot_instance = GridPlot.from_json(json)
# print the JSON string representation of the object
print(GridPlot.to_json())
# convert the object into a dict
grid_plot_dict = grid_plot_instance.to_dict()
# create an instance of GridPlot from a dict
grid_plot_from_dict = GridPlot.from_dict(grid_plot_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/GridPlots.md.txt
+30
View File
@@ -0,0 +1,30 @@
# GridPlots
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**plots** | [**List[GridPlot]**](GridPlot.md) | |
**width** | **int** | |
## Example
```python
from jfjoch_client.models.grid_plots import GridPlots
# TODO update the JSON string below
json = "{}"
# create an instance of GridPlots from a JSON string
grid_plots_instance = GridPlots.from_json(json)
# print the JSON string representation of the object
print(GridPlots.to_json())
# convert the object into a dict
grid_plots_dict = grid_plots_instance.to_dict()
# create an instance of GridPlots from a dict
grid_plots_from_dict = GridPlots.from_dict(grid_plots_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/GridScan.md.txt
+34
View File
@@ -0,0 +1,34 @@
# GridScan
Definition of a grid scan (mutually exclusive with `rotation_axis`)
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**n_fast** | **int** | Number of elements in the fast direction |
**step_x_um** | **float** | Step in grid along the fast direction. Can be negative. Positive number: left to right Negative number: right to left |
**step_y_um** | **float** | Step in grid along the slow direction. Can be negative. Positive number: top to bottom Negative number: bottom to top |
**vertical** | **bool** | If disabled: fast direction = X, slow direction = Y If enabled: fast direction = Y, slow direction = X | [optional] [default to False]
**snake** | **bool** | Flip fast direction for every second row | [optional] [default to False]
## Example
```python
from jfjoch_client.models.grid_scan import GridScan
# TODO update the JSON string below
json = "{}"
# create an instance of GridScan from a JSON string
grid_scan_instance = GridScan.from_json(json)
# print the JSON string representation of the object
print(GridScan.to_json())
# convert the object into a dict
grid_scan_dict = grid_scan_instance.to_dict()
# create an instance of GridScan from a dict
grid_scan_from_dict = GridScan.from_dict(grid_scan_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/GridScanResult.md.txt
+35
View File
@@ -0,0 +1,35 @@
# GridScanResult
Results of a grid scan
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**det_img** | **List[int]** | Detector image number for a given cell |
**bkg_estimate** | **List[float]** | |
**spot_count** | **List[int]** | |
**indexed_lattices** | **List[int]** | |
**mosaicity** | **List[float]** | |
**b_factor** | **List[float]** | |
## Example
```python
from jfjoch_client.models.grid_scan_result import GridScanResult
# TODO update the JSON string below
json = "{}"
# create an instance of GridScanResult from a JSON string
grid_scan_result_instance = GridScanResult.from_json(json)
# print the JSON string representation of the object
print(GridScanResult.to_json())
# convert the object into a dict
grid_scan_result_dict = grid_scan_result_instance.to_dict()
# create an instance of GridScanResult from a dict
grid_scan_result_from_dict = GridScanResult.from_dict(grid_scan_result_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/GridScanResultImagesInner.md.txt
+36
View File
@@ -0,0 +1,36 @@
# GridScanResultImagesInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**efficiency** | **float** | |
**number** | **int** | Detector image number for a given cell |
**bkg** | **float** | Background estimate | [optional]
**spots** | **int** | Spot count | [optional]
**index** | **int** | Indexing solution | [optional]
**mos** | **float** | Mosaicity estimate | [optional]
**b** | **float** | B-Factor estimate | [optional]
**uc** | [**UnitCell**](UnitCell.md) | | [optional]
## Example
```python
from jfjoch_client.models.grid_scan_result_images_inner import GridScanResultImagesInner
# TODO update the JSON string below
json = "{}"
# create an instance of GridScanResultImagesInner from a JSON string
grid_scan_result_images_inner_instance = GridScanResultImagesInner.from_json(json)
# print the JSON string representation of the object
print(GridScanResultImagesInner.to_json())
# convert the object into a dict
grid_scan_result_images_inner_dict = grid_scan_result_images_inner_instance.to_dict()
# create an instance of GridScanResultImagesInner from a dict
grid_scan_result_images_inner_from_dict = GridScanResultImagesInner.from_dict(grid_scan_result_images_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/ImageBufferStatus.md.txt
+36
View File
@@ -0,0 +1,36 @@
# ImageBufferStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**min_image_number** | **int** | Smallest image number available in the buffer |
**max_image_number** | **int** | Largest image number available in the buffer |
**image_numbers** | **List[int]** | Image numbers currently present in the buffer. |
**total_slots** | **int** | Number of slots in the image buffer. This number, compared to number of images in data collection and frame rate will determine \"retention\" rate of the image buffer. |
**available_slots** | **int** | Slots available for the data collection |
**in_preparation_slots** | **int** | Number of slots in the image buffer that are currently in preparation for sending. |
**in_sending_slots** | **int** | Number of slots in the image buffer that are currently sending/writing data. |
**current_counter** | **int** | Counter of changes in the image buffer - either new start message or new image added. For optimization one can only load new images/datasets from the HTTP if this value changes. Counter is optional as it was not implemented in older versions to avoid breaking change | [optional]
## Example
```python
from jfjoch_client.models.image_buffer_status import ImageBufferStatus
# TODO update the JSON string below
json = "{}"
# create an instance of ImageBufferStatus from a JSON string
image_buffer_status_instance = ImageBufferStatus.from_json(json)
# print the JSON string representation of the object
print(ImageBufferStatus.to_json())
# convert the object into a dict
image_buffer_status_dict = image_buffer_status_instance.to_dict()
# create an instance of ImageBufferStatus from a dict
image_buffer_status_from_dict = ImageBufferStatus.from_dict(image_buffer_status_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/ImageFormatSettings.md.txt
+39
View File
@@ -0,0 +1,39 @@
# ImageFormatSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**summation** | **bool** | Enable summation of images to a given image_time If disabled images are saved according to original detector speed, but image count is adjusted |
**geometry_transform** | **bool** | Place module read-out into their location on composed detector and extend multipixels |
**jungfrau_conversion** | **bool** | Convert pixel value in ADU to photon counts/energy Only affects JUNGFRAU detector |
**jungfrau_conversion_factor_ke_v** | **float** | Used to convert energy deposited into pixel to counts If not provided incident_energy_keV is used | [optional]
**bit_depth_image** | **int** | Bit depth of resulting image (it doesn't affect the detector read-out value) If not provided value is adjusted automatically | [optional]
**signed_output** | **bool** | Controls if pixels have signed output If not provided value is adjusted automatically | [optional]
**mask_module_edges** | **bool** | Mask 1 pixel on the module boundary | [default to True]
**mask_chip_edges** | **bool** | Mask multipixels on chip boundary | [default to True]
**jungfrau_mask_pixels_without_g0** | **bool** | JUNGFRAU: mask pixels that don't operate in G0, but do operate in G1 and G1. This should be turned off for cases, where detector is operated at room temperature with long exposure time. | [optional] [default to True]
**apply_mask** | **bool** | Masked pixels are set to special value in the images produced by Jungfraujoch | [default to False]
**jungfrau_pedestal_g0_rms_limit** | **int** | Pixels with pedestal G0 RMS above the threshold are marked as masked pixels | [optional] [default to 100]
## Example
```python
from jfjoch_client.models.image_format_settings import ImageFormatSettings
# TODO update the JSON string below
json = "{}"
# create an instance of ImageFormatSettings from a JSON string
image_format_settings_instance = ImageFormatSettings.from_json(json)
# print the JSON string representation of the object
print(ImageFormatSettings.to_json())
# convert the object into a dict
image_format_settings_dict = image_format_settings_instance.to_dict()
# create an instance of ImageFormatSettings from a dict
image_format_settings_from_dict = ImageFormatSettings.from_dict(image_format_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/ImagePusherStatus.md.txt
+35
View File
@@ -0,0 +1,35 @@
# ImagePusherStatus
Informs about status of the image pusher.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pusher_type** | [**ImagePusherType**](ImagePusherType.md) | | [default to ImagePusherType.NONE]
**addr** | **List[str]** | List of addresses of image pushers. For HDF5 socket - no addresses will be returned. For ZeroMQ - list of addresses for each socket will be provided. For TCP/IP - single address to connect all writers will be provided. |
**connected_writers** | **int** | Number of connected writers For ZeroMQ image socket: number is constant For TCP/IP image socket: number is updated live during operation |
**images_written** | **int** | Number of images written to the image socket. This number is updated live during operation for TCP/IP image socket and direct HDF5 writer. It is updated at the end of experiment for ZeroMQ image socket. | [optional]
**images_write_error** | **int** | Number of images that could not be written to the image socket. This number is updated live during operation for TCP/IP image socket. No other socket use it. | [optional]
**writer_fifo_utilization** | **List[int]** | Utilization of internal writer FIFO. This number is updated live during operation for TCP/IP image socket. No other socket use it. | [optional]
## Example
```python
from jfjoch_client.models.image_pusher_status import ImagePusherStatus
# TODO update the JSON string below
json = "{}"
# create an instance of ImagePusherStatus from a JSON string
image_pusher_status_instance = ImagePusherStatus.from_json(json)
# print the JSON string representation of the object
print(ImagePusherStatus.to_json())
# convert the object into a dict
image_pusher_status_dict = image_pusher_status_instance.to_dict()
# create an instance of ImagePusherStatus from a dict
image_pusher_status_from_dict = ImagePusherStatus.from_dict(image_pusher_status_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/ImagePusherType.md.txt
+18
View File
@@ -0,0 +1,18 @@
# ImagePusherType
## Enum
* `ZEROMQ` (value: `'ZeroMQ'`)
* `HDF5` (value: `'HDF5'`)
* `CBOR` (value: `'CBOR'`)
* `TCP` (value: `'TCP'`)
* `NONE` (value: `'None'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/IndexingAlgorithm.md.txt
+19
View File
@@ -0,0 +1,19 @@
# IndexingAlgorithm
Selection of an indexing algorithm used by Jungfraujoch
## Enum
* `FFBIDX` (value: `'FFBIDX'`)
* `FFT` (value: `'FFT'`)
* `FFTW` (value: `'FFTW'`)
* `AUTO` (value: `'Auto'`)
* `NONE` (value: `'None'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/IndexingSettings.md.txt
+44
View File
@@ -0,0 +1,44 @@
# IndexingSettings
Settings for crystallography indexing
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**algorithm** | [**IndexingAlgorithm**](IndexingAlgorithm.md) | | [default to IndexingAlgorithm.FFBIDX]
**fft_max_unit_cell_a** | **float** | Largest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT | [default to 250]
**fft_min_unit_cell_a** | **float** | Smallest unit cell to be indexed by FFT algorithm; parameter value affects execution time of FFT | [default to 10.0]
**fft_high_resolution_a** | **float** | Highest resolution of spots used for FFT algorithm; parameter value affects execution time of FFT. There is also correlation between smallest unit cell and max resolution, which need to be checked for very small systems. | [default to 2.0]
**fft_num_vectors** | **int** | Number of search directions for the FFT algorithm; parameter value affects execution time of FFT. | [default to 16384]
**tolerance** | **float** | Acceptance tolerance for spots after the indexing run - the larger the number, the more spots will be accepted |
**thread_count** | **int** | Thread count for indexing algorithm |
**geom_refinement_algorithm** | [**GeomRefinementAlgorithm**](GeomRefinementAlgorithm.md) | |
**unit_cell_dist_tolerance** | **float** | Relative distance tolerance for unit cell vs. reference; Lattices outside given tolerance will be ignored | [default to 0.05]
**viable_cell_min_spots** | **int** | Minimum number of indexed spots required for a cell to be considered viable | [default to 10]
**index_ice_rings** | **bool** | Include spots marked as ice rings in the indexing run. If `dataset_settings` doesn't have `detect_ice_rings` on, this option will have no effect on processing. | [default to False]
**rotation_indexing** | **bool** | | [default to False]
**rotation_indexing_min_angular_range_deg** | **float** | | [default to 20.0]
**rotation_indexing_angular_stride_deg** | **float** | | [default to 0.5]
**blocking** | **bool** | Indexing in Jungfraujoch goes with a dedicated thread pool. If set to false, the thread pool is non-blocking, i.e. if there are no threads available, image indexing will be skipped. This option is recommended for real-time processing at high frame rates. If set to true, the thread pool will block until a thread is available. | [default to True]
## Example
```python
from jfjoch_client.models.indexing_settings import IndexingSettings
# TODO update the JSON string below
json = "{}"
# create an instance of IndexingSettings from a JSON string
indexing_settings_instance = IndexingSettings.from_json(json)
# print the JSON string representation of the object
print(IndexingSettings.to_json())
# convert the object into a dict
indexing_settings_dict = indexing_settings_instance.to_dict()
# create an instance of IndexingSettings from a dict
indexing_settings_from_dict = IndexingSettings.from_dict(indexing_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/InstrumentMetadata.md.txt
+34
View File
@@ -0,0 +1,34 @@
# InstrumentMetadata
Metadata for a measurement instrument
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source_name** | **str** | |
**source_type** | **str** | Type of radiation source. NXmx gives a fixed dictionary, though Jungfraujoch is not enforcing compliance. https://manual.nexusformat.org/classes/base_classes/NXsource.html#nxsource NXsource allows the following: Spallation Neutron Source Pulsed Reactor Neutron Source Reactor Neutron Source Synchrotron X-ray Source Pulsed Muon Source Rotating Anode X-ray Fixed Tube X-ray UV Laser Free-Electron Laser Optical Laser Ion Source UV Plasma Source Metal Jet X-ray | [optional] [default to '']
**instrument_name** | **str** | |
**pulsed_source** | **bool** | Settings specific to XFEL (e.g., every image has to come from TTL trigger, save pulse ID and event code) | [optional] [default to False]
**electron_source** | **bool** | Settings specific to electron source (e.g., wavelength definition) | [optional] [default to False]
## Example
```python
from jfjoch_client.models.instrument_metadata import InstrumentMetadata
# TODO update the JSON string below
json = "{}"
# create an instance of InstrumentMetadata from a JSON string
instrument_metadata_instance = InstrumentMetadata.from_json(json)
# print the JSON string representation of the object
print(InstrumentMetadata.to_json())
# convert the object into a dict
instrument_metadata_dict = instrument_metadata_instance.to_dict()
# create an instance of InstrumentMetadata from a dict
instrument_metadata_from_dict = InstrumentMetadata.from_dict(instrument_metadata_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/JfjochBrokerApi.md.txt
+77
View File
@@ -0,0 +1,77 @@
# jfjoch_client.JfjochBrokerApi
All URIs are relative to *http://localhost:5232*
Method | HTTP request | Description
------------- | ------------- | -------------
[**config_zeromq_metadata_put**](JfjochBrokerApi.md#config_zeromq_metadata_put) | **PUT** /config/zeromq_metadata | Set ZeroMQ metadata settings
# **config_zeromq_metadata_put**
> config_zeromq_metadata_put(zeromq_metadata_settings=zeromq_metadata_settings)
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.
### Example
```python
import jfjoch_client
from jfjoch_client.models.zeromq_metadata_settings import ZeromqMetadataSettings
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.JfjochBrokerApi(api_client)
zeromq_metadata_settings = jfjoch_client.ZeromqMetadataSettings() # ZeromqMetadataSettings | (optional)
try:
# Set ZeroMQ metadata settings
api_instance.config_zeromq_metadata_put(zeromq_metadata_settings=zeromq_metadata_settings)
except Exception as e:
print("Exception when calling JfjochBrokerApi->config_zeromq_metadata_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**zeromq_metadata_settings** | [**ZeromqMetadataSettings**](ZeromqMetadataSettings.md)| | [optional]
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Everything OK | - |
**400** | Input parsing or validation error | - |
**500** | Error within Jungfraujoch code - see output message. | - |
[[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)
_sources/python_client/docs/JfjochSettings.md.txt
+49
View File
@@ -0,0 +1,49 @@
# JfjochSettings
Default settings for Jungfraujoch software. This structure is used to provide default settings using configuration JSON file and is not used in HTTP.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pcie** | [**List[PcieDevicesInner]**](PcieDevicesInner.md) | | [optional]
**zeromq** | [**ZeromqSettings**](ZeromqSettings.md) | | [optional]
**tcp** | [**TcpSettings**](TcpSettings.md) | | [optional]
**instrument** | [**InstrumentMetadata**](InstrumentMetadata.md) | | [optional]
**file_writer** | [**FileWriterSettings**](FileWriterSettings.md) | | [optional]
**detector** | [**List[Detector]**](Detector.md) | |
**indexing** | [**IndexingSettings**](IndexingSettings.md) | | [optional]
**detector_settings** | [**DetectorSettings**](DetectorSettings.md) | | [optional]
**azim_int** | [**AzimIntSettings**](AzimIntSettings.md) | | [optional]
**image_format** | [**ImageFormatSettings**](ImageFormatSettings.md) | | [optional]
**image_buffer_mi_b** | **int** | Size of internal buffer in MiB for images before they are sent to a stream | [optional] [default to 2048]
**verbose** | **bool** | Print extra debug information | [optional] [default to False]
**receiver_threads** | **int** | Number of threads used by the receiver | [optional] [default to 64]
**numa_policy** | **str** | NUMA policy to bind CPUs | [optional]
**frontend_directory** | **str** | Location of built JavaScript web frontend |
**spot_finding** | [**SpotFindingSettings**](SpotFindingSettings.md) | | [optional]
**image_pusher** | [**ImagePusherType**](ImagePusherType.md) | | [default to ImagePusherType.NONE]
**zeromq_preview** | [**ZeromqPreviewSettings**](ZeromqPreviewSettings.md) | | [optional]
**zeromq_metadata** | [**ZeromqMetadataSettings**](ZeromqMetadataSettings.md) | | [optional]
**dark_mask** | [**DarkMaskSettings**](DarkMaskSettings.md) | | [optional]
## Example
```python
from jfjoch_client.models.jfjoch_settings import JfjochSettings
# TODO update the JSON string below
json = "{}"
# create an instance of JfjochSettings from a JSON string
jfjoch_settings_instance = JfjochSettings.from_json(json)
# print the JSON string representation of the object
print(JfjochSettings.to_json())
# convert the object into a dict
jfjoch_settings_dict = jfjoch_settings_instance.to_dict()
# create an instance of JfjochSettings from a dict
jfjoch_settings_from_dict = JfjochSettings.from_dict(jfjoch_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/JfjochSettingsSsl.md.txt
+30
View File
@@ -0,0 +1,30 @@
# JfjochSettingsSsl
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**certificate** | **str** | |
**key** | **str** | |
## Example
```python
from jfjoch_client.models.jfjoch_settings_ssl import JfjochSettingsSsl
# TODO update the JSON string below
json = "{}"
# create an instance of JfjochSettingsSsl from a JSON string
jfjoch_settings_ssl_instance = JfjochSettingsSsl.from_json(json)
# print the JSON string representation of the object
print(JfjochSettingsSsl.to_json())
# convert the object into a dict
jfjoch_settings_ssl_dict = jfjoch_settings_ssl_instance.to_dict()
# create an instance of JfjochSettingsSsl from a dict
jfjoch_settings_ssl_from_dict = JfjochSettingsSsl.from_dict(jfjoch_settings_ssl_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/JfjochStatistics.md.txt
+49
View File
@@ -0,0 +1,49 @@
# JfjochStatistics
Pool statistics for Jungfraujoch to reduce transfers between frontend and jfjoch_broker
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**detector** | [**DetectorStatus**](DetectorStatus.md) | | [optional]
**detector_list** | [**DetectorList**](DetectorList.md) | | [optional]
**detector_settings** | [**DetectorSettings**](DetectorSettings.md) | | [optional]
**image_format_settings** | [**ImageFormatSettings**](ImageFormatSettings.md) | | [optional]
**instrument_metadata** | [**InstrumentMetadata**](InstrumentMetadata.md) | | [optional]
**file_writer_settings** | [**FileWriterSettings**](FileWriterSettings.md) | | [optional]
**data_processing_settings** | [**SpotFindingSettings**](SpotFindingSettings.md) | | [optional]
**measurement** | [**MeasurementStatistics**](MeasurementStatistics.md) | | [optional]
**broker** | [**BrokerStatus**](BrokerStatus.md) | | [optional]
**fpga** | [**List[FpgaStatusInner]**](FpgaStatusInner.md) | | [optional]
**calibration** | [**List[CalibrationStatisticsInner]**](CalibrationStatisticsInner.md) | | [optional]
**zeromq_preview** | [**ZeromqPreviewSettings**](ZeromqPreviewSettings.md) | | [optional]
**zeromq_metadata** | [**ZeromqMetadataSettings**](ZeromqMetadataSettings.md) | | [optional]
**dark_mask** | [**DarkMaskSettings**](DarkMaskSettings.md) | | [optional]
**pixel_mask** | [**PixelMaskStatistics**](PixelMaskStatistics.md) | | [optional]
**roi** | [**RoiDefinitions**](RoiDefinitions.md) | | [optional]
**az_int** | [**AzimIntSettings**](AzimIntSettings.md) | | [optional]
**buffer** | [**ImageBufferStatus**](ImageBufferStatus.md) | | [optional]
**indexing** | [**IndexingSettings**](IndexingSettings.md) | | [optional]
**image_pusher** | [**ImagePusherStatus**](ImagePusherStatus.md) | | [optional]
## Example
```python
from jfjoch_client.models.jfjoch_statistics import JfjochStatistics
# TODO update the JSON string below
json = "{}"
# create an instance of JfjochStatistics from a JSON string
jfjoch_statistics_instance = JfjochStatistics.from_json(json)
# print the JSON string representation of the object
print(JfjochStatistics.to_json())
# convert the object into a dict
jfjoch_statistics_dict = jfjoch_statistics_instance.to_dict()
# create an instance of JfjochStatistics from a dict
jfjoch_statistics_from_dict = JfjochStatistics.from_dict(jfjoch_statistics_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/MeasurementStatistics.md.txt
+51
View File
@@ -0,0 +1,51 @@
# MeasurementStatistics
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**file_prefix** | **str** | | [optional]
**run_number** | **int** | Number of data collection run. This can be either automatically incremented or provided externally for each data collection. | [optional]
**experiment_group** | **str** | Name of group owning the data (e.g. p-group or proposal number). | [optional]
**images_expected** | **int** | | [optional]
**images_collected** | **int** | Images collected by the receiver. This number will be lower than images expected if there were issues with data collection performance. | [optional]
**images_sent** | **int** | Images sent to the writer. The value does not include images discarded by lossy compression filter and images not forwarded due to full ZeroMQ queue. | [optional]
**images_written** | **int** | Images successfully written to disk. The value is live updated for TCP/IP socket and direct HDF5 writer, while for ZeroMQ it is only updated at the end of experiment. | [optional]
**images_discarded_lossy_compression** | **int** | Images discarded by the lossy compression filter | [optional]
**max_image_number_sent** | **int** | | [optional]
**collection_efficiency** | **float** | | [optional]
**compression_ratio** | **float** | | [optional]
**cancelled** | **bool** | | [optional]
**max_receiver_delay** | **int** | | [optional]
**indexing_rate** | **float** | | [optional]
**detector_width** | **int** | | [optional]
**detector_height** | **int** | | [optional]
**detector_pixel_depth** | **int** | | [optional]
**bkg_estimate** | **float** | | [optional]
**unit_cell** | **str** | | [optional]
**error_pixels** | **float** | Moving average of 1000 images counting number of error pixels on the detector | [optional]
**saturated_pixels** | **float** | Moving average of 1000 images counting number of saturated pixels on the detector | [optional]
**roi_beam_pixels** | **float** | If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images for number of valid pixels within this ROI | [optional]
**roi_beam_sum** | **float** | If there is an ROI defined with name \"beam\", this number will hold moving average of 1000 images for sum of valid pixels within this ROI | [optional]
## Example
```python
from jfjoch_client.models.measurement_statistics import MeasurementStatistics
# TODO update the JSON string below
json = "{}"
# create an instance of MeasurementStatistics from a JSON string
measurement_statistics_instance = MeasurementStatistics.from_json(json)
# print the JSON string representation of the object
print(MeasurementStatistics.to_json())
# convert the object into a dict
measurement_statistics_dict = measurement_statistics_instance.to_dict()
# create an instance of MeasurementStatistics from a dict
measurement_statistics_from_dict = MeasurementStatistics.from_dict(measurement_statistics_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/PcieDevicesInner.md.txt
+30
View File
@@ -0,0 +1,30 @@
# PcieDevicesInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**blk** | **str** | Block device name | [optional]
**ipv4** | **str** | IPv4 address of the block device | [optional]
## Example
```python
from jfjoch_client.models.pcie_devices_inner import PcieDevicesInner
# TODO update the JSON string below
json = "{}"
# create an instance of PcieDevicesInner from a JSON string
pcie_devices_inner_instance = PcieDevicesInner.from_json(json)
# print the JSON string representation of the object
print(PcieDevicesInner.to_json())
# convert the object into a dict
pcie_devices_inner_dict = pcie_devices_inner_instance.to_dict()
# create an instance of PcieDevicesInner from a dict
pcie_devices_inner_from_dict = PcieDevicesInner.from_dict(pcie_devices_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/PixelMaskStatistics.md.txt
+31
View File
@@ -0,0 +1,31 @@
# PixelMaskStatistics
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user_mask** | **int** | Number of pixels masked using the user mask | [optional]
**too_high_pedestal_rms** | **int** | Number of pixels with G0 pedestal RMS higher than provided threshold | [optional]
**wrong_gain** | **int** | Number of pixels that show wrong gain level during the pedestal procedure | [optional]
## Example
```python
from jfjoch_client.models.pixel_mask_statistics import PixelMaskStatistics
# TODO update the JSON string below
json = "{}"
# create an instance of PixelMaskStatistics from a JSON string
pixel_mask_statistics_instance = PixelMaskStatistics.from_json(json)
# print the JSON string representation of the object
print(PixelMaskStatistics.to_json())
# convert the object into a dict
pixel_mask_statistics_dict = pixel_mask_statistics_instance.to_dict()
# create an instance of PixelMaskStatistics from a dict
pixel_mask_statistics_from_dict = PixelMaskStatistics.from_dict(pixel_mask_statistics_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/Plot.md.txt
+33
View File
@@ -0,0 +1,33 @@
# Plot
x and y coordinates for plotting, it is OK to assume that both arrays have the same size; layout is optimized for Plotly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | | [default to '']
**x** | **List[float]** | |
**y** | **List[Optional[float]]** | |
**z** | **List[Optional[float]]** | | [optional]
## Example
```python
from jfjoch_client.models.plot import Plot
# TODO update the JSON string below
json = "{}"
# create an instance of Plot from a JSON string
plot_instance = Plot.from_json(json)
# print the JSON string representation of the object
print(Plot.to_json())
# convert the object into a dict
plot_dict = plot_instance.to_dict()
# create an instance of Plot from a dict
plot_from_dict = Plot.from_dict(plot_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/PlotTypeEnum.md.txt
+48
View File
@@ -0,0 +1,48 @@
# PlotTypeEnum
## Enum
* `BKG_ESTIMATE` (value: `'bkg_estimate'`)
* `AZINT` (value: `'azint'`)
* `SPOT_COUNT` (value: `'spot_count'`)
* `INDEXING_RATE` (value: `'indexing_rate'`)
* `INDEXING_UNIT_CELL_LENGTH` (value: `'indexing_unit_cell_length'`)
* `INDEXING_UNIT_CELL_ANGLE` (value: `'indexing_unit_cell_angle'`)
* `ERROR_PIXELS` (value: `'error_pixels'`)
* `IMAGE_COLLECTION_EFFICIENCY` (value: `'image_collection_efficiency'`)
* `RECEIVER_DELAY` (value: `'receiver_delay'`)
* `RECEIVER_FREE_SEND_BUF` (value: `'receiver_free_send_buf'`)
* `STRONG_PIXELS` (value: `'strong_pixels'`)
* `ROI_SUM` (value: `'roi_sum'`)
* `ROI_MEAN` (value: `'roi_mean'`)
* `ROI_MAX_COUNT` (value: `'roi_max_count'`)
* `ROI_PIXELS` (value: `'roi_pixels'`)
* `ROI_WEIGHTED_X` (value: `'roi_weighted_x'`)
* `ROI_WEIGHTED_Y` (value: `'roi_weighted_y'`)
* `PACKETS_RECEIVED` (value: `'packets_received'`)
* `MAX_PIXEL_VALUE` (value: `'max_pixel_value'`)
* `RESOLUTION_ESTIMATE` (value: `'resolution_estimate'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/PlotUnitX.md.txt
+20
View File
@@ -0,0 +1,20 @@
# PlotUnitX
## Enum
* `IMAGE_NUMBER` (value: `'image_number'`)
* `Q_RECIP_A` (value: `'q_recipA'`)
* `D_A` (value: `'d_A'`)
* `ANGLE_DEG` (value: `'angle_deg'`)
* `ADU` (value: `'ADU'`)
* `GRID_UM` (value: `'grid_um'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/Plots.md.txt
+33
View File
@@ -0,0 +1,33 @@
# Plots
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | | [optional]
**unit_x** | [**PlotUnitX**](PlotUnitX.md) | | [default to PlotUnitX.IMAGE_NUMBER]
**size_x** | **float** | Max X range of the plot | [optional]
**size_y** | **float** | Max Y range of the plot | [optional]
**plot** | [**List[Plot]**](Plot.md) | |
## Example
```python
from jfjoch_client.models.plots import Plots
# TODO update the JSON string below
json = "{}"
# create an instance of Plots from a JSON string
plots_instance = Plots.from_json(json)
# print the JSON string representation of the object
print(Plots.to_json())
# convert the object into a dict
plots_dict = plots_instance.to_dict()
# create an instance of Plots from a dict
plots_from_dict = Plots.from_dict(plots_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/PreviewSettings.md.txt
+36
View File
@@ -0,0 +1,36 @@
# PreviewSettings
Settings for JPEG rendering of preview images
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**saturation** | **int** | Saturation value to set contrast in the preview image |
**show_spots** | **bool** | Show spot finding results on the image | [optional] [default to True]
**show_roi** | **bool** | Show ROI areas on the image | [optional] [default to False]
**jpeg_quality** | **int** | Quality of JPEG image (100 - highest; 0 - lowest) | [optional] [default to 100]
**show_indexed** | **bool** | Preview indexed images only | [optional] [default to False]
**show_user_mask** | **bool** | Show user mask | [optional] [default to False]
**resolution_ring** | **float** | | [optional] [default to 0.1]
## Example
```python
from jfjoch_client.models.preview_settings import PreviewSettings
# TODO update the JSON string below
json = "{}"
# create an instance of PreviewSettings from a JSON string
preview_settings_instance = PreviewSettings.from_json(json)
# print the JSON string representation of the object
print(PreviewSettings.to_json())
# convert the object into a dict
preview_settings_dict = preview_settings_instance.to_dict()
# create an instance of PreviewSettings from a dict
preview_settings_from_dict = PreviewSettings.from_dict(preview_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/RoiAzimList.md.txt
+30
View File
@@ -0,0 +1,30 @@
# RoiAzimList
List of azimuthal ROIs
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rois** | [**List[RoiAzimuthal]**](RoiAzimuthal.md) | | [optional]
## Example
```python
from jfjoch_client.models.roi_azim_list import RoiAzimList
# TODO update the JSON string below
json = "{}"
# create an instance of RoiAzimList from a JSON string
roi_azim_list_instance = RoiAzimList.from_json(json)
# print the JSON string representation of the object
print(RoiAzimList.to_json())
# convert the object into a dict
roi_azim_list_dict = roi_azim_list_instance.to_dict()
# create an instance of RoiAzimList from a dict
roi_azim_list_from_dict = RoiAzimList.from_dict(roi_azim_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/RoiAzimuthal.md.txt
+32
View File
@@ -0,0 +1,32 @@
# RoiAzimuthal
ROI as Q-range (or resolution range)
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name for the ROI; used in the plots |
**q_min_recip_a** | **float** | Minimum Q-range for the ROI |
**q_max_recip_a** | **float** | Maximum Q-range for the ROI |
## Example
```python
from jfjoch_client.models.roi_azimuthal import RoiAzimuthal
# TODO update the JSON string below
json = "{}"
# create an instance of RoiAzimuthal from a JSON string
roi_azimuthal_instance = RoiAzimuthal.from_json(json)
# print the JSON string representation of the object
print(RoiAzimuthal.to_json())
# convert the object into a dict
roi_azimuthal_dict = roi_azimuthal_instance.to_dict()
# create an instance of RoiAzimuthal from a dict
roi_azimuthal_from_dict = RoiAzimuthal.from_dict(roi_azimuthal_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/RoiBox.md.txt
+34
View File
@@ -0,0 +1,34 @@
# RoiBox
Box ROI
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name for the ROI; used in the plots |
**min_x_pxl** | **int** | Lower bound (inclusive) in X coordinate for the box |
**max_x_pxl** | **int** | Upper bound (inclusive) in X coordinate for the box |
**min_y_pxl** | **int** | Lower bound (inclusive) in Y coordinate for the box |
**max_y_pxl** | **int** | Upper bound (inclusive) in Y coordinate for the box |
## Example
```python
from jfjoch_client.models.roi_box import RoiBox
# TODO update the JSON string below
json = "{}"
# create an instance of RoiBox from a JSON string
roi_box_instance = RoiBox.from_json(json)
# print the JSON string representation of the object
print(RoiBox.to_json())
# convert the object into a dict
roi_box_dict = roi_box_instance.to_dict()
# create an instance of RoiBox from a dict
roi_box_from_dict = RoiBox.from_dict(roi_box_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/RoiBoxList.md.txt
+30
View File
@@ -0,0 +1,30 @@
# RoiBoxList
List of box ROIs
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rois** | [**List[RoiBox]**](RoiBox.md) | | [optional]
## Example
```python
from jfjoch_client.models.roi_box_list import RoiBoxList
# TODO update the JSON string below
json = "{}"
# create an instance of RoiBoxList from a JSON string
roi_box_list_instance = RoiBoxList.from_json(json)
# print the JSON string representation of the object
print(RoiBoxList.to_json())
# convert the object into a dict
roi_box_list_dict = roi_box_list_instance.to_dict()
# create an instance of RoiBoxList from a dict
roi_box_list_from_dict = RoiBoxList.from_dict(roi_box_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/RoiCircle.md.txt
+33
View File
@@ -0,0 +1,33 @@
# RoiCircle
Circular ROI
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name for the ROI; used in the plots |
**center_x_pxl** | **float** | X coordinate of center of the circle [pixels] |
**center_y_pxl** | **float** | Y coordinate of center of the circle [pixels] |
**radius_pxl** | **float** | Radius of the circle [pixels] |
## Example
```python
from jfjoch_client.models.roi_circle import RoiCircle
# TODO update the JSON string below
json = "{}"
# create an instance of RoiCircle from a JSON string
roi_circle_instance = RoiCircle.from_json(json)
# print the JSON string representation of the object
print(RoiCircle.to_json())
# convert the object into a dict
roi_circle_dict = roi_circle_instance.to_dict()
# create an instance of RoiCircle from a dict
roi_circle_from_dict = RoiCircle.from_dict(roi_circle_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/RoiCircleList.md.txt
+30
View File
@@ -0,0 +1,30 @@
# RoiCircleList
List of circular ROIs
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rois** | [**List[RoiCircle]**](RoiCircle.md) | |
## Example
```python
from jfjoch_client.models.roi_circle_list import RoiCircleList
# TODO update the JSON string below
json = "{}"
# create an instance of RoiCircleList from a JSON string
roi_circle_list_instance = RoiCircleList.from_json(json)
# print the JSON string representation of the object
print(RoiCircleList.to_json())
# convert the object into a dict
roi_circle_list_dict = roi_circle_list_instance.to_dict()
# create an instance of RoiCircleList from a dict
roi_circle_list_from_dict = RoiCircleList.from_dict(roi_circle_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/RoiDefinitions.md.txt
+32
View File
@@ -0,0 +1,32 @@
# RoiDefinitions
ROI defintions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**box** | [**RoiBoxList**](RoiBoxList.md) | |
**circle** | [**RoiCircleList**](RoiCircleList.md) | |
**azim** | [**RoiAzimList**](RoiAzimList.md) | |
## Example
```python
from jfjoch_client.models.roi_definitions import RoiDefinitions
# TODO update the JSON string below
json = "{}"
# create an instance of RoiDefinitions from a JSON string
roi_definitions_instance = RoiDefinitions.from_json(json)
# print the JSON string representation of the object
print(RoiDefinitions.to_json())
# convert the object into a dict
roi_definitions_dict = roi_definitions_instance.to_dict()
# create an instance of RoiDefinitions from a dict
roi_definitions_from_dict = RoiDefinitions.from_dict(roi_definitions_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/RotationAxis.md.txt
+35
View File
@@ -0,0 +1,35 @@
# RotationAxis
Definition of a crystal rotation axis
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of rotation axis (e.g., omega, phi) | [optional] [default to 'omega']
**step** | **float** | Angle step (per image) in degrees |
**start** | **float** | Start angle in degrees | [optional] [default to 0]
**vector** | **List[float]** | Rotation axis |
**helical_step_um** | **List[float]** | Translation (per image) for helical scan | [optional]
**screening_wedge_deg** | **float** | Wedge angle value; used if rotation per image is smaller than increment between images (so particularly in screening) | [optional]
## Example
```python
from jfjoch_client.models.rotation_axis import RotationAxis
# TODO update the JSON string below
json = "{}"
# create an instance of RotationAxis from a JSON string
rotation_axis_instance = RotationAxis.from_json(json)
# print the JSON string representation of the object
print(RotationAxis.to_json())
# convert the object into a dict
rotation_axis_dict = rotation_axis_instance.to_dict()
# create an instance of RotationAxis from a dict
rotation_axis_from_dict = RotationAxis.from_dict(rotation_axis_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/ScanResult.md.txt
+33
View File
@@ -0,0 +1,33 @@
# ScanResult
Results of a scan
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**file_prefix** | **str** | | [optional]
**rotation_unit_cell** | [**UnitCell**](UnitCell.md) | | [optional]
**rotation_crystal_lattice** | **List[float]** | Real-space crystal lattice 3D vectors in Angstrom. Order is 1st vector (x,y,z), 2nd vector (x,y,z) and 3rd vector (x,y,z) | [optional]
**images** | [**List[ScanResultImagesInner]**](ScanResultImagesInner.md) | |
## Example
```python
from jfjoch_client.models.scan_result import ScanResult
# TODO update the JSON string below
json = "{}"
# create an instance of ScanResult from a JSON string
scan_result_instance = ScanResult.from_json(json)
# print the JSON string representation of the object
print(ScanResult.to_json())
# convert the object into a dict
scan_result_dict = scan_result_instance.to_dict()
# create an instance of ScanResult from a dict
scan_result_from_dict = ScanResult.from_dict(scan_result_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/ScanResultImagesInner.md.txt
+48
View File
@@ -0,0 +1,48 @@
# ScanResultImagesInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**efficiency** | **float** | |
**number** | **int** | Detector image number for a given cell |
**nx** | **int** | Cell position in X for grid scan | [optional]
**ny** | **int** | Cell position in Y for grid scan | [optional]
**angle** | **float** | Rotation angle associated with the image | [optional]
**bkg** | **float** | Background estimate | [optional]
**spots** | **int** | Spot count | [optional]
**spots_low_res** | **int** | Spot count in low resolution range | [optional]
**spots_indexed** | **int** | Spot count within indexing tolerance | [optional]
**spots_ice** | **int** | Spot count within common ice ring resolutions | [optional]
**index** | **int** | Indexing solution | [optional]
**pr** | **float** | Profile radius, i.e. how far reflections are from the Ewald sphere | [optional]
**b** | **float** | B-Factor estimate | [optional]
**uc** | [**UnitCell**](UnitCell.md) | | [optional]
**xfel_pulseid** | **int** | XFEL pulse ID | [optional]
**pixel_sum** | **int** | Total sum of all pixels | [optional]
**max** | **int** | Max viable pixel | [optional]
**sat** | **int** | Number of saturated pixels | [optional]
**err** | **int** | Number of error pixels | [optional]
**res** | **float** | Diffraction resolution estimate | [optional]
## Example
```python
from jfjoch_client.models.scan_result_images_inner import ScanResultImagesInner
# TODO update the JSON string below
json = "{}"
# create an instance of ScanResultImagesInner from a JSON string
scan_result_images_inner_instance = ScanResultImagesInner.from_json(json)
# print the JSON string representation of the object
print(ScanResultImagesInner.to_json())
# convert the object into a dict
scan_result_images_inner_dict = scan_result_images_inner_instance.to_dict()
# create an instance of ScanResultImagesInner from a dict
scan_result_images_inner_from_dict = ScanResultImagesInner.from_dict(scan_result_images_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/SpotFindingSettings.md.txt
+40
View File
@@ -0,0 +1,40 @@
# SpotFindingSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enable** | **bool** | Enable spot finding. This is temporary setting, i.e. can be changed anytime during data collection. Even if disabled spot finding information will still be send and written, though always with zero spots. | [default to True]
**indexing** | **bool** | Enable indexing. This is temporary setting, i.e. can be changed anytime during data collection. | [default to True]
**signal_to_noise_threshold** | **float** | |
**photon_count_threshold** | **int** | |
**min_pix_per_spot** | **int** | |
**max_pix_per_spot** | **int** | |
**high_resolution_limit** | **float** | High resolution limit for spot finding [Angstrom] |
**low_resolution_limit** | **float** | Low resolution limit for spot finding [Angstrom] |
**high_resolution_limit_for_spot_count_low_res** | **float** | High resolution threshold to consider spot \"low resolution\" [Angstrom] |
**quick_integration** | **bool** | Quick integration of Bragg spots in diffraction images. If enabled it will likely reduce performance of Jungfraujoch for datasets with a very high indexing rate. (experimental feature) | [default to False]
**ice_ring_width_q_recip_a** | **float** | Width of ice ring in q-space in reciprocal space | [default to 0.02]
**high_res_gap_q_recip_a** | **float** | This parameter is used to remove spurious spots at a very high resolution, that sometimes appear due to very low background close to the edge of the detector. If there is a gap in (1/d)-space between spots of at least this size, spots on the side of the gap with high resolution will be discarded. This is optional parameter. This option should be turned OFF for small molecule datasets or for crystals with very low mosaicity, when it is expected to see only few spots in any case. | [optional] [default to 1.5]
## Example
```python
from jfjoch_client.models.spot_finding_settings import SpotFindingSettings
# TODO update the JSON string below
json = "{}"
# create an instance of SpotFindingSettings from a JSON string
spot_finding_settings_instance = SpotFindingSettings.from_json(json)
# print the JSON string representation of the object
print(SpotFindingSettings.to_json())
# convert the object into a dict
spot_finding_settings_dict = spot_finding_settings_instance.to_dict()
# create an instance of SpotFindingSettings from a dict
spot_finding_settings_from_dict = SpotFindingSettings.from_dict(spot_finding_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/StandardDetectorGeometry.md.txt
+33
View File
@@ -0,0 +1,33 @@
# StandardDetectorGeometry
Regular rectangular geometry, first module is in the bottom left corner of the detector
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**nmodules** | **int** | Number of modules in the detector |
**gap_x** | **int** | Gap size in X direction [pixels] | [optional] [default to 8]
**gap_y** | **int** | Gap size in Y direction [pixels] | [optional] [default to 36]
**modules_in_row** | **int** | Number of modules in one row | [optional] [default to 1]
## Example
```python
from jfjoch_client.models.standard_detector_geometry import StandardDetectorGeometry
# TODO update the JSON string below
json = "{}"
# create an instance of StandardDetectorGeometry from a JSON string
standard_detector_geometry_instance = StandardDetectorGeometry.from_json(json)
# print the JSON string representation of the object
print(StandardDetectorGeometry.to_json())
# convert the object into a dict
standard_detector_geometry_dict = standard_detector_geometry_instance.to_dict()
# create an instance of StandardDetectorGeometry from a dict
standard_detector_geometry_from_dict = StandardDetectorGeometry.from_dict(standard_detector_geometry_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/TcpSettings.md.txt
+32
View File
@@ -0,0 +1,32 @@
# TcpSettings
TCP image stream configuration for Jungfraujoch software. This structure is used to provide default settings using configuration JSON file and is not used in HTTP.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**send_buffer_size** | **int** | Send buffer size for TCP/IP socket | [optional]
**image_socket** | **str** | tcp://<IP address>:<port> 0.0.0.0 instead of IP address is accepted and means listening on all network interfaces | [optional]
**nwriters** | **int** | Number of TCP/IP writers to be used for streaming images | [optional] [default to 32]
## Example
```python
from jfjoch_client.models.tcp_settings import TcpSettings
# TODO update the JSON string below
json = "{}"
# create an instance of TcpSettings from a JSON string
tcp_settings_instance = TcpSettings.from_json(json)
# print the JSON string representation of the object
print(TcpSettings.to_json())
# convert the object into a dict
tcp_settings_dict = tcp_settings_instance.to_dict()
# create an instance of TcpSettings from a dict
tcp_settings_from_dict = TcpSettings.from_dict(tcp_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/UnitCell.md.txt
+35
View File
@@ -0,0 +1,35 @@
# UnitCell
Unit cell parameters. Necessary to run indexing. Units of angstrom and degree
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**a** | **float** | |
**b** | **float** | |
**c** | **float** | |
**alpha** | **float** | |
**beta** | **float** | |
**gamma** | **float** | |
## Example
```python
from jfjoch_client.models.unit_cell import UnitCell
# TODO update the JSON string below
json = "{}"
# create an instance of UnitCell from a JSON string
unit_cell_instance = UnitCell.from_json(json)
# print the JSON string representation of the object
print(UnitCell.to_json())
# convert the object into a dict
unit_cell_dict = unit_cell_instance.to_dict()
# create an instance of UnitCell from a dict
unit_cell_from_dict = UnitCell.from_dict(unit_cell_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/ZeromqMetadataSettings.md.txt
+31
View File
@@ -0,0 +1,31 @@
# ZeromqMetadataSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | ZeroMQ metadata socket is enabled. | [default to True]
**period_ms** | **int** | Period for generating metadata package sent to the ZeroMQ interface in milliseconds. | [default to 1000]
**socket_address** | **str** | PUB ZeroMQ socket for image metadata information. Image metadata are serialized using CBOR. Address follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tcp://<IP address>:<port> sockets are OK. 0.0.0.0 instead of IP address is accepted and means listening on all network interfaces. | [optional]
## Example
```python
from jfjoch_client.models.zeromq_metadata_settings import ZeromqMetadataSettings
# TODO update the JSON string below
json = "{}"
# create an instance of ZeromqMetadataSettings from a JSON string
zeromq_metadata_settings_instance = ZeromqMetadataSettings.from_json(json)
# print the JSON string representation of the object
print(ZeromqMetadataSettings.to_json())
# convert the object into a dict
zeromq_metadata_settings_dict = zeromq_metadata_settings_instance.to_dict()
# create an instance of ZeromqMetadataSettings from a dict
zeromq_metadata_settings_from_dict = ZeromqMetadataSettings.from_dict(zeromq_metadata_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/ZeromqPreviewSettings.md.txt
+31
View File
@@ -0,0 +1,31 @@
# ZeromqPreviewSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | ZeroMQ preview socket is enabled. | [default to True]
**period_ms** | **int** | Period for generating preview image sent to the ZeroMQ interface in milliseconds. Default is 1 second. If set to zero, all images will be sent ZeroMQ (should be used only in case of relatively slow data collection). This has no effect on HTTP based preview, which updates always at rate of 1 second. | [default to 1000]
**socket_address** | **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 tcp://<IP address>:<port> sockets are OK. 0.0.0.0 instead of IP address is accepted and means listening on all network interfaces. | [optional]
## Example
```python
from jfjoch_client.models.zeromq_preview_settings import ZeromqPreviewSettings
# TODO update the JSON string below
json = "{}"
# create an instance of ZeromqPreviewSettings from a JSON string
zeromq_preview_settings_instance = ZeromqPreviewSettings.from_json(json)
# print the JSON string representation of the object
print(ZeromqPreviewSettings.to_json())
# convert the object into a dict
zeromq_preview_settings_dict = zeromq_preview_settings_instance.to_dict()
# create an instance of ZeromqPreviewSettings from a dict
zeromq_preview_settings_from_dict = ZeromqPreviewSettings.from_dict(zeromq_preview_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
_sources/python_client/docs/ZeromqSettings.md.txt
+33
View File
@@ -0,0 +1,33 @@
# ZeromqSettings
ZeroMQ configuration for Jungfraujoch software. This structure is used to provide default settings using configuration JSON file and is not used in HTTP.
## Properties
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]
**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]
## Example
```python
from jfjoch_client.models.zeromq_settings import ZeromqSettings
# TODO update the JSON string below
json = "{}"
# create an instance of ZeromqSettings from a JSON string
zeromq_settings_instance = ZeromqSettings.from_json(json)
# print the JSON string representation of the object
print(ZeromqSettings.to_json())
# convert the object into a dict
zeromq_settings_dict = zeromq_settings_instance.to_dict()
# create an instance of ZeromqSettings from a dict
zeromq_settings_from_dict = ZeromqSettings.from_dict(zeromq_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)