shnitsel.vis.plot.filtration

Attributes

shnitsel_blue

shnitsel_yellow

shnitsel_magenta

text_color

text_backgroundcolor

Functions

check_thresholds(ds_or_da[, quantiles])

Display graphs illustrating

validity_populations(ds_or_da[, intersections])

Display two plots showing

Module Contents

shnitsel_blue
shnitsel_yellow = '#C4A000'
shnitsel_magenta = '#7E5273'
text_color = '#fff'
text_backgroundcolor = (0, 0, 0, 0.2)
check_thresholds(ds_or_da, quantiles=None)
Display graphs illustrating

  1. how many trajectories meet each criterion throughout, and

  2. quantiles of cumulative maxima over time for each criterion, indicating at what times a given proportion has failed the criterion

Parameters:

  • ds_or_da – Data to plot

  • quantiles – quantiles to display and mark on the right-hand graph, by default None

  • optional – quantiles to display and mark on the right-hand graph, by default None

Return type:

The matplotlib Axes object of the plots

validity_populations(ds_or_da, intersections=True)

Display two plots showing 1. how many trajectories meet criteria (or combinations thereof) up to a given time 2. how many frames would remain if the ensemble were transected at a given time (see shnitsel.clean.transect())

Parameters:

  • ds_or_da – Data to plot

  • intersections – whether to plot intersections of criteria (how many trajectories still meet criterion 1 AND criterion 2) or to consider criteria independently

  • optional – whether to plot intersections of criteria (how many trajectories still meet criterion 1 AND criterion 2) or to consider criteria independently

Return type:

The matplotlib Axes object of the plots