meta/l3_common-1.0.0
Common Level 3 Metadata
Outline
Schema Definitions ¶
This type is an object with the following properties:
calibration_software_name
asdf://stsci.edu/datamodels/roman/schemas/meta/calibration_software_name-1.0.0 Required calibration_software_version
asdf://stsci.edu/datamodels/roman/schemas/meta/calibration_software_version-1.0.0 Required data_release_id
string Data Release Identifier
A label for the data release (if applicable). This keyword is optional and only populated for data release products.
Maximum length: 120
filename
asdf://stsci.edu/datamodels/roman/schemas/meta/filename-1.0.0 Required file_date
asdf://stsci.edu/datamodels/roman/schemas/meta/file_date-1.0.0 Required model_type
asdf://stsci.edu/datamodels/roman/schemas/meta/model_type-1.0.0 Required origin
asdf://stsci.edu/datamodels/roman/schemas/meta/origin-1.0.0 Required product_type
asdf://stsci.edu/datamodels/roman/schemas/meta/product_type-1.0.0 Required telescope
asdf://stsci.edu/datamodels/roman/schemas/meta/telescope-1.0.0 Required cal_logs
asdf://stsci.edu/datamodels/roman/schemas/meta/cal_logs-1.0.0 coordinates
object Celestial Coordinate Reference Frame
This type is an object with the following properties:
reference_frame
string Required Name of the Celestial Coordinate Reference Frame
No length restrictionName of the celestial coordinate reference frame used for the World Coordinate System (WCS).
Only the following values are valid for this node:
ICRS
coadd_info
object Co-Addition Information
This type is an object with the following properties:
time_first
tag:stsci.edu:asdf/time/time-1.* Required Start Time of the First Exposure
The Universal Coordinated Time (UTC) start time of the first exposure ordered in time used to create the co-added product. The time is serialized on disk as an International Organization for Standardization (ISO) 8601-compliant ISOT string. 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.
time_last
tag:stsci.edu:asdf/time/time-1.* Required End Time of the Last Exposure
The Universal Coordinated Time (UTC) end time of the last exposure ordered in time used to create the co-added product. The time is serialized on disk as an International Organization for Standardization (ISO) 8601-compliant ISOT string. 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.
time_mean
tag:stsci.edu:asdf/time/time-1.* Required Mean Time of the Co-Added Data Product
The Universal Coordinated Time (UTC) mean start time of the exposures used to create the co-added product. The time is serialized on disk as an International Organization for Standardization (ISO) 8601-compliant ISOT string. 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.
max_exposure_time
number Maximum Exposure Time (s)
Maximum exposure time of all pixels in the co-added product in units of seconds. The exposure times of each input pixel are drizzled onto the output frame, and then the maximum is computed from all output pixels with exposure time > 0 seconds.
exposure_time
number Required Exposure Time (s)
A representative exposure time for the co-added product in units of seconds. For Roman SOC products, the exposure times of each input pixel are drizzled on the output frame, and then the mean exposure time is computed from all output pixels with exposure time > 0 seconds. Please check the keyword meta.origin for contextual information.
individual_image_meta
asdf://stsci.edu/datamodels/roman/schemas/meta/individual_image_meta-1.0.0 instrument
object Wide Field Instrument (WFI) Configuration Information
This type is an object with the following properties:
name
string Required Instrument Name
No length restrictionName of the instrument used to acquire the science data.
Only the following values are valid for this node:
WFI
optical_element
object Required Wide Field Instrument (WFI) Optical Element
Name of the optical element used to take the science data. If data using multiple optical elements are combined, the value of optical_element will be None.
This node must validate against any of the following:
null
observation
object Observation Identifiers
This type is an object with the following properties:
execution_plan
object Required Execution Plan Number
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.
This node must validate against any of the following:
integer
null
exposure
object Required Exposure Number
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.
This node must validate against any of the following:
integer
null
exposure_grouping
object Required Exposure Grouping
Conceptual type of exposure grouping used to create this coadd (e.g., by visit, or full)
This node must validate against any of the following:
string
Maximum length: 120
null
observation
object Required Observation Number
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.
This node must validate against any of the following:
integer
null
pass
object Required Pass Number
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.
This node must validate against any of the following:
integer
null
program
object Required Program Number
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.
This node must validate against any of the following:
integer
null
segment
object Required Segment Number
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.
This node must validate against any of the following:
integer
null
visit
object Required Visit Number
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.
This node must validate against any of the following:
integer
null
program
object Program Information
This type is an object with the following properties:
title
object Required Proposal Title
The submitted proposal title of the program.
This node must validate against any of the following:
string
Maximum length: 200
null
investigator_name
object Required Principle Investigator Name
The name of the principle investigator (PI) of the program.
This node must validate against any of the following:
string
Maximum length: 100
null
category
object Required Program Category
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).
This node must validate against any of the following:
string
Maximum length: 6
null
subcategory
object Required Program Subcategory
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.
This node must validate against any of the following:
- No length restriction
string
Only the following values are valid for this node:
CAL
CGI
CR
DR
GBTD
HLTD
HLWA
OR
WFI
WFSC
None
null
science_category
object Required Science Category
The science category assigned during the Time Allocation Committee (TAC) review process.
This node must validate against any of the following:
string
Maximum length: 50
null
statistics
object Basic Statistical Information
This type is an object with the following properties:
image_median
number Required Median Image Value (MJy/sr)
Median image value in units of megaJanskys per steradian (MJy/sr).
image_rms
number Required Image Mean Absolute Deviation (MJy/sr)
Mean absolute deviation of the image values in units of megaJanskys per steradian (MJy/sr).
good_pixel_fraction
number Required Fraction of Good Pixels
The fraction of pixels in the output image that are considered good.
Original Schema ¶
%YAML 1.1
---
$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
id: asdf://stsci.edu/datamodels/roman/schemas/meta/l3_common-1.0.0
title: Common Level 3 Metadata
type: object
properties:
calibration_software_name:
$ref: asdf://stsci.edu/datamodels/roman/schemas/meta/calibration_software_name-1.0.0
calibration_software_version:
$ref: asdf://stsci.edu/datamodels/roman/schemas/meta/calibration_software_version-1.0.0
data_release_id:
title: Data Release Identifier
description: >
A label for the data release (if applicable). This keyword
is optional and only populated for data release products.
type: string
maxLength: 120
archive_catalog:
datatype: nvarchar(120)
destination: [WFIMosaic.data_release_id]
filename:
$ref: asdf://stsci.edu/datamodels/roman/schemas/meta/filename-1.0.0
file_date:
$ref: asdf://stsci.edu/datamodels/roman/schemas/meta/file_date-1.0.0
model_type:
$ref: asdf://stsci.edu/datamodels/roman/schemas/meta/model_type-1.0.0
origin:
$ref: asdf://stsci.edu/datamodels/roman/schemas/meta/origin-1.0.0
product_type:
$ref: asdf://stsci.edu/datamodels/roman/schemas/meta/product_type-1.0.0
telescope:
$ref: asdf://stsci.edu/datamodels/roman/schemas/meta/telescope-1.0.0
cal_logs:
$ref: asdf://stsci.edu/datamodels/roman/schemas/meta/cal_logs-1.0.0
coordinates:
title: Celestial Coordinate Reference Frame
properties:
reference_frame:
title: Name of the Celestial Coordinate Reference Frame
description: >
Name of the celestial coordinate reference frame used
for the World Coordinate System (WCS).
type: string
archive_catalog:
datatype: nvarchar(10)
destination: [WFIMosaic.reference_frame]
enum: [ICRS]
required: [reference_frame]
coadd_info:
title: Co-Addition Information
properties:
time_first:
title: Start Time of the First Exposure
description: >
The Universal Coordinated Time (UTC) start time of
the first exposure ordered in time used to create the
co-added product. The time is serialized on disk as an
International Organization for Standardization (ISO)
8601-compliant ISOT string. 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.*
archive_catalog:
datatype: datetime2
destination: [WFIMosaic.time_first]
time_last:
title: End Time of the Last Exposure
description: >
The Universal Coordinated Time (UTC) end time of
the last exposure ordered in time used to create the
co-added product. The time is serialized on disk as an
International Organization for Standardization (ISO)
8601-compliant ISOT string. 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.*
archive_catalog:
datatype: datetime2
destination: [WFIMosaic.time_last]
time_mean:
title: Mean Time of the Co-Added Data Product
description: >
The Universal Coordinated Time (UTC) mean start
time of the exposures used to create the co-added product.
The time is serialized on disk as an International
Organization for Standardization (ISO) 8601-compliant ISOT
string. 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.*
archive_catalog:
datatype: datetime2
destination: [WFIMosaic.time_mean]
max_exposure_time:
title: Maximum Exposure Time (s)
description: >
Maximum exposure time of all pixels in the
co-added product in units of seconds. The exposure times of
each input pixel are drizzled onto the output frame, and
then the maximum is computed from all output pixels with
exposure time > 0 seconds.
type: number
archive_catalog:
datatype: float
destination: [WFIMosaic.max_exposure_time]
exposure_time:
title: Exposure Time (s)
description: >
A representative exposure time for the co-added
product in units of seconds. For Roman SOC products, the
exposure times of each input pixel are drizzled on the
output frame, and then the mean exposure time is computed
from all output pixels with exposure time > 0 seconds.
Please check the keyword meta.origin for contextual
information.
type: number
archive_catalog:
datatype: float
destination: [WFIMosaic.exposure_time]
required: [time_first, time_last, time_mean, exposure_time]
individual_image_meta:
$ref: asdf://stsci.edu/datamodels/roman/schemas/meta/individual_image_meta-1.0.0
instrument:
title: Wide Field Instrument (WFI) Configuration Information
properties:
name:
title: Instrument Name
description: >
Name of the instrument used to acquire the science data.
type: string
enum: [WFI]
archive_catalog:
datatype: nvarchar(5)
destination: [WFIMosaic.instrument_name]
optical_element:
title: Wide Field Instrument (WFI) Optical Element
description: >
Name of the optical element used to take the science
data. If data using multiple optical elements are combined, the
value of optical_element will be None.
anyOf:
- $ref: asdf://stsci.edu/datamodels/roman/schemas/enums/wfi_optical_element-1.0.0
- type: "null"
archive_catalog:
datatype: nvarchar(20)
destination: [WFIMosaic.optical_element]
required: [name, optical_element]
observation:
title: Observation Identifiers
properties:
execution_plan:
title: Execution Plan Number
description: >
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.
anyOf:
- type: integer
- type: "null"
archive_catalog:
datatype: smallint
destination: [WFIMosaic.execution_plan]
exposure:
title: Exposure Number
description: |
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.
anyOf:
- type: integer
- type: "null"
archive_catalog:
datatype: smallint
destination: [WFIMosaic.exposure]
exposure_grouping:
title: Exposure Grouping
description: >
Conceptual type of exposure grouping used to create this coadd (e.g., by visit, or full)
anyOf:
- type: string
maxLength: 120
- type: "null"
archive_catalog:
datatype: nvarchar(120)
destination: [WFIMosaic.exposure_grouping]
observation:
title: Observation Number
description: |
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.
anyOf:
- type: integer
- type: "null"
archive_catalog:
datatype: smallint
destination: [WFIMosaic.observation]
pass:
title: Pass Number
description: >
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.
anyOf:
- type: integer
- type: "null"
archive_catalog:
datatype: smallint
destination: [WFIMosaic.pass]
program:
title: Program Number
description: >
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.
anyOf:
- type: integer
- type: "null"
archive_catalog:
datatype: int
destination: [WFIMosaic.program]
segment:
title: Segment Number
description: >
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.
anyOf:
- type: integer
- type: "null"
archive_catalog:
datatype: smallint
destination: [WFIMosaic.segment]
visit:
title: Visit Number
description: >
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.
anyOf:
- type: integer
- type: "null"
archive_catalog:
datatype: smallint
destination: [WFIMosaic.visit]
required:
[
execution_plan,
exposure,
exposure_grouping,
observation,
pass,
program,
segment,
visit,
]
program:
title: Program Information
properties:
title:
title: Proposal Title
description: The submitted proposal title of the program.
anyOf:
- type: string
maxLength: 200
- type: "null"
archive_catalog:
datatype: nvarchar(200)
destination: [WFIMosaic.program_title]
investigator_name:
title: Principle Investigator Name
description: The name of the principle investigator (PI) of the program.
anyOf:
- type: string
maxLength: 100
- type: "null"
archive_catalog:
datatype: nvarchar(100)
destination: [WFIMosaic.investigator_name]
category:
title: Program Category
description: >
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).
anyOf:
- type: string
maxLength: 6
- type: "null"
archive_catalog:
datatype: nvarchar(6)
destination: [WFIMosaic.program_category]
subcategory:
title: Program Subcategory
description: >
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.
anyOf:
- type: string
enum:
[
"CAL",
"CGI",
"CR",
"DR",
"GBTD",
"HLTD",
"HLWA",
"OR",
"WFI",
"WFSC",
"None",
]
- type: "null"
archive_catalog:
datatype: nvarchar(15)
destination: [WFIMosaic.program_subcategory]
science_category:
title: Science Category
description: >
The science category assigned during the Time Allocation Committee (TAC) review process.
anyOf:
- type: string
maxLength: 50
- type: "null"
archive_catalog:
datatype: nvarchar(50)
destination: [WFIMosaic.science_category]
required:
[title, investigator_name, category, subcategory, science_category]
statistics:
title: Basic Statistical Information
properties:
image_median:
title: Median Image Value (MJy/sr)
description: >
Median image value in units of megaJanskys per steradian (MJy/sr).
type: number
image_rms:
title: Image Mean Absolute Deviation (MJy/sr)
description: >
Mean absolute deviation of the image values in
units of megaJanskys per steradian (MJy/sr).
type: number
good_pixel_fraction:
title: Fraction of Good Pixels
description: >
The fraction of pixels in the output image that
are considered good.
type: number
required: [image_median, image_rms, good_pixel_fraction]
required:
[
calibration_software_name,
calibration_software_version,
filename,
file_date,
model_type,
product_type,
origin,
telescope,
]