alsdb.utils.viz.plot_waveform#

alsdb.utils.viz.plot_waveform(result, ax_wave=None, ax_rh=None, rh_levels: tuple[int, ...] = (25, 50, 75, 95, 100), figsize: tuple[float, float] = (11, 6), title: str | None = None)[source]#

Two-panel waveform plot for a WaveformResult.

Left panel: Normalised waveform energy vs elevation. Ground peak, canopy top, and each requested RH level are annotated. The canopy layer is shaded in green; the ground return in brown.
Right panel: Horizontal bar chart of RH heights above ground.

Parameters:

result – A WaveformResult instance.
ax_wave – Pre-existing Matplotlib axes. A new figure is created when both are None.
ax_rh – Pre-existing Matplotlib axes. A new figure is created when both are None.
rh_levels – RH percentile levels to annotate and plot.
figsize – Figure size in inches (used only when axes are not supplied).
title – Figure suptitle. Auto-generated if None.

Return type:

matplotlib.figure.Figure