Update data products titles and descriptions

src/rad/resources/schemas/aperture-1.0.0.yaml

@@ -3,11 +3,14 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/aperture-1.0.0
 
-title: Aperture information
+title: Aperture Information
 type: object
 properties:
   name:
-    title: PRD science aperture used
+    title: PRD Science Aperture Used
+    description: |
+      Science aperture used as defined in the Project
+      Reference Database (PRD).
     type: string
     enum: ['WFI_01_FULL', 'WFI_02_FULL', 'WFI_03_FULL', 'WFI_04_FULL',
            'WFI_05_FULL', 'WFI_06_FULL', 'WFI_07_FULL', 'WFI_08_FULL',
@@ -24,7 +27,9 @@ properties:
       datatype: nvarchar(40)
       destination: [ScienceCommon.aperture_name, GuideWindow.aperture_name]
   position_angle:
-    title: "[deg] Position angle of aperture used"
+    title: "Position Angle of Aperture Used (deg)"
+    description: |
+      Position angle of the science aperture as measured in degrees.
     type: number
     sdf:
       special_processing: VALUE_REQUIRED

src/rad/resources/schemas/associations-1.0.0.yaml

@@ -3,33 +3,67 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/associations-1.0.0
 
-title: Association table data model
+title: Association Table Data Model
 
 datamodel_name: AssociationsModel
 
 type: object
 properties:
   asn_id:
+    title: Association ID
+    description: |
+      The unique identifier of the association to which the processed
+      observations belong.
     type: string
   asn_pool:
+    title: Association Pool
     type: string
   asn_type:
+    title: Association Type
+    description: |
+      The type of association observed, such as a dither FOV association or a
+      mosaic survey association.
     type: string
   asn_rule:
+    title: Association Rule
+    description: |
+      Any rules that need to be followed for this particular type of
+      association.
     type: string
   version_id:
+    title: Version ID
+    description: |
+      The unique version identifier that provides context for the data release
+      version and circumstances for the processing.
     type: string
   code_version:
+    title: Code Version
+    description: |
+      The exact code version used to process the observations.
     type: string
   degraded_status:
+    title: Degraded Status
+    description: |
+      Details about how the observations might have suffered degradation, such
+      as a guide star failure.
     type: string
   program:
+    title: Program ID
+    description: |
+      The unique program identifier to which the associated observations belong.
     type: integer
   target:
+    title: Target Name
+    description: |
+      The name or ID of the target being observed.
     type: integer
   constraints:
+    title: Constraints
     type: string
   products:
+    title: Resultant Products
+    description: |
+      The resulting output products created by the processing.
     type: array
     items:
       type: object

src/rad/resources/schemas/basic-1.0.0.yaml

@@ -3,26 +3,54 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/basic-1.0.0
 
-title: Common metadata keywords
+title: Basic Information
 
 type: object
 properties:
   # Meta Variables
   calibration_software_version:
+    title: Calibration Software Version Number
+    description: |
+      The version number of the calibration software used in processing this
+      file.
     tag: asdf://stsci.edu/datamodels/roman/tags/calibration_software_version-1.0.0
   filename:
+    title: File Name
+    description: |
+      The auto-generated name of this file.
     tag: asdf://stsci.edu/datamodels/roman/tags/filename-1.0.0
   file_date:
+    title: File Creation Date
+    description: |
+      The date and time this file was created.
     tag: asdf://stsci.edu/datamodels/roman/tags/file_date-1.0.0
   model_type:
+    title: Data Model Type
+    description: |
+      The type of data model contained in this file.
     tag: asdf://stsci.edu/datamodels/roman/tags/model_type-1.0.0
   origin:
+    title: Institution / Organization Name
+    description: |
+      The name of the institution or organization responsible for creating this
+      file.
     tag: asdf://stsci.edu/datamodels/roman/tags/origin-1.0.0
   prd_software_version:
+    title: SOC PRD Version Number
+    description: |
+      The Science Operations Center (SOC) Project Reference Database (PRD)
+      version number used in generating this file.
     tag: asdf://stsci.edu/datamodels/roman/tags/prd_software_version-1.0.0
   sdf_software_version:
+    title: SDF Version Number
+    description: |
+      The version number of the Science Data Formatting (SDF) software used in
+      generating this file.
     tag: asdf://stsci.edu/datamodels/roman/tags/sdf_software_version-1.0.0
   telescope:
+    title: Telescope Name
+    description: |
+      The name of the telescope used to acquire the data.
     tag: asdf://stsci.edu/datamodels/roman/tags/telescope-1.0.0
 required: [calibration_software_version, filename, file_date,
            model_type, origin, prd_software_version,

src/rad/resources/schemas/cal_logs-1.0.0.yaml

@@ -3,7 +3,10 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/cal_logs-1.0.0
 
-title: Calibration log messages
+title: Calibration Log Messages
+description: |
+  String array of log messages recording the steps, failures, and outputs
+  associated with running the romancal.ramp_fitting.ramp_fit_step.
 type: array
 items:
   type: string

src/rad/resources/schemas/cal_step-1.0.0.yaml

@@ -7,105 +7,153 @@ title: Calibration Status
 type: object
 properties:
   assign_wcs:
-    title: Assign World Coordinate System
+    title: Assign WCS Step
+    description: |
+      Step in ROMANCAL that assigns a World Coordinate System (WCS) object to a
+      science image.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_assign_wcs, GuideWindow.s_assign_wcs]
   flat_field:
-    title: Flat Field Step
+    title: Flat Fielding Step
+    descroption: |
+      Step in ROMANCAL in which a science image is flat-fielded, whereby each
+      detector pixel is calibrated to give the same signal for the same
+      illumination, given its specific response. This is achieved using a
+      flatfield reference image.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_flat_field, GuideWindow.s_flat_field]
   dark:
