CCSP/ccsp_custom_product-1.0.0
CCSP custom product metadata
Description
This schema is the union of all shared metadata for Roman Community Contributed Science Product (CCSP) data. It should be referenced in the schemas of custom data products which do not closely mimic the metadata of Roman SOC mission products. Otherwise, for data products whose schemas reference or closely mimic SOC schemas, reference the ccsp_minimal schema directly instead.
Outline
Schema Definitions ¶
This node must validate against all of the following:
This type is an object with the following properties:
file_date
tag:stsci.edu:asdf/time/time-1.* Required File creation date
File creation date-time in ISO 8601 format with UTC time scale.
exposure
object Exposure information
This type is an object with the following properties:
start_time
tag:stsci.edu:asdf/time/time-1.* Required Start time
Start time of data acquisition in ISO 8601 format.
end_time
tag:stsci.edu:asdf/time/time-1.* Required End time
End time of data acquisition in ISO 8601 format.
exposure_time
number Exposure time (s)
The amount of time elapsed between the start and the end of the observation or data stream.
effective_exposure_time
number Required Effective exposure time (s)
The total accumulated effective exposure duration for this data product, excluding dead time and lost time.
instrument
object Instrument observing configuration
This type is an object with the following properties:
name
object Required Instrument name
This node must validate against any of the following:
- No length restriction
string
null
- No length restriction
array
Items in the array are restricted to the following types:
No length restrictionstring
detector
object Required Detector
This node must validate against any of the following:
- No length restriction
string
null
- No length restriction
array
Items in the array are restricted to the following types:
No length restrictionstring
optical_element
object Required Optical element
Name of filter, disperser, or other optical element.
This node must validate against any of the following:
- No length restriction
string
null
- No length restriction
array
Items in the array are restricted to the following types:
No length restrictionstring
telescope
string Telescope name
No length restrictionName of telescope, typically Roman.
target_coordinates
object Position for this data product
This type is an object with the following properties:
reference_frame
No length restrictionstring Required Only the following values are valid for this node:
ICRS
ra
number Required Right ascension (deg)
Characteristic right ascension in degrees; typically the center of the spatial image, or the target coordinates of a spectrum or light curve. May be null for large survey images, simulated data, etc.
dec
number Required Declination (deg)
Characteristic declination in degrees; typically the center of the spatial image, or the target coordinates of a spectrum or light curve. May be null for large survey images, simulated data, etc.
s_region
string STC-S formatted sky footprint
No length restrictionSky footprint for this data product, formatted as an IVOA Space-Time Coordinate Metadata Linear String (STC-S) in units of degrees.
pixel_scale
number Pixel scale of spatial axes (arcsec/pixel)
wavelength
object Wavelength information
This type is an object with the following properties:
band
object Required Waveband
Waveband of this data product, used to enable archival searches. Select from: RADIO, MILLIMETER, INFRARED, OPTICAL, UV, EUV, XRAY, GAMMARAY.
This node must validate against any of the following:
- No length restriction
string
- No length restriction
array
Items in the array are restricted to the following types:
No length restrictionstring
minimum
object Required Minimum wavelength
Minimum wavelength bound of this data product, used to enable archival searches. Specify units in MAST documentation or a higher-level schema.
This node must validate against any of the following:
number
null
maximum
object Required Maximum wavelength
Maximum wavelength bound of this data product, used to enable archival searches. Specify units in MAST documentation or a higher-level schema.
This node must validate against any of the following:
number
null
Original Schema ¶
%YAML 1.1
---
$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
id: asdf://stsci.edu/datamodels/roman/schemas/CCSP/ccsp_custom_product-1.0.0
title: CCSP custom product metadata
description: |
This schema is the union of all shared metadata for Roman Community
Contributed Science Product (CCSP) data. It should be referenced in
the schemas of custom data products which do not closely mimic the
metadata of Roman SOC mission products. Otherwise, for data products
whose schemas reference or closely mimic SOC schemas, reference the
ccsp_minimal schema directly instead.
allOf:
- $ref: asdf://stsci.edu/datamodels/roman/schemas/CCSP/ccsp_minimal-1.0.0
- type: object
properties:
file_date:
title: File creation date
description: |
File creation date-time in ISO 8601 format with UTC time
scale.
tag: tag:stsci.edu:asdf/time/time-1.*
exposure:
title: Exposure information
type: object
properties:
start_time:
title: Start time
description: |
Start time of data acquisition in ISO 8601 format.
tag: tag:stsci.edu:asdf/time/time-1.*
end_time:
title: End time
description: |
End time of data acquisition in ISO 8601 format.
tag: tag:stsci.edu:asdf/time/time-1.*
exposure_time:
title: Exposure time (s)
description: |
The amount of time elapsed between the start and the end
of the observation or data stream.
type: number
unit: "s"
effective_exposure_time:
title: Effective exposure time (s)
description: |
The total accumulated effective exposure duration for
this data product, excluding dead time and lost time.
type: number
unit: "s"
required: [start_time, end_time, effective_exposure_time]
instrument:
title: Instrument observing configuration
type: object
properties:
name:
title: Instrument name
anyOf:
- type: string
- type: "null"
- type: array
items:
type: string
detector:
title: Detector
anyOf:
- type: string
- type: "null"
- type: array
items:
type: string
optical_element:
title: Optical element
description: |
Name of filter, disperser, or other optical element.
anyOf:
- type: string
- type: "null"
- type: array
items:
type: string
required: [name, detector, optical_element]
telescope:
title: Telescope name
description: |
Name of telescope, typically Roman.
type: string
target_coordinates:
title: Position for this data product
type: object
properties:
reference_frame:
type: string
enum: ["ICRS"]
ra:
title: Right ascension (deg)
description: |
Characteristic right ascension in degrees; typically the
center of the spatial image, or the target coordinates
of a spectrum or light curve. May be null for large
survey images, simulated data, etc.
type: number
unit: "deg"
dec:
title: Declination (deg)
description: |
Characteristic declination in degrees; typically the
center of the spatial image, or the target coordinates
of a spectrum or light curve. May be null for large
survey images, simulated data, etc.
type: number
unit: "deg"
required: [reference_frame, ra, dec]
s_region:
title: STC-S formatted sky footprint
description: |
Sky footprint for this data product, formatted as an IVOA
Space-Time Coordinate Metadata Linear String (STC-S) in units
of degrees.
type: string
pixel_scale:
title: Pixel scale of spatial axes (arcsec/pixel)
type: number
unit: "arcsec/pixel"
wavelength:
title: Wavelength information
type: object
properties:
band:
title: Waveband
description: |
Waveband of this data product, used to enable archival
searches. Select from: RADIO, MILLIMETER, INFRARED,
OPTICAL, UV, EUV, XRAY, GAMMARAY.
anyOf:
- type: string
- type: array
items:
type: string
minimum:
title: Minimum wavelength
description: |
Minimum wavelength bound of this data product, used to
enable archival searches. Specify units in MAST
documentation or a higher-level schema.
anyOf:
- type: number
- type: "null"
maximum:
title: Maximum wavelength
description: |
Maximum wavelength bound of this data product, used to
enable archival searches. Specify units in MAST
documentation or a higher-level schema.
anyOf:
- type: number
- type: "null"
required: [band, minimum, maximum]
required: [file_date]