wfi_img_photom-1.3.0

WFI Imaging Photometric Flux Conversion Data Model

Outline

Schema Definitions

This type is an object with the following properties:

  • meta

    objectRequired

    This node must validate against all of the following:

  • phot_table

    objectRequired

    Photometric Properties Table

    Table containing photometric properties of the WFI optical elements.

    object

Internal Definitions

  • basic_phot_table_entry

    object

    This type is an object with the following properties:

    • photmjsr

      objectRequired

      Surface Brightness Zeropoint

      Zeropoint that converts from data numbers per second (DN/s) to megaJanskys per steradian (MJy/sr).

      This node has no type definition (unrestricted)
    • uncertainty

      objectRequired

      Surface Brightness Zeropoint Uncertainty

      Uncertainty in the zeropoint that converts from units of data numbers per second (DN/s) to megaJanskys per steradian (MJy/sr).

      This node has no type definition (unrestricted)
    • pixelareasr

      objectRequired

      Nominal Pixel Area

      The nominal pixel area in units of steradians.

      This node has no type definition (unrestricted)
    • collecting_area

      objectRequired

      Collecting Area (square meters)

      Collecting area of the telescope in units of square meters (m^2) for the selected optical element. This value includes the primary mirror area and any obstructions in the optical chain.

      This node has no type definition (unrestricted)
    • wavelength

      objectRequired

      Effective Area Wavelength Array (microns)

      The wavelength array in units of microns at which the effective area has been measured.

      This node has no type definition (unrestricted)
    • effective_area

      objectRequired

      Effective Area Array (m^2)

      The effective area in units of square meters (m^2) as a function of wavelength.

      This node has no type definition (unrestricted)
  • 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/wfi_img_photom-1.3.0
    
    title: WFI Imaging Photometric Flux Conversion Data Model
    
    datamodel_name: WfiImgPhotomRefModel
    
    definitions:
      basic_phot_table_entry:
        type: object
        properties:
          photmjsr:
            title: Surface Brightness Zeropoint
            description: |
              Zeropoint that converts from data numbers per second (DN/s) to megaJanskys per steradian (MJy/sr).
          uncertainty:
            title: Surface Brightness Zeropoint Uncertainty
            description: |
              Uncertainty in the zeropoint that converts from units of data numbers per second (DN/s) to megaJanskys per steradian (MJy/sr).
          pixelareasr:
            title: Nominal Pixel Area
            description: |
              The nominal pixel area in units of steradians.
          collecting_area:
            title: Collecting Area (square meters)
            description: |
              Collecting area of the telescope in units of square meters (m^2) for the selected optical element. This value includes the primary mirror area and any obstructions in the optical chain.
          wavelength:
            title: Effective Area Wavelength Array (microns)
            description: |
              The wavelength array in units of microns at which the effective area has been measured.
          effective_area:
            title: Effective Area Array (m^2)
            description: |
              The effective area in units of square meters (m^2) as a function of wavelength.
        required:
          [
            photmjsr,
            uncertainty,
            pixelareasr,
            collecting_area,
            wavelength,
            effective_area,
          ]
    
    type: object
    properties:
      meta:
        allOf:
          - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/ref_common-1.2.0
          - type: object
            properties:
              reftype:
                type: string
                enum: [PHOTOM]
      phot_table:
        title: Photometric Properties Table
        description: |
          Table containing photometric properties of the WFI optical elements.
        type: object
        patternProperties:
          "^(F062|F087|F106|F129|F146|F158|F184|F213)$":
            allOf:
              - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/wfi_img_photom-1.3.0#/definitions/basic_phot_table_entry
              - type: object
                properties:
                  photmjsr:
                    type: number
                    unit: "(MJy/sr) / (DN/s)"
                  uncertainty:
                    type: number
                    unit: "(MJy/sr) / (DN/s)"
                  pixelareasr:
                    type: number
                    unit: "sr"
                  collecting_area:
                    type: number
                    unit: "m^2"
                  wavelength:
                    tag: tag:stsci.edu:asdf/core/ndarray-1.*
                    datatype: float32
                    exact_datatype: true
                    ndim: 1
                    unit: "microns"
                  effective_area:
                    tag: tag:stsci.edu:asdf/core/ndarray-1.*
                    datatype: float32
                    exact_datatype: true
                    ndim: 1
                    unit: "m^2"
          # GRISM_0 is a special optical element case that is only used for this reference file
          "^(GRISM|GRISM_0|PRISM)$":
            allOf:
              - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/wfi_img_photom-1.3.0#/definitions/basic_phot_table_entry
              - type: object
                properties:
                  photmjsr:
                    type: "null"
                  uncertainty:
                    type: "null"
                  pixelareasr:
                    type: "null"
                  collecting_area:
                    type: number
                    unit: "m^2"
                  wavelength:
                    tag: tag:stsci.edu:asdf/core/ndarray-1.*
                    datatype: float32
                    exact_datatype: true
                    ndim: 1
                    unit: "microns"
                  effective_area:
                    tag: tag:stsci.edu:asdf/core/ndarray-1.*
                    datatype: float32
                    exact_datatype: true
                    ndim: 1
                    unit: "m^2"
          "^(DARK|NOT_CONFIGURED)$":
            allOf:
              - $ref: asdf://stsci.edu/datamodels/roman/schemas/reference_files/wfi_img_photom-1.3.0#/definitions/basic_phot_table_entry
              - type: object
                properties:
                  photmjsr:
                    type: "null"
                  uncertainty:
                    type: "null"
                  pixelareasr:
                    type: "null"
                  collecting_area:
                    type: "null"
                  wavelength:
                    type: "null"
                  effective_area:
                    type: "null"
        additionalProperties: false
    required: [meta, phot_table]
    flowStyle: block
    propertyOrder: [meta, phot_table]