xrspatial.multispectral.ndvi#

xrspatial.multispectral.ndvi(nir_agg: xarray.core.dataarray.DataArray, red_agg: xarray.core.dataarray.DataArray, name='ndvi')[source]#

Computes Normalized Difference Vegetation Index (NDVI). Used to determine if a cell contains live green vegetation.

Parameters
  • nir_agg (xr.DataArray) – 2D array of near-infrared band data.

  • red_agg (xr.DataArray) – 2D array red band data.

  • name (str default='ndvi') – Name of output DataArray.

Returns

ndvi_agg – 2D array of ndvi values. All other input attributes are preserved.

Return type

xarray.DataArray of same type as inputs

References

Examples

>>> y1, x1, y2, x2 = 100, 100, 103, 104
>>> print(nir[y1:y2, x1:x2].data)
[[1519. 1504. 1530. 1589.]
 [1491. 1473. 1542. 1609.]
 [1479. 1461. 1592. 1653.]]
>>> print(red[y1:y2, x1:x2].data)
[[1327. 1329. 1363. 1392.]
 [1309. 1331. 1423. 1424.]
 [1293. 1337. 1455. 1414.]]
>>> print(ndvi_agg[y1:y2, x1:x2].data)
[[0.06746311 0.06177197 0.05772555 0.0660852 ]
 [0.065      0.05064194 0.04013491 0.06099571]
 [0.06709956 0.04431737 0.04496226 0.07792632]]