ramp-1.7.0
Ramp Schema
Outline
Schema Definitions ¶
This type is an object with the following properties:
meta
object Required This node must validate against all of the following:
This type is an object with the following properties:
cal_step
asdf://stsci.edu/datamodels/roman/schemas/meta/l2_cal_step-1.3.0 Required
data
tag:stsci.edu:asdf/core/ndarray-1.* Required Science Data Including Border Reference Pixels (DN, electrons)
Science Data Including Border Reference Pixels in units of DN or electrons.
pixeldq
tag:stsci.edu:asdf/core/ndarray-1.* Required Two Dimensional Data Quality Flags Array for Each Pixel
Two dimensional data quality flags array applying to all resultants in a given pixel.
groupdq
tag:stsci.edu:asdf/core/ndarray-1.* Required Three-dimensional Data Quality Array For Each Resultant in Each Pixel
Three-dimensional data quality array indicating quality of each individual resultant for each pixel.
amp33
tag:stsci.edu:asdf/core/ndarray-1.* Required Amp 33 Reference Pixel Data (DN)
Amplifier 33 Reference Pixel Data in units of DN.
border_ref_pix_left
tag:stsci.edu:asdf/core/ndarray-1.* Required Border Reference Pixels on the Left of the Detector, from the Instrument’s Perspective (DN)
Border Reference Pixels on the Left of the Detector, from the instrument’s perspective in units of DN.
border_ref_pix_right
tag:stsci.edu:asdf/core/ndarray-1.* Required Border Reference Pixels on the Right of the Detector, from the Instrument’s Perspective (DN)
Border Reference Pixels on the Right of the Detector, from the instrument’s perspective in units of DN.
border_ref_pix_top
tag:stsci.edu:asdf/core/ndarray-1.* Required Border Reference Pixels on the Top of the Detector (DN)
Border Reference Pixels on the Top of the Detector in units of DN.
border_ref_pix_bottom
tag:stsci.edu:asdf/core/ndarray-1.* Required Border Reference Pixels on the Bottom of the Detector (DN)
Border Reference Pixels on the Bottom of the Detector in units of DN.
dq_border_ref_pix_left
tag:stsci.edu:asdf/core/ndarray-1.* Required Data Quality Flag for Border Reference Pixels, on the Left Edge of the Detector from the Instrument Perspective
Data Quality Flag for Border Reference Pixels, on the Left Edge of the Detector from the Instrument Perspective.
dq_border_ref_pix_right
tag:stsci.edu:asdf/core/ndarray-1.* Required Data Quality Flag for Border Reference Pixels, on the Right Edge of the Detector from the Instrument Perspective
Data Quality Flag for Border Reference Pixels, on the Right Edge of the Detector from the Instrument Perspective.
dq_border_ref_pix_top
tag:stsci.edu:asdf/core/ndarray-1.* Required Data Quality Flag for Border Reference Pixels, on Top.
Data Quality Flag for Border Reference Pixels, on Top.
dq_border_ref_pix_bottom
tag:stsci.edu:asdf/core/ndarray-1.* Required Data Quality Flag for Border Reference Pixels, on Bottom.
Data Quality Flag for Border Reference Pixels, on Bottom.
reset_read
tag:stsci.edu:asdf/core/ndarray-1.* Reset Read (DN)
Reset read in units of data numbers (DNs) subtracted from subsequent reads up-the-ramp. This array is only present if a reset read was used and downlinked.
reset_amp33
tag:stsci.edu:asdf/core/ndarray-1.* Amplifier 33 Reference Pixel Data for the Reset Read (DN)
Reference pixel data from amplifier 33 in units of data numbers (DNs) for the reset read. This array is only present if a reset read was used and downlinked.
Original Schema ¶
%YAML 1.1
---
$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.1.0
id: asdf://stsci.edu/datamodels/roman/schemas/ramp-1.7.0
title: Ramp Schema
datamodel_name: RampModel
type: object
properties:
meta:
allOf:
- $ref: asdf://stsci.edu/datamodels/roman/schemas/meta/common-1.3.0
- type: object
properties:
cal_step:
$ref: asdf://stsci.edu/datamodels/roman/schemas/meta/l2_cal_step-1.3.0
required: [cal_step]
data:
title: Science Data Including Border Reference Pixels (DN, electrons)
description: |
Science Data Including Border Reference Pixels in units of DN or
electrons.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
ndim: 3
datatype: float32
unit: ["DN", "electron"]
exact_datatype: true
pixeldq:
title: Two Dimensional Data Quality Flags Array for Each Pixel
description: |
Two dimensional data quality flags array applying to all resultants in a
given pixel.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
ndim: 2
datatype: uint32
exact_datatype: true
groupdq:
title: Three-dimensional Data Quality Array For Each Resultant in Each Pixel
description: |
Three-dimensional data quality array indicating quality of each individual
resultant for each pixel.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
ndim: 3
datatype: uint8
exact_datatype: true
amp33:
title: Amp 33 Reference Pixel Data (DN)
description: |
Amplifier 33 Reference Pixel Data in units of DN.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
ndim: 3
datatype: uint16
unit: "DN"
exact_datatype: true
border_ref_pix_left:
title: Border Reference Pixels on the Left of the Detector, from the Instrument's Perspective (DN)
description: |
Border Reference Pixels on the Left of the Detector, from the instrument's
perspective in units of DN.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
ndim: 3
datatype: float32
unit: "DN"
exact_datatype: true
border_ref_pix_right:
title: Border Reference Pixels on the Right of the Detector, from the Instrument's Perspective (DN)
description: |
Border Reference Pixels on the Right of the Detector, from the
instrument's perspective in units of DN.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
ndim: 3
datatype: float32
unit: "DN"
exact_datatype: true
border_ref_pix_top:
title: Border Reference Pixels on the Top of the Detector (DN)
description: |
Border Reference Pixels on the Top of the Detector in units of DN.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
ndim: 3
datatype: float32
unit: "DN"
exact_datatype: true
border_ref_pix_bottom:
title: Border Reference Pixels on the Bottom of the Detector (DN)
description: |
Border Reference Pixels on the Bottom of the Detector in units of DN.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
ndim: 3
datatype: float32
unit: "DN"
exact_datatype: true
dq_border_ref_pix_left:
title: Data Quality Flag for Border Reference Pixels, on the Left Edge of the Detector from the Instrument Perspective
description: |
Data Quality Flag for Border Reference Pixels, on the Left Edge of the
Detector from the Instrument Perspective.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
datatype: uint32
exact_datatype: true
ndim: 2
dq_border_ref_pix_right:
title: Data Quality Flag for Border Reference Pixels, on the Right Edge of the Detector from the Instrument Perspective
description: |
Data Quality Flag for Border Reference Pixels, on the Right Edge of the
Detector from the Instrument Perspective.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
datatype: uint32
exact_datatype: true
ndim: 2
dq_border_ref_pix_top:
title: Data Quality Flag for Border Reference Pixels, on Top.
description: |
Data Quality Flag for Border Reference Pixels, on Top.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
datatype: uint32
exact_datatype: true
ndim: 2
dq_border_ref_pix_bottom:
title: Data Quality Flag for Border Reference Pixels, on Bottom.
description: |
Data Quality Flag for Border Reference Pixels, on Bottom.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
datatype: uint32
exact_datatype: true
ndim: 2
reset_read:
title: Reset Read (DN)
description: |
Reset read in units of data numbers (DNs) subtracted
from subsequent reads up-the-ramp. This array is only present
if a reset read was used and downlinked.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
ndim: 2
datatype: uint16
unit: "DN"
exact_datatype: true
reset_amp33:
title: Amplifier 33 Reference Pixel Data for the Reset Read (DN)
description: |
Reference pixel data from amplifier 33 in units of data numbers (DNs)
for the reset read. This array is only present if a reset
read was used and downlinked.
tag: tag:stsci.edu:asdf/core/ndarray-1.*
ndim: 2
datatype: uint16
unit: "DN"
exact_datatype: true
propertyOrder:
[
meta,
data,
pixeldq,
groupdq,
amp33,
border_ref_pix_left,
border_ref_pix_right,
border_ref_pix_top,
border_ref_pix_bottom,
dq_border_ref_pix_left,
dq_border_ref_pix_right,
dq_border_ref_pix_top,
dq_border_ref_pix_bottom,
reset_read,
reset_amp33,
]
flowStyle: block
required:
[
meta,
data,
pixeldq,
groupdq,
amp33,
border_ref_pix_left,
border_ref_pix_right,
border_ref_pix_top,
border_ref_pix_bottom,
dq_border_ref_pix_left,
dq_border_ref_pix_right,
dq_border_ref_pix_top,
dq_border_ref_pix_bottom,
]