matplotlib.projections.geo#

classmatplotlib.projections.geo.AitoffAxes(*args,**kwargs)[source]#

Bases:GeoAxes

Build an Axes in a figure.

Parameters:
figFigure

The Axes is built in theFigurefig.

*args

*args can be a single(left,bottom,width,height)rectangle or a singleBbox. This specifies the rectangle (infigure coordinates) where the Axes is positioned.

*args can also consist of three numbers or a single three-digitnumber; in the latter case, the digits are considered asindependent numbers. The numbers are interpreted as(nrows,ncols,index):(nrows,ncols) specifies the size of an arrayof subplots, andindex is the 1-based index of the subplotbeing created. Finally,*args can also directly be aSubplotSpec instance.

sharex, shareyAxes, optional

The x- or y-axis is shared with the x- or y-axis inthe inputAxes. Note that it is not possible to unshareaxes.

frameonbool, default: True

Whether the Axes frame is visible.

box_aspectfloat, optional

Set a fixed aspect for the Axes box, i.e. the ratio of height towidth. Seeset_box_aspect for details.

forward_navigation_eventsbool or "auto", default: "auto"

Control whether pan/zoom events are passed through to Axes belowthis one. "auto" isTrue for axes with an invisible patch andFalse otherwise.

**kwargs

Other optional keyword arguments:

Property

Description

adjustable

{'box', 'datalim'}

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

float or None

anchor

