deafrica_tools.bandindices

Fonctions de calcul des indices de bande de télédétection sur les données de Digital Earth Africa.

Fonctions

calculate_indices(ds[, index, collection, ...])

Prend un ensemble de données xarray contenant des bandes spectrales, calcule l'un d'un ensemble d'indices de télédétection et ajoute le tableau résultant en tant que nouvelle variable dans l'ensemble de données d'origine.

dualpol_indices(ds[, co_pol, cross_pol, ...])

Prend un ensemble de données xarray contenant une rétrodiffusion radar à double polarisation, calcule un ou un ensemble d'indices et ajoute le tableau résultant en tant que nouvelle variable dans l'ensemble de données d'origine.
deafrica_tools.bandindices.calculate_indices(ds: xarray.Dataset, index: str | list[str] = None, collection: str = None, satellite_mission: str = None, custom_varname: str = None, normalise: bool = True, drop: bool = False, deep_copy: bool = True) → xarray.Dataset

Prend un ensemble de données xarray contenant des bandes spectrales, calcule l’un d’un ensemble d’indices de télédétection et ajoute le tableau résultant en tant que nouvelle variable dans l’ensemble de données d’origine.

Dernière modification : juillet 2022

Paramètres:

  • ds (xarray Dataset) – Un tableau bidimensionnel ou multidimensionnel contenant les bandes spectrales nécessaires au calcul de l’indice. Ces bandes sont utilisées comme entrées pour calculer l’indice d’eau sélectionné.

  • index (str or list of strs) – Une chaîne donnant le nom de l’indice à calculer ou une liste de chaînes donnant les noms des indices à calculer : * 'ASI' (Indice de surface artificielle, Yongquan Zhao & Zhe Zhu 2022) * 'AWEI_ns' (Indice d’extraction d’eau automatisée, sans ombres, Feyisa 2014) * 'AWEI_sh' (Indice d’extraction d’eau automatisée, ombres, Feyisa 2014) * 'BAEI' (Indice d’extraction de surface construite, Bouzekri et al. 2015) * 'BAI' (Indice de surface brûlée, Martin 1998) * 'BSI' (Indice de sol nu, Rikimaru et al. 2002) * 'BUI' (Indice de surface construite, He et al. 2010) * 'CMR' (rapport des minéraux argileux, Drury 1987) * 'ENDISI' (indice de différence normalisée améliorée pour les surfaces imperméables, Chen et al. 2019) * 'EVI' (indice de végétation amélioré, Huete 2002) * 'FMR' (rapport des minéraux ferreux, Segal 1982) * 'IOR' (rapport d’oxyde de fer, Segal 1982) * 'LAI' (indice de surface foliaire, Boegh 2002) * 'MBI' (indice de sol nu modifié, Nguyen et al. 2021) * 'MNDWI' (indice d’eau par différence normalisée modifié, Xu 1996) * 'MSAVI' (indice de végétation ajusté au sol modifié, Qi et al. 1994) * 'NBI' (New Built-Up Index, Jieli et al. 2010) * 'NBR' (Normalised Burn Ratio, Lopez Garcia 1991) * 'NDBI' (Normalised Difference Built-Up Index, Zha 2003) * 'NDCI' (Normalised Difference Chlorophyll Index, Mishra & Mishra, 2012) * 'NDMI' (Normalised Difference Moisture Index, Gao 1996) * 'NDSI' (Normalised Difference Snow Index, Hall 1995) * 'NDTI' (Normalised Difference Turbidity Index, Lacaux et al. 2007) * 'NDVI' (Normalised Difference Vegetation Index, Rouse 1973) * 'NDWI' (indice d’eau par différence normalisée, McFeeters 1996) * 'SAVI' (indice de végétation ajusté au sol, Huete 1988) * 'TCB' (luminosité du cap en forme de gland, Crist 1985) * 'TCG' (verdure du cap en forme de gland, Crist 1985) * 'TCW' (humidité du cap en forme de gland, Crist 1985) * 'WI' (indice d’eau, Fisher 2016)

  • collection (str) – Obsolète dans la version 0.1.7. Utilisez plutôt satellite_mission. Les options valides sont : * 'c2' (pour USGS Landsat Collection 2) Si “c2”, alors satellite_mission=”ls”. * 's2' (pour Sentinel-2) Si “s2”, alors satellite_mission=”s2”.

  • satellite_mission (str) – Une chaîne qui indique à la fonction les données de la mission satellite utilisées pour calculer l’indice. Cela est nécessaire car différentes missions satellites utilisent des noms différents pour les bandes couvrant un spectre similaire. Les options valides sont : * 'ls' (pour USGS Landsat) * 's2' (pour Copernicus Sentinel-2)

  • custom_varname (str, optional) – Par défaut, l’ensemble de données d’origine sera renvoyé avec une nouvelle variable d’index nommée d’après index (par exemple, “NDVI”). Pour spécifier un nom personnalisé à la place, vous pouvez fournir par exemple custom_varname=”custom_name”. La valeur par défaut est None, qui utilise index pour nommer la variable.

  • normalise (bool, optional) – Certains indices basés sur des coefficients (par exemple, « WI », « BAEI », « AWEI_ns », « AWEI_sh », « TCW », « TCG », « TCB », « EVI », « LAI », « SAVI », « MSAVI ») produisent des résultats différents si les valeurs de réflectance de surface ne sont pas mises à l’échelle entre 0,0 et 1,0 avant le calcul de l’indice. Le réglage de « normalise=True » met d’abord les valeurs à l’échelle dans une plage de 0,0 à 1,0 en divisant par 10 000,0. La valeur par défaut est True.

  • drop (bool, optional) – Fournit la possibilité de supprimer les données d’entrée d’origine, économisant ainsi de l’espace. Si drop=True, renvoie uniquement l’index et ses valeurs.

  • deep_copy (bool, optional) – Si deep_copy=False, calculate_indices modifiera le tableau d’origine, en ajoutant des bandes à l’ensemble de données d’entrée et sans les supprimer. Si la fonction calculate_indices est exécutée plusieurs fois, des variables peuvent être supprimées de manière incorrecte, ce qui produit un comportement inattendu. Il s’agit d’un bug qui pourra être corrigé dans les prochaines versions. Ce n’est un problème que lorsque drop=True.

