An open source command line toolkit for processing aerial drone imagery
 
 
 
 
 
 
Go to file
Piero Toffanin a9c5333a53 Merge pull request #1156 from pierotofy/python3
ODM 2.0 - Migration to 18.04, Python 3.6, new features, bug fixes

Former-commit-id: ef174de8af8dbb87379fa882f20ede34c751aef1
2020-09-21 11:03:09 -04:00
SuperBuild Update mvs-texturing 2020-09-15 18:47:42 -04:00
contrib Remove unnecessary scripts for sequoia image preparation. 2020-08-19 20:10:17 +10:00
docker Changed architecture of portable docker images to newer nehalem 2019-04-09 14:37:35 -04:00
docs Create issue_template.md 2018-03-28 16:31:01 -04:00
licenses Remove PMVS module 2018-07-01 17:28:55 -04:00
modules Upgraded PDAL to 2.1, removed odm_filterpoints module 2020-07-07 11:29:25 -04:00
opendm Allow override of parser object in config 2020-09-17 13:59:44 -04:00
stages Added --tiles to generate DEM/Ortho static tiles 2020-09-17 15:28:03 +00:00
tests Started migration to 18.04, Python3.6 2020-09-08 13:08:57 -04:00
.dockerignore Updated dockefiles to best practices ready for multi stage builds 2020-02-29 10:54:26 +10:00
.gitignore Updated start-dev-env.sh, fix photo.py (get_xmp), misc Python 2 --> 3 changes 2020-09-09 12:10:24 -04:00
.gitmodules Added lidar2dems superbuild module, modified dockerfile, configure.sh to install lidar2dems deps 2017-06-20 14:53:17 -04:00
CMakeLists.txt Make SLAM build optional 2016-06-16 10:28:12 +02:00
CNAME Create CNAME 2017-07-31 11:29:25 -04:00
CONTRIBUTING.md Update CONTRIBUTING.md 2020-04-14 11:24:53 -04:00
Dockerfile Started migration to 18.04, Python3.6 2020-09-08 13:08:57 -04:00
LICENSE Rename LICENCE to LICENSE 2016-02-19 12:00:59 -05:00
README.md Merge pull request #1156 from pierotofy/python3 2020-09-21 11:03:09 -04:00
VERSION Started migration to 18.04, Python3.6 2020-09-08 13:08:57 -04:00
code_of_conduct.md Update code_of_conduct.md 2020-04-14 11:26:22 -04:00
configure.sh Fail script if build fails 2020-09-16 11:26:43 -04:00
odm_docker_readme.txt Update odm_docker_readme.txt 2018-03-23 11:43:50 -03:00
portable.Dockerfile Updated portable dockerfile, configure script 2020-09-16 10:04:51 -04:00
requirements.txt Faster EDT in orthophoto computations 2020-09-11 12:34:38 -04:00
run.py Fixes 2020-09-14 20:09:26 +00:00
run.sh Updated start-dev-env.sh, fix photo.py (get_xmp), misc Python 2 --> 3 changes 2020-09-09 12:10:24 -04:00
settings.yaml Update settings.yaml 2020-04-02 18:48:29 -05:00
start-dev-env.sh PDAL alias in start-dev-env 2020-09-16 09:53:06 -04:00
test.sh Started migration to 18.04, Python3.6 2020-09-08 13:08:57 -04:00

README.md

ODM Logo

An open source command line toolkit for processing aerial drone imagery. ODM turns simple 2D images into:

  • Classified Point Clouds
  • 3D Textured Models
  • Georeferenced Orthorectified Imagery
  • Georeferenced Digital Elevation Models

images-diag

The application is available for Windows, Mac and Linux and it works from the command line, making it ideal for power users, scripts and for integration with other software.

If you would rather not type commands in a shell and are looking for a friendly user interface, check out WebODM.

Quickstart

The easiest way to run ODM is via docker. To install docker, see docs.docker.com. Once you have docker installed and working, you can run ODM by placing some images (JPEGs or TIFFs) in a folder named “images” (for example C:\Users\youruser\datasets\project\images or /home/youruser/datasets/project/images) and simply run from a Command Prompt / Terminal:

# Windows
docker run -ti --rm -v c:/Users/youruser/datasets:/datasets opendronemap/odm --project-path /datasets project

