v1.0.0-rc.110 (#16)

This is an UNSTABLE release.

* jfjoch_broker: Add auto-contrast option for preview images
* Frontend: Add logo image
* jfjoch_viewer: Add logo image
* jfjoch_viewer: For image chart allow to set min value to zero
* jfjoch_viewer: For resolution estimation plots, visualization uses 1/d^2 as measure
* jfjoch_viewer: Add 3D unit cell visualization (experimental/WIP/not really there)
* Documentation: Add logo image

Reviewed-on: #16
Co-authored-by: Filip Leonarski <filip.leonarski@psi.ch>
Co-committed-by: Filip Leonarski <filip.leonarski@psi.ch>

docs/python_client/README.md

@@ -22,8 +22,8 @@ communicate through network calls or other mechanisms.
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0.0-rc.109
-- Package version: 1.0.0-rc.109
+- API version: 1.0.0-rc.110
+- Package version: 1.0.0-rc.110
 - Generator version: 7.8.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 

docs/python_client/docs/DefaultApi.md

@@ -2665,7 +2665,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)
 
 # **image_buffer_image_jpeg_get**
-> bytearray image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color)
+> bytearray image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color, show_res_est=show_res_est)
 
 Get preview image in JPEG format using custom settings
 
@@ -2693,14 +2693,15 @@ with jfjoch_client.ApiClient(configuration) as api_client:
     show_roi = False # bool | Show ROI areas on the image (optional) (default to False)
     show_spots = True # bool | Show spot finding results on the image (optional) (default to True)
     show_beam_center = True # bool | Show beam center on the image (optional) (default to True)
-    saturation = 10 # float | Saturation value to set contrast in the preview image (optional) (default to 10)
+    saturation = 3.4 # float | Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used (optional)
     jpeg_quality = 100 # int | Quality of JPEG image (100 - highest; 0 - lowest) (optional) (default to 100)
     show_res_ring = 0.1 # float | Show resolution ring, provided in Angstrom (optional) (default to 0.1)
     color = indigo # str | Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat (optional) (default to indigo)
+    show_res_est = False # bool | Show resolution estimation as a ring (optional) (default to False)
 
     try:
         # Get preview image in JPEG format using custom settings
-        api_response = api_instance.image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color)
+        api_response = api_instance.image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color, show_res_est=show_res_est)
         print("The response of DefaultApi->image_buffer_image_jpeg_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -2719,10 +2720,11 @@ Name | Type | Description  | Notes
  **show_roi** | **bool**| Show ROI areas on the image | [optional] [default to False]
  **show_spots** | **bool**| Show spot finding results on the image | [optional] [default to True]
  **show_beam_center** | **bool**| Show beam center on the image | [optional] [default to True]
- **saturation** | **float**| Saturation value to set contrast in the preview image | [optional] [default to 10]
+ **saturation** | **float**| Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used | [optional] 
  **jpeg_quality** | **int**| Quality of JPEG image (100 - highest; 0 - lowest) | [optional] [default to 100]
  **show_res_ring** | **float**| Show resolution ring, provided in Angstrom | [optional] [default to 0.1]
  **color** | **str**| Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat | [optional] [default to indigo]
+ **show_res_est** | **bool**| Show resolution estimation as a ring | [optional] [default to False]
 
 ### Return type
 

docs/python_client/docs/DetectorSettings.md

@@ -11,8 +11,8 @@ Name | Type | Description | Notes
 **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 EIGER detector. 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 EIGER read-out.  If value is not provided bit depth is adjusted automatically based on the image time.  | [optional] 
+**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]