doc_content
stringlengths 1
386k
| doc_id
stringlengths 5
188
|
|---|---|
code_type
alias of numpy.uint8
|
matplotlib.path_api#matplotlib.path.Path.code_type
|
contains_path(path, transform=None)[source]
Return whether this (closed) path completely contains the given path. If transform is not None, the path will be transformed before checking for containment.
|
matplotlib.path_api#matplotlib.path.Path.contains_path
|
contains_point(point, transform=None, radius=0.0)[source]
Return whether the area enclosed by the path contains the given point. The path is always treated as closed; i.e. if the last code is not CLOSEPOLY an implicit segment connecting the last vertex to the first vertex is assumed. Parameters
point(float, float)
The point (x, y) to check.
transformmatplotlib.transforms.Transform, optional
If not None, point will be compared to self transformed by transform; i.e. for a correct check, transform should transform the path into the coordinate system of point.
radiusfloat, default: 0
Add an additional margin on the path in coordinates of point. The path is extended tangentially by radius/2; i.e. if you would draw the path with a linewidth of radius, all points on the line would still be considered to be contained in the area. Conversely, negative values shrink the area: Points on the imaginary line will be considered outside the area. Returns
bool
Notes The current algorithm has some limitations: The result is undefined for points exactly at the boundary (i.e. at the path shifted by radius/2). The result is undefined if there is no enclosed area, i.e. all vertices are on a straight line. If bounding lines start to cross each other due to radius shift, the result is not guaranteed to be correct.
|
matplotlib.path_api#matplotlib.path.Path.contains_point
|
contains_points(points, transform=None, radius=0.0)[source]
Return whether the area enclosed by the path contains the given points. The path is always treated as closed; i.e. if the last code is not CLOSEPOLY an implicit segment connecting the last vertex to the first vertex is assumed. Parameters
points(N, 2) array
The points to check. Columns contain x and y values.
transformmatplotlib.transforms.Transform, optional
If not None, points will be compared to self transformed by transform; i.e. for a correct check, transform should transform the path into the coordinate system of points.
radiusfloat, default: 0
Add an additional margin on the path in coordinates of points. The path is extended tangentially by radius/2; i.e. if you would draw the path with a linewidth of radius, all points on the line would still be considered to be contained in the area. Conversely, negative values shrink the area: Points on the imaginary line will be considered outside the area. Returns
length-N bool array
Notes The current algorithm has some limitations: The result is undefined for points exactly at the boundary (i.e. at the path shifted by radius/2). The result is undefined if there is no enclosed area, i.e. all vertices are on a straight line. If bounding lines start to cross each other due to radius shift, the result is not guaranteed to be correct.
|
matplotlib.path_api#matplotlib.path.Path.contains_points
|
copy()[source]
Return a shallow copy of the Path, which will share the vertices and codes with the source Path.
|
matplotlib.path_api#matplotlib.path.Path.copy
|
CURVE3=3
|
matplotlib.path_api#matplotlib.path.Path.CURVE3
|
CURVE4=4
|
matplotlib.path_api#matplotlib.path.Path.CURVE4
|
deepcopy(memo=None)[source]
Return a deepcopy of the Path. The Path will not be readonly, even if the source Path is.
|
matplotlib.path_api#matplotlib.path.Path.deepcopy
|
get_extents(transform=None, **kwargs)[source]
Get Bbox of the path. Parameters
transformmatplotlib.transforms.Transform, optional
Transform to apply to path before computing extents, if any. **kwargs
Forwarded to iter_bezier. Returns
matplotlib.transforms.Bbox
The extents of the path Bbox([[xmin, ymin], [xmax, ymax]])
|
matplotlib.path_api#matplotlib.path.Path.get_extents
|
statichatch(hatchpattern, density=6)[source]
Given a hatch specifier, hatchpattern, generates a Path that can be used in a repeated hatching pattern. density is the number of lines per unit square.
|
matplotlib.path_api#matplotlib.path.Path.hatch
|
interpolated(steps)[source]
Return a new path resampled to length N x steps. Codes other than LINETO are not handled correctly.
|
matplotlib.path_api#matplotlib.path.Path.interpolated
|
intersects_bbox(bbox, filled=True)[source]
Return whether this path intersects a given Bbox. If filled is True, then this also returns True if the path completely encloses the Bbox (i.e., the path is treated as filled). The bounding box is always considered filled.
|
matplotlib.path_api#matplotlib.path.Path.intersects_bbox
|
intersects_path(other, filled=True)[source]
Return whether if this path intersects another given path. If filled is True, then this also returns True if one path completely encloses the other (i.e., the paths are treated as filled).
|
matplotlib.path_api#matplotlib.path.Path.intersects_path
|
iter_bezier(**kwargs)[source]
Iterate over each bezier curve (lines included) in a Path. Parameters
**kwargs
Forwarded to iter_segments. Yields
Bmatplotlib.bezier.BezierSegment
The bezier curves that make up the current path. Note in particular that freestanding points are bezier curves of order 0, and lines are bezier curves of order 1 (with two control points).
codePath.code_type
The code describing what kind of curve is being returned. Path.MOVETO, Path.LINETO, Path.CURVE3, Path.CURVE4 correspond to bezier curves with 1, 2, 3, and 4 control points (respectively). Path.CLOSEPOLY is a Path.LINETO with the control points correctly chosen based on the start/end points of the current stroke.
|
matplotlib.path_api#matplotlib.path.Path.iter_bezier
|
iter_segments(transform=None, remove_nans=True, clip=None, snap=False, stroke_width=1.0, simplify=None, curves=True, sketch=None)[source]
Iterate over all curve segments in the path. Each iteration returns a pair (vertices, code), where vertices is a sequence of 1-3 coordinate pairs, and code is a Path code. Additionally, this method can provide a number of standard cleanups and conversions to the path. Parameters
transformNone or Transform
If not None, the given affine transformation will be applied to the path.
remove_nansbool, optional
Whether to remove all NaNs from the path and skip over them using MOVETO commands.
clipNone or (float, float, float, float), optional
If not None, must be a four-tuple (x1, y1, x2, y2) defining a rectangle in which to clip the path.
snapNone or bool, optional
If True, snap all nodes to pixels; if False, don't snap them. If None, snap if the path contains only segments parallel to the x or y axes, and no more than 1024 of them.
stroke_widthfloat, optional
The width of the stroke being drawn (used for path snapping).
simplifyNone or bool, optional
Whether to simplify the path by removing vertices that do not affect its appearance. If None, use the should_simplify attribute. See also rcParams["path.simplify"] (default: True) and rcParams["path.simplify_threshold"] (default: 0.111111111111).
curvesbool, optional
If True, curve segments will be returned as curve segments. If False, all curves will be converted to line segments.
sketchNone or sequence, optional
If not None, must be a 3-tuple of the form (scale, length, randomness), representing the sketch parameters.
|
matplotlib.path_api#matplotlib.path.Path.iter_segments
|
LINETO=2
|
matplotlib.path_api#matplotlib.path.Path.LINETO
|
classmethodmake_compound_path(*args)[source]
Make a compound path from a list of Path objects. Blindly removes all Path.STOP control points.
|
matplotlib.path_api#matplotlib.path.Path.make_compound_path
|
classmethodmake_compound_path_from_polys(XY)[source]
Make a compound path object to draw a number of polygons with equal numbers of sides XY is a (numpolys x numsides x 2) numpy array of vertices. Return object is a Path. (Source code, png, pdf)
|
matplotlib.path_api#matplotlib.path.Path.make_compound_path_from_polys
|
MOVETO=1
|
matplotlib.path_api#matplotlib.path.Path.MOVETO
|
NUM_VERTICES_FOR_CODE={0: 1, 1: 1, 2: 1, 3: 2, 4: 3, 79: 1}
A dictionary mapping Path codes to the number of vertices that the code expects.
|
matplotlib.path_api#matplotlib.path.Path.NUM_VERTICES_FOR_CODE
|
STOP=0
|
matplotlib.path_api#matplotlib.path.Path.STOP
|
to_polygons(transform=None, width=0, height=0, closed_only=True)[source]
Convert this path to a list of polygons or polylines. Each polygon/polyline is an Nx2 array of vertices. In other words, each polygon has no MOVETO instructions or curves. This is useful for displaying in backends that do not support compound paths or Bezier curves. If width and height are both non-zero then the lines will be simplified so that vertices outside of (0, 0), (width, height) will be clipped. If closed_only is True (default), only closed polygons, with the last point being the same as the first point, will be returned. Any unclosed polylines in the path will be explicitly closed. If closed_only is False, any unclosed polygons in the path will be returned as unclosed polygons, and the closed polygons will be returned explicitly closed by setting the last point to the same as the first point.
|
matplotlib.path_api#matplotlib.path.Path.to_polygons
|
transformed(transform)[source]
Return a transformed copy of the path. See also matplotlib.transforms.TransformedPath
A specialized path class that will cache the transformed result and automatically update when the transform changes.
|
matplotlib.path_api#matplotlib.path.Path.transformed
|
classmethodunit_circle()[source]
Return the readonly Path of the unit circle. For most cases, Path.circle() will be what you want.
|
matplotlib.path_api#matplotlib.path.Path.unit_circle
|
classmethodunit_circle_righthalf()[source]
Return a Path of the right half of a unit circle. See Path.circle for the reference on the approximation used.
|
matplotlib.path_api#matplotlib.path.Path.unit_circle_righthalf
|
classmethodunit_rectangle()[source]
Return a Path instance of the unit rectangle from (0, 0) to (1, 1).
|
matplotlib.path_api#matplotlib.path.Path.unit_rectangle
|
classmethodunit_regular_asterisk(numVertices)[source]
Return a Path for a unit regular asterisk with the given numVertices and radius of 1.0, centered at (0, 0).
|
matplotlib.path_api#matplotlib.path.Path.unit_regular_asterisk
|
classmethodunit_regular_polygon(numVertices)[source]
Return a Path instance for a unit regular polygon with the given numVertices such that the circumscribing circle has radius 1.0, centered at (0, 0).
|
matplotlib.path_api#matplotlib.path.Path.unit_regular_polygon
|
classmethodunit_regular_star(numVertices, innerCircle=0.5)[source]
Return a Path for a unit regular star with the given numVertices and radius of 1.0, centered at (0, 0).
|
matplotlib.path_api#matplotlib.path.Path.unit_regular_star
|
classmethodwedge(theta1, theta2, n=None)[source]
Return a Path for the unit circle wedge from angles theta1 to theta2 (in degrees). theta2 is unwrapped to produce the shortest wedge within 360 degrees. That is, if theta2 > theta1 + 360, the wedge will be from theta1 to theta2 - 360 and not a full circle plus some extra overlap. If n is provided, it is the number of spline segments to make. If n is not provided, the number of spline segments is determined based on the delta between theta1 and theta2. See Path.arc for the reference on the approximation used.
|
matplotlib.path_api#matplotlib.path.Path.wedge
|
matplotlib.patheffects Defines classes for path effects. The path effects are supported in Text, Line2D and Patch. See also Path effects guide classmatplotlib.patheffects.AbstractPathEffect(offset=(0.0, 0.0))[source]
Bases: object A base class for path effects. Subclasses should override the draw_path method to add effect functionality. Parameters
offset(float, float), default: (0, 0)
The (x, y) offset to apply to the path, measured in points. draw_path(renderer, gc, tpath, affine, rgbFace=None)[source]
Derived should override this method. The arguments are the same as matplotlib.backend_bases.RendererBase.draw_path() except the first argument is a renderer.
classmatplotlib.patheffects.Normal(offset=(0.0, 0.0))[source]
Bases: matplotlib.patheffects.AbstractPathEffect The "identity" PathEffect. The Normal PathEffect's sole purpose is to draw the original artist with no special path effect. Parameters
offset(float, float), default: (0, 0)
The (x, y) offset to apply to the path, measured in points.
classmatplotlib.patheffects.PathEffectRenderer(path_effects, renderer)[source]
Bases: matplotlib.backend_bases.RendererBase Implements a Renderer which contains another renderer. This proxy then intercepts draw calls, calling the appropriate AbstractPathEffect draw method. Note Not all methods have been overridden on this RendererBase subclass. It may be necessary to add further methods to extend the PathEffects capabilities further. Parameters
path_effectsiterable of AbstractPathEffect
The path effects which this renderer represents.
renderermatplotlib.backend_bases.RendererBase subclass
copy_with_path_effect(path_effects)[source]
draw_markers(gc, marker_path, marker_trans, path, *args, **kwargs)[source]
Draw a marker at each of path's vertices (excluding control points). This provides a fallback implementation of draw_markers that makes multiple calls to draw_path(). Some backends may want to override this method in order to draw the marker only once and reuse it multiple times. Parameters
gcGraphicsContextBase
The graphics context.
marker_transmatplotlib.transforms.Transform
An affine transform applied to the marker.
transmatplotlib.transforms.Transform
An affine transform applied to the path.
draw_path(gc, tpath, affine, rgbFace=None)[source]
Draw a Path instance using the given affine transform.
draw_path_collection(gc, master_transform, paths, *args, **kwargs)[source]
Draw a collection of paths selecting drawing properties from the lists facecolors, edgecolors, linewidths, linestyles and antialiaseds. offsets is a list of offsets to apply to each of the paths. The offsets in offsets are first transformed by offsetTrans before being applied. offset_position is unused now, but the argument is kept for backwards compatibility. This provides a fallback implementation of draw_path_collection() that makes multiple calls to draw_path(). Some backends may want to override this in order to render each set of path data only once, and then reference that path multiple times with the different offsets, colors, styles etc. The generator methods _iter_collection_raw_paths() and _iter_collection() are provided to help with (and standardize) the implementation across backends. It is highly recommended to use those generators, so that changes to the behavior of draw_path_collection() can be made globally.
classmatplotlib.patheffects.PathPatchEffect(offset=(0, 0), **kwargs)[source]
Bases: matplotlib.patheffects.AbstractPathEffect Draws a PathPatch instance whose Path comes from the original PathEffect artist. Parameters
offset(float, float), default: (0, 0)
The (x, y) offset to apply to the path, in points. **kwargs
All keyword arguments are passed through to the PathPatch constructor. The properties which cannot be overridden are "path", "clip_box" "transform" and "clip_path". draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Derived should override this method. The arguments are the same as matplotlib.backend_bases.RendererBase.draw_path() except the first argument is a renderer.
classmatplotlib.patheffects.SimpleLineShadow(offset=(2, - 2), shadow_color='k', alpha=0.3, rho=0.3, **kwargs)[source]
Bases: matplotlib.patheffects.AbstractPathEffect A simple shadow via a line. Parameters
offset(float, float), default: (2, -2)
The (x, y) offset to apply to the path, in points.
shadow_colorcolor, default: 'black'
The shadow color. A value of None takes the original artist's color with a scale factor of rho.
alphafloat, default: 0.3
The alpha transparency of the created shadow patch.
rhofloat, default: 0.3
A scale factor to apply to the rgbFace color if shadow_color is None. **kwargs
Extra keywords are stored and passed through to AbstractPathEffect._update_gc(). draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Overrides the standard draw_path to add the shadow offset and necessary color changes for the shadow.
classmatplotlib.patheffects.SimplePatchShadow(offset=(2, - 2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[source]
Bases: matplotlib.patheffects.AbstractPathEffect A simple shadow via a filled patch. Parameters
offset(float, float), default: (2, -2)
The (x, y) offset of the shadow in points.
shadow_rgbFacecolor
The shadow color.
alphafloat, default: 0.3
The alpha transparency of the created shadow patch. http://matplotlib.1069221.n5.nabble.com/path-effects-question-td27630.html
rhofloat, default: 0.3
A scale factor to apply to the rgbFace color if shadow_rgbFace is not specified. **kwargs
Extra keywords are stored and passed through to AbstractPathEffect._update_gc(). draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Overrides the standard draw_path to add the shadow offset and necessary color changes for the shadow.
classmatplotlib.patheffects.Stroke(offset=(0, 0), **kwargs)[source]
Bases: matplotlib.patheffects.AbstractPathEffect A line based PathEffect which re-draws a stroke. The path will be stroked with its gc updated with the given keyword arguments, i.e., the keyword arguments should be valid gc parameter values. draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Draw the path with updated gc.
classmatplotlib.patheffects.TickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=1.4142135623730951, **kwargs)[source]
Bases: matplotlib.patheffects.AbstractPathEffect A line-based PathEffect which draws a path with a ticked style. This line style is frequently used to represent constraints in optimization. The ticks may be used to indicate that one side of the line is invalid or to represent a closed boundary of a domain (i.e. a wall or the edge of a pipe). The spacing, length, and angle of ticks can be controlled. This line style is sometimes referred to as a hatched line. See also the contour demo example. See also the contours in optimization example. Parameters
offset(float, float), default: (0, 0)
The (x, y) offset to apply to the path, in points.
spacingfloat, default: 10.0
The spacing between ticks in points.
anglefloat, default: 45.0
The angle between the path and the tick in degrees. The angle is measured as if you were an ant walking along the curve, with zero degrees pointing directly ahead, 90 to your left, -90 to your right, and 180 behind you.
lengthfloat, default: 1.414
The length of the tick relative to spacing. Recommended length = 1.414 (sqrt(2)) when angle=45, length=1.0 when angle=90 and length=2.0 when angle=60. **kwargs
Extra keywords are stored and passed through to AbstractPathEffect._update_gc(). Examples See TickedStroke patheffect. draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Draw the path with updated gc.
classmatplotlib.patheffects.withSimplePatchShadow(offset=(2, - 2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[source]
Bases: matplotlib.patheffects.SimplePatchShadow A shortcut PathEffect for applying SimplePatchShadow and then drawing the original Artist. With this class you can use artist.set_path_effects([path_effects.withSimplePatchShadow()])
as a shortcut for artist.set_path_effects([path_effects.SimplePatchShadow(),
path_effects.Normal()])
Parameters
offset(float, float), default: (2, -2)
The (x, y) offset of the shadow in points.
shadow_rgbFacecolor
The shadow color.
alphafloat, default: 0.3
The alpha transparency of the created shadow patch. http://matplotlib.1069221.n5.nabble.com/path-effects-question-td27630.html
rhofloat, default: 0.3
A scale factor to apply to the rgbFace color if shadow_rgbFace is not specified. **kwargs
Extra keywords are stored and passed through to AbstractPathEffect._update_gc(). draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Overrides the standard draw_path to add the shadow offset and necessary color changes for the shadow.
classmatplotlib.patheffects.withStroke(offset=(0, 0), **kwargs)[source]
Bases: matplotlib.patheffects.Stroke A shortcut PathEffect for applying Stroke and then drawing the original Artist. With this class you can use artist.set_path_effects([path_effects.withStroke()])
as a shortcut for artist.set_path_effects([path_effects.Stroke(),
path_effects.Normal()])
The path will be stroked with its gc updated with the given keyword arguments, i.e., the keyword arguments should be valid gc parameter values. draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Draw the path with updated gc.
classmatplotlib.patheffects.withTickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=1.4142135623730951, **kwargs)[source]
Bases: matplotlib.patheffects.TickedStroke A shortcut PathEffect for applying TickedStroke and then drawing the original Artist. With this class you can use artist.set_path_effects([path_effects.withTickedStroke()])
as a shortcut for artist.set_path_effects([path_effects.TickedStroke(),
path_effects.Normal()])
Parameters
offset(float, float), default: (0, 0)
The (x, y) offset to apply to the path, in points.
spacingfloat, default: 10.0
The spacing between ticks in points.
anglefloat, default: 45.0
The angle between the path and the tick in degrees. The angle is measured as if you were an ant walking along the curve, with zero degrees pointing directly ahead, 90 to your left, -90 to your right, and 180 behind you.
lengthfloat, default: 1.414
The length of the tick relative to spacing. Recommended length = 1.414 (sqrt(2)) when angle=45, length=1.0 when angle=90 and length=2.0 when angle=60. **kwargs
Extra keywords are stored and passed through to AbstractPathEffect._update_gc(). Examples See TickedStroke patheffect. draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Draw the path with updated gc.
|
matplotlib.patheffects_api
|
classmatplotlib.patheffects.AbstractPathEffect(offset=(0.0, 0.0))[source]
Bases: object A base class for path effects. Subclasses should override the draw_path method to add effect functionality. Parameters
offset(float, float), default: (0, 0)
The (x, y) offset to apply to the path, measured in points. draw_path(renderer, gc, tpath, affine, rgbFace=None)[source]
Derived should override this method. The arguments are the same as matplotlib.backend_bases.RendererBase.draw_path() except the first argument is a renderer.
|
matplotlib.patheffects_api#matplotlib.patheffects.AbstractPathEffect
|
draw_path(renderer, gc, tpath, affine, rgbFace=None)[source]
Derived should override this method. The arguments are the same as matplotlib.backend_bases.RendererBase.draw_path() except the first argument is a renderer.
|
matplotlib.patheffects_api#matplotlib.patheffects.AbstractPathEffect.draw_path
|
classmatplotlib.patheffects.Normal(offset=(0.0, 0.0))[source]
Bases: matplotlib.patheffects.AbstractPathEffect The "identity" PathEffect. The Normal PathEffect's sole purpose is to draw the original artist with no special path effect. Parameters
offset(float, float), default: (0, 0)
The (x, y) offset to apply to the path, measured in points.
|
matplotlib.patheffects_api#matplotlib.patheffects.Normal
|
classmatplotlib.patheffects.PathEffectRenderer(path_effects, renderer)[source]
Bases: matplotlib.backend_bases.RendererBase Implements a Renderer which contains another renderer. This proxy then intercepts draw calls, calling the appropriate AbstractPathEffect draw method. Note Not all methods have been overridden on this RendererBase subclass. It may be necessary to add further methods to extend the PathEffects capabilities further. Parameters
path_effectsiterable of AbstractPathEffect
The path effects which this renderer represents.
renderermatplotlib.backend_bases.RendererBase subclass
copy_with_path_effect(path_effects)[source]
draw_markers(gc, marker_path, marker_trans, path, *args, **kwargs)[source]
Draw a marker at each of path's vertices (excluding control points). This provides a fallback implementation of draw_markers that makes multiple calls to draw_path(). Some backends may want to override this method in order to draw the marker only once and reuse it multiple times. Parameters
gcGraphicsContextBase
The graphics context.
marker_transmatplotlib.transforms.Transform
An affine transform applied to the marker.
transmatplotlib.transforms.Transform
An affine transform applied to the path.
draw_path(gc, tpath, affine, rgbFace=None)[source]
Draw a Path instance using the given affine transform.
draw_path_collection(gc, master_transform, paths, *args, **kwargs)[source]
Draw a collection of paths selecting drawing properties from the lists facecolors, edgecolors, linewidths, linestyles and antialiaseds. offsets is a list of offsets to apply to each of the paths. The offsets in offsets are first transformed by offsetTrans before being applied. offset_position is unused now, but the argument is kept for backwards compatibility. This provides a fallback implementation of draw_path_collection() that makes multiple calls to draw_path(). Some backends may want to override this in order to render each set of path data only once, and then reference that path multiple times with the different offsets, colors, styles etc. The generator methods _iter_collection_raw_paths() and _iter_collection() are provided to help with (and standardize) the implementation across backends. It is highly recommended to use those generators, so that changes to the behavior of draw_path_collection() can be made globally.
|
matplotlib.patheffects_api#matplotlib.patheffects.PathEffectRenderer
|
copy_with_path_effect(path_effects)[source]
|
matplotlib.patheffects_api#matplotlib.patheffects.PathEffectRenderer.copy_with_path_effect
|
draw_markers(gc, marker_path, marker_trans, path, *args, **kwargs)[source]
Draw a marker at each of path's vertices (excluding control points). This provides a fallback implementation of draw_markers that makes multiple calls to draw_path(). Some backends may want to override this method in order to draw the marker only once and reuse it multiple times. Parameters
gcGraphicsContextBase
The graphics context.
marker_transmatplotlib.transforms.Transform
An affine transform applied to the marker.
transmatplotlib.transforms.Transform
An affine transform applied to the path.
|
matplotlib.patheffects_api#matplotlib.patheffects.PathEffectRenderer.draw_markers
|
draw_path(gc, tpath, affine, rgbFace=None)[source]
Draw a Path instance using the given affine transform.
|
matplotlib.patheffects_api#matplotlib.patheffects.PathEffectRenderer.draw_path
|
draw_path_collection(gc, master_transform, paths, *args, **kwargs)[source]
Draw a collection of paths selecting drawing properties from the lists facecolors, edgecolors, linewidths, linestyles and antialiaseds. offsets is a list of offsets to apply to each of the paths. The offsets in offsets are first transformed by offsetTrans before being applied. offset_position is unused now, but the argument is kept for backwards compatibility. This provides a fallback implementation of draw_path_collection() that makes multiple calls to draw_path(). Some backends may want to override this in order to render each set of path data only once, and then reference that path multiple times with the different offsets, colors, styles etc. The generator methods _iter_collection_raw_paths() and _iter_collection() are provided to help with (and standardize) the implementation across backends. It is highly recommended to use those generators, so that changes to the behavior of draw_path_collection() can be made globally.
|
matplotlib.patheffects_api#matplotlib.patheffects.PathEffectRenderer.draw_path_collection
|
classmatplotlib.patheffects.PathPatchEffect(offset=(0, 0), **kwargs)[source]
Bases: matplotlib.patheffects.AbstractPathEffect Draws a PathPatch instance whose Path comes from the original PathEffect artist. Parameters
offset(float, float), default: (0, 0)
The (x, y) offset to apply to the path, in points. **kwargs
All keyword arguments are passed through to the PathPatch constructor. The properties which cannot be overridden are "path", "clip_box" "transform" and "clip_path". draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Derived should override this method. The arguments are the same as matplotlib.backend_bases.RendererBase.draw_path() except the first argument is a renderer.
|
matplotlib.patheffects_api#matplotlib.patheffects.PathPatchEffect
|
draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Derived should override this method. The arguments are the same as matplotlib.backend_bases.RendererBase.draw_path() except the first argument is a renderer.
|
matplotlib.patheffects_api#matplotlib.patheffects.PathPatchEffect.draw_path
|
classmatplotlib.patheffects.SimpleLineShadow(offset=(2, - 2), shadow_color='k', alpha=0.3, rho=0.3, **kwargs)[source]
Bases: matplotlib.patheffects.AbstractPathEffect A simple shadow via a line. Parameters
offset(float, float), default: (2, -2)
The (x, y) offset to apply to the path, in points.
shadow_colorcolor, default: 'black'
The shadow color. A value of None takes the original artist's color with a scale factor of rho.
alphafloat, default: 0.3
The alpha transparency of the created shadow patch.
rhofloat, default: 0.3
A scale factor to apply to the rgbFace color if shadow_color is None. **kwargs
Extra keywords are stored and passed through to AbstractPathEffect._update_gc(). draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Overrides the standard draw_path to add the shadow offset and necessary color changes for the shadow.
|
matplotlib.patheffects_api#matplotlib.patheffects.SimpleLineShadow
|
draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Overrides the standard draw_path to add the shadow offset and necessary color changes for the shadow.
|
matplotlib.patheffects_api#matplotlib.patheffects.SimpleLineShadow.draw_path
|
classmatplotlib.patheffects.SimplePatchShadow(offset=(2, - 2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[source]
Bases: matplotlib.patheffects.AbstractPathEffect A simple shadow via a filled patch. Parameters
offset(float, float), default: (2, -2)
The (x, y) offset of the shadow in points.
shadow_rgbFacecolor
The shadow color.
alphafloat, default: 0.3
The alpha transparency of the created shadow patch. http://matplotlib.1069221.n5.nabble.com/path-effects-question-td27630.html
rhofloat, default: 0.3
A scale factor to apply to the rgbFace color if shadow_rgbFace is not specified. **kwargs
Extra keywords are stored and passed through to AbstractPathEffect._update_gc(). draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Overrides the standard draw_path to add the shadow offset and necessary color changes for the shadow.
|
matplotlib.patheffects_api#matplotlib.patheffects.SimplePatchShadow
|
draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Overrides the standard draw_path to add the shadow offset and necessary color changes for the shadow.
|
matplotlib.patheffects_api#matplotlib.patheffects.SimplePatchShadow.draw_path
|
classmatplotlib.patheffects.Stroke(offset=(0, 0), **kwargs)[source]
Bases: matplotlib.patheffects.AbstractPathEffect A line based PathEffect which re-draws a stroke. The path will be stroked with its gc updated with the given keyword arguments, i.e., the keyword arguments should be valid gc parameter values. draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Draw the path with updated gc.
|
matplotlib.patheffects_api#matplotlib.patheffects.Stroke
|
draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Draw the path with updated gc.
|
matplotlib.patheffects_api#matplotlib.patheffects.Stroke.draw_path
|
classmatplotlib.patheffects.TickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=1.4142135623730951, **kwargs)[source]
Bases: matplotlib.patheffects.AbstractPathEffect A line-based PathEffect which draws a path with a ticked style. This line style is frequently used to represent constraints in optimization. The ticks may be used to indicate that one side of the line is invalid or to represent a closed boundary of a domain (i.e. a wall or the edge of a pipe). The spacing, length, and angle of ticks can be controlled. This line style is sometimes referred to as a hatched line. See also the contour demo example. See also the contours in optimization example. Parameters
offset(float, float), default: (0, 0)
The (x, y) offset to apply to the path, in points.
spacingfloat, default: 10.0
The spacing between ticks in points.
anglefloat, default: 45.0
The angle between the path and the tick in degrees. The angle is measured as if you were an ant walking along the curve, with zero degrees pointing directly ahead, 90 to your left, -90 to your right, and 180 behind you.
lengthfloat, default: 1.414
The length of the tick relative to spacing. Recommended length = 1.414 (sqrt(2)) when angle=45, length=1.0 when angle=90 and length=2.0 when angle=60. **kwargs
Extra keywords are stored and passed through to AbstractPathEffect._update_gc(). Examples See TickedStroke patheffect. draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Draw the path with updated gc.
|
matplotlib.patheffects_api#matplotlib.patheffects.TickedStroke
|
draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Draw the path with updated gc.
|
matplotlib.patheffects_api#matplotlib.patheffects.TickedStroke.draw_path
|
classmatplotlib.patheffects.withSimplePatchShadow(offset=(2, - 2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[source]
Bases: matplotlib.patheffects.SimplePatchShadow A shortcut PathEffect for applying SimplePatchShadow and then drawing the original Artist. With this class you can use artist.set_path_effects([path_effects.withSimplePatchShadow()])
as a shortcut for artist.set_path_effects([path_effects.SimplePatchShadow(),
path_effects.Normal()])
Parameters
offset(float, float), default: (2, -2)
The (x, y) offset of the shadow in points.
shadow_rgbFacecolor
The shadow color.
alphafloat, default: 0.3
The alpha transparency of the created shadow patch. http://matplotlib.1069221.n5.nabble.com/path-effects-question-td27630.html
rhofloat, default: 0.3
A scale factor to apply to the rgbFace color if shadow_rgbFace is not specified. **kwargs
Extra keywords are stored and passed through to AbstractPathEffect._update_gc(). draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Overrides the standard draw_path to add the shadow offset and necessary color changes for the shadow.
|
matplotlib.patheffects_api#matplotlib.patheffects.withSimplePatchShadow
|
draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Overrides the standard draw_path to add the shadow offset and necessary color changes for the shadow.
|
matplotlib.patheffects_api#matplotlib.patheffects.withSimplePatchShadow.draw_path
|
classmatplotlib.patheffects.withStroke(offset=(0, 0), **kwargs)[source]
Bases: matplotlib.patheffects.Stroke A shortcut PathEffect for applying Stroke and then drawing the original Artist. With this class you can use artist.set_path_effects([path_effects.withStroke()])
as a shortcut for artist.set_path_effects([path_effects.Stroke(),
path_effects.Normal()])
The path will be stroked with its gc updated with the given keyword arguments, i.e., the keyword arguments should be valid gc parameter values. draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Draw the path with updated gc.
|
matplotlib.patheffects_api#matplotlib.patheffects.withStroke
|
draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Draw the path with updated gc.
|
matplotlib.patheffects_api#matplotlib.patheffects.withStroke.draw_path
|
classmatplotlib.patheffects.withTickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=1.4142135623730951, **kwargs)[source]
Bases: matplotlib.patheffects.TickedStroke A shortcut PathEffect for applying TickedStroke and then drawing the original Artist. With this class you can use artist.set_path_effects([path_effects.withTickedStroke()])
as a shortcut for artist.set_path_effects([path_effects.TickedStroke(),
path_effects.Normal()])
Parameters
offset(float, float), default: (0, 0)
The (x, y) offset to apply to the path, in points.
spacingfloat, default: 10.0
The spacing between ticks in points.
anglefloat, default: 45.0
The angle between the path and the tick in degrees. The angle is measured as if you were an ant walking along the curve, with zero degrees pointing directly ahead, 90 to your left, -90 to your right, and 180 behind you.
lengthfloat, default: 1.414
The length of the tick relative to spacing. Recommended length = 1.414 (sqrt(2)) when angle=45, length=1.0 when angle=90 and length=2.0 when angle=60. **kwargs
Extra keywords are stored and passed through to AbstractPathEffect._update_gc(). Examples See TickedStroke patheffect. draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Draw the path with updated gc.
|
matplotlib.patheffects_api#matplotlib.patheffects.withTickedStroke
|
draw_path(renderer, gc, tpath, affine, rgbFace)[source]
Draw the path with updated gc.
|
matplotlib.patheffects_api#matplotlib.patheffects.withTickedStroke.draw_path
|
matplotlib.projections Non-separable transforms that map from data space to screen space. Projections are defined as Axes subclasses. They include the following elements: A transformation from data coordinates into display coordinates. An inverse of that transformation. This is used, for example, to convert mouse positions from screen space back into data space. Transformations for the gridlines, ticks and ticklabels. Custom projections will often need to place these elements in special locations, and Matplotlib has a facility to help with doing so. Setting up default values (overriding cla), since the defaults for a rectilinear axes may not be appropriate. Defining the shape of the axes, for example, an elliptical axes, that will be used to draw the background of the plot and for clipping any data elements. Defining custom locators and formatters for the projection. For example, in a geographic projection, it may be more convenient to display the grid in degrees, even if the data is in radians. Set up interactive panning and zooming. This is left as an "advanced" feature left to the reader, but there is an example of this for polar plots in matplotlib.projections.polar. Any additional methods for additional convenience or features. Once the projection axes is defined, it can be used in one of two ways:
By defining the class attribute name, the projection axes can be registered with matplotlib.projections.register_projection and subsequently simply invoked by name: fig.add_subplot(projection="my_proj_name")
For more complex, parameterisable projections, a generic "projection" object may be defined which includes the method _as_mpl_axes. _as_mpl_axes should take no arguments and return the projection's axes subclass and a dictionary of additional arguments to pass to the subclass' __init__ method. Subsequently a parameterised projection can be initialised with: fig.add_subplot(projection=MyProjection(param1=param1_value))
where MyProjection is an object which implements a _as_mpl_axes method. A full-fledged and heavily annotated example is in Custom projection. The polar plot functionality in matplotlib.projections.polar may also be of interest. classmatplotlib.projections.ProjectionRegistry[source]
Bases: object A mapping of registered projection names to projection classes. get_projection_class(name)[source]
Get a projection class from its name.
get_projection_names()[source]
Return the names of all projections currently registered.
register(*projections)[source]
Register a new set of projections.
matplotlib.projections.get_projection_class(projection=None)[source]
Get a projection class from its name. If projection is None, a standard rectilinear projection is returned.
matplotlib.projections.get_projection_names()[source]
Return the names of all projections currently registered.
matplotlib.projections.register_projection(cls)[source]
matplotlib.projections.polar classmatplotlib.projections.polar.InvertedPolarTransform(axis=None, use_rmin=True, _apply_theta_transforms=True)[source]
Bases: matplotlib.transforms.Transform The inverse of the polar transform, mapping Cartesian coordinate space x and y back to theta and r. Parameters
shorthand_namestr
A string representing the "name" of the transform. The name carries no significance other than to improve the readability of str(transform) when DEBUG=True. 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(xy)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
classmatplotlib.projections.polar.PolarAffine(scale_transform, limits)[source]
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 non-affine transform. get_matrix()[source]
Get the matrix for the affine part of this transform.
classmatplotlib.projections.polar.PolarAxes(*args, theta_offset=0, theta_direction=1, rlabel_position=22.5, **kwargs)[source]
Bases: matplotlib.axes._axes.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.
rect[left, bottom, width, height]
The Axes is built in the rectangle rect. rect is in Figure coordinates.
sharex, shareyAxes, optional
The x or y axis is shared with the x or y axis in the input 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. **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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float Returns
Axes
The new Axes object. classInvertedPolarTransform(axis=None, use_rmin=True, _apply_theta_transforms=True)[source]
Bases: matplotlib.transforms.Transform The inverse of the polar transform, mapping Cartesian coordinate space x and y back to theta and r. Parameters
shorthand_namestr
A string representing the "name" of the transform. The name carries no significance other than to improve the readability of str(transform) when DEBUG=True. 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(xy)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
classPolarAffine(scale_transform, limits)[source]
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 non-affine transform. get_matrix()[source]
Get the matrix for the affine part of this transform.
classPolarTransform(axis=None, use_rmin=True, _apply_theta_transforms=True)[source]
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. Parameters
shorthand_namestr
A string representing the "name" of the transform. The name carries no significance other than to improve the readability of str(transform) when DEBUG=True. 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(tr)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x 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)).
classRadialLocator(base, axes=None)[source]
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 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.
classThetaFormatter[source]
Bases: matplotlib.ticker.Formatter Used to format the theta tick labels. Converts the native unit of radians into degrees and adds a degree symbol.
classThetaLocator(base)[source]
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. refresh()[source]
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 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. Polar axes do not support zoom boxes.
cla()[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.
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 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 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.
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>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<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>, 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>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
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
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 unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim float, optional
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. 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]
See 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. 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 axes 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.
set_ylim(bottom=None, top=None, emit=True, auto=False, *, ymin=None, ymax=None)[source]
Set the data limits for the radial axis. Parameters
bottomfloat, optional
The bottom limit (default: None, which leaves the bottom limit unchanged). The bottom and top ylims may be passed as the tuple (bottom, top) as the first positional argument (or as the bottom keyword argument).
topfloat, optional
The top limit (default: None, which leaves the top limit unchanged).
emitbool, default: True
Whether to notify observers of limit change.
autobool or None, default: False
Whether to turn on autoscaling of the y-axis. True turns on, False turns off, None leaves unchanged.
ymin, ymaxfloat, optional
These arguments are deprecated and will be removed in a future version. They are equivalent to bottom and top respectively, and it is an error to pass both ymin and bottom or ymax and top. Returns
bottom, top(float, float)
The new y-axis limits in data coordinates.
set_yscale(*args, **kwargs)[source]
Set the y-axis scale. Parameters
value{"linear", "log", "symlog", "logit", ...} or ScaleBase
The axis scale type to apply. **kwargs
Different keyword arguments are accepted, depending on the scale. See the respective class keyword arguments: matplotlib.scale.LinearScale matplotlib.scale.LogScale matplotlib.scale.SymmetricalLogScale matplotlib.scale.LogitScale matplotlib.scale.FuncScale Notes By default, Matplotlib supports the above mentioned scales. Additionally, custom scales may be registered using matplotlib.scale.register_scale. These scales can then also be used here.
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.polar.PolarTransform(axis=None, use_rmin=True, _apply_theta_transforms=True)[source]
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. Parameters
shorthand_namestr
A string representing the "name" of the transform. The name carries no significance other than to improve the readability of str(transform) when DEBUG=True. 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(tr)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x 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)).
classmatplotlib.projections.polar.RadialAxis(*args, **kwargs)[source]
Bases: matplotlib.axis.YAxis A radial Axis. This overrides certain properties of a YAxis to provide special-casing for a radial axis. Parameters
axesmatplotlib.axes.Axes
The Axes to which the created Axis belongs.
pickradiusfloat
The acceptance radius for containment tests. See also Axis.contains. axis_name='radius'
Read-only name identifying the axis.
cla()[source]
[Deprecated] Notes Deprecated since version 3.4:
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>, 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>, 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. 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
alpha scalar or None
animated bool
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
data_interval unknown
figure Figure
gid str
in_layout bool
inverted unknown
label object
label_coords unknown
label_position {'left', 'right'}
label_text str
major_formatter Formatter, str, or function
major_locator Locator
minor_formatter Formatter, str, or function
minor_locator Locator
offset_position {'left', 'right'}
path_effects 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 list of floats
ticks_position {'left', 'right', 'both', 'default', 'none'}
transform Transform
units units tag
url str
view_interval unknown
visible bool
zorder float
classmatplotlib.projections.polar.RadialLocator(base, axes=None)[source]
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 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.
classmatplotlib.projections.polar.RadialTick(*args, **kwargs)[source]
Bases: matplotlib.axis.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. 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 set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, label1=<UNSET>, label2=<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. 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
alpha scalar or None
animated bool
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
figure Figure
gid str
in_layout bool
label str
label1 str
label2 str
pad float
path_effects 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.
classmatplotlib.projections.polar.ThetaAxis(*args, **kwargs)[source]
Bases: matplotlib.axis.XAxis A theta Axis. This overrides certain properties of an XAxis to provide special-casing for an angular axis. Parameters
axesmatplotlib.axes.Axes
The Axes to which the created Axis belongs.
pickradiusfloat
The acceptance radius for containment tests. See also Axis.contains. axis_name='theta'
Read-only name identifying the axis.
cla()[source]
[Deprecated] Notes Deprecated since version 3.4:
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>, 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>, 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. 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
alpha scalar or None
animated bool
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
data_interval unknown
figure Figure
gid str
in_layout bool
inverted unknown
label object
label_coords unknown
label_position {'top', 'bottom'}
label_text str
major_formatter Formatter, str, or function
major_locator Locator
minor_formatter Formatter, str, or function
minor_locator Locator
path_effects 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 list of floats
ticks_position {'top', 'bottom', 'both', 'default', 'none'}
transform Transform
units units tag
url str
view_interval unknown
visible bool
zorder float
classmatplotlib.projections.polar.ThetaFormatter[source]
Bases: matplotlib.ticker.Formatter Used to format the theta tick labels. Converts the native unit of radians into degrees and adds a degree symbol.
classmatplotlib.projections.polar.ThetaLocator(base)[source]
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. refresh()[source]
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.
classmatplotlib.projections.polar.ThetaTick(axes, *args, **kwargs)[source]
Bases: matplotlib.axis.XTick A theta-axis tick. This subclass of XTick provides angular ticks with some small modification to their re-positioning 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 tick-specific padding. 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 set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, label1=<UNSET>, label2=<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. 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
alpha scalar or None
animated bool
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
figure Figure
gid str
in_layout bool
label str
label1 str
label2 str
pad float
path_effects 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.
matplotlib.projections.geo classmatplotlib.projections.geo.AitoffAxes(*args, **kwargs)[source]
Bases: matplotlib.projections.geo.GeoAxes Build an Axes in a figure. Parameters
figFigure
The Axes is built in the Figure fig.
rect[left, bottom, width, height]
The Axes is built in the rectangle rect. rect is in Figure coordinates.
sharex, shareyAxes, optional
The x or y axis is shared with the x or y axis in the input 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. **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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float Returns
Axes
The new Axes object. classAitoffTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(ll)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
classInvertedAitoffTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(xy)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x 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>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, latitude_grid=<UNSET>, longitude_grid=<UNSET>, longitude_grid_ends=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
latitude_grid unknown
longitude_grid unknown
longitude_grid_ends unknown
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim unknown
xmargin float greater than -0.5
xscale unknown
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim unknown
ymargin float greater than -0.5
yscale unknown
yticklabels unknown
yticks unknown
zorder float
classmatplotlib.projections.geo.GeoAxes(fig, rect, *, facecolor=None, frameon=True, sharex=None, sharey=None, label='', xscale=None, yscale=None, box_aspect=None, **kwargs)[source]
Bases: matplotlib.axes._axes.Axes An abstract base class for geographic projections. Build an Axes in a figure. Parameters
figFigure
The Axes is built in the Figure fig.
rect[left, bottom, width, height]
The Axes is built in the rectangle rect. rect is in Figure coordinates.
sharex, shareyAxes, optional
The x or y axis is shared with the x or y axis in the input 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. **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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float Returns
Axes
The new Axes object. RESOLUTION=75
classThetaFormatter(round_to=1.0)[source]
Bases: matplotlib.ticker.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.
cla()[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 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.
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 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 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.
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>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, latitude_grid=<UNSET>, longitude_grid=<UNSET>, longitude_grid_ends=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
latitude_grid unknown
longitude_grid unknown
longitude_grid_ends unknown
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim unknown
xmargin float greater than -0.5
xscale unknown
xticklabels unknown
xticks unknown
ybound 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_xlim(*args, **kwargs)[source]
Not supported. Please consider using Cartopy.
set_xscale(*args, **kwargs)[source]
Set the x-axis scale. Parameters
value{"linear", "log", "symlog", "logit", ...} or ScaleBase
The axis scale type to apply. **kwargs
Different keyword arguments are accepted, depending on the scale. See the respective class keyword arguments: matplotlib.scale.LinearScale matplotlib.scale.LogScale matplotlib.scale.SymmetricalLogScale matplotlib.scale.LogitScale matplotlib.scale.FuncScale Notes By default, Matplotlib supports the above mentioned scales. Additionally, custom scales may be registered using matplotlib.scale.register_scale. These scales can then also be used here.
set_ylim(*args, **kwargs)[source]
Not supported. Please consider using Cartopy.
set_yscale(*args, **kwargs)[source]
Set the y-axis scale. Parameters
value{"linear", "log", "symlog", "logit", ...} or ScaleBase
The axis scale type to apply. **kwargs
Different keyword arguments are accepted, depending on the scale. See the respective class keyword arguments: matplotlib.scale.LinearScale matplotlib.scale.LogScale matplotlib.scale.SymmetricalLogScale matplotlib.scale.LogitScale matplotlib.scale.FuncScale Notes By default, Matplotlib supports the above mentioned scales. Additionally, custom scales may be registered using matplotlib.scale.register_scale. These scales can then also be used here.
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: matplotlib.projections.geo.GeoAxes Build an Axes in a figure. Parameters
figFigure
The Axes is built in the Figure fig.
rect[left, bottom, width, height]
The Axes is built in the rectangle rect. rect is in Figure coordinates.
sharex, shareyAxes, optional
The x or y axis is shared with the x or y axis in the input 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. **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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float Returns
Axes
The new Axes object. classHammerTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(ll)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
classInvertedHammerTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(xy)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x 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>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, latitude_grid=<UNSET>, longitude_grid=<UNSET>, longitude_grid_ends=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
latitude_grid unknown
longitude_grid unknown
longitude_grid_ends unknown
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim unknown
xmargin float greater than -0.5
xscale unknown
xticklabels unknown
xticks unknown
ybound 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: matplotlib.projections.geo.GeoAxes Build an Axes in a figure. Parameters
figFigure
The Axes is built in the Figure fig.
rect[left, bottom, width, height]
The Axes is built in the rectangle rect. rect is in Figure coordinates.
sharex, shareyAxes, optional
The x or y axis is shared with the x or y axis in the input 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. **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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float Returns
Axes
The new Axes object. classInvertedLambertTransform(center_longitude, center_latitude, resolution)[source]
Bases: matplotlib.projections.geo._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(xy)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
classLambertTransform(center_longitude, center_latitude, resolution)[source]
Bases: matplotlib.projections.geo._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(ll)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
cla()[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>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, latitude_grid=<UNSET>, longitude_grid=<UNSET>, longitude_grid_ends=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
latitude_grid unknown
longitude_grid unknown
longitude_grid_ends unknown
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim unknown
xmargin float greater than -0.5
xscale unknown
xticklabels unknown
xticks unknown
ybound 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: matplotlib.projections.geo.GeoAxes Build an Axes in a figure. Parameters
figFigure
The Axes is built in the Figure fig.
rect[left, bottom, width, height]
The Axes is built in the rectangle rect. rect is in Figure coordinates.
sharex, shareyAxes, optional
The x or y axis is shared with the x or y axis in the input 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. **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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float Returns
Axes
The new Axes object. classInvertedMollweideTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(xy)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
classMollweideTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(ll)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x 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>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, latitude_grid=<UNSET>, longitude_grid=<UNSET>, longitude_grid_ends=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
latitude_grid unknown
longitude_grid unknown
longitude_grid_ends unknown
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim unknown
xmargin float greater than -0.5
xscale unknown
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim unknown
ymargin float greater than -0.5
yscale unknown
yticklabels unknown
yticks unknown
zorder float
|
matplotlib.projections_api
|
classmatplotlib.projections.geo.AitoffAxes(*args, **kwargs)[source]
Bases: matplotlib.projections.geo.GeoAxes Build an Axes in a figure. Parameters
figFigure
The Axes is built in the Figure fig.
rect[left, bottom, width, height]
The Axes is built in the rectangle rect. rect is in Figure coordinates.
sharex, shareyAxes, optional
The x or y axis is shared with the x or y axis in the input 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. **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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float Returns
Axes
The new Axes object. classAitoffTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(ll)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
classInvertedAitoffTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(xy)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x 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>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, latitude_grid=<UNSET>, longitude_grid=<UNSET>, longitude_grid_ends=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
latitude_grid unknown
longitude_grid unknown
longitude_grid_ends unknown
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim unknown
xmargin float greater than -0.5
xscale unknown
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim unknown
ymargin float greater than -0.5
yscale unknown
yticklabels unknown
yticks unknown
zorder float
|
matplotlib.projections_api#matplotlib.projections.geo.AitoffAxes
|
classAitoffTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(ll)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
|
matplotlib.projections_api#matplotlib.projections.geo.AitoffAxes.AitoffTransform
|
has_inverse=True
True if this transform has a corresponding inverse transform.
|
matplotlib.projections_api#matplotlib.projections.geo.AitoffAxes.AitoffTransform.has_inverse
|
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.
|
matplotlib.projections_api#matplotlib.projections.geo.AitoffAxes.AitoffTransform.inverted
|
transform_non_affine(ll)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
|
matplotlib.projections_api#matplotlib.projections.geo.AitoffAxes.AitoffTransform.transform_non_affine
|
classInvertedAitoffTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(xy)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
|
matplotlib.projections_api#matplotlib.projections.geo.AitoffAxes.InvertedAitoffTransform
|
has_inverse=True
True if this transform has a corresponding inverse transform.
|
matplotlib.projections_api#matplotlib.projections.geo.AitoffAxes.InvertedAitoffTransform.has_inverse
|
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.
|
matplotlib.projections_api#matplotlib.projections.geo.AitoffAxes.InvertedAitoffTransform.inverted
|
transform_non_affine(xy)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
|
matplotlib.projections_api#matplotlib.projections.geo.AitoffAxes.InvertedAitoffTransform.transform_non_affine
|
name='aitoff'
|
matplotlib.projections_api#matplotlib.projections.geo.AitoffAxes.name
|
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>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, latitude_grid=<UNSET>, longitude_grid=<UNSET>, longitude_grid_ends=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
latitude_grid unknown
longitude_grid unknown
longitude_grid_ends unknown
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim unknown
xmargin float greater than -0.5
xscale unknown
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim unknown
ymargin float greater than -0.5
yscale unknown
yticklabels unknown
yticks unknown
zorder float
|
matplotlib.projections_api#matplotlib.projections.geo.AitoffAxes.set
|
classmatplotlib.projections.geo.GeoAxes(fig, rect, *, facecolor=None, frameon=True, sharex=None, sharey=None, label='', xscale=None, yscale=None, box_aspect=None, **kwargs)[source]
Bases: matplotlib.axes._axes.Axes An abstract base class for geographic projections. Build an Axes in a figure. Parameters
figFigure
The Axes is built in the Figure fig.
rect[left, bottom, width, height]
The Axes is built in the rectangle rect. rect is in Figure coordinates.
sharex, shareyAxes, optional
The x or y axis is shared with the x or y axis in the input 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. **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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float Returns
Axes
The new Axes object. RESOLUTION=75
classThetaFormatter(round_to=1.0)[source]
Bases: matplotlib.ticker.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.
cla()[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 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.
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 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 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.
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>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, latitude_grid=<UNSET>, longitude_grid=<UNSET>, longitude_grid_ends=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
latitude_grid unknown
longitude_grid unknown
longitude_grid_ends unknown
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim unknown
xmargin float greater than -0.5
xscale unknown
xticklabels unknown
xticks unknown
ybound 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_xlim(*args, **kwargs)[source]
Not supported. Please consider using Cartopy.
set_xscale(*args, **kwargs)[source]
Set the x-axis scale. Parameters
value{"linear", "log", "symlog", "logit", ...} or ScaleBase
The axis scale type to apply. **kwargs
Different keyword arguments are accepted, depending on the scale. See the respective class keyword arguments: matplotlib.scale.LinearScale matplotlib.scale.LogScale matplotlib.scale.SymmetricalLogScale matplotlib.scale.LogitScale matplotlib.scale.FuncScale Notes By default, Matplotlib supports the above mentioned scales. Additionally, custom scales may be registered using matplotlib.scale.register_scale. These scales can then also be used here.
set_ylim(*args, **kwargs)[source]
Not supported. Please consider using Cartopy.
set_yscale(*args, **kwargs)[source]
Set the y-axis scale. Parameters
value{"linear", "log", "symlog", "logit", ...} or ScaleBase
The axis scale type to apply. **kwargs
Different keyword arguments are accepted, depending on the scale. See the respective class keyword arguments: matplotlib.scale.LinearScale matplotlib.scale.LogScale matplotlib.scale.SymmetricalLogScale matplotlib.scale.LogitScale matplotlib.scale.FuncScale Notes By default, Matplotlib supports the above mentioned scales. Additionally, custom scales may be registered using matplotlib.scale.register_scale. These scales can then also be used here.
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.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes
|
can_pan()[source]
Return whether this axes supports the pan/zoom button functionality. This axes object does not support interactive pan/zoom.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.can_pan
|
can_zoom()[source]
Return whether this axes supports the zoom box button functionality. This axes object does not support interactive zoom box.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.can_zoom
|
cla()[source]
Clear the Axes.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.cla
|
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.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.drag_pan
|
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.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.end_pan
|
format_coord(lon, lat)[source]
Return a format string formatting the coordinate.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.format_coord
|
get_data_ratio()[source]
Return the aspect ratio of the data itself.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.get_data_ratio
|
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.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.get_xaxis_text1_transform
|
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.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.get_xaxis_text2_transform
|
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.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.get_xaxis_transform
|
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.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.get_yaxis_text1_transform
|
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 Axis class, and is meant to be overridden by new kinds of projections that may need to place axis elements in different locations.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.get_yaxis_text2_transform
|
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.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.get_yaxis_transform
|
RESOLUTION=75
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.RESOLUTION
|
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>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, latitude_grid=<UNSET>, longitude_grid=<UNSET>, longitude_grid_ends=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
latitude_grid unknown
longitude_grid unknown
longitude_grid_ends unknown
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim unknown
xmargin float greater than -0.5
xscale unknown
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim unknown
ymargin float greater than -0.5
yscale unknown
yticklabels unknown
yticks unknown
zorder float
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.set
|
set_latitude_grid(degrees)[source]
Set the number of degrees between each latitude grid.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.set_latitude_grid
|
set_longitude_grid(degrees)[source]
Set the number of degrees between each longitude grid.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.set_longitude_grid
|
set_longitude_grid_ends(degrees)[source]
Set the latitude(s) at which to stop drawing the longitude grids.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.set_longitude_grid_ends
|
set_xlim(*args, **kwargs)[source]
Not supported. Please consider using Cartopy.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.set_xlim
|
set_xscale(*args, **kwargs)[source]
Set the x-axis scale. Parameters
value{"linear", "log", "symlog", "logit", ...} or ScaleBase
The axis scale type to apply. **kwargs
Different keyword arguments are accepted, depending on the scale. See the respective class keyword arguments: matplotlib.scale.LinearScale matplotlib.scale.LogScale matplotlib.scale.SymmetricalLogScale matplotlib.scale.LogitScale matplotlib.scale.FuncScale Notes By default, Matplotlib supports the above mentioned scales. Additionally, custom scales may be registered using matplotlib.scale.register_scale. These scales can then also be used here.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.set_xscale
|
set_ylim(*args, **kwargs)[source]
Not supported. Please consider using Cartopy.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.set_ylim
|
set_yscale(*args, **kwargs)[source]
Set the y-axis scale. Parameters
value{"linear", "log", "symlog", "logit", ...} or ScaleBase
The axis scale type to apply. **kwargs
Different keyword arguments are accepted, depending on the scale. See the respective class keyword arguments: matplotlib.scale.LinearScale matplotlib.scale.LogScale matplotlib.scale.SymmetricalLogScale matplotlib.scale.LogitScale matplotlib.scale.FuncScale Notes By default, Matplotlib supports the above mentioned scales. Additionally, custom scales may be registered using matplotlib.scale.register_scale. These scales can then also be used here.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.set_yscale
|
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.
|
matplotlib.projections_api#matplotlib.projections.geo.GeoAxes.start_pan
|
classThetaFormatter(round_to=1.0)[source]
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_api#matplotlib.projections.geo.GeoAxes.ThetaFormatter
|
classmatplotlib.projections.geo.HammerAxes(*args, **kwargs)[source]
Bases: matplotlib.projections.geo.GeoAxes Build an Axes in a figure. Parameters
figFigure
The Axes is built in the Figure fig.
rect[left, bottom, width, height]
The Axes is built in the rectangle rect. rect is in Figure coordinates.
sharex, shareyAxes, optional
The x or y axis is shared with the x or y axis in the input 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. **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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float Returns
Axes
The new Axes object. classHammerTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(ll)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
classInvertedHammerTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(xy)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x 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>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, latitude_grid=<UNSET>, longitude_grid=<UNSET>, longitude_grid_ends=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<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
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
latitude_grid unknown
longitude_grid unknown
longitude_grid_ends unknown
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim unknown
xmargin float greater than -0.5
xscale unknown
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim unknown
ymargin float greater than -0.5
yscale unknown
yticklabels unknown
yticks unknown
zorder float
|
matplotlib.projections_api#matplotlib.projections.geo.HammerAxes
|
classHammerTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(ll)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
|
matplotlib.projections_api#matplotlib.projections.geo.HammerAxes.HammerTransform
|
has_inverse=True
True if this transform has a corresponding inverse transform.
|
matplotlib.projections_api#matplotlib.projections.geo.HammerAxes.HammerTransform.has_inverse
|
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.
|
matplotlib.projections_api#matplotlib.projections.geo.HammerAxes.HammerTransform.inverted
|
transform_non_affine(ll)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
|
matplotlib.projections_api#matplotlib.projections.geo.HammerAxes.HammerTransform.transform_non_affine
|
classInvertedHammerTransform(resolution)[source]
Bases: matplotlib.projections.geo._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(xy)[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 NumPy array of length input_dims or shape (N x input_dims). Returns
array
The output values as NumPy array of length input_dims or shape (N x output_dims), depending on the input.
|
matplotlib.projections_api#matplotlib.projections.geo.HammerAxes.InvertedHammerTransform
|
has_inverse=True
True if this transform has a corresponding inverse transform.
|
matplotlib.projections_api#matplotlib.projections.geo.HammerAxes.InvertedHammerTransform.has_inverse
|
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.
|
matplotlib.projections_api#matplotlib.projections.geo.HammerAxes.InvertedHammerTransform.inverted
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.