core/generic_series-0.1.0#

Schema that describes a quantity that depends on one or more dimensions.

Description

Describes a dimension dependent quantity.

Outline

Schema Definitions Internal Definitions Original Schema

Schema Definitions ¶

This node must validate against one of the following:

Internal Definitions ¶

discrete

object

This type is an object with the following properties:

data
asdf://weldx.bam.de/weldx/tags/units/quantity-0.1.* Required
The discrete data of the multidimensional quantity.
interpolation
string
Name of the interpolation method that should be used on the data.

No length restriction
dimensions
array Required
The names of all dimensions, in the order as they occur in the data.

No length restriction

Items in the array are restricted to the following types:

string
No length restriction
coordinates
object Required
The coordinate values of the data

object

expression

object

This type is an object with the following properties:

expression
string Required
The expression that describes the series

No length restriction
units
asdf://weldx.bam.de/weldx/tags/units/units-0.1.* Required
Units of the data after the evaluation of the expression.
free_dimensions
object Required
A list of all dimensions that are variables of the expression.

object
parameters
object
A list of all expression symbols that have fixed values assigned to them.

object

Original Schema ¶

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

title: |
  Schema that describes a quantity that depends on one or more dimensions.
description: |
  Describes a dimension dependent quantity.

definitions:
  discrete:
    type: object
    properties:
      data:
        description: |
          The discrete data of the multidimensional quantity.
        tag: "asdf://weldx.bam.de/weldx/tags/units/quantity-0.1.*"
      interpolation:
        description: |
          Name of the interpolation method that should be used on the data.
        type: string
      dimensions:
        description: |
          The names of all dimensions, in the order as they occur in the data.
        type: array
        items:
          type: string
      coordinates:
        description: |
          The coordinate values of the data
        type: object
        wx_property_tag: "asdf://weldx.bam.de/weldx/tags/units/quantity-0.1.*"
    required: [data, dimensions, coordinates]
    propertyOrder: [data, interpolation, dimensions, coordinates]

  expression:
    type: object
    properties:
      expression:
        description: |
          The expression that describes the series
        type: string
      units:
        description: |
          Units of the data after the evaluation of the expression.
        tag: "asdf://weldx.bam.de/weldx/tags/units/units-0.1.*"
      free_dimensions:
        description: |
          A list of all dimensions that are variables of the expression.
        type: object
        wx_property_tag: "asdf://weldx.bam.de/weldx/tags/core/generic_series_free_dimension-0.1.0"
      parameters:
        description: |
          A list of all expression symbols that have fixed values assigned to them.
        type: object
        wx_property_tag:
          - "asdf://weldx.bam.de/weldx/tags/units/quantity-0.1.*"
          - "asdf://weldx.bam.de/weldx/tags/core/data_array-0.1.*"

    required: [expression, units, free_dimensions]
    propertyOrder: [expression, units, free_dimensions, parameters]

oneOf:
  - $ref: "#definitions/discrete"
  - $ref: "#definitions/expression"

flowStyle: block
...