ref_common-1.2.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
Reference File Type

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

No length restriction
pedigree
string Required
Pedigree

The pedigree of the reference file (e.g., GROUND).

No length restriction
description
string Required
Description

A string describing the reference file, its intended usage, etc.

No length restriction
author
string Required
Author

The author of who or what created the reference file.

No length restriction
useafter
tag:stsci.edu:asdf/time/time-1.* Required
Use After Date

The use after date of the reference file for CRDS best references matching.
telescope
asdf://stsci.edu/datamodels/roman/schemas/meta/telescope-1.0.0 Required
origin
string Required
Organization

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
  Instrument
  
  The Wide Field Instrument (WFI).
  
  No length restriction
  Only the following values are valid for this node:
  - WFI
- detector
  object Required
  Detector
  
  The numbered WFI detector in the focal plane (e.g., WFI01 for SCA 01).
  This node must validate against all of the following:
  
  asdf://stsci.edu/datamodels/roman/schemas/enums/wfi_detector-1.0.0

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.2.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
  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:
    $ref: asdf://stsci.edu/datamodels/roman/schemas/meta/telescope-1.0.0
  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:
        allOf:
          - $ref: asdf://stsci.edu/datamodels/roman/schemas/enums/wfi_detector-1.0.0
        title: Detector
        description: |
          The numbered WFI detector in the focal plane (e.g., WFI01 for SCA 01).
    required: [name, detector]
required:
  [
    reftype,
    author,
    description,
    pedigree,
    useafter,
    telescope,
    origin,
    instrument,
  ]