ramp-1.0.0
Ramp Schema
Outline
Schema Definitions ¶
This type is an object with the following properties:
meta
common-1.0.0 Required data
tag:stsci.edu:asdf/unit/quantity-1.* Required 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 applying to all resultants in a given pixel.
groupdq
tag:stsci.edu:asdf/core/ndarray-1.* Required Three-dimensional data quality array indicating quality of each individual resultant for each pixel.
err
tag:stsci.edu:asdf/unit/quantity-1.* Required amp33
tag:stsci.edu:asdf/unit/quantity-1.* Required Amplifier 33 Reference Pixel Data in units of DN.
border_ref_pix_left
tag:stsci.edu:asdf/unit/quantity-1.* Required 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/unit/quantity-1.* Required 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/unit/quantity-1.* Required Border Reference Pixels on the Top of the Detector in units of DN.
border_ref_pix_bottom
tag:stsci.edu:asdf/unit/quantity-1.* Required 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.
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.
dq_border_ref_pix_top
tag:stsci.edu:asdf/core/ndarray-1.* Required 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.
Original Schema ¶
%YAML 1.1
---
$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
id: asdf://stsci.edu/datamodels/roman/schemas/ramp-1.0.0
title: Ramp Schema
datamodel_name: RampModel
type: object
properties:
meta:
$ref: common-1.0.0
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/unit/quantity-1.*
properties:
value:
tag: tag:stsci.edu:asdf/core/ndarray-1.*
datatype: float32
exact_datatype: true
ndim: 3
unit:
tag: tag:astropy.org:astropy/units/unit-1.*
enum: ["DN", "electron"]
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
err:
title: Error Array Containing the Square Root of the Exposure-level Combined Variance (DN, electrons)
tag: tag:stsci.edu:asdf/unit/quantity-1.*
properties:
value:
tag: tag:stsci.edu:asdf/core/ndarray-1.*
datatype: float32
exact_datatype: true
ndim: 3
unit:
tag: tag:astropy.org:astropy/units/unit-1.*
enum: ["DN", "electron"]
amp33:
title: Amp 33 Reference Pixel Data (DN)
description: |
Amplifier 33 Reference Pixel Data in units of DN.
tag: tag:stsci.edu:asdf/unit/quantity-1.*
properties:
value:
tag: tag:stsci.edu:asdf/core/ndarray-1.*
datatype: uint16
exact_datatype: true
ndim: 3
unit:
tag: tag:astropy.org:astropy/units/unit-1.*
enum: ["DN"]
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/unit/quantity-1.*
value:
tag: tag:stsci.edu:asdf/core/ndarray-1.*
datatype: float32
exact_datatype: true
ndim: 3
unit:
tag: tag:astropy.org:astropy/units/unit-1.*
enum: ["DN"]
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/unit/quantity-1.*
properties:
value:
tag: tag:stsci.edu:asdf/core/ndarray-1.*
datatype: float32
exact_datatype: true
ndim: 3
unit:
tag: tag:astropy.org:astropy/units/unit-1.*
enum: ["DN"]
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/unit/quantity-1.*
properties:
value:
tag: tag:stsci.edu:asdf/core/ndarray-1.*
datatype: float32
exact_datatype: true
ndim: 3
unit:
tag: tag:astropy.org:astropy/units/unit-1.*
enum: ["DN"]
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/unit/quantity-1.*
properties:
value:
tag: tag:stsci.edu:asdf/core/ndarray-1.*
datatype: float32
exact_datatype: true
ndim: 3
unit:
tag: tag:astropy.org:astropy/units/unit-1.*
enum: ["DN"]
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
propertyOrder: [meta, data, pixeldq, groupdq, err, 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]
flowStyle: block
required: [meta, data, pixeldq, groupdq, err, 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]
...