VoronoiVolume#
- class vivid3d.VoronoiVolume#
VoronoiVolume class for Volumetric analysis and iso-surface extraction.
- iso_surface(self: vivid3d._core.VoronoiVolume, mask: List[bool], label: str = 'isosurface', opacity: float = 1) vivid3d._core.Mesh#
Extracts iso-surface by boolean mask of same size as input points.
Only faces between a True and False point will be included in the final mesh. For a visual explanation, see https://vivid.readthedocs.io/en/latest/userguide/voronoi.html#the-voronoi-algorithm
- Parameters
mask (array_like(n)[bool]) – An (n, 1) shaped boolean array for creating the iso-surface. Only faces between a True and False point will be included in the final mesh.
label (str, default: "isosurface") – Optional name of the object, not required to be unique.
opacity ((0.0-1.0), default: 1.0) – Float in the range of 0.0 - 1.0 indicating how transparent the material is. A value of 0.0 indicates fully transparent, 1.0 is fully opaque.
- Returns
vivid3d.Mesh – The resulting iso-surface