capytaine 2.3.1__cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

capytaine/ui/rich.py

@@ -0,0 +1,5 @@
+import logging
+from rich.logging import RichHandler
+
+def set_logging(level="INFO"):
+    logging.basicConfig(level=level, format="%(message)s", handlers=[RichHandler(level=level, log_time_format="[%X]", show_path=False)], force=True)

capytaine/ui/vtk/__init__.py

@@ -0,0 +1,3 @@
+from capytaine.ui.vtk.mesh_viewer import MeshViewer
+from capytaine.ui.vtk.body_viewer import FloatingBodyViewer
+from capytaine.ui.vtk.animation import Animation

capytaine/ui/vtk/animation.py

@@ -0,0 +1,329 @@
+"""VTK animation for the free surface elevation."""
+# Copyright (C) 2017-2019 Matthieu Ancellin
+# See LICENSE file at <https://github.com/mancellin/capytaine>
+
+import logging
+
+import numpy as np
+from numpy import pi
+
+from capytaine.ui.vtk.helpers import compute_node_data, compute_vtk_polydata
+from capytaine.tools.optional_imports import import_optional_dependency
+
+vtk = import_optional_dependency("vtk")
+
+LOG = logging.getLogger(__name__)
+
+
+class Animation:
+    """Class to generate an animation of a result of Capytaine,
+    including the elevation of the free surface.
+
+    The animation is made of a short loop of a single period of the solution in frequency domain.
+
+    Parameters
+    ----------
+    loop_duration: float
+        Duration in the loop. For real time animation, the period of the motion.
+    fps: int, optional
+        Number of frames per second in the animation (default: 24).
+
+    Attributes
+    ----------
+    frames_per_loop: int
+        Number of frames in one loop
+    actors: list of vtk actor objects
+        The objects in the scene.
+    """
+
+    def __init__(self, loop_duration, fps=24):
+        self.fps = fps
+        self.frames_per_loop = int(fps * loop_duration)
+        self.actors = []
+
+        self._precomputed_polydatas = {}
+        self._current_frame = 0
+
+    # @classmethod
+    # def from_result(self, result):
+    #     from capytaine.bodies import TRANSLATION_DOFS_DIRECTIONS, ROTATION_DOFS_AXIS
+    #
+    #         if display_dof.lower() in TRANSLATION_DOFS_DIRECTIONS:
+    #             direction = np.asarray(TRANSLATION_DOFS_DIRECTIONS[display_dof.lower()])
+    #             def translation_motion(self, frame):
+    #                 nonlocal direction
+    #                 pos = np.asarray(self.body_actor.GetPosition())
+    #                 pos = (1 - direction) * pos + \
+    #                       direction * np.cos(2*np.pi*(frame % self.frames_per_loop)/self.frames_per_loop)
+    #                 self.body_actor.SetPosition(*pos)
+    #             self.update_body_position = translation_motion
+    #
+    #         elif display_dof.lower() in ROTATION_DOFS_AXIS:
+    #             direction = np.asarray(ROTATION_DOFS_AXIS[display_dof.lower()])
+    #             def rotation_motion(self, frame):
+    #                 nonlocal direction
+    #                 pos = np.asarray(self.body_actor.GetOrientation())
+    #                 pos = (1 - direction) * pos + \
+    #                       direction * np.cos(2*np.pi*(frame % self.frames_per_loop)/self.frames_per_loop)
+    #                 self.body_actor.SetOrientation(*pos)
+    #             self.update_body_position = rotation_motion
+
+
+    def _add_actor(self, mesh, faces_motion=None, faces_colors=None, edges=False):
+        """Add an animated object to the scene."""
+        if faces_motion is not None:
+            nodes_motion = compute_node_data(mesh.merged(), faces_motion)
+        else:
+            nodes_motion = None
+
+        base_polydata = compute_vtk_polydata(mesh.merged())
+        mapper = vtk.vtkPolyDataMapper()
+        mapper.SetInputData(base_polydata)
+
+        actor = vtk.vtkActor()
+        if edges:
+            actor.GetProperty().EdgeVisibilityOn()
+        actor.GetProperty().SetInterpolationToGouraud()
+        actor.SetMapper(mapper)
+
+        if nodes_motion is not None or faces_colors is not None:
+            LOG.info(f"Precompute motions of {mesh.name} before animation.")
+            self._precomputed_polydatas[actor] = []
+
+            for i_frame in range(self.frames_per_loop):
+                new_polydata = vtk.vtkPolyData()
+                new_polydata.DeepCopy(base_polydata)
+
+                if nodes_motion is not None:
+                    # Change points positions at frame i
+                    current_deformation = (
+                            np.abs(nodes_motion)*np.cos(np.angle(nodes_motion)-2*pi*i_frame/self.frames_per_loop)
+                    )
+
+                    points = new_polydata.GetPoints()
+                    for j in range(mesh.nb_vertices):
+                        point = points.GetPoint(j)
+                        point = np.asarray(point) + current_deformation[j]
+                        points.SetPoint(j, tuple(point))
+
+                if faces_colors is not None:
+                    # Evaluate scalar field at frame i
+                    current_colors = (
+                        np.abs(faces_colors)*np.cos(np.angle(faces_colors)-2*pi*i_frame/self.frames_per_loop)
+                    )
+                    max_val = max(abs(faces_colors))
+                    vtk_faces_colors = vtk.vtkFloatArray()
+                    for i, color in enumerate(current_colors):
+                        vtk_faces_colors.InsertValue(i, (color+max_val)/(2*max_val))
+                    new_polydata.GetCellData().SetScalars(vtk_faces_colors)
+
+                self._precomputed_polydatas[actor].append(new_polydata)
+        else:
+            self._precomputed_polydatas[actor] = None
+
+        self.actors.append(actor)
+
+        return actor
+
+    def add_body(self, body, faces_motion=None, faces_colors=None, edges=False):
+        """Add an floating body to the scene.
+
+        Parameters
+        ----------
+        body: FloatingBody
+            The object to include in the scene.
+        faces_motion: dof, optional
+            The motion of the body defined at the center of the faces.
+        faces_colors: iterable of complex numbers, optional
+            Scalar field over the surface of the body that should be displayed with colors.
+        edges: bool, optional
+            Draw the edges of the mesh in the scene.
+
+        Returns
+        -------
+        vtk actor object
+        """
+        actor = self._add_actor(body.mesh.merged(), faces_motion=faces_motion,
+                                faces_colors=faces_colors, edges=edges)
+        if faces_colors is None:
+            actor.GetProperty().SetColor((1, 1, 0))
+        else:
+            lut = vtk.vtkLookupTable()
+            lut.SetNumberOfColors(50)
+            lut.SetHueRange(0, 0.6)
+            lut.SetSaturationRange(0.5, 0.5)
+            lut.SetValueRange(0.8, 0.8)
+            lut.Build()
+            actor.GetMapper().SetLookupTable(lut)
+
+        return actor
+
+    def add_free_surface(self, free_surface, faces_elevation):
+        """Add the free surface to the scene.
+
+        Parameters
+        ----------
+        free_surface: FreeSurface
+            The free surface object
+        faces_elevation: array of complex numbers
+            The elevation of each face of the meshed free surface given as a complex number.
+
+        Returns
+        -------
+        vtk actor object
+        """
+        faces_motion = np.array([(0, 0, elevation) for elevation in faces_elevation])
+        actor = self._add_actor(free_surface.mesh, faces_motion=faces_motion, faces_colors=faces_motion[:, 2])
+
+        lut = vtk.vtkLookupTable()
+        lut.SetNumberOfColors(50)
+        lut.SetHueRange(0.58, 0.58)
+        lut.SetSaturationRange(0.5, 0.5)
+        lut.SetValueRange(0.4, 0.6)
+        lut.Build()
+        actor.GetMapper().SetLookupTable(lut)
+
+        return actor
+
+    def _callback(self, renderer, event):
+        for actor in self.actors:
+            if self._precomputed_polydatas[actor] is not None:
+                actor.GetMapper().SetInputData(self._precomputed_polydatas[actor][self._current_frame % self.frames_per_loop])
+        renderer.GetRenderWindow().Render()
+        self._current_frame += 1
+
+    def run(self, camera_position=(-10.0, -10.0, 10.0), resolution=(1280, 720), top_light_intensity=0.5):
+        """Run the animation.
+
+        Parameters
+        ----------
+        camera_position: 3-ple of floats, optional
+            The starting position of the camera in the scene.
+        resolution: 2-ple of ints, optional
+            Resolution of the video in pixels.
+        top_light_intensity: float between 0 and 1
+            Intensity of the light source at the top of the scene (default: 0.5)
+        """
+        # Setup a renderer, render window, and interactor
+        renderer = vtk.vtkRenderer()
+        renderer.SetBackground(1, 1, 1)  # Background color white
+        for actor in self.actors:
+            renderer.AddActor(actor)
+        renderer.Modified()
+
+        camera = vtk.vtkCamera()
+        camera.SetPosition(*camera_position)
+        camera.SetFocalPoint(0, 0, 0)
+        camera.SetViewUp(0, 0, 1)
+        renderer.SetActiveCamera(camera)
+
+        light = vtk.vtkLight()
+        light.SetLightTypeToHeadlight()
+        renderer.AddLight(light)
+
+        if top_light_intensity > 0.0:
+            light = vtk.vtkLight()
+            light.SetDirectionAngle(0, 0)
+            light.SetLightTypeToSceneLight()
+            light.SetIntensity(top_light_intensity)
+            renderer.AddLight(light)
+
+        render_window = vtk.vtkRenderWindow()
+        render_window.SetSize(*resolution)
+        render_window.SetWindowName("Capytaine animation")
+        render_window.AddRenderer(renderer)
+
+        render_window_interactor = vtk.vtkRenderWindowInteractor()
+        render_window_interactor.SetRenderWindow(render_window)
+        render_window_interactor.GetInteractorStyle().SetCurrentStyleToTrackballCamera()
+
+        render_window.Render()
+
+        render_window_interactor.Initialize()  # Initialize must be called prior to creating timer events.
+
+        render_window_interactor.AddObserver('TimerEvent', self._callback)
+        render_window_interactor.CreateRepeatingTimer(int(1000 / self.fps))
+
+        render_window_interactor.Start()
+
+        # Run until stopped by user.
+
+        del render_window_interactor
+        del render_window
+
+    def save(self, filepath, nb_loops=1, camera_position=(-10.0, -10.0, 10.0), resolution=(1280, 720), top_light_intensity=0.5):
+        """Save the animation in a video file.
+
+        Parameters
+        ----------
+        filepath: string
+            Path of the output file.
+        nb_loop: int, optional
+            Number of periods to save in the file.
+        camera_position: 3-ple of floats, optional
+            The starting position of the camera in the scene.
+        resolution: 2-ple of ints, optional
+            Resolution of the video in pixels.
+        top_light_intensity: float between 0 and 1
+            Intensity of the light source at the top of the scene (default: 0.5)
+        """
+        renderer = vtk.vtkRenderer()
+        renderer.SetBackground(1, 1, 1)  # Background color white
+        for actor in self.actors:
+            renderer.AddActor(actor)
+        renderer.Modified()
+
+        camera = vtk.vtkCamera()
+        camera.SetPosition(*camera_position)
+        camera.SetFocalPoint(0, 0, 0)
+        camera.SetViewUp(0, 0, 1)
+        renderer.SetActiveCamera(camera)
+
+        light = vtk.vtkLight()
+        light.SetLightTypeToHeadlight()
+        renderer.AddLight(light)
+
+        if top_light_intensity > 0.0:
+            light = vtk.vtkLight()
+            light.SetDirectionAngle(0, 0)
+            light.SetLightTypeToSceneLight()
+            light.SetIntensity(top_light_intensity)
+            renderer.AddLight(light)
+
+        render_window = vtk.vtkRenderWindow()
+        render_window.SetSize(*resolution)
+        render_window.OffScreenRenderingOn()
+        render_window.AddRenderer(renderer)
+
+        image_filter = vtk.vtkWindowToImageFilter()
+        image_filter.SetInput(render_window)
+        image_filter.SetInputBufferTypeToRGB()
+        image_filter.ReadFrontBufferOff()
+
+        writer = vtk.vtkOggTheoraWriter()
+        writer.SetInputConnection(image_filter.GetOutputPort())
+        writer.SetFileName(filepath)
+        writer.SetRate(self.fps)
+
+        writer.Start()
+
+        for i_frame in range(nb_loops*self.frames_per_loop):
+            self._callback(renderer, None)
+            image_filter.Modified()
+            writer.Write()
+
+        writer.End()
+        render_window.Finalize()
+
+        del image_filter
+        del writer
+        del render_window
+
+    def embed_in_notebook(self, resolution=(640, 360), **kwargs):
+        from tempfile import mkstemp
+        from IPython.core.display import Video
+        # Requires Ipython 7.14 or higher, for this patch: https://github.com/ipython/ipython/pull/12212/
+
+        filepath = mkstemp(suffix=".ogv")[1]
+        self.save(filepath, nb_loops=1, resolution=resolution, **kwargs)
+        return Video(filepath, embed=True, width=resolution[0], html_attributes="controls loop autoplay")

