pygmt.grdvolume

pygmt.grdvolume(grid, data_format='a', **kwargs)[source]

Aliases:

  • C = plane

  • Cr = outside_volume

  • D = slice

  • R = region

  • S = unit

  • V = verbose

Parameters

  • grid (str or xarray.DataArray) – The file name of the input grid or the grid loaded as a DataArray. This is the only required parameter.

  • region (str or list) – Required if this is the first plot command. xmin/xmax/ymin/ymax[+r][+uunit]. Specify the region of interest.

  • verbose (bool or str) –

    Select verbosity level [Default is w], which modulates the messages written to stderr. Choose among 7 levels of verbosity:

    • q - Quiet, not even fatal error messages are produced

    • e - Error messages only

    • w - Warnings [Default]

    • t - Timings (report runtimes for time-intensive algorithms);

    • i - Informational messages (same as verbose=True)

    • c - Compatibility warnings

    • d - Debugging messages

Returns

volume (str) – A string with the volume between the surface and specified plane.