measurement/signal-0.1.0#

Representation of a measurement signal with optional data attached.

Outline

Schema DefinitionsExamplesOriginal Schema

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

  • units
    asdf://weldx.bam.de/weldx/tags/units/units-0.1.*Required
    The unit of the signal (volt, kelvin, etc.).

  • data
    asdf://weldx.bam.de/weldx/tags/core/time_series-0.1.*
    Measurement data that was produced by the signal.

Examples

A signal representing an analog voltage measurement without data.:

!<asdf://weldx.bam.de/weldx/tags/measurement/signal-0.1.0>
  signal_type: analog
  units: !<asdf://weldx.bam.de/weldx/tags/units/units-0.1.0> volt

A digital dimensionless signal.:

!<asdf://weldx.bam.de/weldx/tags/measurement/signal-0.1.0>
  signal_type: digital
  units: !<asdf://weldx.bam.de/weldx/tags/units/units-0.1.0> dimensionless

Original Schema 

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

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

examples:
  -
    - A signal representing an analog voltage measurement without data.
    - |
      !<asdf://weldx.bam.de/weldx/tags/measurement/signal-0.1.0>
        signal_type: analog
        units: !<asdf://weldx.bam.de/weldx/tags/units/units-0.1.0> volt
  -
    - A digital dimensionless signal.
    - |
      !<asdf://weldx.bam.de/weldx/tags/measurement/signal-0.1.0>
        signal_type: digital
        units: !<asdf://weldx.bam.de/weldx/tags/units/units-0.1.0> dimensionless

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


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