visit-1.0.0
Visit Information
Outline
Schema Definitions ¶
This type is an object with the following properties:
dither
object Required Dither Pattern Information
This type is an object with the following properties:
primary_name
object Required Primary Dither Pattern Name
Name of the primary dither pattern used for the visit.
This node must validate against any of the following:
- No length restriction
string
null
subpixel_name
object Required Subpixel Dither Pattern Name
Name of the subpixel dither pattern used for the visit.
This node must validate against any of the following:
- No length restriction
string
null
executed_pattern
object Required Executed Dither Pattern Offsets (arcsec)
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.
This node must validate against any of the following:
- No length restriction
array
Items in the array are restricted to the following types:
number
null
engineering_quality
string Required Engineering 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.
Maximum length: 10
Only the following values are valid for this node:
OK
SUSPECT
pointing_engineering_source
string Required Pointing Engineering Source
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.
Maximum length: 10
Only the following values are valid for this node:
CALCULATED
PLANNED
type
string Required Visit Type
The type of visit from observation planning.
Maximum length: 30
Only the following values are valid for this node:
GENERAL_ENGINEERING
GENERIC
PARALLEL
PRIME_TARGETED_FIXED
PRIME_UNTARGETED
start_time
tag:stsci.edu:asdf/time/time-1.* Required Visit Start 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.
end_time
tag:stsci.edu:asdf/time/time-1.* Required Visit End 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.
status
string Required Visit Status
Execution status of the visit.
Maximum length: 15
Only the following values are valid for this node:
DATALOSS
SUCCESSFUL
UNSUCCESSFUL
nexposures
integer Required Number of Planned Exposures
The total number of exposures planned within the visit.
internal_target
boolean Required Internal Target
A boolean indicator which, if true, indicates that the target for the visit is an internal calibration target.
Original Schema ¶
%YAML 1.1
---
$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
id: asdf://stsci.edu/datamodels/roman/schemas/visit-1.0.0
title: Visit Information
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: PSS:dms_visit.dither_type
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: PSS:dms_visit.subpixel_dither_type
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 Data Quality
description: |
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:
special_processing: VALUE_REQUIRED
source:
origin: TBD
maxLength: 10
archive_catalog:
datatype: nvarchar(10)
destination:
[
WFIExposure.engineering_quality,
GuideWindow.engineering_quality,
SourceCatalog.engineering_quality,
SegmentationMap.engineering_quality,
]
pointing_engineering_source:
title: Pointing Engineering Source
description: |
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:
special_processing: VALUE_REQUIRED
source:
origin: TBD
maxLength: 10
archive_catalog:
datatype: nvarchar(10)
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 from observation planning.
type: string
enum:
[
"GENERAL_ENGINEERING",
"GENERIC",
"PARALLEL",
"PRIME_TARGETED_FIXED",
"PRIME_UNTARGETED",
]
sdf:
special_processing: VALUE_REQUIRED
source:
origin: PSS:dms_visit.visit_type
maxLength: 30
archive_catalog:
datatype: nvarchar(30)
destination:
[
WFIExposure.visit_type,
GuideWindow.visit_type,
SourceCatalog.visit_type,
SegmentationMap.visit_type,
]
start_time:
title: Visit Start Time (UTC)
description: |
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
source:
origin: TBD
archive_catalog:
datatype: datetime2
destination:
[
WFIExposure.visit_start_time,
GuideWindow.visit_start_time,
SourceCatalog.visit_start_time,
SegmentationMap.visit_start_time,
]
end_time:
title: Visit End Time (UTC)
description: |
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
source:
origin: TBD
archive_catalog:
datatype: datetime2
destination:
[
WFIExposure.visit_end_time,
GuideWindow.visit_end_time,
SourceCatalog.visit_end_time,
SegmentationMap.visit_end_time,
]
status:
title: Visit Status
description: |
Execution status of the visit.
type: string
enum: ["DATALOSS", "SUCCESSFUL", "UNSUCCESSFUL"]
sdf:
special_processing: VALUE_REQUIRED
source:
origin: TBD
maxLength: 15
archive_catalog:
datatype: nvarchar(15)
destination:
[
WFIExposure.visit_status,
GuideWindow.visit_status,
SourceCatalog.visit_status,
SegmentationMap.visit_status,
]
nexposures:
title: Number of Planned Exposures
description: |
The total number of exposures planned within the
visit.
type: integer
sdf:
special_processing: VALUE_REQUIRED
source:
origin: PSS:dms_visit.exposures_per_dither
archive_catalog:
datatype: int
destination:
[
WFIExposure.visit_nexposures,
GuideWindow.visit_nexposures,
SourceCatalog.visit_nexposures,
SegmentationMap.visit_nexposures,
]
internal_target:
title: Internal Target
description: |
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
source:
origin: PSS:dms_visit.internal_target
archive_catalog:
datatype: nchar(1)
destination:
[
WFIExposure.visit_internal_target,
GuideWindow.visit_internal_target,
SourceCatalog.visit_internal_target,
SegmentationMap.visit_internal_target,
]
propertyOrder:
[
dither,
engineering_quality,
pointing_engineering_source,
type,
start_time,
end_time,
status,
nexposures,
internal_target,
]
flowStyle: block
required:
[
dither,
engineering_quality,
pointing_engineering_source,
type,
start_time,
end_time,
status,
nexposures,
internal_target,
]