Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eidelen/DicomToMesh
A command line tool to transform a DICOM volume into a 3d surface mesh (obj, stl or ply). Several mesh processing routines can be enabled, such as mesh reduction, smoothing or cleaning. Works on Linux, OSX and Windows.
https://github.com/eidelen/DicomToMesh
3d 3d-mesh ct-scans dicom mesh mesh-generation mesh-processing obj ply stl surface-reconstruction threshold visualisation vtk
Last synced: 24 days ago
JSON representation
A command line tool to transform a DICOM volume into a 3d surface mesh (obj, stl or ply). Several mesh processing routines can be enabled, such as mesh reduction, smoothing or cleaning. Works on Linux, OSX and Windows.
- Host: GitHub
- URL: https://github.com/eidelen/DicomToMesh
- Owner: eidelen
- License: mit
- Created: 2017-06-20T09:09:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-01T21:10:21.000Z (about 1 month ago)
- Last Synced: 2024-11-15T11:02:38.838Z (28 days ago)
- Topics: 3d, 3d-mesh, ct-scans, dicom, mesh, mesh-generation, mesh-processing, obj, ply, stl, surface-reconstruction, threshold, visualisation, vtk
- Language: C++
- Homepage:
- Size: 3.8 MB
- Stars: 451
- Watchers: 34
- Forks: 93
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-dicom - DicomToMesh - A command line tool to transform a DICOM volume into a 3d surface mesh (_obj_, _stl_ or _ply_). Several mesh processing routines can be enabled, such as mesh reduction, smoothing or cleaning. (Libraries / C++)
README
  
