dark-1.0.0

Dark Reference File Schema

Outline

Schema Definitions
Original Schema

Schema Definitions ¶

This type is an object with the following properties:

meta
object Required
This node must validate against all of the following:
- ref_common-1.0.0
- This type is an object with the following properties:
  
  reftype
  string
  No length restriction
  
  Only the following values are valid for this node:
  
  DARK
  
  exposure
  object Required
  This type is an object with the following properties:
  
  ngroups
  integer Required
  The number of resultants averaged according to Multi-Accumulation (MA) Table read pattern.
  
  nframes
  integer Required
  groupgap
  integer Required
  The number of frames skipped between resultants according to MA Table read pattern.
  
  ma_table_name
  string Required
  The name of the MA Table used. Not a unique identifier; see ma_table_number.
  
  No length restriction
  ma_table_number
  integer Required
  The unique number of the MA Table used. A modification to a MA Table that keeps the same name will have a new ma_table_number.
- ref_exposure_type-1.0.0
- ref_optical_element-1.0.0
data
tag:stsci.edu:asdf/unit/quantity-1.* Required
The dark current array represents the integrated number of counts due to the accumulation of dark current electrons in the pixels.
dq
tag:stsci.edu:asdf/core/ndarray-1.* Required
The 2-D data quality array for the Dark Current Array.
dark_slope
tag:stsci.edu:asdf/unit/quantity-1.* Required
The dark current rate array represents the slope of the integrated number of counts due to the accumulation of dark current electrons in the pixels calculated from slope fitting the Dark Current Array.
dark_slope_error
tag:stsci.edu:asdf/unit/quantity-1.* Required
The uncertainty calculated from the slope fitting of the Dark Current Array.

Original Schema ¶

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

title: Dark Reference File Schema

datamodel_name: DarkRefModel

type: object
properties:
  meta:
    allOf:
      - $ref: ref_common-1.0.0
      - type: object
        properties:
          reftype:
            type: string
            enum: [DARK]
          exposure:
            type: object
            properties:
              ngroups:
                title: Number of Resultants
                description: |
                  The number of resultants averaged according to
                  Multi-Accumulation (MA) Table read pattern.
                type: integer
              nframes:
                title: Number of frames per resultant # should be removed
                type: integer
              groupgap:
                title: Number of Skips Between Resultants
                description: |
                  The number of frames skipped between resultants according to
                  MA Table read pattern.
                type: integer
              ma_table_name:
                title: Multi-Accumulation Table Name
                description: |
                  The name of the MA Table used. Not a unique identifier; see
                  ma_table_number.
                type: string
              ma_table_number:
                title: Multi-Accumulation Table Number
                description: |
                  The unique number of the MA Table used. A modification to a MA
                  Table that keeps the same name will have a new
                  ma_table_number.
                type: integer
            required: [ngroups, nframes, groupgap, ma_table_name, ma_table_number]
        required: [exposure]
      - $ref: ref_exposure_type-1.0.0
      - $ref: ref_optical_element-1.0.0
  data:
    title: Dark Current Array
    description: |
      The dark current array represents the integrated number of counts due to
      the accumulation of dark current electrons in the pixels.
    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:
    title: 2-D Data Quality Array
    description: |
      The 2-D data quality array for the Dark Current Array.
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: uint32
    exact_datatype: true
    ndim: 2
  dark_slope:
    title: Dark Current Rate Array
    description: |
      The dark current rate array represents the slope of the integrated number
      of counts due to the accumulation of dark current electrons in the pixels
      calculated from slope fitting the Dark Current Array.
    tag: tag:stsci.edu:asdf/unit/quantity-1.*
    properties:
      value:
        tag: tag:stsci.edu:asdf/core/ndarray-1.*
        datatype: float32
        exact_datatype: true
        ndim: 2
      unit:
        tag: tag:astropy.org:astropy/units/unit-1.*
        enum: ["DN / s"]
  dark_slope_error:
    title: Dark Current Rate Uncertainty Array
    description: |
      The uncertainty calculated from the slope fitting of the Dark Current
      Array.
    tag: tag:stsci.edu:asdf/unit/quantity-1.*
    properties:
      value:
        tag: tag:stsci.edu:asdf/core/ndarray-1.*
        datatype: float32
        exact_datatype: true
        ndim: 2
      unit:
        tag: tag:astropy.org:astropy/units/unit-1.*
        enum: ["DN / s"]
required: [meta, data, dq, dark_slope, dark_slope_error]
flowStyle: block
propertyOrder: [meta, data, dq, dark_slope, dark_slope_error]
...