neulab/docprompting-conala huggingface dataset:
print_figure(filename, dpi=None, facecolor=None, edgecolor=None, orientation='portrait', format=None, *, bbox_inches=None, pad_inches=None, bbox_extra_artists=None, backend=None, **kwargs)[source]
 
Render the figure to hardcopy. Set the figure patch face and edge colors. This is useful because some of the GUIs have a gray figure face color background and you'll probably want to override this on hardcopy.  Parameters 
 
filenamestr or path-like or file-like


The file where the figure is saved.  
dpifloat, default: rcParams["savefig.dpi"] (default: 'figure')


The dots per inch to save the figure in.  
facecolorcolor or 'auto', default: rcParams["savefig.facecolor"] (default: 'auto')


The facecolor of the figure. If 'auto', use the current figure facecolor.  
edgecolorcolor or 'auto', default: rcParams["savefig.edgecolor"] (default: 'auto')


The edgecolor of the figure. If 'auto', use the current figure edgecolor.  
orientation{'landscape', 'portrait'}, default: 'portrait'


Only currently applies to PostScript printing.  
formatstr, optional


Force a specific file format. If not given, the format is inferred from the filename extension, and if that fails from rcParams["savefig.format"] (default: 'png').  
bbox_inches'tight' or Bbox, default: rcParams["savefig.bbox"] (default: None)


Bounding box in inches: only the given portion of the figure is saved. If 'tight', try to figure out the tight bbox of the figure.  
pad_inchesfloat, default: rcParams["savefig.pad_inches"] (default: 0.1)


Amount of padding around the figure when bbox_inches is 'tight'.  
bbox_extra_artistslist of Artist, optional


A list of extra artists that will be considered when the tight bbox is calculated.  
backendstr, optional


Use a non-default backend to render the file, e.g. to render a png file with the "cairo" backend rather than the default "agg", or a pdf file with the "pgf" backend rather than the default "pdf". Note that the default backend is normally sufficient. See The builtin backends for a list of valid backends for each file format. Custom backends can be referenced as "module://...".
release_mouse(ax)[source]
 
Release the mouse grab held by the Axes ax. Usually called by the widgets. It is ok to call this even if ax doesn't have the mouse grab currently.
resize(w, h)[source]
 
UNUSED: Set the canvas size in pixels. Certain backends may implement a similar method internally, but this is not a requirement of, nor is it used by, Matplotlib itself.
resize_event()[source]
 
Pass a ResizeEvent to all functions connected to resize_event.
scroll_event(x, y, step, guiEvent=None)[source]
 
Callback processing for scroll events. Backend derived classes should call this function on any scroll wheel event. (x, y) are the canvas coords ((0, 0) is lower left). button and key are as defined in MouseEvent. This method will call all functions connected to the 'scroll_event' with a MouseEvent instance.
set_cursor(cursor)[source]
 
Set the current cursor. This may have no effect if the backend does not display anything. If required by the backend, this method should trigger an update in the backend event loop after the cursor is set, as this method may be called e.g. before a long-running task during which the GUI is not updated.  Parameters 
 
cursorCursors


The cursor to display over the canvas. Note: some backends may change the cursor for the entire window.
set_window_title(title)[source]
 
[Deprecated] Set the title text of the window containing the figure. Note that this has no effect if there is no window (e.g., a PS backend). Notes  Deprecated since version 3.4.
start_event_loop(timeout=0)[source]
 
Start a blocking event loop. Such an event loop is used by interactive functions, such as ginput and waitforbuttonpress, to wait for events. The event loop blocks until a callback function triggers stop_event_loop, or timeout is reached. If timeout is 0 or negative, never timeout. Only interactive backends need to reimplement this method and it relies on flush_events being properly implemented. Interactive backends should implement this in a more native way.
stop_event_loop()[source]
 
Stop the current blocking event loop. Interactive backends need to reimplement this to match start_event_loop
switch_backends(FigureCanvasClass)[source]
 
Instantiate an instance of FigureCanvasClass This is used for backend switching, e.g., to instantiate a FigureCanvasPS from a FigureCanvasGTK. Note, deep copying is not done, so any changes to one of the instances (e.g., setting figure size or line props), will be reflected in the other
classmatplotlib.backend_bases.FigureManagerBase(canvas, num)[source]
 
