core/variable-0.1.0#

Schema that describes a variable.

Description

This class is a slight modification of the corresponding NetCDF datamodel item. (See https://www.unidata.ucar.edu/software/netcdf/docs/netcdf_data_model.html)

Outline

Schema Definitions

This type is an object with the following properties:
  • name
    stringRequired
    The variables name.

    No length restriction
  • dimensions
    arrayRequired
    An array that contains the dimension names in the correct order (outer to inner).

    No length restriction
  • dtype
    stringRequired
    The arrays fundamental data type defined by a code of 3 characters (adapted from NumPy). For further information see: https://numpy.org/doc/stable/reference/arrays.interface.html#arrays-interface

    No length restriction
  • data
    objectRequired
    An n-dimensional array that contains the data.

    This node must validate against one of the following:

  • units
    asdf://weldx.bam.de/weldx/tags/units/units-0.1.*
    Optional field describing the unit of the data.

  • attrs
    object
    Additional attributes metadata associated with the variable.

    object

Original Schema

%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "asdf://weldx.bam.de/weldx/schemas/core/variable-0.1.0"

title: |
  Schema that describes a variable.
description: |
  This class is a slight modification of the corresponding NetCDF datamodel item.
  (See https://www.unidata.ucar.edu/software/netcdf/docs/netcdf_data_model.html)
type: object
properties:
  name:
    description: |
      The variables name.
    type: string
  dimensions:
    description: |
      An array that contains the dimension names in the correct order (outer to inner).
    type: array
  dtype:
    description: |
      The arrays fundamental data type defined by a code of 3 characters (adapted from NumPy). For further information
      see: https://numpy.org/doc/stable/reference/arrays.interface.html#arrays-interface
    type: string
  data:
    description: |
      An n-dimensional array that contains the data.
    oneOf:
      - tag: "tag:stsci.edu:asdf/core/ndarray-1.*"
      - type: number
  units:
    description: |
      Optional field describing the unit of the data.
    tag: "asdf://weldx.bam.de/weldx/tags/units/units-0.1.*"
  attrs:
    description: |
      Additional attributes metadata associated with the variable.
    type: object

required: [name, dimensions, dtype, data]
propertyOrder: [name, dimensions, dtype, units, data]
flowStyle: block
...