Proposal: Support explicit mesh coordinates in `xarray.plot.pcolormesh`
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- matplotlib, numpy, python
- Ambito
- data-visualization
Direzione di ricerca
Inizia dal punto di ingresso xarray.plot.pcolormesh e verifica come la relativa logica infer_intervals gestisce gli array di coordinate. Definisci l’API e i test per x_edges/y_edges 1D e 2D, assicurandoti che i bordi espliciti bypassino l’inferenza e vengano passati a Matplotlib, mantenendo invariato il comportamento esistente delle etichette e di FacetGrid.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Hi @dcherian @jhamman, @kmuehlbauer
I would like to open a PR to address a current limitation in xarray.plot.pcolormesh regarding the correct display of:
- Irregular 1D grids (non-uniform bin spacing)
- Curvilinear 2D grids (e.g., distorted or geophysical meshes)
Other linked issues:
- https://github.com/pydata/xarray/issues/792
- https://github.com/pydata/xarray/issues/4364
- https://github.com/pydata/xarray/issues/5901
Problem
xarray.plot.pcolormesh assumes that coordinates represent cell centers and internally reconstructs edges (infer_intervals=True logic).
This leads to incorrect rendering when:
- Grid spacing is irregular
- True cell boundaries are known and should be respected
- The grid is curvilinear and defined by 2D vertex coordinates
Such grids are common in many domains:
- Numerical Weather Prediction (NWP) model grids
- Satellite swath data
- Radar products
- Ocean and climate model outputs
- ...
This limitation significantly impacts accurate scientific and cartographic visualization.
Current Workaround
A workaround exists: directly calling matplotlib.pyplot.pcolormesh with explicit edge arrays.
However, this comes with significant drawbacks:
- Loss of
xarray’s high-level plotting API - Loss of automatic labeling and metadata handling
- Loss of
FacetGridsupport (e.g., faceting over time or ensemble dimensions) - More verbose code
In practice, this makes advanced visualization workflows much harder, especially when working with multi-dimensional datasets.
Describe the solution you'd like
I propose adding support for explicitly passing edge coordinates to pcolormesh, following the matplotlib.pyplot.pcolormesh(..., shading="flat") convention.
1D Case
x_edges: shape(n+1,)y_edges: shape(m+1,)
2D Curvilinear Case
x_edges: shape(m+1, n+1)y_edges: shape(m+1, n+1)
When provided, these edge coordinates would:
- Bypass edge inference
- Be passed directly to Matplotlib
- Ensure geometrically correct rendering
I suggest therefore to introduce x_edges and y_edges keyword arguments to pcolormesh
da.pcolormesh(..., x_edges=..., y_edges=...)
Under this approach:
xandymust still be specified- If
x_edges/y_edgesare provided, edge inference is skipped - The edges /mesh arrays are passed directly to Matplotlib
Before starting work on the PR, I would appreciate your feedback on:
- Whether you are in favor of adding this capability
- Preferred API design direction
- Any architectural considerations to keep in mind
Minimal, reproducible example of the problem
import numpy as np
import xarray as xr
import matplotlib.pyplot as plt
####-----------------------------------------------------------------
#### Rectilinear grid (1D case)
# Regular edges
x_edges = np.arange(0, 4) # 4 edges
y_edges = np.arange(6, 9) # 3 edges
# Irregular edges
x_edges = np.array([0, 1, 4, 10]) # 4 edges
y_edges = np.array([30, 50, 100]) # 3 edges
# Plot limits
xlim = x_edges.min(), x_edges.max()
ylim = y_edges.min(), y_edges.max()
# Compute centers
x_centers = 0.5 * (x_edges[:-1] + x_edges[1:])
y_centers = 0.5 * (y_edges[:-1] + y_edges[1:])
# Create 2D data
Xc, Yc = np.meshgrid(x_centers, y_centers)
data = np.sin(Xc/2) * np.cos(Yc/5)
# Build Dataset
ds = xr.Dataset(
{
"data": (("y", "x"), data)
},
coords={
"x": x_centers,
"y": y_centers,
}
)
####-----------------------------------------------------------------
#### Curvilinear grid (2D case)
# Create 2D irregular edges from your 1D irregular edge
x_edges, y_edges = np.meshgrid(x_edges, y_edges)
# Add distortion (to make geometry clearly non-rectangular)
x_edges = x_edges + 0.8 * np.sin(y_edges / 40)
y_edges = y_edges + 3.0 * np.cos(x_edges / 5)
# Compute cell centers from corner average
Xc2 = 0.25 * (
x_edges[:-1, :-1] +
x_edges[1:, :-1] +
x_edges[:-1, 1:] +
x_edges[1:, 1:]
)
Yc2 = 0.25 * (
y_edges[:-1, :-1] +
y_edges[1:, :-1] +
y_edges[:-1, 1:] +
y_edges[1:, 1:]
)
data2 = np.sin(Xc2/2) * np.cos(Yc2/5)
ds = xr.Dataset(
{
"data": (("y", "x"), data2)
},
coords={
"x": (("y", "x"), Xc2),
"y": (("y", "x"), Yc2),
}
)
# Plot limits from true edges
xlim = x_edges.min(), x_edges.max()
ylim = y_edges.min(), y_edges.max()
#--------------------------------------------------------------------
#### XARRAY PCOLORMESH PLOTTING IS CURRENTLY WRONG
p = ds["data"].plot.pcolormesh(x="x", y="y", add_colorbar=False)
p.axes.set_title("")
p.axes.set_xlabel("")
p.axes.set_ylabel("")
p.axes.set_xlim(*xlim)
p.axes.set_ylim(*ylim)
#--------------------------------------------------------------------
#### PLOT CORRECTLY WITH MATPLOTLIB PCOLORMESH
fig, ax = plt.subplots(1,1)
ax.pcolormesh(x_edges, y_edges, data)
p.axes.set_title("")
p.axes.set_xlabel("")
p.axes.set_ylabel("")
p.axes.set_xlim(*xlim)
p.axes.set_ylim(*ylim)
- Lingua principale
- Python
- Stelle
- 4.2k
- Fork
- 1.5k
- Merge medio
- 2g 21h
- PR unite (30g)
- 74
Preparare l'ambiente
Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di pydata/xarray
-
xarray removes axis grid from pcolormeshForse già presa @Sealdot l’ha presa oggi. Apertabug needs triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
I maintainer di solito rispondono entro 1 giorno
-
`DataTree.map_over_datasets` behavior can be obscure sometimesForse già presa @mohansree14 l’ha presa 24 giorni fa. Apertaneeds triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
pydata/xarray#11813 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Comparing attrs that contain a dict of NumPy arrays raises ValueError in identical / assert_identicalForse già presa @SohamXYZDev l’ha presa 29 giorni fa. Apertabug needs triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 73/100
pydata/xarray#11777 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
RangeIndex` with datetime64 bounds cannot be printed (`Unknown format code 'g'`)Forse già presa @d-chambers l’ha presa 60 giorni fa. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
pydata/xarray#11598 · 3 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
DataTree constructor error message says dict even though dict is not acceptedForse già presa @aryansk l’ha presa 100 giorni fa. Apertabug contrib-good-first-issue topic-DataTree topic-error reporting
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
pydata/xarray#11514 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di pydata/xarray
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
abetlen/llama-cpp-python#2424 ·
I maintainer di solito rispondono entro 1 giorno
-
Bug IronPython Python 3
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
pyrevitlabs/pyRevit#4184 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 74/100
jqueryscript/awesome-claude-code#1009 ·
-
tests
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
I maintainer di solito rispondono entro 3 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno