uvisbox.Modules.UncertaintyTube.uncertainty_tubes

Module Contents

uvisbox.Modules.UncertaintyTube.uncertainty_tubes.uncertainty_tubes(trajectories, colormap='viridis', plotter=None, resolution=20, e_proj=1, sym=False, clim=None, n_jobs=1)[source]

Generate and visualize 3D uncertainty tubes from trajectories.

Parameters:

  • trajectories (np.ndarray) – Array of shape (n_steps, n_starting_locations, n_ensemble_members, 3) representing the 3D trajectories.

  • (str (colormap) – Colormap to use for rendering the tube. Defaults to “viridis”.

  • optional) – Colormap to use for rendering the tube. Defaults to “viridis”.

  • pyvista.Plotter (plotter (matplotlib.axes.Axes or) – The plotting object to use. If None, a new Matplotlib figure/axis is created.

  • optional) – The plotting object to use. If None, a new Matplotlib figure/axis is created.

  • (int (n_jobs) – Number of points to sample on each cross-section boundary. Defaults to 20.

  • optional) – Number of points to sample on each cross-section boundary. Defaults to 20.

  • (float (e_proj) – Exponent controlling the superellipse shape. e_proj=1 creates a standard ellipse. Defaults to 1.

  • optional) – Exponent controlling the superellipse shape. e_proj=1 creates a standard ellipse. Defaults to 1.

  • (bool (sym) – If True, forces the superellipse to be symmetric. Defaults to False.

  • optional) – If True, forces the superellipse to be symmetric. Defaults to False.

  • (int – Number of parallel jobs to use. If n_jobs=1, uses sequential processing. Defaults to 1.

  • optional) – Number of parallel jobs to use. If n_jobs=1, uses sequential processing. Defaults to 1.

Returns:

matplotlib.axes.Axes or pyvista.Plotter

Return type:

The plotting object with the visualization.