xarray.DataArray.integrate

DataArray.integrate(self, dim: Union[Hashable, Sequence[Hashable]], datetime_unit: str = None) → 'DataArray'

integrate the array with the trapezoidal rule.

Note

This feature is limited to simple cartesian geometry, i.e. dim must be one dimensional.

Parameters
  • dim (hashable, or a sequence of hashable) – Coordinate(s) used for the integration.

  • datetime_unit (str, optional) – Can be used to specify the unit if datetime coordinate is used. One of {‘Y’, ‘M’, ‘W’, ‘D’, ‘h’, ‘m’, ‘s’, ‘ms’, ‘us’, ‘ns’, ‘ps’, ‘fs’, ‘as’}

Returns

integrated

Return type

DataArray

See also

numpy.trapz()

corresponding numpy function

Examples

>>> da = xr.DataArray(
...     np.arange(12).reshape(4, 3),
...     dims=["x", "y"],
...     coords={"x": [0, 0.1, 1.1, 1.2]},
... )
>>> da
<xarray.DataArray (x: 4, y: 3)>
array([[ 0,  1,  2],
       [ 3,  4,  5],
       [ 6,  7,  8],
       [ 9, 10, 11]])
Coordinates:
  * x        (x) float64 0.0 0.1 1.1 1.2
Dimensions without coordinates: y
>>>
>>> da.integrate("x")
<xarray.DataArray (y: 3)>
array([5.4, 6.6, 7.8])
Dimensions without coordinates: y