wfi_mosaic-1.3.0

The schema for WFI Level 3 mosaics.

Outline

Schema Definitions ΒΆ

This type is an object with the following properties:

  • meta

    objectRequired

    This node must validate against all of the following:

    • This node has no type definition (unrestricted)
    • This type is an object with the following properties:

      • association

        objectRequired

        Association Information

        This type is an object with the following properties:

        • name

          stringRequired

          Association File Name

          Name of the association file used to generate the data product.

          No length restriction
      • cal_step

        objectRequired

        Level 3 Calibration Status

        This type is an object with the following properties:

      • resample

        objectRequired

        Resample Parameters

        This type is an object with the following properties:

        • good_bits

          stringRequired

          Bit Mask

          Bit mask used in the resample step. This key contains strings that correspond to bits in the data quality (DQ) arrays of calibrated rate images. Bits are combined using plus signs (+) and use the bitwise operator tilde (~) to denote exclusion. For example, the string β€œ~DO_NOT_USE+NON_SCIENCE” means to allow all data quality bits except DO_NOT_USE and NON_SCIENCE to be included in the final product. Conversely, a string of β€œGOOD” would only allow pixels with DQ bits equal to 0 in the calibrated rate images to be included in the final product.

          No length restriction
        • pixel_scale_ratio

          numberRequired

          Pixel Scale Ratio

          The ratio of the pixel scale compared to the native detector pixel scale. For example, a pixel scale of 0.9 will produce a resampled image with smaller pixels compared to the input calibrated rate images.

        • pixfrac

          numberRequired

          Pixel Fraction

          The fraction of a pixel to use for pixel convolution.

        • pointings

          integerRequired

          Number of Input Images

          The number of input images combined with resample into an output product.

        • members

          arrayRequired

          Resample Input Filenames

          Names of the calibrated rate image files input into the resample code to create the output product.

          No length restriction

          Items in the array are restricted to the following types:

          string

          No length restriction
        • weight_type

          stringRequired

          Weight Type

          The weight type used by the drizzle algorithm in the resample step. The two weight options available are exposure time (β€œexptime”) and inverse variance map (β€œivm”) weighting.

          No length restriction
      • wcs

        tag:stsci.edu:gwcs/wcs-*Required

        World Coordinate System (WCS)

      • wcsinfo

        objectRequired

        WCS Information

        This type is an object with the following properties:

        • ra_ref

          numberRequired

          Right Ascension of Projection Region Center (deg)

          Right ascension in units of degrees at the center of the projection region over which the world coordinate system (WCS) of this image is defined. If this product does not use the Roman sky tessellation, then this keyword will be equal to meta.wcsinfo.ra.

        • dec_ref

          numberRequired

          Declination of Projection Region Center (deg)

          Declination in units of degrees at the center of the projection region over which the world coordinate system (WCS) of this image is defined. If this product does not use the Roman sky tessellation, then this keyword will be equal to meta.wcsinfo.dec.

        • x_ref

          numberRequired

          X Coordinate of Projection Region Center

          Pixel X coordinate at the center of the projection region over which the world coordinate system (WCS) of this image is defined. If the projection region is larger than the image contained within this file, then the value of x_ref may or may not be contained within the boundaries of the data array in this file.

        • y_ref

          numberRequired

          Y Coordinate of Projection Region Center

          Pixel Y coordinate at the center of the projection region over which the world coordinate system (WCS) of this image is defined. If the projection region is larger than the image contained within this file, then the value of y_ref may or may not be contained within the boundaries of the data array in this file.

        • pixel_scale_ref

          numberRequired

          Pixel Scale at Projection Region Center (arcseconds per pixel)

          Pixel scale in units of arcseconds per pixel at the center of the projection region. If this product does not use the Roman sky tessellation, then this keyword will be equal to meta.wcsinfo.pixel_scale.

        • pixel_scale

          numberRequired

          Pixel Scale at Image Center (arcseconds per pixel)

          Pixel scale in units of arcseconds per pixel at the center of the image in this file.

        • projection

          stringRequired

          Projection Type

          Type of projection used for the world coordinate system (WCS). A value of β€œTAN” indicates a tangent plane projection.

          Maximum length: 50

          Only the following values are valid for this node:

          • TAN

        • s_region

          stringRequired

          Spatial Extent of the Image

          The region of the sky enclosed by the pixel data contained within this file. This is given as a polygon stored as a string with the vertices defined by a list of right ascension and declination pairs in units of degrees.

          No length restriction
        • image_shape

          arrayRequired

          Shape of Image (pixels)

          Shape of the image (nx, ny) in units of pixels.

          Minimum length: 2

          Maximum length: 2

          Items in the array are restricted to the following types:

          integer

        • ra

          numberRequired

          Right Ascension of Image Center (deg)

          Right ascension in units of degrees at the center of the image.

        • dec

          numberRequired

          Declination of Image Center (deg)

          Declination in units of degrees at the center of the image.

        • orientation

          numberRequired

          Image Orientation (deg)

          Angle in units of degrees between celestial North and the image y-axis at the center of the image turning positive in the direction of increasing right ascension.

        • orientation_ref

          numberRequired

          Projection Region Orientation (deg)

          Angle in units of degrees between celestial North and the image y-axis at the center of the projection region turning positive in the direction of increasing right ascension. If this product does not use the Roman sky tessellation, then this keyword will be equal to meta.wcsinfo.orientation.

        • skycell_name

          objectRequired

          Skycell Name

          Name of the skycell in the Roman sky tessellation to which this product corresponds. If this product is not a skycell product, this field will be None.

          This node must validate against any of the following:

          • string

            Maximum length: 30

          • null

        • rotation_matrix

          arrayRequired

          2x2 rotation matrix

          No length restriction

          Items in the array are restricted to the following types:

          array

          No length restriction

          Items in the array are restricted to the following types:

          number

  • data

    tag:stsci.edu:asdf/core/ndarray-1.*Required

    Science Data (MJy / steradian)

    The science data array, excluding the border reference pixels in units of MJy / steradian.

  • err

    tag:stsci.edu:asdf/core/ndarray-1.*Required

    Error Data (MJy / steradian)

  • context

    tag:stsci.edu:asdf/core/ndarray-1.*Required

    Context Data

  • weight

    tag:stsci.edu:asdf/core/ndarray-1.*Required

    Weight Data

  • var_poisson

    tag:stsci.edu:asdf/core/ndarray-1.*Required

    Poisson Variability (MJy^2 / steradian^2)

  • var_rnoise

    tag:stsci.edu:asdf/core/ndarray-1.*Required

    Read Noise Variance (MJy^2 / steradian^2

  • var_flat

    tag:stsci.edu:asdf/core/ndarray-1.*

    Flat Field Variance (MJy^2 / steradian^2)

  • var_sky

    tag:stsci.edu:asdf/core/ndarray-1.*

    Sky Variance (MJy^2 / steradian^2)

Original Schema ΒΆ

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

title: The schema for WFI Level 3 mosaics.

datamodel_name: MosaicModel
archive_meta: None

type: object
properties:
  meta:
    allOf:
      - $ref: asdf://stsci.edu/datamodels/roman/schemas/l3_common-1.0.0
      - required:
          [
            cal_logs,
            coadd_info,
            coordinates,
            individual_image_meta,
            instrument,
            observation,
            program,
            statistics,
          ]
      - properties:
          association:
            title: Association Information
            type: object
            properties:
              name:
                title: Association File Name
                description: >
                  Name of the association file used to generate the data product.
                type: string
            required: [name]
          cal_step:
            title: Level 3 Calibration Status
            type: object
            properties:
              flux:
                title: Flux Scale Application Step
                description: >
                  Step in romancal that applies the scaling factor(s)
                  necessary to convert from units of data numbers per second
                  (DN/s) to megaJanskys per steradian (MJy/sr).
                allOf:
                  - $ref: asdf://stsci.edu/datamodels/roman/schemas/cal_step_flag-1.0.0
                archive_catalog:
                  datatype: nvarchar(15)
                  destination: [ScienceRefData.s_flux]
              outlier_detection:
                title: Outlier Detection Step
                description: >
                  Step in romancal that detects and flags outliers in a stack of rate images.
                allOf:
                  - $ref: asdf://stsci.edu/datamodels/roman/schemas/cal_step_flag-1.0.0
                archive_catalog:
                  datatype: nvarchar(15)
                  destination: [ScienceRefData.s_outlier_detection]
              skymatch:
                title: Sky Matching Step
                description: >
                  Step in romancal that matches sky background levels of
                  each input image and derives scaling factors to equalize
                  overlapping regions.
                allOf:
                  - $ref: asdf://stsci.edu/datamodels/roman/schemas/cal_step_flag-1.0.0
                archive_catalog:
                  datatype: nvarchar(15)
                  destination: [ScienceRefData.s_skymatch]
              resample:
                title: Resampling Step
                description: >
                  Step in romancal which resamples and coadds each input 2D image based on its WCS
                  onto a grid, in order to combine multiple images into a single coadded product.
                allOf:
                  - $ref: asdf://stsci.edu/datamodels/roman/schemas/cal_step_flag-1.0.0
                archive_catalog:
                  datatype: nvarchar(15)
                  destination: [ScienceRefData.s_resample]
            required: [flux, outlier_detection, resample, skymatch]
          resample:
            title: Resample Parameters
            type: object
            properties:
              good_bits:
                title: Bit Mask
                description: >
                  Bit mask used in the resample step. This key contains
                  strings that correspond to bits in the data quality (DQ) arrays
                  of calibrated rate images. Bits are combined using plus signs
                  (+) and use the bitwise operator tilde (~) to denote exclusion.
                  For example, the string "~DO_NOT_USE+NON_SCIENCE" means to allow
                  all data quality bits except DO_NOT_USE and NON_SCIENCE to be
                  included in the final product. Conversely, a string of "GOOD"
                  would only allow pixels with DQ bits equal to 0 in the
                  calibrated rate images to be included in the final product.
                type: string
              pixel_scale_ratio:
                title: Pixel Scale Ratio
                description: >
                  The ratio of the pixel scale compared to the native
                  detector pixel scale. For example, a pixel scale of 0.9 will
                  produce a resampled image with smaller pixels compared to the
                  input calibrated rate images.
                type: number
              pixfrac:
                title: Pixel Fraction
                description: The fraction of a pixel to use for pixel convolution.
                type: number
              pointings:
                title: Number of Input Images
                description: >
                  The number of input images combined with resample into an output product.
                type: integer
              members:
                title: Resample Input Filenames
                description: >
                  Names of the calibrated rate image files input into
                  the resample code to create the output product.
                type: array
                items:
                  type: string
              weight_type:
                title: Weight Type
                description: >
                  The weight type used by the drizzle algorithm in the
                  resample step. The two weight options available are exposure
                  time ("exptime") and inverse variance map ("ivm") weighting.
                type: string
            required:
              [
                good_bits,
                members,
                pixel_scale_ratio,
                pixfrac,
                pointings,
                weight_type,
              ]
          wcs:
            title: World Coordinate System (WCS)
            tag: tag:stsci.edu:gwcs/wcs-*
          wcsinfo:
            title: WCS Information
            type: object
            properties:
              ra_ref:
                title: Right Ascension of Projection Region Center (deg)
                description: >
                  Right ascension in units of degrees at the center of
                  the projection region over which the world coordinate system
                  (WCS) of this image is defined. If this product does not use the
                  Roman sky tessellation, then this keyword will be equal to
                  meta.wcsinfo.ra.
                type: number
                archive_catalog:
                  datatype: float
                  destination: [WFIMosaic.ra_ref]
              dec_ref:
                title: Declination of Projection Region Center (deg)
                description: >
                  Declination in units of degrees at the center of the
                  projection region over which the world coordinate system (WCS)
                  of this image is defined. If this product does not use the Roman
                  sky tessellation, then this keyword will be equal to
                  meta.wcsinfo.dec.
                type: number
                archive_catalog:
                  datatype: float
                  destination: [WFIMosaic.dec_ref]
              x_ref:
                title: X Coordinate of Projection Region Center
                description: >
                  Pixel X coordinate at the center of the projection
                  region over which the world coordinate system (WCS) of this
                  image is defined. If the projection region is larger than the
                  image contained within this file, then the value of x_ref may or
                  may not be contained within the boundaries of the data array in
                  this file.
                type: number
                archive_catalog:
                  datatype: float
                  destination: [WFIMosaic.x_ref]
              y_ref:
                title: Y Coordinate of Projection Region Center
                description: >
                  Pixel Y coordinate at the center of the projection
                  region over which the world coordinate system (WCS) of this
                  image is defined. If the projection region is larger than the
                  image contained within this file, then the value of y_ref may or
                  may not be contained within the boundaries of the data array in
                  this file.
                type: number
                archive_catalog:
                  datatype: float
                  destination: [WFIMosaic.y_ref]
              pixel_scale_ref:
                title: Pixel Scale at Projection Region Center (arcseconds per pixel)
                description: >
                  Pixel scale in units of arcseconds per pixel at the
                  center of the projection region. If this product does not use
                  the Roman sky tessellation, then this keyword will be equal to
                  meta.wcsinfo.pixel_scale.
                type: number
                archive_catalog:
                  datatype: float
                  destination: [WFIMosaic.pixel_scale_ref]
              pixel_scale:
                title: Pixel Scale at Image Center (arcseconds per pixel)
                description: >
                  Pixel scale in units of arcseconds per pixel at the center of the image in this file.
                type: number
                archive_catalog:
                  datatype: float
                  destination: [WFIMosaic.pixel_scale]
              projection:
                title: Projection Type
                description: >
                  Type of projection used for the world coordinate
                  system (WCS). A value of "TAN" indicates a tangent plane projection.
                type: string
                enum: ["TAN"]
                maxLength: 50
                archive_catalog:
                  datatype: nvarchar(50)
                  destination: [WFIMosaic.projection]
              s_region:
                title: Spatial Extent of the Image
                description: >
                  The region of the sky enclosed by the pixel data
                  contained within this file. This is given as a polygon stored as
                  a string with the vertices defined by a list of right ascension
                  and declination pairs in units of degrees.
                type: string
                archive_catalog:
                  datatype: nvarchar(max)
                  destination: [WFIMosaic.s_region]
              image_shape:
                title: Shape of Image (pixels)
                description: Shape of the image (nx, ny) in units of pixels.
                type: array
                minItems: 2
                maxItems: 2
                items:
                  type: integer
                archive_catalog:
                  datatype: nvarchar(50)
                  destination: [WFIMosaic.image_shape]
              ra:
                title: Right Ascension of Image Center (deg)
                description: Right ascension in units of degrees at the center of the image.
                type: number
                archive_catalog:
                  datatype: float
                  destination: [WFIMosaic.ra]
              dec:
                title: Declination of Image Center (deg)
                description: Declination in units of degrees at the center of the image.
                type: number
                archive_catalog:
                  datatype: float
                  destination: [WFIMosaic.dec]
              orientation:
                title: Image Orientation (deg)
                description: >
                  Angle in units of degrees between celestial North and
                  the image y-axis at the center of the image turning positive in
                  the direction of increasing right ascension.
                type: number
                archive_catalog:
                  datatype: float
                  destination: [WFIMosaic.orientation]
              orientation_ref:
                title: Projection Region Orientation (deg)
                description: >
                  Angle in units of degrees between celestial North and
                  the image y-axis at the center of the projection region turning
                  positive in the direction of increasing right ascension. If this
                  product does not use the Roman sky tessellation, then this
                  keyword will be equal to meta.wcsinfo.orientation.
                type: number
                archive_catalog:
                  datatype: float
                  destination: [WFIMosaic.orientation_ref]
              skycell_name:
                title: Skycell Name
                description: >
                  Name of the skycell in the Roman sky tessellation to
                  which this product corresponds. If this product is not a skycell
                  product, this field will be None.
                anyOf:
                  - type: string
                    maxLength: 30
                  - type: "null"
                archive_catalog:
                  datatype: nvarchar(30)
                  destination: [WFIMosaic.skycell_name]
              rotation_matrix:
                title: 2x2 rotation matrix
                type: array
                items:
                  type: array
                  items:
                    type: number
                sdf:
                  special_processing: VALUE_REQUIRED
                  source:
                    origin: TBD
                archive_catalog:
                  datatype: nvarchar(3500)
                  destination: [WFIMosaic.rotation_matrix]
            required:
              [
                ra_ref,
                dec_ref,
                x_ref,
                y_ref,
                pixel_scale_ref,
                pixel_scale,
                projection,
                s_region,
                image_shape,
                ra,
                dec,
                orientation,
                orientation_ref,
                skycell_name,
                rotation_matrix,
              ]
        required: [association, cal_step, resample, wcs, wcsinfo]
  data:
    title: Science Data (MJy / steradian)
    description: |
      The science data array, excluding the border reference pixels in units of
      MJy / steradian.
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: float32
    exact_datatype: true
    ndim: 2
    unit: "MJy.sr**-1"
  err:
    title: Error Data (MJy / steradian)
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: float32
    exact_datatype: true
    ndim: 2
    unit: "MJy.sr**-1"
  context:
    title: Context Data
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: uint32
    exact_datatype: true
    ndim: 3
  weight:
    title: Weight Data
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: float32
    exact_datatype: true
    ndim: 2
  var_poisson:
    title: Poisson Variability (MJy^2 / steradian^2)
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: float32
    exact_datatype: true
    ndim: 2
    unit: "MJy**2.sr**-2"
  var_rnoise:
    title: Read Noise Variance (MJy^2 / steradian^2
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: float32
    exact_datatype: true
    ndim: 2
    unit: "MJy**2.sr**-2"
  var_flat:
    title: Flat Field Variance (MJy^2 / steradian^2)
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: float32
    exact_datatype: true
    ndim: 2
    unit: "MJy**2.sr**-2"
  var_sky:
    title: Sky Variance (MJy^2 / steradian^2)
    tag: tag:stsci.edu:asdf/core/ndarray-1.*
    datatype: float32
    exact_datatype: true
    ndim: 2
    unit: "MJy**2.sr**-2"
propertyOrder:
  [meta, data, context, err, weight, var_poisson, var_rnoise, var_flat, var_sky]
flowStyle: block
required: [meta, data, context, err, weight, var_poisson, var_rnoise]