guidewindow-1.1.0

Guide Star Window Information

Outline

Schema Definitions

This type is an object with the following properties:

  • meta

    objectRequired

    This node must validate against all of the following:

    • This type is an object with the following properties:

      • gw_start_time

        tag:stsci.edu:asdf/time/time-1.*Required

        Start Time of Guide Window Exposure (UTC)

        Time in UTC at the start of the guide window exposure.

      • gw_end_time

        tag:stsci.edu:asdf/time/time-1.*Required

        End Time of Guide Window Exposure (UTC)

        Time in UTC at the end of the guide window exposure.

      • gw_frame_readout_time

        numberRequired

        Guide Window Read Time (Seconds)

        Time to read out the guide window frame in units of seconds.

      • gw_function_start_time

        tag:stsci.edu:asdf/time/time-1.*Required

        Guide Window Function Start Time (UTC)

        Time in UTC at the start of the guider function.

      • gw_function_end_time

        tag:stsci.edu:asdf/time/time-1.*Required

        Guide Window Function End Time (UTC)

        Time in UTC at the end of the guider function.

      • gw_acq_exec_stat

        stringRequired

        Guide Star Acquisition Status

        Status of the guide star acquisition.

        Maximum length: 15

      • pedestal_resultant_exp_time

        numberRequired

        Guide Window Pedestal Exposure Time (Seconds)

        Cumulative exposure time for all of the guide window pedestal resultants in units of seconds.

      • signal_resultant_exp_time

        numberRequired

        Guide Window Signal Exposure Time (Seconds)

        Cumulative exposure time for all of the guide window signal resultants in units of seconds

      • gw_acq_number

        integerRequired

        Guide Star Acquisition Identifier

        Identifier representing the guide star acquisition number within the visit.

      • gw_science_file_source

        stringRequired

        Science File Name

        Name of the file containing the WFI science exposure corresponding to the guide window data contained within this file.

        Maximum length: 120

      • gw_mode

        objectRequired

        This node must validate against all of the following:

      • gw_window_xstart

        integerRequired

        Guide Window X Start Position (pixels)

        Minimum X position in the science coordinate frame of all tracking guide windows in this exposure measured in pixels.

      • gw_window_ystart

        integerRequired

        Guide Window Y Start Position (pixels)

        Minimum Y position in the science coordinate frame of all tracking guide windows in this exposure measured in pixels.

      • gw_window_xstop

        integerRequired

        Guide Window X Stop Position (pixels)

        Maximum X position in the science coordinate frame of all tracking guide windows in this exposure measured in pixels.

      • gw_window_ystop

        integerRequired

        Guide Window Y Stop Position (pixels)

        Maximum Y position in the science coordinate frame of all tracking guide windows in this exposure measured in pixels.

      • gw_window_xsize

        integerRequired

        Guide window size in the x direction in detector coordinates

      • gw_window_ysize

        integerRequired

        Guide window size in the y direction in detector coordinates

  • pedestal_frames

    tag:stsci.edu:asdf/core/ndarray-1.*Required

    Guide Window Pedestal Resultant Array (DN)

    Array containing the guide window pedestal resultants in units of DN. The array has dimensions of (J, H, K, X, Y) where J is the number of science resultants, H is the number of reads of the detector in a given science resultant, K is the number of guide window reads in a science read, and X and Y are the pixel locations.

  • signal_frames

    tag:stsci.edu:asdf/core/ndarray-1.*Required

    Guide Window Signal Resultant Array (DN)

    Array containing the guide window signal resultants in units of DN. The array has dimensions of (J, H, K, X, Y) where J is the number of science resultants, H is the number of reads of the detector in a given science resultant, K is the number of guide window reads in a science read, and X and Y are the pixel locations.

  • amp33

    tag:stsci.edu:asdf/core/ndarray-1.*Required

    Guide Window Amplifier 33 Reference Pixel Resultant Array (DN)

    Array containing the amplifier 33 reference pixel resultants in units of DN. The array has dimensions of (J, H, K, X, Y) where J is the number of science resultants, H is the number of reads of the detector in a given science resultant, K is the number of guide window reads in a science read, and X and Y are the pixel locations.

Original Schema

%YAML 1.1
---
$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
id: asdf://stsci.edu/datamodels/roman/schemas/guidewindow-1.1.0

title: Guide Star Window Information

datamodel_name: GuidewindowModel

archive_meta: None

