matplotlib.projections
¶matplotlib.projections.
ProjectionRegistry
¶Bases: object
Manages the set of projections available to the system.
get_projection_class
(name)¶Get a projection class from its name.
get_projection_names
()¶Get a list of the names of all projections currently registered.
register
(*projections)¶Register a new set of projection(s).
matplotlib.projections.
get_projection_class
(projection=None)¶Get a projection class from its name.
If projection is None, a standard rectilinear projection is returned.
matplotlib.projections.
get_projection_names
()¶Get a list of acceptable projection names.
matplotlib.projections.
process_projection_requirements
(figure, *args, **kwargs)¶Handle the args/kwargs to for add_axes/add_subplot/gca, returning:
(axes_proj_class, proj_class_kwargs, proj_stack_key)
Which can be used for new axes initialization/identification.
Note
kwargs is modified in place.
matplotlib.projections.
register_projection
(cls)¶matplotlib.projections.polar
¶matplotlib.projections.polar.
InvertedPolarTransform
(axis=None, use_rmin=True, _apply_theta_transforms=True)¶Bases: matplotlib.transforms.Transform
The inverse of the polar transform, mapping Cartesian coordinate space x and y back to theta and r.
input_dims
= 2¶inverted
()¶Return the corresponding inverse transformation.
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.
x === self.inverted().transform(self.transform(x))
is_separable
= False¶output_dims
= 2¶transform_non_affine
(xy)¶Performs only the nonaffine part of the transformation.
transform(values)
is always equivalent to
transform_affine(transform_non_affine(values))
.
In nonaffine transformations, this is generally equivalent to
transform(values)
. In affine transformations, this is
always a noop.
Accepts a numpy array of shape (N x input_dims
) and
returns a numpy array of shape (N x output_dims
).
Alternatively, accepts a numpy array of length input_dims
and returns a numpy array of length output_dims
.
matplotlib.projections.polar.
PolarAffine
(scale_transform, limits)¶Bases: matplotlib.transforms.Affine2DBase
The affine part of the polar projection. Scales the output so that maximum radius rests on the edge of the axes circle.
limits is the view limit of the data. The only part of its bounds that is used is the y limits (for the radius limits). The theta range is handled by the nonaffine transform.
get_matrix
()¶Get the Affine transformation array for the affine part of this transform.
matplotlib.projections.polar.
PolarAxes
(*args, **kwargs)¶Bases: matplotlib.axes._axes.Axes
A polar graph projection, where the input dimensions are theta, r.
Theta starts pointing east and goes anticlockwise.
InvertedPolarTransform
(axis=None, use_rmin=True, _apply_theta_transforms=True)¶Bases: matplotlib.transforms.Transform
The inverse of the polar transform, mapping Cartesian coordinate space x and y back to theta and r.
input_dims
= 2¶inverted
()¶Return the corresponding inverse transformation.
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.
x === self.inverted().transform(self.transform(x))
is_separable
= False¶output_dims
= 2¶transform_non_affine
(xy)¶Performs only the nonaffine part of the transformation.
transform(values)
is always equivalent to
transform_affine(transform_non_affine(values))
.
In nonaffine transformations, this is generally equivalent to
transform(values)
. In affine transformations, this is
always a noop.
Accepts a numpy array of shape (N x input_dims
) and
returns a numpy array of shape (N x output_dims
).
Alternatively, accepts a numpy array of length input_dims
and returns a numpy array of length output_dims
.
PolarAffine
(scale_transform, limits)¶Bases: matplotlib.transforms.Affine2DBase
The affine part of the polar projection. Scales the output so that maximum radius rests on the edge of the axes circle.
limits is the view limit of the data. The only part of its bounds that is used is the y limits (for the radius limits). The theta range is handled by the nonaffine transform.
get_matrix
()¶Get the Affine transformation array for the affine part of this transform.
PolarTransform
(axis=None, use_rmin=True, _apply_theta_transforms=True)¶Bases: matplotlib.transforms.Transform
The base polar transform. This handles projection theta and r into Cartesian coordinate space x and y, but does not perform the ultimate affine transformation into the correct position.
input_dims
= 2¶inverted
()¶Return the corresponding inverse transformation.
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.
x === self.inverted().transform(self.transform(x))
is_separable
= False¶output_dims
= 2¶transform_non_affine
(tr)¶Performs only the nonaffine part of the transformation.
transform(values)
is always equivalent to
transform_affine(transform_non_affine(values))
.
In nonaffine transformations, this is generally equivalent to
transform(values)
. In affine transformations, this is
always a noop.
Accepts a numpy array of shape (N x input_dims
) and
returns a numpy array of shape (N x output_dims
).
Alternatively, accepts a numpy array of length input_dims
and returns a numpy array of length output_dims
.
RadialLocator
(base, axes=None)¶Bases: matplotlib.ticker.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 raxis.
autoscale
()¶autoscale the view limits
pan
(numsteps)¶Pan numticks (can be positive or negative)
refresh
()¶refresh internal information based on current lim
view_limits
(vmin, vmax)¶select a scale for the range from vmin to vmax
Normally this method is overridden by subclasses to change locator behaviour.
zoom
(direction)¶Zoom in/out on axis; if direction is >0 zoom in, else zoom out
ThetaFormatter
¶Bases: matplotlib.ticker.Formatter
Used to format the theta tick labels. Converts the native unit of radians into degrees and adds a degree symbol.
ThetaLocator
(base)¶Bases: matplotlib.ticker.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.
autoscale
()¶autoscale the view limits
pan
(numsteps)¶Pan numticks (can be positive or negative)
refresh
()¶refresh internal information based on current lim
set_axis
(axis)¶view_limits
(vmin, vmax)¶select a scale for the range from vmin to vmax
Normally this method is overridden by subclasses to change locator behaviour.
zoom
(direction)¶Zoom in/out on axis; if direction is >0 zoom in, else zoom out
can_pan
()¶Return True if this axes supports the pan/zoom button functionality.
For 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
()¶Return True if this axes supports the zoom box button functionality.
Polar axes do not support zoom boxes.
cla
()¶Clear the current axes.
drag_pan
(button, key, x, y)¶Called when the mouse moves during a pan operation.
button is the mouse button number:
key is a “shift” key
x, y are the mouse coordinates in display coords.
Note
Intended to be overridden by new projection types.
draw
(*args, **kwargs)¶Draw everything (plot lines, axes, labels)
end_pan
()¶Called when a pan operation completes (when the mouse button is up.)
Note
Intended to be overridden by new projection types.
format_coord
(theta, r)¶Return a format string formatting the coordinate using Unicode characters.
get_data_ratio
()¶Return the aspect ratio of the data itself. For a polar plot, this should always be 1.0
get_rlabel_position
()¶Returns:  float


