Skip to main content

napari-vedo-bridge

License BSD-3 PyPI Python Version tests codecov napari hub

To be able to use interactive processing of meshes in napari, this plugin provides a bridge to the vedo library. It allows to transfer meshes between napari and vedo and to use the interactive processing capabilities of vedo in napari.

I/O

The plugin allows to export and import meshes and point layers. The following are supported:

napari layer type File Format Import Export Features
Surface .vtp ✓ ✓ ✓
Surface .vtk ✓ ✓ ✗
Surface .obj ✓ ✓ ✗
Surface .stl ✓ ✓ ✗
Surface .ply ✓ ✓ ✗
Points .vtp ✓ ✓ ✓
Points .vtk ✓ ✓ ✗
Points .ply ✓ ✓ ✗
Points .obj ✓ ✓ ✗

Interactive mesh cutting

To interactively cut meshes in the napari-vedo MeshCutter, install the plugin (see below) and open the plugin it from the napari plugins menu (Plugins > Mesh Cutter (napari-vedo-bridge)).

To cut meshes you can use the following cutters:

  • PlaneCutter: cuts a mesh with a plane
  • SphereCutter: cuts a mesh with a sphere
  • BoxCutter: cuts a mesh with a box

To send and get data into and from the plugin, you can:

  • Retrieve the current mesh from napari (click Retrieve mesh from napari) - this imports the currently selected mesh layer from napari
  • Load a mesh from file (click Load mesh)
  • Send a mesh to napari (click Send back to napari) - this creates a new mesh layer in napari

Mesh Processing Functions

The plugin also provides a set of mesh processing functions that can be used in napari. These functions are wrapped from the vedo library and provide various mesh processing capabilities. The following functions are available:

  • compute_normals: Compute normals for the given mesh.
  • shrink: Shrink the given mesh.
  • join: Join the given meshes.
  • subdivide: Subdivide the given mesh.
  • decimate: Decimate the given mesh.
  • decimate_pro: Decimate the given mesh using the Pro algorithm.
  • decimate_binned: Decimate the given mesh using the Binned algorithm.
  • smooth: Smooth the given mesh.
  • fill_holes: Fill holes in the given mesh.
  • inside_points: Get the points inside the given mesh.
  • extrude: Extrude the given mesh.
  • split: Split the given mesh into connected components.
  • extract_largest_region: Extract the largest region from the given mesh.
  • binarize: Binarize the given mesh.

Pointcloud Processing Functions

The plugin also provides a set of pointcloud processing functions that can be used in napari. These functions are wrapped from the vedo library and provide various pointcloud processing capabilities. The following functions are available:

  • smooth_points: Smooth the given points.
  • decimate_points: Decimate the given points.
  • cluster_points: Cluster the given points.
  • remove_outliers: Remove outliers from the given points.
  • compute_normals_points: Compute normals for the given points.
  • extract_largest_cluster: Extract the largest cluster from the given points.

This napari plugin was generated with Cookiecutter using @napari's cookiecutter-napari-plugin template.

Installation

You can install napari-vedo-bridge via pip:

pip install napari-vedo-bridge

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the BSD-3 license, "napari-vedo-bridge" is free and open source software

Issues

If you encounter any problems, please [file an issue] along with a detailed description.

Metadata

Release files for napari-vedo-bridge 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for napari-vedo-bridge 0.2.0
File Size Uploaded
napari_vedo_bridge-0.2.0.tar.gz 22.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for napari-vedo-bridge 0.2.0
File Interpreter ABI Platform
napari_vedo_bridge-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 46.0 kB

Release files / napari_vedo_bridge-0.2.0.tar.gz

Download URL napari_vedo_bridge-0.2.0.tar.gz
Size 22.0 kB
Tags Source
SHA-256 checksum
How to use checksums
9645adbed0c0754029484a3bc68b2a2df552e4aedc89cd7cf7e33165947cd882
BLAKE2b-256 checksum
How to use checksums
1e6b9362a25f1b0927285aed1021af09988ffed60a04923f36f177a31ea926a3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.4

Release files / napari_vedo_bridge-0.2.0-py3-none-any.whl

Download URL napari_vedo_bridge-0.2.0-py3-none-any.whl
Size 24.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c7539a3a7d2c3c19b2de464f29046f7c502d843a2c47a054f1ba03664b7cec4e
BLAKE2b-256 checksum
How to use checksums
21d52b265da334d8a66ede4f8cdc7e02e5cc191ae307d668f5b970bb8604db31
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.4

Release history Release notifications | RSS feed

0.3.0

2 release files

0.2.2

2 release files

0.2.1

2 release files

This release

0.2.0 This release

2 release files

0.1.0

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page