type: object
properties:
  meta:
    allOf:
      - $ref: asdf://stsci.edu/datamodels/roman/schemas/common-1.1.0
      - type: object
        properties:
          gw_start_time:
            title: Start Time of Guide Window Exposure (UTC)
            description: |
              Time in UTC at the start of the guide window exposure.
            tag: tag:stsci.edu:asdf/time/time-1.*
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: datetime2
              destination: [GuideWindow.gw_start_time]
          gw_end_time:
            title: End Time of Guide Window Exposure (UTC)
            description: |
              Time in UTC at the end of the guide window exposure.
            tag: tag:stsci.edu:asdf/time/time-1.*
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: datetime2
              destination: [GuideWindow.gw_end_time]
          gw_frame_readout_time:
            title: Guide Window Read Time (Seconds)
            description: |
              Time to read out the guide window frame in units of seconds.
            type: number
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: float
              destination: [GuideWindow.gw_frame_readout_time]
          gw_function_start_time:
            title: Guide Window Function Start Time (UTC)
            description: |
              Time in UTC at the start of the guider function.
            tag: tag:stsci.edu:asdf/time/time-1.*
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: datetime2
              destination: [GuideWindow.gw_function_start_time]
          gw_function_end_time:
            title: Guide Window Function End Time (UTC)
            description: |
              Time in UTC at the end of the guider function.
            tag: tag:stsci.edu:asdf/time/time-1.*
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: datetime2
              destination: [GuideWindow.gw_function_end_time]
          gw_acq_exec_stat:
            title: Guide Star Acquisition Status
            description: |
              Status of the guide star acquisition.
            type: string
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            maxLength: 15
            archive_catalog:
              datatype: nvarchar(15)
              destination: [GuideWindow.gw_acq_exec_stat]
          pedestal_resultant_exp_time:
            title: Guide Window Pedestal Exposure Time (Seconds)
            description: |
              Cumulative exposure time for all of the guide window pedestal
              resultants in units of seconds.
            type: number
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: float
              destination: [GuideWindow.gw_pedestal_resultant_exp_time]
          signal_resultant_exp_time:
            title: Guide Window Signal Exposure Time (Seconds)
            description: |
              Cumulative exposure time for all of the guide window signal
              resultants in units of seconds
            type: number
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: float
              destination: [GuideWindow.gw_signal_resultant_exp_time]
          gw_acq_number:
            title: Guide Star Acquisition Identifier
            description: |
              Identifier representing the guide star acquisition number within
              the visit.
            type: integer
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: int
              destination: [GuideWindow.gw_acq_number]
          gw_science_file_source:
            title: Science File Name
            description: |
              Name of the file containing the WFI science exposure
              corresponding to the guide window data contained within this
              file.
            type: string
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            maxLength: 120
            archive_catalog:
              datatype: nvarchar(120)
              destination: [GuideWindow.gw_science_file_source]
          gw_mode:
            allOf:
              - $ref: asdf://stsci.edu/datamodels/roman/schemas/guidewindow_modes-1.0.0
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            maxLength: 18
            archive_catalog:
              datatype: nvarchar(18)
              destination: [GuideWindow.gw_mode]
          gw_window_xstart:
            title: Guide Window X Start Position (pixels)
            description: |
              Minimum X position in the science coordinate frame of all tracking
              guide windows in this exposure measured in pixels.
            type: integer
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: int
              destination: [GuideWindow.gw_window_xstart]
          gw_window_ystart:
            title: Guide Window Y Start Position (pixels)
            description: |
              Minimum Y position in the science coordinate frame of all tracking
              guide windows in this exposure measured in pixels.
            type: integer
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: int
              destination: [GuideWindow.gw_window_ystart]
          gw_window_xstop:
            title: Guide Window X Stop Position (pixels)
            description: |
              Maximum X position in the science coordinate frame of all tracking
              guide windows in this exposure measured in pixels.
            type: integer
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: int
              destination: [GuideWindow.gw_window_xstop]
          gw_window_ystop:
            title: Guide Window Y Stop Position (pixels)
            description: |
              Maximum Y position in the science coordinate frame of all tracking
              guide windows in this exposure measured in pixels.
            type: integer
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: int
              destination: [GuideWindow.gw_window_ystop]
          gw_window_xsize:
            title: Guide window size in the x direction in detector coordinates
            type: integer
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: int
              destination: [GuideWindow.gw_window_xsize]
          gw_window_ysize:
            title: Guide window size in the y direction in detector coordinates
            type: integer
            sdf:
              special_processing: VALUE_REQUIRED
              source:
                origin: Science Data Formatting
            archive_catalog:
              datatype: int
              destination: [GuideWindow.gw_window_ysize]
        required:
          [
            gw_start_time,
            gw_end_time,
            gw_frame_readout_time,
            gw_function_start_time,
            gw_function_end_time,
            gw_acq_exec_stat,
            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,
            gw_science_file_source,
          ]
  pedestal_frames:
    title: Guide Window Pedestal Resultant Array (DN)
    description: |
      Array containing the guide window pedestal resultants in units of DN. The
      array has dimensions of (J, H, K, X, Y) where J is the number of science
      resultants, H is the number of reads of the detector in a given science
      resultant, K is the number of guide window reads in a science read, and X
      and Y are the pixel locations.
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: uint16
    exact_datatype: true
    ndim: 5
    unit: DN
  signal_frames:
    title: Guide Window Signal Resultant Array (DN)
    description: |
      Array containing the guide window signal resultants in units of DN. The
      array has dimensions of (J, H, K, X, Y) where J is the number of science
      resultants, H is the number of reads of the detector in a given science
      resultant, K is the number of guide window reads in a science read, and X
      and Y are the pixel locations.
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: uint16
    exact_datatype: true
    ndim: 5
    unit: DN
  amp33:
    title: Guide Window Amplifier 33 Reference Pixel Resultant Array (DN)
    description: |
      Array containing the amplifier 33 reference pixel resultants in units of
      DN. The array has dimensions of (J, H, K, X, Y) where J is the number of
      science resultants, H is the number of reads of the detector in a given
      science resultant, K is the number of guide window reads in a science
      read, and X and Y are the pixel locations.
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: uint16
    exact_datatype: true
    ndim: 5
    unit: DN
propertyOrder: [meta, pedestal_frames, signal_frames, amp33]
flowStyle: block
required: [meta, pedestal_frames, signal_frames, amp33]