netchos.heatmap¶
- netchos.heatmap(conn, catline_x=None, catline_y=None, catline=None, backend='plotly', kw_trace={}, fig=None, **kwargs)[source]¶
Heatmap plot.
- Parameters
- connarray_like or DataFrame or DataArray
2D Connectivity matrix of shape (n_rows, n_cols). If conn is a DataFrame or a DataArray, the indexes and columns are used for the conn and y tick labels
- catline_x, catline_ydict or None
Dictionary in order to plot categorical lines along the conn and y axis. The keys should correspond to the index or column elements and the values to the category.
- catlinedict or None
Additional arguments when plotting the line (e.g dict(color=’red’, lw=2))
- backend{‘mpl’, ‘plotly’}
Backend to use for plotting. Use either ‘mpl’ for using matplotlib or ‘plotly’ for interactive figures using Plotly.
- figmpl.figure or go.Figure or None
Figure object. Use either :
plt.figure when using matplotlib backend
plotly.graph_objects.Figure when using plotly backend
- kwargsdict or {}
Additional arguments are sent to :
seaborn.heatmap when using matplotlib backend
plotly.graph_objects.Heatmap when using plotly backend
- Returns
- figfigure
A matplotlib or plotly figure depending on the backend