# Mac/Linux
docker run -ti --rm -v /home/youruser/datasets:/datasets opendronemap/odm --project-path /datasets project

You can pass additional parameters by appending them to the command:

docker run -ti --rm -v /datasets:/datasets opendronemap/odm --project-path /datasets project [--additional --parameters --here]

For example, to generate a DSM (--dsm) and increase the orthophoto resolution (--orthophoto-resolution 2) :

docker run -ti --rm -v /datasets:/datasets opendronemap/odm --project-path /datasets project --dsm --orthophoto-resolution 2

Viewing Results

When the process finishes, the results will be organized as follows:

|-- images/
    |-- img-1234.jpg
    |-- ...
|-- opensfm/
    |-- see mapillary/opensfm repository for more info
|-- odm_meshing/
    |-- odm_mesh.ply                    # A 3D mesh
|-- odm_texturing/
    |-- odm_textured_model.obj          # Textured mesh
    |-- odm_textured_model_geo.obj      # Georeferenced textured mesh
|-- odm_georeferencing/
    |-- odm_georeferenced_model.laz     # LAZ format point cloud
|-- odm_orthophoto/
    |-- odm_orthophoto.tif              # Orthophoto GeoTiff

You can use the following free and open source software to open the files generated in ODM:

  • .tif (GeoTIFF): QGIS
  • .laz (Compressed LAS): CloudCompare
  • .obj (Wavefront OBJ), .ply (Stanford Triangle Format): MeshLab

Note! Opening the .tif files generated by ODM in programs such as Photoshop or GIMP might not work (they are GeoTIFFs, not plain TIFFs). Use QGIS instead.

API

ODM can be made accessible from a network via NodeODM.

Documentation

See http://docs.opendronemap.org for tutorials and more guides.

Forum

We have a vibrant community forum. You can search it for issues you might be having with ODM and you can post questions there. We encourage users of ODM to partecipate in the forum and to engage with fellow drone mapping users.

Native Install (Ubuntu 18.04)

You can run ODM natively on Ubuntu 18.04 LTS (although we don't recommend it):

  1. Download the source from here
  2. Run bash configure.sh install
  3. Download a sample dataset from here (about 550MB) and extract it in /datasets/aukerman
  4. Run ./run.sh --project-path /datasets odm_data_aukerman

Updating a native installation

When updating to a newer version of ODM, it is recommended that you run

bash configure.sh reinstall

to ensure all the dependent packages and modules get updated.

Build From Source

If you want to rebuild your own docker image (if you have changed the source code, for example), from the ODM folder you can type:

docker build -t my_odm_image --no-cache .

When building your own Docker image, if image size is of importance to you, you should use the --squash flag, like so:

docker build --squash -t my_odm_image .

This will clean up intermediate steps in the Docker build process, resulting in a significantly smaller image (about half the size).

Experimental flags need to be enabled in Docker to use the --squash flag. To enable this, insert the following into the file /etc/docker/daemon.json:

{
   "experimental": true
}

After this, you must restart docker.

Developers

Help improve our software! We welcome contributions from everyone, whether to add new features, improve speed, fix existing bugs or add support for more cameras. Check our code of conduct, the contributing guidelines and how decisions are made.

For Linux users, the easiest way to modify the software is to make sure docker is installed, clone the repository and then run from a shell:

$ DATA=/path/to/datasets ./start-dev-env.sh

Where /path/to/datasets is a directory where you can place test datasets (it can also point to an empty directory if you don't have test datasets).

Run configure to set up the required third party libraries:

(odmdev) [user:/code] master+* ± bash configure.sh reinstall

You can now make changes to the ODM source. When you are ready to test the changes you can simply invoke:

(odmdev) [user:/code] master+* ± ./run.sh --project-path /datasets mydataset

If you have questions, join the developer's chat at https://community.opendronemap.org/c/developers-chat/21

  1. Try to keep commits clean and simple
  2. Submit a pull request with detailed changes and test results
  3. Have fun!

Citation

OpenDroneMap Authors ODM - A command line toolkit to generate maps, point clouds, 3D models and DEMs from drone, balloon or kite images. OpenDroneMap/ODM GitHub Page 2020; https://github.com/OpenDroneMap/ODM