-    title: Dark Subtraction
+    title: Dark Current Subtraction Step
+    description: |
+      Step in ROMANCAL performing the dark current correction by subtracting
+      dark current reference data from science data.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_dark, GuideWindow.s_dark]
   dq_init:
-    title: Data Quality Mask Step
+    title: Initialization of the Data Quality Extension Step
+    description: |
+      Step in ROMANCAL in which the pixeldq attribute of the input data model
+      using the MASK reference file is initialized.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_dq_init, GuideWindow.s_dq_init]
   jump:
-    title: Jump Detection Step
+    title: Cosmic Rays and Jump Detection Step
+    description: |
+      Step in ROMANCAL which performs a search for jumps in values in ramp that
+      may be associated with cosmic rays.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_jump, GuideWindow.s_jump]
   linearity:
-    title: Linearity Correction
+    title: Linearity Correction Step
+    description: |
+      This step performs a correction for the classical non-linear detector
+      response.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_linearity, GuideWindow.s_linearity]
   photom:
-    title: Photometry Step
+    title: Photometric Calibration Step
+    description: |
+      Step in the ROMANCAL package that adds photometric calibrations  to the
+      metadata of a data product.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_photom, GuideWindow.s_photom]
   source_detection:
     title: Source Detection Step
+    description: |
+      Step in ROMANCAL to detect point sources in an image and catalog them.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_source_detection, GuideWindow.s_source_detection]
   ramp_fit:
-    title: Ramp Fitting
+    title: Ramp Fit Step
+    description: |
+      Step in ROMANCAL to fit the counts versus time with a straight line and
+      thus estimate the count rate for each pixel.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_ramp_fit, GuideWindow.s_ramp_fit]
   refpix:
-    title: Reference Pixel Correction
+    title: Reference Pixel Correction Step
+    description: |
+      Step in ROMANCAL that corrects for additional signal from electronics
+      contributing to e.g. 1/f noise using the reference pixels.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_refpix, GuideWindow.s_refpix]
   saturation:
-    title: Saturation Checking
+    title: Saturation Identification Step
+    description: |
+      Step in ROMANCAL which sets pixel flags to signal if a pixel is at or
+      above the saturation threshold. As part of this step, pixels that are zero
+      or negative are also flagged.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_saturation, GuideWindow.s_saturation]
   outlier_detection:
