Remove units from the ref files (#490)

changes/490.feature.rst

@@ -0,0 +1 @@
+Remove units from the reference file schemas.

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

@@ -20,21 +20,6 @@ properties:
           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: |
@@ -48,7 +33,7 @@ properties:
                   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: [ma_table_name, ma_table_number]
         required: [exposure]
       - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_exposure_type-1.0.0
       - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_optical_element-1.0.0
@@ -57,16 +42,11 @@ properties:
     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"]
+    tag: tag:stsci.edu:asdf/core/ndarray-1.*
+    datatype: float32
+    exact_datatype: true
+    ndim: 3
+    unit: DN
   dq:
     title: 2-D Data Quality Array
     description: |
@@ -81,31 +61,21 @@ properties:
       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"]
+    tag: tag:stsci.edu:asdf/core/ndarray-1.*
+    datatype: float32
+    exact_datatype: true
+    ndim: 2
+    unit: 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"]
+    tag: tag:stsci.edu:asdf/core/ndarray-1.*
+    datatype: float32
+    exact_datatype: true
+    ndim: 2
+    unit: DN / s
 required: [meta, data, dq, dark_slope, dark_slope_error]
 flowStyle: block
 propertyOrder: [meta, data, dq, dark_slope, dark_slope_error]

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

@@ -13,26 +13,17 @@ properties:
     allOf:
       - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_common-1.0.0
       - type: object
+
+        input_units: "pixel"
+        output_units: "arcsec"
+
         properties:
           reftype:
             type: string
             enum: [DISTORTION]
-          input_units:
-            title: Input Model Units
-            description: |
-              The pixel input units of the detector coordinate model.
-            tag: tag:stsci.edu:asdf/unit/unit-1.*
-            enum: ["pixel"]
-          output_units:
-            title: Output Model Units
-            description: |
-              The V2/V3 coordinates output units after the model is applied.
-            tag: tag:stsci.edu:asdf/unit/unit-1.*
-            enum: ["arcsec"]
-        required: [output_units, input_units]
       - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_optical_element-1.0.0
   coordinate_distortion_transform:
-    title: Distortion Transform Model
+    title: Distortion Transform Model with inputs in "pixel" and outputs in "arcsec"
     description: |
       The astropy.modeling.Model instance of of the distortion transform model.
     type: object

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

@@ -22,16 +22,11 @@ properties:
     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.*
-    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: ["electron / DN"]
+    tag: tag:stsci.edu:asdf/core/ndarray-1.*
+    datatype: float32
+    exact_datatype: true
+    ndim: 2
+    unit: electron / DN
 required: [meta, data]
 flowStyle: block
 propertyOrder: [meta, data]

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

@@ -13,23 +13,14 @@ properties:
     allOf:
       - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_common-1.0.0
       - type: object
+
+        input_units: "DN"
+        output_units: "DN"
+
         properties:
           reftype:
             type: string
             enum: [INVERSELINEARITY]
-          input_units:
-            title: Inverse Linearity Input Units
-            description: |
-              Units of the input to the inverse linearity polynomial.
-            tag: tag:astropy.org:astropy/units/unit-1.*
-            enum: ["DN"]
-          output_units:
-            title: Inverse Linearity Output Units
-            description: |
-              Units of the output of the inverse linearity polynomial.
-            tag: tag:astropy.org:astropy/units/unit-1.*
-            enum: ["DN"]
-        required: [output_units, input_units]
   coeffs:
     title: Inverse Linearity Coefficients
     description: |

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

@@ -13,23 +13,14 @@ properties:
     allOf:
       - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_common-1.0.0
       - type: object
+
+        input_units: "DN"
+        output_units: "DN"
+
         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: |

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

@@ -25,26 +25,16 @@ properties:
                 description: |
                   The nominal pixel area in steradians.
                 anyOf:
-                  - tag: tag:stsci.edu:asdf/unit/quantity-1.*
-                    properties:
-                      datatype:
-                        enum: ["float64"]
-                      unit:
-                        tag: tag:stsci.edu:asdf/unit/unit-1.*
-                        enum: ["sr"]
+                  - type: number
+                    unit: sr
                   - type: "null"
               pixelarea_arcsecsq:
                 title: Pixel Area (arcsec^2)
                 description:
                   The nominal pixel area in arcec^2.
                 anyOf:
-                  - tag: tag:stsci.edu:asdf/unit/quantity-1.*
-                    properties:
-                      datatype:
-                        enum: ["float64"]
-                      unit:
-                        tag: tag:stsci.edu:asdf/unit/unit-1.*
-                        enum: ["arcsec**2"]
+                  - type: number
+                    unit: arcsec**2
                   - type: "null"
             required: [pixelarea_steradians, pixelarea_arcsecsq]
         required: [photometry]

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

@@ -22,16 +22,11 @@ properties:
     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.*
-    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"]
+    tag: tag:stsci.edu:asdf/core/ndarray-1.*
+    datatype: float32
+    exact_datatype: true
+    ndim: 2
+    unit: DN
 required: [meta, data]
 flowStyle: block
 propertyOrder: [meta, data]

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

@@ -15,19 +15,14 @@ properties:
     allOf:
       - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_common-1.0.0
       - type: object
+
+        input_units: "DN"
+        output_units: "DN"
+
         properties:
           reftype:
             type: string
             enum: [REFPIX]
-          input_units:
-            title: 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.
-            tag: tag:astropy.org:astropy/units/unit-1.*
-            enum: ["DN"]
-        required: [output_units, input_units]
 
   gamma:
     title: Left column correction coefficients

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

@@ -22,16 +22,11 @@ properties:
     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"]
+    tag: tag:stsci.edu:asdf/core/ndarray-1.*
+    datatype: float32
+    exact_datatype: true
+    ndim: 2
+    unit: DN
   dq:
     title: 2-D Data Quality Array
     description: |

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

@@ -32,39 +32,21 @@ properties:
             description: |
               Surface brightness, in MJy / steradian.
             anyOf:
-              - tag: tag:stsci.edu:asdf/unit/quantity-1.*
-                properties:
-                  value:
-                    type: number
-                  unit:
-                    tag: tag:stsci.edu:asdf/unit/unit-1.*
-                    enum: [MJy.sr**-1]
+              - type: number
               - type: "null"
           uncertainty:
             title: Surface Brightness Uncertainty
             description: |
               Uncertainty of surface brightness, in MJy / steradian.
             anyOf:
-              - tag: tag:stsci.edu:asdf/unit/quantity-1.*
-                properties:
-                  value:
-                    type: number
-                  unit:
-                    tag: tag:stsci.edu:asdf/unit/unit-1.*
-                    enum: [MJy.sr**-1]
+              - type: number
               - type: "null"
           pixelareasr:
             title: Pixel Area
             description: |
               The nominal pixel area, in steradian.
             anyOf:
-              - tag: tag:stsci.edu:asdf/unit/quantity-1.*
-                properties:
-                  value:
-                    type: number
-                  unit:
-                    tag: tag:stsci.edu:asdf/unit/unit-1.*
-                    enum: [sr]
+              - type: number
               - type: "null"
         required: [photmjsr, uncertainty, pixelareasr]
     additionalProperties: false

tests/test_schemas.py

@@ -21,6 +21,7 @@
     asdf.schema.load_schema("asdf://stsci.edu/datamodels/roman/schemas/wfi_optical_element-1.0.0")["enum"]
 )
 EXPOSURE_TYPE_ELEMENTS = list(asdf.schema.load_schema("asdf://stsci.edu/datamodels/roman/schemas/exposure_type-1.0.0")["enum"])
+EXPECTED_COMMON_REFERENCE = {"$ref": "asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_common-1.0.0"}
 
 
 @pytest.fixture(scope="session", params=SCHEMA_URIS)
@@ -263,6 +264,19 @@ def test_reftype_tag(ref_file_uris):
     assert asdf.util.uri_match(f"asdf://stsci.edu/datamodels/roman/schemas/reference_files/*{reftype}-*", schema_uri)
 
 
+def test_ref_file_meta_common(ref_file_schema):
+    """
+    Test that the meta for all reference files contains a reference to `ref_common`
+    """
+    all_of = ref_file_schema["properties"]["meta"]["allOf"]
+
+    for item in all_of:
+        if item == EXPECTED_COMMON_REFERENCE:
+            break
+    else:
+        raise ValueError("ref_common not found in meta")
+
+
 # don't test tvac or fps schemas as they are static
 @pytest.mark.parametrize(
     "uri",