API Documentation¶

Complete reference for the pyFM package, generated from the source docstrings. Every function, class, and method has its own page — use the tables below or the sidebar to navigate.

Core classes¶

The high-level objects most users interact with.

`TriMesh`	Triangle mesh, or point cloud when no faces are given.
`FunctionalMapping`	Compute a functional map between two meshes.

Functional Map Network¶

Consistent map synchronization across a collection of shapes (the FMN class and its helpers).

`FMN`	Functional Map Network.
`CLB_quad_form`	Compute the quadratic form of a Functional Maps Network for CLB computation.

Shape signatures¶

Heat and Wave Kernel Signatures.

pyFM.signatures

Spectral operations¶

Conversions between pointwise and functional maps, shape difference operators, and nearest-neighbour utilities.

pyFM.spectral

Evaluation¶

Geodesic accuracy, continuity, and coverage metrics for correspondences.

pyFM.eval

Mesh geometry & I/O¶

Standalone geometric operators (areas, normals, gradients, geodesics), Laplacians, and mesh file readers/writers.

`pyFM.mesh.geometry`
`pyFM.mesh.laplacian`
`pyFM.mesh.file_utils`

Visualization¶

PyVista-based plotting helpers for meshes, point clouds and vector fields. Requires the viz extra (pip install 'pyfmaps[viz]').

pyFM.viz

PyVista-based visualization helpers.

Optimization internals¶

Energy terms and gradients used by FunctionalMapping.

pyFM.optimize