pygmt.grdvolume¶

pygmt.grdvolume(grid, output_type='pandas', outfile=None, \*,
contour=None, region=None, unit=None, verbose=None, \**kwargs)

Déterminer le volume entre la surface d’une grille et un plan.

Lire un fichier de grille 2D et calculer le volume contenu sous la surface et au-dessus du plan spécifié par le contour donné (ou zéro s’il n’est pas donné) et renvoyer le contour, l’aire, le volume et la hauteur moyenne maximale (volume/aire). Alternativement, une plage de contours peut être spécifiée pour renvoyer le volume et la surface à l’intérieur du contour pour toutes les valeurs de contour.

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.
output_type ( str ) – Déterminez le format dans lequel les données de sortie seront renvoyées [La valeur par défaut est pandas] :
- numpy - numpy.ndarray
- pandas - pandas.DataFrame
- file - Fichier ASCII (nécessite outfile)
outfile ( str ) – Le nom de fichier pour le fichier ASCII de sortie.
contour ( str ou int ou float ou list ) – cval | bas/élevé/delta | r faible/élevé | r cval . Trouvez l’aire, le volume et la hauteur moyenne (volume/aire) à l’intérieur et au-dessus du contour cval . Alternativement, recherchez en utilisant tous les contours de bas en haut par pas de delta . [La valeur par défaut renvoie la surface, le volume et la hauteur moyenne de toute la grille]. La surface est mesurée dans le plan du contour. L’ajout du préfixe r calcule le volume sous la surface de la grille et au-dessus des plans définis par lowet haut , ou en dessous de cval et du minimum de la grille. Notez qu’il s’agit d’un volume extérieur tandis que les autres formes calculent un volume de surface intérieur (sous la surface). Utilisez ce formulaire pour calculer par exemple le volume d’eau entre deux contours. Si aucun contour n’est donné, il n’y a pas de contour et toute la zone de la grille, le volume et la hauteur moyenne sont renvoyés et cval sera signalé comme 0.
région ( str ou liste ) – xmin/xmax/ymin/ymax [ +r ][ +u unité ]. Spécifiez la région d’intérêt.
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 ( pandas.DataFrame ou numpy.ndarray ou None ) – Le type de retour dépend de outfile et output_type:
- Aucun si outfile est défini (la sortie sera stockée dans le fichier défini par outfile)
- pandas.DataFrame ou numpy.ndarray si outfile n’est pas défini (dépend de output_type [La valeur par défaut est pandas.DataFrame])

Exemple¶

import pygmt
# Load a grid of @earth_relief_30m data, with an x-range of 10 to 30
# degrees, and a y-range of 15 to 25 degrees
grid = pygmt.datasets.load_earth_relief(
    resolution="30m", region=[10, 30, 15, 25]
)
# Create a pandas dataframe that contains the contour, area, volume,
# and maximum mean height above the plane specified by the given
# contour and below the surface; set the minimum contour z-value to
# 200, the maximum to 400, and the interval to 50.
output_dataframe = pygmt.grdvolume(
    grid=grid, contour=[200, 400, 50], output_type="pandas"
)
print(output_dataframe)
    0             1             2           3
0  200  2.318187e+12  8.533727e+14  368.120722
1  250  2.272471e+12  7.383936e+14  324.929840
2  300  2.162074e+12  6.273066e+14  290.141086
3  350  2.018302e+12  5.222640e+14  258.764032
4  400  1.857370e+12  4.252699e+14  228.963499