.. grdhisteq.equalize_grid:


pygmt.grdhisteq.equalize_grid
=============================


.. code::

	statiquegrdhisteq. equalize_grid ( grid , * , outgrid = None , 
	divisions = None , region = None , gaussian = None , quadratic = None ,
	verbose = None )
	
Effectuer une égalisation d'histogramme pour une grille.

`pygmt.grdhisteq.equalize_grid` fournit un moyen d'écrire une grille avec des statistiques basées sur une fonction de distribution cumulative. Le `outgrid` présente des hauts et des bas relatifs aux mêmes emplacements (x,y) que le `grid`, mais les valeurs sont modifiées pour refléter leur place dans la distribution cumulative.

Paramètre
---------

* **grid** ( str ou xarray.DataArray ) – Le nom de fichier de la grille d'entrée ou de la grille chargée en tant que xarray.DataArray. C'est le seul paramètre obligatoire.

* **outgrid** ( str ou None ) – Le nom du fichier netCDF de sortie avec l'extension .nc dans lequel stocker la grille.

* **divisions** ( int ) – Définissez le nombre de divisions de la plage de données.

* **gaussian** ( bool ou int ou float ) – norm . Produisez une grille de sortie avec des scores normaux standard en utilisant gaussian=Trueou en forçant les scores à tomber dans la plage ± norm .

* **quadratic** ( bool ) – Effectue une égalisation quadratique [la valeur par défaut est linéaire].

* **région** ( str ou liste ) – xmin/xmax/ymin/ymax [ **+r** ][ **+u** unité ]. Spécifiez la région d'intérêt. L'ajout `region` sélectionnera une sous-section de la grille. Si cette sous-section dépasse les limites de la grille, seule la région commune sera sortie.

* **verbose** ( bool ou str ) – Sélectionnez le niveau de verbosité [la valeur par défaut est w ], qui module les messages écrits sur stderr. Choisissez parmi 7 niveaux de verbosité :
	- **q** - Des messages d'erreur silencieux, même fatals, ne sont pas générés
	- **e** - Messages d'erreur uniquement
	- **w** - Avertissements [par défaut]
	- **t** - Timings (temps d'exécution des rapports pour les algorithmes chronophages)
	- **i** - Messages d'information (comme `verbose=True`)
	- **c** - Avertissements de compatibilité
	- **d** - Messages de débogage


Retour
------

* **ret** ( xarray.DataArray ou None ) – Le type de retour dépend si le `outgrid` paramètre est défini :
	- `xarray.DataArray` si `outgrid` n'est pas défini
	- Aucun si `outgrid` est défini (la sortie de la grille sera stockée dans le fichier défini par `outgrid`)



Exemple
-------

.. code ::

	import pygmt
	# Load a grid of @earth_relief_30m data, with an x-range of 10 to
	# 30, and a y-range of 15 to 25
	grid = pygmt.datasets.load_earth_relief(
	    resolution="30m", region=[10, 30, 15, 25]
	)
	# Create a new grid with a Gaussian data distribution
	grid = pygmt.grdhisteq.equalize_grid(grid=grid, gaussian=True)