Merge pull request #120 from PaulHuwe/RAD-48_GuideWindowSchema

Rad-48: Guide Window Schema

src/rad/resources/manifests/datamodels-1.0.yaml

@@ -9,6 +9,11 @@ asdf_standard_requirement:
   gte: 1.1.0
 tags:
 # Object Modules
+- tag_uri: asdf://stsci.edu/datamodels/roman/tags/guidewindow-1.0.0
+  schema_uri: asdf://stsci.edu/datamodels/roman/schemas/guidewindow-1.0.0
+  title: Guide window schema
+  description: |-
+    Guide window schema
 - tag_uri: asdf://stsci.edu/datamodels/roman/tags/ramp-1.0.0
   schema_uri: asdf://stsci.edu/datamodels/roman/schemas/ramp-1.0.0
   title: Ramp schema

src/rad/resources/schemas/guidestar-1.0.0.yaml

@@ -100,10 +100,7 @@ properties:
       datatype: float
       destination: [ScienceCommon.gs_umag]
   gw_fgs_mode:
-    title: Fine Guidance System mode
-    type: string
-    enum: [WIM-ACQ, WIM-TRACK, WSM-ACQ-1, WSM-ACQ-2, WSM-TRACK,
-           DEFOCUSED-MODERATE, DEFOCUSED-LARGE]
+    $ref: guidewindow_modes-1.0.0
     sdf:
       special_processing: VALUE_REQUIRED
       source:
@@ -241,55 +238,26 @@ properties:
     archive_catalog:
       datatype: float
       destination: [ScienceCommon.gs_para]
-  gw_window_xstart:
-    title: Guide window x position
-    type: number
-    sdf:
-      special_processing: VALUE_REQUIRED
-      source:
-        origin: TBD
-    archive_catalog:
-      datatype: float
-      destination: [ScienceCommon.gw_window_xstart]
-  gw_window_ystart:
-    title: Guide window y position
-    type: number
-    sdf:
-      special_processing: VALUE_REQUIRED
-      source:
-        origin: TBD
-    archive_catalog:
-      datatype: float
-      destination: [ScienceCommon.gw_window_ystart]
-  gw_window_xsize:
-    title: Guide star window size in x
-    type: number
-    sdf:
-      special_processing: VALUE_REQUIRED
-      source:
-        origin: TBD
-    archive_catalog:
-      datatype: float
-      destination: [ScienceCommon.gw_window_xsize]
-  gw_window_ysize:
-    title: Guide star window size in y
+  gs_pattern_error:
+    title: RMS of guide star position
+    description: RMS of guide star position in guide window from pattern matching (error on
+      centroid not explicitly calculated, the FACE information takes all the centroids and
+      calculates the error across the guiding pattern)
     type: number
     sdf:
       special_processing: VALUE_REQUIRED
       source:
         origin: TBD
     archive_catalog:
       datatype: float
-      destination: [ScienceCommon.gw_window_ysize]
+      destination: [ScienceCommon.gs_pattern_error]
 propertyOrder: [gw_start_time, gw_stop_time, gw_id, gs_ra, gs_dec, gs_ura, gs_udec,
            gs_mag, gs_umag, gw_fgs_mode, gw_function_start_time, gw_function_end_time,
            data_start, data_end, gw_acq_exec_stat, gs_ctd_x, gs_ctd_y, gs_ctd_ux, gs_ctd_uy,
-           gs_epoch, gs_mura, gs_mudec, gs_para,
-           gw_window_xstart, gw_window_ystart, gw_window_xsize, gw_window_ysize]
+           gs_epoch, gs_mura, gs_mudec, gs_para, gs_pattern_error]
 flowStyle: block
 required: [gw_start_time, gw_stop_time, gw_id, gs_ra, gs_dec, gs_ura, gs_udec,
            gs_mag, gs_umag, gw_fgs_mode, gw_function_start_time, gw_function_end_time,
            data_start, data_end, gw_acq_exec_stat, gs_ctd_x, gs_ctd_y, gs_ctd_ux, gs_ctd_uy,
-           gs_epoch, gs_mura, gs_mudec, gs_para,
-           gw_window_xstart, gw_window_ystart, gw_window_xsize, gw_window_ysize]
+           gs_epoch, gs_mura, gs_mudec, gs_para, gs_pattern_error]
 ...

src/rad/resources/schemas/guidewindow-1.0.0.yaml

