timeline

Experimental

Experimental: this may change in any minor release without a deprecation period; see what experimental means.

timeline(
    inventory: ‘Inventory’ ,
    kind: ‘str’ = both,
    color: ‘str’ = interrogator,
    time: ‘tuple | None’ = None,
    ax: ‘plt.Axes | None’ = None,
    legend: ‘bool’ = True,
    show: ‘bool’ = False,
)-> ‘plt.Axes’

Plot when each part of an inventory was valid.

One lane per acquisition and per optical path lineage, drawn against time. An epoch which states no start or no end is unbounded rather than missing, and is drawn running off that side of the axis.

Parameters

Parameter	Description
inventory	The inventory to draw.
kind	“both”, “acquisition”, or “optical_path”.
color	“interrogator”, “data_type”, or “kind”.
time	The times to draw between, as (min, max). Either end may be None, or …, to run to what the epochs themselves state.
ax	An Axes to draw on.
legend	Whether to draw the legend.
show	Whether to call plt.show.

Examples

import dascore as dc
from dascore.viz.inventory import timeline

inventory = dc.get_example_inventory("tunnel")
_ = timeline(inventory)