Merge pull request #220 from smathermather/image_mask_tutorial

OpenDroneMap · Oct 20, 2024 · 0f50e9f · 0f50e9f
2 parents ecc87e4 + a0bc353
commit 0f50e9f
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 32 deletions.
diff --git a/source/index.rst b/source/index.rst
@@ -53,10 +53,9 @@ The documentation is available in several languages. Some translations are incom
     flowchart
     outputs
     map-accuracy
-    masks
+    multispectral
     large
     flying
-    multispectral
     requesting-features
     contributing
     faq
diff --git a/source/masks.rst b/source/masks.rst
diff --git 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:
+
+``<filename>_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