diff --git a/changes/466.misc.rst b/changes/466.misc.rst new file mode 100644 index 00000000..24114c57 --- /dev/null +++ b/changes/466.misc.rst @@ -0,0 +1 @@ +Updated ``cal_step`` and ``cal_log`` schema information. diff --git a/changes/467.misc.rst b/changes/467.misc.rst new file mode 100644 index 00000000..11a94f92 --- /dev/null +++ b/changes/467.misc.rst @@ -0,0 +1 @@ +Update ``coordinate`` schema descriptions diff --git a/changes/469.misc.rst b/changes/469.misc.rst new file mode 100644 index 00000000..7b094c0d --- /dev/null +++ b/changes/469.misc.rst @@ -0,0 +1 @@ +Update ``ephemeris`` schema descriptions diff --git a/changes/471.misc.rst b/changes/471.misc.rst new file mode 100644 index 00000000..ce2f6345 --- /dev/null +++ b/changes/471.misc.rst @@ -0,0 +1 @@ +Updates ``guide_star``, ``instrument``, and ``photometry`` schemas diff --git a/changes/473.misc.rst b/changes/473.misc.rst new file mode 100644 index 00000000..154a83fa --- /dev/null +++ b/changes/473.misc.rst @@ -0,0 +1 @@ +Add ``rcs`` and removes ``aperture``, ``target`` schemas diff --git a/changes/474.misc.rst b/changes/474.misc.rst new file mode 100644 index 00000000..b655f3b2 --- /dev/null +++ b/changes/474.misc.rst @@ -0,0 +1 @@ +Update and add keywords and descriptions in the basic-1.0.0 and statistics schemas diff --git a/changes/475.misc.rst b/changes/475.misc.rst new file mode 100644 index 00000000..54b27a2d --- /dev/null +++ b/changes/475.misc.rst @@ -0,0 +1 @@ +Update the pointing schema diff --git a/changes/476.misc.rst b/changes/476.misc.rst new file mode 100644 index 00000000..25711ba7 --- /dev/null +++ b/changes/476.misc.rst @@ -0,0 +1 @@ +Update velocity_aberration descriptions and keywords diff --git a/changes/477.misc.rst b/changes/477.misc.rst new file mode 100644 index 00000000..25ec8864 --- /dev/null +++ b/changes/477.misc.rst @@ -0,0 +1 @@ +Updates wcs keywords and attribute information diff --git a/changes/478.misc.rst b/changes/478.misc.rst new file mode 100644 index 00000000..a36dcad0 --- /dev/null +++ b/changes/478.misc.rst @@ -0,0 +1 @@ +Update exposure and program attributes information diff --git a/changes/479.misc.rst b/changes/479.misc.rst new file mode 100644 index 00000000..0ff1523d --- /dev/null +++ b/changes/479.misc.rst @@ -0,0 +1 @@ +Update ref_file descriptions diff --git a/changes/480.misc.rst b/changes/480.misc.rst new file mode 100644 index 00000000..251b2be7 --- /dev/null +++ b/changes/480.misc.rst @@ -0,0 +1 @@ +Update observation descriptions diff --git a/changes/481.misc.rst b/changes/481.misc.rst new file mode 100644 index 00000000..5c77f09b --- /dev/null +++ b/changes/481.misc.rst @@ -0,0 +1 @@ +Update visit, l1, and l2 attribute information diff --git a/changes/487.misc.rst b/changes/487.misc.rst new file mode 100644 index 00000000..4fac6d9b --- /dev/null +++ b/changes/487.misc.rst @@ -0,0 +1,2 @@ +Update and add descriptions in the individual image metadata schema. +Address merge issues created by the L1 and L2 metadata updates. diff --git a/docs/schemas.rst b/docs/schemas.rst index 577ddb52..9ad00849 100644 --- a/docs/schemas.rst +++ b/docs/schemas.rst @@ -44,7 +44,6 @@ Tags .. asdf-autoschemas:: - aperture-1.0.0 associations-1.0.0 basic-1.0.0 cal_logs-1.0.0 @@ -73,7 +72,6 @@ Tags ref_file-1.0.0 resample-1.0.0 source_detection-1.0.0 - target-1.0.0 velocity_aberration-1.0.0 visit-1.0.0 wcsinfo-1.0.0 @@ -85,6 +83,5 @@ Tags tagged_scalars/filename-1.0.0 tagged_scalars/model_type-1.0.0 tagged_scalars/origin-1.0.0 - tagged_scalars/prd_software_version-1.0.0 tagged_scalars/sdf_software_version-1.0.0 tagged_scalars/telescope-1.0.0 diff --git a/src/rad/resources/manifests/datamodels-1.0.yaml b/src/rad/resources/manifests/datamodels-1.0.yaml index 886227fb..e3d196a7 100644 --- a/src/rad/resources/manifests/datamodels-1.0.yaml +++ b/src/rad/resources/manifests/datamodels-1.0.yaml @@ -85,21 +85,21 @@ tags: title: Coordinate frame information description: |- Coordinate frame information -- tag_uri: asdf://stsci.edu/datamodels/roman/tags/aperture-1.0.0 - schema_uri: asdf://stsci.edu/datamodels/roman/schemas/aperture-1.0.0 - title: Aperture information - description: |- - Aperture information - tag_uri: asdf://stsci.edu/datamodels/roman/tags/pointing-1.0.0 schema_uri: asdf://stsci.edu/datamodels/roman/schemas/pointing-1.0.0 title: Spacecraft Pointing information description: |- Spacecraft Pointing information -- tag_uri: asdf://stsci.edu/datamodels/roman/tags/target-1.0.0 - schema_uri: asdf://stsci.edu/datamodels/roman/schemas/target-1.0.0 - title: Target information +- tag_uri: asdf://stsci.edu/datamodels/roman/tags/rcs-1.0.0 + schema_uri: asdf://stsci.edu/datamodels/roman/schemas/rcs-1.0.0 + title: Relative Calibration System Information + description: |- + Relative Calibration System Information +- tag_uri: asdf://stsci.edu/datamodels/roman/tags/statistics-1.0.0 + schema_uri: asdf://stsci.edu/datamodels/roman/schemas/statistics-1.0.0 + title: Basic Statistical Information description: |- - Target information + Basic Statistical Information - tag_uri: asdf://stsci.edu/datamodels/roman/tags/velocity_aberration-1.0.0 schema_uri: asdf://stsci.edu/datamodels/roman/schemas/velocity_aberration-1.0.0 title: Velocity aberration information @@ -283,46 +283,66 @@ tags: description: |- Segmentation map computed by the Source Catalog Step # Tagged Scalars +- tag_uri: asdf://stsci.edu/datamodels/roman/tags/calibration_software_name-1.0.0 + schema_uri: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/calibration_software_name-1.0.0 + title: Calibration Software Name + description: |- + Name of the calibration software package used in + processing this file. - tag_uri: asdf://stsci.edu/datamodels/roman/tags/calibration_software_version-1.0.0 schema_uri: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/calibration_software_version-1.0.0 title: Calibration software version description: |- - Calibration software version number + The version number of the calibration software used in + processing this file. +- tag_uri: asdf://stsci.edu/datamodels/roman/tags/product_type-1.0.0 + schema_uri: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/product_type-1.0.0 + title: Product Type Descriptor + description: |- + A descriptor for the type of data contained within the + file. This corresponds to the standard file suffixes for + archival data products. Consult the documentation for the list + of options. - tag_uri: asdf://stsci.edu/datamodels/roman/tags/filename-1.0.0 schema_uri: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/filename-1.0.0 - title: Name of the file + title: File Name description: |- - Name of the file + The auto-generated name of this file. - tag_uri: asdf://stsci.edu/datamodels/roman/tags/file_date-1.0.0 schema_uri: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/file_date-1.0.0 - title: Date this file was created (UTC) + title: File Creation Date description: |- - Date this file was created (UTC) + The date and time this file was created. - tag_uri: asdf://stsci.edu/datamodels/roman/tags/model_type-1.0.0 schema_uri: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/model_type-1.0.0 - title: Type of data model + title: Data Model Type description: |- - Type of data model + The type of data model contained within this file. - tag_uri: asdf://stsci.edu/datamodels/roman/tags/origin-1.0.0 schema_uri: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/origin-1.0.0 - title: Organization responsible for creating file + title: Institution / Organization Name description: |- - Organization responsible for creating file -- tag_uri: asdf://stsci.edu/datamodels/roman/tags/prd_software_version-1.0.0 - schema_uri: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/prd_software_version-1.0.0 - title: S&OC PRD version number used in data processing + The name of the institution of organization + responsible for creating this file. +- tag_uri: asdf://stsci.edu/datamodels/roman/tags/prd_version-1.0.0 + schema_uri: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/prd_version-1.0.0 + title: SOC PRD Version Number description: |- - S&OC PRD version number used in data processing + The version number of the Science Operations Center + (SOC) Project Reference Database (PRD) used in generating this + file. - tag_uri: asdf://stsci.edu/datamodels/roman/tags/sdf_software_version-1.0.0 schema_uri: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/sdf_software_version-1.0.0 - title: SDF software version number + title: SOC SDF Version Number description: |- - SDF software version number + The version number of the Science Operations Center + (SOC) Science Data Formatting (SDF) software used in generating + this file. - tag_uri: asdf://stsci.edu/datamodels/roman/tags/telescope-1.0.0 schema_uri: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/telescope-1.0.0 - title: Telescope used to acquire the data + title: Telescope Name description: |- - Telescope used to acquire the data + The name of the telescope used to acquire the data. # FPS Schemas - tag_uri: asdf://stsci.edu/datamodels/roman/tags/fps-1.0.0 schema_uri: asdf://stsci.edu/datamodels/roman/schemas/fps-1.0.0 diff --git a/src/rad/resources/schemas/aperture-1.0.0.yaml b/src/rad/resources/schemas/aperture-1.0.0.yaml deleted file mode 100644 index 0e3523dc..00000000 --- a/src/rad/resources/schemas/aperture-1.0.0.yaml +++ /dev/null @@ -1,45 +0,0 @@ -%YAML 1.1 ---- -$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 -type: object -properties: - name: - 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', - 'WFI_09_FULL', 'WFI_10_FULL', 'WFI_11_FULL', 'WFI_12_FULL', - 'WFI_13_FULL', 'WFI_14_FULL', 'WFI_15_FULL', 'WFI_16_FULL', - 'WFI_17_FULL', 'WFI_18_FULL', - 'BORESIGHT', - 'CGI_CEN', 'WFI_CEN'] - sdf: - special_processing: VALUE_REQUIRED - source: - origin: PSS:aperture.AperName - maxLength: 40 - archive_catalog: - datatype: nvarchar(40) - destination: [WFIExposure.aperture_name, GuideWindow.aperture_name] - position_angle: - 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 - source: - origin: TBD #v3_position_angle in baseline_prime_visits or spacecraft_parameters - archive_catalog: - datatype: float - destination: [WFIExposure.position_angle, GuideWindow.position_angle] -propertyOrder: [name, position_angle] -flowStyle: block -required: [name, position_angle] -... diff --git a/src/rad/resources/schemas/basic-1.0.0.yaml b/src/rad/resources/schemas/basic-1.0.0.yaml index 6000da82..2f89530e 100644 --- a/src/rad/resources/schemas/basic-1.0.0.yaml +++ b/src/rad/resources/schemas/basic-1.0.0.yaml @@ -8,12 +8,26 @@ title: Basic Information type: object properties: # Meta Variables + calibration_software_name: + title: Calibration Software Name + description: | + Name of the calibration software package used in + processing this file. + tag: asdf://stsci.edu/datamodels/roman/tags/calibration_software_name-1.0.0 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 + product_type: + title: Product Type Descriptor + description: | + A descriptor for the type of data contained within the + file. This corresponds to the standard file suffixes for + archival data products. Consult the documentation for the list + of options. + tag: asdf://stsci.edu/datamodels/roman/tags/product_type-1.0.0 filename: title: File Name description: | @@ -27,32 +41,34 @@ properties: model_type: title: Data Model Type description: | - The type of data model contained in this file. + The type of data model contained within 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. + 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: + prd_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 + The version number of the Science Operations Center + (SOC) Project Reference Database (PRD) used in generating this + file. + tag: asdf://stsci.edu/datamodels/roman/tags/prd_version-1.0.0 sdf_software_version: - title: SDF Version Number + title: SOC SDF Version Number description: | - The version number of the Science Data Formatting (SDF) software used in - generating this file. + The version number of the Science Operations Center + (SOC) 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, - sdf_software_version, telescope] +required: [calibration_software_name, calibration_software_version, + filename, file_date, model_type, origin, prd_version, + sdf_software_version, telescope] ... 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 b233d0a9..0d57260d 100644 --- a/src/rad/resources/schemas/cal_logs-1.0.0.yaml +++ b/src/rad/resources/schemas/cal_logs-1.0.0.yaml @@ -5,8 +5,8 @@ id: asdf://stsci.edu/datamodels/roman/schemas/cal_logs-1.0.0 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. + String array of log messages recording the steps, failures, + and outputs associated with running romancal steps. type: array items: type: string diff --git a/src/rad/resources/schemas/common-1.0.0.yaml b/src/rad/resources/schemas/common-1.0.0.yaml index 6b268bd1..90db13dd 100644 --- a/src/rad/resources/schemas/common-1.0.0.yaml +++ b/src/rad/resources/schemas/common-1.0.0.yaml @@ -11,12 +11,6 @@ allOf: - type: object properties: # Meta Objects - aperture: - title: Aperture Information - tag: asdf://stsci.edu/datamodels/roman/tags/aperture-1.0.0 - cal_step: - title: Tracker of Calibration Pipeline Steps - tag: asdf://stsci.edu/datamodels/roman/tags/l2_cal_step-1.0.0 coordinates: title: Name Of The Coordinate Reference Frame tag: asdf://stsci.edu/datamodels/roman/tags/coordinates-1.0.0 @@ -26,7 +20,7 @@ allOf: exposure: title: Exposure Information tag: asdf://stsci.edu/datamodels/roman/tags/exposure-1.0.0 - guidestar: + guide_star: title: Guide Star Window Information tag: asdf://stsci.edu/datamodels/roman/tags/guidestar-1.0.0 instrument: @@ -44,9 +38,9 @@ allOf: 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 + rcs: + title: Relative Calibration System Information + tag: asdf://stsci.edu/datamodels/roman/tags/rcs-1.0.0 velocity_aberration: title: Velocity Aberration Correction Information tag: asdf://stsci.edu/datamodels/roman/tags/velocity_aberration-1.0.0 @@ -56,7 +50,7 @@ allOf: 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, + required: [coordinates, ephemeris, exposure, guide_star, instrument, observation, pointing, program, ref_file, - target, velocity_aberration, visit, wcsinfo] + rcs, velocity_aberration, visit, wcsinfo] ... diff --git a/src/rad/resources/schemas/coordinates-1.0.0.yaml b/src/rad/resources/schemas/coordinates-1.0.0.yaml index cc667a90..38e2581a 100644 --- a/src/rad/resources/schemas/coordinates-1.0.0.yaml +++ b/src/rad/resources/schemas/coordinates-1.0.0.yaml @@ -7,9 +7,10 @@ title: Name Of The Coordinate Reference Frame type: object properties: reference_frame: - title: Name of the Coordinate Reference Frame + title: Name of the Celestial Coordinate Reference Frame description: | - Name of the coordinate reference frame. + Name of the celestial coordinate reference frame used + for the World Coordinate System (WCS). 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 adacfb22..af166e88 100644 --- a/src/rad/resources/schemas/ephemeris-1.0.0.yaml +++ b/src/rad/resources/schemas/ephemeris-1.0.0.yaml @@ -9,7 +9,8 @@ properties: earth_angle: title: Earth Angle (radians) description: | - Earth angle in radians. + Angle between the Earth and the telescope V1 axis in + radians. type: number sdf: special_processing: VALUE_REQUIRED @@ -21,7 +22,8 @@ properties: moon_angle: title: Moon Angle (radians) description: | - Moon angle in radians. + Angle between the Moon and the telescope V1 axis in + radians. type: number sdf: special_processing: VALUE_REQUIRED @@ -30,35 +32,36 @@ properties: archive_catalog: datatype: float destination: [WFIExposure.moon_angle, GuideWindow.moon_angle] - ephemeris_reference_frame: - title: Ephemeris Reference Frame + sun_angle: + title: Sun Angle (radians) description: | - Ephemeris reference frame. - type: string + Angle between the Sun and the telescope V1 axis in + radians. + type: number sdf: special_processing: VALUE_REQUIRED source: origin: TBD - maxLength: 10 archive_catalog: - datatype: nvarchar(10) - destination: [WFIExposure.ephemeris_reference_frame, GuideWindow.ephemeris_reference_frame] - sun_angle: - title: Sun Angle (radians) + datatype: float + destination: [WFIExposure.sun_angle, GuideWindow.sun_angle] + ephemeris_reference_frame: + title: Ephemeris Reference Frame description: | - Sun angle in radians. - type: number + Reference frame of the ephemeris information. + type: string sdf: special_processing: VALUE_REQUIRED source: origin: TBD + maxLength: 10 archive_catalog: - datatype: float - destination: [WFIExposure.sun_angle, GuideWindow.sun_angle] + datatype: nvarchar(10) + destination: [WFIExposure.ephemeris_reference_frame, GuideWindow.ephemeris_reference_frame] type: - title: Type of Ephemeris + title: Ephemeris Type description: | - Type of ephemeris. + Type of ephemeris (either DEFINITIVE or PREDICTED). type: string enum: [DEFINITIVE, PREDICTED] sdf: @@ -70,9 +73,10 @@ properties: datatype: nvarchar(10) destination: [WFIExposure.ephemeris_type, GuideWindow.ephemeris_type] time: - title: UTC Time of Position and Velocity Vectors in Ephemeris (MJD) + title: UTC Time of Ephemeris Information (MJD) description: | - UTC time of position and velocity vectors in ephemeris in MJD. + UTC time of the position and velocity vectors in the + ephemeris. The time is provided in modified Julian date (MJD). type: number sdf: special_processing: VALUE_REQUIRED @@ -84,7 +88,8 @@ properties: spatial_x: title: X Spatial Coordinate of Roman (km) description: | - X spatial coordinate of Roman in km. + X barycentric coordinate of the Roman observatory at + the MJD described by meta.ephemeris.time. type: number sdf: special_processing: VALUE_REQUIRED @@ -96,7 +101,8 @@ properties: spatial_y: title: Y Spatial Coordinate of Roman (km) description: | - Y spatial coordinate of Roman in km. + Y barycentric coordinate of the Roman observatory at + the MJD described by meta.ephemeris.time. type: number sdf: special_processing: VALUE_REQUIRED @@ -108,7 +114,8 @@ properties: spatial_z: title: Z Spatial Coordinate of Roman (km) description: | - Z spatial coordinate of Roman in km. + Z barycentric coordinate of the Roman observatory at + the MJD described by meta.ephemeris.time. type: number sdf: special_processing: VALUE_REQUIRED @@ -118,9 +125,11 @@ properties: datatype: float destination: [WFIExposure.spatial_z, GuideWindow.spatial_z] velocity_x: - title: X Component of Roman Velocity (km / s) + title: X Component of Roman Velocity (km/s) description: | - X component of Roman velocity in km / s. + X component of the Roman velocity in a barycentric + system in units of km/s at the MJD described by + meta.ephemeris.time. type: number sdf: special_processing: VALUE_REQUIRED @@ -130,9 +139,11 @@ properties: datatype: float destination: [WFIExposure.velocity_x, GuideWindow.velocity_x] velocity_y: - title: Y Component of Roman Velocity (km / s) + title: Y Component of Roman Velocity (km/s) description: | - Y component of Roman velocity in km / s. + Y component of the Roman velocity in a barycentric + system in units of km/s at the MJD described by + meta.ephemeris.time. type: number sdf: special_processing: VALUE_REQUIRED @@ -142,9 +153,11 @@ properties: datatype: float destination: [WFIExposure.velocity_y, GuideWindow.velocity_y] velocity_z: - title: Z Component of Roman Velocity (km / s) + title: Z Component of Roman Velocity (km/s) description: | - Z component of Roman velocity in km / s. + Y component of the Roman velocity in a barycentric + system in units of km/s at the MJD described by + meta.ephemeris.time. 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 a5ab65be..6128b170 100644 --- a/src/rad/resources/schemas/exposure-1.0.0.yaml +++ b/src/rad/resources/schemas/exposure-1.0.0.yaml @@ -22,7 +22,13 @@ properties: start_time: title: Exposure Start Time (UTC) description: | - The UTC time at the beginning of the exposure. + The UTC time at the beginning of the exposure. The + time is serialized on disk as an International Organization for + Standardization (ISO) 8601-compliant ISOT string, but if opened + in Python with the asdf-astropy package installed, it may be + read as an astropy.time.Time object with all of the associated + methods and transforms available. See the documentation for + astropy.time.Time objects for more information. tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED @@ -31,48 +37,49 @@ properties: archive_catalog: datatype: datetime2 destination: [WFIExposure.exposure_start_time, GuideWindow.exposure_start_time, WFICommon.exposure_start_time] - ngroups: - title: Number of Resultants - description: | - 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 - source: - origin: TBD - archive_catalog: - datatype: int - destination: [WFIExposure.exposure_ngroups, GuideWindow.exposure_ngroups, WFICommon.exposure_ngroups] - nframes: - title: Number of Reads + mid_time: + title: Exposure Mid Time (UTC) description: | - This is the number of science frames that are combined to produce a resultant frame. - type: integer + The UTC time at the midpoint of the exposure. The time + is serialized on disk as an International Organization for + Standardization (ISO) 8601-compliant ISOT string, but if opened + in Python with the asdf-astropy package installed, it may be + read as an astropy.time.Time object with all of the associated + methods and transforms available. See the documentation for + astropy.time.Time objects for more information. + tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED source: origin: TBD archive_catalog: - datatype: int - destination: [WFIExposure.exposure_nframes, GuideWindow.exposure_nframes, WFICommon.exposure_nframes] - data_problem: - title: Data Problem + datatype: datetime2 + destination: [WFIExposure.exposure_mid_time, GuideWindow.exposure_mid_time, + SourceCatalog.exposure_mid_time] + end_time: + title: Exposure End Time (UTC) description: | - A flag indicating an issue with science telemetry. - type: boolean + The UTC time at the end of the exposure. The time is + serialized on disk as an International Organization for + Standardization (ISO) 8601-compliant ISOT string, but if opened + in Python with the asdf-astropy package installed, it may be + read as an astropy.time.Time object with all of the associated + methods and transforms available. See the documentation for + astropy.time.Time objects for more information. + tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED source: origin: TBD archive_catalog: - datatype: nchar(1) - destination: [WFIExposure.exposure_data_problem, GuideWindow.exposure_data_problem, WFICommon.exposure_data_problem] - frame_divisor: - title: Frame Divisor + datatype: datetime2 + destination: [WFIExposure.exposure_end_time, GuideWindow.exposure_end_time, + SourceCatalog.exposure_end_time] + nresultants: + title: Number of Resultants description: | - The number of reads averaged to calculate a resultant. Value depends on - the readout pattern used from the MultiAccum table. + The number of resultant frames in this exposure that + were transmitted to the ground. type: integer sdf: special_processing: VALUE_REQUIRED @@ -80,25 +87,26 @@ properties: origin: TBD archive_catalog: datatype: int - destination: [WFIExposure.exposure_frame_divisor, GuideWindow.exposure_frame_divisor, WFICommon.exposure_frame_divisor] - groupgap: - title: Number of Frames Dropped Between Resultants - description: - The number of reads that are dropped, or not used to calculate a - resultant. - type: integer + destination: [WFIExposure.exposure_nresultants, GuideWindow.exposure_nresultants, WFICommon.exposure_nresultants] + data_problem: + title: Data Problem + description: | + A boolean flag representing if the science telemetry + indicate a problem with the data. + type: boolean sdf: special_processing: VALUE_REQUIRED source: origin: TBD archive_catalog: - datatype: int - destination: [WFIExposure.exposure_groupgap, GuideWindow.exposure_groupgap, WFICommon.exposure_groupgap] + datatype: nchar(1) + destination: [WFIExposure.exposure_data_problem, GuideWindow.exposure_data_problem, WFICommon.exposure_data_problem] frame_time: - title: Time Between Reads (s) + title: Detector Readout Time (s) description: | - The amount of time elapsed between the end of one read and the beginning - of the next. + The readout time in seconds of the Wide Field + Instrument (WFI) detectors. This represents the time between the + start and end of the readout. type: number sdf: special_processing: VALUE_REQUIRED @@ -107,11 +115,12 @@ properties: archive_catalog: datatype: float destination: [WFIExposure.exposure_frame_time, GuideWindow.exposure_frame_time, WFICommon.exposure_frame_time] - group_time: - title: Time Between Resultants (s) + exposure_time: + title: Exposure Time (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 difference in time (in units of seconds) between + the start of the first reset/read and end of the last read in + the readout pattern. type: number sdf: special_processing: VALUE_REQUIRED @@ -119,13 +128,14 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.exposure_group_time, GuideWindow.exposure_group_time, WFICommon.exposure_group_time] - exposure_time: - title: Exposure Time (s) + destination: [WFIExposure.exposure_time, GuideWindow.exposure_time, WFICommon.exposure_time] + effective_exposure_time: + title: Effective 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 difference in time (in units of seconds) between + the midpoints of the first and last science resultants. If + either resultant contains only a single read, then the time at + the end of the read is used rather than the midpoint time. type: number sdf: special_processing: VALUE_REQUIRED @@ -133,39 +143,47 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.exposure_time, GuideWindow.exposure_time, WFICommon.exposure_time] + destination: [WFIExposure.effective_exposure_time, GuideWindow.effective_exposure_time, + SourceCatalog.effective_exposure_time] ma_table_name: - title: MA Table Name + title: Name of the Multi-Accumulation Table description: | - The name of the MultiAccum table used for this exposure, as defined in the - Project Reference Database. + The name of the multi-accumulation (MA) table used for + the exposure. The MA table is also referred to as the readout + pattern. type: string sdf: special_processing: VALUE_REQUIRED source: - origin: TBD + origin: PSS:dms_visit.multi_accum_table_name maxLength: 50 archive_catalog: datatype: nvarchar(50) destination: [WFIExposure.ma_table_name, GuideWindow.ma_table_name, WFICommon.ma_table_name] ma_table_number: - title: MA Table Number + title: Multi-Accumulation Table Identification Number description: | - The number of the MultiAccum table used for this exposure. Used in - matching exposures to their corresponding calibration data. + A unique identification number for the + multi-accumulation (MA) table used for this exposure. The number + comes from the Science Operations Center (SOC) Project Reference + Database (PRD). type: integer sdf: special_processing: VALUE_REQUIRED source: - origin: TBD + origin: PSS:observation_specification.multi_accum_table_number archive_catalog: datatype: smallint destination: [WFIExposure.ma_table_number, GuideWindow.ma_table_number, WFICommon.ma_table_number] read_pattern: title: Read Pattern description: | - Enumeration of detector reads to resultants making up the L1 data - downlinked from the observatory. + The enumeration of detector reads to resultants making + up the Level 1 ramp data cube. The read pattern is nested such + that each grouping of read numbers represents a resultant. For + example, a readout pattern of [[1], [2, 3], [4]] consists of + four reads that were downlinked as three resultants with both + the first and last resultant each containing a single read. type: array items: type: array @@ -178,223 +196,6 @@ properties: archive_catalog: datatype: nvarchar(3500) destination: [WFIExposure.read_pattern, GuideWindow.read_pattern, WFICommon.read_pattern] - id: - title: Visit Exposure ID - description: | - The matching exposure ID for a given visit ID. - type: integer - sdf: - special_processing: VALUE_REQUIRED - source: - origin: TBD - archive_catalog: - datatype: int - destination: [WFIExposure.exposure_id, GuideWindow.exposure_id, - SourceCatalog.exposure_id] - mid_time: - title: Exposure Mid Time (UTC) - description: | - The UTC time at the midpoint of the exposure. - tag: tag:stsci.edu:asdf/time/time-1.* - sdf: - special_processing: VALUE_REQUIRED - source: - origin: TBD - archive_catalog: - datatype: datetime2 - destination: [WFIExposure.exposure_mid_time, GuideWindow.exposure_mid_time, - SourceCatalog.exposure_mid_time] - end_time: - title: Exposure End Time (UTC) - description: | - The UTC time at the end of the exposure. - tag: tag:stsci.edu:asdf/time/time-1.* - sdf: - special_processing: VALUE_REQUIRED - source: - origin: TBD - archive_catalog: - datatype: datetime2 - destination: [WFIExposure.exposure_end_time, GuideWindow.exposure_end_time, - SourceCatalog.exposure_end_time] - start_time_mjd: - title: MJD Start Time (d) - description: | - 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 - source: - origin: TBD - archive_catalog: - datatype: float - destination: [WFIExposure.exposure_start_time_mjd, GuideWindow.exposure_start_time_mjd, - SourceCatalog.exposure_start_time_mjd] - mid_time_mjd: - title: MJD Mid Time (d) - description: | - 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 - source: - origin: TBD - archive_catalog: - datatype: float - destination: [WFIExposure.exposure_mid_time_mjd, GuideWindow.exposure_mid_time_mjd, - SourceCatalog.exposure_mid_time_mjd] - end_time_mjd: - title: MJD End Time (d) - description: | - 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 - source: - origin: TBD - archive_catalog: - datatype: float - destination: [WFIExposure.exposure_end_time_mjd, GuideWindow.exposure_end_time_mjd, - SourceCatalog.exposure_end_time_mjd] - start_time_tdb: - title: TDB Start Time (d) - description: | - The date, in TDB (Barycentric Dynamical Time), at the beginning of this - exposure. - type: number - sdf: - special_processing: VALUE_REQUIRED - source: - origin: TBD - archive_catalog: - datatype: float - destination: [WFIExposure.exposure_start_time_tdb, GuideWindow.exposure_start_time_tdb, - SourceCatalog.exposure_start_time_tdb] - mid_time_tdb: - title: TDB Mid Time (d) - description: | - The date, in TDB (Barycentric Dynamical Time), at the midpoint of this - exposure. - type: number - sdf: - special_processing: VALUE_REQUIRED - source: - origin: TBD - archive_catalog: - datatype: float - destination: [WFIExposure.exposure_mid_time_tdb, GuideWindow.exposure_mid_time_tdb, - SourceCatalog.exposure_mid_time_tdb] - end_time_tdb: - title: TDB End Time (d) - description: | - The date, in TDB (Barycentric Dynamical Time), at the end of this - exposure. - type: number - sdf: - special_processing: VALUE_REQUIRED - source: - origin: TBD - archive_catalog: - datatype: float - destination: [WFIExposure.exposure_end_time_tdb, GuideWindow.exposure_end_time_tdb, - SourceCatalog.exposure_end_time_tdb] - sca_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 - source: - origin: TBD - archive_catalog: - datatype: int - destination: [WFIExposure.exposure_sca_number, GuideWindow.exposure_sca_number, - SourceCatalog.exposure_sca_number] - gain_factor: - title: Gain Factor - type: number - sdf: - special_processing: VALUE_REQUIRED - source: - origin: TBD - archive_catalog: - datatype: float - destination: [WFIExposure.exposure_gain_factor, GuideWindow.exposure_gain_factor, - SourceCatalog.exposure_gain_factor] - integration_time: - 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 - source: - origin: TBD - archive_catalog: - datatype: float - destination: [WFIExposure.exposure_integration_time, GuideWindow.exposure_integration_time, - SourceCatalog.exposure_integration_time] - elapsed_exposure_time: - title: Elapsed Exposure Time (s) - description: | - The amount of time elapsed between an exposure's first and last science - reads. - type: number - sdf: - special_processing: VALUE_REQUIRED - source: - origin: TBD - archive_catalog: - datatype: float - destination: [WFIExposure.elapsed_exposure_time, GuideWindow.elapsed_exposure_time, - SourceCatalog.elapsed_exposure_time] - effective_exposure_time: - 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 - source: - origin: TBD - archive_catalog: - datatype: float - destination: [WFIExposure.effective_exposure_time, GuideWindow.effective_exposure_time, - SourceCatalog.effective_exposure_time] - duration: - title: Exposure Duration (s) - description: | - 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 - source: - origin: TBD - archive_catalog: - datatype: float - destination: [WFIExposure.exposure_duration, GuideWindow.exposure_duration, - SourceCatalog.exposure_duration] - level0_compressed: - title: Level 0 Compression - description: | - A flag indicating that the exposure has data that was decompressed by the - ground system. - type: boolean - sdf: - special_processing: VALUE_REQUIRED - source: - origin: TBD - archive_catalog: - datatype: nchar(1) - destination: [WFIExposure.exposure_level0_compressed, GuideWindow.exposure_level0_compressed, - SourceCatalog.exposure_level0_compressed] truncated: title: Truncated MA Table description: | @@ -408,27 +209,11 @@ properties: datatype: nchar(1) destination: [WFIExposure.exposure_truncated, SourceCatalog.exposure_truncated] -required: [type, start_time, - ngroups, nframes, data_problem, - frame_divisor, groupgap, frame_time, group_time, exposure_time, - ma_table_name, ma_table_number, read_pattern, id, - mid_time, end_time, - start_time_mjd, mid_time_mjd, end_time_mjd, - start_time_tdb, mid_time_tdb, end_time_tdb, - sca_number, - gain_factor, integration_time, elapsed_exposure_time, - effective_exposure_time, duration, - level0_compressed] -propertyOrder: [type, start_time, - ngroups, nframes, data_problem, - frame_divisor, groupgap, frame_time, group_time, exposure_time, - ma_table_name, ma_table_number, read_pattern, id, - mid_time, end_time, - start_time_mjd, mid_time_mjd, end_time_mjd, - start_time_tdb, mid_time_tdb, end_time_tdb, - sca_number, - gain_factor, integration_time, elapsed_exposure_time, - effective_exposure_time, duration, - level0_compressed, truncated] +required: [type, start_time, mid_time, end_time, nresultants, data_problem, + frame_time, exposure_time, effective_exposure_time, ma_table_name, + ma_table_number, read_pattern, truncated] +propertyOrder: [type, start_time, mid_time, end_time, nresultants, data_problem, + frame_time, exposure_time, effective_exposure_time, ma_table_name, + ma_table_number, read_pattern, truncated] flowStyle: block ... 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 821040b5..acfe05e5 100644 --- a/src/rad/resources/schemas/exposure_type-1.0.0.yaml +++ b/src/rad/resources/schemas/exposure_type-1.0.0.yaml @@ -6,10 +6,12 @@ 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. + The type of the exposure. Wide Field Instrument (WFI) + imaging mode observations have type WFI_IMAGE, while the + spectroscopic mode may be either WFI_GRISM or WFI_PRISM + depending on the selected optical element. Other values are + related to either internal calibration or engineering + observations. type: string enum: diff --git a/src/rad/resources/schemas/guidestar-1.0.0.yaml b/src/rad/resources/schemas/guidestar-1.0.0.yaml index 6d30f746..b48670ff 100644 --- a/src/rad/resources/schemas/guidestar-1.0.0.yaml +++ b/src/rad/resources/schemas/guidestar-1.0.0.yaml @@ -3,14 +3,19 @@ $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 and Guide Window Information type: object properties: - gw_id: - title: Guide Star Window Identifier + guide_window_id: + title: Guide Window Identifier description: | - Identification of the Guide Star Window. + A unique identification number of the guide window. + This identifier combines the visit identifier and guide star + acquisition number, and is set in the visit information uplinked + to the observatory. As the number may be zero-padded, this value + is saved as a string. See technical report Roman-STScI-000193 + "Roman Programmatic Data Identification" for more information. type: string sdf: special_processing: VALUE_REQUIRED @@ -19,8 +24,8 @@ properties: maxLength: 20 archive_catalog: datatype: nvarchar(20) - destination: [WFIExposure.gw_id, GuideWindow.gw_id, WFICommon.gw_id] - gw_fgs_mode: + destination: [WFIExposure.guide_window_id, GuideWindow.guide_window_id, WFICommon.guide_window_id] + guide_mode: $ref: guidewindow_modes-1.0.0 sdf: special_processing: VALUE_REQUIRED @@ -29,38 +34,49 @@ properties: maxLength: 18 archive_catalog: datatype: nvarchar(18) - destination: [WFIExposure.gw_fgs_mode, GuideWindow.gw_fgs_mode, WFICommon.gw_fgs_mode] + destination: [WFIExposure.guide_mode, GuideWindow.guide_mode, WFICommon.guide_mode] data_start: - title: Guide Data Start Time (MJD) + title: Guide Data Start Time (UTC) description: | - Start time of the guide window data taken for this exposure as a Modified - Julian Date. - type: number + The UTC time at the beginning of the guide window + data. The time is serialized on disk as an International + Organization for Standardization (ISO) 8601-compliant ISOT + string, but if opened in Python with the asdf-astropy package + installed, it may be read as an astropy.time.Time object with + all of the associated methods and transforms available. See the + documentation for astropy.time.Time objects for more + information. + tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED source: origin: TBD archive_catalog: - datatype: float + datatype: datetime2 destination: [WFIExposure.data_start, GuideWindow.data_start, WFICommon.data_start] data_end: - title: Guide Data End Time (MJD) + title: Guide Data End Time (UTC) description: | - End time of the guide window data taken for this exposure as a Modified - Julian Date. - type: number + The UTC time at the end of the guide window data. The + time is serialized on disk as an International Organization for + Standardization (ISO) 8601-compliant ISOT string, but if opened + in Python with the asdf-astropy package installed, it may be + read as an astropy.time.Time object with all of the associated + methods and transforms available. See the documentation for + astropy.time.Time objects for more information. + tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED source: origin: TBD archive_catalog: - datatype: float + datatype: datetime2 destination: [WFIExposure.data_end, GuideWindow.data_end, WFICommon.data_end] - gw_window_xstart: + window_xstart: 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. + Minimum X position in pixels in the science coordinate + frame of all tracking guide windows in this exposure. type: integer sdf: special_processing: VALUE_REQUIRED @@ -68,12 +84,12 @@ properties: origin: Science Data Formatting archive_catalog: datatype: int - destination: [WFIExposure.gw_window_xstart, WFICommon.gw_window_xstart] - gw_window_ystart: + destination: [WFIExposure.window_xstart, WFICommon.window_xstart] + window_ystart: 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. + Minimum Y position in pixels in the science coordinate + frame of all tracking guide windows in this exposure. type: integer sdf: special_processing: VALUE_REQUIRED @@ -81,12 +97,12 @@ properties: origin: Science Data Formatting archive_catalog: datatype: int - destination: [WFIExposure.gw_window_ystart, WFICommon.gw_window_ystart] - gw_window_xstop: + destination: [WFIExposure.window_ystart, WFICommon.window_ystart] + window_xstop: 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. + Maximum X position in pixels in the science coordinate + frame of all tracking guide windows in this exposure. type: integer sdf: special_processing: VALUE_REQUIRED @@ -94,12 +110,12 @@ properties: origin: Science Data Formatting archive_catalog: datatype: int - destination: [WFIExposure.gw_window_xstop, WFICommon.gw_window_xstop] - gw_window_ystop: - title: Guide Window Y Stop Position (pixels) + destination: [WFIExposure.window_xstop, WFICommon.window_xstop] + window_ystop: + title: Guide Window Y Start Position (pixels) description: | - Maximum Y position in the science coordinate frame of all tracking guide - windows in this exposure measured in pixels + Maximum Y position in pixels in the science coordinate + frame of all tracking guide windows in this exposure. type: integer sdf: special_processing: VALUE_REQUIRED @@ -107,12 +123,13 @@ properties: origin: Science Data Formatting archive_catalog: datatype: int - destination: [WFIExposure.gw_window_ystop, WFICommon.gw_window_ystop] - gw_window_xsize: + destination: [WFIExposure.window_ystop, WFICommon.window_ystop] + window_xsize: 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. + Size of a single tracking guide window in this + exposure measured along the science coordinate frame X axis in + units of pixels. type: integer sdf: special_processing: VALUE_REQUIRED @@ -120,12 +137,13 @@ properties: origin: Science Data Formatting archive_catalog: datatype: int - destination: [WFIExposure.gw_window_xsize, WFICommon.gw_window_xsize] - gw_window_ysize: + destination: [WFIExposure.window_xsize, WFICommon.window_xsize] + window_ysize: 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. + Size of a single tracking guide window in this + exposure measured along the science coordinate frame Y axis in + units of pixels. type: integer sdf: special_processing: VALUE_REQUIRED @@ -133,11 +151,12 @@ properties: origin: Science Data Formatting archive_catalog: datatype: int - destination: [WFIExposure.gw_window_ysize, WFICommon.gw_window_ysize] - gs_id: - title: Guide Star Identifier from Guide Star Catalog + destination: [WFIExposure.window_ysize, WFICommon.window_ysize] + guide_star_id: + title: Guide Star Identifier description: | - Identification of the guide star from the guide star catalog. + Identification of the guide star from the Guide Star + Catalog (GSC). type: string sdf: special_processing: VALUE_REQUIRED @@ -146,11 +165,11 @@ properties: maxLength: 20 archive_catalog: datatype: nvarchar(20) - destination: [WFIExposure.gs_id, GuideWindow.gs_id] - gs_catalog_version: - title: Version of the Guide Star Catalog + destination: [WFIExposure.guide_star_id, GuideWindow.guide_star_id] + gsc_version: + title: Guide Star Catalog Version description: | - Version identifier of the guide star catalog used for the observation. + Version number of the Guide Star Catalog (GSC). type: string sdf: special_processing: VALUE_REQUIRED @@ -159,12 +178,12 @@ properties: maxLength: 20 archive_catalog: datatype: nvarchar(20) - destination: [WFIExposure.gs_catalog_version] - gs_ra: + destination: [WFIExposure.gsc_version] + ra: title: Guide Star Right Ascension (deg) description: | - Right ascension of the guide star from the guide star catalog in units of - degrees. + Right ascension of the guide star from the Guide Star + Catalog (GSC) in units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -172,12 +191,12 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_ra, GuideWindow.gs_ra] - gs_dec: + destination: [WFIExposure.ra, GuideWindow.ra] + dec: title: Guide Star Declination (deg) description: | - Declination of the guide star from the guide star catalog in units of - degrees. + Declination of the guide star from the Guide Star + Catalog (GSC) in units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -185,12 +204,12 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_dec, GuideWindow.gs_dec] - gs_ura: + destination: [WFIExposure.dec, GuideWindow.dec] + ra_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. + Uncertainty in the guide star right ascension from the + Guide Star Catalog (GSC) in units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -198,12 +217,12 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_ura, GuideWindow.gs_ura] - gs_udec: + destination: [WFIExposure.ra_uncertainty, GuideWindow.ra_uncertainty] + dec_uncertainty: title: Guide Star Declination Uncertainty (deg) description: | - Uncertainty in the guide star declination from the guide star catalog in - units of degrees. + Uncertainty in the guide star declination from the + Guide Star Catalog (GSC) in units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -211,12 +230,12 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_udec, GuideWindow.gs_udec] - gs_mag: + destination: [WFIExposure.dec_uncertainty, GuideWindow.dec_uncertainty] + fgs_magnitude: title: Guide Star Instrumental Magnitude description: | - Predicted instrumental magnitude of the guide star from the guide star - catalog. + Predicted instrumental magnitude of the guide star + from the Guide Star Catalog (GSC). type: number sdf: special_processing: VALUE_REQUIRED @@ -224,12 +243,12 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_mag, GuideWindow.gs_mag] - gs_umag: + destination: [WFIExposure.fgs_magnitude, GuideWindow.fgs_magnitude] + fgs_magnitude_uncertainty: title: Guide Star Instrumental Magnitude Uncertainty description: | - Uncertainty in the predicted instrumental magnitude of the guide star from - the guide star catalog. + Uncertainty in the predicted instrumental magnitude of + the guide star from the Guide Star Catalog (GSC). type: number sdf: special_processing: VALUE_REQUIRED @@ -237,12 +256,12 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_umag, GuideWindow.gs_umag] - gs_ctd_x: - title: Guide Star Centroid X Position (arcsec) + destination: [WFIExposure.fgs_magnitude_uncertainty, GuideWindow.fgs_magnitude_uncertainty] + centroid_x: + title: Guide Star Centroid X Position (pixels) description: | - Centroid of the guide star position longa the X axis of the guider ideal - frame measured in units of arcseconds. + Average centroid position of the guide star along the + science X axis in units of pixels. type: number sdf: special_processing: VALUE_REQUIRED @@ -250,12 +269,12 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_ctd_x, GuideWindow.gs_ctd_x] - gs_ctd_y: - title: Guide Star Centroid Y Position (arcsec) + destination: [WFIExposure.centroid_x, GuideWindow.centroid_x] + centroid_y: + title: Guide Star Centroid Y Position (pixels) description: | - Centroid of the guide star position along the Y axis of the guider ideal - frame measured in units of arcseconds. + Average centroid position of the guide star along the + science Y axis in units of pixels. type: number sdf: special_processing: VALUE_REQUIRED @@ -263,12 +282,12 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_ctd_y, GuideWindow.gs_ctd_y] - gs_ctd_ux: - title: Guide Star Centroid X Position Uncertainty (arcsec) + destination: [WFIExposure.centroid_y, GuideWindow.centroid_y] + centroid_x_uncertainty: + title: Guide Star Centroid X Position Uncertainty (pixels) description: | - Uncertainty in the centroid of the guide star position along the X axis of - the guider ideal frame measured in units of arcseconds + Uncertainty in the average centroid position of the + guide star along the science X axis in units of pixels. type: number sdf: special_processing: VALUE_REQUIRED @@ -276,12 +295,12 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_ctd_ux, GuideWindow.gs_ctd_ux] - gs_ctd_uy: - title: Guide Star Centroid Y Position Uncertainty (arcsec) + destination: [WFIExposure.centroid_x_uncertainty, GuideWindow.centroid_x_uncertainty] + centroid_y_uncertainty: + title: Guide Star Centroid Y Position Uncertainty (pixels) description: | - Uncertainty in the centroid of the guide star position along the Y axis of - the guider ideal frame measured in units of arcseconds. + Uncertainty in the average centroid position of the + guide star along the science Y axis in units of pixels. type: number sdf: special_processing: VALUE_REQUIRED @@ -290,10 +309,11 @@ properties: archive_catalog: datatype: float destination: [WFIExposure.gs_ctd_uy, GuideWindow.gs_ctd_uy] - gs_epoch: + epoch: title: Guide Star Coordinates Epoch description: | - Epoch of the celestial coordinates of the guide star. + Epoch of the celestial coordinates of the guide star + from the Guide Star Catalog (GSC). type: string sdf: special_processing: VALUE_REQUIRED @@ -302,12 +322,13 @@ properties: maxLength: 10 archive_catalog: datatype: nvarchar(10) - destination: [WFIExposure.gs_epoch, GuideWindow.gs_epoch] - gs_mura: + destination: [WFIExposure.epoch, GuideWindow.epoch] + proper_motion_ra: 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. + Proper motion of the guide star in right ascension + from the Guide Star Catalog (GSC) measured in units of + milli-arcseconds per year. type: number sdf: special_processing: VALUE_REQUIRED @@ -315,12 +336,13 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_mura, GuideWindow.gs_mura] - gs_mudec: + destination: [WFIExposure.proper_motion_ra, GuideWindow.proper_motion_ra] + proper_motion_dec: 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. + Proper motion of the guide star in declination from + the Guide Star Catalog (GSC) measured in units of + milli-arcseconds per year. type: number sdf: special_processing: VALUE_REQUIRED @@ -328,11 +350,13 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_mudec, GuideWindow.gs_mudec] - gs_para: - title: Guide Star Annual Parallax + destination: [WFIExposure.proper_motion_dec, GuideWindow.proper_motion_dec] + parallax: + title: Guide Star Parallax (mas) description: | - Annual parallax of the guide star from the guide star catalog. + Annual trigonometric parallax of the guide star from + the Guide Star Catalog (GSC) measured in units of + milli-arcseconds. type: number sdf: special_processing: VALUE_REQUIRED @@ -340,13 +364,14 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_para, GuideWindow.gs_para] - gs_pattern_error: + destination: [WFIExposure.parallax, GuideWindow.parallax] + centroid_rms: 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 + Root mean square (RMS) of the guide star position in + the tracking guide window 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: @@ -355,22 +380,18 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.gs_pattern_error, GuideWindow.gs_pattern_error] -propertyOrder: [gw_id, gw_fgs_mode, - data_start, data_end, gw_window_xstart, - gw_window_ystart, gw_window_xstop, gw_window_ystop, gw_window_xsize, - gw_window_ysize, - gs_id, gs_catalog_version, gs_ra, gs_dec, - gs_ura, gs_udec, gs_mag, gs_umag, - gs_ctd_x, gs_ctd_y, gs_ctd_ux, gs_ctd_uy, - gs_epoch, gs_mura, gs_mudec, gs_para, gs_pattern_error] -required: [gw_id, gw_fgs_mode, - data_start, data_end, gw_window_xstart, - gw_window_ystart, gw_window_xstop, gw_window_ystop, gw_window_xsize, - gw_window_ysize, - gs_id, gs_catalog_version, gs_ra, gs_dec, - gs_ura, gs_udec, gs_mag, gs_umag, - gs_ctd_x, gs_ctd_y, gs_ctd_ux, gs_ctd_uy, - gs_epoch, gs_mura, gs_mudec, gs_para, gs_pattern_error] + destination: [WFIExposure.centroid_rms, GuideWindow.centroid_rms] +propertyOrder: [guide_window_id, guide_mode, data_start, data_end, + window_xstart, window_ystart, window_xstop, window_ystop, window_xsize, + window_ysize, guide_star_id, gsc_version, ra, dec, ra_uncertainty, + dec_uncertainty, fgs_magnitude, fgs_magnitude_uncertainty, centroid_x, + centroid_y, centroid_x_uncertainty, centroid_y_uncertainty, epoch, + proper_motion_ra, proper_motion_dec, parallax, centroid_rms] +required: [guide_window_id, guide_mode, data_start, data_end, + window_xstart, window_ystart, window_xstop, window_ystop, window_xsize, + window_ysize, guide_star_id, gsc_version, ra, dec, ra_uncertainty, + dec_uncertainty, fgs_magnitude, fgs_magnitude_uncertainty, centroid_x, + centroid_y, centroid_x_uncertainty, centroid_y_uncertainty, epoch, + proper_motion_ra, proper_motion_dec, parallax, centroid_rms] flowStyle: block ... 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 37785cdc..34c4c0f2 100644 --- a/src/rad/resources/schemas/guidewindow_modes-1.0.0.yaml +++ b/src/rad/resources/schemas/guidewindow_modes-1.0.0.yaml @@ -5,9 +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 Mode description: | - An enumerated collection of available guidestar and guidewindow modes. + Type of guide window mode used during the exposure. type: string enum: - WIM-ACQ diff --git a/src/rad/resources/schemas/individual_image_meta-1.0.0.yaml b/src/rad/resources/schemas/individual_image_meta-1.0.0.yaml index 53cf4719..6fb7db66 100644 --- a/src/rad/resources/schemas/individual_image_meta-1.0.0.yaml +++ b/src/rad/resources/schemas/individual_image_meta-1.0.0.yaml @@ -11,9 +11,13 @@ properties: description: | Table of basic level 2 metadata. tag: tag:astropy.org:astropy/table/table-1.* - aperture: + background: description: | - Table of aperture level 2 metadata. + Table of background level 2 metadata. + tag: tag:astropy.org:astropy/table/table-1.* + cal_logs: + description: | + Table of cal_logs level 2 metadata. tag: tag:astropy.org:astropy/table/table-1.* cal_step: description: | @@ -31,9 +35,9 @@ properties: description: | Table of exposure level 2 metadata. tag: tag:astropy.org:astropy/table/table-1.* - guidestar: + guide_star: description: | - Table of guidestar level 2 metadata. + Table of guide_star level 2 metadata. tag: tag:astropy.org:astropy/table/table-1.* instrument: description: | @@ -43,6 +47,10 @@ properties: description: | Table of observation level 2 metadata. tag: tag:astropy.org:astropy/table/table-1.* + outlier_detection: + description: | + Table of outlier_detection level 2 metadata. + tag: tag:astropy.org:astropy/table/table-1.* photometry: description: | Table of photometry level 2 metadata. @@ -55,13 +63,17 @@ properties: description: | Table of program level 2 metadata. tag: tag:astropy.org:astropy/table/table-1.* + rcs: + description: | + Table of rcs level 2 metadata. + tag: tag:astropy.org:astropy/table/table-1.* ref_file: description: | Table of ref_file level 2 metadata. tag: tag:astropy.org:astropy/table/table-1.* - target: + source_detection: description: | - Table of target level 2 metadata. + Table of source_detection level 2 metadata. tag: tag:astropy.org:astropy/table/table-1.* velocity_aberration: description: | @@ -76,8 +88,8 @@ properties: Table of wcsinfo level 2 metadata. tag: tag:astropy.org:astropy/table/table-1.* flowStyle: block -propertyOrder: [basic, aperture, cal_step, coordinates, ephemeris, -exposure, guidestar, instrument, observation, photometry, -pointing, program, ref_file, target, velocity_aberration, -visit, wcsinfo] +propertyOrder: [basic, background, cal_step, cal_logs, coordinates, ephemeris, + exposure, guide_star, instrument, observation, outlier_detection, photometry, + pointing, program, rcs, ref_file, source_detection, velocity_aberration, + visit, wcsinfo] ... diff --git a/src/rad/resources/schemas/l2_cal_step-1.0.0.yaml b/src/rad/resources/schemas/l2_cal_step-1.0.0.yaml index c7fdd647..83063202 100644 --- a/src/rad/resources/schemas/l2_cal_step-1.0.0.yaml +++ b/src/rad/resources/schemas/l2_cal_step-1.0.0.yaml @@ -7,10 +7,10 @@ title: Level 2 Calibration Status type: object properties: assign_wcs: - title: Assign WCS Step + title: Assign World Coordinate System (WCS) Step description: | - Step in ROMANCAL that assigns a World Coordinate System (WCS) object to a - science image. + Step in romancal that assigns a World Coordinate + System (WCS) object to a science image. type: string enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE'] maxLength: 15 @@ -18,12 +18,12 @@ properties: datatype: nvarchar(15) destination: [ScienceRefData.s_assign_wcs] flat_field: - title: Flat Fielding Step + title: Flat Field Correction Step description: | - 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. + 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 based on the pixel + response. type: string enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE'] maxLength: 15 @@ -33,8 +33,9 @@ properties: dark: title: Dark Current Subtraction Step description: | - Step in ROMANCAL performing the dark current correction by subtracting - dark current reference data from science data. + Step in romancal that performs a correction for the + dark current by subtracting the dark reference data from the + science data. type: string enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE'] maxLength: 15 @@ -42,10 +43,10 @@ properties: datatype: nvarchar(15) destination: [ScienceRefData.s_dark] dq_init: - title: Initialization of the Data Quality Extension Step + title: Data Quality Initialization Step description: | - Step in ROMANCAL in which the pixeldq attribute of the input data model - using the MASK reference file is initialized. + Step in romancal that initializes the data quality + array and masks known bad pixels. type: string enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE'] maxLength: 15 @@ -63,22 +64,11 @@ properties: archive_catalog: datatype: nvarchar(15) destination: [ScienceRefData.s_flux] - jump: - 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'] - maxLength: 15 - archive_catalog: - datatype: nvarchar(15) - destination: [ScienceRefData.s_jump] linearity: - title: Linearity Correction Step + title: Classical Linearity Correction Step description: | - Step in ROMANCAL which performs a correction for the classical non-linear - detector response. + Step in romancal that linearizes the ramp data to + correct for deviations from a linear response. type: string enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE'] maxLength: 15 @@ -86,10 +76,10 @@ properties: datatype: nvarchar(15) destination: [ScienceRefData.s_linearity] photom: - title: Photometric Calibration Step + title: Populate Photometric Keywords Step description: | - Step in ROMANCAL that adds photometric calibrations to the metadata of a - data product. + Step in romancal that populates photometric + calibration information in the metadata of the science file. type: string enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE'] maxLength: 15 @@ -99,7 +89,8 @@ properties: source_detection: title: Source Detection Step description: | - Step in ROMANCAL to detect point sources in an image and catalog them. + Step in romancal that detects point sources in an + image for use in astrometric alignment. type: string enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE'] maxLength: 15 @@ -107,10 +98,10 @@ properties: datatype: nvarchar(15) destination: [ScienceRefData.s_source_detection] ramp_fit: - title: Ramp Fit Step + title: Ramp Fitting Step description: | - Step in ROMANCAL to fit the counts versus time with a straight line and - thus estimate the count rate for each pixel. + Step in romancal that fits a slope to each pixel to + compute the count rate. type: string enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE'] maxLength: 15 @@ -120,8 +111,9 @@ properties: refpix: 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. + Step in romancal that corrects science pixels for + additional signal from the readout electronics (e.g., 1/f noise) + using the reference pixels. type: string enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE'] maxLength: 15 @@ -131,9 +123,8 @@ properties: saturation: title: Saturation Identification Step description: | - Step in ROMANCAL which sets pixel flags to label that a pixel is at or - above the saturation threshold. As part of this step, pixels that are zero - or negative are also flagged. + Step in romancal that sets data quality flags for + pixels at or above the saturation threshold. type: string enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE'] maxLength: 15 @@ -153,9 +144,10 @@ properties: 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. + Step in romancal that compares the positions of point + sources in the image with coordinates from an astrometric + catalog and, if necessary, corrects the World Coordinate System + (WCS) alignment. type: string enum: ['N/A', 'COMPLETE', 'SKIPPED', 'INCOMPLETE'] maxLength: 15 @@ -173,10 +165,10 @@ properties: archive_catalog: datatype: nvarchar(15) destination: [ScienceRefData.s_skymatch] -propertyOrder: [assign_wcs, flat_field, flux, dark, dq_init, jump, linearity, photom, source_detection, - outlier_detection, ramp_fit, refpix, saturation, skymatch, tweakreg] +propertyOrder: [dq_init, saturation, refpix, linearity, dark, ramp_fit, assign_wcs, + flat_field, photom, source_detection, tweakreg, flux, skymatch, outlier_detection] flowStyle: block -required: [assign_wcs, flat_field, flux, dark, dq_init, jump, linearity, outlier_detection, photom, +required: [assign_wcs, dark, dq_init, flat_field, flux, linearity, outlier_detection, photom, source_detection, ramp_fit, refpix, saturation, skymatch, tweakreg] additionalProperties: true ... diff --git a/src/rad/resources/schemas/mosaic_basic-1.0.0.yaml b/src/rad/resources/schemas/mosaic_basic-1.0.0.yaml index d3622741..bba9e16b 100644 --- a/src/rad/resources/schemas/mosaic_basic-1.0.0.yaml +++ b/src/rad/resources/schemas/mosaic_basic-1.0.0.yaml @@ -93,7 +93,7 @@ properties: program: title: Program number, defined range is 1..18445; included in obs_id and visit_id as 'PPPPP'. - type: string + type: integer sdf: special_processing: VALUE_REQUIRED source: diff --git a/src/rad/resources/schemas/observation-1.0.0.yaml b/src/rad/resources/schemas/observation-1.0.0.yaml index 7ab91183..8d020218 100644 --- a/src/rad/resources/schemas/observation-1.0.0.yaml +++ b/src/rad/resources/schemas/observation-1.0.0.yaml @@ -6,16 +6,18 @@ id: asdf://stsci.edu/datamodels/roman/schemas/observation-1.0.0 title: Observation Identifiers type: object properties: - obs_id: + observation_id: 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 + + The format of the programmatic observation identifier + is "PPPPPCCAAASSSOOOVVVggsaaeee" where "PPPPP" is the program + number, "CC" is the execution plan number, "AAA" is the pass + number, "SSS" is the segment number, "OOO" is the observation + number, "VVV" is the visit number, "gg" is the visit file group, + "s" is the visit file sequence, "aa" is the visit file activity, + and "eeee" is the exposure number. The observation identifier is + the complete concatenation of the visit_id + + visit_file_statement (visit_file_group + visit_file_sequence + visit_file_activity) + exposure. type: string sdf: @@ -25,14 +27,14 @@ properties: maxLength: 28 archive_catalog: datatype: nvarchar(28) - destination: [WFIExposure.obs_id, GuideWindow.obs_id] + destination: [WFIExposure.observation_id, GuideWindow.observation_id] visit_id: 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. + A unique identifier for a visit. The format is "PPPPPCCAAASSSOOOVVV" where + "PPPPP" is the program number, "CC" is the execution plan number, "AAA" is the pass number, + "SSS" is the segment number, "OOO" is the observation number, and "VVV" is the + visit number. type: string sdf: special_processing: VALUE_REQUIRED @@ -45,9 +47,12 @@ properties: program: 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 + Identifier for the observing program. A program is an + approved specification for a science, calibration, or + engineering investigation to be pursued using Roman Space + Telescope mission resources. The allowed range of program + numbers is 00001 to 18445 inclusive. + type: integer sdf: special_processing: VALUE_REQUIRED source: @@ -56,10 +61,14 @@ properties: datatype: int destination: [WFIExposure.program, GuideWindow.program] execution_plan: - title: Execution Plan + title: Execution Plan Number description: | - The defined range of the execution plan within the program is 01 to 99; - included in obs_id and visit_id as 'CC'. + Identifier for the execution plan. An execution plan + is a version of the complete set of activities for a survey. A + survey may include portions of multiple execution plans. A new + execution plan is required whenever there is a change in the + program. The allowed range of execution plan numbers is 01 to 99 + inclusive. type: integer sdf: special_processing: VALUE_REQUIRED @@ -71,8 +80,12 @@ properties: pass: 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'. + Identifier for the pass. A pass is the collection of + activities generated from each iteration of a pass plan in the + Astronomer's Proposal Tool (APT). Multiple Passes may be + generated from the same Pass Plan to allow repetition or execute + at different orientations (via special requirements). The + allowed range of pass numbers is 001 to 999 inclusive. type: integer sdf: special_processing: VALUE_REQUIRED @@ -84,8 +97,12 @@ properties: segment: 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'. + Identifier for the segment. A segment is the sequence + of activities produced by each iteration of an Astronomer's + Proposal Tool (APT) segment plan in a pass. A segment may + include multiple traversals of mosaic pattern(s), with element + wheel moves occurring between observations. The allowed range of + segment numbers is 001 to 999 inclusive. type: integer sdf: special_processing: VALUE_REQUIRED @@ -97,8 +114,11 @@ properties: observation: 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'. + Identifier for the observation. An observation is a + single traversal of a mosaic pattern, using a single, constant + instrument configuration (i.e., with no element wheel moves). + The allowed range of observation numbers is 001 to 999 + inclusive. type: integer sdf: special_processing: VALUE_REQUIRED @@ -110,8 +130,11 @@ properties: visit: 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'. + A visit is the smallest scheduling unit for Roman, + which is a sequence of exposures executed without interruption, + including dither patterns. A visit corresponds to one tile of + the selected mosaic pattern. The allowed range of visit numbers + is 001 to 999 inclusive. type: integer sdf: special_processing: VALUE_REQUIRED @@ -123,9 +146,11 @@ properties: visit_file_group: 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'. + The visit file group identifies the sequence group + within the visit file. The allowed range of visit file group + numbers is 01 to 99 inclusive. type: integer + maxLength: 3 sdf: special_processing: VALUE_REQUIRED source: @@ -136,8 +161,11 @@ properties: visit_file_sequence: 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'. + The visit file sequence identifies the sequence within + the visit file group. A value of 1 indicates a prime instrument + exposure, and a value greater than 1 indicates a parallel + instrument exposure. The allowed range of visit file sequence + numbers of 1 to 5 inclusive. type: integer sdf: special_processing: VALUE_REQUIRED @@ -149,8 +177,9 @@ properties: visit_file_activity: 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'. + The visit file activity number identifies the activity + within the visit file sequence. The allowed range of visit file + activity numbers is 01 to 99 inclusive. type: string sdf: special_processing: VALUE_REQUIRED @@ -163,8 +192,10 @@ properties: exposure: 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'. + An exposure is a single multi-accumulation (MA) table + sequence of the detector array at a single dither point in the + dither pattern. The allowed range of exposure numbers is 0001 to + 9999 inclusive. type: integer sdf: special_processing: VALUE_REQUIRED @@ -173,53 +204,11 @@ properties: archive_catalog: datatype: int destination: [WFIExposure.observation_exposure, GuideWindow.observation_exposure] - template: - title: Observation Template - description: | - The template used to design this observation. - type: string - sdf: - special_processing: VALUE_REQUIRED - source: - origin: PSS:dms_visit.template - maxLength: 50 - archive_catalog: - datatype: nvarchar(50) - destination: [WFIExposure.template, GuideWindow.template] - observation_label: - title: Observation Label - description: | - The label given by the proposer to describe the observation. - type: string - sdf: - special_processing: VALUE_REQUIRED - source: - origin: TBD - archive_catalog: - datatype: nvarchar(max) - destination: [WFIExposure.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] - maxLength: 15 - archive_catalog: - datatype: nvarchar(15) - destination: [WFIExposure.survey, GuideWindow.survey] -propertyOrder: [obs_id, visit_id, program, - execution_plan, pass, observation, segment, - visit, visit_file_group, visit_file_sequence, - visit_file_activity, exposure, template, - observation_label, survey] +propertyOrder: [observation_id, visit_id, program, execution_plan, pass, segment, + observation, visit, visit_file_group, visit_file_sequence, + visit_file_activity, exposure] flowStyle: block -required: [obs_id, visit_id, program, - execution_plan, pass, observation, segment, - visit, visit_file_group, visit_file_sequence, - visit_file_activity, exposure, template, - observation_label, survey] +required: [observation_id, visit_id, program, execution_plan, pass, segment, + observation, visit, visit_file_group, visit_file_sequence, + visit_file_activity, exposure] ... diff --git a/src/rad/resources/schemas/photometry-1.0.0.yaml b/src/rad/resources/schemas/photometry-1.0.0.yaml index 3aad104e..b05b4603 100644 --- a/src/rad/resources/schemas/photometry-1.0.0.yaml +++ b/src/rad/resources/schemas/photometry-1.0.0.yaml @@ -7,9 +7,14 @@ title: Photometry Information type: object properties: conversion_megajanskys: - title: Flux Density Producing 1 count per second (MJy / steradian) + title: Zeropoint Flux (MJy/sr) description: | - The conversion from DN / s to MJy / steradian. + The flux density (in units of megaJanskys per + steradian; MJy/sr) that produces an instrumental count rate of 1 + data number (DN) per second. A unit change to microJanskys per + square arcsecond (uJy/arcsec^2) can be made by multiplying this + value by the ratio (1 x 10^12 MJy/uJy) / (4.254517 x 10^10 + arcsec^2/sr) = 23.50443054. anyOf: - type: number - type: "null" @@ -18,47 +23,15 @@ properties: datatype: float destination: [WFIExposure.conversion_megajanskys, WFIMosaic.conversion_megajanskys, SourceCatalog.conversion_megajanskys] - conversion_microjanskys: - title: Flux Density Producing 1 count per second (uJy / arcsec^2) - description: | - The conversion from DN / s to uJy / arcsec^2. - anyOf: - - type: number - - type: "null" - unit: "uJy.arcsec**-2" - archive_catalog: - datatype: float - destination: [WFIExposure.conversion_microjanskys, WFIMosaic.conversion_microjanskys, - SourceCatalog.conversion_microjanskys] - pixelarea_steradians: - title: Nominal Pixel Area (steradians) - description: | - The average pixel area in units of steradians. - anyOf: - - type: number - - type: "null" - unit: "sr" - archive_catalog: - datatype: float - destination: [WFIExposure.pixelarea_steradians, WFIMosaic.pixelarea_steradians, - SourceCatalog.pixelarea_steradians] - pixelarea_arcsecsq: - title: Nominal Pixel Area (arcsec^2) - description: | - The average pixel area in units of square arcseconds. - anyOf: - - type: number - - type: "null" - unit: "arcsec**2" - archive_catalog: - datatype: float - destination: [WFIExposure.pixelarea_arcsecsq, WFIMosaic.pixelarea_arcsecsq, - SourceCatalog.pixelarea_arcsecsq] conversion_megajanskys_uncertainty: - title: Uncertainty in Flux Density Conversion (from DN / s to MJy / steradians) + title: Zeropoint Flux Uncertainty (MJy/sr) description: | - The uncertainty in the flux density conversion from DN to MJy /steradians - in units of MJy / steradians. + The uncertainty in the flux density (in units of + megaJanskys per steradian; MJy/sr) that produces an instrumental + count rate of 1 data number (DN) per second. A unit change to + microJanskys per square arcsecond (uJy/arcsec^2) can be made by + multiplying this value by the ratio (1 x 10^12 MJy/uJy) / + (4.254517 x 10^10 arcsec^2/sr) = 23.50443. anyOf: - type: number - type: "null" @@ -67,24 +40,23 @@ properties: datatype: float destination: [WFIExposure.conversion_megajanskys_uncertainty, WFIMosaic.conversion_megajanskys_uncertainty, SourceCatalog.conversion_megajanskys_uncertainty] - conversion_microjanskys_uncertainty: - title: Uncertainty in Flux Density Conversion (from DN / s to uJy / arcsec^2) + pixel_area: + title: Nominal Pixel Area (sr) description: | - The uncertainty in the flux density conversion from DN / s to - uJy / arcsec^2. + The average pixel area in units of steradians. This + may be converted to units of square arcseconds by multiplying + the value by 4.254517 x 10^10 square arcseconds per steradian. anyOf: - type: number - type: "null" unit: "uJy.arcsec**-2" archive_catalog: datatype: float - destination: [WFIExposure.conversion_microjanskys_uncertainty, WFIMosaic.conversion_microjanskys_uncertainty, - SourceCatalog.conversion_microjanskys_uncertainty] -propertyOrder: [conversion_microjanskys, conversion_megajanskys, - pixelarea_steradians, pixelarea_arcsecsq, - conversion_megajanskys_uncertainty, conversion_microjanskys_uncertainty] + destination: [WFIExposure.pixel_area, WFIMosaic.pixel_area, + SourceCatalog.pixel_area] +propertyOrder: [conversion_megajanskys, conversion_megajanskys_uncertainty, + pixel_area] flowStyle: block -required: [conversion_microjanskys, conversion_megajanskys, - pixelarea_steradians, pixelarea_arcsecsq, - conversion_megajanskys_uncertainty, conversion_microjanskys_uncertainty] +required: [conversion_megajanskys, conversion_megajanskys_uncertainty, + pixel_area] ... diff --git a/src/rad/resources/schemas/pointing-1.0.0.yaml b/src/rad/resources/schemas/pointing-1.0.0.yaml index bdf825a7..3ce6393d 100644 --- a/src/rad/resources/schemas/pointing-1.0.0.yaml +++ b/src/rad/resources/schemas/pointing-1.0.0.yaml @@ -7,11 +7,17 @@ title: Spacecraft Pointing Information type: object properties: ra_v1: - title: RA of Telescope V1 Axis (deg) + title: Right Ascension of the 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. + The right ascension coordinate of the V1 axis in units + of degrees. This may be considered the right ascension + coordinate of the telescope boresight. The telescope V + coordinate system is defined with its origin at the vertex of + the primary mirror. The V1 axis is orthogonal to the primary + mirror, parallel to the telescope boresight, and increasing + positively through the telescope aperture. See + Roman-STScI-000143 "Description of the Roman SIAF and Coordinate + Frames" for more information. type: number sdf: special_processing: VALUE_REQUIRED @@ -21,10 +27,16 @@ properties: datatype: float destination: [WFIExposure.ra_v1, GuideWindow.ra_v1] dec_v1: - title: Dec of Telescope V1 Axis (deg) + title: Declination of the 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. + The declination coordinate of the V1 axis in units of + degrees. This may be considered the declination coordinate of + the telescope boresight. The telescope V coordinate system is + defined with its origin at the vertex of the primary mirror. The + +V1 axis is orthogonal to the primary mirror, parallel to the + telescope boresight, and increasing positively through the + telescope aperture. See Roman-STScI-000143 "Description of the + Roman SIAF and Coordinate Frames" for more information. type: number sdf: special_processing: VALUE_REQUIRED @@ -34,10 +46,15 @@ properties: datatype: float destination: [WFIExposure.dec_v1, GuideWindow.dec_v1] pa_v3: - title: Position Angle of Telescope V3 Axis (deg) + title: Position Angle of the 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. + The position angle of the V3 axis (in units of + degrees) is defined as the projection of the V3 axis on the sky + measured from North to East. The telescope V coordinate system + is defined with its origin at the vertex of the primary mirror. + The +V3 axis is defined to be orthogonal to the sunshield. See + Roman-STScI-000143 "Description of the Roman SIAF and Coordinate + Frames" for more information. type: number sdf: special_processing: VALUE_REQUIRED @@ -46,7 +63,47 @@ properties: archive_catalog: datatype: float destination: [WFIExposure.pa_v3, GuideWindow.pa_v3] -propertyOrder: [ra_v1, dec_v1, pa_v3] + target_aperture: + title: Aperture Name Used for Pointing + description: | + Name of the aperture used to align the instrument to a + position on the sky. + type: string + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + maxLength: 100 + archive_catalog: + datatype: nvarchar(100) + destination: [WFIExposure.target_aperture, GuideWindow.target_aperture] + target_ra: + title: Right Ascension of the Target Aperture (deg) + description: | + Right ascension in units of degrees at the location of + the target aperture. + type: number + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + archive_catalog: + datatype: float + destination: [WFIExposure.target_ra, GuideWindow.target_ra] + target_dec: + title: Declination of the Target Aperture + description: | + Declination in units of degrees at the location of the + target aperture. + type: number + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + archive_catalog: + datatype: float + destination: [WFIExposure.target_dec, GuideWindow.target_dec] +propertyOrder: [ra_v1, dec_v1, pa_v3, target_aperture, target_ra, target_dec] flowStyle: block -required: [ra_v1, dec_v1, pa_v3] +required: [ra_v1, dec_v1, pa_v3, target_aperture, target_ra, target_dec] ... diff --git a/src/rad/resources/schemas/program-1.0.0.yaml b/src/rad/resources/schemas/program-1.0.0.yaml index d5dc6b72..7d07e4e5 100644 --- a/src/rad/resources/schemas/program-1.0.0.yaml +++ b/src/rad/resources/schemas/program-1.0.0.yaml @@ -20,10 +20,11 @@ properties: datatype: nvarchar(200) destination: [WFIExposure.program_title, WFIMosaic.program_title, GuideWindow.program_title, SourceCatalog.program_title, SegmentationMap.program_title] - pi_name: + investigator_name: title: Principal Investigator Name description: | - The name of the Principal Investigator (PI) of the program. + The name of the principle investigator (PI) of the + program. type: string sdf: special_processing: VALUE_REQUIRED @@ -34,12 +35,18 @@ properties: maxLength: 100 archive_catalog: datatype: nvarchar(100) - destination: [WFIExposure.pi_name, WFIMosaic.pi_name, GuideWindow.pi_name, - SourceCatalog.pi_name, SegmentationMap.pi_name] + destination: [WFIExposure.investigator_name, WFIMosaic.investigator_name, GuideWindow.investigator_name, + SourceCatalog.investigator_name, SegmentationMap.investigator_name] category: title: Program Category description: | - The category of the program. + The submitted proposal category of the program. The + categories include calibration (CAL), core community survey + (CCS), coronagraph technology demonstration (CGI), observatory + commissioning (COM), engineering (ENG), general astrophysics + survey (GAS), general investigator (GI), and observing conducted + at the direction of the National Aeronautics and Space + Administration (NASA). type: string sdf: special_processing: VALUE_REQUIRED @@ -53,8 +60,18 @@ properties: subcategory: title: Program Subcategory description: | - The subcategory of the program. + The submitted proposal subcategory of the program. The + subcategories include calibration (CAL), coronagraph technology + demonstration (CGI), community research programs (CR), + discretionary research programs (DR), Galactic Bulge Time Domain + Survey (GBTD), High-Latitude Time Domain Survey (HLTD), + High-Latitude Wide-Area Survey (HLWA), observational research + program (OR), Wide Field Instrument (WFI), and Wavefront Sensing + and Control (WFSC). All subcategories belong to only a subset of + the meta.program.category values. type: string + enum: ['CAL', 'CGI', 'CR', 'DR', 'GBTD', 'HLTD', 'HLWA', 'OR', + 'WFI', 'WFSC', 'None'] sdf: special_processing: VALUE_REQUIRED source: @@ -67,8 +84,8 @@ properties: science_category: title: Science Category description: | - The science category assigned during the Telescope Allocation Committee - (TAC) process. + The science category assigned during the Time + Allocation Committee (TAC) review process. type: string sdf: special_processing: VALUE_REQUIRED @@ -80,10 +97,10 @@ properties: destination: [WFIExposure.science_category, WFIMosaic.science_category, GuideWindow.science_category, SourceCatalog.science_category, SegmentationMap.science_category] continuation_id: - title: Continuation ID + title: Program Continuation Identifier description: | - The identifier that marks the program as a continuation of a previous - program. + An identifier that indicates if the program is a + continuation of a previous program. type: integer sdf: special_processing: VALUE_REQUIRED @@ -93,7 +110,9 @@ properties: datatype: int destination: [WFIExposure.continuation_id, WFIMosaic.continuation_id, GuideWindow.continuation_id, SourceCatalog.continuation_id, SegmentationMap.continuation_id] -propertyOrder: [title, pi_name, category, subcategory, science_category, continuation_id] +propertyOrder: [title, investigator_name, category, subcategory, + science_category, continuation_id] flowStyle: block -required: [title, pi_name, category, subcategory, science_category, continuation_id] +required: [title, investigator_name, category, subcategory, + science_category, continuation_id] ... diff --git a/src/rad/resources/schemas/ramp-1.0.0.yaml b/src/rad/resources/schemas/ramp-1.0.0.yaml index c5963140..bc89d344 100644 --- a/src/rad/resources/schemas/ramp-1.0.0.yaml +++ b/src/rad/resources/schemas/ramp-1.0.0.yaml @@ -10,7 +10,12 @@ datamodel_name: RampModel type: object properties: meta: - $ref: common-1.0.0 + allOf: + - $ref: common-1.0.0 + - type: object + properties: + cal_step: + tag: asdf://stsci.edu/datamodels/roman/tags/l2_cal_step-1.0.0 data: title: Science Data Including Border Reference Pixels (DN, electrons) description: | diff --git a/src/rad/resources/schemas/rcs-1.0.0.yaml b/src/rad/resources/schemas/rcs-1.0.0.yaml new file mode 100644 index 00000000..627ece30 --- /dev/null +++ b/src/rad/resources/schemas/rcs-1.0.0.yaml @@ -0,0 +1,80 @@ +%YAML 1.1 +--- +$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 +id: asdf://stsci.edu/datamodels/roman/schemas/rcs-1.0.0 + +title: Relative Calibration System Information +type: object +properties: + active: + title: Status of the Relative Calibration System (RCS) + description: | + A boolean flag to indicate if the Relative Calibration + System (RCS) is on (True) or off (False) during the exposure. + type: boolean + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + archive_catalog: + datatype: nchar(1) + destination: [WFIExposure.active] + electronics: + title: Relative Calibration System (RCS) Electronics Side + description: | + The active redundant electronics used to control the + Relative Calibration System (RCS). Values may be "A" or "B" if + the RCS is on, and "N/A" if the RCS is off. + anyOf: + - type: string + enum: ["A", "B", None] + - type: "null" + maxLength: 5 + archive_catalog: + datatype: nvarchar(5) + destination: [WFIExposure.electronics] + bank: + title: Light Emitting Diode (LED) Bank Selection + description: | + The bank of light emitting diodes (LEDs) selected in + the program specification in the Astronomer's Proposal Tool + (APT). Values may be either "1" or "2" if the RCS is on, and + "N/A" if the RCS is off. + anyOf: + - type: string + enum: ["1", "2", None] + - type: "null" + maxLength: 5 + archive_catalog: + datatype: nvarchar(5) + destination: [WFIExposure.bank] + led: + title: Light Emitting Diode (LED) Passband + description: | + The light emitting diode (LED) passband selected in + the program specification in the Astronomer's Proposal Tool + (APT). Values are integer strings between "1" and "6" inclusive, + when the RCS is on, and "N/A" when the RCS is off. + anyOf: + - type: string + enum: ["1", "2", "3", "4", "5", "6", None] + - type: "null" + maxLength: 5 + archive_catalog: + datatype: nvarchar(5) + destination: [WFIExposure.led] + counts: + title: Light Emitting Diode (LED) Flux (DN) + description: | + The integrated number of counts of the light emitting + diode (LED) selected in the program specification in the + Astronomer's Proposal Tool (APT). Values are between 0 and + 65,535 in units of DN. + type: integer + archive_catalog: + datatype: int + destination: [WFIExposure.counts] +propertyOrder: [active, electronics, bank, led, counts] +flowStyle: block +required: [active, electronics, bank, led, counts] +... 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 c340eefa..2bf17ca9 100644 --- a/src/rad/resources/schemas/ref_file-1.0.0.yaml +++ b/src/rad/resources/schemas/ref_file-1.0.0.yaml @@ -7,15 +7,17 @@ title: Reference File Information type: object properties: crds: - title: Calibration Reference Data System Parameters + title: Calibration Reference Data System (CRDS) Information description: | Calibration Reference Data System Parameters type: object properties: - sw_version: - title: CRDS File Version + version: + title: CRDS Software Version description: | - Version of Calibration Reference Data System (CRDS) file selection software. + Version of the Calibration Reference Data + System (CRDS) software package used to match calibration + reference files to science observations. type: string sdf: special_processing: VALUE_REQUIRED @@ -24,12 +26,14 @@ properties: maxLength: 120 archive_catalog: datatype: nvarchar(120) - destination: [WFIExposure.crds_software_version, WFIMosaic.crds_software_version, - GuideWindow.crds_software_version, WFICommon.crds_software_version] - context_used: + destination: [WFIExposure.crds_version, WFIMosaic.crds_version, + GuideWindow.crds_version, WFICommon.crds_version] + context: title: CRDS Context description: | - CRDS context (.pmap) used to select ref files. + Name of the Calibration Reference Data System + (CRDS) context (.pmap) file used to match calibration + reference files to science observations. type: string sdf: special_processing: VALUE_REQUIRED @@ -38,23 +42,13 @@ properties: maxLength: 120 archive_catalog: datatype: nvarchar(120) - destination: [WFIExposure.crds_context_used, WFIMosaic.crds_context_used, - GuideWindow.crds_context_used, WFICommon.crds_context_used] - refpix: - title: Reference Pixel File Information - description: | - Reference file used to correct for the reference pixel contribution to - science data. - type: string - maxLength: 120 - archive_catalog: - datatype: nvarchar(120) - destination: [ScienceRefData.r_refpix, GuideWindow.r_refpix, WFICommon.r_refpix] + destination: [WFIExposure.crds_context, WFIMosaic.crds_context, + GuideWindow.crds_context, WFICommon.crds_context] dark: title: Dark Reference File Information description: | - Reference file used to correct for the dark current contribution to - science data. + Name of the calibration reference file used to correct + for dark current signal in the science data. type: string maxLength: 120 archive_catalog: @@ -63,17 +57,19 @@ properties: distortion: title: Distortion Reference File Information description: | - Information about the distortion reference file used with the science - data. + Name of the calibration reference file used to include + the geometric distortion model in the world coordinate system + (WCS) of the science data. type: string maxLength: 120 archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_distortion, GuideWindow.r_distortion, WFICommon.r_distortion] mask: - title: Mask Reference File Information + title: Bad Pixel Mask Reference File Information description: | - Information about the mask reference file used with the science data. + Name of the calibration reference file used to mark + bad pixels in the data quality array of the science data. type: string maxLength: 120 archive_catalog: @@ -82,7 +78,9 @@ properties: flat: title: Flat Reference File Information description: | - Information about the flat reference file used with the science data. + Name of the calibration reference file used to correct + for element-dependent, spatially-variable sensitivity in the + science data. type: string maxLength: 120 archive_catalog: @@ -91,17 +89,19 @@ properties: gain: title: Gain Reference Rile Information description: | - Information about the gain reference file used with the science data. + Name of the calibration reference file used to convert + between data numbers (DN) and photo-electrons in the science + data. type: string maxLength: 120 archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_gain, GuideWindow.r_gain, WFICommon.r_gain] readnoise: - title: Read Noise Reference Rile Information + title: Read Noise Reference File Information description: | - Information about the read noise reference file used with the science - data. + Name of the calibration reference file that estimates + the pixel-to-pixel read noise in the science data. type: string maxLength: 120 archive_catalog: @@ -110,26 +110,41 @@ properties: linearity: title: Linearity Reference File Information description: | - Information about the linearity reference file used with the science data. + Name of the calibration reference file used to correct + for classical linearity in the science data. type: string maxLength: 120 archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_linearity, GuideWindow.r_linearity, WFICommon.r_linearity] + inverse_linearity: + title: Inverse Linearity Reference File Information + description: | + Name of the calibration reference file used in + simulations of Level 1 data products to imprint the effect of + classical non-linearity in the science data. + type: string + maxLength: 120 + archive_catalog: + datatype: nvarchar(120) + destination: [ScienceRefData.r_inverse_linearity, GuideWindow.r_inverse_linearity, WFICommon.r_inverse_linearity] photom: title: Photometry Reference File Information description: | - Information about the photometry reference file used with the science - data. + Name of the calibration reference file containing + photometric zeropoints and related information populated into + the science product metadata. type: string maxLength: 120 archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_photom, GuideWindow.r_photom, WFICommon.r_photom] area: - title: Area Reference File Information + title: Pixel Area Reference File Information description: | - Information about the area reference file used with the science data. + Name of the calibration reference file containing the + pixel-to-pixel estimates of the area of each detector pixel on + the sky. type: string maxLength: 120 archive_catalog: @@ -145,6 +160,15 @@ properties: archive_catalog: datatype: nvarchar(120) destination: [ScienceRefData.r_saturation, GuideWindow.r_saturation, WFICommon.r_saturation] - + refpix: + title: Reference Pixel Reference File Information + description: | + Name of the calibration reference file used to correct + for 1/f noise using the reference pixels. + type: string + maxLength: 120 + archive_catalog: + datatype: nvarchar(120) + destination: [ScienceRefData.r_refpix, GuideWindow.r_refpix, WFICommon.r_refpix] flowStyle: block ... diff --git a/src/rad/resources/schemas/statistics-1.0.0.yaml b/src/rad/resources/schemas/statistics-1.0.0.yaml new file mode 100644 index 00000000..61663710 --- /dev/null +++ b/src/rad/resources/schemas/statistics-1.0.0.yaml @@ -0,0 +1,69 @@ +%YAML 1.1 +--- +$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 +id: asdf://stsci.edu/datamodels/roman/schemas/statistics-1.0.0 + + +title: | + Basic Statistical Information + +type: object +properties: + zodiacal_light: + title: Estimated Zodiacal Light Surface Brightness (MJy/sr) + description: | + A model estimate of the Zodiacal light + contribution to the sky background in units of MegaJanskys + per steradian (MJy/sr). + type: number + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + archive_catalog: + datatype: float + destination: [WFIExposure.zodiacal_light] + image_median: + title: Median Image Value (DN/s) + description: | + Median image value in units of data numbers per + second (DN/s). + type: number + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + archive_catalog: + datatype: float + destination: [WFIExposure.image_median] + image_rms: + title: Image Mean Absolute Deviation (DN/s) + description: | + Mean absolute deviation of the image values in + units of data numbers per second (DN/s). + type: number + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + archive_catalog: + datatype: float + destination: [WFIExposure.image_rms] + good_pixel_fraction: + title: Fraction of Good Pixels + description: | + The fraction of pixels on the science portion of + the detector for which the data quality bits are do not + include a value corresponding to "DO_NOT_USE". + type: number + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + archive_catalog: + datatype: float + destination: [WFIExposure.good_pixel_fraction] +propertyOrder: [zodiacal_light, image_median, image_rms, good_pixel_fraction] +flowStyle: block +required: [zodiacal_light, image_median, image_rms, good_pixel_fraction] +... diff --git a/src/rad/resources/schemas/tagged_scalars/calibration_software_name-1.0.0.yaml b/src/rad/resources/schemas/tagged_scalars/calibration_software_name-1.0.0.yaml new file mode 100644 index 00000000..54012596 --- /dev/null +++ b/src/rad/resources/schemas/tagged_scalars/calibration_software_name-1.0.0.yaml @@ -0,0 +1,20 @@ +%YAML 1.1 +--- +$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 +id: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/calibration_software_name-1.0.0 + +title: Calibration Software Name +type: string +sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD +maxLength: 120 +archive_catalog: + datatype: nvarchar(120) + destination: [WFIExposure.calibration_software_name, GuideWindow.calibration_software_name, + WFICommon.calibration_software_name, WFIMosaic.calibration_software_name, + SourceCatalog.calibration_software_name, SegmentationMap.calibration_software_name] + +flowStyle: block +... 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 d5096f7c..3b5d5537 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 @@ -6,7 +6,7 @@ id: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/origin-1.0.0 title: Institution / Organization Name type: string -enum: ["STSCI", "IPAC/SSC"] +enum: ["STSCI", "STSCI/SOC", "IPAC/SSC"] sdf: special_processing: VALUE_REQUIRED diff --git a/src/rad/resources/schemas/tagged_scalars/prd_software_version-1.0.0.yaml b/src/rad/resources/schemas/tagged_scalars/prd_version-1.0.0.yaml similarity index 54% rename from src/rad/resources/schemas/tagged_scalars/prd_software_version-1.0.0.yaml rename to src/rad/resources/schemas/tagged_scalars/prd_version-1.0.0.yaml index a49b9c95..e5e8ecde 100644 --- a/src/rad/resources/schemas/tagged_scalars/prd_software_version-1.0.0.yaml +++ b/src/rad/resources/schemas/tagged_scalars/prd_version-1.0.0.yaml @@ -1,7 +1,7 @@ %YAML 1.1 --- $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 +id: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/prd_version-1.0.0 title: SOC PRD Version Number type: string @@ -12,9 +12,9 @@ sdf: maxLength: 120 archive_catalog: datatype: nvarchar(120) - destination: [WFIExposure.prd_software_version, GuideWindow.prd_software_version, - WFICommon.prd_software_version, WFIMosaic.prd_software_version, - SourceCatalog.prd_software_version, SegmentationMap.prd_software_version] + destination: [WFIExposure.prd_version, GuideWindow.prd_version, + WFICommon.prd_version, WFIMosaic.prd_version, + SourceCatalog.prd_version, SegmentationMap.prd_version] flowStyle: block ... diff --git a/src/rad/resources/schemas/tagged_scalars/product_type-1.0.0.yaml b/src/rad/resources/schemas/tagged_scalars/product_type-1.0.0.yaml new file mode 100644 index 00000000..e49a9b00 --- /dev/null +++ b/src/rad/resources/schemas/tagged_scalars/product_type-1.0.0.yaml @@ -0,0 +1,20 @@ +%YAML 1.1 +--- +$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 +id: asdf://stsci.edu/datamodels/roman/schemas/tagged_scalars/product_type-1.0.0 + +title: Product Type Descriptor +type: string +sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD +maxLength: 120 +archive_catalog: + datatype: nvarchar(120) + destination: [WFIExposure.product_type, GuideWindow.product_type, + WFICommon.product_type, WFIMosaic.product_type, + SourceCatalog.product_type, SegmentationMap.product_type] + +flowStyle: block +... diff --git a/src/rad/resources/schemas/target-1.0.0.yaml b/src/rad/resources/schemas/target-1.0.0.yaml deleted file mode 100644 index 858b431f..00000000 --- a/src/rad/resources/schemas/target-1.0.0.yaml +++ /dev/null @@ -1,196 +0,0 @@ -%YAML 1.1 ---- -$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 -type: object -properties: - proposer_name: - 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 - source: - origin: PSS:dms_target.target_name - maxLength: 100 - archive_catalog: - datatype: nvarchar(100) - destination: [WFIExposure.proposer_target_name, GuideWindow.proposer_target_name] - catalog_name: - title: Target Name from Catalog - description: | - The target name as defined by an astronomical catalog. - type: string - sdf: - special_processing: VALUE_REQUIRED - source: - origin: PSS:dms_target.standard_target_name - maxLength: 256 - archive_catalog: - datatype: nvarchar(256) - destination: [WFIExposure.catalog_name, GuideWindow.catalog_name] - type: - 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: - special_processing: VALUE_REQUIRED - source: - origin: PSS:dms_target.target_type - maxLength: 10 - archive_catalog: - datatype: nvarchar(10) - destination: [WFIExposure.target_type, GuideWindow.target_type] - ra: - 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 - source: - origin: PSS:dms_target.ra_computed - archive_catalog: - datatype: float - destination: [WFIExposure.ra, GuideWindow.ra] - dec: - 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 - source: - origin: PSS:dms_target.dec_computed - archive_catalog: - datatype: float - destination: [WFIExposure.dec, GuideWindow.dec] - 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 - source: - origin: PSS:dms_target.ra_uncertainty_computed - archive_catalog: - datatype: float - destination: [WFIExposure.ra_uncertainty, GuideWindow.ra_uncertainty] - 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 - source: - origin: PSS:dms_target.dec_uncertainty_computed - archive_catalog: - datatype: float - destination: [WFIExposure.dec_uncertainty, GuideWindow.dec_uncertainty] - proper_motion_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 - source: - origin: PSS:dms_target.ra_proper_motion - archive_catalog: - datatype: float - destination: [WFIExposure.proper_motion_ra, GuideWindow.proper_motion_ra] - proper_motion_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 - source: - origin: PSS:dms_target.dec_proper_motion - archive_catalog: - datatype: float - destination: [WFIExposure.proper_motion_dec, GuideWindow.proper_motion_dec] - 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 - source: - origin: PSS:dms_visit.epoch - maxLength: 10 - archive_catalog: - datatype: nvarchar(10) - destination: [WFIExposure.proper_motion_epoch, GuideWindow.proper_motion_epoch] - proposer_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 - source: - origin: PSS:fixed_target.ra_literal - function: hms_to_degrees - archive_catalog: - datatype: float - destination: [WFIExposure.proposer_ra, GuideWindow.proposer_ra] - proposer_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 - source: - origin: PSS:fixed_target.dec_literal - function: hms_to_degrees - archive_catalog: - datatype: float - destination: [WFIExposure.proposer_dec, GuideWindow.proposer_dec] - source_type: - 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: - special_processing: VALUE_REQUIRED - source: - origin: TBD - maxLength: 8 - archive_catalog: - datatype: nvarchar(8) - destination: [WFIExposure.source_type, GuideWindow.source_type] -propertyOrder: [proposer_name, catalog_name, type, ra, dec, ra_uncertainty, dec_uncertainty, - proper_motion_ra, proper_motion_dec, proper_motion_epoch, - proposer_ra, proposer_dec, source_type] -flowStyle: block -required: [proposer_name, catalog_name, type, ra, dec, ra_uncertainty, dec_uncertainty, - proper_motion_ra, proper_motion_dec, proper_motion_epoch, - proposer_ra, proposer_dec, source_type] -... 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 41c8102a..f3ade6ee 100644 --- a/src/rad/resources/schemas/velocity_aberration-1.0.0.yaml +++ b/src/rad/resources/schemas/velocity_aberration-1.0.0.yaml @@ -6,10 +6,11 @@ id: asdf://stsci.edu/datamodels/roman/schemas/velocity_aberration-1.0.0 title: Velocity Aberration Correction Information type: object properties: - ra_offset: - title: Velocity Aberration RA Offset (degree) + ra_reference: + title: Velocity Aberrated Reference Right Ascension (deg) description: | - Right ascension offset for velocity aberration in degrees. + Reference position right ascension corrected for + velocity aberration in units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -17,11 +18,12 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.ra_offset, GuideWindow.ra_offset] - dec_offset: - title: Velocity Aberration Dec Offset (degree) + destination: [WFIExposure.ra_reference, GuideWindow.ra_reference] + dec_reference: + title: Velocity Aberrated Reference Declination (deg) description: | - Declination offset for velocity aberration in degrees. + Reference position declination corrected for velocity + aberration in units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -29,11 +31,12 @@ properties: origin: TBD archive_catalog: datatype: float - destination: [WFIExposure.dec_offset, GuideWindow.dec_offset] + destination: [WFIExposure.dec_reference, GuideWindow.dec_reference] scale_factor: - title: Velocity Aberration Scale Factor + title: Velocity Aberration Correction Scale Factor description: | - Velocity aberration scale factor. + Scale factor used for the correction of the velocity + aberration. type: number sdf: special_processing: VALUE_REQUIRED @@ -43,6 +46,6 @@ properties: datatype: float destination: [WFIExposure.scale_factor, GuideWindow.scale_factor] flowStyle: block -propertyOrder: [ra_offset, dec_offset, scale_factor] -required: [ra_offset, dec_offset, scale_factor] +propertyOrder: [ra_reference, dec_reference, scale_factor] +required: [ra_reference, dec_reference, scale_factor] ... diff --git a/src/rad/resources/schemas/visit-1.0.0.yaml b/src/rad/resources/schemas/visit-1.0.0.yaml index f0db478a..184d774f 100644 --- a/src/rad/resources/schemas/visit-1.0.0.yaml +++ b/src/rad/resources/schemas/visit-1.0.0.yaml @@ -6,12 +6,90 @@ id: asdf://stsci.edu/datamodels/roman/schemas/visit-1.0.0 title: Visit Information type: object properties: + dither: + title: Dither Pattern Information + type: object + properties: + primary_name: + title: Primary Dither Pattern Name + description: | + Name of the primary dither pattern used for + the visit. + anyOf: + - type: string + - type: "null" + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + maxLength: 100 + archive_catalog: + datatype: nvarchar(100) + destination: [WFIExposure.dither_primary_name, SourceCatalog.dither_primary_name, + SegmentationMap.dither_primary_name] + subpixel_name: + title: Subpixel Dither Pattern Name + description: | + Name of the subpixel dither pattern used for + the visit. + anyOf: + - type: string + - type: "null" + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + maxLength: 100 + archive_catalog: + datatype: nvarchar(100) + destination: [WFIExposure.dither_subpixel_name, SourceCatalog.dither_subpixel_name, + SegmentationMap.dither_subpixel_name] + + executed_pattern: + title: Executed Dither Pattern Offsets (arcsec) + description: | + The combination of the primary and subpixel + dither patterns (if selected) in units of arcseconds. If + a subpixel dither pattern is selected, then all of the + subpixel dither offsets are performed at each of the + points in the primary dither pattern. Thus, the total + number of dither offsets executed is the product of the + number of points in the primary and subpixel dither + patterns. The array contains (X, Y) pairs of offsets in + the subpixel dither pattern where the X and Y + coordinates are defined in the ideal system. The ideal + coordinate system is a geomtric-distortion-corrected + reference frame projected onto a tangent plane. For more + information, see the Science Instrument Aperture File + (SIAF) and associated documentation. The exposure + identifier in meta.observation.exposure can be used to + index this array to obtain the relative pointing offset + from the initial target position for this exposure. Note + that the exposure identifier is 1-indexed. + anyOf: + - type: array + items: + type: number + - type: "null" + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + archive_catalog: + datatype: nvarchar(max) + destination: [WFIExposure.dither_executed_pattern, + SourceCatalog.dither_executed_pattern, + SegmentationMap.dither_executed_pattern] + required: [primary_name, subpixel_name, executed_pattern] engineering_quality: - title: Engineering Quality of Data + title: Engineering Data 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. + Indicator of data quality problems with the + engineering data used to populated select metadata fields. A + value of "OK" indicates no suspected problems, while a value of + "SUSPECT" indicates one or more metadata values populated from + the engineering database may be missing information during the + exposure or are otherwise of lower quality. type: string enum: [OK, SUSPECT] sdf: @@ -23,11 +101,16 @@ properties: datatype: nvarchar(10) destination: [WFIExposure.engineering_quality, GuideWindow.engineering_quality, SourceCatalog.engineering_quality, SegmentationMap.engineering_quality] - pointing_engdb_quality: - title: Engineering Quality of Pointing + pointing_engineering_source: + title: Pointing Engineering Source description: | - The quality of the pointing information from the Engineering Database - (EngDB). The options available are "CALCULATED" and "PLANNED". + The source type of the pointing information in the + metadata may be set to either "PLANNED" or "CALCULATED". If the + value is "PLANNED", then pointing mnemonics were not found in + the engineering database, and the pointing data were taken from + the observation planning information. If the value is + "CALCULATED", then the pointing data were determined using the + information in the engineering database. type: string enum: [CALCULATED, PLANNED] sdf: @@ -37,13 +120,15 @@ properties: maxLength: 10 archive_catalog: datatype: nvarchar(10) - destination: [WFIExposure.pointing_engdb_quality, GuideWindow.pointing_engdb_quality, - SourceCatalog.pointing_engdb_quality, SegmentationMap.pointing_engdb_quality] + destination: [WFIExposure.pointing_engineering_source, GuideWindow.pointing_engineering_source, + SourceCatalog.pointing_engineering_source, SegmentationMap.pointing_engineering_source] type: title: Visit Type description: | - The type of visit. + The type of visit from observation planning. type: string + enum: ['GENERAL_ENGINEERING', 'GENERIC', 'PARALLEL', + 'PRIME_TARGETED_FIXED', 'PRIME_UNTARGETED'] sdf: special_processing: VALUE_REQUIRED source: @@ -56,7 +141,13 @@ properties: start_time: title: Visit Start Time (UTC) description: | - The start time of the visit in coordinated universal time (UTC). + The UTC time at the beginning of the visit. The time + is serialized on disk as an International Organization for + Standardization (ISO) 8601-compliant ISOT string, but if opened + in Python with the asdf-astropy package installed, it may be + read as an astropy.time.Time object with all of the associated + methods and transforms available. See the documentation for + astropy.time.Time objects for more information. tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED @@ -69,7 +160,13 @@ properties: end_time: title: Visit End Time (UTC) description: | - The end time of the visit in coordinated universal time (UTC). + The UTC time at the end of the visit. The time is + serialized on disk as an International Organization for + Standardization (ISO) 8601-compliant ISOT string, but if opened + in Python with the asdf-astropy package installed, it may be + read as an astropy.time.Time object with all of the associated + methods and transforms available. See the documentation for + astropy.time.Time objects for more information. tag: tag:stsci.edu:asdf/time/time-1.* sdf: special_processing: VALUE_REQUIRED @@ -82,8 +179,9 @@ properties: status: title: Visit Status description: | - The status of a visit. + Execution status of the visit. type: string + enum: ['DATALOSS', 'SUCCESSFUL', 'UNSUCCESSFUL'] sdf: special_processing: VALUE_REQUIRED source: @@ -93,10 +191,11 @@ properties: datatype: nvarchar(15) destination: [WFIExposure.visit_status, GuideWindow.visit_status, SourceCatalog.visit_status, SegmentationMap.visit_status] - total_exposures: - title: Total Number of Exposures + nexposures: + title: Number of Planned Exposures description: | - The total number of exposures planned in a visit. + The total number of exposures planned within the + visit. type: integer sdf: special_processing: VALUE_REQUIRED @@ -104,14 +203,13 @@ properties: origin: TBD archive_catalog: datatype: int - destination: [WFIExposure.visit_total_exposures, GuideWindow.visit_total_exposures, - SourceCatalog.visit_total_exposures, SegmentationMap.visit_total_exposures] + destination: [WFIExposure.visit_nexposures, GuideWindow.visit_nexposures, + SourceCatalog.visit_nexposures, SegmentationMap.visit_nexposures] internal_target: 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 shutter. + A boolean indicator which, if true, indicates that the + target for the visit is an internal calibration target. type: boolean sdf: special_processing: VALUE_REQUIRED @@ -121,24 +219,9 @@ properties: datatype: nchar(1) destination: [WFIExposure.visit_internal_target, GuideWindow.visit_internal_target, SourceCatalog.visit_internal_target, SegmentationMap.visit_internal_target] - 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 refer to temporal phenomena, - such as supernovae, which cannot be planned in advance. - type: boolean - sdf: - special_processing: VALUE_REQUIRED - source: - origin: TBD - archive_catalog: - datatype: nchar(1) - destination: [WFIExposure.target_of_opportunity, GuideWindow.target_of_opportunity, - SourceCatalog.target_of_opportunity, SegmentationMap.target_of_opportunity] -propertyOrder: [engineering_quality, pointing_engdb_quality, type, - start_time, end_time, status, total_exposures, internal_target, target_of_opportunity] +propertyOrder: [dither, engineering_quality, pointing_engineering_source, type, + start_time, end_time, status, nexposures, internal_target] flowStyle: block -required: [engineering_quality, pointing_engdb_quality, type, - start_time, end_time, status, total_exposures, internal_target, target_of_opportunity] +required: [dither, engineering_quality, pointing_engineering_source, type, + start_time, end_time, status, nexposures, internal_target] ... diff --git a/src/rad/resources/schemas/wcsinfo-1.0.0.yaml b/src/rad/resources/schemas/wcsinfo-1.0.0.yaml index 49da01c4..113c2a55 100644 --- a/src/rad/resources/schemas/wcsinfo-1.0.0.yaml +++ b/src/rad/resources/schemas/wcsinfo-1.0.0.yaml @@ -3,14 +3,60 @@ $schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0 id: asdf://stsci.edu/datamodels/roman/schemas/wcsinfo-1.0.0 -title: World Coordinate System (WCS) Parameters +title: World Coordinate System (WCS) Information type: object properties: + aperture_name: + title: Aperture Name + description: | + Name of the aperture used to specify the + transformations between detector pixel, science pixel, and + spacecraft V coordinate frames. This information comes from the + Science Instrument Aperture File (SIAF) in the Science + Operations Center (SOC) Project Reference Database (PRD). + type: string + maxLength: 20 + enum: ['WFI01_FULL', 'WFI02_FULL', 'WFI03_FULL', 'WFI04_FULL', + 'WFI05_FULL', 'WFI06_FULL', 'WFI07_FULL', 'WFI08_FULL', + 'WFI09_FULL', 'WFI10_FULL', 'WFI11_FULL', 'WFI12_FULL', + 'WFI13_FULL', 'WFI14_FULL', 'WFI15_FULL', 'WFI16_FULL', + 'WFI17_FULL', 'WFI18_FULL', 'WFI_CEN', 'BORESIGHT', 'CGI_CEN'] + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + archive_catalog: + datatype: nvarchar(20) + destination: [WFIExposure.aperture_name, GuideWindow.aperture_name] + pa_aperture: + title: Aperture Position Angle (deg) + description: | + Position angle in degrees of the aperture ideal Y axis + relative to the V3 axis of the spacecraft. This information + comes from the Science Instrument Aperture File (SIAF) in the + Science Operations Center (SOC) Project Reference Database + (PRD). + type: number + sdf: + special_processing: VALUE_REQUIRED + source: + origin: TBD + archive_catalog: + datatype: float + destination: [WFIExposure.pa_aperture, GuideWindow.pa_aperture] v2_ref: - title: Reference Position V2 Coordinate (arcsec) + title: V2 Reference Position (arcsec) description: | - Coordinate of the reference position along the telescope V2 axis in units - of arcseconds. + Coordinate of the reference pixel position along the + telescope V2 axis in units of arcseconds. This information comes + from the Science Instrument Aperture File (SIAF) in the Science + Operations Center (SOC) Project Reference Database (PRD). The + telescope V coordinate system is defined with its origin at the + vertex of the primary mirror. The +V1 axis is defined as + parallel to the telescope boresight, the +V3 axis is orthogonal + to the sunshield, and the +V2 axis completes the right-hand + system. See Roman-STScI-000143 "Description of the Roman SIAF + and Coordinate Frames" for more information. type: number sdf: special_processing: VALUE_REQUIRED @@ -20,10 +66,16 @@ properties: datatype: float destination: [WFIExposure.v2_ref, GuideWindow.v2_ref] v3_ref: - title: Reference Position V3 Coordinate (arcsec) + title: V3 Reference Position (arcsec) description: | - Coordinate of the reference position along the telescope V3 axis in units - of arcseconds. + Coordinate of the reference pixel position along the + telescope V3 axis in units of arcseconds. This information comes + from the Science Instrument Aperture File (SIAF) in the Science + Operations Center (SOC) Project Reference Database (PRD). The + telescope V coordinate system is defined with its origin at the + vertex of the primary mirror. The +V3 axis is orthogonal to the + sunshield. See Roman-STScI-000143 "Description of the Roman SIAF + and Coordinate Frames" for more information. type: number sdf: special_processing: VALUE_REQUIRED @@ -33,12 +85,16 @@ properties: datatype: float destination: [WFIExposure.v3_ref, GuideWindow.v3_ref] vparity: - title: Relative Rotation Between Ideal and Telescope Axes + title: Relative Rotation Between the 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. + Relative sense of rotation between the ideal and + telescope coordinate systems. The value may be either 1 or -1. + This information comes from the Science Instrument Aperture File + (SIAF) in the Science Operations Center (SOC) Project Reference + Database (PRD). See documents STScI-JWST-001550 and + STScI-Roman-000143 for more information. type: integer + enum: [-1, 1] sdf: special_processing: VALUE_REQUIRED source: @@ -49,8 +105,16 @@ properties: v3yangle: 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. + Angle between the telescope V3 axis and the ideal Y + axis in units of degrees. This information comes from the + Science Instrument Aperture File (SIAF) in the Science + Operations Center (SOC) Project Reference Database (PRD). The + telescope V coordinate system is defined with its origin at the + vertex of the primary mirror. The +V3 axis is orthogonal to the + sunshield. The ideal coordinate system is a + geomtric-distortion-corrected reference frame projected onto a + tangent plane. See Roman-STScI-000143 "Description of the Roman + SIAF and Coordinate Frames" for more information. type: number sdf: special_processing: VALUE_REQUIRED @@ -62,7 +126,8 @@ properties: ra_ref: title: Right Ascension of the Reference Position (deg) description: | - Right ascension of the reference position on the sky in units of degrees. + Right ascension of the reference pixel position on the + sky in units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -74,7 +139,8 @@ properties: dec_ref: title: Declination of the Reference Position (deg) description: | - Declination of the reference position on the sky in units of degrees. + Declination of the reference pixel position on the sky + in units of degrees. type: number sdf: special_processing: VALUE_REQUIRED @@ -86,8 +152,12 @@ properties: roll_ref: title: V3 Position Angle at the Reference Position description: | - Position angle of the V3 axis at the reference position measured from - North to East. + Position angle of the telescope V3 axis at the + reference pixel position measured from North to East. The + telescope V coordinate system is defined with its origin at the + vertex of the primary mirror. The +V3 axis is orthogonal to the + sunshield. See Roman-STScI-000143 "Description of the Roman SIAF + and Coordinate Frames" for more information. type: number sdf: special_processing: VALUE_REQUIRED @@ -97,11 +167,12 @@ properties: datatype: float destination: [WFIExposure.roll_ref, GuideWindow.roll_ref] s_region: - title: Spatial Extent of the Observation + title: Spatial Extent of the Exposure 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. + The region of the sky enclosed by the pixel data + contained within this file. 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 @@ -110,7 +181,9 @@ properties: archive_catalog: datatype: nvarchar(max) destination: [WFIExposure.s_region, GuideWindow.s_region] -propertyOrder: [v2_ref, v3_ref, vparity, v3yangle, ra_ref, dec_ref, roll_ref, s_region] +propertyOrder: [aperture_name, pa_aperture, v2_ref, v3_ref, vparity, v3yangle, + ra_ref, dec_ref, roll_ref, s_region] flowStyle: block -required: [v2_ref, v3_ref, vparity, v3yangle, ra_ref, dec_ref, roll_ref, s_region] +required: [aperture_name, pa_aperture, v2_ref, v3_ref, vparity, v3yangle, + ra_ref, dec_ref, roll_ref, s_region] ... 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 4ffa1a28..f631c13e 100644 --- a/src/rad/resources/schemas/wfi_image-1.0.0.yaml +++ b/src/rad/resources/schemas/wfi_image-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/wfi_image-1.0.0 -title: The Schema for WFI Level 2 Images. +title: Level 2 (L2) Calibrated Roman Wide Field Instrument (WFI) Rate Image. datamodel_name: ImageModel archive_meta: None @@ -15,99 +15,120 @@ properties: - $ref: common-1.0.0 - type: object properties: + background: + tag: asdf://stsci.edu/datamodels/roman/tags/sky_background-1.0.0 + cal_logs: + tag: asdf://stsci.edu/datamodels/roman/tags/cal_logs-1.0.0 + cal_step: + tag: asdf://stsci.edu/datamodels/roman/tags/l2_cal_step-1.0.0 + outlier_detection: + tag: asdf://stsci.edu/datamodels/roman/tags/outlier_detection-1.0.0 + photometry: + tag: asdf://stsci.edu/datamodels/roman/tags/photometry-1.0.0 + source_detection: + tag: asdf://stsci.edu/datamodels/roman/tags/source_detection-1.0.0 + statistics: + tag: asdf://stsci.edu/datamodels/roman/tags/statistics-1.0.0 wcs: title: WCS object anyOf: - tag: tag:stsci.edu:gwcs/wcs-* - type: "null" - photometry: - tag: asdf://stsci.edu/datamodels/roman/tags/photometry-1.0.0 - outlier_detection: - tag: asdf://stsci.edu/datamodels/roman/tags/outlier_detection-1.0.0 - source_detection: - tag: asdf://stsci.edu/datamodels/roman/tags/source_detection-1.0.0 - background: - tag: asdf://stsci.edu/datamodels/roman/tags/sky_background-1.0.0 + required: [photometry, wcs] data: - title: Science Data (DN / s) or (MJy / sr) + title: Science Data (DN/s) or (MJy/sr) description: | - Science data, excluding border reference pixels, in DNs per second - or MJ per steradian. + Calibrated science rate image in units of data numbers + per second (DN/s) or megaJanskys per steradian (MJy/sr). tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: float32 exact_datatype: true ndim: 2 unit: ["DN / s", "MJy.sr**-1"] dq: - title: Data Quality Flags + title: Data Quality description: | - Data quality flags. + Bitwise sum of data quality flags. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true ndim: 2 err: - title: Error (DN / s) + title: Error (DN / s) or (MJy / sr) description: | - Error in units of DNs per second or MJ per steradian. + Total error array in units of data numbers per second + (DN/s) or megaJanskys per steradian (MJy/sr). tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: float32 exact_datatype: true ndim: 2 unit: ["DN / s", "MJy.sr**-1"] var_poisson: - title: Poisson Variance (DN^2 / s^2) + title: Poisson Variance (DN^2/s^2) or (MJy^2/sr^2) description: | - Poisson variance in units of DN^2 / second^2. + Component of the per pixel variance due to Poisson + noise in units of data numbers squared per second squared + (DN^2/s^2) or megaJanskys squared per square steradian + (MJy^2/sr^2). tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: float32 exact_datatype: true ndim: 2 unit: ["DN2 / s2", "MJy**2.sr**-2"] var_rnoise: - title: Read Noise (DN^2 / s^2) + title: Read Noise Variance (DN^2/s^2) or (MJy^2/sr^2) description: | - Read noise in units of DN^2 / second^2. + Component of the per pixel variance due to detector + read noise in units of data numbers squared per second squared + (DN^2/s^2) or megaJanskys squared per square steradian + (MJy^2/sr^2). tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: float32 exact_datatype: true ndim: 2 unit: ["DN2 / s2", "MJy**2.sr**-2"] var_flat: - title: Variance for Estimate of Flat Pixel Flux (DN^2 / s^2). + title: Flat Field Variance (DN^2/s^2) or (MJy^2/sr^2) description: | - Variance for estimate of flat pixel flux in units of - DN^2 / second^2. + Component of the per pixel variance due to the flat + field in units of data numbers squared per second squared + (DN^2/s^2) or megaJanskys squared per square steradian + (MJy^2/sr^2). tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: float32 exact_datatype: true ndim: 2 unit: ["DN2 / s2", "MJy**2.sr**-2"] amp33: - title: Amp 33 Reference Pixel Data (DN) + title: Amplifier 33 Reference Pixel Data (DN) description: | - Amplifier 33 reference pixel data in units of DN. + Reference pixel data from amplifier 33 in units of + data numbers (DN). tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint16 exact_datatype: true ndim: 3 unit: "DN" border_ref_pix_left: - title: Border Reference Pixels on the Left of the Detector, from the Instrument's Perspective (DN) + title: Left-Edge Border Reference Pixels (DN) description: | - Border reference pixels on the left of the detector, from the instrument's - perspective in units of DN. + Uncalibrated, four-pixel border reference pixel cube + from the left-edge of the detector in the science frame + orientation. In the L1 uncal file data array, these are pixels + (z, y, x) = [:, :, :4] in a zero-indexed system. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: float32 exact_datatype: true ndim: 3 unit: "DN" border_ref_pix_right: - title: Border Reference Pixels on the Right of the Detector, from the Instrument's Perspective (DN) + title: Right-Edge Border Reference Pixels (DN) description: | - Border reference pixels on the right of the detector, from the - instrument's perspective in units of DN + Uncalibrated, four-pixel border reference pixel cube + from the right-edge of the detector in the science frame + orientation. In the L1 uncal file data array, these are pixels + (z, y, x) = [:, :, 4092:] in a zero-indexed system. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: float32 exact_datatype: true @@ -123,62 +144,74 @@ properties: ndim: 3 unit: "DN" border_ref_pix_bottom: - title: Border Reference Pixels on the Bottom of the Detector (DN) + title: Bottom-Edge Border Reference Pixels (DN) description: | - Border reference pixels on the bottom of the detector in units of DN. + Uncalibrated, four-pixel border reference pixel cube + from the bottom-edge of the detector in the science frame + orientation. In the L1 uncal file data array, these are pixels + (z, y, x) = [:, :4, :] in a zero-indexed system. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: float32 exact_datatype: true ndim: 3 unit: "DN" dq_border_ref_pix_left: - title: Data Quality Flag for Border Reference Pixels, on the Left Edge of the Detector from the Instrument Perspective + title: Left-Edge Border Reference Pixel Data Quality (DN) description: | - Data quality flag for border reference pixels, on the left edge of the - detector from the instrument perspective. + Bitwise sum of data quality flags for the four-pixel + border reference pixel cube from the left-edge of the detector + in the science frame orientation. In the L1 uncal file data + array, these are pixels (z, y, x) = [:, :, :4] in a zero-indexed + system. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true ndim: 2 dq_border_ref_pix_right: - title: Data Quality Flag for Border Reference Pixels, on the Right edge of the Detector from the Instrument Perspective + title: Right-Edge Border Reference Pixel Data Quality (DN) description: | - Data quality flag for border reference pixels, on the right edge of the - detector from the instrument perspective. + Bitwise sum of data quality flags for the four-pixel + border reference pixel cube from the right-edge of the detector + in the science frame orientation. In the L1 uncal file data + array, these are pixels (z, y, x) = [:, :, 4092:] in a + zero-indexed system. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true ndim: 2 dq_border_ref_pix_top: - title: Data Quality Flag for Border Reference Pixels, on Top + title: Border Reference Pixel Data Quality on the Top of the Detector (DN) description: | - Data quality flag for border reference pixels, on top. + Bitwise sum of data quality flags for the four-pixel + border reference pixel cube from the top-edge of the detector in + the science frame orientation. In the L1 uncal file data array, + these are pixels (z, y, x) = [:, 4092:, :] in a zero-indexed + system. tag: tag:stsci.edu:asdf/core/ndarray-1.* datatype: uint32 exact_datatype: true ndim: 2 dq_border_ref_pix_bottom: - title: Data Quality Flag for Border Reference Pixels, on Bottom + title: Bottom-Edge Border Reference Pixel Data Quality (DN) description: | - Data quality flag for border reference pixels, on bottom. + Bitwise sum of data quality flags for the four-pixel + border reference pixel cube from the bottom-edge of the detector + in the science frame orientation. In the L1 uncal file data + array, these are pixels (z, y, x) = [:, :4, :] in a zero-indexed + system. 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, border_ref_pix_top, border_ref_pix_bottom, dq_border_ref_pix_left, dq_border_ref_pix_right, - dq_border_ref_pix_top, dq_border_ref_pix_bottom, cal_logs] + dq_border_ref_pix_top, dq_border_ref_pix_bottom] flowStyle: block required: [meta, data, dq, err, var_poisson, var_rnoise, amp33, border_ref_pix_left, border_ref_pix_right, border_ref_pix_top, border_ref_pix_bottom, dq_border_ref_pix_left, dq_border_ref_pix_right, dq_border_ref_pix_top, - dq_border_ref_pix_bottom, cal_logs] + dq_border_ref_pix_bottom] ... 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 6644180a..e3dd030e 100644 --- a/src/rad/resources/schemas/wfi_mode-1.0.0.yaml +++ b/src/rad/resources/schemas/wfi_mode-1.0.0.yaml @@ -4,13 +4,14 @@ $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: Wide Field Instrument (WFI) Configuration Information type: object properties: name: - title: Instrument Used to Acquire the Data + title: Instrument Name description: | - Instrument used to acquire the data. + Name of the instrument used to acquire the science + data. type: string enum: [WFI] sdf: @@ -22,9 +23,10 @@ properties: datatype: nvarchar(5) destination: [WFIExposure.instrument_name, GuideWindow.instrument_name, WFICommon.instrument_name] detector: - title: WFI Detector + title: Wide Field Instrument (WFI) Detector Identifier description: | - WFI detector used to take the data. + Name of the Wide Field Instrument (WFI) detector used + to take the science data in this file. $ref: wfi_detector-1.0.0 sdf: special_processing: VALUE_REQUIRED @@ -35,9 +37,10 @@ properties: datatype: nvarchar(10) destination: [WFIExposure.detector, GuideWindow.detector, WFICommon.detector] optical_element: - title: WFI Optical Element + title: Wide Field Instrument (WFI) Optical Element description: | - WFI optical element used to take the data. + Name of the optical element used to take the science + data. $ref: wfi_optical_element-1.0.0 sdf: special_processing: VALUE_REQUIRED 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 78bd2fbf..b2e0102e 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,7 +3,9 @@ $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: Level 1 WFI Imaging and Spectrographic Science Data +title: | + Level 1 (L1) Uncalibrated Roman Wide Field + Instrument (WFI) Ramp Cube datamodel_name: ScienceRawModel @@ -16,27 +18,28 @@ properties: data: title: Science Data (DN) description: | - Science data, including reference pixels in units of DN + Uncalibrated science ramp cube in units of data + numbers (DNs) tag: tag:stsci.edu:asdf/core/ndarray-1.* ndim: 3 datatype: uint16 unit: "DN" exact_datatype: true - amp33: title: Amplifier 33 Reference Pixel Data (DN) description: | - Reference pixel data from amplifier 33 in units of DN. + Reference pixel data from amplifier 33 in units of + data numbers (DNs) tag: tag:stsci.edu:asdf/core/ndarray-1.* ndim: 3 datatype: uint16 unit: "DN" exact_datatype: true - resultantdq: title: Resultant Data Quality Array description: | - An optional, 3-D data quality array, with plane DQ for each resultant. + Optional, 3-D data quality array with a plane for each + resultant. tag: tag:stsci.edu:asdf/core/ndarray-1.* ndim: 3 datatype: uint8