[
{
"path": ".github/dependabot.yml",
"content": "version: 2\nupdates:\n- package-ecosystem: pip\n directory: /\n insecure-external-code-execution: allow\n schedule:\n interval: monthly\n open-pull-requests-limit: 100\n labels:\n - maintenance\n - dependencies\n groups:\n pip:\n patterns:\n - '*'\n- package-ecosystem: github-actions\n directory: /\n schedule:\n interval: monthly\n open-pull-requests-limit: 100\n labels:\n - maintenance\n - dependencies\n groups:\n actions:\n patterns:\n - '*'\n"
},
{
"path": ".github/workflows/testing-and-deployment.yml",
"content": "name: Build\n\non:\n pull_request:\n push:\n tags:\n - v*\n branches:\n - main\n\n# disable concurrent runs\nconcurrency:\n group: ${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: true\n\njobs:\n # fail fast and early to avoid clogging GH Actions\n smoke_testing:\n runs-on: ubuntu-latest\n name: Source distribution testing\n steps:\n - uses: actions/checkout@v6\n\n - name: Set up Python\n uses: actions/setup-python@v6\n with:\n python-version: '3.13'\n\n - name: Setup headless display\n uses: pyvista/setup-headless-display-action@v4\n\n - name: Build and validate wheel\n run: |\n pip install build twine\n python -m build\n twine check dist/*\n\n - name: Install\n run: pip install dist/*.whl\n\n - name: Test\n run: |\n pip install -r requirements_test.txt\n cd tests && python -m pytest -v\n\n - name: Upload sdist\n uses: actions/upload-artifact@v7\n with:\n path: ./dist/*.tar.gz\n name: fast-simplification-sdist\n\n docs_build:\n name: Build Documentation\n runs-on: ubuntu-latest\n needs: smoke_testing\n\n steps:\n - uses: actions/checkout@v6\n\n - name: Setup Python\n uses: actions/setup-python@v6\n with:\n python-version: '3.13'\n\n - name: Setup headless display\n uses: pyvista/setup-headless-display-action@v4\n\n - name: Install library\n run: pip install .\n\n - name: Build Documentation\n run: |\n pip install -r requirements_docs.txt\n make -C doc html\n\n - name: Deploy on tag\n uses: JamesIves/github-pages-deploy-action@v4\n if: startsWith(github.ref, 'refs/tags/')\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n branch: gh-pages\n folder: doc/_build/html\n\n build_wheels:\n needs: smoke_testing\n name: Build wheels on ${{ matrix.os }}\n runs-on: ${{ matrix.os }}\n strategy:\n fail-fast: false\n matrix:\n os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, macos-latest, macos-15-intel]\n\n steps:\n - uses: actions/checkout@v6\n\n - name: Build wheels\n uses: pypa/cibuildwheel@v3.4.0\n\n - name: List generated wheels\n run: ls ./wheelhouse/*\n\n - uses: actions/upload-artifact@v7\n with:\n path: ./wheelhouse/*.whl\n name: fast-simplification-wheel-${{ matrix.os }}\n\n release:\n name: Release\n if: github.event_name == 'push' && contains(github.ref, 'refs/tags')\n needs: [build_wheels, docs_build]\n runs-on: ubuntu-latest\n environment:\n name: pypi\n url: https://pypi.org/p/fast-simplification\n permissions:\n id-token: write # this permission is mandatory for trusted publishing\n contents: write # required to create a release\n steps:\n - uses: actions/download-artifact@v8\n - name: Flatten directory structure\n run: |\n mkdir -p dist/\n find . -name '*.whl' -exec mv {} dist/ \\;\n find . -name '*.tar.gz' -exec mv {} dist/ \\;\n - name: Publish package distributions to PyPI\n uses: pypa/gh-action-pypi-publish@release/v1\n - name: Create GitHub Release\n uses: softprops/action-gh-release@v2\n with:\n generate_release_notes: true\n files: |\n ./**/*.whl\n"
},
{
"path": ".gitignore",
"content": "# Compiled source #\n###################\n*.pyc\n*.pyd\n*.so\n*.o\n__pycache__/\n\n# Pip\n*.egg-info\n\n# Cython generated files #\nfast_simplification/_simplify.cpp\nfast_simplification/_replay.cpp\n\n# documentation\ndoc/_build/\ndoc/examples/\ndoc/_autosummary/\n\ndist/\nvenv/\nbuild/\n\n# IDE\n.vscode/"
},
{
"path": ".pre-commit-config.yaml",
"content": "# Integration with GitHub Actions\n# See https://pre-commit.ci/\nci:\n autoupdate_schedule: monthly\n\nrepos:\n- repo: https://github.com/astral-sh/ruff-pre-commit\n rev: v0.15.9\n hooks:\n - id: ruff\n args: [--fix, --exit-non-zero-on-fix]\n exclude: ^(docs/|tests)\n - id: ruff-format\n\n- repo: https://github.com/pycqa/isort\n rev: 8.0.1\n hooks:\n - id: isort\n\n- repo: https://github.com/codespell-project/codespell\n rev: v2.4.2\n hooks:\n - id: codespell\n args: [--toml, pyproject.toml]\n additional_dependencies: [tomli]\n\n- repo: https://github.com/keewis/blackdoc\n rev: v0.4.6\n hooks:\n - id: blackdoc\n files: \\.py$\n\n# - repo: https://github.com/pycqa/pydocstyle\n# rev: 6.1.1\n# hooks:\n# - id: pydocstyle\n# additional_dependencies: [toml]\n# exclude: \"tests/\"\n\n- repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v6.0.0\n hooks:\n - id: check-merge-conflict\n - id: debug-statements\n - id: trailing-whitespace\n - id: no-commit-to-branch\n args: [--branch, main]\n - id: requirements-txt-fixer\n\n- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks\n rev: v2.16.0\n hooks:\n - id: pretty-format-toml\n args: [--autofix]\n - id: pretty-format-yaml\n args: [--autofix, --indent, '2']\n\n# this validates our github workflow files\n- repo: https://github.com/python-jsonschema/check-jsonschema\n rev: 0.37.1\n hooks:\n - id: check-github-workflows\n"
},
{
"path": "LICENSE",
"content": "The MIT License\n\nCopyright (c) 2017-2021 The PyVista Developers\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n"
},
{
"path": "MANIFEST.in",
"content": "include fast_simplification/*.h\n"
},
{
"path": "README.rst",
"content": "Python Fast-Quadric-Mesh-Simplification Wrapper\n===============================================\nThis is a python wrapping of the `Fast-Quadric-Mesh-Simplification Library\n`_. Having\narrived at the same problem as the original author, but needing a Python\nlibrary, this project seeks to extend the work of the original library while\nadding integration to Python and the `PyVista\n`_ project.\n\nFor the full documentation visit: https://pyvista.github.io/fast-simplification/\n\n.. image:: https://github.com/pyvista/fast-simplification/raw/main/doc/images/simplify_demo.png\n\nInstallation\n------------\nFast Simplification can be installed from PyPI using pip on Python >= 3.7::\n\n pip install fast-simplification\n\nSee the `Contributing `_ for more details regarding development or if the installation through pip doesn't work out.\n\nBasic Usage\n-----------\nThe basic interface is quite straightforward and can work directly\nwith arrays of points and triangles:\n\n.. code:: python\n\n points = [[ 0.5, -0.5, 0.0],\n [ 0.0, -0.5, 0.0],\n [-0.5, -0.5, 0.0],\n [ 0.5, 0.0, 0.0],\n [ 0.0, 0.0, 0.0],\n [-0.5, 0.0, 0.0],\n [ 0.5, 0.5, 0.0],\n [ 0.0, 0.5, 0.0],\n [-0.5, 0.5, 0.0]]\n\n faces = [[0, 1, 3],\n [4, 3, 1],\n [1, 2, 4],\n [5, 4, 2],\n [3, 4, 6],\n [7, 6, 4],\n [4, 5, 7],\n [8, 7, 5]]\n\n points_out, faces_out = fast_simplification.simplify(points, faces, 0.5)\n\n\nAdvanced Usage\n--------------\nThis library supports direct integration with VTK through PyVista to\nprovide a simplistic interface to the library. As this library\nprovides a 4-5x improvement to the VTK decimation algorithms.\n\n.. code:: python\n\n >>> from pyvista import examples\n >>> mesh = examples.download_nefertiti()\n >>> out = fast_simplification.simplify_mesh(mesh, target_reduction=0.9)\n\n Compare with built-in VTK/PyVista methods:\n\n >>> fas_sim = fast_simplification.simplify_mesh(mesh, target_reduction=0.9)\n >>> dec_std = mesh.decimate(0.9) # vtkQuadricDecimation\n >>> dec_pro = mesh.decimate_pro(0.9) # vtkDecimatePro\n\n >>> pv.set_plot_theme('document')\n >>> pl = pv.Plotter(shape=(2, 2), window_size=(1000, 1000))\n >>> pl.add_text('Original', 'upper_right', color='w')\n >>> pl.add_mesh(mesh, show_edges=True)\n >>> pl.camera_position = cpos\n\n >>> pl.subplot(0, 1)\n >>> pl.add_text(\n ... 'Fast-Quadric-Mesh-Simplification\\n~2.2 seconds', 'upper_right', color='w'\n ... )\n >>> pl.add_mesh(fas_sim, show_edges=True)\n >>> pl.camera_position = cpos\n\n >>> pl.subplot(1, 0)\n >>> pl.add_mesh(dec_std, show_edges=True)\n >>> pl.add_text(\n ... 'vtkQuadricDecimation\\n~9.5 seconds', 'upper_right', color='w'\n ... )\n >>> pl.camera_position = cpos\n\n >>> pl.subplot(1, 1)\n >>> pl.add_mesh(dec_pro, show_edges=True)\n >>> pl.add_text(\n ... 'vtkDecimatePro\\n11.4~ seconds', 'upper_right', color='w'\n ... )\n >>> pl.camera_position = cpos\n >>> pl.show()\n\n\nComparison to other libraries\n-----------------------------\nThe `pyfqmr `_\nlibrary wraps the same header file as this library and has similar capabilities.\nIn this library, the decision was made to write the Cython layer on top of an\nadditional C++ layer rather than directly interfacing with wrapper from Cython.\nThis results in a mild performance improvement.\n\nReusing the example above:\n\n.. code:: python\n\n Set up a timing function.\n\n >>> import pyfqmr\n >>> vertices = mesh.points\n >>> faces = mesh.faces.reshape(-1, 4)[:, 1:]\n >>> def time_pyfqmr():\n ... mesh_simplifier = pyfqmr.Simplify()\n ... mesh_simplifier.setMesh(vertices, faces)\n ... mesh_simplifier.simplify_mesh(\n ... target_count=out.n_faces, aggressiveness=7, verbose=0\n ... )\n ... vertices_out, faces_out, normals_out = mesh_simplifier.getMesh()\n ... return vertices_out, faces_out, normals_out\n\nNow, time it and compare with the non-VTK API of this library:\n\n.. code:: python\n\n >>> timeit time_pyfqmr()\n 2.75 s ± 5.35 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)\n\n >>> timeit vout, fout = fast_simplification.simplify(vertices, faces, 0.9)\n 2.05 s ± 3.18 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)\n\nAdditionally, the ``fast-simplification`` library has direct plugins\nto the ``pyvista`` library, making it easy to read and write meshes:\n\n.. code:: python\n\n >>> import pyvista\n >>> import fast_simplification\n >>> mesh = pyvista.read('my_mesh.stl')\n >>> simple = fast_simplification.simplify_mesh(mesh)\n >>> simple.save('my_simple_mesh.stl')\n\nSince both libraries are based on the same core C++ code, feel free to\nuse whichever gives you the best performance and interoperability.\n\nReplay decimation functionality\n-------------------------------\nThis library also provides an interface to keep track of the successive\ncollapses that occur during the decimation process and to replay the\ndecimation process. This can be useful for different applications, such\nas:\n\n* applying the same decimation to a collection of meshes that share the\n same topology\n* computing a correspondence map between the vertices of the original\n mesh and the vertices of the decimated mesh, to transfer field data from\n one to the other for example\n* replaying the decimation process with a smaller target reduction than\n the original one, faster than decimating the original mesh with the\n smaller target reduction\n\nTo use this functionality, you need to set the ``return_collapses``\nparameter to ``True`` when calling ``simplify``. This will return the\nsuccessive collapses of the decimation process in addition to points\nand faces.\n\n.. code:: python\n\n >>> import fast_simplification\n >>> import pyvista\n >>> mesh = pyvista.Sphere()\n >>> points, faces = mesh.points, mesh.faces.reshape(-1, 4)[:, 1:]\n >>> points_out, faces_out, collapses = fast_simplification.simplify(points, faces, 0.9, return_collapses=True)\n\nNow you can call ``replay_simplification`` to replay the decimation process\nand obtain the mapping between the vertices of the original mesh and the\nvertices of the decimated mesh.\n\n.. code:: python\n\n >>> points_out, faces_out, indice_mapping = fast_simplification.replay_simplification(points, faces, collapses)\n >>> i = 3\n >>> print(f'Vertex {i} of the original mesh is mapped to {indice_mapping[i]} of the decimated mesh')\n\nYou can also use the ``replay_simplification`` function to replay the\ndecimation process with a smaller target reduction than the original one.\nThis is faster than decimating the original mesh with the smaller target\nreduction. To do so, you need to pass a subset of the collapses to the\n``replay_simplification`` function. For example, to replay the decimation\nprocess with a target reduction of 50% the initial rate, you can run:\n\n.. code:: python\n\n >>> import numpy as np\n >>> collapses_half = collapses[:int(0.5 * len(collapses))]\n >>> points_out, faces_out, indice_mapping = fast_simplification.replay_simplification(points, faces, collapses_half)\n\nIf you have a collection of meshes that share the same topology, you can\napply the same decimation to all of them by calling ``replay_simplification``\nwith the same collapses for each mesh. This ensure that the decimated meshes\nwill share the same topology.\n\n.. code:: python\n\n >>> import numpy as np\n >>> # Assume that you have a collection of meshes stored in a list meshes\n >>> _, _, collapses = fast_simplification.simplify(meshes[0].points, meshes[0].faces,\n ... 0.9, return_collapses=True)\n >>> decimated_meshes = []\n >>> for mesh in meshes:\n ... points_out, faces_out, _ = fast_simplification.replay_simplification(mesh.points, mesh.faces, collapses)\n ... decimated_meshes.append(pyvista.PolyData(points_out, faces_out))\n\nContributing\n------------\nContribute to this repository by forking this repository and installing in\ndevelopment mode with::\n\n git clone https://github.com//fast-simplification\n pip install -e .\n pip install -r requirements_test.txt\n\nYou can then add your feature or commit your bug fix and then run your unit\ntesting with::\n\n pytest\n\nUnit testing will automatically enforce minimum code coverage standards.\n\nNext, to ensure your code meets minimum code styling standards, run::\n\n pip install pre-commit\n pre-commit run --all-files\n\nFinally, `create a pull request`_ from your fork and I'll be sure to review it.\n\n.. _create a pull request: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request\n"
},
{
"path": "doc/Makefile",
"content": "# Minimal makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nSPHINXPROJ = pymeshfix\nSOURCEDIR = .\nBUILDDIR = _build\n\n# Put it first so that \"make\" without argument is like \"make help\".\nhelp:\n\t@$(SPHINXBUILD) -M help \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n.PHONY: help Makefile\n\n# Catch-all target: route all unknown targets to Sphinx using the new\n# \"make mode\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\n%: Makefile\n\t@$(SPHINXBUILD) -M $@ \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\nclean:\n\trm -rf $(BUILDDIR)/*\n\trm -rf examples/\n\tfind . -type d -name \"_autosummary\" -exec rm -rf {} +\n"
},
{
"path": "doc/_templates/autosummary/class.rst",
"content": "{{ fullname | escape | underline}}\n\n.. currentmodule:: {{ module }}\n\n.. autoclass:: {{ objname }}\n\n {% block methods %}\n\n {% if methods %}\n .. rubric:: {{ _('Methods') }}\n\n .. autosummary::\n :toctree:\n {% for item in methods %}\n {% if item != \"__init__\" %}\n {{ name }}.{{ item }}\n {% endif %}\n {%- endfor %}\n {% endif %}\n {% endblock %}\n\n {% block attributes %}\n {% if attributes %}\n .. rubric:: {{ _('Attributes') }}\n\n .. autosummary::\n :toctree:\n {% for item in attributes %}\n {% if item.0 != item.upper().0 %}\n {{ name }}.{{ item }}\n {% endif %}\n {%- endfor %}\n {% endif %}\n {% endblock %}\n"
},
{
"path": "doc/api.rst",
"content": "API Reference\n=============\nThese are the three public methods that expose the fast-simplification API to\nPython.\n\n.. currentmodule:: fast_simplification\n\n.. autosummary::\n :toctree: _autosummary\n\n simplify\n simplify_mesh\n replay_simplification\n"
},
{
"path": "doc/conf.py",
"content": "import datetime\nimport os\n\nimport numpy as np\nimport pyvista\nfrom sphinx_gallery.sorting import FileNameSortKey\n\nfrom fast_simplification import __version__\n\n# Manage errors\npyvista.set_error_output_file(\"errors.txt\")\n# Ensure that offscreen rendering is used for docs generation\npyvista.OFF_SCREEN = True # Not necessary - simply an insurance policy\n# Preferred plotting style for documentation\npyvista.set_plot_theme(\"document\")\npyvista.global_theme.window_size = np.array([1024, 768]) * 2\n# Save figures in specified directory\npyvista.FIGURE_PATH = os.path.abspath(\"./images/\")\nif not os.path.exists(pyvista.FIGURE_PATH):\n os.makedirs(pyvista.FIGURE_PATH)\n\npyvista.BUILDING_GALLERY = True\n\n# -- Project information -----------------------------------------------------\n\nproject = \"fast-simplification\"\nyear = datetime.date.today().year\ncopyright = f\"2017-{year}, The PyVista Developers\"\nauthor = \"Alex Kaszynski\"\n\n# The short X.Y version\nversion = release = __version__\n\n# -- General configuration ---------------------------------------------------\nhtml_logo = \"./_static/pyvista_logo_sm.png\"\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#\n# needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n \"sphinx.ext.autodoc\",\n \"sphinx.ext.napoleon\",\n # 'sphinx.ext.doctest',\n \"sphinx.ext.autosummary\",\n \"notfound.extension\",\n \"sphinx_copybutton\",\n \"sphinx_gallery.gen_gallery\",\n \"sphinx.ext.extlinks\",\n \"numpydoc\",\n]\n\nnumpydoc_show_class_members = False\n# numpydoc_class_members_toctree = False\nhtml_static_path = [\"_static\"]\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = [\"_templates\"]\n\n# The suffix(es) of source filenames.\n# You can specify multiple suffix as a list of string:\n#\n# source_suffix = ['.rst', '.md']\nsource_suffix = \".rst\"\n\n# The master toctree document.\nmaster_doc = \"index\"\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#\n# This is also used if you do content translation via gettext catalogs.\n# Usually you set \"language\" from the command line for these cases.\nlanguage = None\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\n# This pattern also affects html_static_path and html_extra_path .\nexclude_patterns = []\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = \"sphinx\"\n\n# Copy button customization ---------------------------------------------------\n# exclude traditional Python prompts from the copied code\ncopybutton_prompt_text = r\">>> ?|\\.\\.\\. \"\ncopybutton_prompt_is_regexp = True\n\n\n# -- Options for HTML output -------------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\n#\nhtml_theme = \"pydata_sphinx_theme\"\nhtml_context = {\n # Enable the \"Edit in GitHub link within the header of each page.\n \"display_github\": True,\n \"github_user\": \"pyvista\",\n \"github_repo\": \"fast-simplification\",\n \"github_version\": \"master\",\n \"menu_links_name\": \"Getting Connected\",\n \"menu_links\": [\n (\n ' Slack Community',\n \"http://slack.pyvista.org\",\n ),\n (\n ' Support',\n \"https://github.com/pyvista/pyvista-support\",\n ),\n (\n ' Source Code',\n \"https://github.com/pyvista/pymeshfix\",\n ),\n ],\n}\n\nhtml_theme_options = {\n \"show_prev_next\": False,\n \"github_url\": \"https://github.com/pyvista/pymeshfix\",\n}\n\n\n# -- Options for HTMLHelp output ---------------------------------------------\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = \"PyMeshFix\"\n\n\n# -- Options for LaTeX output ------------------------------------------------\n\nlatex_elements = {}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n (\n master_doc,\n \"pymeshfix.tex\",\n \"PyMeshFix Documentation\",\n \"Alex Kaszynski\",\n \"manual\",\n ),\n]\n\n\n# -- Options for manual page output ------------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [(master_doc, \"PyMeshFix\", \"PyMeshFix Documentation\", [author], 1)]\n\n\n# -- Options for Texinfo output ----------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n (\n master_doc,\n \"PyMeshFix\",\n \"PyMeshFix Documentation\",\n author,\n \"PyMeshFix\",\n \"One line description of project.\",\n \"Miscellaneous\",\n ),\n]\n\n\n# -- Extension configuration -------------------------------------------------\n\n# -- Options for intersphinx extension ---------------------------------------\n\n# Example configuration for intersphinx: refer to the Python standard library.\nintersphinx_mapping = {\n \"https://docs.python.org/\": None,\n \"https://docs.pyvista.org\": None,\n}\n\n# -- Options for todo extension ----------------------------------------------\n\n# If true, `todo` and `todoList` produce output, else they produce nothing.\ntodo_include_todos = True\n\n\n# -- Sphinx Gallery Options\nsphinx_gallery_conf = {\n # path to your examples scripts\n \"examples_dirs\": [\n \"../examples/\",\n ],\n # path where to save gallery generated examples\n \"gallery_dirs\": [\"examples\"],\n # pattern to search for example files\n \"filename_pattern\": r\"\\.py\",\n # Remove the \"Download all examples\" button from the top level gallery\n \"download_all_examples\": False,\n # Sort gallery example by file name instead of number of lines (default)\n \"within_subsection_order\": FileNameSortKey,\n # directory where function granular galleries are stored\n \"backreferences_dir\": None,\n # Modules for which function level galleries are created. In\n \"doc_module\": \"pymeshfix\",\n \"image_scrapers\": (pyvista.Scraper(), \"matplotlib\"),\n \"thumbnail_size\": (350, 350),\n}\n\n\n# -- Custom 404 page\n\nnotfound_no_urls_prefix = True\n"
},
{
"path": "doc/index.rst",
"content": ".. include:: ../README.rst\n\n\n.. toctree::\n :hidden:\n\n self\n\n\n\n.. toctree::\n :maxdepth: 2\n :caption: Examples\n :hidden:\n\n examples/index\n\n\n\n.. toctree::\n :maxdepth: 2\n :caption: API Reference\n :hidden:\n\n api\n"
},
{
"path": "examples/README.txt",
"content": "Fast-simplification Examples\n============================\nThe following examples demonstrate ``fast-simplification``\nfunctionality using `pyvista `__.\n"
},
{
"path": "examples/replay.py",
"content": "\"\"\"\nReplay Decimation\n-----------------\n\nThis example shows how to replay a decimation sequence with replay.\n\n\"\"\"\n\nfrom time import time\n\nimport numpy as np\nimport pyvista as pv\nfrom pyvista import examples\n\nimport fast_simplification\n\n\n# Ancillary function to convert triangles to padded faces\ndef triangles_to_faces(triangles):\n tmp = 3 * np.ones((len(triangles), 4), dtype=triangles.dtype)\n tmp[:, 1:] = triangles\n return tmp.copy().reshape(-1)\n\n\n# mesh = examples.download_cow().triangulate().clean()\n\n# cpos = [(12.81184076782852, 0.2698100334791761, -10.82840852844307),\n# (-5.767085129340097, -0.45822321783537723, 6.935179459234972),\n# (-0.031039486276564762, 0.99948202301343, 0.008499174352116386)]\n\n\n# load an example mesh\nmesh = examples.download_louis_louvre()\n\n# nice camera angle\ncpos = [\n (5.428820015861438, -10.151721995577468, 15.902198956656623),\n (1.4405146331169636, 2.897371104075222, 10.951469667556948),\n (-0.01001925846458282, 0.3520252491158569, 0.9359368773826251),\n]\n\npoints = mesh.points\ntriangles = mesh.faces.reshape(-1, 4)[:, 1:]\n\n\n# Decimate the mesh with fast_simplification\n# and record the collapses\nstart = time()\ndec_points, dec_triangles, collapses = fast_simplification.simplify(\n points, triangles, 0.995, return_collapses=True\n)\ntime_simplify = time() - start\n\n# Replay the decimation sequence and record the mapping between\n# the original points and the decimated points\nstart = time()\n(\n dec_points_replay,\n dec_triangles_replay,\n indice_mapping_replay,\n) = fast_simplification.replay_simplification(\n points=points,\n triangles=triangles,\n collapses=collapses,\n)\ntime_replay_new = time() - start\n\n# Partially replay the decimation sequence (90% of the collapses are replayed)\npartial_collapses = collapses[0 : int(0.9 * len(collapses))]\nstart = time()\n(\n dec_points_replay2,\n dec_triangles_replay2,\n indice_mapping_replay2,\n) = fast_simplification.replay_simplification(\n points=points, triangles=triangles, collapses=partial_collapses\n)\ntime_replay_new = time() - start\n\n# Randomly select two points on the original mesh\nnp.random.seed(1)\ni, j = np.random.randint(0, len(mesh.points), 2)\n\n# Map the indices of the original points to the indices of the decimated points\nm_i = indice_mapping_replay[i]\nm_j = indice_mapping_replay[j]\nm_i2 = indice_mapping_replay2[i]\nm_j2 = indice_mapping_replay2[j]\n\np = pv.Plotter(shape=(2, 2), theme=pv.themes.DocumentTheme())\n\np.subplot(0, 0)\n# Plot the original mesh with the two highlighted points\np.add_mesh(mesh, show_edges=True, color=\"tan\")\np.add_points(mesh.points[i], color=\"red\", point_size=10, render_points_as_spheres=True)\np.add_points(mesh.points[j], color=\"blue\", point_size=10, render_points_as_spheres=True)\np.add_text(\n f\"Original mesh, {mesh.points.shape[0]} vertices, {triangles.shape[0]} triangles\",\n font_size=10,\n)\np.camera_position = cpos\n\np.subplot(0, 1)\n# Plot the decimated mesh\np.add_mesh(\n pv.PolyData(dec_points, faces=triangles_to_faces(dec_triangles)),\n show_edges=True,\n color=\"tan\",\n)\np.add_text(\n f\"Decimated mesh, {dec_points.shape[0]} vertices, {dec_triangles.shape[0]} triangles, took {time_simplify:.2f}s\",\n font_size=10,\n)\np.camera_position = cpos\n\np.subplot(1, 0)\n# Plot the mesh decimated with replay with the two highlighted points\np.add_mesh(\n pv.PolyData(dec_points_replay, faces=triangles_to_faces(dec_triangles_replay)),\n show_edges=True,\n color=\"tan\",\n)\np.add_points(\n dec_points_replay[m_i],\n color=\"red\",\n point_size=10,\n render_points_as_spheres=True,\n)\np.add_points(\n dec_points_replay[m_j],\n color=\"blue\",\n point_size=10,\n render_points_as_spheres=True,\n)\nn_points, n_triangles = dec_points_replay.shape[0], dec_triangles_replay.shape[0]\np.add_text(\n f\"Replay, {n_points} vertices, {n_triangles} triangles, took {time_replay_new:.2f}s\",\n font_size=10,\n)\np.camera_position = cpos\n\np.subplot(1, 1)\n# Plot the mesh partially decimated with replay with the two highlighted points\np.add_mesh(\n pv.PolyData(dec_points_replay2, faces=triangles_to_faces(dec_triangles_replay2)),\n show_edges=True,\n color=\"tan\",\n)\np.add_points(\n dec_points_replay2[m_i2],\n color=\"red\",\n point_size=10,\n render_points_as_spheres=True,\n)\np.add_points(\n dec_points_replay2[m_j2],\n color=\"blue\",\n point_size=10,\n render_points_as_spheres=True,\n)\nn_points, n_triangles = dec_points_replay2.shape[0], dec_triangles_replay2.shape[0]\np.add_text(\n f\"Partial replay, {n_points} vertices, {n_triangles} triangles, took {time_replay_new:.2f}s\",\n font_size=10,\n)\np.camera_position = cpos\n\np.show()\n"
},
{
"path": "examples/simplify.py",
"content": "\"\"\"\nCompare Decimation Methods\n--------------------------\n\nThis example compares various decimation methods\n\n\"\"\"\n\nimport time\n\nimport pyvista as pv\nfrom pyvista import examples\n\nimport fast_simplification\n\n# load an example mesh\nmesh = examples.download_louis_louvre()\n\n# nice camera angle\ncpos = [\n (6.264157141857314, -6.959267635766402, 11.71668951132694),\n (1.3291685457683413, 2.267162128740896, 12.263240938610595),\n (0.0023825740958850136, -0.05786378450796799, 0.9983216444528751),\n]\n\n\n###############################################################################\n# Compare decimation times\nreduction = 0.9\nprint(\"Approach Time Elapsed\")\n\ntstart = time.time()\nfas_sim = fast_simplification.simplify_mesh(mesh, target_reduction=reduction)\nfast_sim_time = time.time() - tstart\nprint(f\"Fast Quadratic Simplification {fast_sim_time:8.4f} seconds\")\n\ntstart = time.time()\ndec_std = mesh.decimate(reduction)\ndec_std_time = time.time() - tstart\nprint(f\"vtkQuadricDecimation {dec_std_time:8.4f} seconds\")\n\ntstart = time.time()\ndec_pro = mesh.decimate_pro(reduction)\ndec_pro_time = time.time() - tstart\nprint(f\"vtkDecimatePro {dec_pro_time:8.4f} seconds\")\n\n\npl = pv.Plotter(shape=(2, 2), window_size=(1000, 1000), theme=pv.themes.DocumentTheme())\npl.add_text(\"Original\", \"upper_right\", color=\"k\")\npl.add_mesh(mesh, show_edges=True)\npl.camera_position = cpos\n\npl.subplot(0, 1)\npl.add_text(\n f\"Fast-Quadric-Mesh-Simplification\\n{fast_sim_time:8.4f} seconds\",\n \"upper_right\",\n color=\"k\",\n)\npl.add_mesh(fas_sim, show_edges=True)\npl.camera_position = cpos\n\npl.subplot(1, 0)\npl.add_mesh(dec_std, show_edges=True)\npl.add_text(f\"vtkQuadricDecimation\\n{dec_std_time:8.4f} seconds\", \"upper_right\", color=\"k\")\npl.camera_position = cpos\n\npl.subplot(1, 1)\npl.add_mesh(dec_pro, show_edges=True)\npl.add_text(f\"vtkDecimatePro\\n{dec_pro_time:8.4f} seconds\", \"upper_right\", color=\"k\")\npl.camera_position = cpos\n\npl.show()\n"
},
{
"path": "fast_simplification/Replay.h",
"content": "#include \"Simplify.h\"\n\nnamespace Replay{\n\n // Global Variables & Structures (same as for Simplify)\n\tenum Attributes {\n\t\tNONE,\n\t\tNORMAL = 2,\n\t\tTEXCOORD = 4,\n\t\tCOLOR = 8\n\t};\n\tstruct Triangle { int v[3];double err[4];int deleted,dirty,attr;vec3f n;vec3f uvs[3];int material; };\n\tstruct Vertex { vec3f p;int tstart,tcount;SymetricMatrix q;int border;};\n\tstruct Ref { int tid,tvertex; };\n\tstd::vector triangles;\n\tstd::vector vertices;\n\tstd::vector[ refs;\n std::string mtllib;\n std::vector materials;\n std::vector> collapses;\n\n // Helper functions\n double vertex_error(SymetricMatrix q, double x, double y, double z);\n\tdouble calculate_error(int id_v1, int id_v2, vec3f &p_result);\n void initialize_quadrics();\n\n\n void replay_simplification()\n {\n \t// init\n\t\tfor(int i=0; i vcount,vids;\n\n\t\tloopi(0,vertices.size())\n\t\t\t\tvertices[i].border=0;\n\n\t\t\tloopi(0,vertices.size())\n\t\t\t{\n\t\t\t\tVertex &v=vertices[i];\n\t\t\t\tvcount.clear();\n\t\t\t\tvids.clear();\n\t\t\t\tloopj(0,v.tcount)\n\t\t\t\t{\n\t\t\t\t\tint k=refs[v.tstart+j].tid;\n\t\t\t\t\tTriangle &t=triangles[k];\n\t\t\t\t\tloopk(0,3)\n\t\t\t\t\t{\n\t\t\t\t\t\tint ofs=0,id=t.v[k];\n\t\t\t\t\t\twhile(ofs try to find best result\n\t\t\tvec3f p1=vertices[id_v1].p;\n\t\t\tvec3f p2=vertices[id_v2].p;\n\t\t\tvec3f p3=(p1+p2)/2;\n\t\t\tdouble error1 = vertex_error(q, p1.x,p1.y,p1.z);\n\t\t\tdouble error2 = vertex_error(q, p2.x,p2.y,p2.z);\n\t\t\tdouble error3 = vertex_error(q, p3.x,p3.y,p3.z);\n\t\t\terror = min(error1, min(error2, error3));\n\t\t\tif (error1 == error) p_result=p1;\n\t\t\tif (error2 == error) p_result=p2;\n\t\t\tif (error3 == error) p_result=p3;\n\t\t}\n\t\treturn error;\n\t}\n\n\tchar *trimwhitespace(char *str)\n\t{\n\t\tchar *end;\n\n\t\t// Trim leading space\n\t\twhile(isspace((unsigned char)*str)) str++;\n\n\t\tif(*str == 0) // All spaces?\n\t\treturn str;\n\n\t\t// Trim trailing space\n\t\tend = str + strlen(str) - 1;\n\t\twhile(end > str && isspace((unsigned char)*end)) end--;\n\n\t\t// Write new null terminator\n\t\t*(end+1) = 0;\n\n\t\treturn str;\n\t}\n\n\t//Option : Load OBJ\n\tvoid load_obj(const char* filename, bool process_uv=false){\n\t\tvertices.clear();\n\t\ttriangles.clear();\n\t\t// printf ( \"Loading Objects %s ... \\n\",filename);\n\t\tFILE* fn;\n\t\tif(filename==NULL)\t\treturn ;\n\t\tif((char)filename[0]==0)\treturn ;\n\t\tif ((fn = fopen(filename, \"rb\")) == NULL)\n\t\t{\n\t\t\tprintf ( \"File %s not found!\\n\" ,filename );\n\t\t\treturn;\n\t\t}\n\t\tchar line[1000];\n\t\tmemset ( line,0,1000 );\n\t\tint vertex_cnt = 0;\n\t\tint material = -1;\n\t\tstd::map material_map;\n\t\tstd::vector uvs;\n\t\tstd::vector > uvMap;\n\n\t\twhile(fgets( line, 1000, fn ) != NULL)\n\t\t{\n\t\t\tVertex v;\n\t\t\tvec3f uv;\n\n\t\t\tif (strncmp(line, \"mtllib\", 6) == 0)\n\t\t\t{\n\t\t\t\tmtllib = trimwhitespace(&line[7]);\n\t\t\t}\n\t\t\tif (strncmp(line, \"usemtl\", 6) == 0)\n\t\t\t{\n\t\t\t\tstd::string usemtl = trimwhitespace(&line[7]);\n\t\t\t\tif (material_map.find(usemtl) == material_map.end())\n\t\t\t\t{\n\t\t\t\t\tmaterial_map[usemtl] = materials.size();\n\t\t\t\t\tmaterials.push_back(usemtl);\n\t\t\t\t}\n\t\t\t\tmaterial = material_map[usemtl];\n\t\t\t}\n\n\t\t\tif ( line[0] == 'v' && line[1] == 't' )\n\t\t\t{\n\t\t\t\tif ( line[2] == ' ' )\n\t\t\t\tif(sscanf(line,\"vt %lf %lf\",\n\t\t\t\t\t&uv.x,&uv.y)==2)\n\t\t\t\t{\n\t\t\t\t\tuv.z = 0;\n\t\t\t\t\tuvs.push_back(uv);\n\t\t\t\t} else\n\t\t\t\tif(sscanf(line,\"vt %lf %lf %lf\",\n\t\t\t\t\t&uv.x,&uv.y,&uv.z)==3)\n\t\t\t\t{\n\t\t\t\t\tuvs.push_back(uv);\n\t\t\t\t}\n\t\t\t}\n\t\t\telse if ( line[0] == 'v' )\n\t\t\t{\n\t\t\t\tif ( line[1] == ' ' )\n\t\t\t\tif(sscanf(line,\"v %lf %lf %lf\",\n\t\t\t\t\t&v.p.x,\t&v.p.y,\t&v.p.z)==3)\n\t\t\t\t{\n\t\t\t\t\tvertices.push_back(v);\n\t\t\t\t}\n\t\t\t}\n\t\t\tint integers[9];\n\t\t\tif ( line[0] == 'f' )\n\t\t\t{\n\t\t\t\tTriangle t;\n\t\t\t\tbool tri_ok = false;\n bool has_uv = false;\n\n\t\t\t\tif(sscanf(line,\"f %d %d %d\",\n\t\t\t\t\t&integers[0],&integers[1],&integers[2])==3)\n\t\t\t\t{\n\t\t\t\t\ttri_ok = true;\n\t\t\t\t}else\n\t\t\t\tif(sscanf(line,\"f %d// %d// %d//\",\n\t\t\t\t\t&integers[0],&integers[1],&integers[2])==3)\n\t\t\t\t{\n\t\t\t\t\ttri_ok = true;\n\t\t\t\t}else\n\t\t\t\tif(sscanf(line,\"f %d//%d %d//%d %d//%d\",\n\t\t\t\t\t&integers[0],&integers[3],\n\t\t\t\t\t&integers[1],&integers[4],\n\t\t\t\t\t&integers[2],&integers[5])==6)\n\t\t\t\t{\n\t\t\t\t\ttri_ok = true;\n\t\t\t\t}else\n\t\t\t\tif(sscanf(line,\"f %d/%d/%d %d/%d/%d %d/%d/%d\",\n\t\t\t\t\t&integers[0],&integers[6],&integers[3],\n\t\t\t\t\t&integers[1],&integers[7],&integers[4],\n\t\t\t\t\t&integers[2],&integers[8],&integers[5])==9)\n\t\t\t\t{\n\t\t\t\t\ttri_ok = true;\n\t\t\t\t\thas_uv = true;\n\t\t\t\t}else // Add Support for v/vt only meshes\n\t\t\t\tif (sscanf(line, \"f %d/%d %d/%d %d/%d\",\n\t\t\t\t\t&integers[0], &integers[6],\n\t\t\t\t\t&integers[1], &integers[7],\n\t\t\t\t\t&integers[2], &integers[8]) == 6)\n\t\t\t\t{\n\t\t\t\t\ttri_ok = true;\n\t\t\t\t\thas_uv = true;\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tprintf(\"unrecognized sequence\\n\");\n\t\t\t\t\tprintf(\"%s\\n\",line);\n\t\t\t\t\twhile(1);\n\t\t\t\t}\n\t\t\t\tif ( tri_ok )\n\t\t\t\t{\n\t\t\t\t\tt.v[0] = integers[0]-1-vertex_cnt;\n\t\t\t\t\tt.v[1] = integers[1]-1-vertex_cnt;\n\t\t\t\t\tt.v[2] = integers[2]-1-vertex_cnt;\n\t\t\t\t\tt.attr = 0;\n\n\t\t\t\t\tif ( process_uv && has_uv )\n\t\t\t\t\t{\n\t\t\t\t\t\tstd::vector indices;\n\t\t\t\t\t\tindices.push_back(integers[6]-1-vertex_cnt);\n\t\t\t\t\t\tindices.push_back(integers[7]-1-vertex_cnt);\n\t\t\t\t\t\tindices.push_back(integers[8]-1-vertex_cnt);\n\t\t\t\t\t\tuvMap.push_back(indices);\n\t\t\t\t\t\tt.attr |= TEXCOORD;\n\t\t\t\t\t}\n\n\t\t\t\t\tt.material = material;\n\t\t\t\t\t//geo.triangles.push_back ( tri );\n\t\t\t\t\ttriangles.push_back(t);\n\t\t\t\t\t//state_before = state;\n\t\t\t\t\t//state ='f';\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif ( process_uv && uvs.size() )\n\t\t{\n\t\t\tloopi(0,triangles.size())\n\t\t\t{\n\t\t\t\tloopj(0,3)\n\t\t\t\ttriangles[i].uvs[j] = uvs[uvMap[i][j]];\n\t\t\t}\n\t\t}\n\n\t\tfclose(fn);\n\n\t\t//printf(\"load_obj: vertices = %lu, triangles = %lu, uvs = %lu\\n\", vertices.size(), triangles.size(), uvs.size() );\n\t} // load_obj()\n\n\t// Optional : Store as OBJ\n\n\tvoid write_obj(const char* filename)\n\t{\n\t\tFILE *file=fopen(filename, \"w\");\n\t\tint cur_material = -1;\n\t\tbool has_uv = (triangles.size() && (triangles[0].attr & TEXCOORD) == TEXCOORD);\n\n\t\tif (!file)\n\t\t{\n\t\t\tprintf(\"write_obj: can't write data file \\\"%s\\\".\\n\", filename);\n\t\t\texit(0);\n\t\t}\n\t\tif (!mtllib.empty())\n\t\t{\n\t\t\tfprintf(file, \"mtllib %s\\n\", mtllib.c_str());\n\t\t}\n\t\tloopi(0,vertices.size())\n\t\t{\n\t\t\t//fprintf(file, \"v %lf %lf %lf\\n\", vertices[i].p.x,vertices[i].p.y,vertices[i].p.z);\n\t\t\tfprintf(file, \"v %g %g %g\\n\", vertices[i].p.x,vertices[i].p.y,vertices[i].p.z); //more compact: remove trailing zeros\n\t\t}\n\t\tif (has_uv)\n\t\t{\n\t\t\tloopi(0,triangles.size()) if(!triangles[i].deleted)\n\t\t\t{\n\t\t\t\tfprintf(file, \"vt %g %g\\n\", triangles[i].uvs[0].x, triangles[i].uvs[0].y);\n\t\t\t\tfprintf(file, \"vt %g %g\\n\", triangles[i].uvs[1].x, triangles[i].uvs[1].y);\n\t\t\t\tfprintf(file, \"vt %g %g\\n\", triangles[i].uvs[2].x, triangles[i].uvs[2].y);\n\t\t\t}\n\t\t}\n\t\tint uv = 1;\n\t\tloopi(0,triangles.size()) if(!triangles[i].deleted)\n\t\t{\n\t\t\tif (triangles[i].material != cur_material)\n\t\t\t{\n\t\t\t\tcur_material = triangles[i].material;\n\t\t\t\tfprintf(file, \"usemtl %s\\n\", materials[triangles[i].material].c_str());\n\t\t\t}\n\t\t\tif (has_uv)\n\t\t\t{\n\t\t\t\tfprintf(file, \"f %d/%d %d/%d %d/%d\\n\", triangles[i].v[0]+1, uv, triangles[i].v[1]+1, uv+1, triangles[i].v[2]+1, uv+2);\n\t\t\t\tuv += 3;\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tfprintf(file, \"f %d %d %d\\n\", triangles[i].v[0]+1, triangles[i].v[1]+1, triangles[i].v[2]+1);\n\t\t\t}\n\t\t\t//fprintf(file, \"f %d// %d// %d//\\n\", triangles[i].v[0]+1, triangles[i].v[1]+1, triangles[i].v[2]+1); //more compact: remove trailing zeros\n\t\t}\n\t\tfclose(file);\n\t}\n\n}"
},
{
"path": "fast_simplification/Simplify.h",
"content": "/////////////////////////////////////////////\n//\n// Mesh Simplification Tutorial\n//\n// (C) by Sven Forstmann in 2014\n//\n// License : MIT\n// http://opensource.org/licenses/MIT\n//\n//https://github.com/sp4cerat/Fast-Quadric-Mesh-Simplification\n//\n// 5/2016: Chris Rorden created minimal version for OSX/Linux/Windows compile\n\n#include \n//#include \n//#include \n//#include \n//#include \n#include \n//#include \n//#include \n#include \n#include \n#include ]