version 1.0.0-rc.13
This commit is contained in:
@@ -0,0 +1,33 @@
|
||||
# AzimIntSettings
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**polarization_factor** | **float** | If polarization factor is provided, than polarization correction is enabled. | [optional]
|
||||
**solid_angle_corr** | **bool** | Apply solid angle correction for radial integration | [default to True]
|
||||
**high_q_recip_a** | **float** | |
|
||||
**low_q_recip_a** | **float** | |
|
||||
**q_spacing** | **float** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# BrokerStatus
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**state** | **str** | |
|
||||
**progress** | **float** | | [optional]
|
||||
**indexing_rate** | **float** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -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 openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
# 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. Image time must be multiple of frame time; 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** | | [optional] [default to 0]
|
||||
**sample_name** | **str** | /entry/sample/name in NXmx Sample name | [optional] [default to '']
|
||||
**compression** | **str** | | [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]
|
||||
**header_appendix** | **object** | Header appendix, added as user_data/user to start message (can be any valid JSON) | [optional]
|
||||
**image_appendix** | **object** | Image appendix, added as user_data to image message (can be any valid JSON) | [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]
|
||||
**unit_cell** | [**DatasetSettingsUnitCell**](DatasetSettingsUnitCell.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
# DatasetSettingsUnitCell
|
||||
|
||||
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 openapi_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)
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,42 @@
|
||||
# Detector
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**description** | **str** | |
|
||||
**serial_number** | **str** | |
|
||||
**type** | [**DetectorType**](DetectorType.md) | | [optional]
|
||||
**high_voltage_v** | **int** | | [optional] [default to 0]
|
||||
**udp_interface_count** | **int** | | [optional] [default to 1]
|
||||
**sensor_thickness_um** | **float** | | [optional] [default to 320]
|
||||
**calibration_file** | **List[str]** | Gain file (JUNGFRAU) or trimbit file (EIGER). One entry per module. Either empty or number of module entries. | [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]
|
||||
**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]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# DetectorList
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**detectors** | [**List[DetectorListDetectorsInner]**](DetectorListDetectorsInner.md) | |
|
||||
**current_id** | **int** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -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 | [optional]
|
||||
**nmodules** | **int** | |
|
||||
**width** | **int** | |
|
||||
**height** | **int** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -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 openapi_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)
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# DetectorSelection
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
# DetectorSettings
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**frame_time_us** | **int** | Interval between consecutive frames. |
|
||||
**count_time_us** | **int** | Integration time of the detector. If not provided count time will be set to maximum value for a given frame time. | [optional]
|
||||
**storage_cell_count** | **int** | | [default to 1]
|
||||
**internal_frame_generator** | **bool** | Use internal frame generator in FPGA instead of getting data from a real detector | [default to False]
|
||||
**internal_frame_generator_images** | **int** | | [default to 1]
|
||||
**pedestal_g0_frames** | **int** | | [default to 2000]
|
||||
**pedestal_g1_frames** | **int** | | [default to 300]
|
||||
**pedestal_g2_frames** | **int** | | [default to 300]
|
||||
**pedestal_g0_rms_limit** | **int** | Pixels with pedestal G0 RMS above the threshold are marked as masked pixels | [default to 100]
|
||||
**pedestal_window_size** | **int** | Running average window size for pedestal calculations | [default to 128]
|
||||
**storage_cell_delay_ns** | **int** | Delay between two storage cells [ns] | [default to 5000]
|
||||
**detector_trigger_delay_ns** | **int** | Delay between TTL trigger and acquisition start [ns] | [optional] [default to 0]
|
||||
**fixed_gain_g1** | **bool** | Fix gain to G1 (can be useful for storage cells) | [optional] [default to False]
|
||||
**use_gain_hg0** | **bool** | Use high G0 (for low energy applications) | [optional] [default to False]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
# DetectorStatus
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**state** | **str** | Current state of the detector |
|
||||
**powerchip** | **str** | Power on of ASICs |
|
||||
**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 openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# DetectorType
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `EIGER` (value: `'EIGER'`)
|
||||
|
||||
* `JUNGFRAU` (value: `'JUNGFRAU'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -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 openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
# FpgaStatusInner
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**eth_link_count** | **int** | | [optional]
|
||||
**eth_link_status** | **int** | | [optional]
|
||||
**power_usage_w** | **float** | | [optional]
|
||||
**fpga_temp_c** | **float** | | [optional]
|
||||
**hbm_temp_c** | **float** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
# 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 original detector 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]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# ImagePusherType
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `ZEROMQ` (value: `'ZeroMQ'`)
|
||||
|
||||
* `HDF5` (value: `'HDF5'`)
|
||||
|
||||
* `CBOR` (value: `'CBOR'`)
|
||||
|
||||
* `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)
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
# 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]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
# 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]
|
||||
**instrument** | [**InstrumentMetadata**](InstrumentMetadata.md) | | [optional]
|
||||
**detector** | [**List[Detector]**](Detector.md) | |
|
||||
**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]
|
||||
**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 |
|
||||
**image_pusher** | [**ImagePusherType**](ImagePusherType.md) | | [default to ImagePusherType.NONE]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
# 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_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]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -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 openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
# 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[float]** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# Plots
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**title** | **str** | | [optional]
|
||||
**plot** | [**List[Plot]**](Plot.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -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 openapi_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)
|
||||
|
||||
|
||||
@@ -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 openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# RoiBoxList
|
||||
|
||||
List of box ROIs
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**rois** | [**List[RoiBox]**](RoiBox.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -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 openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# RoiCircleList
|
||||
|
||||
List of circular ROIs
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**rois** | [**List[RoiCircle]**](RoiCircle.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
# 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 in degrees |
|
||||
**start** | **float** | Start angle in degrees | [optional] [default to 0]
|
||||
**vector** | **List[float]** | Rotation axis |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
# 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]
|
||||
**filter_powder_rings** | **bool** | Filter spots which form powder rings (e.g., ice rings) | [optional] [default to False]
|
||||
**min_spot_count_powder_ring** | **int** | Minimum number of spots to consider a thin resolution shell (0.01 A^-1) a powder ring and filter out. | [optional]
|
||||
**signal_to_noise_threshold** | **float** | |
|
||||
**photon_count_threshold** | **int** | |
|
||||
**min_pix_per_spot** | **int** | |
|
||||
**max_pix_per_spot** | **int** | |
|
||||
**high_resolution_limit** | **float** | |
|
||||
**low_resolution_limit** | **float** | |
|
||||
**indexing_tolerance** | **float** | Acceptance tolerance for spots after the indexing run - the larger the number, the more spots will be accepted |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
@@ -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 openapi_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)
|
||||
|
||||
|
||||
@@ -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]
|
||||
**image_socket** | **List[str]** | PUSH ZeroMQ socket for images. In case multiple sockets are provided, images are streamed over multiple sockets. Images are serialized using CBOR. Address follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK. 0.0.0.0 instead of IP address is accepted and means listening on all network interfaces. | [optional]
|
||||
**preview_socket** | **str** | PUB ZeroMQ socket for preview images. This socket operates at a reduced frame rate. Images are serialized using CBOR. Address follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK. 0.0.0.0 instead of IP address is accepted and means listening on all network interfaces. | [optional]
|
||||
**writer_notification_socket** | **str** | PULL ZeroMQ socket for notifications from writer that it finished operation. This allows Jungfraujoch to operate in a synchronous manner, with end of acquisition being also end of writing. Address follows ZeroMQ convention for sockets - in practice ipc://<socket file> and tpc://<IP address>:<port> sockets are OK. 0.0.0.0 instead of IP address should be avoided, as this socket address is forwarded to the writer process via START ZerOMQ message and in case of multiple ineterfaces the address might be ambigous. Using * (star) instead of port number is allowed and it means a random free port number. | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_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)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user