saturation-1.0.0

Saturation Reference File Schema

Outline

Schema Definitions

This type is an object with the following properties:

  • meta

    objectRequired

    This node must validate against all of the following:

    • This type is an object with the following properties:

      • reftype

        string
        No length restriction

        Only the following values are valid for this node:

        • SATURATION

  • data

    tag:stsci.edu:asdf/unit/quantity-1.*Required

    The pixel level threshold for determining saturation before non-linearity corrections are applied.

  • dq

    tag:stsci.edu:asdf/core/ndarray-1.*Required

    The 2-D data quality array for the Saturation Threshold 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/saturation-1.0.0

title: Saturation Reference File Schema

datamodel_name: SaturationRefModel

type: object
properties:
  meta:
    allOf:
      - $ref: ref_common-1.0.0
      - type: object
        properties:
          reftype:
            type: string
            enum: [SATURATION]
  data:
    title: Saturation Threshold Array
    description: |
      The pixel level threshold for determining saturation before non-linearity
      corrections are applied.
    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"]
  dq:
    title: 2-D Data Quality Array
    description: |
      The 2-D data quality array for the Saturation Threshold Array.
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: uint32
    exact_datatype: true
    ndim: 2
required: [meta, data, dq]
flowStyle: block
propertyOrder: [meta, data, dq]
...