diff --git a/src/rad/resources/schemas/aperture-1.0.0.yaml b/src/rad/resources/schemas/aperture-1.0.0.yaml index 7f553d36..208ca238 100644 --- a/src/rad/resources/schemas/aperture-1.0.0.yaml +++ b/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 diff --git a/src/rad/resources/schemas/associations-1.0.0.yaml b/src/rad/resources/schemas/associations-1.0.0.yaml index ce9885cc..dff9b2a1 100644 --- a/src/rad/resources/schemas/associations-1.0.0.yaml +++ b/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 diff --git a/src/rad/resources/schemas/basic-1.0.0.yaml b/src/rad/resources/schemas/basic-1.0.0.yaml index 59b8e5ff..6000da82 100644 --- a/src/rad/resources/schemas/basic-1.0.0.yaml +++ b/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, diff --git a/src/rad/resources/schemas/cal_logs-1.0.0.yaml b/src/rad/resources/schemas/cal_logs-1.0.0.yaml index 67ca0887..b233d0a9 100644 --- a/src/rad/resources/schemas/cal_logs-1.0.0.yaml +++ b/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 diff --git a/src/rad/resources/schemas/cal_step-1.0.0.yaml b/src/rad/resources/schemas/cal_step-1.0.0.yaml index bdd377c9..f8af9067 100644 --- a/src/rad/resources/schemas/cal_step-1.0.0.yaml +++ b/src/rad/resources/schemas/cal_step-1.0.0.yaml @@ -7,49 +7,72 @@ 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: @@ -57,34 +80,48 @@ properties: 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: @@ -92,20 +129,31 @@ properties: 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: diff --git a/src/rad/resources/schemas/common-1.0.0.yaml b/src/rad/resources/schemas/common-1.0.0.yaml index 25a3294c..28aeb25a 100644 --- a/src/rad/resources/schemas/common-1.0.0.yaml +++ b/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, diff --git a/src/rad/resources/schemas/coordinates-1.0.0.yaml b/src/rad/resources/schemas/coordinates-1.0.0.yaml index 65b27f03..eca2b3d6 100644 --- a/src/rad/resources/schemas/coordinates-1.0.0.yaml +++ b/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] diff --git a/src/rad/resources/schemas/ephemeris-1.0.0.yaml b/src/rad/resources/schemas/ephemeris-1.0.0.yaml index ee1473a1..0cd1fad1 100644 --- a/src/rad/resources/schemas/ephemeris-1.0.0.yaml +++ b/src/rad/resources/schemas/ephemeris-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/ephemeris-1.0.0 -title: Ephemeris data information +title: Ephemeris Data Information type: object properties: earth_angle: - title: "[radians] Earth Angle" + title: Earth Angle (radians) + description: | + Earth angle in radians. type: number sdf: special_processing: VALUE_REQUIRED @@ -17,7 +19,9 @@ properties: datatype: float destination: [ScienceCommon.earth_angle, GuideWindow.earth_angle] moon_angle: - title: "[radians] Moon Angle" + title: Moon Angle (radians) + description: | + Moon angle in radians. type: number sdf: special_processing: VALUE_REQUIRED @@ -27,7 +31,9 @@ properties: datatype: float destination: [ScienceCommon.moon_angle, GuideWindow.moon_angle] ephemeris_reference_frame: - title: Ephemeris reference frame + title: Ephemeris Reference Frame + description: | + Ephemeris reference frame. type: string sdf: special_processing: VALUE_REQUIRED @@ -37,7 +43,9 @@ properties: datatype: nvarchar(10) destination: [ScienceCommon.ephemeris_reference_frame, GuideWindow.ephemeris_reference_frame] sun_angle: - title: "[radians] Sun Angle" + title: Sun Angle (radians) + description: | + Sun angle in radians. type: number sdf: special_processing: VALUE_REQUIRED @@ -47,7 +55,9 @@ properties: datatype: float destination: [ScienceCommon.sun_angle, GuideWindow.sun_angle] type: - title: Type of ephemeris + title: Type of Ephemeris + description: | + Type of ephemeris. type: string enum: [DEFINITIVE, PREDICTED] sdf: @@ -58,7 +68,9 @@ properties: datatype: nvarchar(10) destination: [ScienceCommon.ephemeris_type, GuideWindow.ephemeris_type] time: - title: UTC time of position and velocity vectors in ephemeris (MJD) + title: UTC Time of Position and Velocity Vectors in ephemeris (MJD) + description: | + UTC time of position and velocity vectors in ephemeris in MJD. type: number sdf: special_processing: VALUE_REQUIRED @@ -68,7 +80,9 @@ properties: datatype: float destination: [ScienceCommon.ephemeris_time, GuideWindow.ephemeris_time] spatial_x: - title: "[km] X spatial coordinate of Roman" + title: X Spatial Coordinate of Roman (km) + description: | + X spatial coordinate of Roman in km. type: number sdf: special_processing: VALUE_REQUIRED @@ -78,7 +92,9 @@ properties: datatype: float destination: [ScienceCommon.spatial_x, GuideWindow.spatial_x] spatial_y: - title: "[km] Y spatial coordinate of Roman" + title: Y Spatial Coordinate of Roman (km) + description: | + Y spatial coordinate of Roman in km. type: number sdf: special_processing: VALUE_REQUIRED @@ -88,7 +104,9 @@ properties: datatype: float destination: [ScienceCommon.spatial_y, GuideWindow.spatial_y] spatial_z: - title: "[km] Z spatial coordinate of Roman" + title: Z Spatial Coordinate of Roman (km) + description: | + Z spatial coordinate of Roman in km. type: number sdf: special_processing: VALUE_REQUIRED @@ -98,7 +116,9 @@ properties: datatype: float destination: [ScienceCommon.spatial_z, GuideWindow.spatial_z] velocity_x: - title: "[km/s] X component of Roman velocity" + title: X Component of Roman Velocity (km / s) + description: | + X component of Roman velocity in km / s. type: number sdf: special_processing: VALUE_REQUIRED @@ -108,7 +128,9 @@ properties: datatype: float destination: [ScienceCommon.velocity_x, GuideWindow.velocity_x] velocity_y: - title: "[km/s] Y component of Roman velocity" + title: Y Component of Roman Velocity (km / s) + description: | + Y component of Roman velocity in km / s. type: number sdf: special_processing: VALUE_REQUIRED @@ -118,7 +140,9 @@ properties: datatype: float destination: [ScienceCommon.velocity_y, GuideWindow.velocity_y] velocity_z: - title: "[km/s] Z component of Roman velocity" + title: Z Component of Roman Velocity (km / s) + description: | + Z component of Roman velocity in km / s. type: number sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/exposure-1.0.0.yaml b/src/rad/resources/schemas/exposure-1.0.0.yaml index ce0f9fb2..f63add64 100644 --- a/src/rad/resources/schemas/exposure-1.0.0.yaml +++ b/src/rad/resources/schemas/exposure-1.0.0.yaml @@ -4,14 +4,14 @@ $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 id: asdf://stsci.edu/datamodels/roman/schemas/exposure-1.0.0 -title: | - Exposure information +title: Exposure Information type: object properties: id: - title: Exposure id number within visit - description: The exposure number for a given visit id + title: Visit Exposure ID + description: | + The matching exposure ID for a given visit ID. type: integer sdf: special_processing: VALUE_REQUIRED @@ -32,10 +32,9 @@ properties: destination: [ScienceCommon.exposure_type, GuideWindow.exposure_type] start_time: - title: UTC exposure start time + title: Exposure Start Time (UTC) description: | - This is a python date-time object that records the - time at the start of the exposure in UTC. + The UTC time at the beginning of the exposure. tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED @@ -45,10 +44,9 @@ properties: datatype: datetime2 destination: [ScienceCommon.exposure_start_time, GuideWindow.exposure_start_time] mid_time: - title: UTC exposure mid time + title: Exposure Mid Time (UTC) description: | - This is a python date-time object that records the - time at the middle of the exposure in UTC. + The UTC time at the midpoint of the exposure. tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED @@ -58,10 +56,9 @@ properties: datatype: datetime2 destination: [ScienceCommon.exposure_mid_time, GuideWindow.exposure_mid_time] end_time: - title: UTC exposure end time + title: Exposure End Time (UTC) description: | - This is a python date-time object that records the - time at the end of the exposure in UTC. + The UTC time at the end of the exposure. tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED @@ -71,11 +68,10 @@ properties: datatype: datetime2 destination: [ScienceCommon.exposure_end_time, GuideWindow.exposure_end_time] start_time_mjd: - title: "[d] exposure start time in MJD" + title: MJD Start Time (d) description: | - This records the time at the start of the exposure using the - Modified Julian Date (MJD). This is used in the archive catalog for - multi-mission matching. + The date, in MJD, at the beginning of this exposure. Used in the archive + catalog for multi-mission matching. type: number sdf: special_processing: VALUE_REQUIRED @@ -85,11 +81,10 @@ properties: datatype: float destination: [ScienceCommon.exposure_start_time_mjd, GuideWindow.exposure_start_time_mjd] mid_time_mjd: - title: "[d] exposure mid time in MJD" + title: MJD Mid Time (d) description: | - This records the time at the midpoint of the exposure using the - Modified Julian Date (MJD). This is used in the archive catalog for - multi-mission matching. + The date, in MJD, at the midpoint of this exposure. Used in the archive + catalog for multi-mission matching. type: number sdf: special_processing: VALUE_REQUIRED @@ -99,11 +94,10 @@ properties: datatype: float destination: [ScienceCommon.exposure_mid_time_mjd, GuideWindow.exposure_mid_time_mjd] end_time_mjd: - title: "[d] exposure end time in MJD" + title: MJD End Time (d) description: | - This records the time at the end of the exposure using the - Modified Julian Date (MJD). This is used in the archive catalog for - multi-mission matching. + The date, in MJD, at the end of this exposure. Used in the archive catalog + for multi-mission matching. type: number sdf: special_processing: VALUE_REQUIRED @@ -113,12 +107,10 @@ properties: datatype: float destination: [ScienceCommon.exposure_end_time_mjd, GuideWindow.exposure_end_time_mjd] start_time_tdb: - title: "[d] TDB time of exposure start in MJD" + title: TDB Start Time (d) description: | - This records the time at the start of the exposure using - the Modified Julian Date for the Barycentric Dynamical Time system - (TDB, Temps Dynamique Barycentrique), a relativistic coordinate - time scale. + The date, in TDB (Barycentric Dynamical Time), at the beginning of this + exposure. type: number sdf: special_processing: VALUE_REQUIRED @@ -128,12 +120,10 @@ properties: datatype: float destination: [ScienceCommon.exposure_start_time_tdb, GuideWindow.exposure_start_time_tdb] mid_time_tdb: - title: "[d] TDB time of exposure mid in MJD" + title: TDB Mid Time (d) description: | - This records the time at the midpoint of the exposure using - the Modified Julian Date for the Barycentric Dynamical Time system - (TDB, Temps Dynamique Barycentrique), a relativistic coordinate - time scale. + The date, in TDB (Barycentric Dynamical Time), at the midpoint of this + exposure. type: number sdf: special_processing: VALUE_REQUIRED @@ -143,12 +133,10 @@ properties: datatype: float destination: [ScienceCommon.exposure_mid_time_tdb, GuideWindow.exposure_mid_time_tdb] end_time_tdb: - title: "[d] TDB time of exposure end in MJD" + title: TDB End Time (d) description: | - This records the time at the end of the exposure using - the Modified Julian Date for the Barycentric Dynamical Time system - (TDB, Temps Dynamique Barycentrique), a relativistic coordinate - time scale. + The date, in TDB (Barycentric Dynamical Time), at the end of this + exposure. type: number sdf: special_processing: VALUE_REQUIRED @@ -158,11 +146,10 @@ properties: datatype: float destination: [ScienceCommon.exposure_end_time_tdb, GuideWindow.exposure_end_time_tdb] ngroups: - title: Number of groups in integration + title: Number of Resultants description: | - This is the number of resultant frames in the exposure - that are transmitted to the ground. The WFI data always has the - number of integrations=1. + The number of resultant frames in this exposure that were transmitted to + the ground. The number of integrations of WFI data is always 1. type: integer sdf: special_processing: VALUE_REQUIRED @@ -172,10 +159,9 @@ properties: datatype: int destination: [ScienceCommon.exposure_ngroups, GuideWindow.exposure_ngroups] nframes: - title: Number of frames per group + title: Number of Reads description: | - This is the number of science frames that are combined to - produce a resultant frame. + This is the number of science frames that are combined to produce a resultant frame. type: integer sdf: special_processing: VALUE_REQUIRED @@ -185,10 +171,9 @@ properties: datatype: int destination: [ScienceCommon.exposure_nframes, GuideWindow.exposure_nframes] data_problem: - title: Science telemetry indicated a problem + title: Data Problem description: | - This is a flag to indicate that the science telemetry - experienced a problem. + A flag indicating an issue with science telemetry. type: boolean sdf: special_processing: VALUE_REQUIRED @@ -198,7 +183,10 @@ properties: datatype: nchar(1) destination: [ScienceCommon.exposure_data_problem, GuideWindow.exposure_data_problem] sca_number: - title: Sensor Chip Assembly number + title: SCA Number + description: | + The number of the detector on the Sensor Chip Assembly used for this + exposure. type: integer sdf: special_processing: VALUE_REQUIRED @@ -208,7 +196,7 @@ properties: datatype: int destination: [ScienceCommon.exposure_sca_number, GuideWindow.exposure_sca_number] gain_factor: - title: Gain scale factor + title: Gain Factor type: number sdf: special_processing: VALUE_REQUIRED @@ -218,8 +206,9 @@ properties: datatype: float destination: [ScienceCommon.exposure_gain_factor, GuideWindow.exposure_gain_factor] integration_time: - title: "[s] Effective integration time" - description: The effective time that the sensor has been exposed to the sky. + title: Effective Integration Time (s) + description: + The effective amount of time that the sensor was exposed to the sky. type: number sdf: special_processing: VALUE_REQUIRED @@ -229,10 +218,10 @@ properties: datatype: float destination: [ScienceCommon.exposure_integration_time, GuideWindow.exposure_integration_time] elapsed_exposure_time: - title: "[s] Total elapsed exposure time" + title: Elapsed Exposure Time (s) description: | - The time between the start of the first Reset/Read Science Frame of an Exposure - and the completion of the final Read Only Science Frame of that Exposure. + The amount of time elapsed between an exposure's first and last science + reads. type: number sdf: special_processing: VALUE_REQUIRED @@ -242,10 +231,10 @@ properties: datatype: float destination: [ScienceCommon.elapsed_exposure_time, GuideWindow.elapsed_exposure_time] frame_divisor: - title: Divisor applied to frame-averaged groups + title: Frame Divisor (s) description: | - This is the number of reads per resultant. Its use depends upon the definition - in the MA table. + The number of reads averaged to calculate a resultant. Value depends on + the readout pattern used from the MultiAccum table. type: integer sdf: special_processing: VALUE_REQUIRED @@ -256,7 +245,9 @@ properties: destination: [ScienceCommon.exposure_frame_divisor, GuideWindow.exposure_frame_divisor] groupgap: title: Number of frames dropped between groups - description: This is the number of reads that are "dropped" and not used in the resultant. + description: + The number of reads that are dropped, or not used to calculate a + resultant. type: integer sdf: special_processing: VALUE_REQUIRED @@ -266,10 +257,10 @@ properties: datatype: int destination: [ScienceCommon.exposure_groupgap, GuideWindow.exposure_groupgap] frame_time: - title: "[s] Time between frames" + title: Time Between Reads (s) description: | - The time between the end of one read and the start of the next read. This - depends on the MA table being used. + The amount of time elapsed between the end of one read and the beginning + of the next. type: number sdf: special_processing: VALUE_REQUIRED @@ -279,10 +270,10 @@ properties: datatype: float destination: [ScienceCommon.exposure_frame_time, GuideWindow.exposure_frame_time] group_time: - title: "[s] Time between groups" + title: Time Between Resultants (s) description: | - The time that is the sum of the reads that are used to construct a resultant. - This will depend on the MA table being used. + The time that is the sum of the reads that are used to construct a + resultant. This will depend on the MA table being used. type: number sdf: special_processing: VALUE_REQUIRED @@ -292,10 +283,11 @@ properties: datatype: float destination: [ScienceCommon.exposure_group_time, GuideWindow.exposure_group_time] exposure_time: - title: "[s] exposure time" + title: Exposure Time (s) description: | - The time between the start of the first Reset/Read Science Frame of an Exposure - and the completion of the final Read Only Science Frame of that Exposure. + The time between the start of the first Reset/Read Science Frame of an + Exposure and the completion of the final Read Only Science Frame of that + Exposure. type: number sdf: special_processing: VALUE_REQUIRED @@ -305,8 +297,10 @@ properties: datatype: float destination: [ScienceCommon.exposure_time, GuideWindow.exposure_time] effective_exposure_time: - title: "[s] Effective exposure time" - description: The time that the detector is collecting photons that are used in the resultants. + title: Effective Exposure Time (s) + description: | + The amount of time during which the detector actually collected photons + during an exposure. type: number sdf: special_processing: VALUE_REQUIRED @@ -316,10 +310,10 @@ properties: datatype: float destination: [ScienceCommon.effective_exposure_time, GuideWindow.effective_exposure_time] duration: - title: "[s] Total duration of exposure" + title: Exposure Duration (s) description: | - The time that the detector is dedicated to an exposure. This includes any overhead - and times for dropped frames etc. + The amount of time dedicated to a exposure, including any overhead, time + spent on dropped frames, and so on. type: number sdf: special_processing: VALUE_REQUIRED @@ -329,10 +323,10 @@ properties: datatype: float destination: [ScienceCommon.exposure_duration, GuideWindow.exposure_duration] ma_table_name: - title: Identifier for the multi-accumulation table used + title: MA Table Name description: | - The name of the MA table used for the exposure as defined by the - PRD (Project Reference Database) + The name of the MultiAccum table used for this exposure, as defined in the + Project Reference Database. type: string sdf: special_processing: VALUE_REQUIRED @@ -342,11 +336,10 @@ properties: datatype: nvarchar(50) destination: [ScienceCommon.ma_table_name, GuideWindow.ma_table_name] ma_table_number: - title: Numerical identifier for the multi-accumulation table used + title: MA Table Number description: | - The number of the MA table used for the exposure as defined by the - PRD (Project Reference Database). This is used for matching the exposure - to the appropriate calibration data. + The number of the MultiAccum table used for this exposure. Used in + matching exposures to their corresponding calibration data. type: integer sdf: special_processing: VALUE_REQUIRED @@ -356,10 +349,10 @@ properties: datatype: smallint destination: [ScienceCommon.ma_table_number, GuideWindow.ma_table_number] level0_compressed: - title: Level 0 data was compressed + title: Level 0 Compression description: | - A flag to indicate that the exposure has data that needed to be decompressed by - the ground system. + A flag indicating that the exposure has data that was decompressed by the + ground system. type: boolean sdf: special_processing: VALUE_REQUIRED @@ -369,10 +362,10 @@ properties: datatype: nchar(1) destination: [ScienceCommon.exposure_level0_compressed, GuideWindow.exposure_level0_compressed] read_pattern: - title: Pattern of reads + title: Read Pattern description: | - Enumeration of detector reads to resultants making up the L1 data downlinked - from the observatory + Enumeration of detector reads to resultants making up the L1 data + downlinked from the observatory. type: array items: type: array @@ -386,9 +379,9 @@ properties: datatype: nvarchar(3500) destination: [ScienceCommon.read_pattern, GuideWindow.read_pattern] truncated: - title: MA Tables were truncated + title: Truncated MA Table description: | - This is a flag to indicate that the the MA table was truncated. + A flag indicating whether the MA table was truncated. type: boolean sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/exposure_type-1.0.0.yaml b/src/rad/resources/schemas/exposure_type-1.0.0.yaml index 27516cdf..821040b5 100644 --- a/src/rad/resources/schemas/exposure_type-1.0.0.yaml +++ b/src/rad/resources/schemas/exposure_type-1.0.0.yaml @@ -4,9 +4,14 @@ $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 id: asdf://stsci.edu/datamodels/roman/schemas/exposure_type-1.0.0 # Helper file to enumerate viewing modes for exposure and ref_exposure +title: Exposure Type +description: | + The type of the WFI exposure. Imaging mode science observations have type + "WFI_IMAGE," while spectroscopic mode science observations may be either + "WFI_GRISM" or "WFI_PRISM" depending on the chosen optical element. Other + values are related to internal calibrations and engineering observations. type: string -title: Type of data in the exposure (viewing mode) enum: - WFI_IMAGE - WFI_GRISM diff --git a/src/rad/resources/schemas/guidestar-1.0.0.yaml b/src/rad/resources/schemas/guidestar-1.0.0.yaml index f683c312..ae625136 100644 --- a/src/rad/resources/schemas/guidestar-1.0.0.yaml +++ b/src/rad/resources/schemas/guidestar-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/guidestar-1.0.0 -title: Guide star window information +title: Guide Star Window Information type: object properties: gw_id: - title: guide star window identifier + title: Guide Star Window Identifier + description: | + Identification of the Guide Star Window. type: string sdf: special_processing: VALUE_REQUIRED @@ -26,8 +28,9 @@ properties: datatype: nvarchar(18) destination: [ScienceCommon.gw_fgs_mode, GuideWindow.gw_fgs_mode] gs_id: - title: guide star identifier from the GSC2 catalog - description: guide star catalog id from the GSC2, field gsc2ID + title: Guide Star Identifier from Guide Star Catalog + description: | + Identification of the guide star from the guide star catalog. type: string sdf: special_processing: VALUE_REQUIRED @@ -37,9 +40,9 @@ properties: datatype: nvarchar(20) destination: [ScienceCommon.gs_id, GuideWindow.gs_id] gs_catalog_version: - title: The version of the Guide Star Catalog - description: The version of the catalog that the guide stars are selected, currently "GSC 2.4.2", SDF should populate - this from the return value of CAT e.g. CAT=GSC242 + title: Version of the Guide Star Catalog + description: | + Version identifier of the guide star catalog used for the observation. type: string sdf: special_processing: VALUE_REQUIRED @@ -49,7 +52,10 @@ properties: datatype: nvarchar(20) destination: [ScienceCommon.gs_catalog_version] gs_ra: - title: "[deg] guide star right ascension" + title: Guide Star Right Ascension (deg) + description: | + Right ascension of the guide star from the guide star catalog in units of + degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -59,7 +65,10 @@ properties: datatype: float destination: [ScienceCommon.gs_ra, GuideWindow.gs_ra] gs_dec: - title: "[deg] guide star declination" + title: Guide Star Declination (deg) + description: | + Declination of the guide star from the guide star catalog in units of + degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -69,7 +78,10 @@ properties: datatype: float destination: [ScienceCommon.gs_dec, GuideWindow.gs_dec] gs_ura: - title: "[deg] guide star right ascension uncertainty" + title: Guide Star Right Ascension Uncertainty (deg) + description: | + Uncertainty in the guide star right ascension from the guide star catalog + in units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -79,7 +91,10 @@ properties: datatype: float destination: [ScienceCommon.gs_ura, GuideWindow.gs_ura] gs_udec: - title: "[deg] guide star declination uncertainty" + title: Guide Star Declination Uncertainty (deg) + description: | + Uncertainty in the guide star declination from the guide star catalog in + units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -89,7 +104,10 @@ properties: datatype: float destination: [ScienceCommon.gs_udec, GuideWindow.gs_udec] gs_mag: - title: guide star magnitude in detector + title: Guide Star Instrumental Magnitude + description: | + Predicted instrumental magnitude of the guide star from the guide star + catalog. type: number sdf: special_processing: VALUE_REQUIRED @@ -99,7 +117,10 @@ properties: datatype: float destination: [ScienceCommon.gs_mag, GuideWindow.gs_mag] gs_umag: - title: guide star magnitude uncertainty + title: Guide Star instrument Magnitude Uncertainty + description: | + Uncertainty in the predicted instrumental magnitude of the guide star from + the guide star catalog. type: number sdf: special_processing: VALUE_REQUIRED @@ -109,7 +130,10 @@ properties: datatype: float destination: [ScienceCommon.gs_umag, GuideWindow.gs_umag] data_start: - title: MJD start time of guider data within this file + title: Guide Data Start Time (MJD) + description: | + Start time of the guide window data taken for this exposure as a Modified + Julian Date. type: number sdf: special_processing: VALUE_REQUIRED @@ -119,7 +143,10 @@ properties: datatype: float destination: [ScienceCommon.data_start, GuideWindow.data_start] data_end: - title: MJD end time of guider data within this file + title: Guide Data End Time (MJD) + description: | + End time of the guide window data taken for this exposure as a Modified + Julian Date. type: number sdf: special_processing: VALUE_REQUIRED @@ -129,7 +156,10 @@ properties: datatype: float destination: [ScienceCommon.data_end, GuideWindow.data_end] gs_ctd_x: - title: "[arcsec] guide star centroid x position in guider ideal frame" + title: Guide Star Centroid X Position (arcsec) + description: | + Centroid of the guide star position longa the X axis of the guider ideal + frame measured in units of arcseconds. type: number sdf: special_processing: VALUE_REQUIRED @@ -139,7 +169,10 @@ properties: datatype: float destination: [ScienceCommon.gs_ctd_x, GuideWindow.gs_ctd_x] gs_ctd_y: - title: "[arcsec] guide star centroid y position in guider ideal frame" + title: Guide Star Centroid Y Position (arcsec) + description: | + Centroid of the guide star position along the Y axis of the guider ideal + frame measured in units of arcseconds. type: number sdf: special_processing: VALUE_REQUIRED @@ -149,7 +182,10 @@ properties: datatype: float destination: [ScienceCommon.gs_ctd_y, GuideWindow.gs_ctd_y] gs_ctd_ux: - title: uncertainty in the x position of the centroid + title: Guide Star Centroid X Position Uncertainty (arcsec) + description: | + Uncertainty in the centroid of the guide star position along the X axis of + the guider ideal frame measured in units of arcseconds type: number sdf: special_processing: VALUE_REQUIRED @@ -159,7 +195,10 @@ properties: datatype: float destination: [ScienceCommon.gs_ctd_ux, GuideWindow.gs_ctd_ux] gs_ctd_uy: - title: uncertainty in the y position of the centroid + title: Guide Star Centroid Y Position Uncertainty (arcsec) + description: | + Uncertainty in the centroid of the guide star position along the Y axis of + the guider ideal frame measured in units of arcseconds. type: number sdf: special_processing: VALUE_REQUIRED @@ -169,7 +208,9 @@ properties: datatype: float destination: [ScienceCommon.gs_ctd_uy, GuideWindow.gs_ctd_uy] gs_epoch: - title: Epoch of guide star coordinates + title: Guide Star Coordinates Epoch + description: | + Epoch of the celestial coordinates of the guide star. type: string sdf: special_processing: VALUE_REQUIRED @@ -179,7 +220,10 @@ properties: datatype: nvarchar(10) destination: [ScienceCommon.gs_epoch, GuideWindow.gs_epoch] gs_mura: - title: "[mas/yr] Guide star ICRS right ascension proper motion" + title: Proper Motion of the Guide Star Right Ascension (mas / yr) + description: | + Proper motion of the guide star in right ascension from the guide star + catalog measured in units of milli-arcseconds per year. type: number sdf: special_processing: VALUE_REQUIRED @@ -189,7 +233,10 @@ properties: datatype: float destination: [ScienceCommon.gs_mura, GuideWindow.gs_mura] gs_mudec: - title: "[mas/yr] Guide star ICRS declination proper motion" + title: Proper Motion of the Guide Star Declination (mas / yr) + description: | + Proper motion of the guide star in declination from the guide star catalog + measured in units of milli-arcseconds per year. type: number sdf: special_processing: VALUE_REQUIRED @@ -199,7 +246,9 @@ properties: datatype: float destination: [ScienceCommon.gs_mudec, GuideWindow.gs_mudec] gs_para: - title: Guide star annual parallax + title: Guide Star Annual Parallax + description: | + Annual parallax of the guide star from the guide star catalog. type: number sdf: special_processing: VALUE_REQUIRED @@ -209,10 +258,12 @@ properties: datatype: float destination: [ScienceCommon.gs_para, GuideWindow.gs_para] gs_pattern_error: - title: RMS of guide star position - description: RMS of guide star position in guide window from pattern matching (error on - centroid not explicitly calculated, the FACE information takes all the centroids and - calculates the error across the guiding pattern) + title: Guide Star Centroid RMS + description: | + RMS of the guide star position in the tracking guide windows from the Fine + Attitude Correction Estimate (FACE) information. The FACE information + determines the error across the guiding pattern using all centroid + measurements. type: number sdf: special_processing: VALUE_REQUIRED @@ -222,7 +273,10 @@ properties: datatype: float destination: [ScienceCommon.gs_pattern_error, GuideWindow.gs_pattern_error] gw_window_xstart: - title: Guide window x start position on the detector + title: Guide Window X Start Position (pixels) + description: | + Minimum X position in the science coordinate frame of all tracking guide + windows in this exposure measured in pixels. type: integer sdf: special_processing: VALUE_REQUIRED @@ -232,7 +286,10 @@ properties: datatype: int destination: [ScienceCommon.gw_window_xstart] gw_window_ystart: - title: Guide window y start position on the detector + title: Guide Window Y Start Position (pixels) + description: | + Minimum Y position in the science coordinate frame of all tracking guide + windows in this exposure measured in pixels. type: integer sdf: special_processing: VALUE_REQUIRED @@ -242,7 +299,10 @@ properties: datatype: int destination: [ScienceCommon.gw_window_ystart] gw_window_xstop: - title: Guide window x stop position on the detector + title: Guide Window X Stop Position (pixels) + description: | + Maximum X position in the science coordinate frame of all tracking guide + windows in this exposure measured in pixels. type: integer sdf: special_processing: VALUE_REQUIRED @@ -252,7 +312,10 @@ properties: datatype: int destination: [ScienceCommon.gw_window_xstop] gw_window_ystop: - title: Guide window y stop position on the detector + title: Guide Window Y Stop Position (pixels) + description: | + Maximum Y position in the science coordinate frame of all tracking guide + windows in this exposure measured in pixels type: integer sdf: special_processing: VALUE_REQUIRED @@ -262,7 +325,10 @@ properties: datatype: int destination: [ScienceCommon.gw_window_ystop] gw_window_xsize: - title: Guide window size in the x direction in detector coordinates + title: Guide Window Size in the X Direction (pixels) + description: | + Size of a single tracking guide window in this exposure measured along the + X axis in units of pixels. type: integer sdf: special_processing: VALUE_REQUIRED @@ -272,7 +338,10 @@ properties: datatype: int destination: [ScienceCommon.gw_window_xsize] gw_window_ysize: - title: Guide window size in the y direction in detector coordinates + title: Guide Window Size in the Y Direction (pixels) + description: | + Size of a single tracking guide window in this exposure measured along the + Y axis in units of pixels. type: integer sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/guidewindow-1.0.0.yaml b/src/rad/resources/schemas/guidewindow-1.0.0.yaml index 3251710a..e14f5fd7 100644 --- a/src/rad/resources/schemas/guidewindow-1.0.0.yaml +++ b/src/rad/resources/schemas/guidewindow-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/guidewindow-1.0.0 -title: Guide window information +title: Guide Star Window Information datamodel_name: GuidewindowModel @@ -17,7 +17,9 @@ properties: - type: object properties: gw_start_time: - title: UTC time at the start of the guide window exposure + title: Start Time of Guide Window Exposure (UTC) + description: | + Time in UTC at the start of the guide window exposure. tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED @@ -27,7 +29,9 @@ properties: datatype: datetime2 destination: [GuideWindow.gw_start_time] gw_end_time: - title: UTC time at the end of the guide window exposure + title: End Time of Guide Window Exposure (UTC) + description: | + Time in UTC at the end of the guide window exposure. tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED @@ -37,7 +41,9 @@ properties: datatype: datetime2 destination: [GuideWindow.gw_end_time] gw_frame_readout_time: - title: The readout time for the guide window frame + title: Guide Window Read Time (Seconds) + description: | + Time to read out the guide window frame in units of seconds. type: number sdf: special_processing: VALUE_REQUIRED @@ -47,7 +53,9 @@ properties: datatype: float destination: [GuideWindow.gw_frame_readout_time] gw_function_start_time: - title: Observatory UTC time at guider function start + title: Guide Window Function Start Time (UTC) + description: | + Time in UTC at the start of the guider function. tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED @@ -57,7 +65,9 @@ properties: datatype: datetime2 destination: [GuideWindow.gw_function_start_time] gw_function_end_time: - title: Observatory UTC time at guider function end + title: Guide Window Function End Time (UTC) + description: | + Time in UTC at the end of the guider function. tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED @@ -67,7 +77,9 @@ properties: datatype: datetime2 destination: [GuideWindow.gw_function_end_time] gw_acq_exec_stat: - title: Guide star window acquisition status + title: Guide Star Acquisition Status + description: | + Status of the guide star acquisition. type: string sdf: special_processing: VALUE_REQUIRED @@ -77,10 +89,10 @@ properties: datatype: nvarchar(15) destination: [GuideWindow.gw_acq_exec_stat] pedestal_resultant_exp_time: - title: Total exposure time for the guide window pedestal frames + title: Guide Window Pedestal Exposure Time (Seconds) description: | - The cumulative exposure time for all the guide window - pedestal frames + Cumulative exposure time for all of the guide window pedestal + resultants in units of seconds. type: number sdf: special_processing: VALUE_REQUIRED @@ -90,10 +102,10 @@ properties: datatype: float destination: [GuideWindow.gw_pedestal_resultant_exp_time] signal_resultant_exp_time: - title: Total exposure time for the guide window resultant frames + title: Guide Window Signal Exposure Time (Seconds) description: | - The cumulative exposure time for all the guide window - resultant frames + Cumulative exposure time for all of the guide window signal + resultants in units of seconds type: number sdf: special_processing: VALUE_REQUIRED @@ -103,10 +115,10 @@ properties: datatype: float destination: [GuideWindow.gw_signal_resultant_exp_time] gw_acq_number: - title: Guide Window ID "Q" + title: Guide Star Acquisition Identifier description: | - A single digit representing the guide star acquisition - number within the visit + Identifier representing the guide star acquisition number within + the visit. type: integer sdf: special_processing: VALUE_REQUIRED @@ -116,10 +128,11 @@ properties: datatype: int destination: [GuideWindow.gw_acq_number] gw_science_file_source: - title: The science data associated with this guide window + title: Science File Name description: | - The science data file that is associated with this guide window, - e.g. "r0000101001001001001_01101_0001_WFI01_uncal.asdf" + Name of the file containing the WFI science exposure + corresponding to the guide window data contained within this + file. type: string sdf: special_processing: VALUE_REQUIRED @@ -138,7 +151,10 @@ properties: datatype: nvarchar(18) destination: [GuideWindow.gw_mode] gw_window_xstart: - title: Guide window x start position on the detector + title: Guide Window X Start Position (pixels) + description: | + Minimum X position in the science coordinate frame of all tracking + guide windows in this exposure measured in pixels. type: integer sdf: special_processing: VALUE_REQUIRED @@ -148,7 +164,10 @@ properties: datatype: int destination: [GuideWindow.gw_window_xstart] gw_window_ystart: - title: Guide window y start position on the detector + title: Guide Window Y Start Position (pixels) + description: | + Minimum Y position in the science coordinate frame of all tracking + guide windows in this exposure measured in pixels. type: integer sdf: special_processing: VALUE_REQUIRED @@ -158,7 +177,10 @@ properties: datatype: int destination: [GuideWindow.gw_window_ystart] gw_window_xstop: - title: Guide window x stop position on the detector + title: Guide Window X Stop Position (pixels) + description: | + Maximum X position in the science coordinate frame of all tracking + guide windows in this exposure measured in pixels. type: integer sdf: special_processing: VALUE_REQUIRED @@ -168,7 +190,10 @@ properties: datatype: int destination: [GuideWindow.gw_window_xstop] gw_window_ystop: - title: Guide window y stop position on the detector + title: Guide Window Y Stop Position (pixels) + description: | + Maximum Y position in the science coordinate frame of all tracking + guide windows in this exposure measured in pixels. type: integer sdf: special_processing: VALUE_REQUIRED @@ -205,9 +230,13 @@ properties: gw_window_xstop, gw_window_ystop, gw_window_xsize, gw_window_ysize, gw_science_file_source] pedestal_frames: - title: "Reconstituted and oriented pedestal frame GW images. - Dimensions: num_frames, num_combined_resultants - (or num_uncombined_resultants), num_reads, x, y" + title: Guide Window Pedestal Resultant Array (DN) + description: | + Array containing the guide window pedestal resultants in units of DN. The + array has dimensions of (J, H, K, X, Y) where J is the number of science + resultants, H is the number of reads of the detector in a given science + resultant, K is the number of guide window reads in a science read, and X + and Y are the pixel locations. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -219,9 +248,13 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN"] signal_frames: - title: "Reconstituted and oriented signal frames. Dimensions: num_frames, - num_combined_resultants (or num_uncombined_resultants), - num_reads, x, y" + title: Guide Window Signal Resultant Array (DN) + description: | + Array containing the guide window signal resultants in units of DN. The + array has dimensions of (J, H, K, X, Y) where J is the number of science + resultants, H is the number of reads of the detector in a given science + resultant, K is the number of guide window reads in a science read, and X + and Y are the pixel locations. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -233,9 +266,13 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN"] amp33: - title: "Amp 33 reference pixel data. Dimensions: num_frames, - num_combined_resultants (or num_uncombined_resultants), - num_reads, x, y" + title: Guide Window Amplifier 33 Reference Pixel Resultant Array (DN) + description: | + Array containing the amplifier 33 reference pixel resultants in units of + DN. The array has dimensions of (J, H, K, X, Y) where J is the number of + science resultants, H is the number of reads of the detector in a given + science resultant, K is the number of guide window reads in a science + read, and X and Y are the pixel locations. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: diff --git a/src/rad/resources/schemas/guidewindow_modes-1.0.0.yaml b/src/rad/resources/schemas/guidewindow_modes-1.0.0.yaml index 97d89e39..37785cdc 100644 --- a/src/rad/resources/schemas/guidewindow_modes-1.0.0.yaml +++ b/src/rad/resources/schemas/guidewindow_modes-1.0.0.yaml @@ -5,7 +5,9 @@ id: asdf://stsci.edu/datamodels/roman/schemas/guidewindow_modes-1.0.0 # Helper file to enumerate guide window modes for guidestar and guidewindow -title: Guide window modes +title: Guide Window Modes +description: | + An enumerated collection of available guidestar and guidewindow modes. type: string enum: - WIM-ACQ diff --git a/src/rad/resources/schemas/msos_stack-1.0.0.yaml b/src/rad/resources/schemas/msos_stack-1.0.0.yaml index 08609ca3..bf61bd15 100644 --- a/src/rad/resources/schemas/msos_stack-1.0.0.yaml +++ b/src/rad/resources/schemas/msos_stack-1.0.0.yaml @@ -16,28 +16,36 @@ properties: - image_list: type: string data: - title: Flux data + title: Flux Data + description: | + Flux array of stacked image data. value: tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: float64 exact_datatype: true ndim: 2 uncertainty: - title: uncertainty data + title: Uncertainty Data + description: | + Uncertainty array of stacked image data. value: tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: float64 exact_datatype: true ndim: 2 mask: - title: mask data + title: Mask Data + description: | + Mask array of stacked image data. value: tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint8 exact_datatype: true ndim: 2 coverage: - title: coverage data + title: Coverage Data + description: | + Coverage array of stacked image data. value: tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint8 diff --git a/src/rad/resources/schemas/observation-1.0.0.yaml b/src/rad/resources/schemas/observation-1.0.0.yaml index c30c4274..ff58c95e 100644 --- a/src/rad/resources/schemas/observation-1.0.0.yaml +++ b/src/rad/resources/schemas/observation-1.0.0.yaml @@ -3,17 +3,20 @@ $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 id: asdf://stsci.edu/datamodels/roman/schemas/observation-1.0.0 -title: Observation identifiers +title: Observation Identifiers type: object properties: obs_id: - title: Programmatic observation identifier. The format is 'PPPPPCCAAASSSOOOVVVggsaaeeee' where - 'PPPPP' is the Program, 'CC' is the execution plan, 'AAA' is the pass, 'SSS' is the - segment, 'OOO' is the Observation, 'VVV' is the Visit, 'gg' is the visit file group, - 's' is the visit file sequence, 'aa' is the visit file activity, and 'eeee' is the - exposure ID. The observation ID is the complete concatenation of visit_id + - visit_file_statement (visit_file_group + visit_file_sequence + visit_file_activity) + - exposure. + title: Programmatic Observation Identifier + description: | + The format of the programmatic observation identifier is + 'PPPPPCCAAASSSOOOVVVggsaaeeee' where 'PPPPP' is the program, 'CC' is the + execution plan, 'AAA' is the pass, 'SSS' is the segment number, 'OOO' is + the observation, 'VVV' is the visit, 'gg' is the visit file group, 's' is + the visit file sequence, 'aa' is the visit file activity, and 'eeee' is + the exposure ID. The observation ID is the complete concatenation of + visit_id + visit_file_statement (visit_file_group + visit_file_sequence + + visit_file_activity) + exposure. type: string sdf: special_processing: VALUE_REQUIRED @@ -23,9 +26,12 @@ properties: datatype: nvarchar(28) destination: [ScienceCommon.obs_id, GuideWindow.obs_id] visit_id: - title: A unique identifier for a visit. The format is 'PPPPPCCAAASSSOOOVVV' where 'PPPPP' is the - Program, 'CC' is the execution plan, 'AAA' is the pass, 'SSS' is the segment number, - 'OOO' is the Observation and 'VVV' is the Visit. + title: Visit Identifier + description: | + A unique identifier for a visit. The format is 'PPPPPCCAAASSSOOOVVV' where + 'PPPPP' is the program, 'CC' is the execution plan, 'AAA' is the pass, + 'SSS' is the segment number, 'OOO' is the observation and 'VVV' is the + visit. type: string sdf: special_processing: VALUE_REQUIRED @@ -35,7 +41,10 @@ properties: datatype: nvarchar(19) destination: [ScienceCommon.visit_id, GuideWindow.visit_id] program: - title: Program number, defined range is 1..18445; included in obs_id and visit_id as 'PPPPP'. + title: Program Number + description: | + The defined range of the program number is 00001 to 18445; included in + obs_id and visit_id as 'PPPPP'. type: string sdf: special_processing: VALUE_REQUIRED @@ -45,8 +54,10 @@ properties: datatype: int destination: [ScienceCommon.program, GuideWindow.program] execution_plan: - title: Execution plan within the program, defined range is 1..99; included in obs_id and - visit_id as 'CC'. + title: Execution Plan + description: | + The defined range of the execution plan within the program is 01 to 99; + included in obs_id and visit_id as 'CC'. type: integer sdf: special_processing: VALUE_REQUIRED @@ -56,8 +67,10 @@ properties: datatype: smallint destination: [ScienceCommon.execution_plan, GuideWindow.execution_plan] pass: - title: Pass number within execution plan, defined range is 1..999; included in obs_id and - visit_id as 'AA'. + title: Pass Number + description: | + The defined range of the pass number within the execution plan is 001 to + 999; included in obs_id and visit_id as 'AAA'. type: integer sdf: special_processing: VALUE_REQUIRED @@ -67,8 +80,10 @@ properties: datatype: smallint destination: [ScienceCommon.pass, GuideWindow.pass] segment: - title: Segment Number within pass, defined range is 1..999; included in obs_id and visit_id as - 'SSS'. + title: Segment Number + description: | + The defined range of the segment number within the pass is 001 to 999; + included in obs_id and visit_id as 'SSS'. type: integer sdf: special_processing: VALUE_REQUIRED @@ -78,8 +93,10 @@ properties: datatype: smallint destination: [ScienceCommon.segment, GuideWindow.segment] observation: - title: Observation number within the segment, defined range is 1..999; included in obs_id and - visit_id as 'OOO'. + title: Observation Number + description: | + The defined range of the observation number within the segment is 001 to + 999; included in obs_id and visit_id as 'OOO'. type: integer sdf: special_processing: VALUE_REQUIRED @@ -89,8 +106,10 @@ properties: datatype: smallint destination: [ScienceCommon.observation, GuideWindow.observation] visit: - title: Visit number within the observation, defined range of values is 1..999; included in - obs_id and visit_id as 'VVV'. + title: Visit Number + description: | + The defined range of the visit number within the observation is 001 to + 999; included in obs_id and visit_id as 'VVV'. type: integer sdf: special_processing: VALUE_REQUIRED @@ -100,8 +119,10 @@ properties: datatype: smallint destination: [ScienceCommon.visit, GuideWindow.visit] visit_file_group: - title: Sequence group within the visit file, defined range of values is 1..99; included in - obs_id as 'gg'. + title: Visit File Group + description: | + The visit file group describes the sequence group within the visit file + and has a defined range of 01 to 99; included in obs_id as 'gg'. type: integer sdf: special_processing: VALUE_REQUIRED @@ -111,8 +132,10 @@ properties: datatype: smallint destination: [ScienceCommon.visit_file_group, GuideWindow.visit_file_group] visit_file_sequence: - title: Visit file sequence within the group, defined range of values is 1..5; included in - obs_id as 's'. + title: Visit File Sequence + description: | + The defined range of the visit file sequence within the group 1 to 5; + included in obs_id as 's'. type: integer sdf: special_processing: VALUE_REQUIRED @@ -122,8 +145,10 @@ properties: datatype: tinyint destination: [ScienceCommon.visit_file_sequence, GuideWindow.visit_file_sequence] visit_file_activity: - title: Visit file activity within the sequence, defined range of values is 1..ZZ; included in - obs_id as 'aa'. + title: Visit File Activity + description: | + The defined range of the visit file activity within the sequence is 01 to + ZZ; included in obs_id as 'aa'. type: string sdf: special_processing: VALUE_REQUIRED @@ -133,8 +158,10 @@ properties: datatype: nvarchar(2) destination: [ScienceCommon.visit_file_activity, GuideWindow.visit_file_activity] exposure: - title: Exposure within the visit, defined range of values is 1..9999; included in obs_id as - 'eeee'. + title: Exposure Number + description: | + The defined range of the assigned exposure number within the visit is 0001 + to 9999; included in obs_id as 'eeee'. type: integer sdf: special_processing: VALUE_REQUIRED @@ -144,7 +171,9 @@ properties: datatype: int destination: [ScienceCommon.observation_exposure, GuideWindow.observation_exposure] template: - title: Observation template used + title: Observation Template + description: | + The template used to design this observation. type: string sdf: special_processing: VALUE_REQUIRED @@ -154,7 +183,9 @@ properties: datatype: nvarchar(50) destination: [ScienceCommon.template, GuideWindow.template] observation_label: - title: Proposer label for the observation + title: Observation Label + description: | + The label given by the proposer to describe the observation. type: string sdf: special_processing: VALUE_REQUIRED @@ -165,6 +196,11 @@ properties: destination: [ScienceCommon.observation_label, GuideWindow.observation_label] survey: title: Observation Survey + description: | + The available survey options for observations are: HLS = High Latitude + Wide Area Survey, EMS = Galactic Bulge Time Domain Survey, SN = High + Latitude Time Domain Survey, N/A = General Astrophysics Surveys or other + survey not otherwise defined here. type: string enum: [HLS, EMS, SN, N/A] archive_catalog: diff --git a/src/rad/resources/schemas/photometry-1.0.0.yaml b/src/rad/resources/schemas/photometry-1.0.0.yaml index 2b321128..afaf537e 100644 --- a/src/rad/resources/schemas/photometry-1.0.0.yaml +++ b/src/rad/resources/schemas/photometry-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/photometry-1.0.0 -title: Photometry information +title: Photometry Information type: object properties: conversion_megajanskys: - title: Flux density (MJy/steradian) producing 1 cps + title: Flux Density Producing 1 count per second (MJy / steradian) + description: | + The conversion from DN / s to MJy / steradian. anyOf: - tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: @@ -21,7 +23,9 @@ properties: datatype: float destination: [ScienceCommon.conversion_megajanskys] conversion_microjanskys: - title: Flux density (uJy/arcsec2) producing 1 cps + title: Flux Density Producing 1 count per second (uJy / arcsec2) + description: | + The conversion from DN / s to uJy / steradian. anyOf: - tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: @@ -35,7 +39,9 @@ properties: datatype: float destination: [ScienceCommon.conversion_microjanskys] pixelarea_steradians: - title: Nominal pixel area in steradians + title: Nominal Pixel Area (steradians) + description: | + The average pixel area in units of steradians. anyOf: - tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: @@ -49,7 +55,9 @@ properties: datatype: float destination: [ScienceCommon.pixelarea_steradians] pixelarea_arcsecsq: - title: Nominal pixel area in arcsec^2 + title: Nominal Pixel Area (arcsec^2) + description: | + The average pixel area in units of square arcseconds. anyOf: - tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: @@ -63,7 +71,10 @@ properties: datatype: float destination: [ScienceCommon.pixelarea_arcsecsq] conversion_megajanskys_uncertainty: - title: Uncertainty in flux density conversion to MJy/steradians + title: Uncertainty in Flux Density Conversion (from DN / s to MJy / steradians) + description: | + The uncertainty in the flux density conversion from DN to MJy /steradians + in units of MJy / steradians. anyOf: - tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: @@ -77,7 +88,10 @@ properties: datatype: float destination: [ScienceCommon.conversion_megajanskys_uncertainty] conversion_microjanskys_uncertainty: - title: Uncertainty in flux density conversion to uJy/arcsec2 + title: Uncertainty in Flux Density Conversion (from DN / s to uJy / arcsec^2) + description: | + The uncertainty in the flux density conversion from DN / s to + uJy /arcsec^2. anyOf: - tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: diff --git a/src/rad/resources/schemas/pointing-1.0.0.yaml b/src/rad/resources/schemas/pointing-1.0.0.yaml index 33585af5..467cfc55 100644 --- a/src/rad/resources/schemas/pointing-1.0.0.yaml +++ b/src/rad/resources/schemas/pointing-1.0.0.yaml @@ -3,11 +3,15 @@ $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 id: asdf://stsci.edu/datamodels/roman/schemas/pointing-1.0.0 -title: Spacecraft pointing information +title: Spacecraft Pointing Information type: object properties: ra_v1: - title: "[deg] RA of telescope V1 axis" + title: RA of Telescope V1 Axis (deg) + description: | + The right ascension (RA) coordinate, in degrees, of the V1 Axis that is + used along with dec_v1 and pa_v3 to describe where the telescope is + pointing. type: number sdf: special_processing: VALUE_REQUIRED @@ -17,7 +21,10 @@ properties: datatype: float destination: [ScienceCommon.ra_v1, GuideWindow.ra_v1] dec_v1: - title: "[deg] Dec of telescope V1 axis" + title: Dec of Telescope V1 Axis (deg) + description: | + The declination (Dec) coordinate, in degrees, of the V1 Axis that is used + along with ra_v1 and pa_v3 to describe where the telescope is pointing. type: number sdf: special_processing: VALUE_REQUIRED @@ -27,7 +34,10 @@ properties: datatype: float destination: [ScienceCommon.dec_v1, GuideWindow.dec_v1] pa_v3: - title: "[deg] Position angle of telescope V3 axis" + title: Position Angle of Telescope V3 Axis (deg) + description: | + The position angle (PA), in degrees, of the V3 Axis that is used along + with ra_v1 and dec_v1 to describe where the telescope is pointing. type: number sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/program-1.0.0.yaml b/src/rad/resources/schemas/program-1.0.0.yaml index c4144151..55025a8e 100644 --- a/src/rad/resources/schemas/program-1.0.0.yaml +++ b/src/rad/resources/schemas/program-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/program-1.0.0 -title: Program information +title: Program Information type: object properties: title: - title: Proposal title + title: Proposal Title + description: | + The submitted proposal title of the program. type: string sdf: special_processing: VALUE_REQUIRED @@ -17,7 +19,9 @@ properties: datatype: nvarchar(200) destination: [ScienceCommon.program_title, GuideWindow.program_title] pi_name: - title: Principle Investigator name + title: Principal Investigator Name + description: | + The name of the Principal Investigator (PI) of the program. type: string sdf: special_processing: VALUE_REQUIRED @@ -29,7 +33,9 @@ properties: datatype: nvarchar(100) destination: [ScienceCommon.pi_name, GuideWindow.pi_name] category: - title: Program category + title: Program Category + description: | + The category of the program. type: string sdf: special_processing: VALUE_REQUIRED @@ -39,7 +45,9 @@ properties: datatype: nvarchar(6) destination: [ScienceCommon.program_category, GuideWindow.program_category] subcategory: - title: Program subcategory + title: Program Subcategory + description: | + The subcategory of the program. type: string sdf: special_processing: VALUE_REQUIRED @@ -49,7 +57,10 @@ properties: datatype: nvarchar(15) destination: [ScienceCommon.program_subcategory, GuideWindow.program_subcategory] science_category: - title: Science category assigned during TAC process + title: Science Category + description: | + The science category assigned during the Telescope Allocation Committee + (TAC) process. type: string sdf: special_processing: VALUE_REQUIRED @@ -59,7 +70,10 @@ properties: datatype: nvarchar(50) destination: [ScienceCommon.science_category, GuideWindow.science_category] continuation_id: - title: Continuation of previous Program + title: Continuation ID + description: | + The identifier that marks the program as a continuation of a previous + program. type: integer sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/rad_schema-1.0.0.yaml b/src/rad/resources/schemas/rad_schema-1.0.0.yaml index cb6f0ff4..c713b7d9 100644 --- a/src/rad/resources/schemas/rad_schema-1.0.0.yaml +++ b/src/rad/resources/schemas/rad_schema-1.0.0.yaml @@ -3,46 +3,48 @@ $schema: http://stsci.edu/schemas/yaml-schema/draft-01 id: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 -title: Roman Attribute Dictionary metaschema -description: |- - A metaschema extending the ASDF metaschema to add support for - sdf and archive_catalog properties. +title: RAD Metaschema +description: | + A metaschema that extends the ASDF metaschema to add support for Scientific + Data Format and archive catalog-related properties. allOf: - $ref: http://stsci.edu/schemas/asdf/asdf-schema-1.0.0 - type: object properties: datamodel_name: + title: Datamodel Name description: |- - The name of the datamodel that this schema describes. + Name of the datamodel described by this schema type: string - archive_meta: + title: Archive Metadata description: |- - Metadata to aide the archive in determining how to handle - a given file. + Metadata that aids the archive in identifying ASDF files. type: string - sdf: + title: Scientific Data Format description: |- - Documents source of this attribute's value when level 1 - files are created. + Information on this attribute's value upon creation of Level 1 files. type: object properties: special_processing: + title: Special Processing description: |- - Indicates whether attribute is required to be present - in the ASDF file or optional. + A flag indicating whether this attribute is must be present in the + SDF file. type: string enum: [VALUE_REQUIRED, OPTIONAL] source: type: object properties: origin: + title: Origin description: |- Source of the attribute value. type: string function: + title: Function description: |- Optional function that transforms the source value. type: string @@ -50,22 +52,25 @@ allOf: required: [special_processing, source] archive_catalog: + title: Archive Catalog description: |- - Documents destination table/column and datatype of this attribute - in the archive catalog. + Information on this attribute's data type and destination table and + column in the archive catalog. type: object properties: datatype: + title: Archive catalog database column type description: |- - Archive catalog database column type. + Column type in the archive catalog database. anyOf: - type: string enum: [datetime2, float, int, nchar(1), nvarchar(max), bigint, smallint, tinyint] - type: string pattern: "^nvarchar\\([0-9]+\\)$" destination: + title: Destination description: |- - Archive catalog database table and column. + Table and column in the archive catalog database type: array items: type: string diff --git a/src/rad/resources/schemas/ramp-1.0.0.yaml b/src/rad/resources/schemas/ramp-1.0.0.yaml index 9c8d2c07..b54aad3e 100644 --- a/src/rad/resources/schemas/ramp-1.0.0.yaml +++ b/src/rad/resources/schemas/ramp-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/ramp-1.0.0 -title: Ramp schema +title: Ramp Schema datamodel_name: RampModel @@ -12,7 +12,9 @@ properties: meta: $ref: common-1.0.0 data: - title: Science data, including the border reference pixels. + title: Science Data Including Border Reference Pixels + description: | + Science Data Including Border Reference Pixels. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -24,19 +26,24 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN", "electron"] pixeldq: - title: 2-D data quality array for all planes + title: Two Dimensional Data Quality Flags Array for Each Resultant + description: | + Two Dimensional Data Quality Flags Array for Each Resultant. tag: tag:stsci.edu:asdf/core/ndarray-1.* ndim: 2 datatype: uint32 exact_datatype: true groupdq: - title: 3-D data quality array (plane dq for each group) + title: Three dimensional Data Quality array developed for all uneven resultants in the ramp + description: | + Three dimensional Data Quality array developed for all uneven resultants + in the ramp. tag: tag:stsci.edu:asdf/core/ndarray-1.* ndim: 3 datatype: uint8 exact_datatype: true err: - title: Error array containing the square root of the exposure-level combined variance + title: Error Array Containing the Square Root of the Exposure-level Combined Variance (DN, electrons) tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -48,7 +55,9 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN", "electron"] amp33: - title: Amp 33 reference pixel data + title: Amp 33 Reference Pixel Data + description: | + Amplifier 33 Reference Pixel Data. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -60,7 +69,10 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN"] border_ref_pix_left: - title: Original border reference pixels, on left (from viewers perspective). + title: Border Reference Pixels on the Left of the Detector, from the instrument's perspective + description: | + Border Reference Pixels on the Left of the Detector, from the instrument's + perspective. tag: tag:stsci.edu:asdf/unit/quantity-1.* value: tag: tag:stsci.edu:asdf/core/ndarray-1.* @@ -71,7 +83,10 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN"] border_ref_pix_right: - title: Original border reference pixels, on right (from viewers perspective). + title: Border Reference Pixels on the Right of the Detector, from the instrument's perspective + description: | + Border Reference Pixels on the Right of the Detector, from the + instrument's perspective. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -83,7 +98,9 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN"] border_ref_pix_top: - title: Original border reference pixels, on top. + title: Border Reference Pixels on the Top of the Detector + description: | + Border Reference Pixels on the Top of the Detector. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -95,7 +112,9 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN"] border_ref_pix_bottom: - title: Original border reference pixels, on bottom. + title: Border Reference Pixels on the Bottom of the Detector + description: | + Border Reference Pixels on the Bottom of the Detector. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -107,25 +126,35 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN"] dq_border_ref_pix_left: - title: DQ for border reference pixels, on left (from viewers perspective). + title: Data Quality Flag for Border Reference Pixels, on the Left Edge of the Detector from the Instrument Perspective + description: | + Data Quality Flag for Border Reference Pixels, on the Left Edge of the + Detector from the Instrument Perspective. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true ndim: 2 dq_border_ref_pix_right: - title: DQ for border reference pixels, on right (from viewers perspective). + title: Data Quality Flag for Border Reference Pixels, on the Right edge of the Detector from the Instrument Perspective + description: | + Data Quality Flag for Border Reference Pixels, on the Right Edge of the + Detector from the Instrument Perspective. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true ndim: 2 dq_border_ref_pix_top: - title: DQ for border reference pixels, on top. + title: Data Quality Flag for Border Reference Pixels, on Top. + description: | + Data Quality Flag for Border Reference Pixels, on Top. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true ndim: 2 dq_border_ref_pix_bottom: - title: DQ for border reference pixels, on bottom. + title: Data Quality Flag for Border Reference Pixels, on Bottom. + description: | + Data Quality Flag for Border Reference Pixels, on Bottom. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true diff --git a/src/rad/resources/schemas/ramp_fit_output-1.0.0.yaml b/src/rad/resources/schemas/ramp_fit_output-1.0.0.yaml index 8cd0a0d6..7a597f32 100644 --- a/src/rad/resources/schemas/ramp_fit_output-1.0.0.yaml +++ b/src/rad/resources/schemas/ramp_fit_output-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/ramp_fit_output-1.0.0 -title: Ramp fit output schema +title: Ramp Fit Output Schema datamodel_name: RampFitOutputModel @@ -12,7 +12,11 @@ properties: meta: $ref: common-1.0.0 slope: - title: Segment-specific slope + title: Slope for specific Segment (electrons / s) + description: | + Slope of a specific segment for a ramp with uneven resultants, in units of + electrons per second. A segment is a set of contiguous resultants where + none of the resultants are saturated or cosmic ray-affected. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -24,7 +28,12 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["electron / s"] sigslope: - title: Sigma for segment-specific slope + title: Uncertainty on Slope for Specific Segment (electrons / s) + description: | + Uncertainty on slope for specific segment for a ramp with uneven + resultants in units of electrons per second. A segment is a set of + contiguous resultants where none of the resultants are saturated or cosmic + ray-affected. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -36,7 +45,11 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["electron / s"] yint: - title: Segment-specific y-intercept + title: Y-intercept Derived for a Specific Segment (electrons) + description: | + Y-intercept derived for a specific segment (electrons). A segment is a set + of contiguous resultants where none of the resultants are saturated or + cosmic ray-affected. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -48,7 +61,11 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["electron"] sigyint: - title: Sigma for segment-specific y-intercept + title: Uncertainty on Y-intercept Derived for a Specific Segment (electrons) + description: | + Uncertainty on Y-intercept derived for a specific segment (electrons). A + segment is a set of contiguous resultants where none of the resultants are + saturated or cosmic ray-affected. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -60,7 +77,9 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["electron"] pedestal: - title: Pedestal array + title: Pedestal Array (electrons) + description: | + Signal at zero exposure time for each pixel in electrons. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -72,13 +91,15 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["electron"] weights: - title: Weights for segment-specific fits + title: Weights for Segment Specific Fit tag: tag:stsci.edu:asdf/core/ndarray-1.* ndim: 3 datatype: float32 exact_datatype: true crmag: - title: Approximate CR magnitudes + title: Approximate Cosmic Ray Magnitudes (AB magnitude) + description: | + The magnitude of each segment that was flagged as having a cosmic ray hit. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -90,7 +111,10 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["electron"] var_poisson: - title: Variance due to poisson noise for segment-specific slope + title: Poisson Variance associated with a segment-specific slope (electrons^2 / sec^2) + description: | + Poisson variance associated with a segment-specific slope, in units of + electrons^2 / sec^2. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -102,7 +126,10 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["electron2 / s2"] var_rnoise: - title: Variance due to read noise for segment-specific slope + title: Read Noise Associated Variance for a Segment Specific Slope (electrons^2 / sec^2) + description: | + Read noise-associated variance for a segment-specific slope, in units of + electrons^2 / sec^2. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: diff --git a/src/rad/resources/schemas/ref_file-1.0.0.yaml b/src/rad/resources/schemas/ref_file-1.0.0.yaml index 4b7fc9c9..ae494990 100644 --- a/src/rad/resources/schemas/ref_file-1.0.0.yaml +++ b/src/rad/resources/schemas/ref_file-1.0.0.yaml @@ -3,17 +3,19 @@ $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 id: asdf://stsci.edu/datamodels/roman/schemas/ref_file-1.0.0 -title: Reference file information - - +title: Reference File Information type: object properties: crds: - title: CRDS parameters + title: Calibration Reference Data System Parameters + description: | + Calibration Reference Data System Parameters type: object properties: sw_version: - title: Version of CRDS file selection software used + title: CRDS File Version + description: | + Version of Calibration Reference Data System (CRDS) file selection software. type: string sdf: special_processing: VALUE_REQUIRED @@ -22,9 +24,10 @@ properties: archive_catalog: datatype: nvarchar(120) destination: [ScienceCommon.crds_software_version, GuideWindow.crds_software_version] - context_used: - title: CRDS context (.pmap) used to select ref files + title: CRDS Context + description: | + CRDS context (.pmap) used to select ref files. type: string sdf: special_processing: VALUE_REQUIRED @@ -34,61 +37,86 @@ properties: datatype: nvarchar(120) destination: [ScienceCommon.crds_context_used, GuideWindow.crds_context_used] dark: - title: Dark reference file information + title: Dark Reference File Information + description: | + Reference file to be used to correct for the dark current contribution to + science data. type: string archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_dark, GuideWindow.r_dark] distortion: - title: Distortion reference file information + title: Distortion Reference File Information + description: | + Information about the distortion reference file used with the science + data. type: string archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_distortion, GuideWindow.r_distortion] mask: - title: Mask reference file information + title: Mask Reference file Information + description: | + Information about the mask reference file used with the science data. type: string archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_mask, GuideWindow.r_mask] flat: - title: Flat reference file information + title: Flat Reference File Information + description: | + Information about the flat reference file used with the science data. type: string archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_flat, GuideWindow.r_flat] gain: - title: Gain reference file information + title: Gain Reference Rile Information + description: | + Information about the gain reference file used with the science data. type: string archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_gain, GuideWindow.r_gain] readnoise: - title: Read noise reference file information + title: Read Noise Reference Rile Information + description: | + Information about the read noise reference file used with the science + data. type: string archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_readnoise, GuideWindow.r_readnoise] linearity: - title: Linearity reference file information + title: Linearity Reference File Information + description: | + Information about the linearity reference file used with the science data. type: string archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_linearity, GuideWindow.r_linearity] photom: - title: Photometry reference file information + title: Photometry Reference File Information + description: | + Information about the photometry reference file used with the science + data. type: string archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_photom, GuideWindow.r_photom] area: - title: Area reference file information + title: Area Reference File Information + description: | + Information about the area reference file used with the science data. type: string archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_area, GuideWindow.r_area] saturation: - title: Saturation reference file information + title: Saturation Reference File Information + description: | + Information about the saturation reference file used with the science + data. type: string archive_catalog: datatype: nvarchar(120) diff --git a/src/rad/resources/schemas/resample-1.0.0.yaml b/src/rad/resources/schemas/resample-1.0.0.yaml index 70ddea7b..be4ad2ca 100644 --- a/src/rad/resources/schemas/resample-1.0.0.yaml +++ b/src/rad/resources/schemas/resample-1.0.0.yaml @@ -3,23 +3,38 @@ $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 id: asdf://stsci.edu/datamodels/roman/schemas/resample-1.0.0 -title: Resample information +title: Resample Information type: object properties: pixel_scale_ratio: - title: Pixel Scale Ratio of resample to input scale + title: Pixel Scale Ratio + description: | + The pixel scale ratio compared to the input scale that resample will use + during processing. For example, a pixel scale ratio of 0.9 will produce a + resampled resultant image with smaller pixels than the native pixel scale + of the detector. type: number pixfrac: - title: Fraction of pixel to use for pixel convolution + title: Pixel Fraction + description: | + The fraction of a pixel to use for pixel convolution. type: number pointings: - title: Number of pointings in the resample + title: Number of Pointings + description: | + The number of pointings combined with the resample processing. type: integer product_exposure_time: - title: Total exposure time for resample product + title: Product Exposure Time + description: | + The total exposure time for the resampled product. type: number weight_type: - title: Drizzle weight type for resample + title: Weight Type + description: | + The weight type used by the drizzle algorithm in the resample processing. + The two weight options available are exposure time ("exptime") and inverse + variance map ("ivm"). type: string enum: ["exptime", "ivm"] propertyOrder: [pixel_scale_ratio, pixfrac, pointings, product_exposure_time, weight_type] diff --git a/src/rad/resources/schemas/source_detection-1.0.0.yaml b/src/rad/resources/schemas/source_detection-1.0.0.yaml index c2da04e3..102fa4d6 100644 --- a/src/rad/resources/schemas/source_detection-1.0.0.yaml +++ b/src/rad/resources/schemas/source_detection-1.0.0.yaml @@ -3,10 +3,13 @@ $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 id: asdf://stsci.edu/datamodels/roman/schemas/source_detection-1.0.0 -title: Source catalog generated by the Source Detection Step for TweakReg. +title: Source Detection Catalog type: object properties: tweakreg_catalog_name: + title: TweakReg Catalog Name + description: | + Source catalog generated by the source detection step for TweakReg. type: string flowStyle: block ... diff --git a/src/rad/resources/schemas/tagged_scalars/calibration_software_version-1.0.0.yaml b/src/rad/resources/schemas/tagged_scalars/calibration_software_version-1.0.0.yaml index 21f06354..87f52e77 100644 --- a/src/rad/resources/schemas/tagged_scalars/calibration_software_version-1.0.0.yaml +++ b/src/rad/resources/schemas/tagged_scalars/calibration_software_version-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/tagged_scalars/calibration_software_version-1.0.0 -title: Calibration software version number +title: Calibration Software Version Number type: string sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/tagged_scalars/file_date-1.0.0.yaml b/src/rad/resources/schemas/tagged_scalars/file_date-1.0.0.yaml index e85ad7a8..67492e33 100644 --- a/src/rad/resources/schemas/tagged_scalars/file_date-1.0.0.yaml +++ b/src/rad/resources/schemas/tagged_scalars/file_date-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/tagged_scalars/file_date-1.0.0 -title: Date this file was created (UTC) +title: File Creation Date allOf: - $ref: http://stsci.edu/schemas/asdf/time/time-1.1.0 diff --git a/src/rad/resources/schemas/tagged_scalars/filename-1.0.0.yaml b/src/rad/resources/schemas/tagged_scalars/filename-1.0.0.yaml index e4c4b189..593a09ac 100644 --- a/src/rad/resources/schemas/tagged_scalars/filename-1.0.0.yaml +++ b/src/rad/resources/schemas/tagged_scalars/filename-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/tagged_scalars/filename-1.0.0 -title: Name of the file +title: File Name type: string sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/tagged_scalars/model_type-1.0.0.yaml b/src/rad/resources/schemas/tagged_scalars/model_type-1.0.0.yaml index 0758cd87..c0f8e50b 100644 --- a/src/rad/resources/schemas/tagged_scalars/model_type-1.0.0.yaml +++ b/src/rad/resources/schemas/tagged_scalars/model_type-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/tagged_scalars/model_type-1.0.0 -title: Type of data model +title: Data Model Type type: string sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/tagged_scalars/origin-1.0.0.yaml b/src/rad/resources/schemas/tagged_scalars/origin-1.0.0.yaml index 051b7c64..bfe49caa 100644 --- a/src/rad/resources/schemas/tagged_scalars/origin-1.0.0.yaml +++ b/src/rad/resources/schemas/tagged_scalars/origin-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/tagged_scalars/origin-1.0.0 -title: Organization responsible for creating file +title: Institution / Organization Name type: string enum: ["STSCI", "IPAC/SSC"] diff --git a/src/rad/resources/schemas/tagged_scalars/prd_software_version-1.0.0.yaml b/src/rad/resources/schemas/tagged_scalars/prd_software_version-1.0.0.yaml index 2a41662a..4548a8fd 100644 --- a/src/rad/resources/schemas/tagged_scalars/prd_software_version-1.0.0.yaml +++ b/src/rad/resources/schemas/tagged_scalars/prd_software_version-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/tagged_scalars/prd_software_version-1.0.0 -title: S&OC PRD version number used in data processing +title: SOC PRD Version Number type: string sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/tagged_scalars/sdf_software_version-1.0.0.yaml b/src/rad/resources/schemas/tagged_scalars/sdf_software_version-1.0.0.yaml index 2e406309..f4aeaa5d 100644 --- a/src/rad/resources/schemas/tagged_scalars/sdf_software_version-1.0.0.yaml +++ b/src/rad/resources/schemas/tagged_scalars/sdf_software_version-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/tagged_scalars/sdf_software_version-1.0.0 -title: SDF software version number +title: SDF Version Number type: string sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/tagged_scalars/telescope-1.0.0.yaml b/src/rad/resources/schemas/tagged_scalars/telescope-1.0.0.yaml index add75f9e..102c499b 100644 --- a/src/rad/resources/schemas/tagged_scalars/telescope-1.0.0.yaml +++ b/src/rad/resources/schemas/tagged_scalars/telescope-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/tagged_scalars/telescope-1.0.0 -title: Telescope used to acquire the data +title: Telescope Name type: string enum: [ROMAN] diff --git a/src/rad/resources/schemas/target-1.0.0.yaml b/src/rad/resources/schemas/target-1.0.0.yaml index 82ea192b..c20a00f9 100644 --- a/src/rad/resources/schemas/target-1.0.0.yaml +++ b/src/rad/resources/schemas/target-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/target-1.0.0 -title: Target information +title: Target Information type: object properties: proposer_name: - title: Proposer's name for the target + title: Target Name from Proposer + description: | + The name of the target as it was defined and submitted by the proposer. type: string sdf: special_processing: VALUE_REQUIRED @@ -17,7 +19,9 @@ properties: datatype: nvarchar(100) destination: [ScienceCommon.proposer_target_name, GuideWindow.proposer_target_name] catalog_name: - title: Standard astronomical catalog name for target + title: Target Name from Catalog + description: | + The target name as defined by an astronomical catalog. type: string sdf: special_processing: VALUE_REQUIRED @@ -27,7 +31,14 @@ properties: datatype: nvarchar(256) destination: [ScienceCommon.catalog_name, GuideWindow.catalog_name] type: - title: Type of target + title: Target Type + description: | + The target type gives information on how the target will need to be + observed by the telescope. The options are "fixed", "moving", and + "generic". Moving indicates that the motion of the target needs to be + taken into account when observing, while fixed indicates that the target + needs a fixed orientation. Generic observations do not fit into the other + two categories. type: string enum: [FIXED, MOVING, GENERIC] sdf: @@ -38,7 +49,10 @@ properties: datatype: nvarchar(10) destination: [ScienceCommon.target_type, GuideWindow.target_type] ra: - title: Target RA at mid time of exposure + title: Target RA (deg) + description: | + The right ascension (RA) of the target in degrees at the midpoint of the + exposure. type: number sdf: special_processing: VALUE_REQUIRED @@ -48,7 +62,10 @@ properties: datatype: float destination: [ScienceCommon.ra, GuideWindow.ra] dec: - title: Target Dec at mid time of exposure + title: Target Dec (deg) + description: | + The declination (Dec) of the target in degrees at the midpoint of the + exposure. type: number sdf: special_processing: VALUE_REQUIRED @@ -58,7 +75,10 @@ properties: datatype: float destination: [ScienceCommon.dec, GuideWindow.dec] ra_uncertainty: - title: Target RA uncertainty + title: Target RA Uncertainty (deg) + description: | + The uncertainty of the right ascension (RA) of the target in degrees at + the midpoint of the exposure. type: number sdf: special_processing: VALUE_REQUIRED @@ -68,7 +88,10 @@ properties: datatype: float destination: [ScienceCommon.ra_uncertainty, GuideWindow.ra_uncertainty] dec_uncertainty: - title: Target Dec uncertainty + title: Target Dec Uncertainty (deg) + description: | + The uncertainty of the declination (Dec) of the target in degrees at the + midpoint of the exposure. type: number sdf: special_processing: VALUE_REQUIRED @@ -78,7 +101,9 @@ properties: datatype: float destination: [ScienceCommon.dec_uncertainty, GuideWindow.dec_uncertainty] proper_motion_ra: - title: Target proper motion in RA + title: Proper Motion of Target RA (deg) + description: | + The proper motion of the right ascension (RA) of the target in degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -88,7 +113,9 @@ properties: datatype: float destination: [ScienceCommon.proper_motion_ra, GuideWindow.proper_motion_ra] proper_motion_dec: - title: Target proper motion in Dec + title: Proper Motion of Target Dec (deg) + description: | + The proper motion of the declination (Dec) of the target in degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -98,7 +125,10 @@ properties: datatype: float destination: [ScienceCommon.proper_motion_dec, GuideWindow.proper_motion_dec] proper_motion_epoch: - title: Target proper motion epoch + title: Proper Motion Epoch of Target + description: | + The epoch at which the proper motion was calculated. This is needed to + correct for the proper motion at other epochs. type: string sdf: special_processing: VALUE_REQUIRED @@ -108,7 +138,10 @@ properties: datatype: nvarchar(10) destination: [ScienceCommon.proper_motion_epoch, GuideWindow.proper_motion_epoch] proposer_ra: - title: Proposer's target RA + title: RA from Proposer (deg) + description: | + The right ascension (RA) of the target in degrees as it was defined and + submitted by the proposer. type: number sdf: special_processing: VALUE_REQUIRED @@ -119,7 +152,10 @@ properties: datatype: float destination: [ScienceCommon.proposer_ra, GuideWindow.proposer_ra] proposer_dec: - title: Proposer's target Dec + title: Dec from Proposer (deg) + description: | + The declination (Dec) of the target in degrees as it was defined and + submitted by the proposer. type: number sdf: special_processing: VALUE_REQUIRED @@ -130,7 +166,12 @@ properties: datatype: float destination: [ScienceCommon.proposer_dec, GuideWindow.proposer_dec] source_type: - title: Source type used for calibration + title: Source Type for Calibration + description: | + The source type is defined by the calibration needs. The options are + "extended", "point", and "unknown". Extended sources and point sources + might have different calibration requirements. Unknown is for sources + where the type is not yet defined. type: string enum: [EXTENDED, POINT, UNKNOWN] sdf: diff --git a/src/rad/resources/schemas/velocity_aberration-1.0.0.yaml b/src/rad/resources/schemas/velocity_aberration-1.0.0.yaml index 46c1d5b7..c7476491 100644 --- a/src/rad/resources/schemas/velocity_aberration-1.0.0.yaml +++ b/src/rad/resources/schemas/velocity_aberration-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/velocity_aberration-1.0.0 -title: Velocity aberration correction information +title: Velocity Aberration Correction Information type: object properties: ra_offset: - title: Velocity aberration right ascension offset + title: Velocity Aberration RA Offset (degree) + description: | + Right ascension offset for velocity aberration in degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -17,7 +19,9 @@ properties: datatype: float destination: [ScienceCommon.ra_offset, GuideWindow.ra_offset] dec_offset: - title: Velocity aberration declination offset + title: Velocity Aberration Dec Offset (degree) + description: | + Declination offset for velocity aberration in degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -27,7 +31,9 @@ properties: datatype: float destination: [ScienceCommon.dec_offset, GuideWindow.dec_offset] scale_factor: - title: Velocity aberration scale factor + title: Velocity Aberration Scale Factor + description: | + Velocity aberration scale factor. type: number sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/visit-1.0.0.yaml b/src/rad/resources/schemas/visit-1.0.0.yaml index 0d588a3d..6e57f15a 100644 --- a/src/rad/resources/schemas/visit-1.0.0.yaml +++ b/src/rad/resources/schemas/visit-1.0.0.yaml @@ -3,11 +3,15 @@ $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 id: asdf://stsci.edu/datamodels/roman/schemas/visit-1.0.0 -title: Visit information +title: Visit Information type: object properties: engineering_quality: - title: Engineering data quality indicator from EngDB + title: Engineering Quality + description: | + The engineering data quality indicator from the Engineering Database + (EngDB). The options available are "OK" and "SUSPECT", where "SUSPECT" + identifies data with indications of poor data quality. type: string enum: [OK, SUSPECT] sdf: @@ -18,7 +22,10 @@ properties: datatype: nvarchar(10) destination: [ScienceCommon.engineering_quality, GuideWindow.engineering_quality] pointing_engdb_quality: - title: Quality of pointing information from EngDB + title: Engineering Quality of Pointing + description: | + The quality of the pointing information from the Engineering Database + (EngDB). The options available are "CALCULATED" and "PLANNED". type: string enum: [CALCULATED, PLANNED] sdf: @@ -29,7 +36,9 @@ properties: datatype: nvarchar(10) destination: [ScienceCommon.pointing_engdb_quality, GuideWindow.pointing_engdb_quality] type: - title: Visit type + title: Visit Type + description: | + The type of visit. type: string sdf: special_processing: VALUE_REQUIRED @@ -39,7 +48,9 @@ properties: datatype: nvarchar(30) destination: [ScienceCommon.visit_type, GuideWindow.visit_type] start_time: - title: UTC visit start time + title: Visit Start Time (UTC) + description: | + The start time of the visit in coordinated universal time (UTC). tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED @@ -49,7 +60,9 @@ properties: datatype: datetime2 destination: [ScienceCommon.visit_start_time, GuideWindow.visit_start_time] end_time: - title: UTC visit end time + title: Visit End Time (UTC) + description: | + The end time of the visit in coordinated universal time (UTC). tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED @@ -59,7 +72,9 @@ properties: datatype: datetime2 destination: [ScienceCommon.visit_end_time, GuideWindow.visit_end_time] status: - title: Status of a visit + title: Visit Status + description: | + The status of a visit. type: string sdf: special_processing: VALUE_REQUIRED @@ -69,7 +84,9 @@ properties: datatype: nvarchar(15) destination: [ScienceCommon.visit_status, GuideWindow.visit_status] total_exposures: - title: Total number of planned exposures in visit + title: Total Number of Exposures + description: | + The total number of exposures planned in a visit. type: integer sdf: special_processing: VALUE_REQUIRED @@ -79,7 +96,11 @@ properties: datatype: int destination: [ScienceCommon.visit_total_exposures, GuideWindow.visit_total_exposures] internal_target: - title: At least one exposure in visit is internal + title: Internal Target + description: | + A boolean value which indicates whether at least one exposure in a visit + is internal. Internal targets refer to calibration data where the + telescope observes without external sources by closing the shudder. type: boolean sdf: special_processing: VALUE_REQUIRED @@ -89,7 +110,11 @@ properties: datatype: nchar(1) destination: [ScienceCommon.visit_internal_target, GuideWindow.visit_internal_target] target_of_opportunity: - title: Visit scheduled as target of opportunity + title: Target of Opportunity + description: | + A boolean value which indicates whether the visit is defined as a target + of opportunity (ToO). Targets of opportunity react to temporal phenomena, + such as supernova, which cannot be planned in advance. type: boolean sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/wcsinfo-1.0.0.yaml b/src/rad/resources/schemas/wcsinfo-1.0.0.yaml index d855ecd6..52d3eaa6 100644 --- a/src/rad/resources/schemas/wcsinfo-1.0.0.yaml +++ b/src/rad/resources/schemas/wcsinfo-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/wcsinfo-1.0.0 -title: WCS parameters +title: World Coordinate System (WCS) Parameters type: object properties: v2_ref: - title: "[arcsec] Telescope v2 coordinate of the reference point" + title: Reference Position V2 Coordinate (arcsec) + description: | + Coordinate of the reference position along the telescope V2 axis in units + of arcseconds. type: number sdf: special_processing: VALUE_REQUIRED @@ -17,7 +20,10 @@ properties: datatype: float destination: [ScienceCommon.v2_ref, GuideWindow.v2_ref] v3_ref: - title: "[arcsec] Telescope v3 coordinate of the reference point" + title: Reference Position V3 Coordinate (arcsec) + description: | + Coordinate of the reference position along the telescope V3 axis in units + of arcseconds. type: number sdf: special_processing: VALUE_REQUIRED @@ -27,7 +33,11 @@ properties: datatype: float destination: [ScienceCommon.v3_ref, GuideWindow.v3_ref] vparity: - title: Relative sense of rotation between Ideal xy and V2V3 + title: Relative Rotation Between Ideal and Telescope Axes + description: | + Relative sense of rotation between the ideal and telescope coordinate + systems. The value may be either 1 or -1. See documents STScI-JWST-001550 + and STScI-Roman-000143 for more information. type: integer sdf: special_processing: VALUE_REQUIRED @@ -37,7 +47,10 @@ properties: datatype: int destination: [ScienceCommon.vparity, GuideWindow.vparity] v3yangle: - title: "[deg] Angle from V3 axis to Ideal y axis" + title: Angle Between the V3 and Ideal Y Axes (deg) + description: | + Angle between the telescope V3 axis and the ideal coordinate frame y-axis + in units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -47,7 +60,9 @@ properties: datatype: float destination: [ScienceCommon.v3yangle, GuideWindow.v3yangle] ra_ref: - title: "[deg] Right ascension of the reference point" + title: Right Ascension of the Reference Position (deg) + description: | + Right ascension of the reference position on the sky in units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -57,7 +72,9 @@ properties: datatype: float destination: [ScienceCommon.ra_ref, GuideWindow.ra_ref] dec_ref: - title: "[deg] Declination of the reference point" + title: Declination of the Reference Position (deg) + description: | + Declination of the reference position on the sky in units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -67,7 +84,10 @@ properties: datatype: float destination: [ScienceCommon.dec_ref, GuideWindow.dec_ref] roll_ref: - title: "[deg] V3 roll angle at the ref point (N over E)" + title: V3 Position Angle at the Reference Position + description: | + Position angle of the V3 axis at the reference position measured from + North to East. type: number sdf: special_processing: VALUE_REQUIRED @@ -77,7 +97,11 @@ properties: datatype: float destination: [ScienceCommon.roll_ref, GuideWindow.roll_ref] s_region: - title: spatial extent of the observation + title: Spatial Extent of the Observation + description: | + The region of the sky enclosed by the observation footprint. This is given + as a polygon stored as a string with the vertices defined by a list of + right ascension and declination pairs in units of degrees. type: string sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/wfi_detector-1.0.0.yaml b/src/rad/resources/schemas/wfi_detector-1.0.0.yaml index a6bd05b7..c5f63b5f 100644 --- a/src/rad/resources/schemas/wfi_detector-1.0.0.yaml +++ b/src/rad/resources/schemas/wfi_detector-1.0.0.yaml @@ -5,7 +5,7 @@ id: asdf://stsci.edu/datamodels/roman/schemas/wfi_detector-1.0.0 # Helper file to enumerate detectors for wfi_mode and ref_detector -title: Name of detector used to acquire the data +title: WFI Detector Name type: string enum: - WFI01 diff --git a/src/rad/resources/schemas/wfi_image-1.0.0.yaml b/src/rad/resources/schemas/wfi_image-1.0.0.yaml index 3f5b0984..8cb0fd5f 100644 --- a/src/rad/resources/schemas/wfi_image-1.0.0.yaml +++ b/src/rad/resources/schemas/wfi_image-1.0.0.yaml @@ -3,8 +3,7 @@ $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 id: asdf://stsci.edu/datamodels/roman/schemas/wfi_image-1.0.0 -title: | - The schema for WFI Level 2 images. +title: The Schema for WFI Level 2 Images. datamodel_name: ImageModel archive_meta: None @@ -27,7 +26,9 @@ properties: tag: asdf://stsci.edu/datamodels/roman/tags/source_detection-1.0.0 required: [photometry, wcs] data: - title: Science data, excluding border reference pixels. + title: Science Data Excluding Border Reference Pixels + description: | + Science data, excluding border reference pixels. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -39,11 +40,17 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["electron / s"] dq: + title: Data Quality Flags + description: | + Data quality flags. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true ndim: 2 err: + title: Error (electrons / s) + description: | + Error in units of electrons per second. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -55,6 +62,9 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["electron / s"] var_poisson: + title: Poisson Variance (electrons^2 / s^2) + description: | + Poisson variance in units of electrons^2 / second^2. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -66,6 +76,9 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["electron2 / s2"] var_rnoise: + title: Read Noise (electrons^2 / s^2) + description: | + Read noise in units of electrons^2 / second^2. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -77,6 +90,10 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["electron2 / s2"] var_flat: + title: Variance for Estimate of Flat Pixel Flux (electrons^2 / s^2) + description: | + Variance for estimate of flat pixel flux in units of + electrons^2 / second^2. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -88,7 +105,9 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["electron2 / s2"] amp33: - title: Amp 33 reference pixel data + title: Amp 33 Reference Pixel Data + description: | + Amplifier 33 reference pixel data. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -100,7 +119,10 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN"] border_ref_pix_left: - title: Original border reference pixels, on left (from viewers perspective). + title: Border Reference Pixels on the Left of the Detector, from the instrument's perspective + description: | + Border reference pixels on the left of the detector, from the instrument's + perspective. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -112,7 +134,10 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN"] border_ref_pix_right: - title: Original border reference pixels, on right (from viewers perspective). + title: Border Reference Pixels on the Right of the Detector, from the instrument's perspective + description: | + Border reference pixels on the right of the detector, from the + instrument's perspective. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -124,7 +149,9 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN"] border_ref_pix_top: - title: Original border reference pixels, on top. + title: Border Reference Pixels on the Top of the Detector + description: | + Border reference pixels on the top of the detector. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -136,7 +163,9 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN"] border_ref_pix_bottom: - title: Original border reference pixels, on bottom. + title: Border Reference Pixels on the Bottom of the Detector + description: | + Border reference pixels on the bottom of the detector. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -148,30 +177,42 @@ properties: tag: tag:astropy.org:astropy/units/unit-1.* enum: ["DN"] dq_border_ref_pix_left: - title: DQ for border reference pixels, on left (from viewers perspective). + title: Data Quality Flag for Border Reference Pixels, on the Left Edge of the Detector from the Instrument Perspective + description: | + Data quality flag for border reference pixels, on the left edge of the + detector from the instrument perspective. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true ndim: 2 dq_border_ref_pix_right: - title: DQ for border reference pixels, on right (from viewers perspective). + title: Data Quality Flag for Border Reference Pixels, on the Right edge of the Detector from the Instrument Perspective + description: | + Data quality flag for border reference pixels, on the right edge of the + detector from the instrument perspective. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true ndim: 2 dq_border_ref_pix_top: - title: DQ for border reference pixels, on top. - tag: tag:stsci.edu:asdf/core/ndarray-1.* + title: Data Quality Flag for Border Reference Pixels, on Top + description: | + Data quality flag for border reference pixels, on top. datatype: uint32 exact_datatype: true ndim: 2 dq_border_ref_pix_bottom: - title: DQ for border reference pixels, on bottom. + title: Data Quality Flag for Border Reference Pixels, on Bottom + description: | + Data quality flag for border reference pixels, on bottom. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true ndim: 2 cal_logs: + title: Calibration Logs + description: | + Calibration logs. tag: asdf://stsci.edu/datamodels/roman/tags/cal_logs-1.0.0 propertyOrder: [meta, data, dq, err, var_poisson, var_rnoise, var_flat, amp33, border_ref_pix_left, border_ref_pix_right, diff --git a/src/rad/resources/schemas/wfi_mode-1.0.0.yaml b/src/rad/resources/schemas/wfi_mode-1.0.0.yaml index 7b4f5d5d..40bf32a1 100644 --- a/src/rad/resources/schemas/wfi_mode-1.0.0.yaml +++ b/src/rad/resources/schemas/wfi_mode-1.0.0.yaml @@ -4,12 +4,13 @@ $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 id: asdf://stsci.edu/datamodels/roman/schemas/wfi_mode-1.0.0 -title: | - WFI observing configuration +title: WFI Observing Configuration type: object properties: name: - title: Instrument used to acquire the data + title: Instrument Used to Acquire the Data + description: | + Instrument used to acquire the data. type: string enum: [WFI] sdf: @@ -20,6 +21,9 @@ properties: datatype: nvarchar(5) destination: [ScienceCommon.instrument_name, GuideWindow.instrument_name] detector: + title: WFI Detector + description: | + WFI detector used to take the data. $ref: wfi_detector-1.0.0 sdf: special_processing: VALUE_REQUIRED @@ -29,6 +33,9 @@ properties: datatype: nvarchar(10) destination: [ScienceCommon.detector, GuideWindow.detector] optical_element: + title: WFI Optical Element + description: | + WFI optical element used to take the data. $ref: wfi_optical_element-1.0.0 sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/wfi_mosaic-1.0.0.yaml b/src/rad/resources/schemas/wfi_mosaic-1.0.0.yaml index d3ed9b1f..4e6b1815 100644 --- a/src/rad/resources/schemas/wfi_mosaic-1.0.0.yaml +++ b/src/rad/resources/schemas/wfi_mosaic-1.0.0.yaml @@ -43,7 +43,9 @@ properties: tag: asdf://stsci.edu/datamodels/roman/tags/mosaic_wcsinfo-1.0.0 required: [asn, basic, cal_step, photometry, program, resample, wcs, wcsinfo] data: - title: Science data, excluding border reference pixels. + title: Science Data + description: | + The science data array, excluding the border reference pixels. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -55,6 +57,7 @@ properties: tag: tag:stsci.edu:asdf/unit/unit-1.* enum: ["MJy.sr**-1"] err: + title: Error Data tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -66,16 +69,19 @@ properties: tag: tag:stsci.edu:asdf/unit/unit-1.* enum: ["MJy.sr**-1"] context: + title: Context Data tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true ndim: 3 weight: + title: Weight Data tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: float32 exact_datatype: true ndim: 2 var_poisson: + title: Poisson Variability tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -87,6 +93,7 @@ properties: tag: tag:stsci.edu:asdf/unit/unit-1.* enum: ["MJy**2.sr**-2"] var_rnoise: + title: Read Noise Variance tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -98,6 +105,7 @@ properties: tag: tag:stsci.edu:asdf/unit/unit-1.* enum: ["MJy**2.sr**-2"] var_flat: + title: Flat Field Variance tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: diff --git a/src/rad/resources/schemas/wfi_optical_element-1.0.0.yaml b/src/rad/resources/schemas/wfi_optical_element-1.0.0.yaml index 2829a551..ec8e431a 100644 --- a/src/rad/resources/schemas/wfi_optical_element-1.0.0.yaml +++ b/src/rad/resources/schemas/wfi_optical_element-1.0.0.yaml @@ -5,8 +5,11 @@ id: asdf://stsci.edu/datamodels/roman/schemas/wfi_optical_element-1.0.0 # Helper file to enumerate filters for wfi_mode and ref_optical_element +title: Optical Element +description: | + Name of the filter element used. See the RDox Optical Element page for more + details on available optical elements and their properties. type: string -title: Name of the filter element used enum: - F062 - F087 diff --git a/src/rad/resources/schemas/wfi_science_raw-1.0.0.yaml b/src/rad/resources/schemas/wfi_science_raw-1.0.0.yaml index cd7b6c44..09e7fd64 100644 --- a/src/rad/resources/schemas/wfi_science_raw-1.0.0.yaml +++ b/src/rad/resources/schemas/wfi_science_raw-1.0.0.yaml @@ -3,8 +3,7 @@ $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 id: asdf://stsci.edu/datamodels/roman/schemas/wfi_science_raw-1.0.0 -title: | - The schema for Level 1 WFI science data (both imaging and spectrographic). +title: Level 1 WFI Imaging and Spectrographic Science Data datamodel_name: ScienceRawModel @@ -15,7 +14,9 @@ properties: meta: $ref: common-1.0.0 data: - title: Science data, including the border reference pixels. + title: Science Data + description: | + Science data, including reference pixels. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -28,7 +29,9 @@ properties: enum: ["DN"] amp33: - title: Amp 33 reference pixel data. + title: Amplifier 33 Reference Pixel Data + description: | + Reference pixel data from amplifier 33. tag: tag:stsci.edu:asdf/unit/quantity-1.* properties: value: @@ -41,7 +44,9 @@ properties: enum: ["DN"] resultantdq: - title: Optional 3-D data quality array (plane dq for each resultant) + title: Resultant Data Quality Array + description: | + An optional, 3-D data quality array, with plane DQ for each resultant. tag: tag:stsci.edu:asdf/core/ndarray-1.* ndim: 3 datatype: uint8