fps/exposure-1.0.0

FPS Base Exposure Information

Outline

Schema Definitions

This type is an object with the following properties:

  • type

    objectRequired

    This node must validate against all of the following:

  • start_time

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

    Exposure Start Time (UTC)

    The UTC time at the beginning of the exposure.

  • ngroups

    integerRequired

    Number of Resultants

    The number of resultant frames in this exposure that were transmitted to the ground. The number of integrations of WFI data is always 1.

  • nframes

    integerRequired

    Number of Reads

    This is the number of science frames that are combined to produce a resultant frame.

  • data_problem

    booleanRequired

    Data Problem

    A flag indicating an issue with science telemetry.

  • frame_divisor

    integerRequired

    Frame Divisor

    The number of reads averaged to calculate a resultant. Value depends on the readout pattern used from the MultiAccum table.

  • groupgap

    integerRequired

    Number of Frames Dropped Between Resultants

    The number of reads that are dropped, or not used to calculate a resultant.

  • frame_time

    numberRequired

    Time Between Reads (s)

    The amount of time elapsed between the end of one read and the beginning of the next.

  • group_time

    numberRequired

    Time Between Resultants (s)

    The time that is the sum of the reads that are used to construct a resultant. This will depend on the MA table being used.

  • exposure_time

    numberRequired

    Exposure Time (s)

    The time between the start of the first Reset/Read Science Frame of an Exposure and the completion of the final Read Only Science Frame of that Exposure.

  • ma_table_name

    stringRequired

    MA Table Name

    The name of the MultiAccum table used for this exposure, as defined in the Project Reference Database.

    No length restriction
  • ma_table_number

    integerRequired

    MA Table Number

    The number of the MultiAccum table used for this exposure. Used in matching exposures to their corresponding calibration data.

  • read_pattern

    arrayRequired

    Read Pattern

    Enumeration of detector reads to resultants making up the L1 data downlinked from the observatory.

    No length restriction

    Items in the array are restricted to the following types:

    array

    No length restriction

    Items in the array are restricted to the following types:

    integer

Original Schema

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

title: |
  FPS Base Exposure Information

type: object
properties:
  type:
    allOf:
      - $ref: asdf://stsci.edu/datamodels/roman/schemas/fps/exposure_type-1.0.0
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nvarchar(25)
      destination: [WFICommon.exposure_type]
  start_time:
    title: Exposure Start Time (UTC)
    description: |
      The UTC time at the beginning of the exposure.
    tag: tag:stsci.edu:asdf/time/time-1.*
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: datetime2
      destination: [WFICommon.exposure_start_time]
  ngroups:
    title: Number of Resultants
    description: |
      The number of resultant frames in this exposure that were transmitted to
      the ground. The number of integrations of WFI data is always 1.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: int
      destination: [WFICommon.exposure_ngroups]
  nframes:
    title: Number of Reads
    description: |
      This is the number of science frames that are combined to produce a resultant frame.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: int
      destination: [WFICommon.exposure_nframes]
  data_problem:
    title: Data Problem
    description: |
      A flag indicating an issue with science telemetry.
    type: boolean
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nchar(1)
      destination: [WFICommon.exposure_data_problem]
  frame_divisor:
    title: Frame Divisor
    description: |
      The number of reads averaged to calculate a resultant. Value depends on
      the readout pattern used from the MultiAccum table.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: int
      destination: [WFICommon.exposure_frame_divisor]
  groupgap:
    title: Number of Frames Dropped Between Resultants
    description:
      The number of reads that are dropped, or not used to calculate a
      resultant.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: int
      destination: [WFICommon.exposure_groupgap]
  frame_time:
    title: Time Between Reads (s)
    description: |
      The amount of time elapsed between the end of one read and the beginning
      of the next.
    type: number
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: float
      destination: [WFICommon.exposure_frame_time]
  group_time:
    title: Time Between Resultants (s)
    description: |
      The time that is the sum of the reads that are used to construct a
      resultant. This will depend on the MA table being used.
    type: number
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: float
      destination: [WFICommon.exposure_group_time]
  exposure_time:
    title: Exposure Time (s)
    description: |
      The time between the start of the first Reset/Read Science Frame of an
      Exposure and the completion of the final Read Only Science Frame of that
      Exposure.
    type: number
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: float
      destination: [WFICommon.exposure_time]
  ma_table_name:
    title: MA Table Name
    description: |
      The name of the MultiAccum table used for this exposure, as defined in the
      Project Reference Database.
    type: string
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nvarchar(50)
      destination: [WFICommon.ma_table_name]
  ma_table_number:
    title: MA Table Number
    description: |
      The number of the MultiAccum table used for this exposure. Used in
      matching exposures to their corresponding calibration data.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: smallint
      destination: [WFICommon.ma_table_number]
  read_pattern:
    title: Read Pattern
    description: |
      Enumeration of detector reads to resultants making up the L1 data
      downlinked from the observatory.
    type: array
    items:
      type: array
      items:
        type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nvarchar(3500)
      destination: [WFICommon.read_pattern]
propertyOrder:
  [
    type,
    start_time,
    ngroups,
    nframes,
    data_problem,
    frame_divisor,
    groupgap,
    frame_time,
    group_time,
    exposure_time,
    ma_table_name,
    ma_table_number,
    read_pattern,
  ]
flowStyle: block
required:
  [
    type,
    start_time,
    ngroups,
    nframes,
    data_problem,
    frame_divisor,
    groupgap,
    frame_time,
    group_time,
    exposure_time,
    ma_table_name,
    ma_table_number,
    read_pattern,
  ]