polartoolkit.regions
====================

.. py:module:: polartoolkit.regions

.. autoapi-nested-parse::

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



Attributes
----------

.. autoapisummary::

   polartoolkit.regions.ipyleaflet
   polartoolkit.regions.display
   polartoolkit.regions.antarctica
   polartoolkit.regions.west_antarctica
   polartoolkit.regions.east_antarctica
   polartoolkit.regions.antarctic_peninsula
   polartoolkit.regions.marie_byrd_land
   polartoolkit.regions.victoria_land
   polartoolkit.regions.saunders_coast
   polartoolkit.regions.roosevelt_island
   polartoolkit.regions.ross_island
   polartoolkit.regions.minna_bluff
   polartoolkit.regions.mcmurdo_dry_valleys
   polartoolkit.regions.siple_coast
   polartoolkit.regions.crary_ice_rise
   polartoolkit.regions.siple_dome
   polartoolkit.regions.ross_ice_shelf
   polartoolkit.regions.nickerson_ice_shelf
   polartoolkit.regions.getz_ice_shelf
   polartoolkit.regions.george_vi_ice_shelf
   polartoolkit.regions.larsen_ice_shelf
   polartoolkit.regions.ronne_filchner_ice_shelf
   polartoolkit.regions.ronne_ice_shelf
   polartoolkit.regions.fimbul_ice_shelf
   polartoolkit.regions.baudouin_ice_shelf
   polartoolkit.regions.amery_ice_shelf
   polartoolkit.regions.pine_island_glacier
   polartoolkit.regions.thwaites_glacier
   polartoolkit.regions.kamb_ice_stream
   polartoolkit.regions.ross_sea
   polartoolkit.regions.lake_vostok
   polartoolkit.regions.greenland
   polartoolkit.regions.north_greenland
   polartoolkit.regions.kangerlussuaq_glacier


Functions
---------

.. autoapisummary::

   polartoolkit.regions.get_regions
   polartoolkit.regions.alter_region
   polartoolkit.regions.combine_regions
   polartoolkit.regions.draw_region


Module Contents
---------------

.. py:data:: ipyleaflet
   :value: None


.. py:data:: display
   :value: None


.. py:data:: antarctica

.. py:data:: west_antarctica

.. py:data:: east_antarctica

.. py:data:: antarctic_peninsula

.. py:data:: marie_byrd_land

.. py:data:: victoria_land

.. py:data:: saunders_coast

.. py:data:: roosevelt_island

.. py:data:: ross_island

.. py:data:: minna_bluff

.. py:data:: mcmurdo_dry_valleys

.. py:data:: siple_coast

.. py:data:: crary_ice_rise

.. py:data:: siple_dome

.. py:data:: ross_ice_shelf

.. py:data:: nickerson_ice_shelf

.. py:data:: getz_ice_shelf

.. py:data:: george_vi_ice_shelf

.. py:data:: larsen_ice_shelf

.. py:data:: ronne_filchner_ice_shelf

.. py:data:: ronne_ice_shelf

.. py:data:: fimbul_ice_shelf

.. py:data:: baudouin_ice_shelf
   :value: (855000.0, 1250000.0, 1790000.0, 2080000.0)


.. py:data:: amery_ice_shelf
   :value: (1530000.0, 2460000.0, 430000.0, 1000000.0)


.. py:data:: pine_island_glacier

.. py:data:: thwaites_glacier

.. py:data:: kamb_ice_stream

.. py:data:: ross_sea

.. py:data:: lake_vostok

.. py:data:: greenland

.. py:data:: north_greenland

.. py:data:: kangerlussuaq_glacier

.. py:function:: get_regions()

   get all the regions defined in this module.

   :returns: dictionary of each defined region's name and values
   :rtype: dict[str, tuple[float, float, float, float] ]


.. py:function:: alter_region(starting_region, zoom = 0, n_shift = 0, w_shift = 0)

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

   :param starting_region: Initial region in meters in format [xmin, xmax, ymin, ymax]
   :type starting_region: tuple[float, float, float, float]
   :param zoom: zoom in or out, in meters, by default 0
   :type zoom: float, optional
   :param n_shift: shift north, or south if negative, in meters, by default 0
   :type n_shift: float, optional
   :param w_shift: shift west, or east if negative, in meters, by default 0
   :type w_shift: float, optional

   :returns: Returns the altered region
   :rtype: tuple[float, float, float, float]


.. py:function:: combine_regions(region1, region2)

   Get the bounding region of 2 regions.

   :param region1: first region, in the format (xmin, xmax, ymin, ymax)
   :type region1: tuple[float, float, float, float]
   :param region2: second region in the format (xmin, xmax, ymin, ymax)
   :type region2: tuple[float, float, float, float]

   :returns: Bounding region of the 2 supplied regions.
   :rtype: tuple[float, float, float, float]


.. py:function:: draw_region(**kwargs)

   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.
   :rtype: list[typing.Any]

   .. rubric:: Example

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