arctichoke.plot.limit_extent
============================

.. py:module:: arctichoke.plot.limit_extent


Functions
---------

.. autoapisummary::

   arctichoke.plot.limit_extent.get_limited_extent


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

.. py:function:: get_limited_extent(map_projection: cartopy.crs.CRS, map_bbox: [float, float, float, float] = sps.NWP_BBOX, n_samples: int = 100, **kwargs)

   Get the extent to which to limit a plot.

   Using the given coordinates to define the corners of a bounding box, sample the edges, and project those points into the given projection.

   :param map_projection: The coordinate reference system from `cartopy` onto which the bounding box will be projected.
   :type map_projection: `cartopy.crs.CRS`
   :param map_bbox:
                    An array of coordinates defining the bounding box of the map in the following format:
                        - [LAT_MAX, LAT_MIN, LON_MAX, LON_MIN]

                    Default is `arctichoke.params.latlon_params.NWP_BBOX`.
   :type map_bbox: Array of `float`, optional
   :param n_sample: The number of samples to take along the edges of the bounding box.
                    Use a larger number for larger bounding boxes to reduce clipping.
                    Default is `100`.
   :type n_sample: `int`, optional
   :param \*\*kwargs: Keyword arguments to handle extras that might have been passed by the function above this one.

   :rtype: map_extent

   .. rubric:: Examples

   >>>