Update reference file titles and descriptions

src/rad/resources/schemas/reference_files/dark-1.0.0.yaml

@@ -3,7 +3,7 @@
 $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 schema
+title: Dark Reference File Schema
 
 datamodel_name: DarkRefModel
 
@@ -21,29 +21,42 @@ properties:
             type: object
             properties:
               ngroups:
-                title: Number of groups in integration
+                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 group
+                title: Number of frames per group # should be removed
                 type: integer
               groupgap:
-                title: Number of frames dropped between groups
+                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: Identifier for the multi-accumulation table used
+                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: Number of the multi-accumulation table used
+                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
+    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.
+      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.1.0
     properties:
       value:
@@ -54,16 +67,18 @@ properties:
         tag: tag:astropy.org:astropy/units/unit-1.0.0
         enum: ["DN"]
   dq:
-    title: 2-D data quality array for all planes
+    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.0.0
     datatype: uint32
     ndim: 2
   dark_slope:
-    title: Dark current slope array
+    title: Dark Current Rate Array
     description: |
-       The dark current slope array represents the slope of the
-       integrated number of counts due to the accumulation of dark
-       current electrons in the pixels for slope fitting purposes.
+      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.1.0
     properties:
       value:
@@ -74,7 +89,10 @@ properties:
         tag: tag:astropy.org:astropy/units/unit-1.0.0
         enum: ["DN / s"]
   dark_slope_error:
-    title: Uncertainty in dark current slope array
+    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.1.0
     properties:
       value:

src/rad/resources/schemas/reference_files/distortion-1.0.0.yaml

@@ -3,7 +3,7 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/reference_files/distortion-1.0.0
 
-title: Distortion reference schema
+title: Distortion Reference Schema
 
 datamodel_name: DistortionRefModel
 
@@ -18,17 +18,23 @@ properties:
             type: string
             enum: [DISTORTION]
           input_units:
-            title: Units of the detector coordinate inputs to this model.
+            title: Input Model Units
+            description: |
+              The pixel input units of the detector coordinate model.
             tag: tag:stsci.edu:asdf/unit/unit-1.0.0
             enum: ["pixel"]
           output_units:
-            title: Output units of V2/V3 coordinates after the model is applied.
+            title: Output Model Units
+            description: |
+              The V2/V3 coordinates output units after the model is applied.
             tag: tag:stsci.edu:asdf/unit/unit-1.0.0
             enum: ["arcsec"]
         required: [output_units, input_units]
       - $ref: ref_optical_element-1.0.0
   coordinate_distortion_transform:
-    title: Distortion transform as an instance of astropy.modeling.Model.
+    title: Distortion Transform Model
+    description: |
+      The astropy.modeling.Model instance of of the distortion transform model.
     type: object
 required: [meta, coordinate_distortion_transform]
 flowStyle: block

src/rad/resources/schemas/reference_files/flat-1.0.0.yaml

@@ -3,7 +3,7 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/reference_files/flat-1.0.0
 
-title: Flat reference schema
+title: Flat Reference File Schema
 
 datamodel_name: FlatRefModel
 
@@ -19,17 +19,25 @@ properties:
             enum: [FLAT]
       - $ref: ref_optical_element-1.0.0
   data:
-    title: Flat data array
+    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.0.0
     datatype: float32
     ndim: 2
   dq:
-    title: Data quality array
+    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.0.0
     datatype: uint32
     ndim: 2
   err:
-    title: Error array
+    title: Flat Data Uncertainty Array
+    description: |
+      The uncertainty in the Flat Data Array.
     tag: tag:stsci.edu:asdf/core/ndarray-1.0.0
     datatype: float32
     ndim: 2

src/rad/resources/schemas/reference_files/gain-1.0.0.yaml

@@ -3,7 +3,7 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/reference_files/gain-1.0.0
 
-title: Gain reference schema
+title: Gain Reference File Schema
 
 datamodel_name: GainRefModel
 
@@ -18,7 +18,10 @@ properties:
             type: string
             enum: [GAIN]
   data:
-    title: The detector gain map
+    title: Gain Data Array
+    description: |
+      The Gain Data Array represents the pixel to pixel conversion from digital
+      numbers (DN) to electrons (e). The units are e/DN.
     tag: tag:stsci.edu:asdf/unit/quantity-1.1.0
     properties:
       value:

src/rad/resources/schemas/reference_files/inverselinearity-1.0.0.yaml

@@ -3,7 +3,7 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/reference_files/inverselinearity-1.0.0
 
-title: Inverse linearity correction reference schema
+title: Inverse Linearity Correction Reference Schema
 
 datamodel_name: InverselinearityRefModel
 
@@ -18,26 +18,33 @@ properties:
             type: string
             enum: [INVERSELINEARITY]
           input_units:
-            title: Units of the input to the inverse linearity polynomial.
+            title: Inverse Linearity Input Units
+            description: |
+              Units of the input to the inverse linearity polynomial.
             tag: tag:astropy.org:astropy/units/unit-1.0.0
             enum: ["DN"]
           output_units:
-            title: Units of the output of the inverse linearity polynomial.
+            title: Inverse Linearity Output Units
+            description: |
+              Units of the output of the inverse linearity polynomial.
             tag: tag:astropy.org:astropy/units/unit-1.0.0
             enum: ["DN"]
         required: [output_units, input_units]
   coeffs:
