ref_file-1.0.0

Reference File Information

Outline

Schema Definitions

This type is an object with the following properties:

  • crds

    object

    Calibration Reference Data System Parameters

    This type is an object with the following properties:

    • sw_version

      string

      Version of Calibration Reference Data System (CRDS) file selection software.

      No length restriction
    • context_used

      string

      CRDS context (.pmap) used to select ref files.

      No length restriction
  • dark

    string

    Reference file used to correct for the dark current contribution to science data.

    No length restriction
  • distortion

    string

    Information about the distortion reference file used with the science data.

    No length restriction
  • mask

    string

    Information about the mask reference file used with the science data.

    No length restriction
  • flat

    string

    Information about the flat reference file used with the science data.

    No length restriction
  • gain

    string

    Information about the gain reference file used with the science data.

    No length restriction
  • readnoise

    string

    Information about the read noise reference file used with the science data.

    No length restriction
  • linearity

    string

    Information about the linearity reference file used with the science data.

    No length restriction
  • photom

    string

    Information about the photometry reference file used with the science data.

    No length restriction
  • area

    string

    Information about the area reference file used with the science data.

    No length restriction
  • saturation

    string

    Information about the saturation reference file used with the science data.

    No length restriction

Original Schema

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

title: Reference File Information
type: object
properties:
  crds:
    title: Calibration Reference Data System Parameters
    description: |
      Calibration Reference Data System Parameters
    type: object
    properties:
      sw_version:
        title: CRDS File Version
        description: |
          Version of Calibration Reference Data System (CRDS) file selection software.
        type: string
        sdf:
          special_processing: VALUE_REQUIRED
          source:
            origin: TBD
        archive_catalog:
          datatype: nvarchar(120)
          destination: [WFIExposure.crds_software_version, WFIMosaic.crds_software_version,
                        GuideWindow.crds_software_version, WFICommon.crds_software_version]

      context_used:
        title: CRDS Context
        description: |
          CRDS context (.pmap) used to select ref files.
        type: string
        sdf:
          special_processing: VALUE_REQUIRED
          source:
            origin: TBD
        archive_catalog:
          datatype: nvarchar(120)
          destination: [WFIExposure.crds_context_used, WFIMosaic.crds_context_used,
                        GuideWindow.crds_context_used, WFICommon.crds_context_used]
  dark:
    title: Dark Reference File Information
    description: |
      Reference file used to correct for the dark current contribution to
      science data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_dark, GuideWindow.r_dark, WFICommon.r_dark]
  distortion:
    title: Distortion Reference File Information
    description: |
      Information about the distortion reference file used with the science
      data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_distortion, GuideWindow.r_distortion, WFICommon.r_distortion]
  mask:
    title: Mask Reference File Information
    description: |
      Information about the mask reference file used with the science data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_mask, GuideWindow.r_mask, WFICommon.r_mask]
  flat:
    title: Flat Reference File Information
    description: |
      Information about the flat reference file used with the science data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_flat, GuideWindow.r_flat, WFICommon.r_flat]
  gain:
    title: Gain Reference Rile Information
    description: |
      Information about the gain reference file used with the science data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_gain, GuideWindow.r_gain, WFICommon.r_gain]
  readnoise:
    title: Read Noise Reference Rile Information
    description: |
      Information about the read noise reference file used with the science
      data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_readnoise, GuideWindow.r_readnoise, WFICommon.r_readnoise]
  linearity:
    title: Linearity Reference File Information
    description: |
      Information about the linearity reference file used with the science data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_linearity, GuideWindow.r_linearity, WFICommon.r_linearity]
  photom:
    title: Photometry Reference File Information
    description: |
      Information about the photometry reference file used with the science
      data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_photom, GuideWindow.r_photom, WFICommon.r_photom]
  area:
    title: Area Reference File Information
    description: |
      Information about the area reference file used with the science data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_area, GuideWindow.r_area, WFICommon.r_area]
  saturation:
    title: Saturation Reference File Information
    description: |
      Information about the saturation reference file used with the science
      data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_saturation, GuideWindow.r_saturation, WFICommon.r_saturation]

flowStyle: block
...