Skip to content

Meshes

qim3d.mesh

qim3d.mesh.from_volume 

from_volume(volume, **kwargs)

Convert a 3D numpy array to a mesh object using the volumetric_isocontour function from Pygel3D.

Parameters:

Name Type Description Default
volume ndarray

A 3D numpy array representing a volume.

 required
**kwargs any

Additional arguments to pass to the Pygel3D volumetric_isocontour function.

 {}

Raises:

Type Description
ValueError

If the input volume is not a 3D numpy array or if the input volume is empty.

Returns:

Type Description
Manifold

hmesh.Manifold: A Pygel3D mesh object representing the input volume.
Example

Convert a 3D numpy array to a Pygel3D mesh object: 

import qim3d

# Generate a 3D blob
synthetic_blob = qim3d.generate.noise_object(noise_scale = 0.015)

# Convert the 3D numpy array to a Pygel3D mesh object
mesh = qim3d.mesh.from_volume(synthetic_blob)

Source code in qim3d/mesh/_common_mesh_methods.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def from_volume(volume: np.ndarray, **kwargs: any) -> hmesh.Manifold:
    """
    Convert a 3D numpy array to a mesh object using the [volumetric_isocontour](https://www2.compute.dtu.dk/projects/GEL/PyGEL/pygel3d/hmesh.html#volumetric_isocontour) function from Pygel3D.

    Args:
        volume (np.ndarray): A 3D numpy array representing a volume.
        **kwargs: Additional arguments to pass to the Pygel3D volumetric_isocontour function.

    Raises:
        ValueError: If the input volume is not a 3D numpy array or if the input volume is empty.

    Returns:
        hmesh.Manifold: A Pygel3D mesh object representing the input volume.

    Example:
        Convert a 3D numpy array to a Pygel3D mesh object:
        ```python
        import qim3d

        # Generate a 3D blob
        synthetic_blob = qim3d.generate.noise_object(noise_scale = 0.015)

        # Convert the 3D numpy array to a Pygel3D mesh object
        mesh = qim3d.mesh.from_volume(synthetic_blob)
        ```

    """

    if volume.ndim != 3:
        raise ValueError('The input volume must be a 3D numpy array.')

    if volume.size == 0:
        raise ValueError('The input volume must not be empty.')

    mesh = hmesh.volumetric_isocontour(volume, **kwargs)
    return mesh