core/time_series-1.0.0¶

Schema that describes a time series.

Description

Describes a time dependent quantity.

Outline

Schema Definitions Original Schema

Schema Definitions ¶

This node must validate against one of the following:

This type is an object with the following properties:
- value
  object Required
  Number or n-dimensional array that is constant in time.
  This node must validate against any of the following:
  
  number
  
  tag:stsci.edu:asdf/core/ndarray-1.0.0
- unit
  string Required
  Unit of the data.
  
  No length restriction
This type is an object with the following properties:
- expression
  tag:weldx.bam.de:weldx/core/mathematical_expression-1.0.0 Required
  A mathematical expression that describes the time dependent behaviour.
- unit
  string Required
  Resulting unit of the data when the expression is evaluated.
  
  No length restriction
- shape
  array
  (optional) Resulting shape of the data when the expression is evaluated.
  
  No length restriction
This type is an object with the following properties:
- time
  tag:weldx.bam.de:weldx/time/timedeltaindex-1.0.0 Required
  A set of time deltas.
- unit
  string Required
  Unit of the data.
  
  No length restriction
- shape
  array Required
  Shape of the data.
  
  No length restriction
- interpolation
  string Required
  Method how the data should be interpolated.
  
  No length restriction
  Only the following values are valid for this node:
  - linear
  - step
- values
  tag:stsci.edu:asdf/core/ndarray-1.0.0 Required
  Set of discrete n-dimensional data.

Original Schema ¶

%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://weldx.bam.de/weldx/core/time_series-1.0.0"
tag: "tag:weldx.bam.de:weldx/core/time_series-1.0.0"

title: |
  Schema that describes a time series.
description: |
  Describes a time dependent quantity.
oneOf:
  - type: object
    description: |
      Implementation for constant values.
    properties:
      value:
        description: |
          Number or n-dimensional array that is constant in time.
        anyOf:
          - type: number
          - tag: "tag:stsci.edu:asdf/core/ndarray-1.0.0"
      unit:
        description: |
          Unit of the data.
        type: string
    required: [value, unit]

  - type: object
    description: |
      Implementation for expressions.
    properties:
      expression:
        description: |
          A mathematical expression that describes the time dependent behaviour.
        tag: "tag:weldx.bam.de:weldx/core/mathematical_expression-1.0.0"
      unit:
        description: |
          Resulting unit of the data when the expression is evaluated.
        type: string
      shape:
        description: |
          (optional) Resulting shape of the data when the expression is evaluated.
        type: array
    required: [expression, unit]

  - type: object
    description: |
      Implementation for discrete data.
    properties:
      time:
        description: |
          A set of time deltas.
        tag: "tag:weldx.bam.de:weldx/time/timedeltaindex-1.0.0"
      unit:
        description: |
          Unit of the data.
        type: string
      shape:
        description: |
          Shape of the data.
        type: array
      interpolation:
        description: |
          Method how the data should be interpolated.
        type: string
        enum: [linear, step]
      values:
        description: |
          Set of discrete n-dimensional data.
        tag: "tag:stsci.edu:asdf/core/ndarray-1.0.0"
    wx_shape:
      #description: |
      #  The outer dimension of the data needs to be identical to the times dimension.
      time: [t]
      values: [t, ...]
    required: [time, unit, shape, interpolation, values]

propertyOrder: [expression, values, time, unit, shape, interpolation, values]
flowStyle: block
...