Metadata-Version: 2.1
Name: geo3dfeatures
Version: 0.4.0.post2
Summary: Extract geometry features from 3D point clouds
Home-page: https://github.com/oslandia/geo3dfeatures
License: BSD-3-Clause
Author: Damien Garaud
Author-email: damien.garaud@oslandia.com
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Software Development :: Libraries
Requires-Dist: daiquiri (>=1.5.0,<2.0.0)
Requires-Dist: dask (>=0.20.2,<0.21.0)
Requires-Dist: laspy (>=1.5.1,<2.0.0)
Requires-Dist: numpy (>=1.15,<2.0)
Requires-Dist: pandas (>=0.23.4,<0.24.0)
Requires-Dist: plotly (>=4.1,<5.0)
Requires-Dist: plyfile (>=0.7.0,<0.8.0)
Requires-Dist: scikit-learn (>=0.21,<0.22)
Requires-Dist: scipy (>=1.2,<2.0)
Requires-Dist: seaborn (>=0.9.0,<0.10.0)
Requires-Dist: tables (>=3.5,<4.0)
Requires-Dist: tqdm (>=4.31.1,<5.0.0)
Project-URL: Repository, https://github.com/oslandia/geo3dfeatures
Description-Content-Type: text/markdown

Extract geometry features from 3D point clouds

# Content

The project contains the following folders:

+ [geo3dfeatures](./geo3dfeatures) contains source code
+ [docs](./docs) contains some mardown files for documentation purpose and
  images
+ [examples](./examples) contains some Jupyter notebooks for describing data
+ [tests](./tests); `pytest` is used to launch several tests from this folder

Additionally, running the code may generate extra subdirectories in a chosen
data repository (`./data`, by default).

# How to install

This projects runs with Python3, every dependencies are managed
through [poetry](https://poetry.eustace.io/).

## Installation from source

```
$ git clone ssh://git@git.oslandia.net:10022/Oslandia-data/geo3dfeatures.git
$ cd geo3dfeatures
$ virtualenv -p /usr/bin/python3 venv
$ source venv/bin/activate
(venv)$ poetry install
```

# Contribution

See [CONTRIBUTING.md](./CONTRIBUTING.md).

# Run commands

In order to get the available program commands, consider the program help (`geo3d -h`):

```
usage: geo3d [-h] {info,sample,index,featurize,cluster,train,predict} ...

Geo3dfeatures framework for 3D semantic analysis

positional arguments:
  {info,sample,index,featurize,cluster,train,predict}
    info                Describe an input .las file
    sample              Extract a sample of a .las file
    index               Index a point cloud file and serialize it
    featurize           Extract the geometric feature associated to 3D points
    cluster             Cluster a set of 3D points with a k-means algorithm
    train               Train a semantic segmentation model
    predict             Predict 3D point semantic class starting from a
                        trained model

optional arguments:
  -h, --help            show this help message and exit
```

Any further CLI documentation may be printed with `geo3d <command> -h`.

# Documentation

Some documentation is available, that describes the set of considered geometric
features, the fixtures (*i.e.* dummy datasets) used for test purpose and a
practical pipeline use case:

- [Feature set](./docs/features.md)
- [Test fixtures](./docs/test_fixtures.md)
- [Command pipeline](./docs/pipeline.md)

# Examples

The following example has been generated starting from
a [CANUPO](http://nicolas.brodu.net/en/recherche/canupo/) dataset (file `scene.xyz`, with 500k points, 50 neighbors and all the features):

![scene](./docs/images/scene_kmean.png)

___

Oslandia – 2019-2020

