Documentation

Documentation

The Documentation is split into the sub-pages Prerequisites, Compiling, Examples, 3D-Visualizer, Model generation and Usage as a library
Doxygen Pages of the API can be found at: http://www.gpu-voxels.org/doxygen/html/

Licenses:

  • The ic_workspace and the ic_maker with its FindScripts ships under a BSD license.
  • icl_core and the gpu_voxels come with a CDDL license.
  • Some parts of gpu_voxels contain 3rd party code. Please see Open Source Acknowledgment for details.
  • The example Maps (all.pcd, holl.pcd) are kindly provided by Jan Oberländer (FZI) and may NOT be redistributed!

Directory structure:

ic_workspace
├── build  ==> Here are the binaries
├── doc ==> Doxygen Docu
├── example_how_to_link ==> Example on how to link against gpu_voxels
├── export ==>  This is the standard export dir if you want to link against gpu_voxels
├── icmaker
│      └── CMakeModules ==> Here lie the Cmake Find Scripts
├── ide
├── packages ==> All software packages go here
│        ├── gpu_voxels ==> Our GPU-Voxels library
│        │       ├── models ==> Example model files
│        │       └── src
│        │                ├── examples ==> Example code
│        │                ├── gpu_visualization ==> Shared Mem Visualizer
│        │                │         ├── kernels
│        │                │         ├── logging
│        │                │         └── shaders
│        │                └── gpu_voxels ==> Main Library
│        │                            ├── helpers ==> General Helper Functions
│        │                            ├── logging ==> Logging Defines
│        │                            ├── octree ==> The GPU Octree (for large volumes)
│        │                            ├── primitive_array ==> The GPU Primitive-Array (helper to visualize 3D data)
│        │                            ├── robot ==> Helpers to represent kinematic structures
│        │                            ├── test ==> Unit tests
│        │                            ├── vis_interface ==> Definition of the Visualization Interface
│        │                            ├── voxel ==> The basic data type
│        │                            ├── voxellist ==> The GPU Voxellist (for sparse data)
│        │                            └── voxelmap ==> The GPU Voxelmaps (for dense data)
│        ├── icl_core ==> Basic Library
├── python
└── script