docs: update documentation for smoothed maps

riatelab · Aug 28, 2024 · 0cccba8 · 0cccba8
1 parent 6efcb37
commit 0cccba8
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 0 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -2,6 +2,10 @@
 
 <br />
 
+#### Unreleased
+
+- Nouvelle fonctionnalité permettant de choisir une variable pour le numérateur et pour le dénominateur lors de la création de cartes lissées (Corrige <a href="https://github.com/riatelab/magrit/issues/135">135</a>).
+
 #### 2.0.8 (2024-08-27)
 
 - Correction de la valeur affichée pour les barres d'échelles (Corrige <a href="https://github.com/riatelab/magrit/issues/137">137</a>).

diff --git a/docs/en/changelog.md b/docs/en/changelog.md
@@ -2,6 +2,10 @@
 
 <br />
 
+#### Unreleased
+
+- New functionality to select numerator / denominator for smoothed maps (Fixes <a href=“https://github.com/riatelab/magrit/issues/135”>135</a>)
+
 #### 2.0.8 (2024-08-27)
 
 - Corrected the value displayed for scale bars (Fixes <a href=“https://github.com/riatelab/magrit/issues/137”>137</a>).

diff --git a/docs/en/functionalities/smoothed-map.md b/docs/en/functionalities/smoothed-map.md
@@ -11,6 +11,30 @@ The two proposed smoothing methods are:
 - Stewart potential,
 - Kernel Density Estimation (KDE).
 
+## Parameters
+
+When creating a layer of this type, the following parameters must be entered:
+
+- The variable to be used,
+- Weight variable / divisor (optional),
+- Smoothing type (Stewart or KDE),
+- Grid resolution in kilometers,
+- The type of kernel among :
+    - Gaussian or pareto (for Stewart potentials),
+    - Gaussian, uniform or triangular (for KDEs),
+- Smoothing range in kilometers and beta (for Stewart potentials),
+- Kernel bandwidth in kilometers (for KDEs).
+
+These parameters are used to calculate the density values of the phenomenon at each point of the calculation grid, taking into account the values of neighboring points.
+Once these have been calculated, it is necessary to choose threshold values to define the density classes to be represented, in the form of
+choropleth map.
+
+Here you need to choose :
+- Class boundaries,
+- The name of the resulting layer.
+
+## Example
+
 <ZoomImg
     src="/smoothed-stewart-pop.png"
     alt="Population potential in a Gaussian neighborhood of 20 km (Stewart method - population data for French communes)"

diff --git a/docs/functionalities/smoothed-map.md b/docs/functionalities/smoothed-map.md
@@ -11,6 +11,29 @@ Les deux méthodes de lissage proposées sont :
 - Potentiel de Stewart,
 - Estimation de densité par noyaux (*Kernel Density Estimation* ou KDE).
 
+
+## Paramètres
+
+Lors de la création d'une couche de ce type, il est nécessaire de renseigner les paramètres suivants :
+
+- La variable à utiliser,
+- La variable de poids / le diviseur (optionnelle),
+- Le type de lissage (Stewart ou KDE),
+- La résolution de la grille de calcul en kilomètres,
+- Le type de noyau parmi :
+  - Gaussien ou pareto (pour les potentiels de Stewart),
+  - Gaussien, uniforme ou triangulaire (pour les KDE),
+- La portée du lissage en kilomètres et le beta (pour les potentiels de Stewart),
+- La portée du noyau en kilomètres (pour les KDE).
+
+Ces paramètres permettent de calculer les valeurs de densité du phénomène à chaque point de la grille de calcul, en prenant en compte les valeurs des points voisins.
+Une fois celles-ci calculées, il est nécessaire de choisir des valeurs de seuil pour définir les classes de densité à représenter, sous forme
+d'une carte choroplèthe.
+
+Il faut donc choisir ici :
+- Les limites de classes,
+- Le nom de la couche résultante.
+
 ## Exemple
 
 <ZoomImg