mpl_toolkits.axes_grid1.inset_locator
¶A collection of functions and objects for creating or placing inset axes.
mpl_toolkits.axes_grid1.inset_locator.
AnchoredLocatorBase
(bbox_to_anchor, offsetbox, loc, borderpad=0.5, bbox_transform=None)¶Bases: matplotlib.offsetbox.AnchoredOffsetbox
draw
(renderer)¶mpl_toolkits.axes_grid1.inset_locator.
AnchoredSizeLocator
(bbox_to_anchor, x_size, y_size, loc, borderpad=0.5, bbox_transform=None)¶Bases: mpl_toolkits.axes_grid1.inset_locator.AnchoredLocatorBase
get_extent
(renderer)¶mpl_toolkits.axes_grid1.inset_locator.
AnchoredZoomLocator
(parent_axes, zoom, loc, borderpad=0.5, bbox_to_anchor=None, bbox_transform=None)¶Bases: mpl_toolkits.axes_grid1.inset_locator.AnchoredLocatorBase
get_extent
(renderer)¶mpl_toolkits.axes_grid1.inset_locator.
BboxConnector
(bbox1, bbox2, loc1, loc2=None, **kwargs)¶Bases: matplotlib.patches.Patch
Connect two bboxes with a straight line.
Parameters: | bbox1, bbox2 :
loc1 : {1, 2, 3, 4}
loc2 : {1, 2, 3, 4}, optional
**kwargs
|
---|
connect_bbox
(bbox1, bbox2, loc1, loc2=None)¶Helper function to obtain a Path from one bbox to another.
Parameters: | bbox1, bbox2 :
loc1 : {1, 2, 3, 4}
loc2 : {1, 2, 3, 4}, optional
|
---|---|
Returns: | path :
|
get_bbox_edge_pos
(bbox, loc)¶Helper function to obtain the location of a corner of a bbox
Parameters: | bbox : loc : {1, 2, 3, 4}
|
---|---|
Returns: | x, y : float
|
get_path
()¶Return the path of this patch
mpl_toolkits.axes_grid1.inset_locator.
BboxConnectorPatch
(bbox1, bbox2, loc1a, loc2a, loc1b, loc2b, **kwargs)¶Bases: mpl_toolkits.axes_grid1.inset_locator.BboxConnector
Connect two bboxes with a quadrilateral.
The quadrilateral is specified by two lines that start and end at corners of the bboxes. The four sides of the quadrilateral are defined by the two lines given, the line between the two corners specified in bbox1 and the line between the two corners specified in bbox2.
Parameters: | bbox1, bbox2 :
loc1a, loc2a : {1, 2, 3, 4}
loc1b, loc2b : {1, 2, 3, 4}
**kwargs
|
---|
get_path
()¶Return the path of this patch
mpl_toolkits.axes_grid1.inset_locator.
BboxPatch
(bbox, **kwargs)¶Bases: matplotlib.patches.Patch
Patch showing the shape bounded by a Bbox.
Parameters: | bbox :
**kwargs
|
---|
get_path
()¶Return the path of this patch
mpl_toolkits.axes_grid1.inset_locator.
InsetPosition
(parent, lbwh)¶Bases: object
An object for positioning an inset axes.
This is created by specifying the normalized coordinates in the axes, instead of the figure.
Parameters: | parent :
lbwh : iterable of four floats
|
---|
Examples
The following bounds the inset axes to a box with 20% of the parent axes’s height and 40% of the width. The size of the axes specified ([0, 0, 1, 1]) ensures that the axes completely fills the bounding box:
>>> parent_axes = plt.gca()
>>> ax_ins = plt.axes([0, 0, 1, 1])
>>> ip = InsetPosition(ax, [0.5, 0.1, 0.4, 0.2])
>>> ax_ins.set_axes_locator(ip)
mpl_toolkits.axes_grid1.inset_locator.
inset_axes
(parent_axes, width, height, loc=1, bbox_to_anchor=None, bbox_transform=None, axes_class=None, axes_kwargs=None, borderpad=0.5)¶Create an inset axes with a given width and height.
Both sizes used can be specified either in inches or percentage of the parent axes.
Parameters: | parent_axes :
width, height : float or str
loc : int or string, optional, default to 1
bbox_to_anchor : tuple or
bbox_transform :
axes_class :
axes_kwargs : dict, optional
borderpad : float, optional
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Returns: | inset_axes :
|
mpl_toolkits.axes_grid1.inset_locator.
mark_inset
(parent_axes, inset_axes, loc1, loc2, **kwargs)¶Draw a box to mark the location of an area represented by an inset axes.
This function draws a box in parent_axes at the bounding box of inset_axes, and shows a connection with the inset axes by drawing lines at the corners, giving a “zoomed in” effect.
Parameters: | parent_axes :
inset_axes :
loc1, loc2 : {1, 2, 3, 4}
**kwargs
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Returns: |
p1, p2 :
|
mpl_toolkits.axes_grid1.inset_locator.
zoomed_inset_axes
(parent_axes, zoom, loc=1, bbox_to_anchor=None, bbox_transform=None, axes_class=None, axes_kwargs=None, borderpad=0.5)¶Create an anchored inset axes by scaling a parent axes.
Parameters: | parent_axes :
zoom : float
loc : int or string, optional, default to 1
bbox_to_anchor : tuple or
bbox_transform :
axes_class :
axes_kwargs : dict, optional
borderpad : float, optional
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Returns: | inset_axes :
|