Bases: object A backend-independent abstraction of a figure container and controller. The figure manager is used by pyplot to interact with the window in a backend-independent way. It's an adapter for the real (GUI) framework that represents the visual figure on screen. GUI backends define from this class to translate common operations such as show or resize to the GUI-specific code. Non-GUI backends do not support these operations an can just use the base class. This following basic operations are accessible: Window operations  show destroy full_screen_toggle resize get_window_title set_window_title  Key and mouse button press handling The figure manager sets up default key and mouse button press handling by hooking up the key_press_handler to the matplotlib event system. This ensures the same shortcuts and mouse actions across backends. Other operations Subclasses will have additional attributes and functions to access additional functionality. This is of course backend-specific. For example, most GUI backends have window and toolbar attributes that give access to the native GUI widgets of the respective framework.  Attributes 
 
canvasFigureCanvasBase


The backend-specific canvas instance.  
numint or str


The figure number.  
key_press_handler_idint


The default key handler cid, when using the toolmanager. To disable the default key press handling use: figure.canvas.mpl_disconnect(
    figure.canvas.manager.key_press_handler_id)
  
button_press_handler_idint


The default mouse button handler cid, when using the toolmanager. To disable the default button press handling use: figure.canvas.mpl_disconnect(
    figure.canvas.manager.button_press_handler_id)
       button_press(event)[source]
 
[Deprecated] The default Matplotlib button actions for extra mouse buttons. Notes  Deprecated since version 3.4.  
   destroy()[source]

   full_screen_toggle()[source]

   get_window_title()[source]
 
Return the title text of the window containing the figure, or None if there is no window (e.g., a PS backend). 
   key_press(event)[source]
 
[Deprecated] Implement the default Matplotlib key bindings defined at Navigation keyboard shortcuts. Notes  Deprecated since version 3.4.  
   resize(w, h)[source]
 
For GUI backends, resize the window (in physical pixels). 
   set_window_title(title)[source]
 
Set the title text of the window containing the figure. This has no effect for non-GUI (e.g., PS) backends. 
   show()[source]
 
For GUI backends, show the figure window and redraw. For non-GUI backends, raise an exception, unless running headless (i.e. on Linux with an unset DISPLAY); this exception is converted to a warning in Figure.show.
button_press(event)[source]
 
[Deprecated] The default Matplotlib button actions for extra mouse buttons. Notes  Deprecated since version 3.4.
get_window_title()[source]
 
Return the title text of the window containing the figure, or None if there is no window (e.g., a PS backend).
key_press(event)[source]
 
[Deprecated] Implement the default Matplotlib key bindings defined at Navigation keyboard shortcuts. Notes  Deprecated since version 3.4.
resize(w, h)[source]
 
For GUI backends, resize the window (in physical pixels).
set_window_title(title)[source]
 
Set the title text of the window containing the figure. This has no effect for non-GUI (e.g., PS) backends.
show()[source]
 
For GUI backends, show the figure window and redraw. For non-GUI backends, raise an exception, unless running headless (i.e. on Linux with an unset DISPLAY); this exception is converted to a warning in Figure.show.
matplotlib.backend_bases.get_registered_canvas_class(format)[source]
 
Return the registered default canvas for given file format. Handles deferred import of required backend.
get_alpha()[source]
 
Return the alpha value used for blending - not supported on all backends.
get_antialiased()[source]
 
Return whether the object should try to do antialiased rendering.
get_clip_path()[source]
 
Return the clip path in the form (path, transform), where path is a Path instance, and transform is an affine transform to apply to the path before clipping.
get_clip_rectangle()[source]
 
Return the clip rectangle as a Bbox instance.
get_dashes()[source]
 
Return the dash style as an (offset, dash-list) pair. The dash list is a even-length list that gives the ink on, ink off in points. See p. 107 of to PostScript blue book for more info. Default value is (None, None).
get_forced_alpha()[source]
 
Return whether the value given by get_alpha() should be used to override any other alpha-channel values.
get_gid()[source]
 
Return the object identifier if one is set, None otherwise.
get_hatch_path(density=6.0)[source]
 
Return a Path for the current hatch.
get_rgb()[source]
 
Return a tuple of three or four floats from 0-1.
get_sketch_params()[source]
 
