animatplot.blocks.Surface

class animatplot.blocks.Surface(*args, ax=None, t_axis=0, fixed_vscale=True, **kwargs)[source]

Animates a surface (wrapping mpl_toolkits.mplot3d.axes3d.plot_surface())

Parameters:
  • X (1D or 2D np.ndarray, optional) –

  • Y (1D or 2D np.ndarray, optional) –

  • C (list of 2D np.ndarray or a 3D np.ndarray) –

  • ax (matplotlib.axes.Axes, optional) – The matplotlib axes to attach the block to. Must be created with ‘projection=”3d”’. Defaults to matplotlib.pyplot.gca()

  • t_axis (int, optional) – The axis of the array that represents time. Defaults to 0. No effect if C is a list.

  • fixed_vscale (bool, default True) – By default, set the vertical scale using the overall minimum and maximum of the array. If set to False, scale is calculated independently for each time slice.

ax

The matplotlib axes that the block is attached to.

Type:

matplotlib axis

Notes

All other keyword arguments get passed to ax.plot_surface see mpl_toolkits.mplot3d.axes3d.plot_surface() for details.

Methods

__init__

__init__(*args, ax=None, t_axis=0, fixed_vscale=True, **kwargs)[source]