capytaine/ui/vtk/body_viewer.py

@@ -0,0 +1,28 @@
+"""3D display of floating body with VTK."""
+# Copyright (C) 2017-2019 Matthieu Ancellin
+# See LICENSE file at <https://github.com/mancellin/capytaine>
+
+from capytaine.tools.optional_imports import import_optional_dependency
+from capytaine.ui.vtk.mesh_viewer import MeshViewer
+
+vtk = import_optional_dependency("vtk")
+
+class FloatingBodyViewer(MeshViewer):
+
+    def __init__(self):
+        super().__init__()
+        self.dofs_data = {}
+
+    def add_body(self, body, **kwargs):
+        self.add_mesh(body.mesh, **kwargs)
+        if body.lid_mesh is not None:
+            self.add_mesh(body.lid_mesh, **kwargs)
+
+        for dof in body.dofs:
+            vtk_data_array = vtk.vtkFloatArray()
+            vtk_data_array.SetNumberOfComponents(3)
+            vtk_data_array.SetNumberOfTuples(body.mesh.nb_faces)
+            for i, vector in enumerate(body.dofs[dof]):
+                vtk_data_array.SetTuple3(i, *vector)
+            self.dofs_data[dof] = vtk_data_array
+            # vtk_polydata.GetCellData().SetVectors(vtk_data_array)

