v1.0.0-rc.34

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.33',
+    VERSION: '1.0.0-rc.34',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

frontend/src/openapi/index.ts

@@ -26,6 +26,7 @@ export type { detector_status } from './models/detector_status';
 export { detector_timing } from './models/detector_timing';
 export { detector_type } from './models/detector_type';
 export { error_message } from './models/error_message';
+export { file_writer_format } from './models/file_writer_format';
 export type { file_writer_settings } from './models/file_writer_settings';
 export type { fpga_status } from './models/fpga_status';
 export type { image_buffer_status } from './models/image_buffer_status';
@@ -40,6 +41,8 @@ export type { pixel_mask_statistics } from './models/pixel_mask_statistics';
 export type { plot } from './models/plot';
 export type { plots } from './models/plots';
 export type { preview_settings } from './models/preview_settings';
+export type { roi_azim_list } from './models/roi_azim_list';
+export type { roi_azimuthal } from './models/roi_azimuthal';
 export type { roi_box } from './models/roi_box';
 export type { roi_box_list } from './models/roi_box_list';
 export type { roi_circle } from './models/roi_circle';

frontend/src/openapi/models/file_writer_format.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * None - no master file written
+ * 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
+ *
+ */
+export enum file_writer_format {
+    NONE = 'None',
+    NXMX_LEGACY = 'NXmxLegacy',
+    NXMX_VDS = 'NXmxVDS',
+}

frontend/src/openapi/models/file_writer_settings.ts

@@ -3,17 +3,14 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { file_writer_format } from './file_writer_format';
+
 export type file_writer_settings = {
     /**
      * Inform jfjoch_write to overwrite existing files. Otherwise files would be saved with .h5.{timestamp}.tmp suffix.
      *
      */
     overwrite?: boolean;
-    /**
-     * version 1 - legacy format with soft links to data files in the master file; necessary for DECTRIS Albula 4.0 and DECTRIS Neggia
-     * version 2 - newer format with virtual dataset linking data files in the master file, also includes better metadata handling
-     *
-     */
-    file_writer_version?: number;
+    format?: file_writer_format;
 };
 

frontend/src/openapi/models/roi_azim_list.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { roi_azimuthal } from './roi_azimuthal';
+
+/**
+ * List of azimuthal ROIs
+ */
+export type roi_azim_list = {
+    rois?: Array<roi_azimuthal>;
+};
+

frontend/src/openapi/models/roi_azimuthal.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * ROI as Q-range (or resolution range)
+ */
+export type roi_azimuthal = {
+    /**
+     * Name for the ROI; used in the plots
+     */
+    name: string;
+    /**
+     * Minimum Q-range for the ROI
+     */
+    q_min_recipA: number;
+    /**
+     * Maximum Q-range for the ROI
+     */
+    q_max_recipA: number;
+};
+

frontend/src/openapi/models/roi_definitions.ts

@@ -3,6 +3,7 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { roi_azim_list } from './roi_azim_list';
 import type { roi_box_list } from './roi_box_list';
 import type { roi_circle_list } from './roi_circle_list';
 
@@ -12,5 +13,6 @@ import type { roi_circle_list } from './roi_circle_list';
 export type roi_definitions = {
     box: roi_box_list;
     circle: roi_circle_list;
+    azim?: roi_azim_list;
 };
 

frontend/src/openapi/services/DefaultService.ts

@@ -986,6 +986,81 @@ export class DefaultService {
         });
     }
 
+    /**
+     * Generate plot of ROI mean value
+     * Mean of pixels within a ROI area; pixels with special values (overload, bad pixel) are excluded; binning is configurable; number will be wrong if multipixels are included!
+     * @param binning Binning of frames for the plot (0 = default binning)
+     * @param compression Enable DEFLATE compression of output data.
+     * @returns plots Response will be by default compressed with deflate algorithm, if using curl, use --compressed option.
+     * @throws ApiError
+     */
+    public static getPlotRoiMean(
+        binning?: number,
+        compression: boolean = true,
+    ): CancelablePromise<plots> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/plot/roi_mean',
+            query: {
+                'binning': binning,
+                'compression': compression,
+            },
+            errors: {
+                400: `Input parsing or validation error`,
+            },
+        });
+    }
+
+    /**
+     * Generate plot of ROI weighted X-coordinate
+     * Pixel X weighted by measured counts; pixels with special values (overload, bad pixel) are excluded; binning is configurable
+     * @param binning Binning of frames for the plot (0 = default binning)
+     * @param compression Enable DEFLATE compression of output data.
+     * @returns plots Response will be by default compressed with deflate algorithm, if using curl, use --compressed option.
+     * @throws ApiError
+     */
+    public static getPlotRoiX(
+        binning?: number,
+        compression: boolean = true,
+    ): CancelablePromise<plots> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/plot/roi_x',
+            query: {
+                'binning': binning,
+                'compression': compression,
+            },
+            errors: {
+                400: `Input parsing or validation error`,
+            },
+        });
+    }
+
+    /**
+     * Generate plot of ROI weighted Y-coordinate
+     * Pixel Y weighted by measured counts; pixels with special values (overload, bad pixel) are excluded; binning is configurable
+     * @param binning Binning of frames for the plot (0 = default binning)
+     * @param compression Enable DEFLATE compression of output data.
+     * @returns plots Response will be by default compressed with deflate algorithm, if using curl, use --compressed option.
+     * @throws ApiError
+     */
+    public static getPlotRoiY(
+        binning?: number,
+        compression: boolean = true,
+    ): CancelablePromise<plots> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/plot/roi_y',
+            query: {
+                'binning': binning,
+                'compression': compression,
+            },
+            errors: {
+                400: `Input parsing or validation error`,
+            },
+        });
+    }
+
     /**
      * Generate receiver delay plot
      * Amount of frames the receiver is behind the FPGA for each image - used for internal debugging; binning is configurable