linearity-1.0.0

Linearity Correction Reference 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:
  
  LINEARITY
  
  input_units
  tag:astropy.org:astropy/units/unit-1.* Required
  Units of the input to the linearity polynomial.
  
  Only the following values are valid for this node:
  
  DN
  
  output_units
  tag:astropy.org:astropy/units/unit-1.* Required
  Units of the output to the linearity polynomial.
  
  Only the following values are valid for this node:
  
  DN
coeffs
tag:stsci.edu:asdf/core/ndarray-1.* Required
Contains the coefficients of a polynomial to correct the non-linear response of each pixel to a linear signal. Both the input to and output from the polynomial are in units of DN. The coefficients have units that contain various powers of DN.
dq
tag:stsci.edu:asdf/core/ndarray-1.* Required
Two Dimensional data Quality Array for all Resultants

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/linearity-1.0.0

title: Linearity Correction Reference Schema

datamodel_name: LinearityRefModel

type: object
properties:
  meta:
    allOf:
      - $ref: ref_common-1.0.0
      - type: object
        properties:
          reftype:
            type: string
            enum: [LINEARITY]
          input_units:
            title: Units of the Input to the Linearity Polynomial
            description: |
              Units of the input to the linearity polynomial.
            tag: tag:astropy.org:astropy/units/unit-1.*
            enum: ["DN"]
          output_units:
            title: Units of the Output of the Linearity Polynomial
            description: |
              Units of the output to the linearity polynomial.
            tag: tag:astropy.org:astropy/units/unit-1.*
            enum: ["DN"]
        required: [output_units, input_units]
  coeffs:
    title: Linearity Coefficients
    description: |
      Contains the coefficients of a polynomial to correct the non-linear
      response of each pixel to a linear signal. Both the input to and output
      from the polynomial are in units of DN. The coefficients have units that
      contain various powers of DN.
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: float32
    exact_datatype: true
    # Dimensions: numcoeffs, ysize, xsize
    ndim: 3
  dq:
    title: Two Dimensional Data Quality Array for All Resultants
    description: |
      Two Dimensional data Quality Array for all Resultants
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: uint32
    exact_datatype: true
    ndim: 2
required: [meta, coeffs, dq]
flowStyle: block
propertyOrder: [meta, coeffs, dq]
...