visit-1.0.0

Visit Information

Outline

Schema Definitions
Original Schema

Schema Definitions ¶

This type is an object with the following properties:

engineering_quality
string Required
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.

No length restriction
Only the following values are valid for this node:
- OK
- SUSPECT
pointing_engdb_quality
string Required
The quality of the pointing information from the Engineering Database (EngDB). The options available are “CALCULATED” and “PLANNED”.

No length restriction
Only the following values are valid for this node:
- CALCULATED
- PLANNED
type
string Required
The type of visit.

No length restriction
start_time
tag:stsci.edu:asdf/time/time-1.* Required
The start time of the visit in coordinated universal time (UTC).
end_time
tag:stsci.edu:asdf/time/time-1.* Required
The end time of the visit in coordinated universal time (UTC).
status
string Required
The status of a visit.

No length restriction
total_exposures
integer Required
The total number of exposures planned in a visit.
internal_target
boolean Required
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.
target_of_opportunity
boolean Required
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.

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:
  engineering_quality:
    title: Engineering Quality of Data
    description: |
      The engineering data quality indicator from the Engineering Database
      (EngDB). The options available are "OK" and "SUSPECT", where "SUSPECT"
      identifies data with indications of poor data quality.
    type: string
    enum: [OK, SUSPECT]
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nvarchar(10)
      destination: [WFIExposure.engineering_quality, GuideWindow.engineering_quality,
                    SourceCatalog.engineering_quality, SegmentationMap.engineering_quality]
  pointing_engdb_quality:
    title: Engineering Quality of Pointing
    description: |
      The quality of the pointing information from the Engineering Database
      (EngDB). The options available are "CALCULATED" and "PLANNED".
    type: string
    enum: [CALCULATED, PLANNED]
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nvarchar(10)
      destination: [WFIExposure.pointing_engdb_quality, GuideWindow.pointing_engdb_quality,
                    SourceCatalog.pointing_engdb_quality, SegmentationMap.pointing_engdb_quality]
  type:
    title: Visit Type
    description: |
      The type of visit.
    type: string
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: PSS:dms_visit.visit_type
    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 start time of the visit in coordinated universal time (UTC).
    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 end time of the visit in coordinated universal time (UTC).
    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: |
      The status of a visit.
    type: string
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nvarchar(15)
      destination: [WFIExposure.visit_status, GuideWindow.visit_status,
                    SourceCatalog.visit_status, SegmentationMap.visit_status]
  total_exposures:
    title: Total Number of Exposures
    description: |
      The total number of exposures planned in a visit.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: int
      destination: [WFIExposure.visit_total_exposures, GuideWindow.visit_total_exposures,
                    SourceCatalog.visit_total_exposures, SegmentationMap.visit_total_exposures]
  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.
    type: boolean
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      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]
flowStyle: block
required: [engineering_quality, pointing_engdb_quality, type,
           start_time, end_time, status, total_exposures, internal_target, target_of_opportunity]
...