vistools 0.1.0__tar.gz

vistools-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023-2025 Ivo Steinbrecher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

vistools-0.1.0/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: vistools
+Version: 0.1.0
+Summary: Utility functionality for vtk and pyvista
+Author-email: Ivo Steinbrecher <ivo.steinbrecher@unibw.de>
+Project-URL: Repository, https://github.com/isteinbrecher/vtktools/
+Project-URL: Issues, https://github.com/isteinbrecher/vtktools/issues/
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: vtk
+Provides-Extra: pyvista
+Requires-Dist: pyvista<0.45.0; extra == "pyvista"
+Requires-Dist: opencv-python; extra == "pyvista"
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Dynamic: license-file

vistools-0.1.0/README.md

@@ -0,0 +1,19 @@
+# VisTools
+
+**VisTools** is a utility library for scientific visualization workflows, focused on the pure VTK data format as well as PyVista.
+
+## Modules
+
+- `vistools.vtk`: Utility functions based only on the plain `vtk` python package.
+
+- `vistools.pyvista`: Utility functions for PvVista, depends on `vistools.vtk`.
+
+## Installation
+
+VisTools is available via `pip` and can be installed with
+```bash
+# Install only vistools.vtk
+pip install vistools
+# Install all modules
+pip install "vistools[pyvista]"
+```

