`visualdynamics.plot.overload`¶

overload ¶

Each channel against its range: the worst one's trace over its range, and every channel's headroom beside its kurtosis.

At the top, one channel's trace over the span read, with its range drawn across it either way as dashed lines, every sample on the rail marked with a cross, the largest peak with a diamond, and, where the range has held, that peak scaled to the next level drawn either way as dotted lines, so a range that will not hold the next step is seen against the peak that says so. The row is titled with the channel's judgment in words.

Under it, two bar charts on one row, a bar per channel and the channels in the same order on both, their rows locked together. On the left the headroom of each channel's range over its largest peak, in dB, grown from zero, with the step to the next level as a floor: a bar short of it reaches its range at the next level, and a bar of zero is on the rail. Each channel flagged has its finding written along its row in words ('on the rail, 287', 'reaches its range at +6 dB', and 'beyond its range' where the table's range cannot be the one the record was taken with), and a channel with no range says why in place of a bar. On the right the kurtosis bars (plot.bars.kurtosis_chart), unchanged, because the kurtosis is what a reader looks at for a clip and its band of 2 to 4 passes one at 2.86: the two charts side by side show the clipped channel with an ordinary kurtosis and no headroom.

Nothing is told apart by hue alone: the range is dashed and the scaled peak dotted, the rail samples are crosses and the peak a diamond, every mark is named in the legend, and every flagged bar carries its finding in words. Levels and times are drawn in the unit system's units.

Functions:

Name	Description
`finding`	What a channel is flagged for, in the few words its bar
`build_overload`	Draw an overload check into `layout`.

Functions:¶

finding ¶

finding(channel: Any) -> str

What a channel is flagged for, in the few words its bar carries; '' when it is not flagged.

Source code in src/visualdynamics/plot/overload.py

def finding(channel: Any) -> str:
    """What a channel is flagged for, in the few words its bar
    carries; '' when it is not flagged."""
    flagged = channel.flagged
    if 'beyond' in flagged:
        return f'beyond its range, {channel.beyond}'
    if 'rail' in flagged:
        return f'on the rail, {channel.rail}'
    if 'next' in flagged:
        return f'reaches its range at +{channel.step_db:g} dB'
    return ''

build_overload ¶

build_overload(layout: Any, history: Any, check: Any, record: int | None = None, *, kurtosis_band: tuple[float, float] | None = None, unit_system: Any = None, theme: Any = None, step_changed: Callable[..., None] | None = None, kurtosis_changed: Callable[..., None] | None = None) -> tuple[Any, Any]

Draw an overload check into layout.

check is the core.overload.OverloadCheck of history (TimeHistory.overload_check). The trace is channel record, or the check's worst channel (OverloadCheck.worst) when record is None, or its first when no channel has a range. kurtosis_band is the kurtosis bars' band, core.kurtosis's 2 to 4 by default. step_changed is called with the headroom floor when it is dragged, and kurtosis_changed with the kurtosis band, as plot.bars.BarChart calls them. Returns the two charts, headroom then kurtosis.