Refactoring to include multiple shapes type in the future

geomfum/_registry.py

@@ -249,8 +249,8 @@ def from_registry(cls, *args, which=None, **kwargs):
         return instantiator(*args, **kwargs)
 
 
-class MeshWhichRegistryMixins:
-    """Mixin for registry-based instantiation with mesh/point cloud distinction."""
+class ShapeWhichRegistryMixins:
+    """Mixin for registry-based instantiation with shape type distinction."""
 
     def __init__(self, *args, **kwargs):
         # TODO: has to be improved
@@ -259,13 +259,13 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
     @classmethod
-    def from_registry(cls, *args, mesh=True, which=None, **kwargs):
+    def from_registry(cls, *args, shape_type="mesh", which=None, **kwargs):
         """Create instance from registered implementation based on shape type.
 
         Parameters
         ----------
-        mesh : bool
-            Whether a mesh or point cloud.
+        shape_type : str
+            Type of shape (e.g. ``"mesh"``, ``"pointcloud"``).
         which : str
             A registered implementation.
 
@@ -274,7 +274,7 @@ def from_registry(cls, *args, mesh=True, which=None, **kwargs):
         obj : Obj
             An instantiated object.
         """
-        instantiator = cls._Registry.get(mesh, which)
+        instantiator = cls._Registry.get(shape_type, which)
         if instantiator is None:
             obj = cls.__new__(cls)
             obj.__init__(*args, **kwargs)
@@ -295,8 +295,8 @@ class _PointSetLaplacianFinderRegistry(Registry):
 
 class LaplacianFinderRegistry(NestedRegistry):
     Registries = {
-        True: _MeshLaplacianFinderRegistry,
-        False: _PointSetLaplacianFinderRegistry,
+        "mesh": _MeshLaplacianFinderRegistry,
+        "pointcloud": _PointSetLaplacianFinderRegistry,
     }
 
 
@@ -374,8 +374,8 @@ class _PointSetHeatDistanceMetricRegistry(Registry):
 
 class HeatDistanceMetricRegistry(NestedRegistry):
     Registries = {
-        True: _MeshHeatDistanceMetricRegistry,
-        False: _PointSetHeatDistanceMetricRegistry,
+        "mesh": _MeshHeatDistanceMetricRegistry,
+        "pointcloud": _PointSetHeatDistanceMetricRegistry,
     }
 
 

geomfum/laplacian.py

@@ -5,7 +5,7 @@
 import gsops.backend as gs
 
 import geomfum.wrap as _wrap  # noqa (for register)
-from geomfum._registry import LaplacianFinderRegistry, MeshWhichRegistryMixins
+from geomfum._registry import LaplacianFinderRegistry, ShapeWhichRegistryMixins
 from geomfum.basis import LaplaceEigenBasis
 from geomfum.numerics.eig import ScipyEigsh
 
@@ -31,7 +31,7 @@ def __call__(self, shape):
         """
 
 
-class LaplacianFinder(MeshWhichRegistryMixins, BaseLaplacianFinder):
+class LaplacianFinder(ShapeWhichRegistryMixins, BaseLaplacianFinder):
     """Algorithm to find the Laplacian."""
 
     _Registry = LaplacianFinderRegistry

geomfum/metric/_base.py

@@ -4,7 +4,7 @@
 
 import gsops.backend as gs
 
-from geomfum._registry import HeatDistanceMetricRegistry, MeshWhichRegistryMixins
+from geomfum._registry import HeatDistanceMetricRegistry, ShapeWhichRegistryMixins
 
 
 class Metric(abc.ABC):
@@ -135,7 +135,7 @@ def dist_matrix(self):
         return self.dist_from_source(gs.arange(self._shape.n_vertices))[0]
 
 
-class HeatDistanceMetric(MeshWhichRegistryMixins):
+class HeatDistanceMetric(ShapeWhichRegistryMixins):
     """Geodesic distance approximation using the heat method.
 
     References

geomfum/operator.py

@@ -141,7 +141,7 @@ def find(self, laplacian_finder=None, recompute=False):
 
         if laplacian_finder is None:
             laplacian_finder = LaplacianFinder.from_registry(
-                mesh=self._shape.is_mesh, which="robust"
+                shape_type=self._shape.shape_type, which="robust"
             )
 
         self._stiffness_matrix, self._mass_matrix = laplacian_finder(self._shape)

geomfum/shape/_base.py

@@ -13,12 +13,12 @@ class Shape(abc.ABC):
 
     Parameters
     ----------
-    is_mesh : bool
-        Whether the shape is a mesh (True) or point cloud (False).
+    shape_type : str
+        Type of shape (e.g. ``"mesh"``, ``"pointcloud"``).
     """
 
-    def __init__(self, is_mesh):
-        self.is_mesh = is_mesh
+    def __init__(self, shape_type):
+        self.shape_type = shape_type
 
         self._basis = None
         self.laplacian = Laplacian(self)

geomfum/shape/mesh.py

@@ -33,7 +33,7 @@ def __init__(
         vertices,
         faces,
     ):
-        super().__init__(is_mesh=True)
+        super().__init__(shape_type="mesh")
         self.vertices = gs.asarray(vertices)
         self.faces = gs.asarray(faces)
 

geomfum/shape/point_cloud.py

@@ -23,7 +23,7 @@ class PointCloud(Shape):
     """
 
     def __init__(self, vertices):
-        super().__init__(is_mesh=False)
+        super().__init__(shape_type="pointcloud")
         self.vertices = gs.asarray(vertices)
 
         self.n_neighbors = 30

geomfum/wrap/__init__.py

@@ -20,26 +20,26 @@
 from geomfum._utils import has_package
 
 register_laplacian_finder(
-    True,
+    "mesh",
     "pyfm",
     "PyfmMeshLaplacianFinder",
     requires="pyFM",
     as_default=not has_package("robust_laplacian"),
 )
 
 register_laplacian_finder(
-    True,
+    "mesh",
     "robust",
     "RobustMeshLaplacianFinder",
     requires="robust_laplacian",
     as_default=has_package("robust_laplacian"),
 )
 
-register_laplacian_finder(True, "igl", "IglMeshLaplacianFinder", requires="igl")
+register_laplacian_finder("mesh", "igl", "IglMeshLaplacianFinder", requires="igl")
 
 
 register_laplacian_finder(
-    False, "robust", "RobustPointCloudLaplacianFinder", requires="robust_laplacian"
+    "pointcloud", "robust", "RobustPointCloudLaplacianFinder", requires="robust_laplacian"
 )
 
 register_heat_kernel_signature(
@@ -120,11 +120,11 @@
 
 
 register_heat_distance_metric(
-    True, "pp3d", "Pp3dMeshHeatDistanceMetric", requires="potpourri3d", as_default=True
+    "mesh", "pp3d", "Pp3dMeshHeatDistanceMetric", requires="potpourri3d", as_default=True
 )
 
 register_heat_distance_metric(
-    False,
+    "pointcloud",
     "pp3d",
     "Pp3dPointSetHeatDistanceMetric",
     requires="potpourri3d",