vistools-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vistools"
+authors = [
+    {name = "Ivo Steinbrecher", email = "ivo.steinbrecher@unibw.de"},
+]
+description = "Utility functionality for vtk and pyvista"
+dependencies = [
+    "numpy",
+    "scipy",
+    "vtk"
+]
+version = "0.1.0"
+
+[project.urls]
+Repository = "https://github.com/isteinbrecher/vtktools/"
+Issues = "https://github.com/isteinbrecher/vtktools/issues/"
+
+[project.optional-dependencies]
+pyvista = [
+  "pyvista<0.45.0",
+  "opencv-python"
+]
+dev = [
+  "pre-commit",
+  "pytest",
+  "pytest-cov"
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-p pytest_cov --cov-report=term --cov-report=html --cov=src/"

vistools-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vistools-0.1.0/src/vistools/__init__.py

@@ -0,0 +1,22 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2023-2025 Ivo Steinbrecher
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""Define the main namespace of vistools."""

vistools-0.1.0/src/vistools/pyvista/__init__.py

@@ -0,0 +1,24 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2023-2025 Ivo Steinbrecher
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""Define the main namespace of pvtools."""
+
+from vistools.pyvista.sort_grid import sort_grid

vistools-0.1.0/src/vistools/pyvista/camera.py

@@ -0,0 +1,48 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2023-2025 Ivo Steinbrecher
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""Camera functionality for pyvista."""
+
+
+def get_camera_settings(camera):
+    names = [
+        "clipping_range",
+        "distance",
+        "elevation",
+        "focal_point",
+        "model_transform_matrix",
+        "parallel_projection",
+        "parallel_scale",
+        "position",
+        "roll",
+        "thickness",
+        "up",
+        "view_angle",
+    ]
+    camera_settings = {}
+    for name in names:
+        camera_settings[name] = getattr(camera, name)
+    return camera_settings
+
+
+def set_camera_settings(camera, settings):
+    for name, value in settings.items():
+        setattr(camera, name, value)

vistools-0.1.0/src/vistools/pyvista/polyline_cross_section.py

@@ -0,0 +1,86 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2023-2025 Ivo Steinbrecher
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""Extrude a profile along a polyline."""
+
+import pyvista as pv
+
+from vistools.vtk.polyline_cross_section import (
+    polyline_cross_section as vtk_polyline_cross_section,
+)
+
+
+def polyline_cross_section(
+    grid: pv.PolyData,
+    cross_section_points,
+    *,
+    closed: bool = True,
+    separate_surfaces: bool = False,
+) -> pv.UnstructuredGrid:
+    """Extrude a profile defined by the cross section coordinates along a
+    polyline.
+
+    This function calls the vtk version under the hood, but adds some additional
+    functionality.
+
+    Args
+    ----
+    grid:
+        Polyline defining the centerline of the extruded structure
+    cross_section_points:
+        In-cross-section coordinates defining the profile
+    closed:
+        Flag if the profile is open or closed
+    separate_surfaces:
+        Per default all surface cells for a single polyline extrusion are connected.
+        If this is true, then the connectivity of the returned surfaces is modified.
+        The polygons at the start and end (for closed==True) will not be connected to
+        the rest. For the extruded surfaces, each segment between two points in
+        cross_section_points will be extruded along the centerline and not be connected
+        to the bounding surfaces. This can be useful if sharp edges should be shown in
+        the visualization.
+    """
+
+    cross_section_grid = pv.UnstructuredGrid(
+        vtk_polyline_cross_section(grid, cross_section_points, closed=closed)
+    )
+
+    if not separate_surfaces:
+        return cross_section_grid
+    else:
+        surface_ids = cross_section_grid.celltypes != pv.CellType.POLYGON
+        grid_surfaces = cross_section_grid.extract_cells(surface_ids)
+        if closed:
+            n_surfaces = len(cross_section_points)
+        else:
+            n_surfaces = len(cross_section_points) - 1
+        n_cells = grid_surfaces.n_cells
+        surfaces = [
+            grid_surfaces.extract_cells(range(i_start, n_cells, n_surfaces))
+            for i_start in range(n_surfaces)
+        ]
+
+        if closed:
+            bound_ids = cross_section_grid.celltypes == pv.CellType.POLYGON
+            grid_bound = cross_section_grid.extract_cells(bound_ids)
+            surfaces.append(grid_bound)
+
+        return pv.merge(surfaces, merge_points=False)

vistools-0.1.0/src/vistools/pyvista/scalar_bar_to_tikz.py

@@ -0,0 +1,241 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2023-2025 Ivo Steinbrecher
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""Create a screenshot and the TikZ code to create the scalar bar."""
+
+import os
+from pathlib import Path
+
+import cv2
+import pyvista as pv
+
+# Inch to centimeter conversion
+INCH = 2.54
+
+
+def _dots_to_inch(pt, dpi):
+    """Convert a distance in pt to cm."""
+    return float(pt) / dpi * INCH
+
+
+def _hide_scalar_bar(scalar_bar):
+    """Hide the scalar bar and return the data needed to reset it."""
+    data = {"title": scalar_bar.GetTitle()}
+    scalar_bar.SetTitle("")
+    scalar_bar.DrawTickLabelsOff()
+    return data
+
+
+def _show_scalar_bar(scalar_bar, data):
+    """Show the scalar bar and reset the options."""
+    scalar_bar.SetTitle(data["title"])
+    scalar_bar.DrawTickLabelsOn()
+
+
+def _get_scalar_bar_rectangles(scalar_bars, image_pixel_data, dpi):
+    """Get the position of the TikZ color bars.
+
+    We return the distance in cm where the scalar bar starts and the width
+    and the height:
+        [pos_x, pos_y, width, heighth]
+
+    For now we do this with image detection, but this could also be done by
+    directly interpreting the data from the scalar bar. There seems to be a
+    bug in pyvista such that the width of the scalar bar needs to be scaled
+    with 1/INCH.
+    """
+
+    shape = image_pixel_data.shape
+
+    # Convert to grayscale
+    gray = cv2.cvtColor(image_pixel_data, cv2.COLOR_RGB2GRAY)
+
+    # Apply edge detection
+    edges = cv2.Canny(gray, threshold1=50, threshold2=150)
+
+    # Find external contours
+    contours, _ = cv2.findContours(edges, cv2.RETR_EXTERNAL, cv2.CHAIN_APPROX_SIMPLE)
+
+    rectangles = []
+
+    for contour in contours:
+        # Approximate contour to polygon
+        epsilon = 0.02 * cv2.arcLength(contour, True)
+        approx = cv2.approxPolyDP(contour, epsilon, True)
+
+        # Check for 4 corners and convexity
+        if len(approx) == 4 and cv2.isContourConvex(approx):
+            x, y, w, h = cv2.boundingRect(approx)
+            rectangle_pixel = [x, shape[0] - y - h + 1, w, h - 1]
+            rectangles.append([_dots_to_inch(val, dpi) for val in rectangle_pixel])
+
+    return rectangles
+
+
+def _get_tikz_data(scalar_bar):
+    """Return the data required for TikZ for this scalar bar."""
+
+    data = {}
+
+    min_max = list(scalar_bar.GetLookupTable().GetRange())
+    data["min_max"] = min_max
+
+    ticks = []
+    ticks.extend(min_max)
+    ticks.sort()
+    data["ticks"] = ticks
+
+    data["title"] = scalar_bar.GetTitle()
+
+    data["orientation"] = "v" if scalar_bar.GetOrientation() else "h"
+
+    return data
+
+
+def _get_tikz_string_continuous(rectangle, data, number_format):
+    """Get the TikZ code for a continuous color bar."""
+
+    # Add the code that is valid for all types of labels.
+    tikz_code = [
+        "\\begin{axis}[",
+        "scale only axis,",
+        "scaled x ticks=false,",
+        "scaled y ticks=false,",
+        f"at={{({rectangle[0]}cm,{rectangle[1]}cm)}},",
+        "tick label style={font=\\footnotesize},",
+        f"title={data['title']},",
+        f"xticklabel={number_format},",
+        f"yticklabel={number_format},",
+        f"xmin={data['min_max'][0]},",
+        f"xmax={data['min_max'][1]},",
+        f"ymin={data['min_max'][0]},",
+        f"ymax={data['min_max'][1]},",
+        f"width={rectangle[2]}cm,",
+        f"height={rectangle[3]}cm,",
+    ]
+
+    ticks_string = ",".join(map(str, data["ticks"]))
+
+    if data["orientation"] == "v":
+        tikz_code += [
+            "xtick=\\empty,",
+            f"ytick={{{ticks_string}}},",
+            "ytick pos=right,",
+            "ytick align=outside,",
+        ]
+    elif data["orientation"] == "h":
+        raise ValueError("For horizontal orientation the rectangles are wrong!")
+        tikz_code += [
+            "ytick=\\empty,",
+            f"xtick={{{ticks_string}}},",
+            "xtick pos=right,",
+            "xtick align=outside,",
+            "title style={{yshift=10pt,}},",
+        ]
+    else:
+        raise ValueError("Got unexpected value for orientation")
+
+    tikz_code += ["]", "\\end{axis}"]
+    return tikz_code
+
+
+def export_to_tikz(
+    name_or_path: Path,
+    plotter: pv.Plotter,
+    *,
+    dpi: int = 300,
+    figure_path: str = "",
+    number_format: str = "{$\\pgfmathprintnumber[sci,precision=1,sci generic={mantissa sep=,exponent={\\mathrm{e}{##1}}}]{\\tick}$}",
+    is_testing: bool = True,
+):
+    """Export a screenshot and also export TikZ code that overlays a TikZ
+    scalar bar.
+
+    We export the image with the raw scalar bar, i.e., no labels, ticks, title, etc..
+    We also export TikZ code that can import this image and overlay a TikZ scalar bar
+    such that the numbering of the scalar bar can be done directly within LaTeX.
+
+    Args:
+        name_or_path: Name of the output files. Can include directory paths.
+        plotter: Pyvista plotter
+        dpi: Desired resolution of image in dots per inch.
+        figure_path: Relative path to figures in the TeX document structure. Default is empty.
+        number_format: Number format to be used for the TeX ticks.
+    """
+
+    # Name of image and TikZ file.
+    path_to_name = Path(name_or_path)
+    base_dir = path_to_name.parent
+    name = path_to_name.name
+    image_name = name + ".png"
+    image_path = base_dir / image_name
+    tikz_path = base_dir / (name + ".tex")
+
+    # Get all scalar bars in the plotter
+    scalar_bars = [plotter.scalar_bars[key] for key in list(plotter.scalar_bars.keys())]
+
+    # Hide the stuff we don't want in the image
+    original_data = [_hide_scalar_bar(scalar_bar) for scalar_bar in scalar_bars]
+
+    # Save the screenshot
+    if not is_testing:
+        image_pixel_data = plotter.screenshot(image_path)
+    else:
+        image_pixel_data = plotter.screenshot(None, return_img=True)
+
+    # Reset the scalar bar properties
+    for scalar_bar, data in zip(scalar_bars, original_data):
+        _show_scalar_bar(scalar_bar, data)
+
+    # Set the header of te TikZ code
+    tikz_code = [
+        "%% This file was created with vtktools",
+        "%% Use the following includes in the LaTeX header:",
+        "%\\usepackage{tikz}",
+        "%\\usepackage{pgfplots}",
+        "%% Optional:",
+        "%\\pgfplotsset{compat=1.16}",
+        "%\\normalsize % Sometimes in figure environments a smaller font is selected -> uncomment this to activate the default font size",
+        "\\begin{tikzpicture}",
+        "% The -0.2pt here are needed, so the image is really placed at the origin.",
+        f"\\node[anchor=south west,inner sep=-0.2pt] (image) at (0,0) {{\\includegraphics[scale={72.0 / dpi}]{{{os.path.join(figure_path, image_name)}}}}};",
+    ]
+
+    # Get the positions of the scalar bar
+    rectangles = _get_scalar_bar_rectangles(scalar_bars, image_pixel_data, dpi)
+
+    # Get the data we need for the TikZ plot from the scalar bar
+    tikz_data_list = [_get_tikz_data(scalar_bar) for scalar_bar in scalar_bars]
+
+    # For now this only works for 1 rectangle
+    if not len(rectangles) == 1 or not len(tikz_data_list) == 1:
+        raise ValueError("This function currently only works for 1 rectangle")
+
+    # Add the TikZ code for each color bar
+    for rectangle, data in zip(rectangles, tikz_data_list):
+        tikz_code.extend(_get_tikz_string_continuous(rectangle, data, number_format))
+
+    # Finalize the TikZ code
+    tikz_code.append("\\end{tikzpicture}%\n%}%")
+
+    # Write TikZ code to file.
+    with open(tikz_path, "w") as text_file:
+        text_file.write("\n".join(tikz_code))