Return the sketch parameters for the artist.  Returns 
 tuple or None


A 3-tuple with the following elements:  
scale: The amplitude of the wiggle perpendicular to the source line. 
length: The length of the wiggle along the line. 
randomness: The scale factor by which the length is shrunken or expanded.  May return None if no sketch parameters were set.
get_snap()[source]
 
Return the snap setting, which can be:  True: snap vertices to the nearest pixel center False: leave vertices as-is None: (auto) If the path contains only rectilinear line segments, round to the nearest pixel center
restore()[source]
 
Restore the graphics context from the stack - needed only for backends that save graphics contexts on a stack.
set_alpha(alpha)[source]
 
Set the alpha value used for blending - not supported on all backends. If alpha=None (the default), the alpha components of the foreground and fill colors will be used to set their respective transparencies (where applicable); otherwise, alpha will override them.
set_antialiased(b)[source]
 
Set whether object should be drawn with antialiased rendering.
set_capstyle(cs)[source]
 
Set how to draw endpoints of lines.  Parameters 
 
csCapStyle or {'butt', 'projecting', 'round'}
set_clip_path(path)[source]
 
Set the clip path to a TransformedPath or None.
set_clip_rectangle(rectangle)[source]
 
Set the clip rectangle to a Bbox or None.
set_dashes(dash_offset, dash_list)[source]
 
Set the dash style for the gc.  Parameters 
 
dash_offsetfloat


The offset (usually 0).  
dash_listarray-like or None


The on-off sequence as points. None specifies a solid line.     Notes See p. 107 of to PostScript blue book for more info.
set_foreground(fg, isRGBA=False)[source]
 
Set the foreground color.  Parameters 
 
fgcolor


isRGBAbool


If fg is known to be an (r, g, b, a) tuple, isRGBA can be set to True to improve performance.
set_hatch(hatch)[source]
 
Set the hatch style (for fills).
set_hatch_color(hatch_color)[source]
 
Set the hatch color.
set_joinstyle(js)[source]
 
Set how to draw connections between line segments.  Parameters 
 
jsJoinStyle or {'miter', 'round', 'bevel'}
set_sketch_params(scale=None, length=None, randomness=None)[source]
 
Set the sketch parameters.  Parameters 
 
scalefloat, optional


The amplitude of the wiggle perpendicular to the source line, in pixels. If scale is None, or not provided, no sketch filter will be provided.  
lengthfloat, default: 128


The length of the wiggle along the line, in pixels.  
randomnessfloat, default: 16


The scale factor by which the length is shrunken or expanded.
set_snap(snap)[source]
 
Set the snap setting which may be:  True: snap vertices to the nearest pixel center False: leave vertices as-is None: (auto) If the path contains only rectilinear line segments, round to the nearest pixel center
matplotlib.backend_bases.key_press_handler(event, canvas=None, toolbar=None)[source]
 
Implement the default Matplotlib key bindings for the canvas and toolbar described at Navigation keyboard shortcuts.  Parameters 
 
eventKeyEvent


A key press/release event.  
canvasFigureCanvasBase, default: event.canvas


The backend-specific canvas instance. This parameter is kept for back-compatibility, but, if set, should always be equal to event.canvas.  
toolbarNavigationToolbar2, default: event.canvas.toolbar


The navigation cursor toolbar. This parameter is kept for back-compatibility, but, if set, should always be equal to event.canvas.toolbar.
classmatplotlib.backend_bases.KeyEvent(name, canvas, key, x=0, y=0, guiEvent=None)[source]
 
Bases: matplotlib.backend_bases.LocationEvent A key event (key press, key release). A KeyEvent has a number of special attributes in addition to those defined by the parent Event and LocationEvent classes. Notes Modifier keys will be prefixed to the pressed key and will be in the order "ctrl", "alt", "super". The exception to this rule is when the pressed key is itself a modifier key, therefore "ctrl+alt" and "alt+control" can both be valid key values. Examples def on_key(event):
    print('you pressed', event.key, event.xdata, event.ydata)

cid = fig.canvas.mpl_connect('key_press_event', on_key)
  Attributes 
 
keyNone or str


