flat-1.3.0

Flat 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:
- asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_common-1.2.0
- This type is an object with the following properties:
  
  reftype
  string
  No length restriction
  
  Only the following values are valid for this node:
  
  FLAT
- asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_optical_element-1.3.0
data
tag:stsci.edu:asdf/core/ndarray-1.* Required
Flat Data Array

The Flat Data Array represents the small and large pixel-to-pixel mitigations necessary to account for wavelength dependent detector sensitivity and distortions in the optical path.
dq
tag:stsci.edu:asdf/core/ndarray-1.* Required
2-D Data Quality Array

The 2-D data quality array for the Flat Data Array.
err
tag:stsci.edu:asdf/core/ndarray-1.* Required
Flat Data Uncertainty Array

The uncertainty in the Flat Data 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/flat-1.3.0

title: Flat Reference File Schema

datamodel_name: FlatRefModel

type: object
properties:
  meta:
    allOf:
      - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_common-1.2.0
      - type: object
        properties:
          reftype:
            type: string
            enum: [FLAT]
      - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_optical_element-1.3.0
  data:
    title: Flat Data Array
    description: |
      The Flat Data Array represents the small and large pixel-to-pixel
      mitigations necessary to account for wavelength dependent detector
      sensitivity and distortions in the optical path.
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: float32
    exact_datatype: true
    ndim: 2
  dq:
    title: 2-D Data Quality Array
    description: |
      The 2-D data quality array for the Flat Data Array.
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: uint32
    exact_datatype: true
    ndim: 2
  err:
    title: Flat Data Uncertainty Array
    description: |
      The uncertainty in the Flat Data Array.
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: float32
    exact_datatype: true
    ndim: 2
required: [meta, data, dq, err]
flowStyle: block
propertyOrder: [meta, data, dq, err]