(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

animated

bool

aspect

{'auto', 'equal'} or float

autoscale_on

bool

autoscalex_on

unknown

autoscaley_on

unknown

axes_locator

Callable[[Axes, Renderer], Bbox]

axisbelow

bool or 'line'

box_aspect

float or None

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

facecolor orfc

color

figure

Figure orSubFigure

forward_navigation_events

bool or "auto"

frame_on

bool

gid

str

in_layout

bool

label

object

mouseover

bool

navigate

bool

navigate_mode

unknown

path_effects

list ofAbstractPathEffect

picker

None or bool or float or callable

position

[left, bottom, width, height] orBbox

prop_cycle

Cycler

rasterization_zorder

float or None

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

subplotspec

unknown

title

str

transform

Transform

url

str

visible

bool

xbound

(lower: float, upper: float)

xinverted

unknown

xlabel

str

xlim

(left: float, right: float)

xmargin

float greater than -0.5

xscale

unknown

xticklabels

unknown

xticks

unknown

ybound

(lower: float, upper: float)

yinverted

unknown

ylabel

str

ylim

(bottom: float, top: float)

ymargin

float greater than -0.5

yscale

unknown

yticklabels

unknown

yticks

unknown

zorder

float

Returns:
Axes

The newAxes object.

classAitoffTransform(resolution)[source]#

Bases:_GeoTransform

The base Aitoff transform.

Create a new geographical transform.

Resolution is the number of steps to interpolate between each inputline segment to approximate its path in curved space.

has_inverse=True#

True if this transform has a corresponding inverse transform.

inverted()[source]#

Return the corresponding inverse transformation.

It holdsx==self.inverted().transform(self.transform(x)).

The return value of this method should be treated astemporary. An update toself does not cause a correspondingupdate to its inverted copy.

transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent totransform_affine(transform_non_affine(values)).

In non-affine transformations, this is generally equivalent totransform(values). In affine transformations, this isalways a no-op.

Parameters:
valuesarray

The input values as an array of lengthinput_dims orshape (N,input_dims).

Returns:
array

The output values as an array of lengthoutput_dims or shape(N,output_dims),depending on the input.

classInvertedAitoffTransform(resolution)[source]#

Bases:_GeoTransform

Create a new geographical transform.

Resolution is the number of steps to interpolate between each inputline segment to approximate its path in curved space.

has_inverse=True#

True if this transform has a corresponding inverse transform.

inverted()[source]#

Return the corresponding inverse transformation.

It holdsx==self.inverted().transform(self.transform(x)).

The return value of this method should be treated astemporary. An update toself does not cause a correspondingupdate to its inverted copy.

transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent totransform_affine(transform_non_affine(values)).

In non-affine transformations, this is generally equivalent totransform(values). In affine transformations, this isalways a no-op.

Parameters:
valuesarray

The input values as an array of lengthinput_dims orshape (N,input_dims).

Returns:
array

The output values as an array of lengthoutput_dims or shape(N,output_dims),depending on the input.

name='aitoff'#
set(*,adjustable=<UNSET>,agg_filter=<UNSET>,alpha=<UNSET>,anchor=<UNSET>,animated=<UNSET>,aspect=<UNSET>,autoscale_on=<UNSET>,autoscalex_on=<UNSET>,autoscaley_on=<UNSET>,axes_locator=<UNSET>,axisbelow=<UNSET>,box_aspect=<UNSET>,clip_box=<UNSET>,clip_on=<UNSET>,clip_path=<UNSET>,facecolor=<UNSET>,forward_navigation_events=<UNSET>,frame_on=<UNSET>,gid=<UNSET>,in_layout=<UNSET>,label=<UNSET>,latitude_grid=<UNSET>,longitude_grid=<UNSET>,longitude_grid_ends=<UNSET>,mouseover=<UNSET>,navigate=<UNSET>,path_effects=<UNSET>,picker=<UNSET>,position=<UNSET>,prop_cycle=<UNSET>,rasterization_zorder=<UNSET>,rasterized=<UNSET>,sketch_params=<UNSET>,snap=<UNSET>,subplotspec=<UNSET>,title=<UNSET>,transform=<UNSET>,url=<UNSET>,visible=<UNSET>,xbound=<UNSET>,xinverted=<UNSET>,xlabel=<UNSET>,xlim=<UNSET>,xmargin=<UNSET>,xscale=<UNSET>,xticklabels=<UNSET>,xticks=<UNSET>,ybound=<UNSET>,yinverted=<UNSET>,ylabel=<UNSET>,ylim=<UNSET>,ymargin=<UNSET>,yscale=<UNSET>,yticklabels=<UNSET>,yticks=<UNSET>,zorder=<UNSET>)[source]#

Set multiple properties at once.

Supported properties are

Property

Description

adjustable

{'box', 'datalim'}

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

float or None

anchor

(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

animated

bool

aspect

{'auto', 'equal'} or float

autoscale_on

bool

autoscalex_on

unknown

autoscaley_on

unknown

axes_locator

Callable[[Axes, Renderer], Bbox]

axisbelow

bool or 'line'

box_aspect

float or None

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

facecolor orfc

color

figure

Figure orSubFigure

forward_navigation_events

bool or "auto"

frame_on

bool

gid

str

in_layout

bool

label

object

latitude_grid

unknown

longitude_grid

unknown

longitude_grid_ends

unknown

mouseover

bool

navigate

bool

navigate_mode

unknown

path_effects

list ofAbstractPathEffect

picker

None or bool or float or callable

position

[left, bottom, width, height] orBbox

prop_cycle

Cycler

rasterization_zorder

float or None

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

subplotspec

unknown

title

str

transform

Transform

url

str

visible

bool

xbound

unknown

xinverted

unknown

xlabel

str

xlim

unknown

xmargin

float greater than -0.5

xscale

unknown

xticklabels

unknown

xticks

unknown

ybound

unknown

yinverted

unknown

ylabel

str

ylim

unknown

ymargin

float greater than -0.5

yscale

unknown

yticklabels

unknown

yticks

unknown

zorder

float

classmatplotlib.projections.geo.GeoAxes(fig,*args,facecolor=None,frameon=True,sharex=None,sharey=None,label='',xscale=None,yscale=None,box_aspect=None,forward_navigation_events='auto',**kwargs)[source]#

Bases:Axes

An abstract base class for geographic projections.

Build an Axes in a figure.

Parameters:
figFigure

The Axes is built in theFigurefig.

*args

*args can be a single(left,bottom,width,height)rectangle or a singleBbox. This specifies the rectangle (infigure coordinates) where the Axes is positioned.

*args can also consist of three numbers or a single three-digitnumber; in the latter case, the digits are considered asindependent numbers. The numbers are interpreted as(nrows,ncols,index):(nrows,ncols) specifies the size of an arrayof subplots, andindex is the 1-based index of the subplotbeing created. Finally,*args can also directly be aSubplotSpec instance.

sharex, shareyAxes, optional

The x- or y-axis is shared with the x- or y-axis inthe inputAxes. Note that it is not possible to unshareaxes.

frameonbool, default: True

Whether the Axes frame is visible.

box_aspectfloat, optional

Set a fixed aspect for the Axes box, i.e. the ratio of height towidth. Seeset_box_aspect for details.

forward_navigation_eventsbool or "auto", default: "auto"

Control whether pan/zoom events are passed through to Axes belowthis one. "auto" isTrue for axes with an invisible patch andFalse otherwise.

**kwargs

Other optional keyword arguments:

Property

Description

adjustable

{'box', 'datalim'}

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

float or None

anchor

(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

animated

bool

aspect

{'auto', 'equal'} or float

autoscale_on

bool

autoscalex_on

unknown

autoscaley_on

unknown

axes_locator

Callable[[Axes, Renderer], Bbox]

axisbelow

bool or 'line'

box_aspect

float or None

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

facecolor orfc

color

figure

Figure orSubFigure

forward_navigation_events

bool or "auto"

frame_on

bool

gid

str

in_layout

bool

label

object

mouseover

bool

navigate

bool

navigate_mode

unknown

path_effects

list ofAbstractPathEffect

picker

None or bool or float or callable

position

[left, bottom, width, height] orBbox

prop_cycle

Cycler

rasterization_zorder

float or None

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

subplotspec

unknown

title

str

transform

Transform

url

str

visible

bool

xbound

(lower: float, upper: float)

xinverted

unknown

xlabel

str

xlim

(left: float, right: float)

xmargin

float greater than -0.5

xscale

unknown

xticklabels

unknown

xticks

unknown

ybound

(lower: float, upper: float)

yinverted

unknown

ylabel

str

ylim

(bottom: float, top: float)

ymargin

float greater than -0.5

yscale

unknown

yticklabels

unknown

yticks

unknown

zorder

float

Returns:
Axes

The newAxes object.

RESOLUTION=75#
classThetaFormatter(round_to=1.0)[source]#

Bases:Formatter

Used to format the theta tick labels. Converts the nativeunit of radians into degrees and adds a degree symbol.

can_pan()[source]#

Return whether this Axes supports the pan/zoom button functionality.

This Axes object does not support interactive pan/zoom.

can_zoom()[source]#

Return whether this Axes supports the zoom box button functionality.

This Axes object does not support interactive zoom box.

clear()[source]#

Clear the Axes.

drag_pan(button,key,x,y)[source]#

Called when the mouse moves during a pan operation.

Parameters:
buttonMouseButton

The pressed mouse button.

keystr or None

The pressed key, if any.

x, yfloat

The mouse coordinates in display coords.

Notes

This is intended to be overridden by new projection types.

end_pan()[source]#

Called when a pan operation completes (when the mouse button is up.)

Notes

This is intended to be overridden by new projection types.

format_coord(lon,lat)[source]#

Return a format string formatting the coordinate.

get_data_ratio()[source]#

Return the aspect ratio of the data itself.

get_xaxis_text1_transform(pad)[source]#
Returns:
transformTransform

The transform used for drawing x-axis labels, which will addpad_points of padding (in points) between the axis and the label.The x-direction is in data coordinates and the y-direction is inaxis coordinates

valign{'center', 'top', 'bottom', 'baseline', 'center_baseline'}

The text vertical alignment.

halign{'center', 'left', 'right'}

The text horizontal alignment.

Notes

This transformation is primarily used by theAxisclass, and is meant to be overridden by new kinds of projections thatmay need to place axis elements in different locations.

get_xaxis_text2_transform(pad)[source]#
Returns:
transformTransform

The transform used for drawing secondary x-axis labels, which willaddpad_points of padding (in points) between the axis and thelabel. The x-direction is in data coordinates and the y-directionis in axis coordinates

valign{'center', 'top', 'bottom', 'baseline', 'center_baseline'}

The text vertical alignment.

halign{'center', 'left', 'right'}

The text horizontal alignment.

Notes

This transformation is primarily used by theAxisclass, and is meant to be overridden by new kinds of projections thatmay need to place axis elements in different locations.

get_xaxis_transform(which='grid')[source]#

Get the transformation used for drawing x-axis labels, ticksand gridlines. The x-direction is in data coordinates and they-direction is in axis coordinates.

Note

This transformation is primarily used by theAxis class, and is meant to beoverridden by new kinds of projections that may need toplace axis elements in different locations.

Parameters:
which{'grid', 'tick1', 'tick2'}
get_yaxis_text1_transform(pad)[source]#
Returns:
transformTransform

The transform used for drawing y-axis labels, which will addpad_points of padding (in points) between the axis and the label.The x-direction is in axis coordinates and the y-direction is indata coordinates

valign{'center', 'top', 'bottom', 'baseline', 'center_baseline'}

The text vertical alignment.

halign{'center', 'left', 'right'}

The text horizontal alignment.

Notes

This transformation is primarily used by theAxisclass, and is meant to be overridden by new kinds of projections thatmay need to place axis elements in different locations.

get_yaxis_text2_transform(pad)[source]#
Returns:
transformTransform

The transform used for drawing secondary y-axis labels, which willaddpad_points of padding (in points) between the axis and thelabel. The x-direction is in axis coordinates and the y-directionis in data coordinates

valign{'center', 'top', 'bottom', 'baseline', 'center_baseline'}

The text vertical alignment.

halign{'center', 'left', 'right'}

The text horizontal alignment.

Notes

This transformation is primarily used by theAxisclass, and is meant to be overridden by new kinds of projections thatmay need to place axis elements in different locations.

get_yaxis_transform(which='grid')[source]#

Get the transformation used for drawing y-axis labels, ticksand gridlines. The x-direction is in axis coordinates and they-direction is in data coordinates.

Note

This transformation is primarily used by theAxis class, and is meant to beoverridden by new kinds of projections that may need toplace axis elements in different locations.

Parameters:
which{'grid', 'tick1', 'tick2'}
invert_xaxis()[source]#

Not supported. Please consider using Cartopy.

invert_yaxis()[source]#

Not supported. Please consider using Cartopy.

set(*,adjustable=<UNSET>,agg_filter=<UNSET>,alpha=<UNSET>,anchor=<UNSET>,animated=<UNSET>,aspect=<UNSET>,autoscale_on=<UNSET>,autoscalex_on=<UNSET>,autoscaley_on=<UNSET>,axes_locator=<UNSET>,axisbelow=<UNSET>,box_aspect=<UNSET>,clip_box=<UNSET>,clip_on=<UNSET>,clip_path=<UNSET>,facecolor=<UNSET>,forward_navigation_events=<UNSET>,frame_on=<UNSET>,gid=<UNSET>,in_layout=<UNSET>,label=<UNSET>,latitude_grid=<UNSET>,longitude_grid=<UNSET>,longitude_grid_ends=<UNSET>,mouseover=<UNSET>,navigate=<UNSET>,path_effects=<UNSET>,picker=<UNSET>,position=<UNSET>,prop_cycle=<UNSET>,rasterization_zorder=<UNSET>,rasterized=<UNSET>,sketch_params=<UNSET>,snap=<UNSET>,subplotspec=<UNSET>,title=<UNSET>,transform=<UNSET>,url=<UNSET>,visible=<UNSET>,xbound=<UNSET>,xinverted=<UNSET>,xlabel=<UNSET>,xlim=<UNSET>,xmargin=<UNSET>,xscale=<UNSET>,xticklabels=<UNSET>,xticks=<UNSET>,ybound=<UNSET>,yinverted=<UNSET>,ylabel=<UNSET>,ylim=<UNSET>,ymargin=<UNSET>,yscale=<UNSET>,yticklabels=<UNSET>,yticks=<UNSET>,zorder=<UNSET>)[source]#

Set multiple properties at once.

Supported properties are

Property

Description

adjustable

{'box', 'datalim'}

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

float or None

anchor

(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

animated

bool

aspect

{'auto', 'equal'} or float

autoscale_on

bool

autoscalex_on

unknown

autoscaley_on

unknown

axes_locator

Callable[[Axes, Renderer], Bbox]

axisbelow

bool or 'line'

box_aspect

float or None

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

facecolor orfc

color

figure

Figure orSubFigure

forward_navigation_events

bool or "auto"

frame_on

bool

gid

str

in_layout

bool

label

object

latitude_grid

unknown

longitude_grid

unknown

longitude_grid_ends

unknown

mouseover

bool

navigate

bool

navigate_mode

unknown

path_effects

list ofAbstractPathEffect

picker

None or bool or float or callable

position

[left, bottom, width, height] orBbox

prop_cycle

Cycler

rasterization_zorder

float or None

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

subplotspec

unknown

title

str

transform

Transform

url

str

visible

bool

xbound

unknown

xinverted

unknown

xlabel

str

xlim

unknown

xmargin

float greater than -0.5

xscale

unknown

xticklabels

unknown

xticks

unknown

ybound

unknown

yinverted

unknown

ylabel

str

ylim

unknown

ymargin

float greater than -0.5

yscale

unknown

yticklabels

unknown

yticks

unknown

zorder

float

set_latitude_grid(degrees)[source]#

Set the number of degrees between each latitude grid.

set_longitude_grid(degrees)[source]#

Set the number of degrees between each longitude grid.

set_longitude_grid_ends(degrees)[source]#

Set the latitude(s) at which to stop drawing the longitude grids.

set_xbound(*args,**kwargs)[source]#

Not supported. Please consider using Cartopy.

set_xlim(*args,**kwargs)[source]#

Not supported. Please consider using Cartopy.

set_xscale(*args,**kwargs)[source]#

Set the xaxis' scale.

Parameters:
valuestr orScaleBase

The axis scale type to apply. Valid string values are the names of scaleclasses ("linear", "log", "function",...). These may be the names of anyof thebuilt-in scales or of any custom scalesregistered usingmatplotlib.scale.register_scale.

**kwargs

Ifvalue is a string, keywords are passed to the instantiation method ofthe respective class.

set_ybound(*args,**kwargs)[source]#

Not supported. Please consider using Cartopy.

set_ylim(*args,**kwargs)[source]#

Not supported. Please consider using Cartopy.

set_yscale(*args,**kwargs)[source]#

Set the yaxis' scale.

Parameters:
valuestr orScaleBase

The axis scale type to apply. Valid string values are the names of scaleclasses ("linear", "log", "function",...). These may be the names of anyof thebuilt-in scales or of any custom scalesregistered usingmatplotlib.scale.register_scale.

**kwargs

Ifvalue is a string, keywords are passed to the instantiation method ofthe respective class.

start_pan(x,y,button)[source]#

Called when a pan operation has started.

Parameters:
x, yfloat

The mouse coordinates in display coords.

buttonMouseButton

The pressed mouse button.

Notes

This is intended to be overridden by new projection types.

classmatplotlib.projections.geo.HammerAxes(*args,**kwargs)[source]#

Bases:GeoAxes

Build an Axes in a figure.

Parameters:
figFigure

The Axes is built in theFigurefig.

*args

*args can be a single(left,bottom,width,height)rectangle or a singleBbox. This specifies the rectangle (infigure coordinates) where the Axes is positioned.

*args can also consist of three numbers or a single three-digitnumber; in the latter case, the digits are considered asindependent numbers. The numbers are interpreted as(nrows,ncols,index):(nrows,ncols) specifies the size of an arrayof subplots, andindex is the 1-based index of the subplotbeing created. Finally,*args can also directly be aSubplotSpec instance.

sharex, shareyAxes, optional

The x- or y-axis is shared with the x- or y-axis inthe inputAxes. Note that it is not possible to unshareaxes.

frameonbool, default: True

Whether the Axes frame is visible.

box_aspectfloat, optional

Set a fixed aspect for the Axes box, i.e. the ratio of height towidth. Seeset_box_aspect for details.

forward_navigation_eventsbool or "auto", default: "auto"

Control whether pan/zoom events are passed through to Axes belowthis one. "auto" isTrue for axes with an invisible patch andFalse otherwise.

**kwargs

Other optional keyword arguments:

Property

Description

adjustable

{'box', 'datalim'}

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

float or None

anchor

(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

animated

bool

aspect

{'auto', 'equal'} or float

autoscale_on

bool

autoscalex_on

unknown

autoscaley_on

unknown

axes_locator

Callable[[Axes, Renderer], Bbox]

axisbelow

bool or 'line'

box_aspect

float or None

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

facecolor orfc

color

figure

Figure orSubFigure

forward_navigation_events

bool or "auto"

frame_on

bool

gid

str

in_layout

bool

label

object

mouseover

bool

navigate

bool

navigate_mode

unknown

path_effects

list ofAbstractPathEffect

picker

None or bool or float or callable

position

[left, bottom, width, height] orBbox

prop_cycle

Cycler

rasterization_zorder

float or None

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

subplotspec

unknown

title

str

transform

Transform

url

str

visible

bool

xbound

(lower: float, upper: float)

xinverted

unknown

xlabel

str

xlim

(left: float, right: float)

xmargin

float greater than -0.5

xscale

unknown

xticklabels

unknown

xticks

unknown

ybound

(lower: float, upper: float)

yinverted

unknown

ylabel

str

ylim

(bottom: float, top: float)

ymargin

float greater than -0.5

yscale

unknown

yticklabels

unknown

yticks

unknown

zorder

float

Returns:
Axes

The newAxes object.

classHammerTransform(resolution)[source]#

Bases:_GeoTransform

The base Hammer transform.

Create a new geographical transform.

Resolution is the number of steps to interpolate between each inputline segment to approximate its path in curved space.

has_inverse=True#

True if this transform has a corresponding inverse transform.

inverted()[source]#

Return the corresponding inverse transformation.

It holdsx==self.inverted().transform(self.transform(x)).

The return value of this method should be treated astemporary. An update toself does not cause a correspondingupdate to its inverted copy.

transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent totransform_affine(transform_non_affine(values)).

In non-affine transformations, this is generally equivalent totransform(values). In affine transformations, this isalways a no-op.

Parameters:
valuesarray

The input values as an array of lengthinput_dims orshape (N,input_dims).

Returns:
array

The output values as an array of lengthoutput_dims or shape(N,output_dims),depending on the input.

classInvertedHammerTransform(resolution)[source]#

Bases:_GeoTransform

Create a new geographical transform.

Resolution is the number of steps to interpolate between each inputline segment to approximate its path in curved space.

has_inverse=True#

True if this transform has a corresponding inverse transform.

inverted()[source]#

Return the corresponding inverse transformation.

It holdsx==self.inverted().transform(self.transform(x)).

The return value of this method should be treated astemporary. An update toself does not cause a correspondingupdate to its inverted copy.

transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent totransform_affine(transform_non_affine(values)).

In non-affine transformations, this is generally equivalent totransform(values). In affine transformations, this isalways a no-op.

Parameters:
valuesarray

The input values as an array of lengthinput_dims orshape (N,input_dims).

Returns:
array

The output values as an array of lengthoutput_dims or shape(N,output_dims),depending on the input.

name='hammer'#
set(*,adjustable=<UNSET>,agg_filter=<UNSET>,alpha=<UNSET>,anchor=<UNSET>,animated=<UNSET>,aspect=<UNSET>,autoscale_on=<UNSET>,autoscalex_on=<UNSET>,autoscaley_on=<UNSET>,axes_locator=<UNSET>,axisbelow=<UNSET>,box_aspect=<UNSET>,clip_box=<UNSET>,clip_on=<UNSET>,clip_path=<UNSET>,facecolor=<UNSET>,forward_navigation_events=<UNSET>,frame_on=<UNSET>,gid=<UNSET>,in_layout=<UNSET>,label=<UNSET>,latitude_grid=<UNSET>,longitude_grid=<UNSET>,longitude_grid_ends=<UNSET>,mouseover=<UNSET>,navigate=<UNSET>,path_effects=<UNSET>,picker=<UNSET>,position=<UNSET>,prop_cycle=<UNSET>,rasterization_zorder=<UNSET>,rasterized=<UNSET>,sketch_params=<UNSET>,snap=<UNSET>,subplotspec=<UNSET>,title=<UNSET>,transform=<UNSET>,url=<UNSET>,visible=<UNSET>,xbound=<UNSET>,xinverted=<UNSET>,xlabel=<UNSET>,xlim=<UNSET>,xmargin=<UNSET>,xscale=<UNSET>,xticklabels=<UNSET>,xticks=<UNSET>,ybound=<UNSET>,yinverted=<UNSET>,ylabel=<UNSET>,ylim=<UNSET>,ymargin=<UNSET>,yscale=<UNSET>,yticklabels=<UNSET>,yticks=<UNSET>,zorder=<UNSET>)[source]#

Set multiple properties at once.

Supported properties are

Property

Description

adjustable

{'box', 'datalim'}

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

float or None

anchor

(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

animated

bool

aspect

{'auto', 'equal'} or float

autoscale_on

bool

autoscalex_on

unknown

autoscaley_on

unknown

axes_locator

Callable[[Axes, Renderer], Bbox]

axisbelow

bool or 'line'

box_aspect

float or None

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

facecolor orfc

color

figure

Figure orSubFigure

forward_navigation_events

bool or "auto"

frame_on

bool

gid

str

in_layout

bool

label

object

latitude_grid

unknown

longitude_grid

unknown

longitude_grid_ends

unknown

mouseover

bool

navigate

bool

navigate_mode

unknown

path_effects

list ofAbstractPathEffect

picker

None or bool or float or callable

position

[left, bottom, width, height] orBbox

prop_cycle

Cycler

rasterization_zorder

float or None

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

subplotspec

unknown

title

str

transform

Transform

url

str

visible

bool

xbound

unknown

xinverted

unknown

xlabel

str

xlim

unknown

xmargin

float greater than -0.5

xscale

unknown

xticklabels

unknown

xticks

unknown

ybound

unknown

yinverted

unknown

ylabel

str

ylim

unknown

ymargin

float greater than -0.5

yscale

unknown

yticklabels

unknown

yticks

unknown

zorder

float

classmatplotlib.projections.geo.LambertAxes(*args,center_longitude=0,center_latitude=0,**kwargs)[source]#

Bases:GeoAxes

Build an Axes in a figure.

Parameters:
figFigure

The Axes is built in theFigurefig.

*args

*args can be a single(left,bottom,width,height)rectangle or a singleBbox. This specifies the rectangle (infigure coordinates) where the Axes is positioned.

*args can also consist of three numbers or a single three-digitnumber; in the latter case, the digits are considered asindependent numbers. The numbers are interpreted as(nrows,ncols,index):(nrows,ncols) specifies the size of an arrayof subplots, andindex is the 1-based index of the subplotbeing created. Finally,*args can also directly be aSubplotSpec instance.

sharex, shareyAxes, optional

The x- or y-axis is shared with the x- or y-axis inthe inputAxes. Note that it is not possible to unshareaxes.

frameonbool, default: True

Whether the Axes frame is visible.

box_aspectfloat, optional

Set a fixed aspect for the Axes box, i.e. the ratio of height towidth. Seeset_box_aspect for details.

forward_navigation_eventsbool or "auto", default: "auto"

Control whether pan/zoom events are passed through to Axes belowthis one. "auto" isTrue for axes with an invisible patch andFalse otherwise.

**kwargs

Other optional keyword arguments:

Property

Description

adjustable

{'box', 'datalim'}

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

float or None

anchor

(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

animated

bool

aspect

{'auto', 'equal'} or float

autoscale_on

bool

autoscalex_on

unknown

autoscaley_on

unknown

axes_locator

Callable[[Axes, Renderer], Bbox]

axisbelow

bool or 'line'

box_aspect

float or None

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

facecolor orfc

color

figure

Figure orSubFigure

forward_navigation_events

bool or "auto"

frame_on

bool

gid

str

in_layout

bool

label

object

mouseover

bool

navigate

bool

navigate_mode

unknown

path_effects

list ofAbstractPathEffect

picker

None or bool or float or callable

position

[left, bottom, width, height] orBbox

prop_cycle

Cycler

rasterization_zorder

float or None

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

subplotspec

unknown

title

str

transform

Transform

url

str

visible

bool

xbound

(lower: float, upper: float)

xinverted

unknown

xlabel

str

xlim

(left: float, right: float)

xmargin

float greater than -0.5

xscale

unknown

xticklabels

unknown

xticks

unknown

ybound

(lower: float, upper: float)

yinverted

unknown

ylabel

str

ylim

(bottom: float, top: float)

ymargin

float greater than -0.5

yscale

unknown

yticklabels

unknown

yticks

unknown

zorder

float

Returns:
Axes

The newAxes object.

classInvertedLambertTransform(center_longitude,center_latitude,resolution)[source]#

Bases:_GeoTransform

Create a new geographical transform.

Resolution is the number of steps to interpolate between each inputline segment to approximate its path in curved space.

has_inverse=True#

True if this transform has a corresponding inverse transform.

inverted()[source]#

Return the corresponding inverse transformation.

It holdsx==self.inverted().transform(self.transform(x)).

The return value of this method should be treated astemporary. An update toself does not cause a correspondingupdate to its inverted copy.

transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent totransform_affine(transform_non_affine(values)).

In non-affine transformations, this is generally equivalent totransform(values). In affine transformations, this isalways a no-op.

Parameters:
valuesarray

The input values as an array of lengthinput_dims orshape (N,input_dims).

Returns:
array

The output values as an array of lengthoutput_dims or shape(N,output_dims),depending on the input.

classLambertTransform(center_longitude,center_latitude,resolution)[source]#

Bases:_GeoTransform

The base Lambert transform.

Create a new Lambert transform. Resolution is the number of stepsto interpolate between each input line segment to approximate itspath in curved Lambert space.

has_inverse=True#

True if this transform has a corresponding inverse transform.

inverted()[source]#

Return the corresponding inverse transformation.

It holdsx==self.inverted().transform(self.transform(x)).

The return value of this method should be treated astemporary. An update toself does not cause a correspondingupdate to its inverted copy.

transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent totransform_affine(transform_non_affine(values)).

In non-affine transformations, this is generally equivalent totransform(values). In affine transformations, this isalways a no-op.

Parameters:
valuesarray

The input values as an array of lengthinput_dims orshape (N,input_dims).

Returns:
array

The output values as an array of lengthoutput_dims or shape(N,output_dims),depending on the input.

clear()[source]#

Clear the Axes.

name='lambert'#
set(*,adjustable=<UNSET>,agg_filter=<UNSET>,alpha=<UNSET>,anchor=<UNSET>,animated=<UNSET>,aspect=<UNSET>,autoscale_on=<UNSET>,autoscalex_on=<UNSET>,autoscaley_on=<UNSET>,axes_locator=<UNSET>,axisbelow=<UNSET>,box_aspect=<UNSET>,clip_box=<UNSET>,clip_on=<UNSET>,clip_path=<UNSET>,facecolor=<UNSET>,forward_navigation_events=<UNSET>,frame_on=<UNSET>,gid=<UNSET>,in_layout=<UNSET>,label=<UNSET>,latitude_grid=<UNSET>,longitude_grid=<UNSET>,longitude_grid_ends=<UNSET>,mouseover=<UNSET>,navigate=<UNSET>,path_effects=<UNSET>,picker=<UNSET>,position=<UNSET>,prop_cycle=<UNSET>,rasterization_zorder=<UNSET>,rasterized=<UNSET>,sketch_params=<UNSET>,snap=<UNSET>,subplotspec=<UNSET>,title=<UNSET>,transform=<UNSET>,url=<UNSET>,visible=<UNSET>,xbound=<UNSET>,xinverted=<UNSET>,xlabel=<UNSET>,xlim=<UNSET>,xmargin=<UNSET>,xscale=<UNSET>,xticklabels=<UNSET>,xticks=<UNSET>,ybound=<UNSET>,yinverted=<UNSET>,ylabel=<UNSET>,ylim=<UNSET>,ymargin=<UNSET>,yscale=<UNSET>,yticklabels=<UNSET>,yticks=<UNSET>,zorder=<UNSET>)[source]#

Set multiple properties at once.

Supported properties are

Property

Description

adjustable

{'box', 'datalim'}

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

float or None

anchor

(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

animated

bool

aspect

{'auto', 'equal'} or float

autoscale_on

bool

autoscalex_on

unknown

autoscaley_on

unknown

axes_locator

Callable[[Axes, Renderer], Bbox]

axisbelow

bool or 'line'

box_aspect

float or None

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

facecolor orfc

color

figure

Figure orSubFigure

forward_navigation_events

bool or "auto"

frame_on

bool

gid

str

in_layout

bool

label

object

latitude_grid

unknown

longitude_grid

unknown

longitude_grid_ends

unknown

mouseover

bool

navigate

bool

navigate_mode

unknown

path_effects

list ofAbstractPathEffect

picker

None or bool or float or callable

position

[left, bottom, width, height] orBbox

prop_cycle

Cycler

rasterization_zorder

float or None

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

subplotspec

unknown

title

str

transform

Transform

url

str

visible

bool

xbound

unknown

xinverted

unknown

xlabel

str

xlim

unknown

xmargin

float greater than -0.5

xscale

unknown

xticklabels

unknown

xticks

unknown

ybound

unknown

yinverted

unknown

ylabel

str

ylim

unknown

ymargin

float greater than -0.5

yscale

unknown

yticklabels

unknown

yticks

unknown

zorder

float

classmatplotlib.projections.geo.MollweideAxes(*args,**kwargs)[source]#

Bases:GeoAxes

Build an Axes in a figure.

Parameters:
figFigure

The Axes is built in theFigurefig.

*args

*args can be a single(left,bottom,width,height)rectangle or a singleBbox. This specifies the rectangle (infigure coordinates) where the Axes is positioned.

*args can also consist of three numbers or a single three-digitnumber; in the latter case, the digits are considered asindependent numbers. The numbers are interpreted as(nrows,ncols,index):(nrows,ncols) specifies the size of an arrayof subplots, andindex is the 1-based index of the subplotbeing created. Finally,*args can also directly be aSubplotSpec instance.

sharex, shareyAxes, optional

The x- or y-axis is shared with the x- or y-axis inthe inputAxes. Note that it is not possible to unshareaxes.

frameonbool, default: True

Whether the Axes frame is visible.

box_aspectfloat, optional

Set a fixed aspect for the Axes box, i.e. the ratio of height towidth. Seeset_box_aspect for details.

forward_navigation_eventsbool or "auto", default: "auto"

Control whether pan/zoom events are passed through to Axes belowthis one. "auto" isTrue for axes with an invisible patch andFalse otherwise.

**kwargs

Other optional keyword arguments:

Property

Description

adjustable

{'box', 'datalim'}

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

float or None

anchor

(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

animated

bool

aspect

{'auto', 'equal'} or float

autoscale_on

bool

autoscalex_on

unknown

autoscaley_on

unknown

axes_locator

Callable[[Axes, Renderer], Bbox]

axisbelow

bool or 'line'

box_aspect

float or None

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

facecolor orfc

color

figure

Figure orSubFigure

forward_navigation_events

bool or "auto"

frame_on

bool

gid

str

in_layout

bool

label

object

mouseover

bool

navigate

bool

navigate_mode

unknown

path_effects

list ofAbstractPathEffect

picker

None or bool or float or callable

position

[left, bottom, width, height] orBbox

prop_cycle

Cycler

rasterization_zorder

float or None

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

subplotspec

unknown

title

str

transform

Transform

url

str

visible

bool

xbound

(lower: float, upper: float)

xinverted

unknown

xlabel

str

xlim

(left: float, right: float)

xmargin

float greater than -0.5

xscale

unknown

xticklabels

unknown

xticks

unknown

ybound

(lower: float, upper: float)

yinverted

unknown

ylabel

str

ylim

(bottom: float, top: float)

ymargin

float greater than -0.5

yscale

unknown

yticklabels

unknown

yticks

unknown

zorder

float

Returns:
Axes

The newAxes object.

classInvertedMollweideTransform(resolution)[source]#

Bases:_GeoTransform

Create a new geographical transform.

Resolution is the number of steps to interpolate between each inputline segment to approximate its path in curved space.

has_inverse=True#

True if this transform has a corresponding inverse transform.

inverted()[source]#

Return the corresponding inverse transformation.

It holdsx==self.inverted().transform(self.transform(x)).

The return value of this method should be treated astemporary. An update toself does not cause a correspondingupdate to its inverted copy.

transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent totransform_affine(transform_non_affine(values)).

In non-affine transformations, this is generally equivalent totransform(values). In affine transformations, this isalways a no-op.

Parameters:
valuesarray

The input values as an array of lengthinput_dims orshape (N,input_dims).

Returns:
array

The output values as an array of lengthoutput_dims or shape(N,output_dims),depending on the input.

classMollweideTransform(resolution)[source]#

Bases:_GeoTransform

The base Mollweide transform.

Create a new geographical transform.

Resolution is the number of steps to interpolate between each inputline segment to approximate its path in curved space.

has_inverse=True#

True if this transform has a corresponding inverse transform.

inverted()[source]#

Return the corresponding inverse transformation.

It holdsx==self.inverted().transform(self.transform(x)).

The return value of this method should be treated astemporary. An update toself does not cause a correspondingupdate to its inverted copy.

transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent totransform_affine(transform_non_affine(values)).

In non-affine transformations, this is generally equivalent totransform(values). In affine transformations, this isalways a no-op.

Parameters:
valuesarray

The input values as an array of lengthinput_dims orshape (N,input_dims).

Returns:
array

The output values as an array of lengthoutput_dims or shape(N,output_dims),depending on the input.

name='mollweide'#
set(*,adjustable=<UNSET>,agg_filter=<UNSET>,alpha=<UNSET>,anchor=<UNSET>,animated=<UNSET>,aspect=<UNSET>,autoscale_on=<UNSET>,autoscalex_on=<UNSET>,autoscaley_on=<UNSET>,axes_locator=<UNSET>,axisbelow=<UNSET>,box_aspect=<UNSET>,clip_box=<UNSET>,clip_on=<UNSET>,clip_path=<UNSET>,facecolor=<UNSET>,forward_navigation_events=<UNSET>,frame_on=<UNSET>,gid=<UNSET>,in_layout=<UNSET>,label=<UNSET>,latitude_grid=<UNSET>,longitude_grid=<UNSET>,longitude_grid_ends=<UNSET>,mouseover=<UNSET>,navigate=<UNSET>,path_effects=<UNSET>,picker=<UNSET>,position=<UNSET>,prop_cycle=<UNSET>,rasterization_zorder=<UNSET>,rasterized=<UNSET>,sketch_params=<UNSET>,snap=<UNSET>,subplotspec=<UNSET>,title=<UNSET>,transform=<UNSET>,url=<UNSET>,visible=<UNSET>,xbound=<UNSET>,xinverted=<UNSET>,xlabel=<UNSET>,xlim=<UNSET>,xmargin=<UNSET>,xscale=<UNSET>,xticklabels=<UNSET>,xticks=<UNSET>,ybound=<UNSET>,yinverted=<UNSET>,ylabel=<UNSET>,ylim=<UNSET>,ymargin=<UNSET>,yscale=<UNSET>,yticklabels=<UNSET>,yticks=<UNSET>,zorder=<UNSET>)[source]#

Set multiple properties at once.

Supported properties are

Property

Description

adjustable

{'box', 'datalim'}

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

float or None

anchor

(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

animated

bool

aspect

{'auto', 'equal'} or float

autoscale_on

bool

autoscalex_on

unknown

autoscaley_on

unknown

axes_locator

Callable[[Axes, Renderer], Bbox]

axisbelow

bool or 'line'

box_aspect

float or None

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

facecolor orfc

color

figure

Figure orSubFigure

forward_navigation_events

bool or "auto"

frame_on

bool

gid

str

in_layout

bool

label

object

latitude_grid

unknown

longitude_grid

unknown

longitude_grid_ends

unknown

mouseover

bool

navigate

bool

navigate_mode

unknown

path_effects

list ofAbstractPathEffect

picker

None or bool or float or callable

position

[left, bottom, width, height] orBbox

prop_cycle

Cycler

rasterization_zorder

float or None

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

subplotspec

unknown

title

str

transform

Transform

url

str

visible

bool

xbound

unknown

xinverted

unknown

xlabel

str

xlim

unknown

xmargin

float greater than -0.5

xscale

unknown

xticklabels

unknown

xticks

unknown

ybound

unknown

yinverted

unknown

ylabel

str

ylim

unknown

ymargin

float greater than -0.5

yscale

unknown

yticklabels

unknown

yticks

unknown

zorder

float

On this page