meta/guidewindow_common-1.2.0

Guide Window Common Metadata

Outline

Schema Definitions
Original Schema

Schema Definitions ¶

This node must validate against all of the following:

This type is an object with the following properties:
- fgs_modes_used
  array Required
  FGS Guiding Modes
  
  List of unique FGS guiding modes used during the guide window exposure.
  
  No length restriction
  Items in the array are restricted to the following types:
  string
  No length restriction
  
  Only the following values are valid for this node:
  
  NOT_CONFIGURED
  
  STANDBY
  
  WIM_ACQ_VW
  
  WIM_ACQ_NA
  
  WIM_TRK
  
  WIM_TRK_S
  
  WSM_ACQ_HC
  
  WSM_ACQ_VC
  
  WSM_TRK
  
  WIM_DFC
- guide_star_acq_num
  integer Required
  Guide Star Acquisition Number
  
  Guide star acquisition number (1-9) for the guide window exposure.
- t_start
  tag:stsci.edu:asdf/time/time-1.* Required
  Guide Window Acquisition Start Time
  
  The UTC time for the start of attempted acquisition of guiding for the guide star acquisition cycle contained in this file.
- t_stop
  tag:stsci.edu:asdf/time/time-1.* Required
  Guide Window Acquisition End Time
  
  The UTC time for the end of the guide star acquisition cycle contained in this file.
- guide_window_id
  asdf://stsci.edu/datamodels/roman/schemas/meta/guide_window_id-1.1.0 Required

Original Schema ¶

%YAML 1.1
---
$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.1.0
id: asdf://stsci.edu/datamodels/roman/schemas/meta/guidewindow_common-1.2.0

title: Guide Window Common Metadata

allOf:
  - $ref: asdf://stsci.edu/datamodels/roman/schemas/meta/basic-1.1.0
  - type: object
    properties:
      fgs_modes_used:
        title: FGS Guiding Modes
        description: |
          List of unique FGS guiding modes used during the guide window exposure.
        type: array
        items:
          type: string
          enum:
            [
              "NOT_CONFIGURED",
              "STANDBY",
              "WIM_ACQ_VW",
              "WIM_ACQ_NA",
              "WIM_TRK",
              "WIM_TRK_S",
              "WSM_ACQ_HC",
              "WSM_ACQ_VC",
              "WSM_TRK",
              "WIM_DFC",
            ]
        sdf:
          special_processing: VALUE_REQUIRED
          source:
            origin: TBD
        archive_catalog:
          datatype: nvarchar(max)
          destination: [GuideWindow.fgs_modes_used]
      guide_star_acq_num:
        title: Guide Star Acquisition Number
        description: |
          Guide star acquisition number (1-9) for the guide window exposure.
        type: integer
        sdf:
          special_processing: VALUE_REQUIRED
          source:
            origin: TBD
        archive_catalog:
          datatype: int
          destination: [GuideWindow.guide_star_acq_num]
      t_start:
        title: Guide Window Acquisition Start Time
        description: |
          The UTC time for the start of attempted acquisition of guiding
          for the guide star acquisition cycle contained in this file.
        tag: tag:stsci.edu:asdf/time/time-1.*
        sdf:
          special_processing: VALUE_REQUIRED
          source:
            origin: TBD
        archive_catalog:
          datatype: datetime2
          destination: [GuideWindow.t_start]
      t_stop:
        title: Guide Window Acquisition End Time
        description: |
          The UTC time for the end of the guide star acquisition cycle
          contained in this file.
        tag: tag:stsci.edu:asdf/time/time-1.*
        sdf:
          special_processing: VALUE_REQUIRED
          source:
            origin: TBD
        archive_catalog:
          datatype: datetime2
          destination: [GuideWindow.t_stop]
      guide_window_id:
        $ref: asdf://stsci.edu/datamodels/roman/schemas/meta/guide_window_id-1.1.0
    required:
      [fgs_modes_used, guide_star_acq_num, guide_window_id, t_start, t_stop]