.. grdinfo:


pygmt.grdinfo
=============


.. code::

	pygmt.grdinfo(grid, \*, per_column=None, tiles=None, geographic=None,
	spacing=None, force_scan=None, minmax_pos=None, region=None,
	nearest_multiple=None, verbose=None, coltypes=None, \**kwargs)
	

Obtenir des informations sur une grille.

Peut lire des grilles à partir d'un fichier ou donnée sous forme de grille `xarray.DataArray`.



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

* **region** ( chaîne ou liste ) – xmin/xmax/ymin/ymax [ **+r** ][ **+u** unité ]. Spécifiez la région d'intérêt.

* **per_column** ( str ou bool ) – **n | t** . Mettez en forme le rapport en utilisant des champs séparés par des tabulations sur une seule ligne. La sortie est nom wesn z0 z1 dx dy nx ny [ x0 y0 x1 y1 ] [ med scale ] [ mean std rms ] [ n_nan ] registration gtype . Les données entre parenthèses sont sorties en fonction des paramètres `force_scan` et `minmax_pos`. Utilisez **t** pour placer le nom du fichier à la fin de l'enregistrement de sortie ou, **n** ou `True` pour ne sortir que des colonnes numériques. L'enregistrement est soit 0 (gridline) soit 1 (pixel), tandis que gtype est soit 0 (cartésien) soit 1 (géographique). La valeur par défaut est `False`. Cela ne peut pas être appelé si geographicest également défini.

* **tiles** ( str ou liste ) – xoff [/ yoff ][ **+i** ]. Divisez le domaine d'une grille unique (ou le `region` domaine, si aucune grille n'est donnée) en tuiles de taille dx fois dy (défini via `spacing`). Vous pouvez spécifier le chevauchement entre les tuiles en ajoutant xoff [/ yoff ]. Si la grille unique est donnée, vous pouvez utiliser le modificateur **+i** pour ignorer les tuiles qui n'ont pas de données dans chaque sous-région de tuiles. La sortie par défaut est des chaînes de région de texte. Utilisez `per_column` à la place pour signaler quatre colonnes avec xmin xmax ymin ymax par vignette, ou utilisez `per_column="t"` pour également ajouter la chaîne de région en tant que texte de fin.

* **geographic** ( bool ) – Indique le domaine de la grille et les incréments x/y au format de mappage mondial. La valeur par défaut est `False`. Cela ne peut pas être appelé si `per_column` est également défini.

* **spacing** ( str ) – [ **b | p | f | s** ] dx [/ dy [/ dz …]]. Calculez les valeurs min/max des n premières colonnes au multiple le plus proche des incréments fournis [la valeur par défaut est 2 colonnes]. Par défaut, les résultats de sortie sont sous la forme , sauf si est défini, auquel cas nous publions chaque valeur min et max dans des colonnes de sortie séparées. `[w, e, s, n]` `per_column`

* **force_scan** ( int ou str ) – **0 | 1 | 2 | p | a** .
	- **0** : rapporte la plage de z après avoir effectivement scanné les données, pas seulement en rapportant ce que dit l'en-tête.
	- **1** : rapporter la médiane et l'échelle L1 de z (échelle L1 = 1,4826 * écart absolu médian (MAD)).
	- **2** : Indiquez la moyenne, l'écart type et la moyenne quadratique (rms) de z.
	- **p** : mode de rapport (LMS) et échelle LMS de z.
	- **a** : Incluez tout ce qui précède.

* **minmax_pos** ( bool ) – Inclut les valeurs x/y à l'emplacement des valeurs z minimales et maximales.

* **nearest_multiple** ( str ) – [ dz ][ **+a** [ alpha ]][ **+s** ]. Déterminez les valeurs z minimales et maximales. Si dz est fourni, nous arrondissons d'abord ces valeurs à des multiples de dz . Pour exclure les deux queues de la distribution lors de la détermination du minimum et du maximum, vous pouvez ajouter **+a** pour définir la valeur alpha (en pourcentage) : nous trions ensuite la grille, excluons les données dans les queues 0,5* alpha et 100 - 0,5* alpha , et réviser le minimum et le maximum. Pour forcer une plage symétrique autour de zéro, en utilisant moins/plus la valeur absolue maximale des deux extrêmes, ajoutez **+s**. Nous rapportons le résultat via la chaîne de texte zmin/zmax ou zmin/zmax/dz (si dz a été donné) comme prévu par `pygmt.makecpt`.

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

**info** ( str ) – Une chaîne contenant des informations sur la grille.

Exemple
-------

.. code ::
	
	chemin_fichier = "chemin/de/ton/fichier.grd"
	pygmt.grdinfo(grid=chemin_fichier, per_column=True)