Skip to content

CLI reference

tsdive screen

Screen a window against a baseline: MAD, or regime-keyed with --mode.

The usage walkthrough has a section on it.

Usage

usage: tsdive screen [-h] --baseline BASELINE --window WINDOW
                     [--method {mad,moving-range}] [--k K] [--mode PARQUET]
                     [--basis {TIME_WEIGHTED,EVENT_WEIGHTED}] [--stepped]
                     [--json] [--no-color]
                     parquet

Options

Argument Value Default Description
parquet required single-tag parquet archive to screen
--baseline BASELINE required ISO 8601 START/END in UTC for the history
--window WINDOW required ISO 8601 START/END in UTC to screen
--method {mad,moving-range} mad scale of the baseline: MAD, or the mean moving range; ignored with --mode
--k K 3.0 flag beyond k*scale from center
--mode PARQUET MODE archive; compute one baseline per regime instead of one for the window
--basis {TIME_WEIGHTED,EVENT_WEIGHTED} TIME_WEIGHTED calculation basis declared on the read
--stepped stepped interpolation between samples
--json print one JSON object and nothing else
--no-color plain text, no ANSI colour (NO_COLOR does the same)

Example

$ tsdive screen data/demo/fic101_demo.parquet \
    --baseline "2024-03-30T20:00:00Z/2024-03-31T01:00:00Z" \
    --window "2024-03-31T01:00:00Z/2024-03-31T06:00:00Z"
demo:FIC101.PV  flagged 29 of 300 (9.7%)

baseline  2024-03-30 20:00:00Z -> 2024-03-31 01:00:00Z   GOOD 261   censored no
window    2024-03-31 01:00:00Z -> 06:00:00Z
method    MAD   center 62.32   scale 0.5488   k 3.0   limits [60.67, 63.97]
caveat    provisional: one baseline for every regime in the window

Flagged
  2024-03-31 02:01:00Z -> 02:29:00Z   29 samples