Renvoie:

ds – Le jeu de données xarray d’origine entré dans la fonction, avec une nouvelle variable contenant l’index de télédétection sous forme de DataArray. Si drop = True, la/les nouvelle(s) variable(s) sous forme de DataArrays dans le jeu de données d’origine.

Type renvoyé:

xarray Dataset

deafrica_tools.bandindices.dualpol_indices(ds: xarray.Dataset, co_pol: str = 'vv', cross_pol: str = 'vh', index: str | list[str] = None, custom_varname: str = None, drop: bool = False, deep_copy: bool = True) → xarray.Dataset

Prend un ensemble de données xarray contenant une rétrodiffusion radar à double polarisation, calcule un ou un ensemble d’indices et ajoute le tableau résultant en tant que nouvelle variable dans l’ensemble de données d’origine.

Dernière modification : juillet 2021

Paramètres:

  • ds (xarray Dataset) – Un réseau bidimensionnel ou multidimensionnel contenant les deux bandes de polarisation.

  • co_pol (str) – Nom de mesure pour la bande de copolarisation. La valeur par défaut est « vv » pour Sentinel-1.

  • cross_pol (str) – Nom de mesure pour la bande de polarisation croisée. La valeur par défaut est « vh » pour Sentinel-1.

  • index (str or list of strs) – Une chaîne donnant le nom de l’indice à calculer ou une liste de chaînes donnant les noms des indices à calculer : * 'RVI' (Radar Vegetation Index for dual-pol, Trudel et al. 2012; Nasirzadehdizaji et al., 2019; Gururaj et al., 2019) * 'VDDPI' (Vertical dual depolarization index, Periasamy 2018) * 'theta' (pseudo scattering-type, Bhogapurapu et al. 2021) * 'entropy' (pseudo scattering entropy, Bhogapurapu et al. 2021) * 'purity' (co-pol purete, Bhogapurapu et al. 2021) * 'ratio' (cross-pol/co-pol) rapport)

  • custom_varname (str, optional) – Par défaut, l’ensemble de données d’origine sera renvoyé avec une nouvelle variable d’index nommée d’après index (par exemple “RVI”). Pour spécifier un nom personnalisé à la place, vous pouvez fournir par exemple custom_varname=”custom_name”. La valeur par défaut est None, qui utilise index pour nommer la variable.

  • drop (bool, optional) – Fournit la possibilité de supprimer les données d’entrée d’origine, économisant ainsi de l’espace. Si drop=True, renvoie uniquement l’index et ses valeurs.

  • deep_copy (bool, optional) – Si deep_copy=False, calculate_indices modifiera le tableau d’origine, en ajoutant des bandes à l’ensemble de données d’entrée et sans les supprimer. Si la fonction calculate_indices est exécutée plusieurs fois, des variables peuvent être supprimées de manière incorrecte, ce qui produit un comportement inattendu. Il s’agit d’un bug qui pourra être corrigé dans les prochaines versions. Ce n’est un problème que lorsque drop=True.

Renvoie:

ds – Le jeu de données xarray d’origine entré dans la fonction, avec une nouvelle variable contenant l’index de télédétection sous forme de DataArray. Si drop = True, la/les nouvelle(s) variable(s) sous forme de DataArrays dans le jeu de données d’origine.

Type renvoyé:

xarray Dataset