Configuration des applications tierces¶

Note pour les utilisateurs de Windows¶

If you are not an advanced user and you are running QGIS on Windows, you might not be interested in reading the rest of this chapter. Make sure you install QGIS in your system using the standalone installer. That will automatically install SAGA, GRASS and OTB in your system and configure them so they can be run from QGIS. All the algorithms from these providers will be ready to be run without needing any further configuration. If installing through OSGeo4W application, make sure you select for installation SAGA, GRASS and OTB as well.

If you want to know more about how these providers work, or if you want to use some algorithms not included in the simplified toolbox (such as R scripts), keep on reading.

A propos des formats de fichiers¶

Le fait d’ouvrir un fichier dans QGIS ne garantit pas que ce fichier pourra être ouvert et traité par l’application tierce. Dans la plupart des cas, celui-ci pourra lire ce que vous avez ouvert dans QGIS, mais parfois, cela ne sera pas le cas. C’est particulièrement le cas des connections aux bases de données et les fichiers peu communs, aussi bien raster que vectoriels, qui pourront présenter des problèmes. Si cela arrivait, essayez de convertir vos données dans un format usuel reconnu par l’application tierce et vérifiez dans la console (historique et messages) le résultat du traitement pour analyser l’origine des erreurs.

Si vous utilisez des couches raster GRASS, par exemple, vous allez peut-être rencontrer des problèmes et ne pas pouvoir mener à bien votre travail si vous appelez des algorithmes externes ayant cette couche comme entrée. C’est pour cette raison que ces couches ne seront pas disponibles pour les algorithmes.

You should, however, find no problems at all with vector layers, since QGIS automatically converts from the original file format to one accepted by the external application before passing the layer to it. This adds extra processing time, which might be significant if the layer has a large size, so do not be surprised if it takes more time to process a layer from a DB connection than it does to process one of a similar size stored in a shapefile.

Les algorithmes n’utilisant pas d’application tierce peuvent traiter toutes les couches qui peuvent s’ouvrir dans QGIS puisque qu’ils sont lancés depuis QGIS.

Concernant les formats de sortie, tous les formats gérés par QGIS peuvent être utilisés en sortie, à la fois pour les couches raster et vecteur. Certains formats ne sont pas gérés par certaines applications tierces mais celles-ci permettent toutes d’exporter dans des formats courants qui peuvent ensuite être convertis automatiquement par QGIS. Comme pour les couches d’entrée, si une conversion est opérée, le temps de traitement peut être allongé.

A propos des sélections sur les couches vectorielles¶

Les applications tierces peuvent prendre en compte les sélections qui existent sur les couches vecteur dans QGIS. Cependant, cela nécessite de réécrire toutes les couches vecteur d’entrée, comme si elles étaient dans un format non géré par l’application tierce. Une couche peut être passée directement à une application tierce uniquement lorsqu’il n’y a pas de sélection ou que l’option N’utiliser que les entités sélectionnées n’ pas activée dans les paramètres de configuration généraux du module de traitement.

Dans les cas où l’export de la sélection est nécessaire cela rallonge les temps d’exécution.

SAGA¶

Les algorithmes de SAGA peuvent être exécutés depuis QGIS si SAGA est installé sur votre ordinateur et que le module de traitements QGIS est configuré correctement pour trouver les fichiers nécessaires. En particulier, l’exécutable en ligne de commande de SAGE est nécessaire pour utiliser les algorithmes.

Si vous utilisez Windows, les installateurs indépendant et OSGeo4W incluent SAGA aux côtés de QGIS, et le chemin d’accès est automatiquement configuré. Il n’y a donc rien à faire d’autre.

Si vous avez installé vous-même SAGA et que votre installeur QGIS ne l’inclut pas, le chemin vers l’exécutable SAGA doit être configuré. pour cela, ouvrez la fenêtre de configuration. Dans le bloc SAGA, vous trouverez un paramètre nommé Répertoire SAGA. Entrez le chemin du dossier d’installation de SAGA et fermez la fenêtre. Vous êtes prêts à utiliser les algorithmes de SAGA depuis QGIS.

Si vous êtes sur Linux, les exécutables SAGA ne sont pas inclus dans le module de Traitements. Vous devez donc télécharger et installer le logiciel vous-même. Référez au site web de SAGA pour plus d’informations.

Dans ce cas, il n’est pas nécessaire de configurer le chemin vers l’exécutable de SAGA et vous ne verrez pas ces répertoires. Vérifiez que SAGA est correctement installé et que le chemin d’installation figure dans la variable d’environnement PATH. Pour vérifier que les fichiers binaires de SAGA sont accessibles, ouvrez une console et tapez saga_cmd.

R. Creating R scripts¶

L’intégration de R est légèrement différente de celle de SAGA, dans la mesure où il n’y a pas d’ensemble prédéfini d’algorithmes à exécuter, hormis quelques exemples. Au lieu de cela, c’est à vous d’écrire les scripts à transmettre à R, comme vous le feriez depuis R. Un peu comme dans le chapitre sur les scripts. Ce chapitre va vous montrer comment appeler les commandes R à partir de QGIS et comment leur transmettre les objets QGIS (couches et tables).

