xarray.Dataset.regridder.horizontal#
- Dataset.regridder.horizontal(data_var, output_grid, tool='xesmf', **options)#
Transform
data_var
tooutput_grid
.When might
Regrid2
be preferred overxESMF
?If performing conservative regridding from a high/medium resolution lat/lon grid to a coarse lat/lon target,
Regrid2
may provide better results as it assumes grid cells with constant latitudes and longitudes whilexESMF
assumes the cells are connected by Great Circles [1].Supported tools, methods and grids:
- xESMF (https://xesmf.readthedocs.io/en/latest/)
Methods: Bilinear, Conservative, Conservative Normed, Patch, Nearest s2d, or Nearest d2s.
Grids: Rectilinear, or Curvilinear.
Find options at
xcdat.regridder.xesmf.XESMFRegridder()
- Regrid2
Methods: Conservative
Grids: Rectilinear
Find options at
xcdat.regridder.regrid2.Regrid2Regridder()
- Parameters:
data_var (
str
) – Name of the variable to transform.output_grid (
xr.Dataset
) – Grid to transformdata_var
to.tool (
str
) – Name of the tool to use.**options (
Any
) – These options are passed directly to thetool
. See specific regridder for available options.
- Returns:
xr.Dataset
– With thedata_var
transformed to theoutput_grid
.- Raises:
ValueError – If tool is not supported.
References
Examples
Import xCDAT:
>>> import xcdat
Open a dataset:
>>> ds = xcdat.open_dataset("...")
Create output grid:
>>> output_grid = xcdat.create_uniform_grid(-90, 90, 4.0, -180, 180, 5.0)
Regrid variable using “xesmf”:
>>> output_data = ds.regridder.horizontal("ts", output_grid, tool="xesmf", method="bilinear")
Regrid variable using “regrid2”:
>>> output_data = ds.regridder.horizontal("ts", output_grid, tool="regrid2")