polartoolkit.regions

polartoolkit.regions#

Bounding regions for commonly plotted polar regions. In stereographic projections. The format is (xmin, xmax, ymin, ymax), in meters.

Attributes#

ipyleaflet

display

antarctica

west_antarctica

east_antarctica

antarctic_peninsula

marie_byrd_land

victoria_land

saunders_coast

roosevelt_island

ross_island

minna_bluff

mcmurdo_dry_valleys

siple_coast

crary_ice_rise

siple_dome

ross_ice_shelf

nickerson_ice_shelf

getz_ice_shelf

george_vi_ice_shelf

larsen_ice_shelf

ronne_filchner_ice_shelf

ronne_ice_shelf

fimbul_ice_shelf

baudouin_ice_shelf

amery_ice_shelf

pine_island_glacier

thwaites_glacier

kamb_ice_stream

ross_sea

lake_vostok

greenland

north_greenland

kangerlussuaq_glacier

Functions#

get_regions()

get all the regions defined in this module.

alter_region(starting_region[, zoom, n_shift, w_shift])

Change a bounding region by shifting the box east/west or north/south, or zooming in

combine_regions(region1, region2)

Get the bounding region of 2 regions.

draw_region(**kwargs)

Plot an interactive map, and use the "Draw a Rectangle" button to draw a rectangle

Module Contents#

ipyleaflet = None[source]#
display = None[source]#
antarctica[source]#
west_antarctica[source]#
east_antarctica[source]#
antarctic_peninsula[source]#
marie_byrd_land[source]#
victoria_land[source]#
saunders_coast[source]#
roosevelt_island[source]#
ross_island[source]#
minna_bluff[source]#
mcmurdo_dry_valleys[source]#
siple_coast[source]#
crary_ice_rise[source]#
siple_dome[source]#
ross_ice_shelf[source]#
nickerson_ice_shelf[source]#
getz_ice_shelf[source]#
george_vi_ice_shelf[source]#
larsen_ice_shelf[source]#
ronne_filchner_ice_shelf[source]#
ronne_ice_shelf[source]#
fimbul_ice_shelf[source]#
baudouin_ice_shelf = (855000.0, 1250000.0, 1790000.0, 2080000.0)[source]#
amery_ice_shelf = (1530000.0, 2460000.0, 430000.0, 1000000.0)[source]#
pine_island_glacier[source]#
thwaites_glacier[source]#
kamb_ice_stream[source]#
ross_sea[source]#
lake_vostok[source]#
greenland[source]#
north_greenland[source]#
kangerlussuaq_glacier[source]#
get_regions()[source]#

get all the regions defined in this module.

Returns:

dictionary of each defined region’s name and values

Return type:

dict[str, tuple[float, float, float, float] ]

alter_region(starting_region, zoom=0, n_shift=0, w_shift=0)[source]#

Change a bounding region by shifting the box east/west or north/south, or zooming in or out.

Parameters:

  • starting_region (tuple[float, float, float, float]) – Initial region in meters in format [xmin, xmax, ymin, ymax]

  • zoom (float, optional) – zoom in or out, in meters, by default 0

  • n_shift (float, optional) – shift north, or south if negative, in meters, by default 0

  • w_shift (float, optional) – shift west, or east if negative, in meters, by default 0

Returns:

Returns the altered region

Return type:

tuple[float, float, float, float]

combine_regions(region1, region2)[source]#

Get the bounding region of 2 regions.

Parameters:
Returns:

Bounding region of the 2 supplied regions.

Return type:

tuple[float, float, float, float]

draw_region(**kwargs)[source]#

Plot an interactive map, and use the “Draw a Rectangle” button to draw a rectangle and get the bounding region. Vertices will be returned as the output of the function.

Returns:

Returns a list of list of vertices for each polyline.

Return type:

list[Any]

Parameters:

kwargs (Any)

Example

>>> from polartoolkit import regions, utils
...
>>> polygon = regions.draw_region()
>>> region = utils.polygon_to_region(polygon, hemisphere="north")
Contents