observation-1.0.0

Observation Identifiers

Outline

• Schema Definitions
• Original Schema

Schema Definitions

This type is an object with the following properties:

• obs_id

  string

  Required

  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 + visit_file_activity) + exposure.

  No length restriction

• visit_id

  string

  Required

  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.

  No length restriction

• program

  string

  Required

  The defined range of the program number is 00001 to 18445; included in obs_id and visit_id as ‘PPPPP’.

  No length restriction

• execution_plan

  integer

  Required

  The defined range of the execution plan within the program is 01 to 99; included in obs_id and visit_id as ‘CC’.

• pass

  integer

  Required

  The defined range of the pass number within the execution plan is 001 to 999; included in obs_id and visit_id as ‘AAA’.

• segment

  integer

  Required

  The defined range of the segment number within the pass is 001 to 999; included in obs_id and visit_id as ‘SSS’.

• observation

  integer

  Required

  The defined range of the observation number within the segment is 001 to 999; included in obs_id and visit_id as ‘OOO’.

• visit

  integer

  Required

  The defined range of the visit number within the observation is 001 to 999; included in obs_id and visit_id as ‘VVV’.

• visit_file_group

  integer

  Required

  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’.

• visit_file_sequence

  integer

  Required

  The defined range of the visit file sequence within the group 1 to 5; included in obs_id as ‘s’.

• visit_file_activity

  string

  Required

  The defined range of the visit file activity within the sequence is 01 to ZZ; included in obs_id as ‘aa’.

  No length restriction

• exposure

  integer

  Required

  The defined range of the assigned exposure number within the visit is 0001 to 9999; included in obs_id as ‘eeee’.

• template

  string

  Required

  The template used to design this observation.

  No length restriction

• observation_label

  string

  Required

  The label given by the proposer to describe the observation.

  No length restriction

• survey

  string

  Required

  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.

  No length restriction

  Only the following values are valid for this node:

  • HLS

  • EMS

  • SN

  • N/A

Original Schema

%YAML 1.1
---
$schema: asdf://stsci.edu/datamodels/roman/schemas/rad_schema-1.0.0
id: asdf://stsci.edu/datamodels/roman/schemas/observation-1.0.0

title: Observation Identifiers
type: object
properties:
  obs_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 +
      visit_file_activity) + exposure.
    type: string
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nvarchar(28)
      destination: [WFIExposure.obs_id, GuideWindow.obs_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.
    type: string
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nvarchar(19)
      destination: [WFIExposure.visit_id, GuideWindow.visit_id]
  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
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: int
      destination: [WFIExposure.program, GuideWindow.program]
  execution_plan:
    title: Execution Plan
    description: |
      The defined range of the execution plan within the program is 01 to 99;
      included in obs_id and visit_id as 'CC'.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: smallint
      destination: [WFIExposure.execution_plan, GuideWindow.execution_plan]
  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'.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: smallint
      destination: [WFIExposure.pass, GuideWindow.pass]
  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'.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: smallint
      destination: [WFIExposure.segment, GuideWindow.segment]
  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'.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: smallint
      destination: [WFIExposure.observation, GuideWindow.observation]
  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'.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: smallint
      destination: [WFIExposure.visit, GuideWindow.visit]
  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'.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: smallint
      destination: [WFIExposure.visit_file_group, GuideWindow.visit_file_group]
  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'.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: tinyint
      destination: [WFIExposure.visit_file_sequence, GuideWindow.visit_file_sequence]
  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'.
    type: string
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    archive_catalog:
      datatype: nvarchar(2)
      destination: [WFIExposure.visit_file_activity, GuideWindow.visit_file_activity]
  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'.
    type: integer
    sdf:
      special_processing: VALUE_REQUIRED
      source:
        origin: TBD
    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
    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]
    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]
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]
...