# BD TOPO® Extractor - Documentation

## Pourquoi ?

Cet outil permet d'extraire les données de son choix de la BD TOPO® de l'IGN. Les données sont filtrées en fonction d'une emprise tracée par l'utilisateur sur le canevas de la carte ou en fonction de l'emprise d'une couche d'information géographique. Les donées dont issues du service WFS de l'IGN depuis la [Géoplateforme](https://www.ign.fr/geoplateforme).

## Comment ?

Seulement 4 étapes sont nécéssaires pour utiliser le BD TOPO® Extractor :

1. [Sélectionner une emprise pour filtrée les données à extraire.](https://plugin-bd-topo-extractor-220867.frama.io/usage/fr_how_to_use.html#selectionner-une-emprise)

1. [Sélectionner les données que l'on souhait extraire](https://plugin-bd-topo-extractor-220867.frama.io/usage/fr_how_to_use.html#selectionner-les-donnees-a-extraire)

1. [Séelectionner si l'on souhaite conserver les entités qui intersectent l'emprise ou si l'on coupe ces entités en fonction de l'emprise.](https://plugin-bd-topo-extractor-220867.frama.io/usage/fr_how_to_use.html#selectionner-le-fitrage-de-lemprise)

1. [Sélectionner si l'on souhaite sauvegarder le résultat ou non, et si c'est le cas, renseigner le dossier en sortie et le format de la donnée.](https://plugin-bd-topo-extractor-220867.frama.io/usage/fr_how_to_use.html#selectionner-le-format-en-sortie)

### Interface utilisateur

<p align="center">
  <img src="https://framagit.org/JulesGrillot/plugin_bd_topo_extractor/-/raw/main/bd_topo_extractor/resources/images/plugin_ui_fr.png?ref_type=heads" alt="user_interface"/>
</p>

### 1. Sélectionner une emprise

Il est possible :

- dessiner un rectangle sur la carte (par défaut)
- sélectionner une couche d'information géographique présente dans le projet et utilisé son emprise.

#### Choose your weapon

2 cases à cocher permettent de sélectionner la méthode de création de l'emprise pour l'extraction de données :

- `Utiliser une emprise tracée pour l'extraction :` si l'on souhaite utiliser une emprise déssinée. Puis il faut cliquer sur le bouton `Dessiner une emprise` et tracer un rectangle sur la cart.

- `Utiliser l'emprise d'une couche pour l'extraction :` si l'on souhaite utiliser l'emprise d'une couche de données géographiques. Il faut ensuite choisir la couche sur lequel sera basée l'emprise dans la liste déroulante.

#### Messages d'erreur

La couche sélectionne ou le rectangle déssinée est en dehors de l'emprise maximale des données WFS.

<p align="center">
  <img src="https://framagit.org/JulesGrillot/plugin_bd_topo_extractor/-/raw/main/bd_topo_extractor/resources/images/outside_wfs_error_fr.png?ref_type=heads" alt="outside_wfs_error"/>
</p>

L'emprise sélectionnée est trop grande, le traitement peut prendre un temps conséquent.

<p align="center">
  <img src="https://framagit.org/JulesGrillot/plugin_bd_topo_extractor/-/raw/main/bd_topo_extractor/resources/images/extent_too_big_error_fr.png?ref_type=heads" alt="extent_too_big_error"/>
</p>

### 2. Sélectionner les données à extraire

Toutes les données du WFS sont listées dans la partie centrale de l'interface utilisateur. Il est soit possible de télécharger toutes les données en cochant la case `Extraire toutes les données de la BD TOPO®` ou de sélectionner uniquement les données que l'on souhaite télécharger en cochant leur case respective.

### 3. Sélectionner le fitrage de l'emprise

Il est possible d'extraire toutes les entités qui intersectent l'emprise sélectionnée (par défaut) en cochant la case `Conserver les données intersectant l'emprise` ou de découper les entités en fonction de l'emprise en cochant la case `Découper les données intersectant l'emprise`.

### 4. Sélectionner le format en sortie

#### Sauvegarder le résultat dans une couche temporaire

Si l'on ne souhaite pas sauvegarder les données extraites dans un fichier (par défaut), il est seulement nécéssaire de sélectionner le système de projection en sortie.

#### Sauvergarder le résultat

Si l'on souhaite sauvegarder les données dans un fichier il faut :

- sélectionner le système de projection en sortie avec la liste déroulant
- cocher la case `Enregistrer le résultat :`.
- sélectionner si l'on souhaite ajouter les données exportées au projet (par défaut) ou non.
- sélectionner le format du fichier, `GeoPackage` (par défaut), `Shapefile` ou `GeoJSon`.
- sélectionner le dossier en sortie pour enregistrer les données dans un dossier appelé `BDTopoExport_yyyymmdd_HHMM`.

Si le format GeoPackage est sélectionné, seulement un seul fichier contenant toutes les données sera crée dans le dossier.

### Lancer l'extraction

L'extraction débute quand le bouton `OK` est préssé.

## Outils supplémentaires

En cliquant sur le bouton IGN, une redirection vers leur site est effectué. En cliquant sur le bouton `Documentation`, une redirection vers cette page est effectué. En cliquant sur le bouton `Metadata`, une redirection vers la page de description de la BD TOPO®. Un fond de carte OpenStreetMAp est automatiquement ajouté au projet si il n'y a aucune couche d'information géographique présente.