-    title: outlier_detection
+    title: Outlier Detection Step
+    description: |
+      Step in ROMANCAL which detects and flags outliers in a science image.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_outlier_detection, GuideWindow.s_outlier_detection]
   tweakreg:
     title: Tweakreg step
+    description: |
+      Step in ROMANCAL that compares positions of point-like sources with
+      coordinates from a Gaia catalog, and, if necessary, corrects an image's
+      World Coordinate System  alignment.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_tweakreg, GuideWindow.s_tweakreg]
   skymatch:
-    title: Sky Match step
+    title: Sky Matching for Combining Overlapping Images Step
+    description: |
+      Step in ROMANCAL that computes sky background values of each input image
+      and derives scalings to equalize overlapping regions.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:
       datatype: nvarchar(15)
       destination: [ScienceRefData.s_skymatch, GuideWindow.s_skymatch]
   resample:
-    title: Resample Step
+    title: Resampling Input Data onto a Regular Grid Step
+    description: |
+      Step in ROMANCAL which resamples each input 2D image based on the WCS and
+      WCS distortion information on a grid that allows the combination of
+      multiple resampled images into a single, undistorted product.
     type: string
     enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE']
     archive_catalog:

src/rad/resources/schemas/common-1.0.0.yaml

@@ -12,34 +12,49 @@ allOf:
   properties:
     # Meta Objects
     aperture:
+      title: Aperture Information
       tag: asdf://stsci.edu/datamodels/roman/tags/aperture-1.0.0
     cal_step:
+      title: Calibration Tracker of Pipeline Steps
       tag: asdf://stsci.edu/datamodels/roman/tags/cal_step-1.0.0
     coordinates:
+      title: Name Of The Coordinate Reference Frame
       tag: asdf://stsci.edu/datamodels/roman/tags/coordinates-1.0.0
     ephemeris:
+      title: Ephemeris Data Information
       tag: asdf://stsci.edu/datamodels/roman/tags/ephemeris-1.0.0
     exposure:
+      title: Exposure Information
       tag: asdf://stsci.edu/datamodels/roman/tags/exposure-1.0.0
     guidestar:
+      title: Guide Star Window Information
       tag: asdf://stsci.edu/datamodels/roman/tags/guidestar-1.0.0
     instrument:
+      title: WFI Observing Configuration
       tag: asdf://stsci.edu/datamodels/roman/tags/wfi_mode-1.0.0
     observation:
+      title: Observation Identifiers
       tag: asdf://stsci.edu/datamodels/roman/tags/observation-1.0.0
     pointing:
+      title: Spacecraft Pointing Information
       tag: asdf://stsci.edu/datamodels/roman/tags/pointing-1.0.0
     program:
+      title: Program Information
       tag: asdf://stsci.edu/datamodels/roman/tags/program-1.0.0
     ref_file:
+      title: Reference File Information
       tag: asdf://stsci.edu/datamodels/roman/tags/ref_file-1.0.0
     target:
+      title: Target Information
       tag: asdf://stsci.edu/datamodels/roman/tags/target-1.0.0
     velocity_aberration:
+      title: Velocity Aberration Correction Information
       tag: asdf://stsci.edu/datamodels/roman/tags/velocity_aberration-1.0.0
     visit:
+      title: Visit Information
       tag: asdf://stsci.edu/datamodels/roman/tags/visit-1.0.0
     wcsinfo:
+      title: World Coordinate System (WCS) Parameters
       tag: asdf://stsci.edu/datamodels/roman/tags/wcsinfo-1.0.0
   required: [aperture, cal_step, coordinates, ephemeris, exposure, guidestar,
              instrument, observation, pointing, program, ref_file,

src/rad/resources/schemas/coordinates-1.0.0.yaml

@@ -3,11 +3,13 @@
 $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
 id: asdf://stsci.edu/datamodels/roman/schemas/coordinates-1.0.0
 
-title: Information about the coordinates in the file
+title: Name Of The Coordinate Reference Frame
 type: object
 properties:
   reference_frame:
-    title: Name of the coordinate reference frame
+    title: Name of the Coordinate Reference Frame
+    description: |
+      Name of the coordinate reference frame.
     type: string
     default: ICRS
     enum: [ICRS]