ProjectedMesh¶
from mcot.surface.mesh import ProjectedMesh
-
class
mcot.surface.mesh.
ProjectedMesh
(mesh, indices, position, orientation)[source]¶ 1-dimensional slice of a 2D mesh.
-
__init__
(mesh, indices, position, orientation)[source]¶ Initialize self. See help(type(self)) for accurate signature.
Inheritance diagram
Methods
line_collection
(inplane_vec[, flip_other, …])Returns a matplotlib line collection of the projected surface.
spanned_coordinates
(inplane_vec[, flip_other])Computes the 2D coordinates from the position
Attributes
npoints
-
line_collection¶
-
ProjectedMesh.
line_collection
(inplane_vec, flip_other=False, surface_arr=None, axes=None, **kwargs)[source]¶ Returns a matplotlib line collection of the projected surface.
- Parameters
inplane_vec – (3, ) array defining the hemisphere that will be used as the x-coordinate (see ProjectedMesh.spanned_coordinates)
flip_other – if True the y-coordinate is defined based on the negative of the cross product betwen the plane normal and inplane_vec rather than the positive
surface_arr – (N, ) or (N, 3) array defining values for vertices on the original mesh. If set will be used to set the color along the line;
axes – matplotlib axes. If set the LineCollection will be added to this plot
kwargs – keywords are pased on to the creation of the LineCollection (see matplotlib.collections.LineCollection)
- Returns
the new LineCollection
- Return type
matplotlib.collections.LineCollection
spanned_coordinates¶
-
ProjectedMesh.
spanned_coordinates
(inplane_vec, flip_other=False)[source]¶ Computes the 2D coordinates from the position
- Parameters
inplane_vec – (3, ) array with any in-plane hemisphere defining the first coordinate
flip_other – if True the second coordinate is defined based on the negative of the cross product betwen the plane normal and inplane_vec rather than the positive
- Returns
(Npoints, 2) array with the coordinates along and perpendicular to
inplane_vec