Point Cloud Library (PCL)  1.12.0
/builddir/build/BUILD/pcl-1.12.0/outofcore/outofcore.doxy
1 /**
2  \addtogroup outofcore Module outofcore
3 
4  \section secOutofcoreOctree Overview
5 
6  The <b>pcl_outofcore</b> library provides an octree data structure
7  for point clouds that are too large to be stored in main memory. The
8  data are located instead in an directory-based octree hierary on
9  some secondary storage (disk) medium. <b>pcl_outofcore</b> provides
10  the framework for constructing and traversing outofcore octrees, a
11  command-line tool <b>pcl_outofcore_process</b> for converting a set
12  of registered PCD files to outofcore octree, and
13  <b>pcl_outofcore_viewer</b> for rendering outofcore octrees.
14 
15  <b>pcl_outofcore</b> provides an interface to construct and query
16  outofcore octrees via OutofcoreOctreeBase. The out of core octree
17  can be used with any PCLPointCloud2 with point types containing x,
18  y and z fields. No internal checking is done to verify
19  this. On the other hand, point clouds do not need to be filtered for
20  NaN entries; the library will automatically ignore NaN points in the
21  insertion methods.
22 
23  The average user may not need to do any development with this
24  library, but rather use the command-line tool
25  <b>pcl_outofcore_process</b> to construct an outofcore octree, and
26  <b>pcl_outofcore_viewer</b> to view it.
27 
28  For those interested in developing software with
29  <b>pcl_outofcore</b>, the functionality of the OutofcoreOctreeBase
30  class provides methods for insertion (<b>addPointCloud</b>), and
31  querying bounding boxes (<b>queryBoundingBox</b>). Furthermore
32  <b>OutofcoreDepthFirstIterator</b> provides an iterator for the
33  entire tree that gives direct access to the in-memory node
34  datastructre, <b>OutofcoreOctreeBaseNode</b>. Please note that this
35  library is still under development, and that interested users should
36  use the <b>PCLPointCloud2</b>-based insertion and query methods.
37 
38  \section secOutofcore Example Usage
39 
40  \section secOutofcoreRequirements Requirements
41  - \ref common "common"
42  - \ref io "io"
43  - \ref visualization "visualization" (for pcl_outofcore_viewer)
44  - \ref filters "filters"
45 
46 */