matplotlib.projections.geo — Matplotlib 3.10.3 documentation (original) (raw)

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

Build an Axes in a figure.

Parameters:

The Axes is built in the Figure fig.

*args

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

*args can also consist of three numbers or a single three-digit number; in the latter case, the digits are considered as independent numbers. The numbers are interpreted as (nrows, ncols, index): (nrows, ncols) specifies the size of an array of subplots, and index is the 1-based index of the subplot being 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 in the input Axes. Note that it is not possible to unshare axes.

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 to width. See set_box_aspect for details.

forward_navigation_eventsbool or "auto", default: "auto"

Control whether pan/zoom events are passed through to Axes below this one. "auto" is True for axes with an invisible patch and_False_ otherwise.

**kwargs

Other optional keyword arguments:

Returns:

Axes

The new Axes object.

class AitoffTransform(resolution)[source]#

Bases: _GeoTransform

The base Aitoff transform.

Create a new geographical transform.

Resolution is the number of steps to interpolate between each input line 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 holds x == self.inverted().transform(self.transform(x)).

The return value of this method should be treated as temporary. An update to self does not cause a corresponding update 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 is always a no-op.

Parameters:

valuesarray

The input values as an array of length input_dims or shape (N, input_dims).

Returns:

array

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

class InvertedAitoffTransform(resolution)[source]#

Bases: _GeoTransform

Create a new geographical transform.

Resolution is the number of steps to interpolate between each input line 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 holds x == self.inverted().transform(self.transform(x)).

The return value of this method should be treated as temporary. An update to self does not cause a corresponding update 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 is always a no-op.

Parameters:

valuesarray

The input values as an array of length input_dims or shape (N, input_dims).

Returns:

array

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

name = 'aitoff'#

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

Set multiple properties at once.

Supported properties are

class matplotlib.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 the Figure fig.

*args

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

sharex, shareyAxes, optional

The x- or y-axis is shared with the x- or y-axis in the input Axes. Note that it is not possible to unshare axes.

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 to width. See set_box_aspect for details.

forward_navigation_eventsbool or "auto", default: "auto"

Control whether pan/zoom events are passed through to Axes below this one. "auto" is True for axes with an invisible patch and_False_ otherwise.

**kwargs

Other optional keyword arguments:

Returns:

Axes

The new Axes object.

RESOLUTION = 75#

class ThetaFormatter(round_to=1.0)[source]#

Bases: Formatter

Used to format the theta tick labels. Converts the native unit 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 add_pad_points_ of padding (in points) between the axis and the label. The x-direction is in data coordinates and the y-direction is 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 the Axisclass, and is meant to be overridden by new kinds of projections that may 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 will add pad_points of padding (in points) between the axis and the label. The x-direction is in data coordinates and the y-direction is 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 the Axisclass, and is meant to be overridden by new kinds of projections that may need to place axis elements in different locations.

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

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

Note

This transformation is primarily used by theAxis class, and is meant to be overridden by new kinds of projections that may need to place 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 add_pad_points_ of padding (in points) between the axis and the label. The x-direction is in axis coordinates and the y-direction is 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 the Axisclass, and is meant to be overridden by new kinds of projections that may need to place axis elements in different locations.

get_yaxis_text2_transform(pad)[source]#

Returns:

transformTransform

The transform used for drawing secondart y-axis labels, which will add pad_points of padding (in points) between the axis and the label. The x-direction is in axis coordinates and the y-direction is 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 the Axisclass, and is meant to be overridden by new kinds of projections that may need to place axis elements in different locations.

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

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

Note

This transformation is primarily used by theAxis class, and is meant to be overridden by new kinds of projections that may need to place 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 multiple properties at once.

Supported properties are

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 or ScaleBase

The axis scale type to apply. Valid string values are the names of scale classes ("linear", "log", "function",...). These may be the names of any of the built-in scales or of any custom scales registered using matplotlib.scale.register_scale.

**kwargs

If value is a string, keywords are passed to the instantiation method of the 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 or ScaleBase

**kwargs

If value is a string, keywords are passed to the instantiation method of the 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.

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

Bases: GeoAxes

Build an Axes in a figure.

Parameters:

figFigure

The Axes is built in the Figure fig.

*args

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

sharex, shareyAxes, optional

The x- or y-axis is shared with the x- or y-axis in the input Axes. Note that it is not possible to unshare axes.

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 to width. See set_box_aspect for details.

