README.md 5.03 KB
Newer Older
Rashad Kanavath's avatar
Rashad Kanavath committed
1
# OTB provider for QGIS Processing
Rashad Kanavath's avatar
Rashad Kanavath committed
2

Rashad Kanavath's avatar
Rashad Kanavath committed
3
**OTB provider will be available in processing core starting from qgis 3.8.**
4 5


Rashad Kanavath's avatar
Rashad Kanavath committed
6 7 8
## Version
* QGIS : 3.2.0 or later
* OTB  : 6.6.0 or later
Rashad Kanavath's avatar
Rashad Kanavath committed
9 10


Rashad Kanavath's avatar
Rashad Kanavath committed
11
## Requirements
Rashad Kanavath's avatar
Rashad Kanavath committed
12

Rashad Kanavath's avatar
Rashad Kanavath committed
13
Make sure you don't have reference to clone of this repository in your QGIS_PLUGINPATH. 
Rashad Kanavath's avatar
Rashad Kanavath committed
14

15 16 17 18 19 20 21
### Download and Install OTB

OTB is not distributed with qgis-otb-plugin. It is a seperate project and has its own git repository.

Download OTB: https://www.orfeo-toolbox.org/download/

Git repository: https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb
Rashad Kanavath's avatar
Rashad Kanavath committed
22

Rashad Kanavath's avatar
Rashad Kanavath committed
23 24 25
## Installation

Install through QGIS plugin manager. This plugin is available in OTB's plugin repository located at orfeo-toolbox.org/qgis/
Rashad Kanavath's avatar
Rashad Kanavath committed
26

27 28
#### Start QGIS

Rashad Kanavath's avatar
Rashad Kanavath committed
29 30 31 32 33 34 35 36 37 38
* Open plugin manager through menu. `Plugins -> Manage and Install Plugins `
* Select `Settings` on left pane and then click `Add..` button to add our plugin repository

![QGIS Plugin Manager](http://orfeo-toolbox.org/qgis/otb_plugin_readme/qgis_plugins_settings.png)

* Write `Name` for repository. eg: `CNES plugin repository`
* Write `URL` as `http://orfeo-toolbox.org/qgis/plugins.xml`
* Click `OK` to add repository.

![Add cnes plugin repo 1](http://orfeo-toolbox.org/qgis/otb_plugin_readme/qgis_plugins_add_repo.png)
39

Rashad Kanavath's avatar
Rashad Kanavath committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
* Once list of plugins are fetched from our repository. It will show status as `connected`

![Add cnes plugin repo 2](http://orfeo-toolbox.org/qgis/otb_plugin_readme/qgis_plugins_add_otb_1.png)

* Select `New` or `Upgradable` from left pane. You can now see `Processing OTB Provider` in the list of plugins
* Select `Processing OTB Provider` and click on `Install plugin` to download and install otb processing

![intall plugin ](http://orfeo-toolbox.org/qgis/otb_plugin_readme/qgis_plugins_install_1.png)

* It show "Plugin installed Sucessfully" message afer installation is finished.
 
![install plugin done ](http://orfeo-toolbox.org/qgis/otb_plugin_readme/qgis_plugins_install_done.png)


#### Verify otb plugin installation
55 56 57

`Plugins -> Manage and Install Plugins `

Rashad Kanavath's avatar
Rashad Kanavath committed
58 59 60
Click on `Installed` tab on left and make sure box next to `Processing OTB provider` is checked.

![ verify plugin installation ](http://orfeo-toolbox.org/qgis/otb_plugin_readme/verify_plugin_install.png)
61 62

#### Open processing settings
Rashad Kanavath's avatar
Rashad Kanavath committed
63 64
  
`Settings -> Options -> Processing (left panel)`
Rashad Kanavath's avatar
Rashad Kanavath committed
65

66
You can see OTB under "Providers".
Rashad Kanavath's avatar
Rashad Kanavath committed
67

Rashad Kanavath's avatar
Rashad Kanavath committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
* Expand `OTB` tab
* Tick `Activate` box
* 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 QGIS Processing toolbox

![configure otb provider ](http://orfeo-toolbox.org/qgis/otb_plugin_readme/qgis_processing_configure_otb.png)

![install finished ](http://orfeo-toolbox.org/qgis/otb_plugin_readme/qgis_processing_configure_done.png)

****Installation finished!****

#### OTB Haralick texture extraction Algorithm in QGIS processing

![OTB Algorithm ](http://orfeo-toolbox.org/qgis/otb_plugin_readme/qgis_processing_otb_haralick.png)
Rashad Kanavath's avatar
Rashad Kanavath committed
83

84 85
------

Rashad Kanavath's avatar
Rashad Kanavath committed
86
#### Documenation of OTB settings available in QGIS Processing.
Rashad Kanavath's avatar
Rashad Kanavath committed
87

Rashad Kanavath's avatar
Rashad Kanavath committed
88 89 90 91 92 93 94 95
##### 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 list below.
* OTB build folder (for source builds), 
* Folder in which OTB is installed using `make install`, package managers or official binary packages

96
##### OTB application folder
Rashad Kanavath's avatar
Rashad Kanavath committed
97
This is the location(s) of OTB applications.
Rashad Kanavath's avatar
Rashad Kanavath committed
98 99 100

Multiple paths are allowed to use custom/proprietary OTB applications.

Rashad Kanavath's avatar
Rashad Kanavath committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
##### Logger level (optional)
Level of logger to use by OTB applications. level of logging control 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 application use system RAM as available. you can however instruct otb to use specific amount of RAM from available using this option. 

*A value of `128` is ignored by OTB processing provider.*

**This is an advanced user configuration.**

Rashad Kanavath's avatar
Rashad Kanavath committed
118 119 120 121 122 123 124
##### 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. 

Rashad Kanavath's avatar
Rashad Kanavath committed
125
*This value is empty by default.*
Rashad Kanavath's avatar
Rashad Kanavath committed
126 127 128 129 130 131 132 133 134 135 136


##### 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.

Rashad Kanavath's avatar
Rashad Kanavath committed
137
*This value is empty by default.*
Rashad Kanavath's avatar
Rashad Kanavath committed
138 139

See OTB issue for a related feature request in OTB QtWidget wrapper. https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb/issues/1560
Rashad Kanavath's avatar
Rashad Kanavath committed
140