associations-1.0.0

Association Table Data Model

Outline

Schema Definitions
Original Schema

Schema Definitions ¶

This type is an object with the following properties:

asn_id
string Required
Association ID

The unique identifier of the association to which the processed observations belong.

No length restriction
asn_pool
string Required
Association Pool

No length restriction
asn_type
string Required
Association Type

The type of association observed, such as a dither FOV association or a mosaic survey association.

No length restriction
asn_rule
string Required
Association Rule

Any rules that need to be followed for this particular type of association.

No length restriction
version_id
string
Version ID

The unique version identifier that provides context for the data release version and circumstances for the processing.

No length restriction
code_version
string
Code Version

The exact code version used to process the observations.

No length restriction
degraded_status
string
Degraded Status

Details about how the observations might have suffered degradation, such as a guide star failure.

No length restriction
program
integer
Program ID

The unique program identifier to which the associated observations belong.
target
integer
Target Name

The name or ID of the target being observed.
constraints
string
Constraints

No length restriction
products
array Required
Resultant Products

The resulting output products created by the processing.

No length restriction
Items in the array are restricted to the following types:
This type is an object with the following properties:
- name
  string Required
  No length restriction
- members
  array Required
  No length restriction
  Items in the array are restricted to the following types:
  
  This type is an object with the following properties:
  
  expname
  string Required
  No length restriction
  exposerr
  string Required
  No length restriction
  exptype
  string Required
  No length restriction
  
  Only the following values are valid for this node:
  
  SCIENCE
  
  CALIBRATION
  
  ENGINEERING

Original Schema ¶

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

title: Association Table Data Model

datamodel_name: AssociationsModel

type: object
properties:
  asn_id:
    title: Association ID
    description: |
      The unique identifier of the association to which the processed
      observations belong.
    type: string
  asn_pool:
    title: Association Pool
    type: string
  asn_type:
    title: Association Type
    description: |
      The type of association observed, such as a dither FOV association or a
      mosaic survey association.
    type: string
  asn_rule:
    title: Association Rule
    description: |
      Any rules that need to be followed for this particular type of
      association.
    type: string
  version_id:
    title: Version ID
    description: |
      The unique version identifier that provides context for the data release
      version and circumstances for the processing.
    type: string
  code_version:
    title: Code Version
    description: |
      The exact code version used to process the observations.
    type: string
  degraded_status:
    title: Degraded Status
    description: |
      Details about how the observations might have suffered degradation, such
      as a guide star failure.
    type: string
  program:
    title: Program ID
    description: |
      The unique program identifier to which the associated observations belong.
    type: integer
  target:
    title: Target Name
    description: |
      The name or ID of the target being observed.
    type: integer
  constraints:
    title: Constraints
    type: string
  products:
    title: Resultant Products
    description: |
      The resulting output products created by the processing.
    type: array
    items:
      type: object
      properties:
        name:
          type: string
        members:
          type: array
          items:
            type: object
            properties:
              expname:
                type: string
              exposerr:
                type: string
              exptype:
                type: string
                enum: ["SCIENCE", "CALIBRATION", "ENGINEERING"]
            required: [expname, exposerr, exptype]
      required: [name, members]

required: [asn_id, asn_pool, asn_type, asn_rule, products]
flowStyle: block
propertyOrder:
  [
    asn_id,
    asn_pool,
    asn_type,
    asn_rule,
    version_id,
    code_version,
    degraded_status,
    program,
    target,
    constraints,
    products,
  ]