pyinterp.backends.xarray.Grid3D#

class pyinterp.backends.xarray.Grid3D(data_array: xarray.core.dataarray.DataArray, increasing_axes: bool = False, geodetic: bool = True)[source]#

Bases: pyinterp.grid.Grid3D

Builds a Grid3D from the Xarray data provided.

Parameters
  • data_array – Provided data array

  • increasing_axes – If this is true, check that the grid axes are increasing: the decreasing axes and the supplied grid will be flipped. Default to False.

  • geodetic

    True, if the axes of the grid represent longitudes and latitudes. In this case, the constructor will try to determine the axes of longitudes and latitudes according to the value of the attribute units using the following algorithm:

    • if the axis unit is one of the values of the set degrees_east, degree_east, degree_E, degrees_E, degreeE or degreesE the axis represents a longitude,

    • if the axis unit is one of the values of the set degrees_north, degree_north, degree_N, degrees_N or degreesN the axis represents a latitude.

    If this option is false, the axes will be considered Cartesian. Default to True.

Raises
  • ValueError – if the provided data array doesn’t define a longitude/latitude axis if geodetic is True.

  • ValueError – if the number of dimensions is different of 3.

Attributes

array

Gets the values handled by this instance.

x

Gets the X-Axis handled by this instance.

y

Gets the Y-Axis handled by this instance.

z

Gets the Z-Axis handled by this instance.

Public Methods

bicubic(coords, *args, **kwargs)

Evaluate the interpolation defined for the given coordinates.

trivariate(coords, *args, **kwargs)

Evaluate the interpolation defined for the given coordinates.