capytaine/ui/vtk/helpers.py

@@ -0,0 +1,82 @@
+"""Tools for 3D displays with VTK."""
+# Copyright (C) 2017-2019 Matthieu Ancellin
+# See LICENSE file at <https://github.com/mancellin/capytaine>
+
+from typing import Union
+
+from capytaine.meshes.meshes import Mesh
+from capytaine.meshes.collections import CollectionOfMeshes
+from capytaine.tools.optional_imports import import_optional_dependency
+
+vtk = import_optional_dependency("vtk")
+
+def compute_vtk_polydata(mesh: Union[Mesh, CollectionOfMeshes]):
+    """Transform a mesh into vtkPolydata."""
+
+    # Create a vtkPoints object and store the points in it
+    points = vtk.vtkPoints()
+    for point in mesh.vertices:
+        points.InsertNextPoint(point)
+
+    # Create a vtkCellArray to store faces
+    faces = vtk.vtkCellArray()
+    for face_ids in mesh.faces:
+        if face_ids[0] == face_ids[-1]:
+            # Triangle
+            curface = face_ids[:3]
+            vtk_face = vtk.vtkTriangle()
+        else:
+            # Quadrangle
+            curface = face_ids[:4]
+            vtk_face = vtk.vtkQuad()
+
+        for idx, id in enumerate(curface):
+            vtk_face.GetPointIds().SetId(idx, id)
+
+        faces.InsertNextCell(vtk_face)
+
+    vtk_polydata = vtk.vtkPolyData()
+    vtk_polydata.SetPoints(points)
+    vtk_polydata.SetPolys(faces)
+
+    return vtk_polydata
+
+
+def compute_node_data(mesh: Union[Mesh, CollectionOfMeshes],
+                      face_data):
+    """Transform data defined at the center of the faces to data defined at the nodes of the mesh
+    by a simple averaging of the values of the neighboring faces.
+
+    Parameters
+    ----------
+    mesh: Mesh or CollectionOfMeshes
+        the mesh on which the face face_data are defined
+    face_data: numpy array of shape (mesh.nb_faces, ...)
+        the data defined on the center of the faces of the mesh
+
+    Returns
+    -------
+    node_data: numpy array of shape (mesh.nb_vertices, ...)
+        the same data averaged on the nodes
+    """
+
+    import numpy as np
+
+    mesh = mesh.merged()
+    assert face_data.shape[0] == mesh.nb_faces
+
+    # Initialize output array
+    node_data_shape = (mesh.vertices.shape[0], ) + face_data.shape[1:]
+    node_data = np.zeros(node_data_shape, dtype=complex)
+
+    # Keep track of the number of faces near each vertex
+    faces_near_nodes_shape = (mesh.vertices.shape[0], ) + (1, ) * len(face_data.shape[1:])
+    nb_faces_near_nodes = np.zeros(faces_near_nodes_shape, dtype=np.int8)
+
+    for i, vertices in enumerate(mesh.faces):
+        for vertex in vertices:
+            nb_faces_near_nodes[vertex] += 1
+            node_data[vertex, ...] += face_data[i, ...]
+
+    node_data /= nb_faces_near_nodes
+    return node_data