.. grdcut:


pygmt.grdcut
=============


.. code::

	pygmt.grdcut(grid, \*, outgrid=None, region=None, projection=None,
	extend=None, circ_subregion=None, verbose=None, z_subregion=None,
	coltypes=None, \**kwargs)
	

Convertir la grille en table de données.

Lit une grille et génère des triplets xyz sous forme de fichier `numpy.ndarray`, `pandas.DataFrame` ou ASCII.

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.

* **projection** ( str ) – Sélectionnez la projection cartographique .

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

* **extend** ( bool ou int ou float ) – Autoriser l'extension de la grille si new `region` dépasse les limites existantes. Donnez une valeur pour initialiser les nœuds en dehors de la région actuelle.

* **circ_subregion** ( str ) – lon/lat/rayon [ unité ][ **+n** ]. Spécifiez une origine ( lon et lat ) et un rayon ; ajoutez une unité de distance et nous déterminons la région rectangulaire correspondante de sorte que tous les nœuds de la grille sur ou à l'intérieur du cercle soient contenus dans le sous-ensemble. Si **+n** est ajouté, nous définissons tous les nœuds en dehors du cercle sur NaN.

* **z_subregion** ( str ) – [ min/max ][ **+n | N | r** ]. Déterminez une nouvelle région rectangulaire de sorte que tous les nœuds en dehors de cette région soient également en dehors de la plage z donnée [-inf/+inf]. Pour indiquer aucune limite sur min ou max uniquement, spécifiez un trait d'union (-). Normalement, tous les NaN rencontrés sont simplement ignorés et ne sont pas pris en compte dans la décision de plage. Ajoutez **+n** pour considérer qu'un NaN est en dehors de la plage z donnée. Cela signifie que le nouveau sous-ensemble sera exempt de NaN. Sinon, ajoutez **+r** pour considérer que les NaN se situent dans la plage de données. Dans ce cas, nous arrêtons de réduire les limites une fois qu'un NaN est trouvé [par défaut, saute simplement NaN lors de la prise de décision de plage]. Enfin, si votre grille de sous-ensemble principal est entourée de lignes et/ou de colonnes qui sont toutes des NaN, ajoutez **+N** pour supprimer ces colonnes avant (éventuellement) de considérer la plage du sous-ensemble principal pour une réduction supplémentaire de la zone.

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

* **coltypes** ( str ) – [ **I** | **o** ] colinfo . Spécifiez les types de données des colonnes d'entrée et/ou de sortie (données temporelles ou géographiques).
	
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 from an input grid, with an x-range of 12 to 15,
	# and a y-range of 21 to 24
	new_grid = pygmt.grdcut(grid=grid, region=[12, 15, 21, 24])