get_rmax
()¶get_rmin
()¶get_rorigin
()¶get_theta_direction
()¶Get the direction in which theta increases.
get_theta_offset
()¶Get the offset for the location of 0 in radians.
get_thetamax
()¶get_thetamin
()¶get_xaxis_text1_transform
(pad)¶Get the transformation used for drawing xaxis labels, which will add the given amount of padding (in points) between the axes and the label. The xdirection is in data coordinates and the ydirection is in axis coordinates. Returns a 3tuple of the form:
(transform, valign, halign)
where valign and halign are requested alignments for the text.
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.
get_xaxis_text2_transform
(pad)¶Get the transformation used for drawing the secondary xaxis labels, which will add the given amount of padding (in points) between the axes and the label. The xdirection is in data coordinates and the ydirection is in axis coordinates. Returns a 3tuple of the form:
(transform, valign, halign)
where valign and halign are requested alignments for the text.
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.
get_xaxis_transform
(which='grid')¶Get the transformation used for drawing xaxis labels, ticks and gridlines. The xdirection is in data coordinates and the ydirection 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.
get_yaxis_text1_transform
(pad)¶Get the transformation used for drawing yaxis labels, which will add the given amount of padding (in points) between the axes and the label. The xdirection is in axis coordinates and the ydirection is in data coordinates. Returns a 3tuple of the form:
(transform, valign, halign)
where valign and halign are requested alignments for the text.
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.
get_yaxis_text2_transform
(pad)¶Get the transformation used for drawing the secondary yaxis labels, which will add the given amount of padding (in points) between the axes and the label. The xdirection is in axis coordinates and the ydirection is in data coordinates. Returns a 3tuple of the form:
(transform, valign, halign)
where valign and halign are requested alignments for the text.
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.
get_yaxis_transform
(which='grid')¶Get the transformation used for drawing yaxis labels, ticks and gridlines. The xdirection is in axis coordinates and the ydirection 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.
name
= 'polar'¶set_rgrids
(radii, labels=None, angle=None, fmt=None, **kwargs)¶Set the radial locations and labels of the r grids.
The labels will appear at radial distances radii at the given angle in degrees.
labels, if not None, is a len(radii)
list of strings of the
labels to use at each radius.
If labels is None, the builtin formatter will be used.
Return value is a list of tuples (line, label), where
line is Line2D
instances and the
label is Text
instances.
kwargs are optional text properties for the labels:
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 alpha
float (0.0 transparent through 1.0 opaque) animated
bool backgroundcolor
any matplotlib color bbox
FancyBboxPatch prop dict clip_box
a matplotlib.transforms.Bbox
instanceclip_on
bool clip_path
[ ( Path
,Transform
) Patch
 None ]color
