ref_file-1.0.0
Reference File Information
Outline
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
dark
string Required Dark Reference File Information
Name of the calibration reference file used to correct for dark current signal in the science data.
Maximum length: 120
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.
Maximum length: 120
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.
Maximum length: 120
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.
Maximum length: 120
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.
Maximum length: 120
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.
Maximum length: 120
linearity
string Required Linearity Reference File Information
Name of the calibration reference file used to correct for classical linearity in the science data.
Maximum length: 120
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.
Maximum length: 120
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.
Maximum length: 120
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.
Maximum length: 120
saturation
string Required Saturation Reference File Information
Information about the saturation reference file used with the science data.
Maximum length: 120
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.
Maximum length: 120
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 (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,
WFIMosaic.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,
WFIMosaic.crds_context,
GuideWindow.crds_context,
WFICommon.crds_context,
]
required: [version, context]
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
maxLength: 120
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
maxLength: 120
archive_catalog:
datatype: nvarchar(120)
destination:
[
ScienceRefData.r_distortion,
GuideWindow.r_distortion,
WFICommon.r_distortion,
]
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
maxLength: 120
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
maxLength: 120
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
maxLength: 120
archive_catalog:
datatype: nvarchar(120)
destination: [ScienceRefData.r_gain, GuideWindow.r_gain, WFICommon.r_gain]
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
maxLength: 120
archive_catalog:
datatype: nvarchar(120)
destination:
[
ScienceRefData.r_readnoise,
GuideWindow.r_readnoise,
WFICommon.r_readnoise,
]
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
maxLength: 120
archive_catalog:
datatype: nvarchar(120)
destination:
[
ScienceRefData.r_linearity,
GuideWindow.r_linearity,
WFICommon.r_linearity,
]
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
maxLength: 120
archive_catalog:
datatype: nvarchar(120)
destination:
[
ScienceRefData.r_inverse_linearity,
GuideWindow.r_inverse_linearity,
WFICommon.r_inverse_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
maxLength: 120
archive_catalog:
datatype: nvarchar(120)
destination:
[ScienceRefData.r_photom, GuideWindow.r_photom, WFICommon.r_photom]
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
maxLength: 120
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
maxLength: 120
archive_catalog:
datatype: nvarchar(120)
destination:
[
ScienceRefData.r_saturation,
GuideWindow.r_saturation,
WFICommon.r_saturation,
]
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
maxLength: 120
archive_catalog:
datatype: nvarchar(120)
destination:
[ScienceRefData.r_refpix, GuideWindow.r_refpix, WFICommon.r_refpix]
required:
[
crds,
dark,
distortion,
mask,
flat,
gain,
readnoise,
linearity,
inverse_linearity,
photom,
area,
saturation,
refpix,
]
flowStyle: block