-    title: Inverse linearity coefficients
+    title: Inverse Linearity Coefficients
     description: |
-      Contains the coefficients of a polynomial to add classic non-linearity
-      to pixels. Both the input to and output from the polynomial are in units
-      of DN. The coefficients have units that contain various powers of DN.
+      Contains the coefficients of a polynomial which describe 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.0.0
     datatype: float32
     # Dimensions: numcoeffs, ysize, xsize
     ndim: 3
   dq:
-    title: 2-D data quality array for all planes
+    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.0.0
     datatype: uint32
     ndim: 2

src/rad/resources/schemas/reference_files/ipc-1.0.0.yaml

@@ -3,7 +3,7 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/reference_files/ipc-1.0.0
 
-title: IPC kernel reference schema
+title:  Interpixel Capacitance Reference File Schema
 
 datamodel_name: IpcRefModel
 
@@ -19,10 +19,10 @@ properties:
             type: string
             enum: [IPC]
   data:
-    title: Interpixel capacitance correction kernel array
+    title: Interpixel Capacitance Kernel Array
     description: |
-      Reference kernel used for convolving with data in order to correct
-      for interpixel capacitance
+      The kernel array used for convolving data to correct for interpixel
+      capacitance of neighboring pixels.
     tag: tag:stsci.edu:asdf/core/ndarray-1.0.0
     datatype: float32
     ndim: 2

src/rad/resources/schemas/reference_files/linearity-1.0.0.yaml

@@ -3,7 +3,7 @@
 $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
+title: Linearity Correction Reference Schema
 
 datamodel_name: LinearityRefModel
 
@@ -18,27 +18,33 @@ properties:
             type: string
             enum: [LINEARITY]
           input_units:
-            title: Units of the input to the linearity polynomial.
+            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.0.0
             enum: ["DN"]
           output_units:
-            title: Units of the output of the linearity polynomial.
+            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.0.0
             enum: ["DN"]
         required: [output_units, input_units]
   coeffs:
-    title: Linearity coefficients
+    title: Linearity Coefficients
     description: |
-      Contains the coefficients of a polynomial to correct pixel
-      values for classic non-linearity. Both the input to and
-      output from the polynomial are in units of DN. The coefficients
-      have units that contain various powers of DN.
+      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.0.0
     datatype: float32
     # Dimensions: numcoeffs, ysize, xsize
     ndim: 3
   dq:
-    title: 2-D data quality array for all planes
+    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.0.0
     datatype: uint32
     ndim: 2

src/rad/resources/schemas/reference_files/mask-1.0.0.yaml

@@ -3,7 +3,7 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/reference_files/mask-1.0.0
 
-title: DQ Mask reference schema
+title: Mask Reference File Schema
 
 datamodel_name: MaskRefModel
 
@@ -18,7 +18,10 @@ properties:
             type: string
             enum: [MASK]
   dq:
-    title: Data quality mask array
+    title: Mask Data Quality Array
+    description: |
+      The Mask Data Quality Array is the pixel value of the sum of bit integer
+      dq flags.
     tag: tag:stsci.edu:asdf/core/ndarray-1.0.0
     datatype: uint32
     ndim: 2

src/rad/resources/schemas/reference_files/pixelarea-1.0.0.yaml

@@ -3,7 +3,7 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/reference_files/pixelarea-1.0.0
 
-title: Pixel area reference schema
+title: Pixel Area Reference Schema
 
 datamodel_name: PixelareaRefModel
 
@@ -21,7 +21,9 @@ properties:
             type: object
             properties:
               pixelarea_steradians:
-                title: Nominal pixel area in steradians
+                title: Pixel Area (steradians)
+                description: |
+                  The nominal pixel area in steradians.
                 anyOf:
                   - tag: tag:stsci.edu:asdf/unit/quantity-1.1.0
                     properties:
@@ -32,7 +34,9 @@ properties:
                         enum: ["sr"]
                   - type: "null"
               pixelarea_arcsecsq:
-                title: Nominal pixel area in arcsec^2
+                title: Pixel Area (arcsec^2)
+                description:
+                  The nominal pixel area in arcec^2.
                 anyOf:
                   - tag: tag:stsci.edu:asdf/unit/quantity-1.1.0
                     properties:
@@ -46,7 +50,9 @@ properties:
         required: [photometry]
       - $ref: ref_optical_element-1.0.0
   data:
-    title: Pixel area array
+    title: Pixel Area Array
+    description: |
+      Pixel area in units of of either arcseconds or steradians.
     tag: tag:stsci.edu:asdf/core/ndarray-1.0.0
     datatype: float32
     ndim: 2

src/rad/resources/schemas/reference_files/readnoise-1.0.0.yaml

@@ -3,7 +3,7 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/reference_files/readnoise-1.0.0
 
-title: Read noise reference schema
+title: Read Noise Reference File Schema
 
 datamodel_name: ReadnoiseRefModel
 
@@ -18,7 +18,10 @@ properties:
             enum: [READNOISE]
       - $ref: ref_exposure_type-1.0.0
   data:
-    title: Read noise data array
+    title: Read Noise Data Array
+    description: |
+      The pixel-by-pixel map read noise data array is used in estimating the
+      expected noise in each pixel.
     tag: tag:stsci.edu:asdf/unit/quantity-1.1.0
     properties:
       value: