visualization.draw_geometry

visualization.draw_geometry(
    geometry,
    *,
    title=None,
    bitmap=False,
    with_labels=True,
    cmap='coolwarm',
    edge_cmap='binary',
    **kwgs,
)

Draw a given geometry.

Parameters

Name	Type	Description	Default
geometry	psiclone.data.Geometry	A geometry 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. If so, draw_bitmap is called. Otherwise networkx.draw_networkx is called.	False
with_labels	bool, optional (default: True)	Enable drawing of labels.	True
cmap	str or Colormap, optional (default: "coolwarm")	A color map for nodes passed to matplotlib.	'coolwarm'
edge_cmap	str or Colormap, optional (default: "binary")	A color map for edges passed to matplotlib.	'binary'

Other Parameters

Name	Type	Description	Default
**kwgs	dict	These are passed to the function draw_bitmap or networkx.draw_networkx.	{}