Resample a grid to a new spacing, region, and/or registration. Method of resampling
depends on comparison with initial and supplied values for spacing, region, and
registration. If initial values not supplied, will try and extract them from the
grid.
initial_spacing (float | None, optional) â spacing of input grid, if known, by default None
initial_region (tuple[float, float, float, float] | None, optional) â region of input grid, if known, in format [xmin, xmax, ymin, ymax] by default
None
initial_registration (str | None, optional) â registration of input grid, if known, by default None
spacing (float | None, optional) â new spacing for grid, by default None
region (tuple[float, float, float, float] | None, optional) â new region for grid in format [xmin, xmax, ymin, ymax], by default None
registration (str | None, optional) â new registration for grid, by default None
Either pulls login details from pre-set environment variables, or prompts user to
input username and password. Will persist the entered details within the python
session.
Ice-sheet height and thickness changes from ICESat to ICESat-2 for both Antarctica
and Greenland from Smith et al.[5].
Choose a version of the data to download with the format: âICESHEET_VERSION_TYPEâ
where ICESHEET is âaisâ or âgrisâ, for Antarctica or Greenland, VERSION is âdhdtâ
for total thickness change or âdmdtâ for corrected for firn-air content. For
Antarctic data, TYPE is âfloatingâ or âgroundedâ.
add â_filtâ to retrieve a filtered version of the data for some versions.
version (str, optional,) â choose which version to retrieve, by default is âais_dhdt_groundedâ for
Antarctica and âgris_dhdtâ for Greenland.
hemisphere (str, optional) â choose which hemisphere to retrieve data for, ânorthâ or âsouthâ, by default
None
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (float, optional,) â grid spacing to resample the loaded grid to, by default is 5km
registration (str, optional) â change registration with either âpâ for pixel or âgâ for gridline registration,
by default is âpâ.
kwargs (Any) â additional keyword arguments to pass to resample_grid
Returns:
Returns a grid of Antarctic or Greenland ice mass change in meters/year.
version (str) â choose which version to load, either âw_bâ for basal melt rate, âw_b_interpâ,
for basal melt rate with interpolated values, and âw_b_uncertâ for uncertainty
version (str) â choose which version to load, either âmaxâ for maximum buttressing, âminâ for
minimum buttressing, âflowâ for along-flow buttressing, or âviscosityâ for
estimated ice viscosity values
Requires an EarthData login, see Tutorials/Download Polar datasets for how to
configure this.
Parameters:
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (float, optional,) â grid spacing to resample the loaded grid to, by default is 5km for Antarctica
(original data is 450m), and 250m for Greenland
registration (str, optional) â change registration with either âpâ for pixel or âgâ for gridline registration,
by default is None.
hemisphere (str, optional) â choose which hemisphere to retrieve data for, ânorthâ or âsouthâ, by default
None
kwargs (Any) â additional keyword arguments to pass to resample_grid
Returns:
Returns a calculated grid of ice velocity in meters/year.
Requires an EarthData login, see Tutorials/Download Polar datasets for how to
configure this.
Parameters:
version (str, optional) â for Antarctica, choose between â750mâ or â125mâ resolutions, by default â750mâ,
for Greenland, choose between â500mâ or â100mâ resolutions, by default â500mâ
hemisphere (str, optional) â choose which hemisphere to retrieve data for, ânorthâ or âsouthâ, by default
None
version (str, optional) â choose which version to retrieve, âfaultsâ, âunitsâ, âsourcesâ, or âqualityâ,
by default âfaultsâ
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
Requires an EarthData login, see Tutorials/Download Polar datasets for how to
configure this.
Parameters:
version (str,) â choose which file to retrieve from the following list:
âCoastlineâ, âBasins_Antarcticaâ, âBasins_IMBIEâ, âIceBoundariesâ, âIceShelfâ,
âMaskâ
version (str,) â choose which version of data to fetch.
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (str or int, optional) â grid spacing to resample the loaded grid to, by default 10e3
registration (str, optional) â change registration with either âpâ for pixel or âgâ for gridline registration,
by default is None.
**kwargs (Any) â additional keyword arguments to pass to the resample_grid function
Returns:
Returns a loaded, and optional clip/resampled grid of sediment thickness.
Load IBCSO v2 data, from Dorschel et al.[1] and
Dorschel et al.[26].
Parameters:
region (tuple[float, float, float, float] or None) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
Returns:
Returns two geodataframes; points and polygons for a subset of IBCSO v2 point
measurement locations. Column âdataset_tidâ is the type identifier from IBCSO.
The points geodataframe contains all individual point measurements, including
single-beam (TID 10), seismic points (TID 12), isolated soundings (TID 13),
ENC sounding (TID 14), grounded iceberg draft (TID 46), and gravity-inverted
bathymetry (TID 45). The polygon geodataframe contains all polygon measurements,
including multi-beam (swath) (TID 11), contours from charts (TID 42), or
other unknown sources (TID 71).
Load IBCSO v2 data, from Dorschel et al.[1] and
Dorschel et al.[26].
By default the elevations are relative to Mean Sea Level (the geoid). To convert
them to be relative to the WGS84 ellipsoid, set reference=âellipsoid which will
add the EIGEN-6C4 geoid anomaly.
Parameters:
layer (str) â choose which layer to fetch:
âsurfaceâ, âbedâ
reference (str, optional) â choose which vertical reference to use, âgeoidâ or âellipsoidâ, by default
âgeoidâ
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (str or int, optional) â grid spacing to resample the loaded grid to, by default 500 m
registration (str, optional) â change registration with either âpâ for pixel or âgâ for gridline registration,
by default is None.
**kwargs (Any) â additional keyword arguments to pass to the resample_grid function
Returns:
Returns a loaded, and optional clip/resampled grid of IBCSO data.
Referenced to the EIGEN-6C4 geoid. To convert to be ellipsoid-referenced, we add
the geoid grid. use reference=âellipsoidâ to include this conversion in the
fetch call.
For Antarctica: Surface and ice thickness are in ice equivalents. Actual snow
surface is from REMA [2], and has had firn thickness
added(?) to it to get Bedmachine Surface.
To get snow surface: surface+firn
To get firn and ice thickness: thickness+firn
Here, icebase will return a grid of surface-thickness
This should be the same as snow-surface - (firn and ice thickness)
Requires an EarthData login, see Tutorials/Download Polar datasets for how to
configure this.
Parameters:
layer (str) â choose which layer to fetch:
âbedâ, âdataidâ, âerrbedâ, âfirnâ, âgeoidâ, âmaskâ, âsourceâ,
âsurfaceâ, âthicknessâ; âicebaseâ will give results of surface-thickness
reference (str) â choose whether heights are referenced to âeigen-6c4â geoid or the
âellipsoidâ (WGS84), by default is eigen-6c4â
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (str or int, optional) â grid spacing to resample the loaded grid to, by default 500m
registration (str, optional) â change registration with either âpâ for pixel or âgâ for gridline registration,
by default is None.
hemisphere (str, optional) â choose which hemisphere to retrieve data for, ânorthâ or âsouthâ, by default
None
**kwargs (Any) â additional keyword arguments to pass to the resample_grid function
Returns:
Returns a loaded, and optional clip/resampled grid of Bedmachine.
version (str) â choose between âbedmap1â, âbedmap2â, âbedmap3â, or âallâ, point data
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
All grids are by default referenced to the EIGEN-GL04C geoid. Use the
reference=âellipsoidâ to convert to the WGS-84 ellipsoid or reference=âeigen-6c4â to
convert to the EIGEN-6c4 geoid.
Unlike Bedmachine data, Bedmap2 surface and icethickness contain NaNâs over the
ocean, instead of 0âs. To fill these NaNâs with 0âs, set fill_nans=True.
Note, this only makes since if the reference is the geoid, therefore, if
reference=âellipsoid and fill_nans=True, the nanâs will be filled before
converting the results to the geoid (just for surface, since thickness isnât
relative to anything).
Parameters:
layer (str) â choose which layer to fetch:
âsurfaceâ, âicebaseâ, âbedâ, âice_thicknessâ, âwater_thicknessâ,
âbed_uncertaintyâ, âice_thickness_uncertaintyâ, and âmaskâ.
reference (str) â choose whether heights are referenced to the âeigen-6c4â geoid, the WGS84
ellipsoid, âellipsoidâ, or by default the âeigen-gl04câ geoid.
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (str or int, optional) â grid spacing to resample the loaded grid to, by default 10e3
registration (str, optional,) â choose between âgâ (gridline) or âpâ (pixel) registration types, by default is
the original type of the grid
fill_nans (bool, optional,) â choose whether to fill nans in âsurfaceâ and âthicknessâ with 0. If converting
to reference to the geoid, will fill nanâs before conversion, by default is
False
**kwargs (optional) â additional keyword arguments to pass to the resample_grid function
Returns:
Returns a loaded, and optional clip/resampled grid of Bedmap2.
All grids are by default referenced to the EIGEN-GL04C geoid. Use the
reference=âellipsoidâ to convert to the WGS-84 ellipsoid or reference=âeigen-6c4â to
convert to the EIGEN-6c4 geoid.
Unlike Bedmachine data, Bedmap2 surface and icethickness contain NaNâs over the
ocean, instead of 0âs. To fill these NaNâs with 0âs, set fill_nans=True.
Note, this only makes since if the reference is the geoid, therefore, if
reference=âellipsoid and fill_nans=True, the nanâs will be filled before
converting the results to the geoid (just for surface, since thickness isnât
relative to anything).
Parameters:
layer (str) â choose which layer to fetch:
âbedâ, âcoverageâ, âgrounded_bed_uncertaintyâ, âicemask_grounded_and_shelvesâ,
âlakemask_vostokâ, ârockmaskâ, âsurfaceâ, âthicknessâ,
âthickness_uncertainty_5kmâ, âgl04c_geiod_to_WGS84â, âicebaseâ,
âwater_thicknessâ
reference (str) â choose whether heights are referenced to the âeigen-6c4â geoid, the WGS84
ellipsoid, âellipsoidâ, or by default the âeigen-gl04câ geoid.
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (str or int, optional) â grid spacing to resample the loaded grid to, by default 10e3
registration (str, optional,) â choose between âgâ (gridline) or âpâ (pixel) registration types, by default is
the original type of the grid
fill_nans (bool, optional,) â choose whether to fill nans in âsurfaceâ and âthicknessâ with 0. If converting
to reference to the geoid, will fill nanâs before conversion, by default is
False
**kwargs (optional) â additional keyword arguments to pass to the resample_grid function
Returns:
Returns a loaded, and optional clip/resampled grid of Bedmap2.
Load the REMA surface elevation data from Howat et al.[2]. The data
are in EPSG3031 and reference to the WGS84 ellipsoid. To convert the data to be
geoid-referenced, subtract a geoid model, which you can get from fetch.geoid().
Choose between â1kmâ or â500mâ resolutions with parameter version.
version (str, optional,) â choose which resolution to fetch, either â1kmâ or â500mâ, by default is â1kmâ
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (str or int, optional) â grid spacing to resample the loaded grid to, by default 10e3
registration (str, optional,) â choose between âgâ (gridline) or âpâ (pixel) registration types, by default is
the original type of the grid
**kwargs (optional) â additional keyword arguments to pass to the resample_grid function
Returns:
Returns a loaded, and optional clip/resampled grid of the REMA DEM.
Load DeepBedMap data, from Leong and Horgan[3] and
Leong and Horgan[32].
Parameters:
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (str or int, optional) â grid spacing to resample the loaded grid to, by default 10e3
registration (str, optional) â change registration with either âpâ for pixel or âgâ for gridline registration,
by default is None.
**kwargs (optional) â additional keyword arguments to pass to the resample_grid function
Loads gravity anomaly data for the Arctic and Antarctic.
version=âantggâ
Antarctic-wide gravity data compilation of ground-based, airborne, and shipborne
data, from Scheinert et al.[33].
Accessed from https://doi.pangaea.de/10.1594/PANGAEA.848168
Anomalies are at the ice surface, or bedrock surface in areas of no ice. These
surfaces are defined by Bedmap2 and are relative to the ellipsoid.
version=âantgg-2021â
Updates on 2016 AntGG compilation.
Accessed from https://doi.pangaea.de/10.1594/PANGAEA.971238?format=html#download
Anomalies are at the ice surface, or bedrock surface in areas of no ice. These
surfaces are defined by Bedmap2 and are relative to the ellipsoid.
version (str) â choose which version of gravity data to fetch.
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (str or int, optional) â grid spacing to resample the loaded grid to, by default 10e3
registration (str, optional) â change registration with either âpâ for pixel or âgâ for gridline registration,
by default is None.
hemisphere (str, optional) â choose which hemisphere to retrieve data for, ânorthâ or âsouthâ, by default
None
kwargs (Any) â additional kwargs to pass to resample_grid and set the anomaly_type.
Keyword Arguments:
anomaly_type (str) â either âFAâ or âBAâ, for free-air and bouguer anomalies, respectively. For
antgg-update can also be âDGâ for gravity disturbance, or âErrâ for error
estimates.
Returns:
Returns a loaded, and optional clip/resampled grid of either observed, free-air
or Bouguer gravity anomalies.
Loads a grid of Antarctic topography from ETOPO1 from ETOPO1 1 Arc-Minute Global Relief Model: Procedures, Data Sources and Analysis[4].
Originally at 10 arc-min resolution, reference to mean sea-level (geoid).
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (str or int, optional) â grid spacing to resample the loaded grid to, by default 10e3
registration (str, optional) â change registration with either âpâ for pixel or âgâ for gridline registration,
by default is None.
hemisphere (str, optional) â choose which hemisphere to retrieve data for, ânorthâ or âsouthâ, by default
None
**kwargs (optional) â additional keyword arguments to pass to the resample_grid function
Returns:
Returns a loaded, and optional clip/resampled grid of topography.
Loads a grid of Antarctic geoid heights derived from the EIGEN-6C4 from
Förste et al.[34] spherical harmonic model of Earthâs gravity field.
Originally at 10 arc-min resolution.
Negative values indicate the geoid is below the ellipsoid surface and vice-versa.
To convert a topographic grid which is referenced to the ellipsoid to be referenced
to the geoid, add this grid.
To convert a topographic grid which is referenced to the geoid to be referencde to
the ellipsoid, add this grid.
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (str or int, optional) â grid spacing to resample the loaded grid to, by default 10e3
registration (str, optional) â change registration with either âpâ for pixel or âgâ for gridline registration,
by default is None.
hemisphere (str, optional) â choose which hemisphere to retrieve data for, ânorthâ or âsouthâ, by default
None
kwargs (Any) â additional kwargs to pass to resample_grid.
Returns:
Returns a loaded, and optional clip/resampled grid of geoid height.
version (str) â Either âadmap1â, âadmap2â, âadmap2_gdbâ or âLCS-1â.
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (str or int, optional) â grid spacing to resample the loaded grid to, by default 10e3
registration (str, optional,) â choose between âgâ (gridline) or âpâ (pixel) registration types, by default is
the original type of the grid
hemisphere (str, optional) â choose which hemisphere to retrieve data for, ânorthâ or âsouthâ, by default
None
kwargs (Any) â key word arguments to pass to resample_grid.
Returns:
Returns a loaded, and optional clip/resampled grid of magnetic anomalies.
version=âburton-johnson-2020â
From Burton-Johnson et al.[43].
Accessed from supplementary material
Choose for either of grid, or the point measurements
version (str) â Either âburton-johnson-2020â, âlosing-ebbing-2021â, âaq1â,
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (int, optional) â grid spacing to resample the loaded grid to, by default spacing is read from
downloaded files
registration (str, optional) â change registration with either âpâ for pixel or âgâ for gridline registration,
by default is None.
kwargs (Any) â if version=âburton-johnson-2020â, then kwargs are passed to return point
measurements instead of the grid.
**kwargs (Any) â additional keyword arguments to pass to the resample_grid function
Returns:
Returns a loaded, and optional clip/resampled grid of GHF data.
Load 1 of 1 âversionsâ of Antarctic glacial isostatic adjustment grids.
version=âstal-2020â
From StÄl et al.[48] and StÄl et al.[49].
Parameters:
version (str) â For now the only option is âstal-2020â,
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (int, optional) â grid spacing to resample the loaded grid to, by default spacing is read from
downloaded files
registration (str, optional) â change registration with either âpâ for pixel or âgâ for gridline registration,
by default is None.
**kwargs (Any) â additional keyword arguments to pass to the resample_grid function
Returns:
Returns a loaded, and optional clip/resampled grid of GIA data.
version=âan-2015â
Crustal thickness (distance from solid (ice and rock) top to Moho discontinuity)
from An et al.[51].
Accessed from http://www.seismolab.org/model/antarctica/lithosphere/index.html#an1s
File is the AN1-CRUST model, paper states âMoho depths and crustal thicknesses
referred to below are the distance from the solid surface to the Moho. We note that
this definition of Moho depth is different from that in the compilation of AN-MOHOâ.
Unclear, but seems moho depth is just negative of crustal thickness. Not sure if its
to the ice surface or ice base.
Parameters:
version (str) â Either âshen-2018â,
will add later: âlamb-2020â, âan-2015â, âbaranovâ, âchaputâ, âcrust1â,
âszwillusâ, âllubesâ, âpappaâ, âstalâ
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (int, optional) â grid spacing to resample the loaded grid to, by default spacing is read from
downloaded files
registration (str, optional) â change registration with either âpâ for pixel or âgâ for gridline registration,
by default is None.
**kwargs (Any) â additional keyword arguments to pass to the resample_grid function
Returns:
Returns a loaded, and optional clip/resampled grid of crustal thickness.
Load 1 of x âversionsâ of Antarctic Moho depth grids.
version=âshen-2018â
Depth to the Moho relative to the surface of solid earth (bottom of ice/ocean)
from Shen et al.[50].
Accessed from https://sites.google.com/view/weisen/research-products?authuser=0
Appears to be almost identical to crustal thickness from Shen et al. 2018
version=âan-2015â
This is fetch.crustal_thickness(version=âan-2015)* -1
Documentation is unclear whether the An crust model from
An et al.[51] is crustal thickness or moho depths, or whether it
makes a big enough difference to matter.
version=âpappa-2019â
from Pappa et al.[52].
Accessed from supplement material
Parameters:
version (str) â Either âshen-2018â, âan-2015â, âpappa-2019â,
will add later: âlamb-2020â, âbaranovâ, âchaputâ, âcrust1â,
âszwillusâ, âllubesâ,
region (tuple[float, float, float, float], optional) â region to clip the loaded grid to, in format [xmin, xmax, ymin, ymax], by
default doesnât clip
spacing (int, optional) â grid spacing to resample the loaded grid to, by default spacing is read from
downloaded files
registration (str, optional,) â choose between âgâ (gridline) or âpâ (pixel) registration types, by default is
the original type of the grid
**kwargs (Any) â additional keyword arguments to pass to the resample_grid function
Returns:
Returns a loaded, and optional clip/resampled grid of crustal thickness.