API Reference¶
morphvista.MorphPlotter
¶
Bases: Plotter
Methods:
| Name | Description |
|---|---|
add_graph_layer |
Add a graph layer from a MorphSync object to the plotter. |
add_mesh_layer |
Add a mesh layer from a MorphSync object to the plotter. |
add_point_layer |
Add a point layer from a MorphSync object to the plotter. |
add_graph_layer(morph, layer_name='graph', hue=None, clim=None, **kwargs)
¶
Add a graph layer from a MorphSync object to the plotter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
morph
|
MorphSync
|
A MorphSync object containing the graph layer. |
required |
layer_name
|
str
|
The name of the graph layer to add. |
'graph'
|
hue
|
Optional[str]
|
The name of the node attributes to use for coloring the graph. |
None
|
clim
|
Optional[tuple]
|
Color limits for the scalar values. If None, defaults to the min and max of the scalar values. If 'robust', uses the 2nd and 98th percentiles. If 'symmetric', uses symmetric limits around zero. |
None
|
**kwargs
|
Additional keyword arguments to pass to pyvista.Plotter.add_mesh. |
{}
|
See Also
add_mesh_layer(morph, layer_name='mesh', hue=None, clim=None, **kwargs)
¶
Add a mesh layer from a MorphSync object to the plotter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
morph
|
MorphSync
|
A MorphSync object containing the mesh layer. |
required |
layer_name
|
str
|
The name of the mesh layer to add. |
'mesh'
|
hue
|
Optional[str]
|
The name of the node attributes to use for coloring the mesh. |
None
|
clim
|
Optional[tuple]
|
Color limits for the scalar values. If None, defaults to the min and max of the scalar values. If 'robust', uses the 2nd and 98th percentiles. If 'symmetric', uses symmetric limits around zero. |
None
|
**kwargs
|
Additional keyword arguments to pass to pyvista.Plotter.add_mesh. |
{}
|
See Also
add_point_layer(morph, layer_name='points', hue=None, clim=None, **kwargs)
¶
Add a point layer from a MorphSync object to the plotter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
morph
|
MorphSync
|
A MorphSync object containing the point layer. |
required |
layer_name
|
str
|
The name of the point layer to add. |
'points'
|
hue
|
Optional[str]
|
The name of the node attributes to use for coloring the points. |
None
|
clim
|
Optional[tuple]
|
Color limits for the scalar values. If None, defaults to the min and max of the scalar values. If 'robust', uses the 2nd and 98th percentiles. If 'symmetric', uses symmetric limits around zero. |
None
|
**kwargs
|
Additional keyword arguments to pass to pyvista.Plotter.add_points. |
{}
|