py_eddy_tracker.gui.GUIAxes¶
- class py_eddy_tracker.gui.GUIAxes(*args, **kwargs)[source]¶
Bases:
PlatCarreAxes
Axes that uses full space available
Build an Axes in a figure.
Parameters¶
- fig~matplotlib.figure.Figure
The Axes is built in the .Figure fig.
- *args
*args
can be a single(left, bottom, width, height)
rectangle or a single .Bbox. This specifies the rectangle (in figure coordinates) where the Axes is positioned.*args
can also consist of three numbers or a single three-digit number; in the latter case, the digits are considered as independent numbers. The numbers are interpreted as(nrows, ncols, index)
:(nrows, ncols)
specifies the size of an array of subplots, andindex
is the 1-based index of the subplot being created. Finally,*args
can also directly be a .SubplotSpec instance.- sharex, sharey~.axes.Axes, optional
The x- or y-~.matplotlib.axis is shared with the x- or y-axis in the input ~.axes.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 ~.axes.Axes.set_box_aspect for details.
- **kwargs
Other optional keyword arguments:
Properties: adjustable: {‘box’, ‘datalim’} agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image alpha: 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: unknown autoscaley_on: unknown 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 mouseover: bool navigate: bool navigate_mode: unknown path_effects: .AbstractPathEffect picker: None or bool or float or callable position: [left, bottom, width, height] or ~matplotlib.transforms.Bbox prop_cycle: unknown rasterization_zorder: float or None rasterized: bool sketch_params: (scale: float, length: float, randomness: float) snap: bool or None subplotspec: unknown title: str transform: .Transform url: str visible: bool xbound: unknown xlabel: str xlim: (bottom: float, top: float) xmargin: float greater than -0.5 xscale: unknown xticklabels: unknown xticks: unknown ybound: unknown ylabel: str ylim: (bottom: float, top: float) ymargin: float greater than -0.5 yscale: unknown yticklabels: unknown yticks: unknown zorder: float
Returns¶
- ~.axes.Axes
The new ~.axes.Axes object.
Methods
acorr
Plot the autocorrelation of x.
add_artist
Add an .Artist to the Axes; return the artist.
add_callback
Add a callback function that will be called whenever one of the .Artist's properties changes.
add_child_axes
Add an .AxesBase to the Axes' children; return the child Axes.
add_collection
Add a .Collection to the Axes; return the collection.
add_container
Add a .Container to the Axes' containers; return the container.
add_image
Add an .AxesImage to the Axes; return the image.
add_line
Add a .Line2D to the Axes; return the line.
add_patch
Add a .Patch to the Axes; return the patch.
add_table
Add a .Table to the Axes; return the table.
angle_spectrum
Plot the angle spectrum.
annotate
Annotate the point xy with text text.
apply_aspect
Adjust the Axes for a specified data aspect ratio.
arrow
Add an arrow to the Axes.
autoscale
Autoscale the axis view to the data (toggle).
autoscale_view
Autoscale the view limits using the data limits.
axhline
Add a horizontal line across the Axes.
axhspan
Add a horizontal span (rectangle) across the Axes.
axis
Convenience method to get or set some axis properties.
axline
Add an infinitely long straight line.
axvline
Add a vertical line across the Axes.
axvspan
Add a vertical span (rectangle) across the Axes.
bar
Make a bar plot.
bar_label
Label a bar plot.
barbs
Plot a 2D field of barbs.
barh
Make a horizontal bar plot.
boxplot
Draw a box and whisker plot.
broken_barh
Plot a horizontal sequence of rectangles.
bxp
Drawing function for box and whisker plots.
can_pan
Return whether this Axes supports any pan/zoom button functionality.
can_zoom
Return whether this Axes supports the zoom box button functionality.
cla
Clear the Axes.
clabel
Label a contour plot.
clear
Clear the Axes.
cohere
Plot the coherence between x and y.
contains
Test whether the artist contains the mouse event.
contains_point
Return whether point (pair of pixel coordinates) is inside the Axes patch.
contour
Plot contour lines.
contourf
Plot filled contours.
convert_xunits
Convert x using the unit type of the xaxis.
convert_yunits
Convert y using the unit type of the yaxis.
csd
Plot the cross-spectral density.
drag_pan
Called when the mouse moves during a pan operation.
draw
Draw the Artist (and its children) using the given renderer.
draw_artist
Efficiently redraw a single artist.
Called when a pan operation completes (when the mouse button is up.)
errorbar
Plot y versus x as lines and/or markers with attached errorbars.
eventplot
Plot identical parallel lines at the given positions.
fill
Plot filled polygons.
fill_between
Fill the area between two horizontal curves.
fill_betweenx
Fill the area between two vertical curves.
findobj
Find artist objects.
format_coord
Return a format string formatting the x, y coordinates.
format_cursor_data
Return a string representation of data.
format_xdata
Return x formatted as an x-value.
format_ydata
Return y formatted as a y-value.
get_adjustable
Return whether the Axes will adjust its physical dimension ('box') or its data limits ('datalim') to achieve the desired aspect ratio.
get_agg_filter
Return filter function to be used for agg filter.
get_alpha
Return the alpha value used for blending - not supported on all backends.
get_anchor
Get the anchor location.
get_animated
Return whether the artist is animated.
get_aspect
Return the aspect ratio of the axes scaling.
get_autoscale_on
Return True if each axis is autoscaled, False otherwise.
get_autoscalex_on
Return whether the xaxis is autoscaled.
get_autoscaley_on
Return whether the yaxis is autoscaled.
get_axes_locator
Return the axes_locator.
get_axisbelow
Get whether axis ticks and gridlines are above or below most artists.
get_box_aspect
Return the Axes box aspect, i.e. the ratio of height to width.
get_children
Return a list of the child .Artists of this .Artist.
get_clip_box
Return the clipbox.
get_clip_on
Return whether the artist uses clipping.
get_clip_path
Return the clip path.
get_cursor_data
Return the cursor data for a given event.
get_data_ratio
Return the aspect ratio of the scaled data.
get_default_bbox_extra_artists
Return a default list of artists that are used for the bounding box calculation.
get_facecolor
Get the facecolor of the Axes.
get_fc
Alias for get_facecolor.
get_figure
Return the .Figure instance the artist belongs to.
get_frame_on
Get whether the Axes rectangle patch is drawn.
get_gid
Return the group id.
get_gridspec
Return the .GridSpec associated with the subplot, or None.
get_images
Return a list of .AxesImages contained by the Axes.
get_in_layout
Return boolean flag,
True
if artist is included in layout calculations.get_label
Return the label used for this artist in the legend.
get_legend
Return the .Legend instance, or None if no legend is defined.
get_legend_handles_labels
Return handles and labels for legend
get_lines
Return a list of lines contained by the Axes.
get_mouseover
Return whether this artist is queried for custom context information when the mouse cursor moves over it.
get_navigate
Get whether the Axes responds to navigation commands.
get_navigate_mode
Get the navigation toolbar button status: 'PAN', 'ZOOM', or None.
get_path_effects
get_picker
Return the picking behavior of the artist.
get_position
Return the position of the Axes within the figure as a .Bbox.
get_rasterization_zorder
Return the zorder value below which artists will be rasterized.
get_rasterized
Return whether the artist is to be rasterized.
get_renderer_cache
[Deprecated]
get_shared_x_axes
Return an immutable view on the shared x-axes Grouper.
get_shared_y_axes
Return an immutable view on the shared y-axes Grouper.
get_sketch_params
Return the sketch parameters for the artist.
get_snap
Return the snap setting.
get_subplotspec
Return the .SubplotSpec associated with the subplot, or None.
get_tightbbox
Return the tight bounding box of the Axes, including axis and their decorators (xlabel, title, etc).
get_title
Get an Axes title.
get_transform
Return the .Transform instance used by this artist.
get_transformed_clip_path_and_affine
Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.
get_url
Return the url.
get_visible
Return the visibility.
get_window_extent
Return the Axes bounding box in display space; args and kwargs are empty.
get_xaxis
[Discouraged] Return the XAxis instance.
get_xaxis_text1_transform
Returns transform Transform 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.
get_xaxis_text2_transform
Returns transform Transform 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.
get_xaxis_transform
Get the transformation used for drawing x-axis labels, ticks and gridlines.
get_xbound
Return the lower and upper x-axis bounds, in increasing order.
get_xgridlines
Return the xaxis' grid lines as a list of .Line2Ds.
get_xlabel
Get the xlabel text string.
get_xlim
Return the x-axis view limits.
get_xmajorticklabels
Return the xaxis' major tick labels, as a list of ~.text.Text.
get_xminorticklabels
Return the xaxis' minor tick labels, as a list of ~.text.Text.
get_xscale
Return the xaxis' scale (as a str).
get_xticklabels
Get the xaxis' tick labels.
get_xticklines
Return the xaxis' tick lines as a list of .Line2Ds.
get_xticks
Return the xaxis' tick locations in data coordinates.
get_yaxis
[Discouraged] Return the YAxis instance.
get_yaxis_text1_transform
Returns transform Transform 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.
get_yaxis_text2_transform
Returns transform Transform 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.
get_yaxis_transform
Get the transformation used for drawing y-axis labels, ticks and gridlines.
get_ybound
Return the lower and upper y-axis bounds, in increasing order.
get_ygridlines
Return the yaxis' grid lines as a list of .Line2Ds.
get_ylabel
Get the ylabel text string.
get_ylim
Return the y-axis view limits.
get_ymajorticklabels
Return the yaxis' major tick labels, as a list of ~.text.Text.
get_yminorticklabels
Return the yaxis' minor tick labels, as a list of ~.text.Text.
get_yscale
Return the yaxis' scale (as a str).
get_yticklabels
Get the yaxis' tick labels.
get_yticklines
Return the yaxis' tick lines as a list of .Line2Ds.
get_yticks
Return the yaxis' tick locations in data coordinates.
get_zorder
Return the artist's zorder.
grid
Configure the grid lines.
has_data
Return whether any artists have been added to the Axes.
have_units
Return whether units are set on any axis.
hexbin
Make a 2D hexagonal binning plot of points x, y.
hist
Compute and plot a histogram.
hist2d
Make a 2D histogram plot.
hlines
Plot horizontal lines at each y from xmin to xmax.
imshow
Display data as an image, i.e., on a 2D regular raster.
in_axes
Return whether the given event (in display coords) is in the Axes.
indicate_inset
Add an inset indicator to the Axes.
indicate_inset_zoom
Add an inset indicator rectangle to the Axes based on the axis limits for an inset_ax and draw connectors between inset_ax and the rectangle.
inset_axes
Add a child inset Axes to this existing Axes.
invert_xaxis
Invert the x-axis.
invert_yaxis
Invert the y-axis.
is_transform_set
Return whether the Artist has an explicitly set transform.
label_outer
Only show "outer" labels and tick labels.
legend
Place a legend on the Axes.
locator_params
Control behavior of major tick locators.
loglog
Make a plot with log scaling on both the x- and y-axis.
magnitude_spectrum
Plot the magnitude spectrum.
margins
Set or retrieve autoscaling margins.
matshow
Plot the values of a 2D matrix or array as color-coded image.
minorticks_off
Remove minor ticks from the Axes.
minorticks_on
Display minor ticks on the Axes.
pchanged
Call all of the registered callbacks.
pcolor
Create a pseudocolor plot with a non-regular rectangular grid.
pcolorfast
Create a pseudocolor plot with a non-regular rectangular grid.
pcolormesh
Create a pseudocolor plot with a non-regular rectangular grid.
phase_spectrum
Plot the phase spectrum.
pick
Process a pick event.
pickable
Return whether the artist is pickable.
pie
Plot a pie chart.
plot
Plot y versus x as lines and/or markers.
plot_date
[Discouraged] Plot coercing the axis to treat floats as dates.
properties
Return a dictionary of all the properties of the artist.
psd
Plot the power spectral density.
quiver
Plot a 2D field of arrows.
quiverkey
Add a key to a quiver plot.
redraw_in_frame
Efficiently redraw Axes data, but not axis ticks, labels, etc.
relim
Recompute the data limits based on current artists.
remove
Remove the artist from the figure if possible.
remove_callback
Remove a callback based on its observer id.
reset_position
Reset the active position to the original position.
scatter
A scatter plot of y vs.
secondary_xaxis
Add a second x-axis to this ~.axes.Axes.
secondary_yaxis
Add a second y-axis to this ~.axes.Axes.
semilogx
Make a plot with log scaling on the x-axis.
semilogy
Make a plot with log scaling on the y-axis.
Set multiple properties at once.
set_adjustable
Set how the Axes adjusts to achieve the required aspect ratio.
set_agg_filter
Set the agg filter.
set_alpha
Set the alpha value used for blending - not supported on all backends.
set_anchor
Define the anchor location.
set_animated
Set whether the artist is intended to be used in an animation.
set_aspect
Set the aspect ratio of the axes scaling, i.e. y/x-scale.
set_autoscale_on
Set whether autoscaling is applied to each axis on the next draw or call to .Axes.autoscale_view.
set_autoscalex_on
Set whether the xaxis is autoscaled when drawing or by .Axes.autoscale_view.
set_autoscaley_on
Set whether the yaxis is autoscaled when drawing or by .Axes.autoscale_view.
set_axes_locator
Set the Axes locator.
set_axis_off
Turn the x- and y-axis off.
set_axis_on
Turn the x- and y-axis on.
set_axisbelow
Set whether axis ticks and gridlines are above or below most artists.
set_box_aspect
Set the Axes box aspect, i.e. the ratio of height to width.
set_clip_box
Set the artist's clip .Bbox.
set_clip_on
Set whether the artist uses clipping.
set_clip_path
Set the artist's clip path.
set_facecolor
Set the facecolor of the Axes.
set_fc
Alias for set_facecolor.
set_figure
Set the .Figure instance the artist belongs to.
set_frame_on
Set whether the Axes rectangle patch is drawn.
set_gid
Set the (group) id for the artist.
set_in_layout
Set if artist is to be included in layout calculations, E.g.
set_label
Set a label that will be displayed in the legend.
set_mouseover
Set whether this artist is queried for custom context information when the mouse cursor moves over it.
set_navigate
Set whether the Axes responds to navigation toolbar commands.
set_navigate_mode
Set the navigation toolbar button status.
set_path_effects
Set the path effects.
set_picker
Define the picking behavior of the artist.
set_position
Set the Axes position.
set_prop_cycle
Set the property cycle of the Axes.
set_rasterization_zorder
Set the zorder threshold for rasterization for vector graphics output.
set_rasterized
Force rasterized (bitmap) drawing for vector graphics output.
set_sketch_params
Set the sketch parameters.
set_snap
Set the snapping behavior.
set_subplotspec
Set the .SubplotSpec.
set_title
Set a title for the Axes.
set_transform
Set the artist transform.
set_url
Set the url for the artist.
set_visible
Set the artist's visibility.
set_xbound
Set the lower and upper numerical bounds of the x-axis.
set_xlabel
Set the label for the x-axis.
set_xlim
Set the x-axis view limits.
set_xmargin
Set padding of X data limits prior to autoscaling.
set_xscale
Set the xaxis' scale.
set_xticklabels
[Discouraged] Set the xaxis' tick labels with list of string labels.
set_xticks
Set the xaxis' tick locations and optionally labels.
set_ybound
Set the lower and upper numerical bounds of the y-axis.
set_ylabel
Set the label for the y-axis.
set_ylim
Set the y-axis view limits.
set_ymargin
Set padding of Y data limits prior to autoscaling.
set_yscale
Set the yaxis' scale.
set_yticklabels
[Discouraged] Set the yaxis' tick labels with list of string labels.
set_yticks
Set the yaxis' tick locations and optionally labels.
set_zorder
Set the zorder for the artist.
sharex
Share the x-axis with other.
sharey
Share the y-axis with other.
specgram
Plot a spectrogram.
spy
Plot the sparsity pattern of a 2D array.
stackplot
Draw a stacked area plot.
stairs
A stepwise constant function as a line with bounding edges or a filled plot.
start_pan
Called when a pan operation has started.
stem
Create a stem plot.
step
Make a step plot.
streamplot
Draw streamlines of a vector flow.
table
Add a table to an ~.axes.Axes.
text
Add text to the Axes.
tick_params
Change the appearance of ticks, tick labels, and gridlines.
ticklabel_format
Configure the .ScalarFormatter used by default for linear Axes.
tricontour
Draw contour lines on an unstructured triangular grid.
tricontourf
Draw contour regions on an unstructured triangular grid.
tripcolor
Create a pseudocolor plot of an unstructured triangular grid.
triplot
Draw an unstructured triangular grid as lines and/or markers.
twinx
Create a twin Axes sharing the xaxis.
twiny
Create a twin Axes sharing the yaxis.
update
Update this artist's properties from the dict props.
update_datalim
Extend the ~.Axes.dataLim Bbox to include the given points.
update_from
Copy properties from other to self.
violin
Drawing function for violin plots.
violinplot
Make a violin plot.
vlines
Plot vertical lines at each x from ymin to ymax.
xaxis_date
Set up axis ticks and labels to treat data along the xaxis as dates.
xaxis_inverted
Return whether the xaxis is oriented in the "inverse" direction.
xcorr
Plot the cross correlation between x and y.
yaxis_date
Set up axis ticks and labels to treat data along the yaxis as dates.
yaxis_inverted
Return whether the yaxis is oriented in the "inverse" direction.
Attributes
artists
axes
The ~.axes.Axes instance the artist resides in, or None.
collections
images
lines
mouseover
Return whether this artist is queried for custom context information when the mouse cursor moves over it.
patches
stale
Whether the artist is 'stale' and needs to be re-drawn for the output to match the internal state of the artist.
sticky_edges
x
andy
sticky edge lists for autoscaling.tables
texts
use_sticky_edges
When autoscaling, whether to obey all Artist.sticky_edges.
viewLim
zorder
- end_pan(*args, **kwargs)[source]¶
Called when a pan operation completes (when the mouse button is up.)
Notes¶
This is intended to be overridden by new projection types.
- name = 'full_axes'¶
- 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>, mouseover=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, subplotspec=<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>)¶
Set multiple properties at once.
Supported properties are
- Properties:
adjustable: {‘box’, ‘datalim’} agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image alpha: 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: unknown autoscaley_on: unknown 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 mouseover: bool navigate: bool navigate_mode: unknown path_effects: .AbstractPathEffect picker: None or bool or float or callable position: [left, bottom, width, height] or ~matplotlib.transforms.Bbox prop_cycle: unknown rasterization_zorder: float or None rasterized: bool sketch_params: (scale: float, length: float, randomness: float) snap: bool or None subplotspec: unknown title: str transform: .Transform url: str visible: bool xbound: unknown xlabel: str xlim: (bottom: float, top: float) xmargin: float greater than -0.5 xscale: unknown xticklabels: unknown xticks: unknown ybound: unknown ylabel: str ylim: (bottom: float, top: float) ymargin: float greater than -0.5 yscale: unknown yticklabels: unknown yticks: unknown zorder: float