@@ -0,0 +1,169 @@
+%YAML 1.1
+---
+$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
+id: asdf://stsci.edu/datamodels/roman/schemas/guidewindow-1.0.0
+
+title: Guide window information
+type: object
+properties:
+  meta:
+    allOf:
+      - $ref: common-1.0.0
+      - type: object
+        properties:
+          gw_start_time:
+            title: UTC time at the start of the guide window exposure
+            tag: tag:stsci.edu:asdf/time/time-1.1.0
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: datetime2
+              destination: [ScienceCommon.gw_start_time]
+          gw_end_time:
+            title: UTC time at the end of the guide window exposure
+            tag: tag:stsci.edu:asdf/time/time-1.1.0
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: datetime2
+              destination: [ScienceCommon.gw_end_time]
+          gw_frame_readout_time:
+            title: The readout time for the guide window frame
+            type: number
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: float
+              destination: [ScienceCommon.gw_frame_readout_time]
+          pedestal_resultant_exp_time:
+            title: Total exposure time for the resultant guide window frame
+            type: number
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: float
+              destination: [ScienceCommon.gw_pedestal_resultant_exp_time]
+          signal_resultant_exp_time:
+            title: Total exposure time for the resultant guide window frame
+            type: number
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: float
+              destination: [ScienceCommon.gw_signal_resultant_exp_time]
+          gw_acq_number:
+            title: Guide Window ID "Q"
+            type: number
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: int
+              destination: [ScienceCommon.gw_acq_number]
+          gw_mode:
+            $ref: guidewindow_modes-1.0.0
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: nvarchar(10)
+              destination: [ScienceCommon.gw_mode]
+          gw_window_xstart:
+            title: Guide window x position
+            type: number
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: float
+              destination: [ScienceCommon.gw_window_xstart]
+          gw_window_ystart:
+            title: Guide window y position
+            type: number
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: float
+              destination: [ScienceCommon.gw_window_ystart]
+          gw_window_xstop:
+            title: Guide window x stop position
+            type: number
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: float
+              destination: [ScienceCommon.gw_window_xstop]
+          gw_window_ystop:
+            title: Guide window y stop position
+            type: number
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: float
+              destination: [ScienceCommon.gw_window_ystart]
+          gw_window_xsize:
+            title: Guide star window size in x
+            type: number
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: float
+              destination: [ScienceCommon.gw_window_xsize]
+          gw_window_ysize:
+            title: Guide star window size in y
+            type: number
+            sdf:
+              special_processing: VALUE_REQUIRED
+              source:
+                origin: TBD
+            archive_catalog:
+              datatype: float
+              destination: [ScienceCommon.gw_window_ysize]
+        required: [gw_start_time, gw_end_time, gw_frame_readout_time, pedestal_resultant_exp_time,
+                   signal_resultant_exp_time, gw_acq_number, gw_mode,
+                   gw_window_xstart, gw_window_ystart,
+                   gw_window_xstop, gw_window_ystop,
+                   gw_window_xsize, gw_window_ysize,]
+  pedestal_frames:
+    title: "Reconstituted and oriented pedestal frame GW images. Dimensions: num_frames,
+            num_combined_resultants (or num_uncombined_resultants), num_reads, x, y"
+    tag: tag:stsci.edu:asdf/core/ndarray-1.0.0
+    datatype: uint16
+    ndim: 5
+  signal_frames:
+    title: "Reconstituted and oriented signal frames. Dimensions: num_frames,
+            num_combined_resultants (or num_uncombined_resultants), num_reads, x, y"
+    tag: tag:stsci.edu:asdf/core/ndarray-1.0.0
+    datatype: uint16
+    ndim: 5
+  amp33:
+    title: "Amp 33 reference pixel data. Dimensions: num_frames,
+            num_combined_resultants (or num_uncombined_resultants), num_reads, x, y"
+    tag: tag:stsci.edu:asdf/core/ndarray-1.0.0
+    datatype: uint16
+    ndim: 5
+propertyOrder: [meta, pedestal_frames, signal_frames, amp33]
+flowStyle: block
+required: [meta,pedestal_frames, signal_frames, amp33]
+...

src/rad/resources/schemas/guidewindow_modes-1.0.0.yaml

@@ -0,0 +1,18 @@
+%YAML 1.1
+---
+$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
+id: asdf://stsci.edu/datamodels/roman/schemas/guidewindow_modes-1.0.0
+
+# Helper file to enumerate guide window modes for guidestar and guidewindow
+
+title: Guide window modes
+type: string
+enum:
+  - WIM-ACQ
+  - WIM-TRACK
+  - WSM-ACQ-1
+  - WSM-ACQ-2
+  - WSM-TRACK
+  - DEFOCUSED-MODERATE
+  - DEFOCUSED-LARGE
+...

src/rad/resources/schemas/observation-1.0.0.yaml

@@ -196,8 +196,8 @@ properties:
       datatype: nvarchar(50)
       destination: [ScienceCommon.ma_table_name]
   ma_table_number:
-    title: Number of the multi-accumulation table used
-    type: integer
+    title: Numerical identifier for the multi-accumulation table used
+    type: number
     sdf:
       special_processing: VALUE_REQUIRED
       source: