time/datetimeindex-1.0.0¶

Represents an array of timestamps following pandas.DatetimeIndex.

Outline

Schema Definitions Internal Definitions Original Schema

Schema Definitions ¶

This node must validate against one of the following:

This type is an object with the following properties:
- values
  values Required
- start
  start
- end
  end
- freq
  freq
- min
  min
- max
  max
This type is an object with the following properties:
- start
  start Required
- end
  end Required
- freq
  freq Required
- min
  min
- max
  max

Internal Definitions ¶

values

tag:stsci.edu:asdf/core/ndarray-1.0.0

Integer representation of a pandas DatetimeIndex in nanoseconds precision.

start

timestamp-1.0.0

Timedelta of the first value.

end

timestamp-1.0.0

Timestamp of the last value.

freq

string

Optional string to describe the frequency in pandas offset style. See https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases .

No length restriction

min

timestamp-1.0.0

Minimum timestamp in the index.

max

timestamp-1.0.0

Maximum timestamp in the index.

Original Schema ¶

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

title: |
  Represents an array of timestamps following pandas.DatetimeIndex.

definitions:
  values:
    description: |
      Integer representation of a pandas DatetimeIndex in nanoseconds precision.
    $ref: tag:stsci.edu:asdf/core/ndarray-1.0.0

  start:
    description: |
      Timedelta of the first value.
    $ref: timestamp-1.0.0

  end:
    description: |
      Timestamp of the last value.
    $ref: timestamp-1.0.0

  freq:
    description: |
      Optional string to describe the frequency in pandas offset style.
      See https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases .
    type: string
    # TODO: match pattern for pandas string? Maybe in pandas code?

  min:
    description: |
      Minimum timestamp in the index.
    $ref: timestamp-1.0.0

  max:
    description: |
      Maximum timestamp in the index.
    $ref: timestamp-1.0.0

oneOf:
  - type: object
    properties:
      values:
        $ref: "#/definitions/values"
      start:
        $ref: "#/definitions/start"
      end:
        $ref: "#/definitions/end"
      freq:
        $ref: "#/definitions/freq"
      min:
        $ref: "#/definitions/min"
      max:
        $ref: "#/definitions/max"

    required: [values]
    propertyOrder: [values, start, end, freq, min, max]
    additionalProperties: false

  - type: object
    properties:
      start:
        $ref: "#/definitions/start"
      end:
        $ref: "#/definitions/end"
      freq:
        $ref: "#/definitions/freq"
      min:
        $ref: "#/definitions/min"
      max:
        $ref: "#/definitions/max"

    required: [start, end, freq]
    propertyOrder: [start, end, freq, min, max]
    additionalProperties: false
...