Proj

Proj(name, backend=None, lon0=None, lon_0=None, lat0=None, lat_0=None, lonlim=None, latlim=None, **kwargs)[source]

Return a cartopy.crs.Projection or Basemap instance.

Parameters:

name (str, cartopy.crs.Projection, or Basemap) – 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 ultraplot has “added” to cartopy using the cartopy API.

Key	Name	Cartopy	Basemap
`'aea'`	Albers Equal Area	✓	✓
`'aeqd'`	Azimuthal Equidistant	✓	✓
`'aitoff'`	Aitoff	✓ (added)	✗
`'cass'`	Cassini-Soldner	✗	✓
`'cea'`	Cylindrical Equal Area	✗	✓
`'cyl'`	Cylindrical Equidistant	✓	✓
`'eck1'`	Eckert I	✓	✗
`'eck2'`	Eckert II	✓	✗
`'eck3'`	Eckert III	✓	✗
`'eck4'`	Eckert IV	✓	✓
`'eck5'`	Eckert V	✓	✗
`'eck6'`	Eckert VI	✓	✗
`'eqdc'`	Equidistant Conic	✓	✓
`'eqc'`	Cylindrical Equidistant	✓	✓
`'eqearth'`	Equal Earth	✓	✗
`'europp'`	Euro PP (Europe)	✓	✗
`'gall'`	Gall Stereographic Cylindrical	✗	✓
`'geos'`	Geostationary	✓	✓
`'gnom'`	Gnomonic	✓	✓
`'hammer'`	Hammer	✓ (added)	✓
`'igh'`	Interrupted Goode Homolosine	✓	✗
`'kav7'`	Kavrayskiy VII	✓ (added)	✓
`'laea'`	Lambert Azimuthal Equal Area	✓	✓
`'lcc'`	Lambert Conformal	✓	✓
`'lcyl'`	Lambert Cylindrical	✓	✗
`'mbtfpq'`	McBryde-Thomas Flat-Polar Quartic	✗	✓
`'merc'`	Mercator	✓	✓
`'mill'`	Miller Cylindrical	✓	✓
`'moll'`	Mollweide	✓	✓
`'npaeqd'`	North-Polar Azimuthal Equidistant	✓ (added)	✓
`'npgnom'`	North-Polar Gnomonic	✓ (added)	✗
`'nplaea'`	North-Polar Lambert Azimuthal	✓ (added)	✓
`'npstere'`	North-Polar Stereographic	✓	✓
`'nsper'`	Near-Sided Perspective	✓	✓
`'osni'`	OSNI (Ireland)	✓	✗
`'osgb'`	OSGB (UK)	✓	✗
`'omerc'`	Oblique Mercator	✗	✓
`'ortho'`	Orthographic	✓	✓
`'pcarree'`	Cylindrical Equidistant	✓	✓
`'poly'`	Polyconic	✗	✓
`'rotpole'`	Rotated Pole	✓	✓
`'sinu'`	Sinusoidal	✓	✓
`'spaeqd'`	South-Polar Azimuthal Equidistant	✓ (added)	✓
`'spgnom'`	South-Polar Gnomonic	✓ (added)	✗
`'splaea'`	South-Polar Lambert Azimuthal	✓ (added)	✓
`'spstere'`	South-Polar Stereographic	✓	✓
`'stere'`	Stereographic	✓	✓
`'tmerc'`	Transverse Mercator	✓	✓
`'utm'`	Universal Transverse Mercator	✓	✗
`'vandg'`	van der Grinten	✗	✓
`'wintri'`	Winkel tripel	✓ (added)	✗

backend ({'cartopy', 'basemap'}, default: rc['geo.backend'] = 'cartopy') – Whether to return a cartopy Projection instance or a basemap Basemap instance.
lon0, lat0 (float, optional) – The central projection longitude and latitude. These are translated to central_longitude, central_latitude for cartopy projections.
lon_0, lat_0 (float, optional) – Aliases for lon0, lat0.
lonlim (2-tuple of float, optional) – The longitude limits. Translated to min_longitude and max_longitude for cartopy projections and llcrnrlon and urcrnrlon for basemap projections.
latlim (2-tuple of float, optional) – The latitude limits. Translated to min_latitude and max_latitude for cartopy projections and llcrnrlon and urcrnrlon for basemap projections.

Other Parameters:

**kwargs – Passed to the cartopy Projection or basemap Basemap class.

Returns:

proj (mpl_toolkits.basemap.Basemap or cartopy.crs.Projection) – A cartopy or basemap projection instance.