ref_common-1.0.0

Common Reference File Metadata Properties

Outline

Schema Definitions
Original Schema

Schema Definitions ¶

This type is an object with the following properties:

reftype
string Required
The capitalized string of the reference file type (e.g., DARK).

No length restriction
pedigree
string Required
The pedigree of the reference file (e.g., GROUND).

No length restriction
Only the following values are valid for this node:
- GROUND
- MODEL
- DUMMY
- SIMULATION
description
string Required
A string describing the reference file, its intended usage, etc.

No length restriction
author
string Required
The author of who or what created the reference file.

No length restriction
useafter
tag:stsci.edu:asdf/time/time-1.* Required
The use after date of the reference file for CRDS best references matching.
telescope
object Required
The telescope data used to select reference files, e.g. ROMAN for the Nancy Grace Roman Space Telescope.
This node must validate against any of the following:
- asdf://stsci.edu/datamodels/roman/tags/telescope-1.0.0
- string
  No length restriction
  
  Only the following values are valid for this node:
  
  ROMAN
origin
string Required
The organization responsible for creating the file, e.g. STSCI for the Space Telescope Science Institute.

No length restriction
instrument
object Required
This type is an object with the following properties:
- name
  string Required
  The Wide Field Instrument (WFI).
  
  No length restriction
  Only the following values are valid for this node:
  - WFI
- detector
  ../wfi_detector-1.0.0 Required
  The numbered WFI detector in the focal plane (e.g., WFI01 for SCA 01).

Original Schema ¶

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

title: Common Reference File Metadata Properties

type: object
properties:
  reftype:
    title: Reference File Type
    description: |
      The capitalized string of the reference file type (e.g., DARK).
    type: string
  pedigree:
    title: Pedigree
    description: |
      The pedigree of the reference file (e.g., GROUND).
    type: string
    enum: [GROUND, MODEL, DUMMY, SIMULATION]
  description:
    title: Description
    description: |
      A string describing the reference file, its intended usage, etc.
    type: string
  author:
    title: Author
    description: |
      The author of who or what created the reference file.
    type: string
  useafter:
    title: Use After Date
    description: |
      The use after date of the reference file for CRDS best references
      matching.
    tag: tag:stsci.edu:asdf/time/time-1.*
  telescope:
    title: Telescope
    description: |
      The telescope data used to select reference files, e.g. ROMAN for the
      Nancy Grace Roman Space Telescope.
    anyOf:
      - tag: asdf://stsci.edu/datamodels/roman/tags/telescope-1.0.0
      - type: string
        enum: [ROMAN]
  origin:
    title: Organization
    description: |
      The organization responsible for creating the file, e.g. STSCI for the
      Space Telescope Science Institute.
    type: string
  instrument:
    type: object
    properties:
      name:
        title: Instrument
        description: |
          The Wide Field Instrument (WFI).
        type: string
        enum: [WFI]
      detector:
        title: Detector
        description: |
          The numbered WFI detector in the focal plane (e.g., WFI01 for SCA 01).
        $ref: ../wfi_detector-1.0.0
    required: [name, detector]
required: [reftype, author, description, pedigree, useafter, telescope, origin, instrument]
...