How to read the API documentation

A Dataset consists of multiple PointCloud objects which form the two main classes of the package.

The main classes

Dataset: pointcloudset.dataset.Dataset based on pointcloudset.dataset_core.DatasetCore

PointCloud: pointcloudset.pointcloud.PointCloud based on pointcloudset.pointcloud_core.PointCloudCore

Modules

As a common user these Classes are enough to tackle most proplems. If you want to dive deeper or contribute to the package than you should have a look at the other modules.

Datasets and PointCloud use the functions of the following modules:

• pointcloudset.cluster

• pointcloudset.diff

• pointcloudset.filter

• pointcloudset.geometry

• pointcloudset.io

• pointcloudset.plot

Note

pointcloudset.cluster provides the DBSCAN-based clustering used by PointCloud.get_cluster() via pointcloudset.cluster.get_cluster_labels(). The union-find inner loops are JIT-compiled with Numba when the optional extra is installed:

pip install pointcloudset[numba]

Without Numba a pure-Python fallback is used automatically.

For a more detailed documentation see the section below.