Skip to main content

A Python package for point cloud classification using color and curvature

Project description

pymccrgb

Build Status Documentation Status

pymccrgb is a Python package for multiscale curvature classification of point clouds with color attributes.

It extends a popular classification method (MCC lidar) [0] to point cloud datasets with multiple color channels, such as those commonly produced in surveys using drone photography or other platforms. It can be used to distinguish points from the ground surface and low vegetation in data produced by structure from motion photogrammetry, stereo photogrammetry, or multi-spectral lidar scanning, or to filter colorized lidar point clouds.

The intended users are scientists in geomorphology, ecology, or planetary science who want to classify point clouds for topographic analysis, canopy height measurements, or other spectral classification.

Installation

If LibLAS is installed, you can create a virtual environment with conda or venv to install the package and the rest of the dependencies:

git clone https://github.com/rmsare/pymccrgb
cd pymccrgb
conda env create -f environment.yml
conda activate pymcc
pip install pymccrgb
py.test pymccrgb/tests

Requirements

This package is developed for Linux/OS X and Python 3.6+.

The LibLAS C library is required for MCC and pymccrgb. The MCC wrapper also requires Boost and the C++11 standard library, which are likely installed as system libraries.

On Ubuntu/Debian, you can install LibLAS via apt:

sudo apt-get install liblas-c-dev

On OS X, it is available through Homebrew:

brew install liblas

Refer to the documentation and the LibLAS install guide for instructions for installing LibLAS from source.

Examples

Topography under tree cover

from pymccrgb import mcc, mcc_rgb
from pymccrgb.datasets import load_mammoth_lidar
from pymccrgb.plotting import plot_results

# Load sample data (Mammoth Mountain, CA)
data = load_mammoth_lidar(npoints=1e6)

# MCC algorithm
ground_mcc, labels_mcc = mcc(data)

# MCC-RGB algorithm
ground_mccrgb, labels_mccrgb = mcc_rgb(data)

plot_results(data, labels_mcc, labels_mccrgb)

MCC results

Results of MCC and MCC-RGB on forested area near Mammoth Mountain, CA.

Documentation

Read the documentation for example use cases, an API reference, and more. They are hosted at pymccrgb.readthedocs.io. Example notebooks are available in the docs or at docs/source/examples.

Contributing

Bug reports

Bug reports are much appreciated. Please open an issue with the bug label, and provide a minimal example illustrating the problem.

Suggestions

Feel free to suggest new features in an issue with the new-feature label.

Pull requests

If you would like to add a feature or fix a bug, please fork the repository, create a feature branch, and submit a PR and reference any relevant issues. There are nice guides to contributing with GitHub here and here. Please include tests where appropriate and check that the test suite passes (a Travis build or pytest pymccrgb/tests) before submitting.

Support and questions

Please open an issue with your question.

References

[0] Evans, J. S., & Hudak, A. T. 2007. A multiscale curvature algorithm for classifying discrete return LiDAR in forested environments. IEEE Transactions on Geoscience and Remote Sensing, 45(4), 1029-1038 doi

License

This work is licensed under the MIT License (see LICENSE). It also incorporates a wrapper for the mcc-lidar implementation, which is distributed under the Apache license (see LICENSE.txt).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pymccrgb-0.1.1.tar.gz (24.3 MB view details)

Uploaded Source

Built Distribution

pymccrgb-0.1.1-py3-none-any.whl (24.3 MB view details)

Uploaded Python 3

File details

Details for the file pymccrgb-0.1.1.tar.gz.

File metadata

  • Download URL: pymccrgb-0.1.1.tar.gz
  • Upload date:
  • Size: 24.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.6

File hashes

Hashes for pymccrgb-0.1.1.tar.gz
Algorithm Hash digest
SHA256 27496cc832ac970230d896cd2480663d54373b291cbc64a9568ce6f19318b6ec
MD5 21f9c08377a477d53e20df2052458dfe
BLAKE2b-256 9f31b506ac0119dd7ac93c0dcb727ef9514250e0c7f8dcac4ef3802a3d471bbd

See more details on using hashes here.

File details

Details for the file pymccrgb-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pymccrgb-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 24.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.6

File hashes

Hashes for pymccrgb-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 33eb84265b71a256c99a887b5148a894100f438ca29663ebdc3f57baaf09b2a9
MD5 d145e53e6b9d8c2666e4fa78432720dc
BLAKE2b-256 cfec190f30603e41268a1bd25a01dadd56d4f13cadc5f2e745d30f8059ccc5fa

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page