.. grdclip:


pygmt.grdclip
=============


.. code::

	pygmt.grdclip(grid, \*, outgrid=None, region=None, above=None, below=None,
	between=None, new=None, verbose=None, \**kwargs)

Définissez les valeurs d'une grille qui répondent à certains critères sur une nouvelle valeur.

Produire un extrait `outgrid` ou `xarray.DataArray` une version du `grid` fichier d'entrée.

Les paramètres `above` et `below` permettent de définir une valeur donnée pour les valeurs supérieures ou inférieures à un montant défini, respectivement. Cela permet aux valeurs extrêmes d'une grille, telles que les points en dessous d'une certaine profondeur lors du tracé du relief de la Terre, d'être toutes définies sur la même valeur.


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.


* **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.

* **above** ( str ou liste ou tuple ) – [ haut , au-dessus ]. Définissez toutes les données[i] > high sur above .

* **below** ( str ou liste ou tuple ) – [ bas , ci-dessous ]. Définissez toutes les données [i] < bas à ci-dessous .

* **between** ( chaîne ou liste ou tuple ) – [ bas , haut , entre ]. Définissez toutes les données[ i ] >= low et <= high entre .

* **new** ( str ou list ou tuple ) – [ old , new ]. Définissez toutes les données[i] == old sur new . Ceci est surtout utile lorsque vos données sont connues pour être des valeurs entières.

* **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]
	)
	# Report the minimum and maximum data values
	[grid.data.min(), grid.data.max()]
	[170.0, 2275.5]
	# Create a new grid from an input grid. Set all values below 1,000 to
	# 0 and all values above 1,500 to 10,000
	new_grid = pygmt.grdclip(
	    grid=grid, below=[1000, 0], above=[1500, 10000]
	)
	# Report the minimum and maximum data values
	[new_grid.data.min(), new_grid.data.max()]
	[0.0, 10000.0]