forward_navigation_eventsbool or "auto", default: "auto"

Control whether pan/zoom events are passed through to Axes below this one. "auto" is True for axes with an invisible patch and_False_ otherwise.

**kwargs

Other optional keyword arguments:

Returns:

Axes

The new Axes object.

class HammerTransform(resolution)[source]#

Bases: _GeoTransform

The base Hammer transform.

Create a new geographical transform.

Resolution is the number of steps to interpolate between each input line 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 holds x == self.inverted().transform(self.transform(x)).

The return value of this method should be treated as temporary. An update to self does not cause a corresponding update 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 is always a no-op.

Parameters:

valuesarray

The input values as an array of length input_dims or shape (N, input_dims).

Returns:

array

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

class InvertedHammerTransform(resolution)[source]#

Bases: _GeoTransform

Create a new geographical transform.

Resolution is the number of steps to interpolate between each input line 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 holds x == self.inverted().transform(self.transform(x)).

The return value of this method should be treated as temporary. An update to self does not cause a corresponding update 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 is always a no-op.

Parameters:

valuesarray

The input values as an array of length input_dims or shape (N, input_dims).

Returns:

array

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

name = 'hammer'#

Set multiple properties at once.

Supported properties are

class matplotlib.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 the Figure fig.

*args

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

sharex, shareyAxes, optional

The x- or y-axis is shared with the x- or y-axis in the input Axes. Note that it is not possible to unshare axes.

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 to width. See set_box_aspect for details.

forward_navigation_eventsbool or "auto", default: "auto"

Control whether pan/zoom events are passed through to Axes below this one. "auto" is True for axes with an invisible patch and_False_ otherwise.

**kwargs

Other optional keyword arguments:

Returns:

Axes

The new Axes object.

class InvertedLambertTransform(center_longitude, center_latitude, resolution)[source]#

Bases: _GeoTransform

Create a new geographical transform.

Resolution is the number of steps to interpolate between each input line 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 holds x == self.inverted().transform(self.transform(x)).

The return value of this method should be treated as temporary. An update to self does not cause a corresponding update 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 is always a no-op.

Parameters:

valuesarray

The input values as an array of length input_dims or shape (N, input_dims).

Returns:

array

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

class LambertTransform(center_longitude, center_latitude, resolution)[source]#

Bases: _GeoTransform

The base Lambert transform.

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

has_inverse = True#

True if this transform has a corresponding inverse transform.

inverted()[source]#

Return the corresponding inverse transformation.

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

The return value of this method should be treated as temporary. An update to self does not cause a corresponding update 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 is always a no-op.

Parameters:

valuesarray

The input values as an array of length input_dims or shape (N, input_dims).

Returns:

array

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

clear()[source]#

Clear the Axes.

name = 'lambert'#

Set multiple properties at once.

Supported properties are

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

Bases: GeoAxes

Build an Axes in a figure.

Parameters:

figFigure

The Axes is built in the Figure fig.

*args

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

sharex, shareyAxes, optional

The x- or y-axis is shared with the x- or y-axis in the input Axes. Note that it is not possible to unshare axes.

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 to width. See set_box_aspect for details.

forward_navigation_eventsbool or "auto", default: "auto"

Control whether pan/zoom events are passed through to Axes below this one. "auto" is True for axes with an invisible patch and_False_ otherwise.

**kwargs

Other optional keyword arguments:

Returns:

Axes

The new Axes object.

class InvertedMollweideTransform(resolution)[source]#

Bases: _GeoTransform

Create a new geographical transform.

Resolution is the number of steps to interpolate between each input line 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 holds x == self.inverted().transform(self.transform(x)).

The return value of this method should be treated as temporary. An update to self does not cause a corresponding update 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 is always a no-op.

Parameters:

valuesarray

The input values as an array of length input_dims or shape (N, input_dims).

Returns:

array

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

class MollweideTransform(resolution)[source]#

Bases: _GeoTransform

The base Mollweide transform.

Create a new geographical transform.

Resolution is the number of steps to interpolate between each input line 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 holds x == self.inverted().transform(self.transform(x)).

The return value of this method should be treated as temporary. An update to self does not cause a corresponding update 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 is always a no-op.

Parameters:

valuesarray

The input values as an array of length input_dims or shape (N, input_dims).

Returns:

array

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

name = 'mollweide'#

Set multiple properties at once.

Supported properties are