lt_toolbox.TrajFrame.plot_timeseries#

TrajFrame.plot_timeseries(var: str, sample_size: int | None = None, **kwargs)[source]#

Plot timeseries of property sampled along Lagrangian trajectories in a plotly express interactive figure.

Parameters:
  • var (str) – Name of column variable to plot timeseries.

  • sample_size (int, default: None) – Size of random sample of Lagrangian trajectories to plot.

  • (optional) (**kwargs) – Additional keyword arguments to be passed to plotly line(), when creating the figure.

Returns:

Interactive figure of property timeseries sampled along Langrangian trajectories.

Return type:

plotly.graph_objs._figure.Figure

Examples

Plot the temperature along ten randomly sampled Lagrangian trajectories.

>>>  trajectories.plot_timeseries(var='temp', sample_size=10).