Git Product home page Git Product logo

adaptivefiltering's Introduction

Welcome to the Adaptive Ground Point Filtering Library

License: MIT GitHub Workflow Status codecov Documentation Status Binder

This library is currently under development.

Features

adaptivefiltering is a Python package to enhance the productivity of ground point filtering workflows in archaeology and beyond. It provides a Jupyter-based environment for "human-in-the-loop" tuned, spatially heterogeneous ground point filterings. Core features

  • Working with Lidar datasets directly in Jupyter notebooks
    • Loading/Storing of LAS/LAZ files
    • Visualization using hillshade models and slope maps
    • Applying of ground point filtering algorithms
    • Cropping with a map-based user interface
  • Accessibility of existing filtering algorithms under a unified data model:
    • PDAL: The Point Data Abstraction Library is an open source library for point cloud processing.
    • OPALS is a proprietary library for processing Lidar data. It can be tested freely for datasets <1M points.
    • LASTools has a proprietary tool called lasground_new that can be used for ground point filtering.
  • Access to predefined filter pipeline settings
  • Spatially heterogeneous application of filter pipelines
    • Assignment of filter pipeline settings to spatial subregions in map-based user interface
    • Command Line Interface for large scale application of filter pipelines

Prerequisites

In order to work with adaptivefiltering, you need the following required pieces of Software.

  • Python >= 3.7
  • A WebGL-enabled browser. We recommend Google Chrome and advise you to test with it whenever you experience difficulties with user intefaces.
  • A Conda installation

There are alternatives to Conda for installation, but we strongly advise you to use Conda as it offers the best experience for this type of project.

Installing and using

Using Conda

Having a local installation of Conda, the following sequence of commands sets up a Conda environment for adaptivefiltering:

git clone https://github.com/ssciwr/adaptivefiltering.git
cd adaptivefiltering
conda env create -f environment.yml --force
conda run -n adaptivefiltering python -m pip install .

You can start the JupyterLab frontend by doing:

conda activate adaptivefiltering
jupyter lab

Using Binder

You can try adaptivefiltering without prior installation by using Binder, which is a free cloud-hosted service to run Jupyter notebooks. This will give you an impression of the library's capabilities, but you will want to work on a local setup when using the library productively: On Binder, you might experience very long startup times, slow user experience and limitations to disk space and memory.

Using Docker

Having set up Docker, you can use adaptivefiltering directly from a provided Docker image:

docker run -t -p 8888:8888 ssciwr/adaptivefiltering:latest

Having executed above command, paste the URL given on the command line into your browser and start using adaptivefiltering by looking at the provided Jupyter notebooks. This image is limited to working with non-proprietary filtering backends (PDAL only).

Using Pip

We advise you to use Conda as adaptivefiltering depends on a lot of other Python packages, some of which have external C/C++ dependencies. Using Conda, you get all of these installed automatically, using pip you might need to do a lot of manual work to get the same result.

That being said, adaptivefiltering can be installed from PyPI:

python -m pip install adaptivefiltering

adaptivefiltering's People

Contributors

dokempf avatar gwydionjon avatar pre-commit-ci[bot] avatar readthedocs-assistant avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.