waterfall

function of dascore.viz.waterfall source

waterfall(
    patch: Patch ,
    ax: Axes | None ,
    cmap ,
    timefmt ,
    scale: float | Sequence[float] | None ,
    scale_type: Literal[‘relative’, ‘absolute’] ,
    colorbar ,
    show ,
)-> Figure

Parameters

patch The Patch object. ax A matplotlib object, if None create one. cmap A matplotlib colormap string or instance. timefmt The format for the time axis (e.g., “%H:%M:%S”). If None, try to automatically determine the most clear format. scale If not None, controls the saturation level of the colorbar. Values can either be a float, to set upper and lower limit to the same value centered around the mean of the data, or a length 2 tuple specifying upper and lower limits. See scale_type for controlling how values are scaled. scale_type Controls the type of scaling specified by scale parameter. Options are: relative - scale based on half the dynamic range in patch absolute - scale based on absolute values provided to scale colorbar If True, show the color bar. show If True, show the plot, else just return axis.

Examples

Plot the default patch

import dascore as dc patch = dc.get_example_patch()

Parameters

Parameter Description
patch The Patch object.
ax A matplotlib object, if None create one.
cmap A matplotlib colormap string or instance.
timefmt The format for the time axis (e.g., “%H:%M:%S”). If None, try to automatically determine the most clear format.
scale If not None, controls the saturation level of the colorbar. Values can either be a float, to set upper and lower limit to the same value centered around the mean of the data, or a length 2 tuple specifying upper and lower limits. See scale_type for controlling how values are scaled.
scale_type Controls the type of scaling specified by scale parameter. Options are: relative - scale based on half the dynamic range in patch absolute - scale based on absolute values provided to scale
colorbar If True, show the color bar.
show If True, show the plot, else just return axis.

Examples

# Plot the default patch
import dascore as dc
patch = dc.get_example_patch()
_ = patch.viz.waterfall(scale=0.1)