mnultitool.plot package

Submodules

mnultitool.plot.plot module

Functions:

plotMatrixAndVector(A, b[, bigTitle, …])

Plots a colormap presenting matrix A and a colorbar presenting vector b, with a legend of the range of values

plotVector(title, ax, vec[, showLegendColorbar])

Plots a vector colorbar in a transposed form, with an additional legend of values, if needed
mnultitool.plot.plot.plotMatrixAndVector(A, b, bigTitle='Visualization of matrix A & vector b', matrixTitle='Matrix A', vectorTitle='Vector b', figsize=None)

Plots a colormap presenting matrix A and a colorbar presenting vector b, with a legend of the range of values

Parameters

  • A (ndarray) – the matrix to be presented

  • b (ndarray) – the vector to be presented; note: the vector will be copied & transposed for visualization

  • bigTitle (str) – the suptitle of the figure, optional

  • matrixTitle (str) – the title of the subplot of the matrix, optional

  • vectorTitle (str) – the title of the subplot of the vector, optional

  • figsize – the size of the plot, optional

Return type

Any, Axes, Axes]]

Returns

a tuple containing the figure and a tuple of the two axes

mnultitool.plot.plot.plotVector(title, ax, vec, showLegendColorbar=True)

Plots a vector colorbar in a transposed form, with an additional legend of values, if needed

Parameters

  • title (str) – the title of the figure (or axes, if on a subplot)

  • ax – Axes object

  • vec (ndarray) – the vector

  • showLegendColorbar (bool) – whether to show the legend colorbar, optional

Return type

None