uvisbox.Modules.UncertaintyTube.uncertainty_tubes
=================================================

.. py:module:: uvisbox.Modules.UncertaintyTube.uncertainty_tubes




Module Contents
---------------

.. py:function:: uncertainty_tubes(trajectories, colormap='viridis', plotter=None, resolution=20, e_proj=1, sym=False, clim=None, n_jobs=1)

   Generate and visualize 3D uncertainty tubes from trajectories.

   :param trajectories: Array of shape (n_steps, n_starting_locations, n_ensemble_members, 3) representing the 3D trajectories.
   :type trajectories: np.ndarray
   :param colormap (str: Colormap to use for rendering the tube. Defaults to "viridis".
   :param optional): Colormap to use for rendering the tube. Defaults to "viridis".
   :param plotter (matplotlib.axes.Axes or pyvista.Plotter: The plotting object to use. If None, a new Matplotlib figure/axis is created.
   :param optional): The plotting object to use. If None, a new Matplotlib figure/axis is created.
   :param resolution (int: Number of points to sample on each cross-section boundary. Defaults to 20.
   :param optional): Number of points to sample on each cross-section boundary. Defaults to 20.
   :param e_proj (float: Exponent controlling the superellipse shape. e_proj=1 creates a standard ellipse.
                         Defaults to 1.
   :param optional): Exponent controlling the superellipse shape. e_proj=1 creates a standard ellipse.
                     Defaults to 1.
   :param sym (bool: If True, forces the superellipse to be symmetric. Defaults to False.
   :param optional): If True, forces the superellipse to be symmetric. Defaults to False.
   :param n_jobs (int: Number of parallel jobs to use. If n_jobs=1, uses sequential processing.
                       Defaults to 1.
   :param optional): Number of parallel jobs to use. If n_jobs=1, uses sequential processing.
                     Defaults to 1.

   :returns: **matplotlib.axes.Axes or pyvista.Plotter**
   :rtype: The plotting object with the visualization.