Commit 38b25cad authored by Cédric Traizet's avatar Cédric Traizet

Merge branch...

Merge branch '2056-move-documentation-about-otb-integration-in-qgis-to-qgis-documentation' into 'develop'

Clean QGIS interface documentation according migration into QGIS documentation

Closes #2056

See merge request orfeotoolbox/otb!722
parents 48c6e94a 56ab1317
QGIS interface
==============
The OTB QGIS plugin provides a GUI for OTB applications directly into QGIS. Note that OTB is not distributed with the plugin and needs to be installed separately. Binary packages for OTB can be found on the [download page](https://www.orfeo-toolbox.org/download).
OTB Applications are fully integrated in QGIS since QGIS 3.8.
You can configure OTB for QGIS according to the:
The plugin requires QGIS 3.2 or later, and is fully integrated within QGIS since version 3.8.
This page explains how to setup the plugin with QGIS 3.8 or later. For QGIS version between 3.2 and 3.8 the instructions on this (page)[https://gitlab.orfeo-toolbox.org/orfeotoolbox/qgis-otb-plugin#otb-provider-for-qgis-processing] should be followed.
Plugin configuration
--------------------
Plugin activation
^^^^^^^^^^^^^^^^^
The plugin should be configured to find the OTB library :
Open processing settings :
`Settings -> Options -> Processing (left panel)`
You can see OTB under "Providers":
* Expand OTB tab
* Tick Activate option
* Set OTB folder. This is location of your OTB installation.
* Set OTB application folder. This is location of your OTB applications. ``<OTB_FOLDER>/lib/otb/applications``
* Click "ok" to save settings and close dialog. If settings are correct, you will have OTB algorithms loaded in Processing toolbox
Documentation of OTB settings available in QGIS Processing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* **Activate**: This is a checkbox to activate or deactivate OTB provider. Any invalid settings in OTB folder will uncheck this when saved.
* **OTB folder**: This is the directory where OTB is available. Valid values are listed below.
* **OTB application folder**: This is the location(s) of OTB applications. Multiple paths are allowed to use custom/proprietary OTB applications.
* **Logger level** (optional): Level of logger to use by OTB applications. The level of logging controls the amount of details printed during algorithm execution.
Possible values for logger level are INFO, WARNING, CRITICAL, DEBUG. You can refer to otb::Logger documentation for more on this values. This value is INFO by default. This is an advanced user configuration.
* **Maximum RAM to use** (optional): by default OTB applications use system RAM as available. You can however instruct OTB to use a specific amount of RAM from available using this option.
A value of 256 is ignored by OTB processing provider. This is an advanced user configuration.
* **Geoid file** (optional): Path to geoid file. Value of this options is set for elev.dem.geoid and elev.geoid parameters in OTB applications.
Setting this value globally help users to share it across multiple processing algorithms. This value is empty by default.
* **SRTM tiles folder** (optional): Directory where SRTM tiles are available.
SRTM data can be stored locally to avoid connecting to downloading of files during processing.
Value of this options is set for elev.dem.path and elev.dem parameters in OTB applications.
Setting this value globally help users to share it across multiple processing algorithms. This value is empty by default.
- `QGIS Provider documentation for latest LTR <https://docs.qgis.org/latest/en/docs/user_manual/processing/3rdParty.html>`_.
- `QGIS Provider documentation <https://docs.qgis.org/testing/en/docs/user_manual/processing/3rdParty.html>`_.
Compatibility between QGIS and OTB versions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-------------------------------------------
There are compatibility issues between the different versions of OTB and QGIS. Any version
of OTB compiled with GDAL 3.X is not compatible with QGIS 3.12 or below. This is the case
......@@ -73,6 +26,27 @@ The table below summarizes which version of OTB can be used with which version o
| OTB 7.1.0 | Not Compatible | Compatible |
+---------------+-----------------+--------------------+
Troubleshoot
------------
As of QGIS 3.8 the otb plugin is in the core. It might get messy if you have a previously installed plugin. Try to remove the old plugin before launching QGIS.
Use OTB in old QGIS version (3.6 and less)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. warning:: Please consider upgrading your QGIS version.
Since QGIS 3.8 and with 3.10 LTR version, the configuration of OTB Application is
directly done in QGIS Provider (see above).
If you use older version of QGIS (from 3.2 to 3.6), you need to install an
additional plugin in order to use OTB applications. This plugin is available
`here <https://gitlab.orfeo-toolbox.org/orfeotoolbox/qgis-otb-plugin>`_
with specific installation instructions.
Troubleshooting
^^^^^^^^^^^^^^^
As of QGIS 3.8 the OTB plugin is in the core. It might get messy if you
have a previously installed plugin. Try to remove the old plugin before
launching QGIS.
Issue tracking
^^^^^^^^^^^^^^
If you encounter issues with integration of OTB application into QGIS,
please `fill an issue <https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb/-/issues/new?issue[assignee_id]=&issue[milestone_id]=>`_ into the OTB issue tracker with `qgis` label.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment