Proj¶
-
Proj
(name, basemap=None, **kwargs)[source]¶ Return a
cartopy.crs.Projection
orBasemap
instance. Used to interpret theproj
andproj_kw
arguments when passed tosubplots
.- Parameters
name (str,
cartopy.crs.Projection
, orBasemap
) – The projection name or projection class instance. If the latter, it is simply returned. If the former, it must correspond to one of the PROJ projection name shorthands, like in basemap.The following table lists the valid projection name shorthands, their full names (with links to the relevant PROJ documentation), and whether they are available in the cartopy and basemap packages. (added) indicates a projection class that ProPlot has “added” to cartopy using the cartopy API.
Key
Name
Cartopy
Basemap
'aea'
✓
✓
'aeqd'
✓
✓
'aitoff'
✓ (added)
✗
'cass'
✗
✓
'cea'
✗
✓
'cyl'
✓
✓
'eck1'
✓
✗
'eck2'
✓
✗
'eck3'
✓
✗
'eck4'
✓
✓
'eck5'
✓
✗
'eck6'
✓
✗
'eqdc'
✓
✓
'eqc'
✓
✓
'eqearth'
✓
✗
'europp'
Euro PP (Europe)
✓
✗
'gall'
✗
✓
'geos'
✓
✓
'gnom'
✓
✓
'hammer'
✓ (added)
✓
'igh'
✓
✗
'kav7'
✓ (added)
✓
'laea'
✓
✓
'lcc'
✓
✓
'lcyl'
Lambert Cylindrical
✓
✗
'mbtfpq'
✗
✓
'merc'
✓
✓
'mill'
✓
✓
'moll'
✓
✓
'npaeqd'
North-Polar Azimuthal Equidistant
✓ (added)
✓
'npgnom'
North-Polar Gnomonic
✓ (added)
✗
'nplaea'
North-Polar Lambert Azimuthal
✓ (added)
✓
'npstere'
North-Polar Stereographic
✓
✓
'nsper'
✓
✓
'osni'
OSNI (Ireland)
✓
✗
'osgb'
OSGB (UK)
✓
✗
'omerc'
✗
✓
'ortho'
✓
✓
'pcarree'
✓
✓
'poly'
✗
✓
'rotpole'
Rotated Pole
✓
✓
'sinu'
✓
✓
'spaeqd'
South-Polar Azimuthal Equidistant
✓ (added)
✓
'spgnom'
South-Polar Gnomonic
✓ (added)
✗
'splaea'
South-Polar Lambert Azimuthal
✓ (added)
✓
'spstere'
South-Polar Stereographic
✓
✓
'stere'
✓
✓
'tmerc'
✓
✓
'utm'
✓
✗
'vandg'
✗
✓
'wintri'
✓ (added)
✗
basemap (bool, optional) – Whether to use the basemap package as opposed to the cartopy package. Default is
False
.lonlim (2-tuple of float, optional) – Alternative way to specify
llcrnrlon
andurcrnrlon
for basemap projections.latlim (2-tuple of float, optional) – Alternative way to specify
llcrnrlat
andurcrnrlat
for basemap projections.
- Other Parameters
**kwargs – Passed to the
Basemap
or cartopyProjection
class. For cartopy axes, ProPlot translateslon_0
andlat_0
tocentral_longitude
andcentral_latitude
.- Returns
proj (
Basemap
orProjection
) – The projection instance.
References
For more information on map projections, see the wikipedia page and the PROJ documentation.