meta/ref_file-1.0.0

Reference File Information

Outline

• Schema Definitions
• Original Schema

Schema Definitions

This type is an object with the following properties:

• crds

  object

  Required

  Calibration Reference Data System (CRDS) Information

  Calibration Reference Data System Parameters

  This type is an object with the following properties:

  • version

    string

    Required

    CRDS Software Version

    Version of the Calibration Reference Data System (CRDS) software package used to match calibration reference files to science observations.

    Maximum length: 120

  • context

    string

    Required

    CRDS Context

    Name of the Calibration Reference Data System (CRDS) context (.pmap) file used to match calibration reference files to science observations.

    Maximum length: 120

• apcorr

  string

  Required

  Aperture Correction Reference File Schema

  Name of the calibration reference file used to apply the aperture correction to the science data.

  No length restriction

• area

  string

  Required

  Pixel Area Reference File Information

  Name of the calibration reference file containing the pixel-to-pixel estimates of the area of each detector pixel on the sky.

  No length restriction

• dark

  string

  Required

  Dark Reference File Information

  Name of the calibration reference file used to correct for dark current signal in the science data.

  No length restriction

• distortion

  string

  Required

  Distortion Reference File Information

  Name of the calibration reference file used to include the geometric distortion model in the world coordinate system (WCS) of the science data.

  No length restriction

• epsf

  string

  Required

  ePSF Reference File Information

  Name of the calibration reference file used to apply the ePSF model to the science data.

  No length restriction

• mask

  string

  Required

  Bad Pixel Mask Reference File Information

  Name of the calibration reference file used to mark bad pixels in the data quality array of the science data.

  No length restriction

• flat

  string

  Required

  Flat Reference File Information

  Name of the calibration reference file used to correct for element-dependent, spatially-variable sensitivity in the science data.

  No length restriction

• gain

  string

  Required

  Gain Reference Rile Information

  Name of the calibration reference file used to convert between data numbers (DN) and photo-electrons in the science data.

  No length restriction

• inverse_linearity

  string

  Required

  Inverse Linearity Reference File Information

  Name of the calibration reference file used in simulations of Level 1 data products to imprint the effect of classical non-linearity in the science data.

  No length restriction

• linearity

  string

  Required

  Linearity Reference File Information

  Name of the calibration reference file used to correct for classical linearity in the science data.

  No length restriction

• photom

  string

  Required

  Photometry Reference File Information

  Name of the calibration reference file containing photometric zeropoints and related information populated into the science product metadata.

  No length restriction

• readnoise

  string

  Required

  Read Noise Reference File Information

  Name of the calibration reference file that estimates the pixel-to-pixel read noise in the science data.

  No length restriction

• refpix

  string

  Required

  Reference Pixel Reference File Information

  Name of the calibration reference file used to correct for 1/f noise using the reference pixels.

  No length restriction

• saturation

  string

  Required

  Saturation Reference File Information

  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/meta/ref_file-1.0.0

title: Reference File Information
type: object
properties:
  crds:
    title: Calibration Reference Data System (CRDS) Information
    description: |
      Calibration Reference Data System Parameters
    type: object
    properties:
      version:
        title: CRDS Software Version
        description: |
          Version of the Calibration Reference Data
          System (CRDS) software package used to match calibration
          reference files to science observations.
        type: string
        sdf:
          special_processing: VALUE_REQUIRED
          source:
            origin: TBD
        maxLength: 120
        archive_catalog:
          datatype: nvarchar(120)
          destination:
            [
              WFIExposure.crds_version,
              GuideWindow.crds_version,
              WFICommon.crds_version,
            ]
      context:
        title: CRDS Context
        description: |
          Name of the Calibration Reference Data System
          (CRDS) context (.pmap) file used to match calibration
          reference files to science observations.
        type: string
        sdf:
          special_processing: VALUE_REQUIRED
          source:
            origin: TBD
        maxLength: 120
        archive_catalog:
          datatype: nvarchar(120)
          destination:
            [
              WFIExposure.crds_context,
              GuideWindow.crds_context,
              WFICommon.crds_context,
            ]
    required: [version, context]
  apcorr:
    title: Aperture Correction Reference File Schema
    description: |
      Name of the calibration reference file used to apply
      the aperture correction to the science data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination:
        [ScienceRefData.r_apcorr, GuideWindow.r_apcorr, WFICommon.r_apcorr]
  area:
    title: Pixel Area Reference File Information
    description: |
      Name of the calibration reference file containing the
      pixel-to-pixel estimates of the area of each detector pixel on
      the sky.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_area, GuideWindow.r_area, WFICommon.r_area]
  dark:
    title: Dark Reference File Information
    description: |
      Name of the calibration reference file used to correct
      for dark current signal in the 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: |
      Name of the calibration reference file used to include
      the geometric distortion model in the world coordinate system
      (WCS) of the science data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination:
        [
          ScienceRefData.r_distortion,
          GuideWindow.r_distortion,
          WFICommon.r_distortion,
        ]
  epsf:
    title: ePSF Reference File Information
    description: |
      Name of the calibration reference file used to apply
      the ePSF model to the science data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_epsf, GuideWindow.r_epsf, WFICommon.r_epsf]
  mask:
    title: Bad Pixel Mask Reference File Information
    description: |
      Name of the calibration reference file used to mark
      bad pixels in the data quality array of 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: |
      Name of the calibration reference file used to correct
      for element-dependent, spatially-variable sensitivity in 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: |
      Name of the calibration reference file used to convert
      between data numbers (DN) and photo-electrons in the science
      data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination: [ScienceRefData.r_gain, GuideWindow.r_gain, WFICommon.r_gain]
  inverse_linearity:
    title: Inverse Linearity Reference File Information
    description: |
      Name of the calibration reference file used in
      simulations of Level 1 data products to imprint the effect of
      classical non-linearity in the science data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination:
        [
          ScienceRefData.r_inverse_linearity,
          GuideWindow.r_inverse_linearity,
          WFICommon.r_inverse_linearity,
        ]
  linearity:
    title: Linearity Reference File Information
    description: |
      Name of the calibration reference file used to correct
      for classical linearity in 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: |
      Name of the calibration reference file containing
      photometric zeropoints and related information populated into
      the science product metadata.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination:
        [ScienceRefData.r_photom, GuideWindow.r_photom, WFICommon.r_photom]
  readnoise:
    title: Read Noise Reference File Information
    description: |
      Name of the calibration reference file that estimates
      the pixel-to-pixel read noise in the science data.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination:
        [
          ScienceRefData.r_readnoise,
          GuideWindow.r_readnoise,
          WFICommon.r_readnoise,
        ]
  refpix:
    title: Reference Pixel Reference File Information
    description: |
      Name of the calibration reference file used to correct
      for 1/f noise using the reference pixels.
    type: string
    archive_catalog:
      datatype: nvarchar(120)
      destination:
        [ScienceRefData.r_refpix, GuideWindow.r_refpix, WFICommon.r_refpix]
  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,
        ]
required:
  [
    apcorr,
    crds,
    dark,
    distortion,
    epsf,
    mask,
    flat,
    gain,
    readnoise,
    linearity,
    inverse_linearity,
    photom,
    area,
    saturation,
    refpix,
  ]