xclim.indicators.seaIce package¶
Submodules¶
xclim.indicators.seaIce._seaice module¶
Sea ice indicator definitions.
- xclim.indicators.seaIce._seaice.sea_ice_area(siconc='siconc', areacello='areacello', *, thresh='15 %', ds=None)
Sea ice area
A measure of total ocean surface covered by sea ice.
Based on function
sea_ice_area().- Parameters:
siconc (str or DataArray) – Sea ice concentration (area fraction). Default: ‘siconc’. [Required units : []]
areacello (str or DataArray) – Grid cell area (usually over the ocean). Default: ‘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 %’. [Required units : []]
ds (Dataset, optional) – A dataset with the variables given by name. Default: None.
- Returns:
xarray.DataArray, [m2] – sea_ice_area, Sum of ice-covered areas where sea ice concentration exceeds {thresh}. With additional attributes: description:
The sum of ice-covered areas where sea ice concentration exceeds {thresh}., cell_methods:lon: sum lat: sum- 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 %', ds=None)
Sea ice extent
A measure of the extent of all areas where sea ice concentration exceeds a threshold.
Based on function
sea_ice_extent().- Parameters:
siconc (str or DataArray) – Sea ice concentration (area fraction). Default: ‘siconc’. [Required units : []]
areacello (str or DataArray) – Grid cell area. Default: ‘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 %’. [Required units : []]
ds (Dataset, optional) – A dataset with the variables given by name. Default: None.
- Returns:
xarray.DataArray, [m2] – sea_ice_extent, Sum of ocean areas where sea ice concentration exceeds {thresh}. With additional attributes: description:
The sum of ocean areas where sea ice concentration exceeds {thresh}., cell_methods:lon: sum lat: sum- 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]