The key(s) pressed. Could be None, a single case sensitive Unicode character ("g", "G", "#", etc.), a special key ("control", "shift", "f1", "up", etc.) or a combination of the above (e.g., "ctrl+alt+g", "ctrl+alt+G").
classmatplotlib.backend_bases.LocationEvent(name, canvas, x, y, guiEvent=None)[source]
 
Bases: matplotlib.backend_bases.Event An event that has a screen location. A LocationEvent has a number of special attributes in addition to those defined by the parent Event class.  Attributes 
 
x, yint or None


Event location in pixels from bottom left of canvas.  
inaxesAxes or None


The Axes instance over which the mouse is, if any.  
xdata, ydatafloat or None


Data coordinates of the mouse within inaxes, or None if the mouse is not over an Axes.       lastevent=None
classmatplotlib.backend_bases.MouseButton(value)[source]
 
Bases: enum.IntEnum An enumeration.   BACK=8[source]

   FORWARD=9[source]

   LEFT=1[source]

   MIDDLE=2[source]

   RIGHT=3[source]
classmatplotlib.backend_bases.MouseEvent(name, canvas, x, y, button=None, key=None, step=0, dblclick=False, guiEvent=None)[source]
 
Bases: matplotlib.backend_bases.LocationEvent A mouse event ('button_press_event', 'button_release_event', 'scroll_event', 'motion_notify_event'). A MouseEvent has a number of special attributes in addition to those defined by the parent Event and LocationEvent classes. Examples def on_press(event):
    print('you pressed', event.button, event.xdata, event.ydata)

cid = fig.canvas.mpl_connect('button_press_event', on_press)
  Attributes 
 
buttonNone or MouseButton or {'up', 'down'}


The button pressed. 'up' and 'down' are used for scroll events. Note that LEFT and RIGHT actually refer to the "primary" and "secondary" buttons, i.e. if the user inverts their left and right buttons ("left-handed setting") then the LEFT button will be the one physically on the right.  
keyNone or str


The key pressed when the mouse event triggered, e.g. 'shift'. See KeyEvent.  Warning This key is currently obtained from the last 'key_press_event' or 'key_release_event' that occurred within the canvas. Thus, if the last change of keyboard state occurred while the canvas did not have focus, this attribute will be wrong.   
stepfloat


The number of scroll steps (positive for 'up', negative for 'down'). This applies only to 'scroll_event' and defaults to 0 otherwise.  
dblclickbool


Whether the event is a double-click. This applies only to 'button_press_event' and is False otherwise. In particular, it's not used in 'button_release_event'.
back(*args)[source]
 
Move back up the view lim stack. For convenience of being directly connected as a GUI callback, which often get passed additional parameters, this method accepts arbitrary parameters, but does not use them.
drag_pan(event)[source]
 
Callback for dragging in pan/zoom mode.
draw_rubberband(event, x0, y0, x1, y1)[source]
 
Draw a rectangle rubberband to indicate zoom limits. Note that it is not guaranteed that x0 <= x1 and y0 <= y1.
forward(*args)[source]
 
Move forward in the view lim stack. For convenience of being directly connected as a GUI callback, which often get passed additional parameters, this method accepts arbitrary parameters, but does not use them.
home(*args)[source]
 
Restore the original view. For convenience of being directly connected as a GUI callback, which often get passed additional parameters, this method accepts arbitrary parameters, but does not use them.
pan(*args)[source]
 
Toggle the pan/zoom tool. Pan with left button, zoom with right.
press_pan(event)[source]
 
Callback for mouse button press in pan/zoom mode.
press_zoom(event)[source]
 
Callback for mouse button press in zoom to rect mode.
release_pan(event)[source]
 
Callback for mouse button release in pan/zoom mode.
release_zoom(event)[source]
 
Callback for mouse button release in zoom to rect mode.
set_cursor(cursor)[source]
 
[Deprecated] Set the current cursor to one of the Cursors enums values. If required by the backend, this method should trigger an update in the backend event loop after the cursor is set, as this method may be called e.g. before a long-running task during which the GUI is not updated. Notes  Deprecated since version 3.5.
set_message(s)[source]
 
