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>

frontend/src/openapi/core/OpenAPI.ts

@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
 
 export const OpenAPI: OpenAPIConfig = {
     BASE: 'http://localhost:5232',
-    VERSION: '1.0.0-rc.109',
+    VERSION: '1.0.0-rc.110',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

frontend/src/openapi/index.ts

@@ -54,6 +54,7 @@ export type { plot } from './models/plot';
 export { plot_type } from './models/plot_type';
 export { plot_unit_x } from './models/plot_unit_x';
 export type { plots } from './models/plots';
+export type { resolution_estimate } from './models/resolution_estimate';
 export type { resolution_ring } from './models/resolution_ring';
 export type { roi } from './models/roi';
 export type { roi_azim_list } from './models/roi_azim_list';

frontend/src/openapi/models/detector_settings.ts

@@ -33,7 +33,7 @@ export type detector_settings = {
     detector_trigger_delay_ns?: number;
     timing?: detector_timing;
     /**
-     * Threshold for the EIGER detector.
+     * 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.
@@ -41,8 +41,11 @@ export type detector_settings = {
      */
     eiger_threshold_keV?: number;
     /**
-     * Bit depth of EIGER read-out.
-     * If value is not provided bit depth is adjusted automatically based on the image time.
+     * 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.
      *
      */
     eiger_bit_depth?: detector_settings.eiger_bit_depth;
@@ -71,8 +74,11 @@ export type detector_settings = {
 export namespace detector_settings {
 
     /**
-     * Bit depth of EIGER read-out.
-     * If value is not provided bit depth is adjusted automatically based on the image time.
+     * 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.
      *
      */
     export enum eiger_bit_depth {

frontend/src/openapi/models/resolution_estimate.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Show resolution estimation as a ring
+ */
+export type resolution_estimate = boolean;

frontend/src/openapi/models/saturation.ts

@@ -4,6 +4,6 @@
 /* eslint-disable */
 
 /**
- * Saturation value to set contrast in the preview image
+ * Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used
  */
 export type saturation = number;

frontend/src/openapi/services/DefaultService.ts

@@ -1078,10 +1078,11 @@ export class DefaultService {
      * @param showRoi Show ROI areas on the image
      * @param showSpots Show spot finding results on the image
      * @param showBeamCenter Show beam center on the image
-     * @param saturation Saturation value to set contrast in the preview image
+     * @param saturation Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used
      * @param jpegQuality Quality of JPEG image (100 - highest; 0 - lowest)
      * @param showResRing Show resolution ring, provided in Angstrom
      * @param color Color scale for preview image: 0 - indigo, 1 - viridis, 2 - B/W, 3 - heat
+     * @param showResEst Show resolution estimation as a ring
      * @returns binary Preview image
      * @throws ApiError
      */
@@ -1091,10 +1092,11 @@ export class DefaultService {
         showRoi: boolean = false,
         showSpots: boolean = true,
         showBeamCenter: boolean = true,
-        saturation: number = 10,
+        saturation?: number,
         jpegQuality: number = 100,
         showResRing: number = 0.1,
         color: 'indigo' | 'viridis' | 'bw' | 'heat' = 'indigo',
+        showResEst: boolean = false,
     ): CancelablePromise<Blob> {
         return __request(OpenAPI, {
             method: 'GET',
@@ -1109,6 +1111,7 @@ export class DefaultService {
                 'jpeg_quality': jpegQuality,
                 'show_res_ring': showResRing,
                 'color': color,
+                'show_res_est': showResEst,
             },
             errors: {
                 400: `Input parsing or validation error`,