Altametris - geo3d

Welcome to geo3d’s documentation

Note

For a complete documentation, please visit the repository geo3d.

Owner altametris.

Project Description

A Python package for handling 3D point cloud data

Steps

  1. Install the package following the Installation

  2. Learn how to use it following the Usage

Contents

Contributors

README

GEO3D

A Python package for handling 3D point cloud data.

Introduction

This package is used for handling point clouds and processing them for data science projects.

It enables to make various transformations along with input output operations and to handle particularly classes and their annotations.

The package is articulated around the PDAL library for processing point clouds and which defines readers, writers, and filters, that can be chained together to build pipelines and run them.

Getting started

The source code is structured as follows:

altametris/
└── geo3d
    ├── __init__.py
    ├── core                        # core components module
       ├── __init__.py
       ├── base.py                 # defining components
       ├── functional.py           # components as functions
       ├── links.py                # utility file
       └── pipeline.py             # pipeline creation
    ├── pdal                        # pdal stages module
       ├── __init__.py
       ├── filters.py              # pdal filters definition
       ├── helpers.py              # utility file
       ├── readers.py              # pdal readers definition
       └── writers.py              # pdal writers definition
    ├── scripts                     # module containing runnable scripts
       ├── clean_clusters.py       # clean object clusters
       ├── remove_outliers.py      # remove outliers
       └── report_clusters.py      # create report of clusters
    ├── settings.py                 # file defining global settings
    ├── utils                       # utility module
       ├── __init__.py
       ├── colors.py               # handling color objects
       ├── geometry.py             # handling geometry objects
       └── multiprocessing.py      # handling multiprocessing
    └── visualization               # visualization module
        ├── __init__.py
        └── visualizer.py           # main file for creating visualizations

It is recommanded to take a tour at the notebooks folder that contains tutorials on how to use the package:

notebooks/
├── Visualization-tutorial.ipynb    # tutorial about how to make visualizations
├── pdal-tutorial.ipynb             # tutorial about python pdal library
└── pipelines-tutorial.ipynb        # tutorial about how to create pipelines

Installation

To use the geo3d package, you must create an anaconda virtual environment. :

conda create -n geo3d python=3.11
conda activate geo3d

Then we can begin by installing the package from the altametris feed:

[global]
index-url=https://pkgs.dev.azure.com/altametris/_packaging/altametris-sdk%40Local/pypi/simple/

We can then install the package:

pip install geo3d

Finally install python pdal manually

conda install -c conda-forge python-pdal=3.4.5

Indices and tables