API Reference

• geomfum package
  • Subpackages
    • geomfum.dataset package
      • Submodules
      • geomfum.dataset.notebook module
        • DownloadableFile
          • DownloadableFile.get_filename()
        • NotebooksDataset
          • NotebooksDataset.get_filename()
          • NotebooksDataset.get_filenames()
      • geomfum.dataset.torch module
        • Dataset
        • MeshDataset
        • PairsDataset
          • PairsDataset.generate_all_pairs()
          • PairsDataset.generate_random_pairs()
        • PointCloud
          • PointCloud.dist_matrix
          • PointCloud.edge_tangent_vectors
          • PointCloud.edges
          • PointCloud.equip_with_metric()
          • PointCloud.from_file()
          • PointCloud.knn_graph
          • PointCloud.n_vertices
          • PointCloud.vertex_normals
          • PointCloud.vertex_tangent_frames
        • PointCloudDataset
        • ScipyGraphShortestPathMetric
        • ShapeDataset
        • TriangleMesh
          • TriangleMesh.dist_matrix
          • TriangleMesh.edge_tangent_vectors
          • TriangleMesh.edges
          • TriangleMesh.equip_with_metric()
          • TriangleMesh.face_area_vectors
          • TriangleMesh.face_areas
          • TriangleMesh.face_normals
          • TriangleMesh.face_vertex_coords
          • TriangleMesh.from_file()
          • TriangleMesh.n_faces
          • TriangleMesh.n_vertices
          • TriangleMesh.vertex_areas
          • TriangleMesh.vertex_normals
          • TriangleMesh.vertex_tangent_frames
        • VertexEuclideanMetric
          • VertexEuclideanMetric.dist()
          • VertexEuclideanMetric.dist_from_source()
          • VertexEuclideanMetric.dist_matrix()
      • Module contents
        • NotebooksDataset
          • NotebooksDataset.get_filename()
          • NotebooksDataset.get_filenames()
    • geomfum.descriptor package
      • Submodules
      • geomfum.descriptor.learned module
        • BaseFeatureExtractor
          • BaseFeatureExtractor.load_from_path()
          • BaseFeatureExtractor.save()
        • Descriptor
        • FeatureExtractor
        • FeatureExtractorRegistry
          • FeatureExtractorRegistry.MAP
          • FeatureExtractorRegistry.default
        • LearnedDescriptor
          • LearnedDescriptor.forward()
        • WhichRegistryMixins
          • WhichRegistryMixins.from_registry()
      • geomfum.descriptor.pipeline module
        • ArangeSubsampler
        • Descriptor
        • DescriptorPipeline
          • DescriptorPipeline.apply()
        • L2InnerNormalizer
        • LearnedDescriptor
          • LearnedDescriptor.forward()
        • Normalizer
        • Subsampler
      • geomfum.descriptor.spectral module
        • HeatKernelFilter
        • HeatKernelSignature
        • HeatKernelSignatureRegistry
          • HeatKernelSignatureRegistry.MAP
          • HeatKernelSignatureRegistry.default
          • HeatKernelSignatureRegistry.has_internal
        • LandmarkHeatKernelSignature
        • LandmarkHeatKernelSignatureRegistry
          • LandmarkHeatKernelSignatureRegistry.MAP
          • LandmarkHeatKernelSignatureRegistry.default
          • LandmarkHeatKernelSignatureRegistry.has_internal
        • LandmarkWaveKernelSignature
        • LandmarkWaveKernelSignatureRegistry
          • LandmarkWaveKernelSignatureRegistry.MAP
          • LandmarkWaveKernelSignatureRegistry.default
          • LandmarkWaveKernelSignatureRegistry.has_internal
        • SpectralDescriptor
        • SpectralFilter
        • WaveKernelFilter
        • WaveKernelSignature
        • WaveKernelSignatureRegistry
          • WaveKernelSignatureRegistry.MAP
          • WaveKernelSignatureRegistry.default
          • WaveKernelSignatureRegistry.has_internal
        • WhichRegistryMixins
          • WhichRegistryMixins.from_registry()
        • WksDefaultDomain
        • hks_default_domain()
      • Module contents
        • Descriptor
        • DistanceFromLandmarksDescriptor
        • SpectralDescriptor
    • geomfum.metric package
      • Submodules
      • geomfum.metric.mesh module
        • FinitePointSetMetric
          • FinitePointSetMetric.dist_from_source()
          • FinitePointSetMetric.dist_matrix()
        • GraphShortestPathMetric
        • KClosestGraphShortestPathMetric
        • ScipyGraphShortestPathMetric
        • VertexEuclideanMetric
          • VertexEuclideanMetric.dist()
          • VertexEuclideanMetric.dist_from_source()
          • VertexEuclideanMetric.dist_matrix()
        • shortest_path()
        • single_source_partial_dijkstra_path_length()
        • to_nx_edge_graph()
      • geomfum.metric.point_cloud module
      • Module contents
        • FinitePointSetMetric
          • FinitePointSetMetric.dist_from_source()
          • FinitePointSetMetric.dist_matrix()
        • HeatDistanceMetric
        • Metric
          • Metric.dist()
        • VertexEuclideanMetric
          • VertexEuclideanMetric.dist()
          • VertexEuclideanMetric.dist_from_source()
          • VertexEuclideanMetric.dist_matrix()
    • geomfum.numerics package
      • Submodules
      • geomfum.numerics.eig module
        • ScipyEigsh
      • geomfum.numerics.graph module
        • single_source_partial_dijkstra_path_length()
      • geomfum.numerics.optimization module
        • ScipyMinimize
          • ScipyMinimize.minimize()
        • result_to_backend_type()
      • Module contents
    • geomfum.shape package
      • Subpackages
        • geomfum.shape.convert package
          • Module contents
            • to_go_mesh3d()
            • to_go_pointcloud()
            • to_pv_polydata()
      • Submodules
      • geomfum.shape.hierarchical module
        • EigenBasis
          • EigenBasis.full_spectrum_size
          • EigenBasis.nonzero_vals
          • EigenBasis.nonzero_vecs
          • EigenBasis.spectrum_size
          • EigenBasis.truncate()
          • EigenBasis.vals
          • EigenBasis.vecs
        • HierarchicalMesh
        • HierarchicalMeshRegistry
          • HierarchicalMeshRegistry.MAP
          • HierarchicalMeshRegistry.default
        • HierarchicalShape
          • HierarchicalShape.extend_basis()
          • HierarchicalShape.scalar_low_high()
        • NestedHierarchicalMesh
          • NestedHierarchicalMesh.hmeshes
          • NestedHierarchicalMesh.meshes
          • NestedHierarchicalMesh.n_faces
          • NestedHierarchicalMesh.n_vertices
        • NestedHierarchicalShape
          • NestedHierarchicalShape.extend_basis()
          • NestedHierarchicalShape.from_hierarchical_shape()
          • NestedHierarchicalShape.highest
          • NestedHierarchicalShape.lowest
          • NestedHierarchicalShape.scalar_low_high()
          • NestedHierarchicalShape.shapes
        • WhichRegistryMixins
          • WhichRegistryMixins.from_registry()
      • geomfum.shape.mesh module
        • FaceDivergenceOperator
        • FaceOrientationOperator
        • FaceValuedGradient
        • HeatDistanceMetric
        • Shape
          • Shape.basis
          • Shape.equip_with_operator()
          • Shape.set_basis()
          • Shape.set_landmarks()
        • TriangleMesh
          • TriangleMesh.dist_matrix
          • TriangleMesh.edge_tangent_vectors
          • TriangleMesh.edges
          • TriangleMesh.equip_with_metric()
          • TriangleMesh.face_area_vectors
          • TriangleMesh.face_areas
          • TriangleMesh.face_normals
          • TriangleMesh.face_vertex_coords
          • TriangleMesh.from_file()
          • TriangleMesh.n_faces
          • TriangleMesh.n_vertices
          • TriangleMesh.vertex_areas
          • TriangleMesh.vertex_normals
          • TriangleMesh.vertex_tangent_frames
        • compute_edge_tangent_vectors()
        • compute_tangent_frames()
        • load_mesh()
      • geomfum.shape.point_cloud module
        • HeatDistanceMetric
        • PointCloud
          • PointCloud.dist_matrix
          • PointCloud.edge_tangent_vectors
          • PointCloud.edges
          • PointCloud.equip_with_metric()
          • PointCloud.from_file()
          • PointCloud.knn_graph
          • PointCloud.n_vertices
          • PointCloud.vertex_normals
          • PointCloud.vertex_tangent_frames
        • Shape
          • Shape.basis
          • Shape.equip_with_operator()
          • Shape.set_basis()
          • Shape.set_landmarks()
        • compute_edge_tangent_vectors()
        • compute_tangent_frames()
        • load_pointcloud()
      • geomfum.shape.shape_utils module
        • compute_edge_tangent_vectors()
        • compute_gradient_matrix_fem()
        • compute_tangent_frames()
      • Module contents
        • PointCloud
          • PointCloud.dist_matrix
          • PointCloud.edge_tangent_vectors
          • PointCloud.edges
          • PointCloud.equip_with_metric()
          • PointCloud.from_file()
          • PointCloud.knn_graph
          • PointCloud.n_vertices
          • PointCloud.vertex_normals
          • PointCloud.vertex_tangent_frames
        • Shape
          • Shape.basis
          • Shape.equip_with_operator()
          • Shape.set_basis()
          • Shape.set_landmarks()
        • TriangleMesh
          • TriangleMesh.dist_matrix
          • TriangleMesh.edge_tangent_vectors
          • TriangleMesh.edges
          • TriangleMesh.equip_with_metric()
          • TriangleMesh.face_area_vectors
          • TriangleMesh.face_areas
          • TriangleMesh.face_normals
          • TriangleMesh.face_vertex_coords
          • TriangleMesh.from_file()
          • TriangleMesh.n_faces
          • TriangleMesh.n_vertices
          • TriangleMesh.vertex_areas
          • TriangleMesh.vertex_normals
          • TriangleMesh.vertex_tangent_frames
    • geomfum.wrap package
      • Submodules
      • geomfum.wrap.diffusionnet module
        • BaseFeatureExtractor
          • BaseFeatureExtractor.load_from_path()
          • BaseFeatureExtractor.save()
        • DiffusionNet
          • DiffusionNet.forward()
        • DiffusionNetBlock
          • DiffusionNetBlock.forward()
        • DiffusionnetFeatureExtractor
          • DiffusionnetFeatureExtractor.forward()
        • LearnedTimeDiffusion
          • LearnedTimeDiffusion.forward()
        • MiniMLP
        • SpatialGradientFeatures
          • SpatialGradientFeatures.forward()
        • TriangleMesh
          • TriangleMesh.dist_matrix
          • TriangleMesh.edge_tangent_vectors
          • TriangleMesh.edges
          • TriangleMesh.equip_with_metric()
          • TriangleMesh.face_area_vectors
          • TriangleMesh.face_areas
          • TriangleMesh.face_normals
          • TriangleMesh.face_vertex_coords
          • TriangleMesh.from_file()
          • TriangleMesh.n_faces
          • TriangleMesh.n_vertices
          • TriangleMesh.vertex_areas
          • TriangleMesh.vertex_normals
          • TriangleMesh.vertex_tangent_frames
      • geomfum.wrap.igl module
        • BaseLaplacianFinder
        • IglMeshLaplacianFinder
      • geomfum.wrap.plotly module
        • PlotlyMeshPlotter
          • PlotlyMeshPlotter.add_mesh()
          • PlotlyMeshPlotter.set_vertex_colors()
          • PlotlyMeshPlotter.set_vertex_scalars()
        • PlotlyPointCloudPlotter
          • PlotlyPointCloudPlotter.add_point_cloud()
          • PlotlyPointCloudPlotter.set_vertex_colors()
          • PlotlyPointCloudPlotter.set_vertex_scalars()
        • PlotlyShapePlotter
          • PlotlyShapePlotter.add_vectors()
          • PlotlyShapePlotter.highlight_vertices()
          • PlotlyShapePlotter.save()
          • PlotlyShapePlotter.set_colormap()
          • PlotlyShapePlotter.show()
        • ShapePlotter
          • ShapePlotter.highlight_vertices()
          • ShapePlotter.set_vertex_colors()
          • ShapePlotter.set_vertex_scalars()
          • ShapePlotter.show()
        • to_go_mesh3d()
        • to_go_pointcloud()
      • geomfum.wrap.pointnet module
        • BaseFeatureExtractor
          • BaseFeatureExtractor.load_from_path()
          • BaseFeatureExtractor.save()
        • PointNet
          • PointNet.forward()
        • PointNetfeat
          • PointNetfeat.forward()
        • PointnetFeatureExtractor
          • PointnetFeatureExtractor.forward()
      • geomfum.wrap.polyscope module
        • PsMeshPlotter
          • PsMeshPlotter.add_mesh()
          • PsMeshPlotter.highlight_vertices()
          • PsMeshPlotter.set_vertex_colors()
          • PsMeshPlotter.set_vertex_scalars()
          • PsMeshPlotter.show()
        • PsPointCloudPlotter
          • PsPointCloudPlotter.add_point_cloud()
          • PsPointCloudPlotter.highlight_vertices()
          • PsPointCloudPlotter.set_vertex_colors()
          • PsPointCloudPlotter.set_vertex_scalars()
          • PsPointCloudPlotter.show()
        • ShapePlotter
          • ShapePlotter.highlight_vertices()
          • ShapePlotter.set_vertex_colors()
          • ShapePlotter.set_vertex_scalars()
          • ShapePlotter.show()
      • geomfum.wrap.pot module
        • BaseNeighborFinder
        • PotSinkhornNeighborFinder
      • geomfum.wrap.pp3d module
        • FinitePointSetMetric
          • FinitePointSetMetric.dist_from_source()
          • FinitePointSetMetric.dist_matrix()
        • Pp3dHeatDistanceMetric
          • Pp3dHeatDistanceMetric.dist_matrix()
        • Pp3dMeshHeatDistanceMetric
        • Pp3dPointSetHeatDistanceMetric
      • geomfum.wrap.pyfm module
        • BaseLaplacianFinder
        • BaseSampler
          • BaseSampler.sample()
        • FunctionalOperator
        • PyFmFaceOrientationOperator
        • PyfmEuclideanFarthestVertexSampler
          • PyfmEuclideanFarthestVertexSampler.sample()
        • PyfmFaceDivergenceOperator
        • PyfmFaceValuedGradient
        • PyfmHeatKernelSignature
        • PyfmLandmarkHeatKernelSignature
        • PyfmLandmarkWaveKernelSignature
        • PyfmMeshLaplacianFinder
        • PyfmWaveKernelSignature
        • SpectralDescriptor
        • VectorFieldOperator
        • WksDefaultDomain
        • get_orientation_op()
        • hks_default_domain()
      • geomfum.wrap.pymeshlab module
        • BaseSampler
          • BaseSampler.sample()
        • PymeshlabPoissonSampler
          • PymeshlabPoissonSampler.sample()
      • geomfum.wrap.pyrmt module
        • HierarchicalShape
          • HierarchicalShape.extend_basis()
          • HierarchicalShape.scalar_low_high()
        • PyrmtHierarchicalMesh
          • PyrmtHierarchicalMesh.scalar_low_high()
        • RMTMesh
          • RMTMesh.baryc_map()
          • RMTMesh.clean_up()
          • RMTMesh.make_manifold()
          • RMTMesh.remesh()
          • RMTMesh.triangles
          • RMTMesh.vertices
        • TriangleMesh
          • TriangleMesh.dist_matrix
          • TriangleMesh.edge_tangent_vectors
          • TriangleMesh.edges
          • TriangleMesh.equip_with_metric()
          • TriangleMesh.face_area_vectors
          • TriangleMesh.face_areas
          • TriangleMesh.face_normals
          • TriangleMesh.face_vertex_coords
          • TriangleMesh.from_file()
          • TriangleMesh.n_faces
          • TriangleMesh.n_vertices
          • TriangleMesh.vertex_areas
          • TriangleMesh.vertex_normals
          • TriangleMesh.vertex_tangent_frames
      • geomfum.wrap.pyvista module
        • PvMeshPlotter
          • PvMeshPlotter.add_mesh()
          • PvMeshPlotter.highlight_vertices()
          • PvMeshPlotter.set_vertex_scalars()
          • PvMeshPlotter.show()
        • PvPointCloudPlotter
          • PvPointCloudPlotter.add_point_cloud()
          • PvPointCloudPlotter.highlight_vertices()
          • PvPointCloudPlotter.set_vertex_scalars()
          • PvPointCloudPlotter.show()
        • ShapePlotter
          • ShapePlotter.highlight_vertices()
          • ShapePlotter.set_vertex_colors()
          • ShapePlotter.set_vertex_scalars()
          • ShapePlotter.show()
        • to_pv_polydata()
      • geomfum.wrap.robust module
        • BaseLaplacianFinder
        • RobustMeshLaplacianFinder
        • RobustPointCloudLaplacianFinder
      • geomfum.wrap.transformer module
        • AttentionLayer
          • AttentionLayer.forward()
        • BaseFeatureExtractor
          • BaseFeatureExtractor.load_from_path()
          • BaseFeatureExtractor.save()
        • MultiHeadAttention
          • MultiHeadAttention.forward()
        • Transformer
          • Transformer.forward()
        • TransformerFeatureExtractor
          • TransformerFeatureExtractor.forward()
      • Module contents
        • has_package()
        • register_face_divergence_operator()
        • register_face_orientation_operator()
        • register_face_valued_gradient()
        • register_feature_extractor()
        • register_heat_distance_metric()
        • register_heat_kernel_signature()
        • register_hierarchical_mesh()
        • register_landmark_heat_kernel_signature()
        • register_landmark_wave_kernel_signature()
        • register_laplacian_finder()
        • register_mesh_plotter()
        • register_neighbor_finder()
        • register_point_cloud_plotter()
        • register_poisson_sampler()
        • register_wave_kernel_signature()
  • Submodules
  • geomfum.basis module
    • Basis
    • EigenBasis
      • EigenBasis.full_spectrum_size
      • EigenBasis.nonzero_vals
      • EigenBasis.nonzero_vecs
      • EigenBasis.spectrum_size
      • EigenBasis.truncate()
      • EigenBasis.vals
      • EigenBasis.vecs
    • LaplaceEigenBasis
      • LaplaceEigenBasis.pinv
      • LaplaceEigenBasis.project()
      • LaplaceEigenBasis.truncate()
      • LaplaceEigenBasis.use_k
  • geomfum.convert module
    • BaseFmFromP2pConverter
    • BaseNeighborFinder
    • BaseP2pFromFmConverter
    • FmFromP2pBijectiveConverter
    • FmFromP2pConverter
    • NamFromP2pConverter
    • NearestNeighbors
      • NearestNeighbors.effective_metric_
      • NearestNeighbors.effective_metric_params_
      • NearestNeighbors.n_features_in_
      • NearestNeighbors.feature_names_in_
      • NearestNeighbors.n_samples_fit_
      • NearestNeighbors.fit()
    • NeighborFinder
    • NeighborFinderRegistry
      • NeighborFinderRegistry.MAP
      • NeighborFinderRegistry.default
      • NeighborFinderRegistry.has_internal
    • NeuralAdjointMap
      • NeuralAdjointMap.forward()
    • P2pFromFmConverter
    • P2pFromNamConverter
    • SinkhornP2pFromFmConverter
    • SoftmaxNeighborFinder
      • SoftmaxNeighborFinder.forward()
      • SoftmaxNeighborFinder.softmax_matrix()
    • WhichRegistryMixins
      • WhichRegistryMixins.from_registry()
  • geomfum.forward_functional_map module
    • ForwardFunctionalMap
  • geomfum.functional_map module
    • FactorSum
      • FactorSum.gradient()
    • LBCommutativityEnforcing
      • LBCommutativityEnforcing.from_bases()
      • LBCommutativityEnforcing.gradient()
    • OperatorCommutativityEnforcing
      • OperatorCommutativityEnforcing.compute_multiplication_operator()
      • OperatorCommutativityEnforcing.compute_orientation_operator()
      • OperatorCommutativityEnforcing.from_multiplication()
      • OperatorCommutativityEnforcing.from_orientation()
      • OperatorCommutativityEnforcing.gradient()
    • SpectralDescriptorPreservation
      • SpectralDescriptorPreservation.gradient()
    • WeightedFactor
      • WeightedFactor.gradient()
  • geomfum.io module
    • load_mesh()
    • load_pointcloud()
  • geomfum.laplacian module
    • BaseLaplacianFinder
    • LaplaceEigenBasis
      • LaplaceEigenBasis.pinv
      • LaplaceEigenBasis.project()
      • LaplaceEigenBasis.truncate()
      • LaplaceEigenBasis.use_k
    • LaplacianFinder
    • LaplacianFinderRegistry
      • LaplacianFinderRegistry.Registries
    • LaplacianSpectrumFinder
      • LaplacianSpectrumFinder.spectrum_size
    • MeshWhichRegistryMixins
      • MeshWhichRegistryMixins.from_registry()
    • ScipyEigsh
  • geomfum.linalg module
    • columnwise_scaling()
    • matvecmul()
    • normalize()
    • rowwise_scaling()
    • scalarvecmul()
    • scale_to_unit_sum()
  • geomfum.neural_adjoint_map module
    • MLP
      • MLP.forward()
    • NeuralAdjointMap
      • NeuralAdjointMap.forward()
  • geomfum.operator module
    • FaceDivergenceOperator
    • FaceDivergenceOperatorRegistry
      • FaceDivergenceOperatorRegistry.MAP
      • FaceDivergenceOperatorRegistry.default
    • FaceOrientationOperator
    • FaceOrientationOperatorRegistry
      • FaceOrientationOperatorRegistry.MAP
      • FaceOrientationOperatorRegistry.default
    • FaceValuedGradient
    • FaceValuedGradientRegistry
      • FaceValuedGradientRegistry.MAP
      • FaceValuedGradientRegistry.default
    • FunctionalOperator
    • Gradient
      • Gradient.gradient_matrix
    • Laplacian
      • Laplacian.basis
      • Laplacian.find()
      • Laplacian.find_spectrum()
      • Laplacian.mass_matrix
      • Laplacian.stiffness_matrix
    • LaplacianFinder
    • LaplacianSpectrumFinder
      • LaplacianSpectrumFinder.spectrum_size
    • VectorFieldOperator
    • WhichRegistryMixins
      • WhichRegistryMixins.from_registry()
  • geomfum.plot module
    • MeshPlotter
    • MeshPlotterRegistry
      • MeshPlotterRegistry.MAP
      • MeshPlotterRegistry.default
    • PointCloudPlotter
    • PointCloudPlotterRegistry
      • PointCloudPlotterRegistry.MAP
      • PointCloudPlotterRegistry.default
    • ShapePlotter
      • ShapePlotter.highlight_vertices()
      • ShapePlotter.set_vertex_colors()
      • ShapePlotter.set_vertex_scalars()
      • ShapePlotter.show()
    • WhichRegistryMixins
      • WhichRegistryMixins.from_registry()
  • geomfum.refine module
    • AdjointBijectiveZoomOut
    • FastSinkhornFilters
    • FmFromP2pBijectiveConverter
    • FmFromP2pConverter
    • IcpRefiner
    • IdentityRefiner
    • IterativeRefiner
      • IterativeRefiner.iter()
      • IterativeRefiner.step
    • NamFromP2pConverter
    • NeuralZoomOut
    • OrthogonalRefiner
    • P2pFromFmConverter
    • P2pFromNamConverter
    • ProperRefiner
    • Refiner
    • SinkhornP2pFromFmConverter
    • ZoomOut
  • geomfum.sample module
    • BaseSampler
      • BaseSampler.sample()
    • FarthestPointSampler
      • FarthestPointSampler.sample()
    • NearestNeighbors
      • NearestNeighbors.effective_metric_
      • NearestNeighbors.effective_metric_params_
      • NearestNeighbors.n_features_in_
      • NearestNeighbors.feature_names_in_
      • NearestNeighbors.n_samples_fit_
      • NearestNeighbors.fit()
    • PoissonSampler
    • PoissonSamplerRegistry
      • PoissonSamplerRegistry.MAP
      • PoissonSamplerRegistry.default
    • VertexProjectionSampler
      • VertexProjectionSampler.sample()
    • WhichRegistryMixins
      • WhichRegistryMixins.from_registry()
  • Module contents