v1.0.0-rc.41
This commit is contained in:
@@ -6,8 +6,8 @@ Jungfraujoch uses FPGA boards to acquire data at high data rates.
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 1.0.0-rc.40
|
||||
- Package version: 1.0.0-rc.40
|
||||
- API version: 1.0.0-rc.41
|
||||
- Package version: 1.0.0-rc.41
|
||||
- Generator version: 7.8.0
|
||||
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
||||
|
||||
|
||||
@@ -5,11 +5,12 @@
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**polarization_factor** | **float** | If polarization factor is provided, than polarization correction is enabled. | [optional]
|
||||
**polarization_corr** | **bool** | Apply polarization correction for radial integration (polarization factor must be configured in dataset settings) | [default to True]
|
||||
**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** | |
|
||||
**azimuthal_bins** | **int** | Numer of azimuthal (phi) bins; 1 = standard 1D radial integration | [optional] [default to 1]
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**ml_resolution_estimation** | **bool** | ML resolution estimation available | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
@@ -31,6 +31,10 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**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** | [**DatasetSettingsUnitCell**](DatasetSettingsUnitCell.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
@@ -3002,7 +3002,7 @@ No authorization required
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **preview_plot_get**
|
||||
> Plots preview_plot_get(type, binning=binning, compression=compression, experimental_coord=experimental_coord)
|
||||
> Plots preview_plot_get(type, binning=binning, compression=compression, experimental_coord=experimental_coord, azint_unit=azint_unit)
|
||||
|
||||
Generate 1D plot from Jungfraujoch
|
||||
|
||||
@@ -3030,10 +3030,11 @@ with jfjoch_client.ApiClient(configuration) as api_client:
|
||||
binning = 56 # int | Binning of frames for the plot (0 = default binning) (optional)
|
||||
compression = False # bool | Enable DEFLATE compression of output data. (optional) (default to False)
|
||||
experimental_coord = False # bool | If measurement has goniometer axis defined, plot X-axis will represent rotation angle If measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value For still measurement the number is ignored (optional) (default to False)
|
||||
azint_unit = Q_recipA # str | Unit used for azim int. (optional) (default to Q_recipA)
|
||||
|
||||
try:
|
||||
# Generate 1D plot from Jungfraujoch
|
||||
api_response = api_instance.preview_plot_get(type, binning=binning, compression=compression, experimental_coord=experimental_coord)
|
||||
api_response = api_instance.preview_plot_get(type, binning=binning, compression=compression, experimental_coord=experimental_coord, azint_unit=azint_unit)
|
||||
print("The response of DefaultApi->preview_plot_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
@@ -3051,6 +3052,7 @@ Name | Type | Description | Notes
|
||||
**binning** | **int**| Binning of frames for the plot (0 = default binning) | [optional]
|
||||
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to False]
|
||||
**experimental_coord** | **bool**| If measurement has goniometer axis defined, plot X-axis will represent rotation angle If measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value For still measurement the number is ignored | [optional] [default to False]
|
||||
**azint_unit** | **str**| Unit used for azim int. | [optional] [default to Q_recipA]
|
||||
|
||||
### Return type
|
||||
|
||||
|
||||
@@ -13,6 +13,9 @@ Name | Type | Description | Notes
|
||||
**nmodules** | **int** | |
|
||||
**width** | **int** | |
|
||||
**height** | **int** | |
|
||||
**readout_time_us** | **int** | |
|
||||
**min_frame_time_us** | **int** | |
|
||||
**min_count_time_us** | **int** | |
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@
|
||||
|
||||
* `Q_RECIP_A` (value: `'q_recipA'`)
|
||||
|
||||
* `D_A` (value: `'d_A'`)
|
||||
|
||||
* `ANGLE_DEG` (value: `'angle_deg'`)
|
||||
|
||||
* `ADU` (value: `'ADU'`)
|
||||
|
||||
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**scale** | [**ColorScale**](ColorScale.md) | | [optional] [default to ColorScale.INDIGO]
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
|
||||
**low_resolution_limit** | **float** | |
|
||||
**resolution_estimate** | **bool** | Diffraction image resolution estimation using ML model from SSRL; `jfjoch_broker` must be compiled with libtorch support and path to .pt file configured in `jfjoch_broker` configuration file. If enabled it will likely reduce performance of Jungfraujoch to below 100 Hz. (experimental feature) | [optional] [default to True]
|
||||
**quick_integration** | **bool** | Quick integration of collected diffraction images. If enabled it will likely reduce performance of Jungfraujoch for datasets with a very high indexing rate. (experimental feature) | [default to False]
|
||||
**quick_integration_high_res_a** | **float** | Quick integration limit for high resolution [A] | [default to 1.5]
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
Reference in New Issue
Block a user