# DicomToMesh
DicomToMesh is a handy command line tool, which enables the user to automatically create a 3D mesh from a set of 2D DICOM images, a common image format used in medicine. The supported 3D mesh formats are STL, OBJ and PLY. DicomToMesh works on Linux, OSX and Windows.
# Mesh Creation
The 3D surface mesh is computed by the marching cubes algorithm. As an input, this algorithm requires a threshold which indicates what range of voxel values should be considered. This threshold is also known as iso-value. In CT scans, the iso-value depends on the tissue (density). In Dicom2Mesh you can specify the iso-value with the parameter -t X, where X is an integer.
# Mesh Post-Processing Options
**Mesh reduction:** The mesh of a medical DICOM image can easily exceed 1 GB of data. Reducing the number of polygons, therefore, is a crucial feature. Reduction can be enabled by the option -r X where X is a floating-point value between 0.0 and 1.0.
**Mesh smoothing:** Acquired medical images contain often heavy noise. This is visible in the extracted 3D surface. Smoothing the mesh leads often to a better result. Smoothing can be enabled with the argument -s.
**Remove small objects:** The resulting 3D mesh contains often parts which are not of interest, such as for example the screws of the table on which a CT scan of a patient was acquired. With DicomToMesh, you can remove objects below a certain size by adding the option -e X where X is a floating-point value between 0.0 and 1.0. X is a size threshold relative to the connected object with the most vertices. It is easy understandable with an example: The biggest connected object of the mesh has 1000 vertices. Then -e 0.25 removes all connected objects with less than 250 vertices.
# Visualisation
By passing the command line option -v the resulting mesh is visualised in a 3D environment. By double clicking the mesh's surface, the corresponding 3D coordinate is printed to the shell.
The option -vo shows the input DICOM data in a volume renderer (vtkFixedPointVolumeRayCastMapper). The color map can be set with multiple parameters like (Red,Green,Blue,Alpha,Iso-Value). As an example, the parameters -vo (255,0,0,0,0) (255,0,0,60,700) (200,200,200,90,2000) color voxels with values from 0-700 reddish and 700-2000 whitish.
# Installation
Ubuntu 18.04
```
> sudo add-apt-repository ppa:eidelen/d2m
> sudo apt-get update
> sudo apt-get install dicom2mesh
```
On OSX and Windows it is required to build DicomToMesh yourself.
### Using via Docker
There is a [docker file](docker/Dockerfile) ready for use. If you have docker installed you can use the generated image without installing anything locally.
#### Usage
```bash
# build image and tag it as `dicom2mesh`
docker build docker -t dicom2mesh
# use generated image to build an stl file
docker run -v `pwd`/my/dicom/files/:/data dicom2mesh -i /data -t 557 -o /data/mesh.stl
```
Your mesh will be created alongside your dicom images and named `mesh.stl`
# Building
The software is written in modern C++ on top of the powerful VTK library and is using CMake as a build-system.
Building DicomToMesh on Linux and OSX:
```
> git clone https://github.com/AOT-AG/DicomToMesh.git
> cd DicomToMesh
> mkdir build
> cd build
> ccmake .. #opens ccmake window
```
Within the ccmake window, pass the path to your vtk installation or vtk build directory. In my case, it looks like that
```
BUILD_GUI OFF
CMAKE_BUILD_TYPE DEBUG
CMAKE_INSTALL_PREFIX /usr/local
USE_VTK_DICOM OFF
VTK_DIR /home/eidelen/Development/libs/vtk/build
```
Press c and then g.
Now you are back in terminal and ready to build.
```
> make
```
In order to extend the supported DICOM formats, the library vtk-dicom USE_VTK_DICOM can be optionally enabled (see https://github.com/dgobbi/vtk-dicom). If you use VTK 6, 7 or 8, you have to build vtk-dicom separately. From on VTK 9, vtk-dicom is part of the vtk project - you can enable the corresponding module when building VTK with
```
> cmake .. -DVTK_MODULE_ENABLE_VTK_DICOM=YES -DVTK_MODULE_ENABLE_VTK_vtkDICOM=YES
```
Building on Windows:
Building on Windows is essentially the same as building under Linux and OSX. The project settings can be done with the cmake GUI. The versions we are using are VTK 7.0.0 together with Visual Studio 2015. The optional GUI we are building with QT 5.9.4.
Additional build notes:
- Building on OSX with vtk-dicom (Moritz Moeller)
# How to use Dicom2Mesh
Command line arguments can be combined and passed in arbitrary order.
**Input and output:** The path to the DICOM directory is passed by the argument -i dicomPath. The file name of the resulting 3D mesh is specified by the parameter -o meshPath. This simple example transforms a DICOM data set into a 3D mesh file called mesh.stl, by using an iso-value of 557 -t 557.
> dicom2mesh -i pathToDicomDirectory -t 557 -o mesh.stl
Alternatively, one can use an existing 3d mesh as input. This is useful if you want to apply only mesh post-processing routines and bypass the time consuming mesh creation step. This example imports the former mesh.stl, centers it and exports it in the OBJ mesh format.
> dicom2mesh -i mesh.stl -c -o newMesh.obj
**Mesh post-processing:** The following example shows different mesh post-processing methods applied to resulting surface mesh out of the marching cubes algorithm. In particular, a mesh is reduced by 90% of its original number faces -r 0.9. In addition, the mesh is smoothed -s and centred at the coordinate system's origin -c. Another helpful function is the removal of small objects - here the removal of every object smaller than 5% of the biggest object -e 0.05.
> dicom2mesh -i pathToDicomDirectory -r 0.9 -s -c -e 0.05 -o mesh.stl
# GUI
Dicom2Mesh can be built with a small GUI on top.
This showed up to be helpful for users without command line experience.
However, the control possibilities are limited compared to the command line version.
In order to build the Dicom2Mesh GUI, please set the cmake flag BUILD_GUI=ON when configuring the project.
The GUI requires QT.
The icons in the gui were made by Smashicons from www.flaticon.com. The license is CC 3.0 BY
# Contributors
DicomToMesh was an in-house product of AOT AG, a former robotic medtech startup from Basel. Since the software is based on several open-source projects and multiple Stack Overflow entries, we decided to make our code public as well. We hope somebody can use parts of it. Participants are most welcome.
Have fun :)