any matplotlib color contains
a callable function family
or fontfamily or fontname or name[FONTNAME  ‘serif’  ‘sansserif’  ‘cursive’  ‘fantasy’  ‘monospace’ ] figure
a Figure
instancefontproperties
or font_propertiesa matplotlib.font_manager.FontProperties
instancegid
an id string horizontalalignment
or ha[ ‘center’  ‘right’  ‘left’ ] label
object linespacing
float (multiple of font size) multialignment
or ma[‘left’  ‘right’  ‘center’ ] path_effects
AbstractPathEffect
picker
[None  bool  float  callable] position
(x,y) rasterized
bool or None rotation
[ angle in degrees  ‘vertical’  ‘horizontal’ ] rotation_mode
[ None  “default”  “anchor” ] size
or fontsize[size in points  ‘xxsmall’  ‘xsmall’  ‘small’  ‘medium’  ‘large’  ‘xlarge’  ‘xxlarge’ ] sketch_params
(scale: float, length: float, randomness: float) snap
bool or None stretch
or fontstretch[a numeric value in range 01000  ‘ultracondensed’  ‘extracondensed’  ‘condensed’  ‘semicondensed’  ‘normal’  ‘semiexpanded’  ‘expanded’  ‘extraexpanded’  ‘ultraexpanded’ ] style
or fontstyle[ ‘normal’  ‘italic’  ‘oblique’] text
string or anything printable with ‘%s’ conversion. transform
Transform
url
a url string usetex
bool or None variant
or fontvariant[ ‘normal’  ‘smallcaps’ ] verticalalignment
or va[ ‘center’  ‘top’  ‘bottom’  ‘baseline’ ] visible
bool weight
or fontweight[a numeric value in range 01000  ‘ultralight’  ‘light’  ‘normal’  ‘regular’  ‘book’  ‘medium’  ‘roman’  ‘semibold’  ‘demibold’  ‘demi’  ‘bold’  ‘heavy’  ‘extra bold’  ‘black’ ] wrap
bool x
float y
float zorder
float
ACCEPTS: sequence of floats
set_rlabel_position
(value)¶Updates the theta position of the radius labels.
Parameters:  value : number


