Implementation Of Visualization Framework

geomfum/_registry.py

@@ -245,6 +245,10 @@ class HierarchicalMeshRegistry(WhichRegistry):
     MAP = {}
 
 
+class MeshPlotterRegistry(WhichRegistry):
+    MAP = {}
+
+
 def _create_register_funcs(module):
     """Create ``register`` functions for each class registry in this module.
 

geomfum/plot.py

@@ -0,0 +1,34 @@
+import abc
+from geomfum._registry import MeshPlotterRegistry, WhichRegistryMixins
+
+"""
+In this file we define the plotting logic used in geomfum
+Since each plotting library has its own method of plotting, we define general functions that works with any library implemented 
+
+"""
+
+class ShapePlotter(abc.ABC):
+    """
+    Primitive Calss to plot meshes, pointclouds or specific useful informations (scalar functions, landmarks, etc..)
+    """
+    def plot(self, mesh):
+
+        """
+        Function to plot a mesh
+
+        """
+        raise NotImplementedError("This method should be overridden by subclasses")
+
+    def plot_function(self, mesh, function):  
+        """
+        Function to plot a mesh
+        """
+        raise NotImplementedError("This method should be overridden by subclasses")
+    def show(self):  
+        """
+        Function to display the plot
+        """
+        raise NotImplementedError("This method should be overridden by subclasses")
+
+class MeshPlotter(WhichRegistryMixins, ShapePlotter):
+    _Registry = MeshPlotterRegistry

geomfum/shape/convert.py

@@ -0,0 +1,22 @@
+import numpy as np
+# TODO: decide where its best to put this functions since they are related to the import of plotly and pyvista
+import plotly.graph_objects as go
+import pyvista as pv
+
+
+
+def to_go_mesh3d(mesh):    
+    """
+    Convert a TriangleMesh object to a plotly Mesh3d object.
+    """
+    x, y, z = mesh.vertices[:, 0], mesh.vertices[:, 1], mesh.vertices[:, 2]
+    f1, f2, f3 = mesh.faces[:, 0], mesh.faces[:, 1], mesh.faces[:, 2]
+
+    return go.Mesh3d(x=x, y=y, z=z, i=f1, j=f2, k=f3)
+
+
+def to_pv_polydata(mesh):
+    """
+    Convert a TriangleMesh object to a PyVista PolyData object.
+    """
+    return pv.PolyData.from_regular_faces(points=mesh.vertices, faces=mesh.faces)

geomfum/wrap/__init__.py

@@ -6,6 +6,7 @@
     register_hierarchical_mesh,
     register_laplacian_finder,
     register_wave_kernel_signature,
+    register_mesh_plotter,
 )
 from geomfum._utils import has_package
 
@@ -52,7 +53,14 @@
     "pyfm", "PyFmFaceOrientationOperator", requires="pyFM", as_default=True
 )
 
-
 register_hierarchical_mesh(
     "pyrmt", "PyrmtHierarchicalMesh", requires="PyRMT", as_default=True
 )
+
+register_mesh_plotter(
+    "plotly", "PlotlyMeshPlotter", requires="plotly", as_default=True
+)
+register_mesh_plotter(
+    "pyvista", "PyvistaMeshPlotter", requires="pyvista", as_default=False
+)
+

geomfum/wrap/plotly.py

@@ -0,0 +1,38 @@
+
+import plotly.graph_objects as go
+from geomfum.plot import ShapePlotter
+from geomfum.shape.convert import to_go_mesh3d
+
+
+class PlotlyMeshPlotter(ShapePlotter):
+
+    def __init__(self, colormap='viridis'):
+        self.colormap = colormap
+        self.fig = None
+
+    def plot(self, mesh):
+
+        mesh3d= to_go_mesh3d(mesh)
+        #update adding plotter properties
+        mesh3d.update(colorscale=self.colormap)
+        self.fig = go.Figure(data=[mesh3d])
+
+        return self.fig
+
+    def plot_function(self, mesh, function):
+
+
+        vertices=mesh.vertices
+        faces=mesh.faces
+        x, y, z = vertices[:,0], vertices[:,1], vertices[:,2]
+        f1,f2,f3= faces[:,0], faces[:,1], faces[:,2]
+        self.fig = go.Figure(data=[go.Mesh3d(x=x,y=y,z=z, i=f1, j=f2, k=f3,
+                                        intensity = function, 
+                                        colorscale  = self.colormap,   
+        )])
+
+        return self.fig
+
+    def show(self):
+        self.fig.show()    
+

geomfum/wrap/pyvista.py

@@ -0,0 +1,22 @@
+import pyvista as pv
+from geomfum.plot import ShapePlotter
+import numpy as np
+from geomfum.shape.convert import to_pv_polydata
+
+
+
+class PyvistaMeshPlotter(ShapePlotter):
+
+    def __init__(self, colormap='viridis'):
+        self.colormap = colormap
+        self.fig=None
+    def plot(self, mesh):
+
+        # here i call the plotter fig to be consistent with the plotly plotter
+        mesh_polydata = to_pv_polydata(mesh)
+        self.fig = pv.Plotter()
+        self.fig.add_mesh(mesh_polydata, cmap=self.colormap, show_edges=False)
+        return self.fig
+
+    def show(self):
+        self.fig.show()