From 665c63c86e64b057ca8e38ab012a7c8f6ee4bc05 Mon Sep 17 00:00:00 2001 From: Piero Toffanin Date: Mon, 14 Sep 2020 12:10:15 -0400 Subject: [PATCH 1/2] Update Ubuntu version reference --- source/installation.rst | 2 +- source/locale/ar/LC_MESSAGES/installation.po | 4 ++-- source/locale/ar/LC_MESSAGES/tutorials.po | 8 ++++---- source/locale/en/pot/installation.pot | 2 +- source/locale/en/pot/tutorials.pot | 4 ++-- source/locale/sw/LC_MESSAGES/installation.po | 4 ++-- source/locale/sw/LC_MESSAGES/tutorials.po | 8 ++++---- source/tutorials.rst | 4 ++-- 8 files changed, 18 insertions(+), 18 deletions(-) diff --git a/source/installation.rst b/source/installation.rst index 1ead657e2..6ad42c09a 100644 --- a/source/installation.rst +++ b/source/installation.rst @@ -47,7 +47,7 @@ ODM, NodeODM and WebODM are available on all major platforms (Windows, macOS and Without docker it would not be possible to run ODM on Windows or macOS. On these platforms ODM cannot run natively. Future development efforts are being focused on leveraging the new Windows Subsystem for Linux (WSL) and the possibility to make a native port of all dependencies to macOS, which is going to make the installation much easier. -On Ubuntu Linux 16.04 it’s feasible to run all OpenDroneMap software natively. However, because there’s very little performance penalty for running docker on Linux and docker is straightforward to setup on this platform, we don’t recommend it. On Linux the advantages of containerization far outweigh a tiny performance penalty. With docker users also get easy one-step updates of the software, so that’s nice. +On Ubuntu Linux 18.04 it’s feasible to run all OpenDroneMap software natively. However, because there’s very little performance penalty for running docker on Linux and docker is straightforward to setup on this platform, we don’t recommend it. On Linux the advantages of containerization far outweigh a tiny performance penalty. With docker users also get easy one-step updates of the software, so that’s nice. Hardware Recommendations diff --git a/source/locale/ar/LC_MESSAGES/installation.po b/source/locale/ar/LC_MESSAGES/installation.po index cde54f80c..de280d4af 100644 --- a/source/locale/ar/LC_MESSAGES/installation.po +++ b/source/locale/ar/LC_MESSAGES/installation.po @@ -148,14 +148,14 @@ msgstr "" # 73af16f53c6b4b658517706a33eabf7f #: ../../../installation.rst:50 msgid "" -"On Ubuntu Linux 16.04 it’s feasible to run all OpenDroneMap software " +"On Ubuntu Linux 18.04 it’s feasible to run all OpenDroneMap software " "natively. However, because there’s very little performance penalty for " "running docker on Linux and docker is straightforward to setup on this " "platform, we don’t recommend it. On Linux the advantages of containerization" " far outweigh a tiny performance penalty. With docker users also get easy " "one-step updates of the software, so that’s nice." msgstr "" -"في Ubuntu Linux 16.04 ، من الممكن تشغيل جميع برامج OpenDroneMap أصلاً. ومع " +"في Ubuntu Linux 18.04 ، من الممكن تشغيل جميع برامج OpenDroneMap أصلاً. ومع " "ذلك ، نظرًا لوجود القليل جدًا من عقوبة الأداء لتشغيل عامل الميناء على Linux " "ووصلة عامل الميناء مباشرة على الإعداد على هذا النظام الأساسي ، فإننا لا نوصي" " بذلك. في لينكس ، تفوق مزايا الحاويات بشكل كبير عقوبة الأداء الصغيرة. مع " diff --git a/source/locale/ar/LC_MESSAGES/tutorials.po b/source/locale/ar/LC_MESSAGES/tutorials.po index cd3080384..09b0ff27a 100644 --- a/source/locale/ar/LC_MESSAGES/tutorials.po +++ b/source/locale/ar/LC_MESSAGES/tutorials.po @@ -590,8 +590,8 @@ msgstr "" # 548dc42ce8ee453f9a7d4b501e7f3522 #: ../../../tutorials.rst:237 -msgid "Should be an Ubuntu 16.04 instance to ensure dependency compatibility" -msgstr "يجب أن يكون نسخة Ubuntu 16.04 لضمان توافق التبعية" +msgid "Should be an Ubuntu 18.04 instance to ensure dependency compatibility" +msgstr "يجب أن يكون نسخة Ubuntu 18.04 لضمان توافق التبعية" # 7f25f7675fe04c2d8a4e7f52011f99e1 #: ../../../tutorials.rst:239 @@ -607,7 +607,7 @@ msgid "" "it will offer you the option to upgrade to Ubuntu 18.04, a more recent " "version. Don’t. ODM native install doesn’t work smoothly on 18.04. Go ahead " "and execute ``sudo apt update`` and ``sudo apt upgrade`` to ensure your " -"server isn’t dangerously without updates, but stay with Ubuntu 16.04." +"server isn’t dangerously without updates, but stay with Ubuntu 18.04." msgstr "" "قم بإنشاء مستخدم بامتيازات sudo. \"وثائق Digital Ocean الجيدة بجنون " "`__ can help you figure this out. In our case we set up a user called ``odm``, so connecting to it is via the command ``ssh odm@xxx.xxx.xxx.xxx`` (where the x’s stand for the IPv4 address of your server). If you want to follow this example closely, *do* use the username ``odm``; then your install path will be ``/home/odm/ODM/`` and will match all of the examples in this document. -When you log into the server, it will offer you the option to upgrade to Ubuntu 18.04, a more recent version. Don’t. ODM native install doesn’t work smoothly on 18.04. Go ahead and execute ``sudo apt update`` and ``sudo apt upgrade`` to ensure your server isn’t dangerously without updates, but stay with Ubuntu 16.04." +msgid "Create a user with sudo privileges. `Digital Ocean’s insanely good documentation `__ can help you figure this out. In our case we set up a user called ``odm``, so connecting to it is via the command ``ssh odm@xxx.xxx.xxx.xxx`` (where the x’s stand for the IPv4 address of your server). If you want to follow this example closely, *do* use the username ``odm``; then your install path will be ``/home/odm/ODM/`` and will match all of the examples in this document. -When you log into the server, it will offer you the option to upgrade to Ubuntu 18.04, a more recent version. Don’t. ODM native install doesn’t work smoothly on 18.04. Go ahead and execute ``sudo apt update`` and ``sudo apt upgrade`` to ensure your server isn’t dangerously without updates, but stay with Ubuntu 18.04." msgstr "" #: ../../../tutorials.rst:254 diff --git a/source/locale/sw/LC_MESSAGES/installation.po b/source/locale/sw/LC_MESSAGES/installation.po index 8c61b3713..b1a3b6a98 100644 --- a/source/locale/sw/LC_MESSAGES/installation.po +++ b/source/locale/sw/LC_MESSAGES/installation.po @@ -152,14 +152,14 @@ msgstr "" # 73af16f53c6b4b658517706a33eabf7f #: ../../../installation.rst:50 msgid "" -"On Ubuntu Linux 16.04 it’s feasible to run all OpenDroneMap software " +"On Ubuntu Linux 18.04 it’s feasible to run all OpenDroneMap software " "natively. However, because there’s very little performance penalty for " "running docker on Linux and docker is straightforward to setup on this " "platform, we don’t recommend it. On Linux the advantages of containerization" " far outweigh a tiny performance penalty. With docker users also get easy " "one-step updates of the software, so that’s nice." msgstr "" -"Katika Ubuntu Linux 16.04 inawezekana kurun OpenDroneMap software zote " +"Katika Ubuntu Linux 18.04 inawezekana kurun OpenDroneMap software zote " "wenyewe. Hata hivyo, kwa sababu kuna kuongezeka ufanisi kwa kufanya kazi " "docker kwenye Linux na docker ina njia nyepesi ya kupangilia katika platform" " hii, hatushauri hio. Katika Linux ya faida ya chombo kisichozidi uwezowe " diff --git a/source/locale/sw/LC_MESSAGES/tutorials.po b/source/locale/sw/LC_MESSAGES/tutorials.po index afa1dd2e2..e749f0eef 100644 --- a/source/locale/sw/LC_MESSAGES/tutorials.po +++ b/source/locale/sw/LC_MESSAGES/tutorials.po @@ -600,8 +600,8 @@ msgstr "" # 548dc42ce8ee453f9a7d4b501e7f3522 #: ../../../tutorials.rst:237 -msgid "Should be an Ubuntu 16.04 instance to ensure dependency compatibility" -msgstr "Lazima Ubuntu 16.04 instance kuhakikisha uwiano" +msgid "Should be an Ubuntu 18.04 instance to ensure dependency compatibility" +msgstr "Lazima Ubuntu 18.04 instance kuhakikisha uwiano" # 7f25f7675fe04c2d8a4e7f52011f99e1 #: ../../../tutorials.rst:239 @@ -617,7 +617,7 @@ msgid "" "it will offer you the option to upgrade to Ubuntu 18.04, a more recent " "version. Don’t. ODM native install doesn’t work smoothly on 18.04. Go ahead " "and execute ``sudo apt update`` and ``sudo apt upgrade`` to ensure your " -"server isn’t dangerously without updates, but stay with Ubuntu 16.04." +"server isn’t dangerously without updates, but stay with Ubuntu 18.04." msgstr "" "Tengeneza mtumiaji kwa sudo privileges\" `Digital Ocean’s insanely good " "documentation `__ @@ -249,7 +249,7 @@ Install Don’t. ODM native install doesn’t work smoothly on 18.04. Go ahead and execute ``sudo apt update`` and ``sudo apt upgrade`` to ensure your server isn’t dangerously without updates, but stay with - Ubuntu 16.04. + Ubuntu 18.04. - Download and install ODM on it from the `ODM Github `__ (regular, not WebODM) From e11caa2078c7d17c1f51471792e1b963dd19c7e1 Mon Sep 17 00:00:00 2001 From: Piero Toffanin Date: Wed, 16 Sep 2020 10:43:55 -0400 Subject: [PATCH 2/2] Added geo, masks sections --- source/conf.py | 4 ++-- source/geo.rst | 34 ++++++++++++++++++++++++++++++++++ source/index.rst | 2 ++ source/masks.rst | 29 +++++++++++++++++++++++++++++ 4 files changed, 67 insertions(+), 2 deletions(-) create mode 100644 source/geo.rst create mode 100644 source/masks.rst diff --git a/source/conf.py b/source/conf.py index 7d64b53c2..d4f21d565 100644 --- a/source/conf.py +++ b/source/conf.py @@ -14,9 +14,9 @@ copyright = '2020, OpenDroneMap' author = 'OpenDroneMap' # The short X.Y version -version = '0.9.10' +version = '2.0.0' # The full version, including alpha/beta/rc tags -release = '0.9.10' +release = '2.0.0' # -- General configuration --------------------------------------------------- diff --git a/source/geo.rst b/source/geo.rst new file mode 100644 index 000000000..9b9958e92 --- /dev/null +++ b/source/geo.rst @@ -0,0 +1,34 @@ +####################### +Image Geolocation Files +####################### + +By default ODM will use the GPS information embedded in the images, if it is available. Sometimes images do not contain GPS information, or a user wishes to override the information with more accurate data (such as RTK). + +Starting from ODM ``2.0`` people can supply an image geolocation file (geo) for this purpose. + +The format of the image geolocation file is simple. + + * The first line should contain the name of the projection used for the geo coordinates. This can be specified either as a PROJ string (e.g. ``+proj=utm +zone=10 +ellps=WGS84 +datum=WGS84 +units=m +no_defs``), EPSG code (e.g. ``EPSG:4326``) or as a ``WGS84 UTM [N|S]`` value (eg. ``WGS84 UTM 16N``) + * Subsequent lines are the image filename, X, Y & Z (optional) coordinates, the camera angles (optional, currently used only for radiometric calibration) and the horizontal/vertical accuracy (optional): + * Camera angles can be set to ``0`` if they are not available. + * The 10th column (optional) can contain extra fields, such as a label. + +File format:: + + + image_name geo_x geo_y [geo_z] [omega (degrees)] [phi (degrees)] [kappa (degrees)] [horz accuracy (meters)] [vert accuracy (meters)] [extras...] + ... + +Example:: + + EPSG:4326 + DJI_0028.JPG -91.9942096111111 46.84252125 198.609 + DJI_0032.JPG -91.9938293055556 46.8424584444444 198.609 + + + +If you supply a file called ``geo.txt`` then ODM will automatically detect it. If it has another name you can specify using ``--geo ``. + +The ``geo.txt`` file must be created in the base of your project folder. + +`Help edit these docs! `_ diff --git a/source/index.rst b/source/index.rst index 25a1787d5..9f3bf1051 100644 --- a/source/index.rst +++ b/source/index.rst @@ -33,6 +33,8 @@ Welcome to OpenDroneMap's documentation arguments outputs gcp + geo + masks large resources flying diff --git a/source/masks.rst b/source/masks.rst new file mode 100644 index 000000000..2918c133e --- /dev/null +++ b/source/masks.rst @@ -0,0 +1,29 @@ +################# +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. + + +`Help edit these docs! `_