visualization.draw_contour

visualization.draw_contour(
    psi2tree,
    *,
    title=None,
    bitmap=False,
    cmap='coolwarm',
    contour_type='nonfilled',
    level_type='linear',
    mask=None,
    fmt='%1.3f',
    **kwgs,
)

Draw a contour plot of given data.

Parameters

Name	Type	Description	Default
psi2tree	psiclone.psi2tree.Psi2tree	A computed Psi2tree object.	required
title	str	A title of the plot, if needed.	None
bitmap	bool, optional (default: False)	Treat the geometry to be a grid if True is set. Otherwise an interpolation is applied.	False
cmap	str or Colormap, optional (default: "coolwarm")	A color map passed to matplotlib unless contour_type is ‘nonfilled’.	'coolwarm'
contour_type	str, optional (default: 'nonfilled')	Specify a contour plot type. - ‘filled’: a filled contour plot - ‘nonfilled’: a non-filled contour plot	'nonfilled'
level_type	str, optional (default: 'linear')	Specify a level choice algorithm. - ‘linear’: equally spaced levels - ‘reeb’: levels from nodes and edges of the Reeb graph	'linear'
mask	array-like, optional (default: None)	A masking array specifying which data are drawn. If specified, mask is passed to numpy.ma.array to construct a masked array and must be a two-dimensional boolean array compatible with data. See numpy.ma for details of masking arrays.	None
fmt	(string, dict)	This is passed to matplotlib.pyplot.clabel to specify contour level formats. See matplotlib.pyplot.clabel for the detail.	'%1.3f'

Other Parameters

Name	Type	Description	Default
**kwgs	dict	These are passed to the function matplotlib.pyplot.contour	{}