Display a message on toolbar or in status bar.
toolitems=(('Home', 'Reset original view', 'home', 'home'), ('Back', 'Back to previous view', 'back', 'back'), ('Forward', 'Forward to next view', 'forward', 'forward'), (None, None, None, None), ('Pan', 'Left button pans, Right button zooms\nx/y fixes axis, CTRL fixes aspect', 'move', 'pan'), ('Zoom', 'Zoom to rectangle\nx/y fixes axis', 'zoom_to_rect', 'zoom'), ('Subplots', 'Configure subplots', 'subplots', 'configure_subplots'), (None, None, None, None), ('Save', 'Save the figure', 'filesave', 'save_figure'))
exceptionmatplotlib.backend_bases.NonGuiException[source]
 
Bases: Exception Raised when trying show a figure in a non-GUI backend.
classmatplotlib.backend_bases.PickEvent(name, canvas, mouseevent, artist, guiEvent=None, **kwargs)[source]
 
Bases: matplotlib.backend_bases.Event A pick event. This event is fired when the user picks a location on the canvas sufficiently close to an artist that has been made pickable with Artist.set_picker. A PickEvent has a number of special attributes in addition to those defined by the parent Event class. Examples Bind a function on_pick() to pick events, that prints the coordinates of the picked data point: ax.plot(np.rand(100), 'o', picker=5)  # 5 points tolerance

def on_pick(event):
    line = event.artist
    xdata, ydata = line.get_data()
    ind = event.ind
    print('on pick line:', np.array([xdata[ind], ydata[ind]]).T)

cid = fig.canvas.mpl_connect('pick_event', on_pick)
  Attributes 
 
mouseeventMouseEvent


The mouse event that generated the pick.  
artistmatplotlib.artist.Artist


The picked artist. Note that artists are not pickable by default (see Artist.set_picker).  other

Additional attributes may be present depending on the type of the picked object; e.g., a Line2D pick may define different extra attributes than a PatchCollection pick.
matplotlib.backend_bases.register_backend(format, backend, description=None)[source]
 
Register a backend for saving to a given file format.  Parameters 
 
formatstr


File extension  
backendmodule string or canvas class


Backend for handling file output  
descriptionstr, default: ""


Description of the file type.
close_group(s)[source]
 
Close a grouping element with label s. Only used by the SVG renderer.
draw_gouraud_triangle(gc, points, colors, transform)[source]
 
Draw a Gouraud-shaded triangle.  Parameters 
 
gcGraphicsContextBase


The graphics context.  
points(3, 2) array-like


Array of (x, y) points for the triangle.  
colors(3, 4) array-like


RGBA colors for each point of the triangle.  
transformmatplotlib.transforms.Transform


An affine transform to apply to the points.
draw_gouraud_triangles(gc, triangles_array, colors_array, transform)[source]
 
Draw a series of Gouraud triangles.  Parameters 
 
points(N, 3, 2) array-like


Array of N (x, y) points for the triangles.  
colors(N, 3, 4) array-like


Array of N RGBA colors for each point of the triangles.  
transformmatplotlib.transforms.Transform


An affine transform to apply to the points.
draw_image(gc, x, y, im, transform=None)[source]
 
Draw an RGBA image.  Parameters 
 
gcGraphicsContextBase


A graphics context with clipping information.  
xscalar


The distance in physical units (i.e., dots or pixels) from the left hand side of the canvas.  
yscalar


The distance in physical units (i.e., dots or pixels) from the bottom side of the canvas.  
im(N, M, 4) array-like of np.uint8


An array of RGBA pixels.  
transformmatplotlib.transforms.Affine2DBase


If and only if the concrete backend is written such that option_scale_image() returns True, an affine transformation (i.e., an Affine2DBase) may be passed to draw_image(). The translation vector of the transformation is given in physical units (i.e., dots or pixels). Note that the transformation does not override x and y, and has to be applied before translating the result by x and y (this can be accomplished by adding x and y to the translation vector defined by transform).
draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)[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, path, transform, rgbFace=None)[source]
 
Draw a Path instance using the given affine transform.
draw_path_collection(gc, master_transform, paths, all_transforms, offsets, offsetTrans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)[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.
draw_quad_mesh(gc, master_transform, meshWidth, meshHeight, coordinates, offsets, offsetTrans, facecolors, antialiased, edgecolors)[source]
 
Fallback implementation of draw_quad_mesh() that generates paths and then calls draw_path_collection().
draw_tex(gc, x, y, s, prop, angle, *, mtext=None)[source]