libgunshotmatch_mpl.peakviewer

Common peak drawing functionality.

Exceptions:

UnsupportedProject

Exception raised when a project is missing certain attributes (such as the consolidated peak list).

Functions:

draw_peaks(project, retention_times, figure, …)	Draw the peaks at the given retention time for each repeat in the project.
load_project(filename)	Load a project from disk and ensure it has all required attributes for displaying chromatograms.

exception UnsupportedProject

Bases: ValueError

Exception raised when a project is missing certain attributes (such as the consolidated peak list).

draw_peaks(project, retention_times, figure, axes)

Draw the peaks at the given retention time for each repeat in the project.

Parameters

• project (Project)

• retention_times (List[float]) – List of retention times for each repeat in the project.

• figure (Figure)

• axes (List[Axes])

Changed in version 0.6.0: Replaced peak_idx argument with retention_times

load_project(filename)

Load a project from disk and ensure it has all required attributes for displaying chromatograms.

Parameters

filename (Union[str, Path, PathLike])

Return type

Project