measurement/signal-1.0.0

Representation of a measurement signal with optional data attached.

Outline

Schema Definitions

This type is an object with the following properties:
  • signal_type
    stringRequired
    The type of the signal (analog or digital).

    No length restriction
    Only the following values are valid for this node:
    • analog

    • digital

  • unit
    stringRequired
    The unit of the signal (volt, kelvin, etc.).

    No length restriction
  • data
    tag:weldx.bam.de:weldx/core/time_series-1.0.0
    Measurement data that was produced by the signal.

Examples

A signal representing an analog voltage measurement without data.:

!<tag:weldx.bam.de:weldx/measurement/signal-1.0.0>
  signal_type: analog
  unit: V

A digital dimensionless signal.:

!<tag:weldx.bam.de:weldx/measurement/signal-1.0.0>
  signal_type: digital
  unit: ''

Original Schema

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

title: |
  Representation of a measurement signal with optional data attached.
type: object

examples:
  -
    - A signal representing an analog voltage measurement without data.
    - |
      !<tag:weldx.bam.de:weldx/measurement/signal-1.0.0>
        signal_type: analog
        unit: V
  -
    - A digital dimensionless signal.
    - |
      !<tag:weldx.bam.de:weldx/measurement/signal-1.0.0>
        signal_type: digital
        unit: ''

properties:
  signal_type:
    description: |
      The type of the signal (analog or digital).
    type: string
    enum: [analog, digital]
  unit:
    description: |
      The unit of the signal (volt, kelvin, etc.).
    type: string
  data:
    description: |
      Measurement data that was produced by the signal.
    tag: "tag:weldx.bam.de:weldx/core/time_series-1.0.0"


propertyOrder: [signal_type, unit, data]
required: [signal_type, unit]
flowStyle: block
...