Plotting Module

soundevent.plot

Plotting utilities.

Modules:

Name	Description
annotation	Functions for plotting annotations.
common	Common utilities for plotting.
geometries	Functions for plotting sound event geometries.
prediction
tags	Functions for plotting tags.

Classes:

Name	Description
TagColorMapper	Maps tags to colors.

Functions:

Name	Description
add_tags_legend	Add a legend for tags.
create_axes	Create a new figure and axes.
plot_annotation	Plot an annotation.
plot_annotations	Plot an annotation.
plot_geometry	Plot a geometry in the given ax.
plot_prediction	Plot an annotation.
plot_predictions	Plot an prediction.
plot_tag	Plot a tag.

Classes

TagColorMapper(cmap='tab20', num_colors=20)

Maps tags to colors.

Methods:

Name	Description
get_color	Get color for tag.

Functions

get_color(tag)

Get color for tag.

Functions

add_tags_legend(ax, color_mapper)

Add a legend for tags.

create_axes(figsize=None)

Create a new figure and axes.

Parameters:

Name	Type	Description	Default
figsize	Optional[Tuple[float, float]]	The size of the figure. If None, use the default size.	None

Returns:

Type	Description
ax	The axes.

plot_annotation(annotation, ax=None, position='top-right', color_mapper=None, time_offset=0.001, freq_offset=1000, color=None, **kwargs)

Plot an annotation.

plot_annotations(annotations, ax=None, position='top-right', color_mapper=None, time_offset=0.001, freq_offset=1000, legend=True, color=None, **kwargs)

Plot an annotation.

plot_geometry(geometry, ax=None, figsize=None, **kwargs)

Plot a geometry in the given ax.

plot_prediction(prediction, ax=None, position='top-right', color_mapper=None, time_offset=0.001, freq_offset=1000, max_alpha=0.5, color=None, **kwargs)

Plot an annotation.

plot_predictions(predictions, ax=None, position='top-right', color_mapper=None, time_offset=0.001, freq_offset=1000, legend=True, max_alpha=0.5, color=None, **kwargs)

Plot an prediction.

plot_tag(time, frequency, color, ax=None, size=10, **kwargs)

Plot a tag.