set_rlim
(*args, **kwargs)¶set_rmax
(rmax)¶set_rmin
(rmin)¶set_rorigin
(rorigin)¶set_rscale
(*args, **kwargs)¶set_rticks
(*args, **kwargs)¶set_theta_direction
(direction)¶Set the direction in which theta increases.
set_theta_offset
(offset)¶Set the offset for the location of 0 in radians.
set_theta_zero_location
(loc, offset=0.0)¶Sets the location of theta’s zero. (Calls set_theta_offset with the correct value in radians under the hood.)
loc
. Note:
this offset is always applied counterclockwise regardless of
the direction setting.set_thetagrids
(angles, labels=None, frac=None, fmt=None, **kwargs)¶Set the angles at which to place the theta grids (these gridlines are equal along the theta dimension). angles is in degrees.
labels, if not None, is a len(angles)
list of strings of
the labels to use at each angle.
If labels is None, the labels will be fmt % angle
frac is the fraction of the polar axes radius at which to place the label (1 is the edge). e.g., 1.05 is outside the axes and 0.95 is inside the axes.
Return value is a list of tuples (line, label), where
line is Line2D
instances and the
label is Text
instances.
kwargs are optional text properties for the labels:
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 alpha
float (0.0 transparent through 1.0 opaque) animated
bool backgroundcolor
any matplotlib color bbox
FancyBboxPatch prop dict clip_box
a matplotlib.transforms.Bbox
instanceclip_on
bool clip_path
[ ( Path
,Transform
) Patch
 None ]color
any matplotlib color contains
a callable function family
or fontfamily or fontname or name[FONTNAME  ‘serif’  ‘sansserif’  ‘cursive’  ‘fantasy’  ‘monospace’ ] figure
a Figure
instancefontproperties
or font_propertiesa matplotlib.font_manager.FontProperties
instancegid
an id string horizontalalignment
or ha[ ‘center’  ‘right’  ‘left’ ] label
object linespacing
float (multiple of font size) multialignment
or ma[‘left’  ‘right’  ‘center’ ] path_effects
AbstractPathEffect
picker
[None  bool  float  callable] position
(x,y) rasterized
bool or None rotation
[ angle in degrees  ‘vertical’  ‘horizontal’ ] rotation_mode
[ None  “default”  “anchor” ] size
or fontsize[size in points  ‘xxsmall’  ‘xsmall’  ‘small’  ‘medium’  ‘large’  ‘xlarge’  ‘xxlarge’ ] sketch_params
(scale: float, length: float, randomness: float) snap
bool or None stretch
or fontstretch[a numeric value in range 01000  ‘ultracondensed’  ‘extracondensed’  ‘condensed’  ‘semicondensed’  ‘normal’  ‘semiexpanded’  ‘expanded’  ‘extraexpanded’  ‘ultraexpanded’ ] style
or fontstyle[ ‘normal’  ‘italic’  ‘oblique’] text
string or anything printable with ‘%s’ conversion. transform
Transform
url
a url string usetex
bool or None variant
or fontvariant[ ‘normal’  ‘smallcaps’ ] verticalalignment
or va[ ‘center’  ‘top’  ‘bottom’  ‘baseline’ ] visible
bool weight
or fontweight[a numeric value in range 01000  ‘ultralight’  ‘light’  ‘normal’  ‘regular’  ‘book’  ‘medium’  ‘roman’  ‘semibold’  ‘demibold’  ‘demi’  ‘bold’  ‘heavy’  ‘extra bold’  ‘black’ ] wrap
bool x
float y
float zorder
float
ACCEPTS: sequence of floats
set_thetalim
(*args, **kwargs)¶set_thetamax
(thetamax)¶set_thetamin
(thetamin)¶set_xscale
(scale, *args, **kwargs)¶Set the xaxis scale.
Parameters:  value : {“linear”, “log”, “symlog”, “logit”}


See also
matplotlib.scale.LinearScale
matplotlib.scale.LogTransform
matplotlib.scale.SymmetricalLogTransform
matplotlib.scale.LogisticTransform
Notes
Different kwargs are accepted, depending on the scale. See
the scale
module for more information.
set_yscale
(*args, **kwargs)¶Set the yaxis scale.
Parameters:  value : {“linear”, “log”, “symlog”, “logit”}


