pyrfu.plot.plot_projection module#

pyrfu.plot.plot_projection.plot_projection(axis, v_x, v_y, f_mat, vlim: float = 1000.0, clim: list | None = None, cmap: str | None = None, colorbar: str = 'right')[source]#

Plot the projection of the distribution.

Parameters:

  • axis (matplotlib.pyplot.subplotsaxes) – Axis to plot.

  • v_x (ndarray) – X axis velocity grid.

  • v_y (ndarray) – Y axis velocity grid.

  • f_mat (ndarray) – Projected distribution.

  • vlim (float, Optional) – Maximum velocity to limit axis. Default is vlim = 1000 km/s.

  • clim (list, Optional) – Caxes limit. Default is clim = [-18, -13] (assume to be in SI units)

  • colorbar (str, Optional) – Location of the colorbar. Default is cbar_pos = “top”.

  • cmap (str, Optional) – Colormap. Default is cmap = “jet”.

Returns:

  • axis (axis) – Axis

  • caxis (axis) – Colorbar axis.