Skip to content

pygmt.blockmean/blockmedian/blockmode: Add the center parameter (-C) #4780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seisman merged 2 commits into from
Aug 1, 2026
+18 −0
Merged

pygmt.blockmean/blockmedian/blockmode: Add the center parameter (-C) #4780

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3debefb
Add center parameter to block module functions
Aayush7788 Jul 30, 2026
d4b7063
Remove redundant alias tests
Aayush7788 Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions pygmt/src/blockm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ def blockmean(
z=None,
output_type: Literal["pandas", "numpy", "file"] = "pandas",
outfile: PathLike | None = None,
center: bool = False,
spacing: Sequence[float | str] | None = None,
region: Sequence[float | str] | str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
Expand All @@ -112,6 +113,7 @@ def blockmean(
Full GMT docs at :gmt-docs:`blockmean.html`.

$aliases
- C = center
- I = spacing
- R = region
- V = verbose
Expand All @@ -129,6 +131,9 @@ def blockmean(
Arrays of x and y coordinates and values z of the data points.
$output_type
$outfile
center
Use the center of each block as the output location. By default, the
mean x and y coordinates are used.
$spacing
summary : str
[**m**\|\ **n**\|\ **s**\|\ **w**].
Expand Down Expand Up @@ -170,6 +175,7 @@ def blockmean(
>>> data_bmean = pygmt.blockmean(data=data, region=[245, 255, 20, 30], spacing="5m")
"""
aliasdict = AliasSystem(
C=Alias(center, name="center"),
I=Alias(spacing, name="spacing", sep="/", size=2),
).add_common(
R=region,
Expand Down Expand Up @@ -203,6 +209,7 @@ def blockmedian(
z=None,
output_type: Literal["pandas", "numpy", "file"] = "pandas",
outfile: PathLike | None = None,
center: bool = False,
spacing: Sequence[float | str] | None = None,
region: Sequence[float | str] | str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
Expand All @@ -227,6 +234,7 @@ def blockmedian(
Full GMT docs at :gmt-docs:`blockmedian.html`.

$aliases
- C = center
- I = spacing
- R = region
- V = verbose
Expand All @@ -244,6 +252,9 @@ def blockmedian(
Arrays of x and y coordinates and values z of the data points.
$output_type
$outfile
center
Use the center of each block as the output location. By default, the
median x and median y coordinates are used.
$spacing
$region
$verbose
Expand Down Expand Up @@ -279,6 +290,7 @@ def blockmedian(
... )
"""
aliasdict = AliasSystem(
C=Alias(center, name="center"),
I=Alias(spacing, name="spacing", sep="/", size=2),
).add_common(
R=region,
Expand Down Expand Up @@ -318,6 +330,7 @@ def blockmode(
z=None,
output_type: Literal["pandas", "numpy", "file"] = "pandas",
outfile: PathLike | None = None,
center: bool = False,
spacing: Sequence[float | str] | None = None,
region: Sequence[float | str] | str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
Expand All @@ -342,6 +355,7 @@ def blockmode(
Full GMT docs at :gmt-docs:`blockmode.html`.

$aliases
- C = center
- I = spacing
- R = region
- V = verbose
Expand All @@ -359,6 +373,9 @@ def blockmode(
Arrays of x and y coordinates and values z of the data points.
$output_type
$outfile
center
Use the center of each block as the output location. By default, the
modal x and y coordinates are used.
$spacing
$region
$verbose
Expand Down Expand Up @@ -392,6 +409,7 @@ def blockmode(
>>> data_bmode = pygmt.blockmode(data=data, region=[245, 255, 20, 30], spacing="5m")
"""
aliasdict = AliasSystem(
C=Alias(center, name="center"),
I=Alias(spacing, name="spacing", sep="/", size=2),
).add_common(
R=region,
Expand Down
Loading