Python Interface

This part of the documentation covers the public interface of Nanomesh.

The side bar contains a listing of classes and functions by topic.

Most of Nanomesh’ functionality can be accessed through the classes and functions listed below. See the Overview for how to use them.

Data types

nanomesh.Plane(image)

Data class for working with 2D image data.

nanomesh.Volume(image)

Data class for working with 3D (volumetric) image data..

nanomesh.Image(image)

Generic image class.

nanomesh.MeshContainer(points, cells[, ...])

Low-level container for storing mesh data.

nanomesh.Mesh(points, cells, *args, **kwargs)

Generic mesh class.

nanomesh.LineMesh(points, cells, *args, **kwargs)

Data class for line meshes.

nanomesh.TriangleMesh(points, cells, *args, ...)

Data class for triangle meshes.

nanomesh.TetraMesh(points, cells, *args, ...)

Data class for tetrahedral meshes.

nanomesh.RegionMarker(label, point[, name, ...])

Data class to store region info.

Meshing classes

nanomesh.Mesher(image)

Utility class to generate a mesh from image data.

nanomesh.Mesher2D(image)

Utility class to generate a triangular mesh from 2D image data.

nanomesh.Mesher3D(image)

Utility class to generate a tetrahedral mesh from 3D (volumetric) image data.

Functions

nanomesh.simple_triangulate(points, *[, ...])

Simple triangulation using triangle.

nanomesh.triangulate(mesh[, opts, default_opts])

Triangulate a contour mesh.

nanomesh.tetrahedralize(mesh[, opts, ...])

Tetrahedralize a surface mesh.

nanomesh.volume2mesh(image, *[, level])

Generate a tetrahedral mesh from a 3D segmented image.

nanomesh.plane2mesh(image, *[, level, ...])

Generate a triangular mesh from a 2D segmented image.

Modules

nanomesh.metrics

Module to compute cell quality metrics.

nanomesh.data

Module containing sample data.

Reference

The complete API reference is listed below.