matplotlib.projections.polar#

class matplotlib.projections.polar.InvertedPolarTransform(axis=None, use_rmin=True, *, apply_theta_transforms=<deprecated parameter>)[source]#

Bases: Transform

The inverse of the polar transform, mapping Cartesian coordinate space x and y back to theta and r.

Parameters:

axisAxis, optional

Axis associated with this transform. This is used to get the minimum radial limit.

use_rminbool, optional

If True, add the minimum radial axis limit after transforming from Cartesian coordinates. axis must also be specified for this to take effect.

has_inverse = True#

True if this transform has a corresponding inverse transform.

input_dims = 2#

The number of input dimensions of this transform. Must be overridden (with integers) in the subclass.

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.

output_dims = 2#

The number of output dimensions of this transform. Must be overridden (with integers) in the subclass.

transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent to transform_affine(transform_non_affine(values)).

In non-affine transformations, this is generally equivalent to transform(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 matplotlib.projections.polar.PolarAffine(scale_transform, limits)[source]#

Bases: Affine2DBase

The affine part of the polar projection.

Scales the output so that maximum radius rests on the edge of the Axes circle and the origin is mapped to (0.5, 0.5). The transform applied is the same to x and y components and given by:

\[x_{1} = 0.5 \left [ \frac{x_{0}}{(r_{\max} - r_{\min})} + 1 \right ]\]

\(r_{\min}, r_{\max}\) are the minimum and maximum radial limits after any scaling (e.g. log scaling) has been removed.

Parameters:

scale_transformTransform

Scaling transform for the data. This is used to remove any scaling from the radial view limits.

limitsBboxBase

View limits of the data. The only part of its bounds that is used is the y limits (for the radius limits).

get_matrix()[source]#

Get the matrix for the affine part of this transform.

class matplotlib.projections.polar.PolarAxes(*args, theta_offset=0, theta_direction=1, rlabel_position=22.5, **kwargs)[source]#

Bases: Axes

A polar graph projection, where the input dimensions are theta, r.

Theta starts pointing east and goes anti-clockwise.

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.

*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 a SubplotSpec 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:

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 or fc	color
figure	Figure or SubFigure
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 of AbstractPathEffect
picker	None or bool or float or callable
position	[left, bottom, width, height] or Bbox
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 new Axes object.

class InvertedPolarTransform(axis=None, use_rmin=True, *, apply_theta_transforms=<deprecated parameter>)[source]#

Bases: Transform

The inverse of the polar transform, mapping Cartesian coordinate space x and y back to theta and r.

Parameters:

axisAxis, optional

Axis associated with this transform. This is used to get the minimum radial limit.

use_rminbool, optional

If True, add the minimum radial axis limit after transforming from Cartesian coordinates. axis must also be specified for this to take effect.

has_inverse = True#

True if this transform has a corresponding inverse transform.

input_dims = 2#

The number of input dimensions of this transform. Must be overridden (with integers) in the subclass.

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.

output_dims = 2#

The number of output dimensions of this transform. Must be overridden (with integers) in the subclass.

transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent to transform_affine(transform_non_affine(values)).

In non-affine transformations, this is generally equivalent to transform(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 PolarAffine(scale_transform, limits)[source]#

Bases: Affine2DBase

The affine part of the polar projection.

Scales the output so that maximum radius rests on the edge of the Axes circle and the origin is mapped to (0.5, 0.5). The transform applied is the same to x and y components and given by:

\[x_{1} = 0.5 \left [ \frac{x_{0}}{(r_{\max} - r_{\min})} + 1 \right ]\]

\(r_{\min}, r_{\max}\) are the minimum and maximum radial limits after any scaling (e.g. log scaling) has been removed.

Parameters:

scale_transformTransform

Scaling transform for the data. This is used to remove any scaling from the radial view limits.

limitsBboxBase

View limits of the data. The only part of its bounds that is used is the y limits (for the radius limits).

get_matrix()[source]#

Get the matrix for the affine part of this transform.

class PolarTransform(axis=None, use_rmin=True, *, apply_theta_transforms=<deprecated parameter>, scale_transform=None)[source]#

Bases: Transform

The base polar transform.

This transform maps polar coordinates \(\theta, r\) into Cartesian coordinates \(x, y = r \cos(\theta), r \sin(\theta)\) (but does not fully transform into Axes coordinates or handle positioning in screen space).

This transformation is designed to be applied to data after any scaling along the radial axis (e.g. log-scaling) has been applied to the input data.

Path segments at a fixed radius are automatically transformed to circular arcs as long as path._interpolation_steps > 1.

Parameters:

axisAxis, optional

Axis associated with this transform. This is used to get the minimum radial limit.

use_rminbool, optional

If True, subtract the minimum radial axis limit before transforming to Cartesian coordinates. axis must also be specified for this to take effect.

has_inverse = True#

True if this transform has a corresponding inverse transform.

input_dims = 2#

The number of input dimensions of this transform. Must be overridden (with integers) in the subclass.

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.

output_dims = 2#

The number of output dimensions of this transform. Must be overridden (with integers) in the subclass.

transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent to transform_affine(transform_non_affine(values)).

In non-affine transformations, this is generally equivalent to transform(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.

transform_path_non_affine(path)[source]#

Apply the non-affine part of this transform to Path path, returning a new Path.

transform_path(path) is equivalent to transform_path_affine(transform_path_non_affine(values)).

class RadialLocator(base, axes=<deprecated parameter>)[source]#

Bases: Locator

Used to locate radius ticks.

Ensures that all ticks are strictly positive. For all other tasks, it delegates to the base Locator (which may be different depending on the scale of the r-axis).

nonsingular(vmin, vmax)[source]#

Adjust a range as needed to avoid singularities.

This method gets called during autoscaling, with (v0, v1) set to the data limits on the Axes if the Axes contains any data, or (-inf, +inf) if not.

• If v0 == v1 (possibly up to some floating point slop), this method returns an expanded interval around this value.

• If (v0, v1) == (-inf, +inf), this method returns appropriate default view limits.

• Otherwise, (v0, v1) is returned without modification.

set_axis(axis)[source]#

view_limits(vmin, vmax)[source]#

Select a scale for the range from vmin to vmax.

Subclasses should override this method to change locator behaviour.

class ThetaFormatter[source]#

Bases: Formatter

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

class ThetaLocator(base)[source]#

Bases: Locator

Used to locate theta ticks.

This will work the same as the base locator except in the case that the view spans the entire circle. In such cases, the previously used default locations of every 45 degrees are returned.

set_axis(axis)[source]#

view_limits(vmin, vmax)[source]#

Select a scale for the range from vmin to vmax.

Subclasses should override this method to change locator behaviour.

can_pan()[source]#

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

For a polar Axes, this is slightly misleading. Both panning and zooming are performed by the same button. Panning is performed in azimuth while zooming is done along the radial.

can_zoom()[source]#

Return whether this Axes supports the zoom box button functionality.

A polar Axes does not support zoom boxes.

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.

draw(renderer)[source]#

Draw the Artist (and its children) using the given renderer.

This has no effect if the artist is not visible (Artist.get_visible returns False).

Parameters:

rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

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(theta, r)[source]#

Return a format string formatting the x, y coordinates.

get_data_ratio()[source]#

Return the aspect ratio of the data itself. For a polar plot, this should always be 1.0

get_rlabel_position()[source]#

Returns:

float

The theta position of the radius labels in degrees.

get_rmax()[source]#

Returns:

float

Outer radial limit.

get_rmin()[source]#

Returns:

float

The inner radial limit.

get_rorigin()[source]#

Returns:

float

get_rsign()[source]#

get_theta_direction()[source]#

Get the direction in which theta increases.

-1:

Theta increases in the clockwise direction

1:

Theta increases in the counterclockwise direction

get_theta_offset()[source]#

Get the offset for the location of 0 in radians.

get_thetamax()[source]#

Return the maximum theta limit in degrees.

get_thetamin()[source]#

Get the minimum theta limit in degrees.

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 Axis class, 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 Axis class, 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 the Axis 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 Axis class, 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 secondary 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 Axis class, 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 the Axis 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'}

name = 'polar'#

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>, mouseover=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, rgrids=<UNSET>, rlabel_position=<UNSET>, rlim=<UNSET>, rmax=<UNSET>, rmin=<UNSET>, rorigin=<UNSET>, rscale=<UNSET>, rticks=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, subplotspec=<UNSET>, theta_direction=<UNSET>, theta_offset=<UNSET>, theta_zero_location=<UNSET>, thetagrids=<UNSET>, thetalim=<UNSET>, thetamax=<UNSET>, thetamin=<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.

a.set(a=A, b=B, c=C)

is equivalent to

a.set_a(A)
a.set_b(B)
a.set_c(C)

In addition to the full property names, aliases are also supported, e.g. set(lw=2) is equivalent to set(linewidth=2), but it is an error to pass both simultaneously.

The order of the individual setter calls matches the order of parameters in set(). However, most properties do not depend on each other so that order is rarely relevant.

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 or fc	color
figure	Figure or SubFigure
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 of AbstractPathEffect
picker	None or bool or float or callable
position	[left, bottom, width, height] or Bbox
prop_cycle	Cycler
rasterization_zorder	float or None
rasterized	bool
rgrids	tuple with floats
rlabel_position	number
rlim	unknown
rmax	float
rmin	float
rorigin	float
rscale	unknown
rticks	unknown
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
subplotspec	unknown
theta_direction	unknown
theta_offset	unknown
theta_zero_location	str
thetagrids	tuple with floats, degrees
thetalim	unknown
thetamax	unknown
thetamin	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

set_rgrids(radii, labels=None, angle=None, fmt=None, **kwargs)[source]#

Set the radial gridlines on a polar plot.

Parameters:

radiituple with floats

The radii for the radial gridlines

labelstuple with strings or None

The labels to use at each radial gridline. The matplotlib.ticker.ScalarFormatter will be used if None.

anglefloat

The angular position of the radius labels in degrees.

fmtstr or None

Format string used in matplotlib.ticker.FormatStrFormatter. For example '%f'.

Returns:

lineslist of lines.Line2D

The radial gridlines.

labelslist of text.Text

The tick labels.

Other Parameters:

**kwargs

kwargs are optional Text properties for the labels.

Warning

This only sets the properties of the current ticks. Ticks are not guaranteed to be persistent. Various operations can create, delete and modify the Tick instances. There is an imminent risk that these settings can get lost if you work on the figure further (including also panning/zooming on a displayed figure).

Use set_tick_params instead if possible.

See also

PolarAxes.set_thetagrids

Axis.get_gridlines

Axis.get_ticklabels

set_rlabel_position(value)[source]#

Update the theta position of the radius labels.

Parameters:

valuenumber

The angular position of the radius labels in degrees.

set_rlim(bottom=None, top=None, *, emit=True, auto=False, **kwargs)[source]#

Set the radial axis view limits.

This function behaves like Axes.set_ylim, but additionally supports rmin and rmax as aliases for bottom and top.

See also

Axes.set_ylim

set_rmax(rmax)[source]#

Set the outer radial limit.

Parameters:

rmaxfloat

set_rmin(rmin)[source]#

Set the inner radial limit.

Parameters:

rminfloat

set_rorigin(rorigin)[source]#

Update the radial origin.

Parameters:

roriginfloat

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

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

set_theta_direction(direction)[source]#

Set the direction in which theta increases.

clockwise, -1:

Theta increases in the clockwise direction

counterclockwise, anticlockwise, 1:

Theta increases in the counterclockwise direction

set_theta_offset(offset)[source]#

Set the offset for the location of 0 in radians.

set_theta_zero_location(loc, offset=0.0)[source]#

Set the location of theta's zero.

This simply calls set_theta_offset with the correct value in radians.

Parameters:

locstr

May be one of "N", "NW", "W", "SW", "S", "SE", "E", or "NE".

offsetfloat, default: 0

An offset in degrees to apply from the specified loc. Note: this offset is always applied counter-clockwise regardless of the direction setting.

set_thetagrids(angles, labels=None, fmt=None, **kwargs)[source]#

Set the theta gridlines in a polar plot.

Parameters:

anglestuple with floats, degrees

The angles of the theta gridlines.

labelstuple with strings or None

The labels to use at each theta gridline. The projections.polar.ThetaFormatter will be used if None.

fmtstr or None

Format string used in matplotlib.ticker.FormatStrFormatter. For example '%f'. Note that the angle that is used is in radians.

Returns:

lineslist of lines.Line2D

The theta gridlines.

labelslist of text.Text

The tick labels.

Other Parameters:

**kwargs

kwargs are optional Text properties for the labels.

Warning

This only sets the properties of the current ticks. Ticks are not guaranteed to be persistent. Various operations can create, delete and modify the Tick instances. There is an imminent risk that these settings can get lost if you work on the figure further (including also panning/zooming on a displayed figure).

Use set_tick_params instead if possible.

See also

PolarAxes.set_rgrids

Axis.get_gridlines

Axis.get_ticklabels

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

Set the minimum and maximum theta values.

Can take the following signatures:

• set_thetalim(minval, maxval): Set the limits in radians.

• set_thetalim(thetamin=minval, thetamax=maxval): Set the limits in degrees.

where minval and maxval are the minimum and maximum limits. Values are wrapped in to the range \([0, 2\pi]\) (in radians), so for example it is possible to do set_thetalim(-np.pi / 2, np.pi / 2) to have an axis symmetric around 0. A ValueError is raised if the absolute angle difference is larger than a full circle.

set_thetamax(thetamax)[source]#

Set the maximum theta limit in degrees.

set_thetamin(thetamin)[source]#

Set the minimum theta limit in degrees.

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.polar.PolarTransform(axis=None, use_rmin=True, *, apply_theta_transforms=<deprecated parameter>, scale_transform=None)[source]#

Bases: Transform

The base polar transform.

This transform maps polar coordinates \(\theta, r\) into Cartesian coordinates \(x, y = r \cos(\theta), r \sin(\theta)\) (but does not fully transform into Axes coordinates or handle positioning in screen space).

This transformation is designed to be applied to data after any scaling along the radial axis (e.g. log-scaling) has been applied to the input data.

Path segments at a fixed radius are automatically transformed to circular arcs as long as path._interpolation_steps > 1.

Parameters:

axisAxis, optional

Axis associated with this transform. This is used to get the minimum radial limit.

use_rminbool, optional

If True, subtract the minimum radial axis limit before transforming to Cartesian coordinates. axis must also be specified for this to take effect.

has_inverse = True#

True if this transform has a corresponding inverse transform.

input_dims = 2#

The number of input dimensions of this transform. Must be overridden (with integers) in the subclass.

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.

output_dims = 2#

The number of output dimensions of this transform. Must be overridden (with integers) in the subclass.

transform_non_affine(values)[source]#

Apply only the non-affine part of this transformation.

transform(values) is always equivalent to transform_affine(transform_non_affine(values)).

In non-affine transformations, this is generally equivalent to transform(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.

transform_path_non_affine(path)[source]#

Apply the non-affine part of this transform to Path path, returning a new Path.

transform_path(path) is equivalent to transform_path_affine(transform_path_non_affine(values)).

class matplotlib.projections.polar.RadialAxis(*args, **kwargs)[source]#

Bases: YAxis

A radial Axis.

This overrides certain properties of a YAxis to provide special-casing for a radial axis.

Parameters:

axesAxes

The Axes to which the created Axis belongs.

pickradiusfloat

The acceptance radius for containment tests. See also Axis.contains.

clearbool, default: True

Whether to clear the Axis on creation. This is not required, e.g., when creating an Axis as part of an Axes, as Axes.clear will call Axis.clear. .. versionadded:: 3.8

axis_name = 'radius'#

Read-only name identifying the axis.

clear()[source]#

Clear the axis.

This resets axis properties to their default values:

• the label

• the scale

• locators, formatters and ticks

• major and minor grid

• units

• registered callbacks

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, converter=<UNSET>, data_interval=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, inverted=<UNSET>, label=<UNSET>, label_coords=<UNSET>, label_position=<UNSET>, label_text=<UNSET>, major_formatter=<UNSET>, major_locator=<UNSET>, minor_formatter=<UNSET>, minor_locator=<UNSET>, mouseover=<UNSET>, offset_position=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, remove_overlapping_locs=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, tick_params=<UNSET>, ticklabels=<UNSET>, ticks=<UNSET>, ticks_position=<UNSET>, transform=<UNSET>, units=<UNSET>, url=<UNSET>, view_interval=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]#

Set multiple properties at once.

a.set(a=A, b=B, c=C)

is equivalent to

a.set_a(A)
a.set_b(B)
a.set_c(C)

In addition to the full property names, aliases are also supported, e.g. set(lw=2) is equivalent to set(linewidth=2), but it is an error to pass both simultaneously.

The order of the individual setter calls matches the order of parameters in set(). However, most properties do not depend on each other so that order is rarely relevant.

Supported properties are

Property	Description
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
animated	bool
clip_box	BboxBase or None
clip_on	bool
clip_path	Patch or (Path, Transform) or None
converter	ConversionInterface
data_interval	unknown
figure	Figure or SubFigure
gid	str
in_layout	bool
inverted	unknown
label	unknown
label_coords	unknown
label_position	{'left', 'right'}
label_text	str
major_formatter	Formatter, str, or function
major_locator	unknown
minor_formatter	Formatter, str, or function
minor_locator	Locator
mouseover	bool
offset_position	{'left', 'right'}
path_effects	list of AbstractPathEffect
picker	None or bool or float or callable
pickradius	float
rasterized	bool
remove_overlapping_locs	unknown
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
tick_params	unknown
ticklabels	sequence of str or of Texts
ticks	1D array-like
ticks_position	{'left', 'right', 'both', 'default', 'none'}
transform	Transform
units	units tag
url	str
view_interval	unknown
visible	bool
zorder	float

set_major_locator(locator)[source]#

Set the locator of the major ticker.

Parameters:

locatorLocator

class matplotlib.projections.polar.RadialLocator(base, axes=<deprecated parameter>)[source]#

Bases: Locator

Used to locate radius ticks.

Ensures that all ticks are strictly positive. For all other tasks, it delegates to the base Locator (which may be different depending on the scale of the r-axis).

nonsingular(vmin, vmax)[source]#

Adjust a range as needed to avoid singularities.

This method gets called during autoscaling, with (v0, v1) set to the data limits on the Axes if the Axes contains any data, or (-inf, +inf) if not.

• If v0 == v1 (possibly up to some floating point slop), this method returns an expanded interval around this value.

• If (v0, v1) == (-inf, +inf), this method returns appropriate default view limits.

• Otherwise, (v0, v1) is returned without modification.

set_axis(axis)[source]#

view_limits(vmin, vmax)[source]#

Select a scale for the range from vmin to vmax.

Subclasses should override this method to change locator behaviour.

class matplotlib.projections.polar.RadialTick(*args, **kwargs)[source]#

Bases: YTick

A radial-axis tick.

This subclass of YTick provides radial ticks with some small modification to their re-positioning such that ticks are rotated based on axes limits. This results in ticks that are correctly perpendicular to the spine. Labels are also rotated to be perpendicular to the spine, when 'auto' rotation is enabled.

Parameters:

loc

The tick location in data coords.

size

The tick size in points.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, pad=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]#

Set multiple properties at once.

a.set(a=A, b=B, c=C)

is equivalent to

a.set_a(A)
a.set_b(B)
a.set_c(C)

In addition to the full property names, aliases are also supported, e.g. set(lw=2) is equivalent to set(linewidth=2), but it is an error to pass both simultaneously.

The order of the individual setter calls matches the order of parameters in set(). However, most properties do not depend on each other so that order is rarely relevant.

Supported properties are

Property	Description
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
animated	bool
clip_box	BboxBase or None
clip_on	bool
clip_path	Patch or (Path, Transform) or None
figure	Figure or SubFigure
gid	str
in_layout	bool
label	object
mouseover	bool
pad	float
path_effects	list of AbstractPathEffect
picker	None or bool or float or callable
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
transform	Transform
url	str
visible	bool
zorder	float

update_position(loc)[source]#

Set the location of tick in data coords with scalar loc.