See also
matplotlib.scale.LinearScale
matplotlib.scale.LogTransform
matplotlib.scale.SymmetricalLogTransform
matplotlib.scale.LogisticTransform
Notes
Different kwargs are accepted, depending on the scale. See
the scale
module for more information.
start_pan
(x, y, button)¶Called when a pan operation has started.
x, y are the mouse coordinates in display coords. button is the mouse button number:
Note
Intended to be overridden by new projection types.
matplotlib.projections.polar.
PolarTransform
(axis=None, use_rmin=True, _apply_theta_transforms=True)¶Bases: matplotlib.transforms.Transform
The base polar transform. This handles projection theta and r into Cartesian coordinate space x and y, but does not perform the ultimate affine transformation into the correct position.
input_dims
= 2¶inverted
()¶Return the corresponding inverse transformation.
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.
x === self.inverted().transform(self.transform(x))
is_separable
= False¶output_dims
= 2¶transform_non_affine
(tr)¶Performs only the nonaffine part of the transformation.
transform(values)
is always equivalent to
transform_affine(transform_non_affine(values))
.
In nonaffine transformations, this is generally equivalent to
transform(values)
. In affine transformations, this is
always a noop.
Accepts a numpy array of shape (N x input_dims
) and
returns a numpy array of shape (N x output_dims
).
Alternatively, accepts a numpy array of length input_dims
and returns a numpy array of length output_dims
.
matplotlib.projections.polar.
RadialAxis
(*args, **kwargs)¶Bases: matplotlib.axis.YAxis
A radial Axis.
This overrides certain properties of a YAxis
to provide specialcasing
for a radial axis.
axis_name
= 'radius'¶cla
()¶clear the current axis
matplotlib.projections.polar.
RadialLocator
(base, axes=None)¶Bases: matplotlib.ticker.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 raxis.
autoscale
()¶autoscale the view limits
pan
(numsteps)¶Pan numticks (can be positive or negative)
refresh
()¶refresh internal information based on current lim
view_limits
(vmin, vmax)¶select a scale for the range from vmin to vmax
Normally this method is overridden by subclasses to change locator behaviour.
zoom
(direction)¶Zoom in/out on axis; if direction is >0 zoom in, else zoom out
matplotlib.projections.polar.
RadialTick
(axes, loc, label, size=None, width=None, color=None, tickdir=None, pad=None, labelsize=None, labelcolor=None, zorder=None, gridOn=None, tick1On=True, tick2On=True, label1On=True, label2On=False, major=True, labelrotation=0, grid_color=None, grid_linestyle=None, grid_linewidth=None, grid_alpha=None, **kw)¶Bases: matplotlib.axis.YTick
A radialaxis tick.
This subclass of YTick
provides radial ticks with some small modification
to their repositioning 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.
bbox is the Bound2D bounding box in display coords of the Axes loc is the tick location in data coords size is the tick size in points
update_position
(loc)¶Set the location of tick in data coords with scalar loc
matplotlib.projections.polar.
ThetaAxis
(axes, pickradius=15)¶Bases: matplotlib.axis.XAxis
A theta Axis.
This overrides certain properties of an XAxis
to provide specialcasing
for an angular axis.
Init the axis with the parent Axes instance
axis_name
= 'theta'¶cla
()¶clear the current axis
matplotlib.projections.polar.
ThetaFormatter
¶Bases: matplotlib.ticker.Formatter
Used to format the theta tick labels. Converts the native unit of radians into degrees and adds a degree symbol.
matplotlib.projections.polar.
ThetaLocator
(base)¶Bases: matplotlib.ticker.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.
autoscale
()¶autoscale the view limits
pan
(numsteps)¶Pan numticks (can be positive or negative)
refresh
()¶refresh internal information based on current lim
set_axis
(axis)¶view_limits
(vmin, vmax)¶select a scale for the range from vmin to vmax
Normally this method is overridden by subclasses to change locator behaviour.
zoom
(direction)¶Zoom in/out on axis; if direction is >0 zoom in, else zoom out
matplotlib.projections.polar.
ThetaTick
(axes, *args, **kwargs)¶Bases: matplotlib.axis.XTick
A thetaaxis tick.
This subclass of XTick
provides angular ticks with some small
modification to their repositioning such that ticks are rotated based on
tick location. This results in ticks that are correctly perpendicular to
the arc spine.
When ‘auto’ rotation is enabled, labels are also rotated to be parallel to the spine. The label padding is also applied here since it’s not possible to use a generic axes transform to produce tickspecific padding.
update_position
(loc)¶Set the location of tick in data coords with scalar loc