Getting Started#
Introduction#
Consider reading the Cleaver Manual.
System requirements#
Windows 10+, macOS 10.12+, and Ubuntu 20.04 or OpenSuse 15.1+ Recommended.
CPU: Core Duo or higher, recommended i5 or i7
Memory: 4Gb, recommended 8Gb or more
Dedicated Graphics Card (OpenGL 4.1+, Dedicated Shared Memory, no integrated graphics cards)
Graphics Memory: minimum 128MB, recommended 256MB or more
Caution
The following graphics cards are known to not support Cleaver:
AMD Radeon HD 6310 (Integrated Card)
AMD Radeon 7400 M
INTEL HD 3000 (Integrated Card)
Using Installer#
Download the latest installers.
Learn about the Cleaver Command Line Tool and Graphical Interface.
Tip
If there is no installer available for your platform, you may consider using python, installing the SlicerSegmentMesher extension or building Cleaver from source.
Using Python#
Cleaver is available as Python wheels distributed on PyPI for Windows, macOS and Linux for integrating in either an ITK or VTK filtering pipeline.
ITK#
Create a virtual environment then install the
itk-cleaver
package:
pip install itk-cleaver
Generate multi-material tetrahedral mesh from a label image
import itk
image = itk.imread('./mickey.nrrd')
tet_mesh, triangle_mesh = itk.cleaver_image_to_mesh_filter(image)
itk.meshwrite(triangle_mesh, './triangle_mesh.vtk')
VTK#
Using 3D Slicer#
Download 3D Slicer and install the SlicerSegmentMesher extension that enables creating volumetric meshes from segmentation using Cleaver.
Using C++ and CMake#
See Building Cleaver as well as the Cleaver Library manual.