La première chose à faire, comme nous l’avons vu pour SAGA, est de dire à QGIS où se situent les fichiers exécutables de R. Paramétrez l’entrée Répertoire R dans la fenêtre de configuration du module de traitements. Une fois cela fait, vous pouvez commencer à créer et exécuter vos propres scripts R.

Une fois encore, pour Linux, cela est légèrement différent : vous n’avez qu’à vérifier que le répertoire R est inclus dans la variable d’environnement PATH. Si vous pouvez lancer R en tapant R dans un terminal, alors vous êtes prêt pour la suite.

Pour ajouter un nouvel algorithme qui appelle une fonction R (ou un script R plus complexe que vous auriez développé et que vous souhaiteriez utiliser dans QGIS), vous devez créer un fichier de script qui va indiquer au module de traitements comment effectuer l’opération et les commandes R correspondantes.

Les fichiers de scripts R ont l’extension .rsx et leur création est relativement simple si vous connaissez la syntaxe et le langage de script de R. Ils seront sauvegardés dans le répertoire de scripts de R. Vous pouvez configurer ce répertoire dans le groupe de configuration de R (dans la fenêtre Options du module de traitements), comme vous le feriez pour un script ordinaire.

Voyons un simple script, qui appelle la méthode spsample de R, pour créer une grille aléatoire à l’intérieur de l’emprise d’un ensemble de polygones d’une couche donnée. Cette fonction appartient au paquet maptools. Comme la plupart des algorithmes que vous aurez à intégrer dans QGIS utilisent ou génèrent des données spatiales, la connaissance des paquets spatiaux comme maptools et surtout sp est un prérequis.

##polyg=vector
##numpoints=number 10
##output=output vector
##sp=group
pts=spsample(polyg,numpoints,type="random")
output=SpatialPointsDataFrame(pts, as.data.frame(pts))

