meta/wfi_mode-1.2.0

Wide Field Instrument (WFI) Configuration Information

Outline

• Schema Definitions
• Original Schema

Schema Definitions

This type is an object with the following properties:

• name

  string

  Required

  Instrument Name

  Name of the instrument used to acquire the science data.

  No length restriction

  Only the following values are valid for this node:

  • WFI

• detector

  object

  Required

  Wide Field Instrument (WFI) Detector Identifier

  Name of the Wide Field Instrument (WFI) detector used to take the science data in this file.

  This node must validate against all of the following:

  • asdf://stsci.edu/datamodels/roman/schemas/enums/wfi_detector-1.2.0

• optical_element

  object

  Required

  Wide Field Instrument (WFI) Optical Element

  Name of the optical element used to take the science data.

  This node must validate against all of the following:

  • asdf://stsci.edu/datamodels/roman/schemas/enums/wfi_optical_element-1.1.0

• data_encoding_offset

  integer

  Data Encoding Offset

  Offset added to science resultants in L1 data to avoid clipping the noise at zero DN.

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/wfi_mode-1.2.0

title: Wide Field Instrument (WFI) Configuration Information
type: object
properties:
  name:
    title: Instrument Name
    description: |
      Name of the instrument used to acquire the science
      data.
    type: string
    enum: [WFI]
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nvarchar(5)
      destination: [WFIExposure.instrument_name, GuideWindow.instrument_name]
  detector:
    allOf:
      - $ref: asdf://stsci.edu/datamodels/roman/schemas/enums/wfi_detector-1.2.0
    title: Wide Field Instrument (WFI) Detector Identifier
    description: |
      Name of the Wide Field Instrument (WFI) detector used
      to take the science data in this file.
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nvarchar(16)
      destination: [WFIExposure.detector, GuideWindow.detector]
  optical_element:
    allOf:
      - $ref: asdf://stsci.edu/datamodels/roman/schemas/enums/wfi_optical_element-1.1.0
    title: Wide Field Instrument (WFI) Optical Element
    description: |
      Name of the optical element used to take the science
      data.
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nvarchar(20)
      destination: [WFIExposure.optical_element, GuideWindow.optical_element]
  data_encoding_offset:
    title: Data Encoding Offset
    description: |
      Offset added to science resultants in L1 data to avoid
      clipping the noise at zero DN.
    type: integer
required: [detector, optical_element, name]