measurement/error-0.1.0#

Measurement error description.

Description

A basic schema to represent a measurement error.

Outline

Schema Definitions Examples Original Schema

Schema Definitions ¶

This type is an object with the following properties:

deviation
object Required
A simple numerical representation of the error.
This node must validate against one of the following:
- number
- asdf://weldx.bam.de/weldx/tags/units/quantity-0.1.*

Examples ¶

An error representing a deviation of 0.1%.:

!<asdf://weldx.bam.de/weldx/tags/measurement/error-0.1.0>
  deviation: !<asdf://weldx.bam.de/weldx/tags/units/quantity-0.1.0> {value: 0.1, units: !<asdf://weldx.bam.de/weldx/tags/units/units-0.1.0> percent}

Original Schema ¶

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

title: |
  Measurement error description.
description: |
  A basic schema to represent a measurement error.

examples:
  -
    - An error representing a deviation of 0.1%.
    - |
      !<asdf://weldx.bam.de/weldx/tags/measurement/error-0.1.0>
        deviation: !<asdf://weldx.bam.de/weldx/tags/units/quantity-0.1.0> {value: 0.1, units: !<asdf://weldx.bam.de/weldx/tags/units/units-0.1.0> percent}

type: object
properties:
  deviation:
    description: |
      A simple numerical representation of the error.
    oneOf:
      - type: number
      - tag: "asdf://weldx.bam.de/weldx/tags/units/quantity-0.1.*"
required: [deviation]
flowStyle: block
...