Les premières lignes, qui commencent avec un double signe de commentaire Python (##), indiquent à QGIS les entrées de l’algorithme décrit dans le fichier ainsi que les sorties qu’il génère. Ces lignes fonctionnent exactement avec la même syntaxe que les scripts du module de Traitements que nous avons déjà étudiés et elles ne seront pas décrites davantage ici.

Merci de jeter un oeil sur les chapitres consacrés à l’Introduction à R et à la Syntaxe R pour avoir plus d’informations sur la manière d’écrire vos propres scripts R.

Quand vous déclarez un paramètre d’entrée, QGIS utilise cette information pour deux choses : créer le formulaire pour demander à l’utilisateur la valeur de ce paramètre et créer la variable R correspondante qui sera ensuite utilisée dans les commandes R.

Dans l’exemple ci-dessus, nous avons déclaré une entrée de type vecteur appelée polyg. A l’exécution de l’algorithme, QGIS ouvrira la couche sélectionnée par l’utilisateur dans R et la stockera dans une variable nommée polyg. Ainsi le nom du paramètre est également le nom de la variable à utiliser dans R pour accéder à son contenu (par conséquent, évitez d’utiliser des mots réservés R comme noms de paramètre).

Les éléments spatiaux telles que les couches vecteur et raster sont lues en utilisant les commandes readOGR() et brick() (n’ajoutez pas ces commandes à votre description de fichier – QGIS s’en chargera). Elles sont stockées en tant qu’objets Spatial*DataFrame. Les champs des tables sont stockés en tant que chaînes de caractères contenant le nom du champ sélectionné.

Les tables sont ouvertes par la commande read.csv(). Si la table à charger n’est pas au format CSV, il faudra la convertir avant de l’importer dans R.

De plus, les couches raster peuvent être lues avec la commande readGDAL() au lieu de brick(), en utilisant ##usereadgdal.

Si vous êtes un utilisateur expert et que vous ne voulez pas que QGIS crée l’objet correspondant à une couche, vous pouvez utiliser le paramètre ##passfilename qui indique que vous préférez une chaîne de caractères contenant le nom du fichier à la place. Dans ce cas, c’est à vous d’ouvrir le fichier au préalable.

Avec l’information ci-dessus, nous pouvons maintenant comprendre la première ligne de notre premier exemple de script (la première ligne qui n’est pas un commentaire Python).

pts=spsample(polyg,numpoints,type="random")

La variable polygon contient déjà un objet SpatialPolygonsDataFrame, l’appel de la méthode spsample est donc simple. Il en est de même pour la méthode numpoints qui renvoit le nombre de points à ajouter pour créer la grille.

Comme nous avons déclaré une sortie de type vecteur nommée out, nous devons créer cette variable out et lui affecter un objet Spatial*DataFrame (dans notre cas, un SpatialPointsDataFrame). Vous pouvez utiliser n’importe quel nom pour les variables intermédiaires. Assurez-vous simplement que la variable qui stocke la valeur finale ait le même nom que la variable de sortie définie au début ainsi qu’une valeur compatible.

Dans notre exemple, le résultat de la méthode spsample doit être converti explicitement en objet SpatialPointsDataFrame, dans la mesure où c’est un objet de la classe ppp qui ne peut être retransmis à QGIS.

Si votre algorithme génère des couches raster, la façon dont elles sont enregistrées varie selon que vous ayez utilisé l’option ##dontuserasterpackage ou pas. Si oui, les couches seront sauvegardées en utilisant la méthode writeGDAL(). Si non, la méthode writeRaster() du paquet raster sera utilisée.

Si vous avez utilisé l’option #passfilenames, les sorties sont générées à l’aide du package raster (avec writeRaster()), bien qu’il ne soit pas utilisé pour les entrées.

Si votre algorithme ne renvoie pas de couche mais plutôt un résultat texte dans la console, vous devez préciser que la console doit s’afficher à la fin de son exécution. Pour cela, commencez les lignes qui doivent renvoyer les résultats par le signe >. Les sorties des autres lignes seront masquées. Par exemple, voici la description d’un algorithme qui réalise un test de normalisation sur un champ donné (ou une colonne) de la table d’attributs d’une couche vectorielle :

##layer=vector
##field=field layer
##nortest=group
library(nortest)
>lillie.test(layer[[field]])

La sortie de la dernière ligne est affichée, mais la sortie de la première ne l’est pas (ni celles des commandes ajoutées automatiquement par QGIS).

Si votre algorithme crée des graphiques (par la méthode plot()), ajoutez la ligne suivante:

##showplots

Ceci va indiquer à QGIS de rediriger toutes les sorties graphiques de R vers un fichier temporaire qui sera chargé une fois l’exécution de R terminée.

Les graphiques et les résultats dans la console seront affichés dans le gestionnaire de résultats.

Pour plus d’informations, veuillez vous référer aux scripts fournis avec le module de Traitements. Tous sont relativement simples et pourront vous aider à construire vos propres scripts.

GRASS¶

Configuring GRASS is not much different from configuring SAGA. First, the path to the GRASS folder has to be defined, but only if you are running Windows. Additionally, a shell interpreter (usually msys.exe, which can be found in most GRASS for Windows distributions) has to be defined and its path set up as well.

By default, the processing framework tries to configure its GRASS connector to use the GRASS distribution that ships along with QGIS. This should work without problems in most systems, but if you experience problems, you might have to configure the GRASS connector manually. Also, if you want to use a different GRASS installation, you can change that setting and point to the folder where the other version is installed. GRASS 6.4 is needed for algorithms to work correctly.

Sous Linux, assurez-vous simplement que GRASS est correctement installé et qu’il peut être lancé depuis un terminal.

Les algorithmes GRASS nécessitent la définition d’une région. Cette région peut être définie manuellement, en fournissant les valeurs, comme pour la configuration de SAGA, ou de manière automatique, correspondant à l’emprise minimale des données d’entrée à l’exécution de l’algorithme. Si vous préférez ce dernier réglage, cochez l’option Utiliser l’emprise minimale dans les paramètres de configuration de GRASS.

GDAL¶

No additional configuration is needed to run GDAL algorithms. Since they are already incorporated into QGIS, the algorithms can infer their configuration from it.

Orfeo Toolbox¶

Orfeo Toolbox (OTB) algorithms can be run from QGIS if you have OTB installed in your system and you have configured QGIS properly, so it can find all necessary files (command-line tools and libraries).

As in the case of SAGA, OTB binaries are included in the stand-alone installer for Windows, but they are not included if you are running Linux, so you have to download and install the software yourself. Please check the OTB website for more information.

Once OTB is installed, start QGIS, open the processing configuration dialog and configure the OTB algorithm provider. In the Orfeo Toolbox (image analysis) block, you will find all settings related to OTB. First, ensure that algorithms are enabled.

Then, configure the path to the folder where OTB command-line tools and libraries are installed:

• Usually OTB applications folder points to /usr/lib/otb/applications and OTB command line tools folder is /usr/bin.
• If you use any of the installers that include OTB, such as OSGeo4W, there is no need for further configuration. Processing will detect the path automatically and will not show the corresponding configuration entries. Otherwise, fill the OTB applications folder and OTB command line tools folder parameters with the to the corresponding values for your installation.

TauDEM¶

TauDEM (Terrain Analysis Using Digital Elevation Models) is a tools for the extraction and analysis of hydrological information from Digital Elevation Models (DEM). TauDEM can be used from QGIS if you have it installed in your system and configured QGIS properly, so it can find all necessary files.

There are two versions of TauDEM tools: singlefile (TauDEM 5.0.6 or 5.1.2) and multifile (TauDEM 5.2.0). The difference between these versions in the supported inputs/outputs. Single files version accepts only single raster file and write single file as output. Multifile version accepts a directory with rasters and writes directory with rasters as output. Such directory should contain rasters that will be treated as a single DEM grid.

TauDEM Processing provider supports both single- and multifile versions of TauDEM and even allows to use them simultaneously.

mkdir build
cd build

CXX=mpicxx cmake -DCMAKE_INSTALL_PREFIX=/usr/local ..
make

sudo make install

#include "mpi.h"

#include <stdint.h>

#include "mpi.h"
#include <stdint.h>

#include <stdint.h>