Adjacency
PointCloud(data=None)
Bases: Mesh
A data structure for representing point clouds
Attributes:
| Name | Type | Description |
|---|---|---|
vertices |
DataContainer
|
the container for all vertices |
__str__ |
str
|
Representation of the object and its elements as a string. |
id_vertices
property
Shortcut for range(len(self.vertices))
append(x)
Shortcut for self.vertices.append(x), since we can only append elements in the 'vertices' container
PolyLine(data=None)
Bases: Mesh
A data structure for representing polylines.
Attributes:
| Name | Type | Description |
|---|---|---|
vertices |
DataContainer
|
the container for all vertices |
edges |
DataContainer
|
the container for all edges |
__str__ |
Representation of the object and its elements as a string. |
id_edges
property
Shortcut for range(len(self.edges))
id_vertices
property
Shortcut for range(len(self.vertices))
SurfaceMesh(data=None)
Bases: Mesh
A data structure for representing polygonal surfaces.
Attributes:
| Name | Type | Description |
|---|---|---|
vertices |
DataContainer
|
the container for all vertices |
edges |
DataContainer
|
the container for all edges |
faces |
DataContainer
|
the container for all faces |
face_corners |
DataContainer
|
the container for all corner of faces |
boundary_edges |
list
|
list of all edge indices on the boundary |
interior_edges |
list
|
list of all interior edge indices (all edges \ boundary_edges) |
boundary_vertices |
list
|
list of all vertex indices on the boundary |
interior_vertices |
list
|
list of all interior verticex indices (all vertices \ boundary_vertices) |
connectivity |
_SurfaceConnectivity
|
the connectivity utility class |
id_corners
property
Shortcut for range(len(self.face_corners))
id_edges
property
Shortcut for range(len(self.edges))
id_faces
property
Shortcut for range(len(self.faces))
id_vertices
property
Shortcut for range(len(self.vertices))
clear_boundary_data()
Clear all boundary data. Next call to a boundary/interior container or method will recompute everything
is_edge_on_border(u, v)
whether edge (u,v) is a boundary edge or not
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
u |
int
|
vertex id |
required |
v |
int
|
vertex id |
required |
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
whether edge (u,v) is a boundary edge or not. Returns False if (u,v) is not a valid edge. |
is_quad()
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
True if the mesh is quadrangular (all faces are quad) |
is_triangular()
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
True if the mesh is triangular (all faces are triangles) |
is_vertex_on_border(u)
whether vertex u is a boundary vertex or not.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
u |
int
|
vertex id |
required |
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
whether vertex |
ith_vertex_of_face(fid, i)
helper function to get the i-th vertex of a face, i.e. self.faces[fid][i]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
fid |
int
|
face id |
required |
i |
int
|
vertex id in face. Should be 0 <= vid < len(face) |
required |
Returns:
| Name | Type | Description |
|---|---|---|
int |
int
|
the id of the i-th vertex in face |
pt_of_face(fid)
point coordinates of vertices of face fid
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
fid |
int
|
face id |
required |
Returns:
| Name | Type | Description |
|---|---|---|
Iterable |
iterator of Vec objects representing point coordinates of vertices |
VolumeMesh(data=None)
Bases: Mesh
id_cells
property
Shortcut for range(len(self.cells))
id_corners
property
Shortcut for range(len(self.face_corners))
id_edges
property
Shortcut for range(len(self.edges))
id_faces
property
Shortcut for range(len(self.faces))
id_vertices
property
Shortcut for range(len(self.vertices))
is_edge_on_border(*args)
Simple test to determine if a given edge is on the boundary of the mesh.
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
Returns True if the given edge is on the boundary of the mesh. |
is_face_on_border(*args)
Simple test to determine if a given face is on the boundary of the mesh.
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
Returns True is the given face exists and is on the boundary of the mesh |
is_tetrahedral()
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
True if the mesh is tetrahedral (all cells are tetrahedra) |
adjacency_matrix(mesh, weights='one')
Computes and returns the adjacency matrix of a mesh, that is a (sparse) matrix M such that
M[i,j] = M[j,i] = weights[i,j] if (i,j) is an edge of the mesh
M[i,j] = 0 otherwise
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mesh |
Mesh
|
the input mesh |
required |
weights |
str
|
How to weight the edges of the matrix. Options are: - "one" : every edge is 1 - "length" : every edge has weight corresponding to its length - a custom dict edge_id:int -> weight:float Defaults to "one". |
'one'
|
Returns:
| Type | Description |
|---|---|
coo_matrix
|
scipy.sparse.coo_matrix |
vertex_to_edge_operator(mesh, oriented=False)
Vertices to edges operator. Matrix M of size |V|x|E| where:
M[v,e] = 1 if and only if v is one extremity of edge e.
if oriented is set, M[v,e] = -1 if v is the origin of the edge and 1 if it is the arrival.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mesh |
Mesh
|
the input mesh |
required |
oriented |
bool
|
whether to consider oriented edge and signed values or not. Defaults to False. |
False
|
Returns:
| Type | Description |
|---|---|
csc_matrix
|
scipy.sparse.csc_matrix |
vertex_to_face_operator(mesh)
Vertices to face operator. Matrix M of size |V| x |F| where:
M[v,f] = 1/len(f) if and only if v is one of the vertices of f
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mesh |
SurfaceMesh
|
input surface mesh |
required |
Returns:
| Type | Description |
|---|---|
csc_matrix
|
scipy.sparse.csc_matrix |
See also
mouette.attributes.interpolate_vertices_to_faces