Skip to content

Add Dataset.plot.quiver #4373

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.

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

Closed
dcherian opened this issue Aug 25, 2020 · 0 comments · Fixed by #4407
Closed

Add Dataset.plot.quiver #4373

dcherian opened this issue Aug 25, 2020 · 0 comments · Fixed by #4407

Comments

@dcherian
Copy link
Contributor

I think it would be nice to add a quiver plot function. I got this far in my current project:

@xarray.plot.dataset_plot._dsplot
def quiver(ds, x, y, ax, u, v, **kwargs):
    from xarray import broadcast

    if x is None or y is None or u is None or v is None:
        raise ValueError("Must specify x, y, u, v for quiver plots.")

    # matplotlib autoscaling algorithm
    scale = kwargs.pop("scale", None)
    if scale is None:
        npts = ds.dims[x] * ds.dims[y]
        # crude auto-scaling
        # scale is typical arrow length as a multiple of the arrow width
        scale = (
            1.8 * ds.to_array().median().values * np.maximum(10, np.sqrt(npts))
        )  # / span

    ds = ds.squeeze()
    x, y, u, v = broadcast(ds[x], ds[y], ds[u], ds[v])

    # no support for these kwargs right now.
    kwargs.pop("cmap_params")
    kwargs.pop("hue")
    kwargs.pop("hue_style")
    hdl = ax.quiver(x.values, y.values, u.values, v.values, scale=scale, **kwargs)

    return hdl

The autoscaling logic is quite crude; I tried to copy what matplotlib does but got somewhat confused. To get faceting to work properly, we'll need to estimate scale around here:

cmap_params, cbar_kwargs = _process_cmap_cbar_kwargs(
func, self.data[hue].values, **kwargs
)
kwargs["meta_data"]["cmap_params"] = cmap_params
kwargs["meta_data"]["cbar_kwargs"] = cbar_kwargs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants