mechanochat.plotting.plot_grid_signal_direction#

mechanochat.plotting.plot_grid_signal_direction(Xgrid, Vgrid, rs: Literal['receiver', 'sender'], color='k', scale=1., scale_units='x', ax=None)[source]#

Quiver plot of the grid-level signal directions from tl.signal_direction.

Parameters:

  • Xgrid (ndarray) – (n_grid, 2) grid positions

  • Vgrid (ndarray) – (n_grid, 2) mean signal direction per grid cell

  • rs ({'receiver', 'sender'}) – Anchoring of the arrow on the grid point: ‘receiver’ puts the tip on it (the signal arrives), ‘sender’ puts the tail on it (the signal leaves)

  • color (color, default 'k') – Arrow color

  • scale (float, default 1.) – Quiver scale; larger values give shorter arrows

  • scale_units (str, default 'x') – Quiver scale units

  • ax (Axes, optional) – Target matplotlib axes object. Creates new figure if None

Returns:

ax (Axes)