timeseries
Version: v26.0721
Namespace: https://behaverse.org/schemas/timeseries
Sidecar metadata for continuous sampled signals (mouse trajectories, gaze, EEG). A small JSON document — named <payload-filename>.timeseries.json, stored beside its payload in the dataset's activity folder — declaring the payload's location, encoding, clock, sampling nature, and channels. Referenced from event streams via attachments (type bdm:Timeseries).
Properties
This schema defines 15 properties for describing timeseries metadata.
All Properties
| Property | Type | Requirement | Description |
|---|---|---|---|
| type | string | required | Discriminator for the document kind; always bdm:Timeseries. |
| name | string | optional | Short machine-friendly name of the series (e.g. mouse_trajectory, gaze, `eeg... |
| description | string | optional | Human-readable description of what was recorded and how. |
| content_url | string | required | Where the payload file lives: a relative path resolved against this sidecar's ow... |
| content_type | string | required | MIME type of the payload (e.g. application/x-ndjson, text/csv, `application/... |
| content_encoding | string | optional | Optional transport encoding of the payload file, e.g. gzip. Absent means the p... |
| sha256 | string | optional | SHA-256 hash of the payload file's bytes (after any content_encoding), lowercase... |
| byte_length | integer | optional | Size of the payload file in bytes (after any content_encoding). |
| clock | string | optional | URI of the clock every t value is on. Defaults to the vocabulary `engine_secon... |
| anchor_datetime | string | optional | The RFC 9557 datetime (with timezone offset) corresponding to t = 0 on the dec... |
| sampling_nature | enum | required | Whether samples are event-driven (irregular) or taken at a nominal fixed rate. |
| nominal_rate_hz | number | optional | Nominal sampling rate in Hz. Required when sampling_nature is sampled; meani... |
| session_uuid | string | optional | UUID of the session this series was recorded in (see the trial schema's `session... |
| attempt | integer | optional | 1-based attempt number, matching the dataset layout's partition-by-attempt conve... |
| channels | array | required | Definitions of the payload's channels, in payload column order. For self-describ... |
Usage
See the examples for practical usage patterns.
Version History
The current version of timeseries is v26.0721.
Older versions are available in the timeseries/versions/ directory.