diff --git a/source/faq.rst b/source/faq.rst index d48693eb27..c420d8c69c 100644 --- a/source/faq.rst +++ b/source/faq.rst @@ -1,46 +1,41 @@ -########################## +################################################### +Frequently Asked Questions and Additional Resources +################################################### + +************************** Frequently Asked Questions -########################## +************************** -*************** Data Processing -*************** +--------------- -Can I process two or more orthophoto GeoTIFFs to stitch them together? ----------------------------------------------------------------------- +**Can I process two or more orthophoto GeoTIFFs to stitch them together?** No. ODM is a photogrammetric pipeline and orthophotos do not have the necessary camera information since the images have already been orthorectified. You can use another program such as `Hugin `_ to do that. -The software is not using all of my CPU cores / memory / GPU all of the times. Is it normal? --------------------------------------------------------------------------------------------- +**The software is not using all of my CPU cores / memory / GPU all of the times. Is it normal?** Yes. The software tries to use all available resources, when possible, but not always. It's normal to see 10-15% CPU utilization at several moments during processing and 0% GPU utilization for lots of times. -If I use the native version of the software, how can I allocate more resources for processing? ----------------------------------------------------------------------------------------------- +**If I use the native version of the software, how can I allocate more resources for processing?** No need; the native (non-docker) version of the software already uses all available resources. -********* Licensing -********* +--------- -I want to build a commercial application that includes ODM. Do I need a commercial license? -------------------------------------------------------------------------------------------- +**I want to build a commercial application that includes ODM. Do I need a commercial license?** ODM is free and open source software, released under the `AGPLv3 `_. You are free to build and sell applications with it, just make sure to comply with the requirements of the license, in particular the disclose source requirement. -Are there other licensing options aside from the AGPLv3? --------------------------------------------------------- +**Are there other licensing options aside from the AGPLv3?** Nope, sorry! -************* Memory issues -************* +------------- -Your computer is running out of memory, what can you do? --------------------------------------------------------- +**Your computer is running out of memory, what can you do?** 1. First you can buy more RAM, this is the ultimate and final solution. 2. Alternatively you can resize the images when uploading and/or tweak your quality settings. @@ -55,6 +50,29 @@ Your computer is running out of memory, what can you do? - In Linux you can add a swap file or a partition dedicated to swap. For more information, please consult your search engine of choice as there are a lot of different distributions and methods to add swap. +********************* +Additional References +********************* + +For Users +--------- + +The following resources are a good place to start: + +* `README page for ODM `_ +* `README page for WebODM `_ +* `README page for NodeODM `_ +* `Ground Control Points Format Specification `_ +* `OpenDroneMap: The Missing Guide `_ + +For Developers +-------------- + +In addition to user resources, we recommend to also read the following: +* WebODM documentation: https://docs.webodm.org +* NodeODM API specification: https://github.com/OpenDroneMap/NodeODM/blob/master/docs/index.adoc +* Overview of the ODM pipeline: http://community.opendronemap.org/t/where-can-i-find-background-information-on-the-concepts-of-odm/665/2 +* We keep a `section in our forum dedicated to research papers `_. This is a valuable place where to read more about state of the art research related to structure from motion, multi-view stereo, meshing, texturing, etc. which can be used to improve the software. `Learn to edit `_ and help improve `this page `_! diff --git a/source/index.rst b/source/index.rst index d6844c3d3a..ae444f5e11 100644 --- a/source/index.rst +++ b/source/index.rst @@ -53,11 +53,9 @@ The documentation is available in several languages. Some translations are incom flowchart outputs map-accuracy - masks + multispectral large - resources flying - multispectral requesting-features contributing faq diff --git a/source/masks.rst b/source/masks.rst deleted file mode 100644 index 8eed0a510e..0000000000 --- a/source/masks.rst +++ /dev/null @@ -1,29 +0,0 @@ -################# -Using Image Masks -################# - -Starting from ODM ``2.0`` people can supply image masks to inform the software to skip reconstruction over certain areas. This is useful for cases where the sky was accidentally included in the input photos from oblique shots, or simply to limit the reconstruction of a single subject. - -To add a mask, simply create a new black and white image of the same dimension as the target image you want to mask (you can use a program such as GIMP to do this). Color in black the areas to exclude from the reconstruction. - -.. figure:: https://user-images.githubusercontent.com/1951843/93247037-ade87a00-f75b-11ea-8b42-25bc1d89279d.png - :alt: Target image - :align: center - -.. figure:: https://user-images.githubusercontent.com/1951843/93247007-a2954e80-f75b-11ea-87b3-4f04bd1737b9.png - :alt: Image mask - :align: center - - -.. figure:: https://user-images.githubusercontent.com/1951843/93246970-8f827e80-f75b-11ea-8179-5a8fdd9f5193.png - :alt: 3D result (building is masked) - :align: center - -Name your file: - -``_mask.JPG`` - -For example, ``DJI_0018.JPG`` can have a mask by creating a ``DJI_0018_mask.JPG`` file and include that in the list of images. You can use ``.JPG``, ``.PNG``, ``.BMP`` and ``.TIF`` formats for image masks. - - -`Learn to edit `_ and help improve `this page `_! diff --git a/source/resources.rst b/source/resources.rst deleted file mode 100644 index 9fcb910ee0..0000000000 --- a/source/resources.rst +++ /dev/null @@ -1,26 +0,0 @@ -Additional References -===================== - -For Users --------------- - -The following resources are a good place to start: - -* `README page for ODM `_ -* `README page for WebODM `_ -* `README page for NodeODM `_ -* `Ground Control Points Format Specification `_ -* `OpenDroneMap: The Missing Guide `_ - -For Developers --------------- - -In addition to user resources, we recommend to also read the following: - -* WebODM documentation: https://docs.webodm.org -* NodeODM API specification: https://github.com/OpenDroneMap/NodeODM/blob/master/docs/index.adoc -* Overview of the ODM pipeline: http://community.opendronemap.org/t/where-can-i-find-background-information-on-the-concepts-of-odm/665/2 -* We keep a `section in our forum dedicated to research papers `_. This is a valuable place where to read more about state of the art research related to structure from motion, multi-view stereo, meshing, texturing, etc. which can be used to improve the software. - - -`Learn to edit `_ and help improve `this page `_! \ No newline at end of file diff --git a/source/tutorials.rst b/source/tutorials.rst index 76a684279f..772deffae0 100644 --- a/source/tutorials.rst +++ b/source/tutorials.rst @@ -822,6 +822,32 @@ For instance, point clouds properties can be modified to show elevation and also Advanced ******** +Using Image Masks +================= + +Starting from ODM ``2.0`` people can supply image masks to inform the software to skip reconstruction over certain areas. This is useful for cases where the sky was accidentally included in the input photos from oblique shots, or simply to limit the reconstruction of a single subject. + +To add a mask, simply create a new black and white image of the same dimension as the target image you want to mask (you can use a program such as GIMP to do this). Color in black the areas to exclude from the reconstruction. + +.. figure:: https://user-images.githubusercontent.com/1951843/93247037-ade87a00-f75b-11ea-8b42-25bc1d89279d.png + :alt: Target image + :align: center + +.. figure:: https://user-images.githubusercontent.com/1951843/93247007-a2954e80-f75b-11ea-87b3-4f04bd1737b9.png + :alt: Image mask + :align: center + + +.. figure:: https://user-images.githubusercontent.com/1951843/93246970-8f827e80-f75b-11ea-8179-5a8fdd9f5193.png + :alt: 3D result (building is masked) + :align: center + +Name your file: + +``_mask.JPG`` + +For example, ``DJI_0018.JPG`` can have a mask by creating a ``DJI_0018_mask.JPG`` file and include that in the list of images. You can use ``.JPG``, ``.PNG``, ``.BMP`` and ``.TIF`` formats for image masks. + Using Singularity ================= @@ -1046,7 +1072,7 @@ Let us get the environment prepared for our testing: :: root@c997a4c5611b:/var/www# cd /code - ./configure.sh installruntimedepsonly + ./configure.sh install mkdir /code/SuperBuild/build cd /code/SuperBuild/build