pygmt.blockmean

pygmt.blockmean(table, outfile=None, **kwargs)[source]

Block average (x,y,z) data tables by mean estimation.

Reads arbitrarily located (x,y,z) triples [or optionally weighted quadruples (x,y,z,w)] from a table and writes to the output a mean position and value for every non-empty block in a grid region defined by the region and spacing parameters.

Full option list at https://docs.generic-mapping-tools.org/latest/blockmean.html

Aliases:

  • I = spacing

  • R = region

  • V = verbose

  • a = aspatial

  • f = coltypes

  • r = registration

Parameters

  • table (pandas.DataFrame or str) – Either a pandas dataframe with (x, y, z) or (longitude, latitude, elevation) values in the first three columns, or a file name to an ASCII data table.

  • spacing (str) – xinc[unit][+e|n] [/yinc[unit][+e|n]]. xinc [and optionally yinc] is the grid spacing.

  • region (str or list) – xmin/xmax/ymin/ymax[+r][+uunit]. Specify the region of interest.

  • outfile (str) – Required if table is a file. The file name for the output ASCII file.

  • 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

  • aspatial (str) – [col=]name[,…]. Control how aspatial data are handled during input and output. Full documentation is at https://docs.generic-mapping-tools.org/latest/gmt.html#aspatial-full.

  • coltypes (str) – [i|o]colinfo. Specify data types of input and/or output columns (time or geographical data). Full documentation is at https://docs.generic-mapping-tools.org/latest/gmt.html#f-full.

  • registration (str) – g|p. Force gridline (g) or pixel (p) node registration. [Default is g(ridline)].

Returns

output (pandas.DataFrame or None) – Return type depends on whether the outfile parameter is set:

  • pandas.DataFrame table with (x, y, z) columns if outfile is not set

  • None if outfile is set (filtered output will be stored in file set by outfile)