xclim.indicators.seaIce package¶
Submodules¶
xclim.indicators.seaIce._seaice module¶
Sea ice indicators¶
- xclim.indicators.seaIce._seaice.sea_ice_area(siconc='siconc', areacello='areacello', *, thresh='15 pct', ds=None)
Sea ice area (realm: seaIce)
A measure of total ocean surface covered by sea ice.
This indicator will check for missing values according to the method “skip”. Based on indice
sea_ice_area()
. Keywords : seaice.- Parameters:
siconc (str or DataArray) – Sea ice concentration (area fraction). Default : ds.siconc. [Required units : []]
areacello (str or DataArray) – Grid cell area (usually over the ocean). Default : ds.areacello. [Required units : [area]]
thresh (quantity (string or DataArray, with units)) – Minimum sea ice concentration for a grid cell to contribute to the sea ice extent. Default : 15 pct. [Required units : []]
ds (Dataset, optional) – A dataset with the variables given by name. Default : None.
- Returns:
sea_ice_area (DataArray) – Sum of ice-covered areas where sea ice concentration exceeds {thresh} (sea_ice_area) [m2], with additional attributes: cell_methods: lon: sum lat: sum; description: The sum of ice-covered areas where sea ice concentration exceeds {thresh}.
- Return type:
xarray.DataArray
Notes
To compute sea ice area over a subregion, first mask or subset the input sea ice concentration data.
References
“What is the difference between sea ice area and extent?” - NSIDC [2008]
- xclim.indicators.seaIce._seaice.sea_ice_extent(siconc='siconc', areacello='areacello', *, thresh='15 pct', ds=None)
Sea ice extent (realm: seaIce)
A measure of the extent of all areas where sea ice concentration exceeds a threshold.
This indicator will check for missing values according to the method “skip”. Based on indice
sea_ice_extent()
. Keywords : seaice.- Parameters:
siconc (str or DataArray) – Sea ice concentration (area fraction). Default : ds.siconc. [Required units : []]
areacello (str or DataArray) – Grid cell area. Default : ds.areacello. [Required units : [area]]
thresh (quantity (string or DataArray, with units)) – Minimum sea ice concentration for a grid cell to contribute to the sea ice extent. Default : 15 pct. [Required units : []]
ds (Dataset, optional) – A dataset with the variables given by name. Default : None.
- Returns:
sea_ice_extent (DataArray) – Sum of ocean areas where sea ice concentration exceeds {thresh} (sea_ice_extent) [m2], with additional attributes: cell_methods: lon: sum lat: sum; description: The sum of ocean areas where sea ice concentration exceeds {thresh}.
- Return type:
xarray.DataArray
Notes
To compute sea ice area over a subregion, first mask or subset the input sea ice concentration data.
References
“What is the difference between sea ice area and extent?” - NSIDC [2008]