uxarray.UxDataArray.remap.bilinear

uxarray.UxDataArray.remap.bilinear#

UxDataArray.remap.bilinear(destination_grid, remap_to='faces', backend='uxarray', yac_method='average', yac_options=None, **kwargs)#

Perform bilinear remapping.

Parameters:
  • destination_grid (Grid) – Destination Grid for remapping

  • remap_to ({'nodes', 'edges', 'faces'}, default='faces') – Which grid element receives the remapped values.

  • backend ({'uxarray', 'yac'}, default='uxarray') – Remapping backend to use. When set to ‘yac’, bilinear remapping is routed through YAC’s average interpolation.

  • yac_method ({'average'}, optional) – YAC interpolation method for the bilinear convenience wrapper. Only 'average' is supported here.

  • yac_options (dict, optional) – YAC interpolation configuration options for the average method.

Returns:

A new object with data mapped onto destination_grid.

Return type:

UxDataArray or UxDataset