matplotlib.backends.backend_pgf#

matplotlib.backends.backend_pgf.FigureCanvas[source]#

alias ofFigureCanvasPgf

classmatplotlib.backends.backend_pgf.FigureCanvasPgf(figure=None)[source]#

Bases:FigureCanvasBase

draw()[source]#

Render theFigure.

This method must walk the artist tree, even if no output is produced,because it triggers deferred work that users may want to accessbefore saving output to disk. For example computing limits,auto-limits, and tick values.

filetypes={'pdf':'LaTeXcompiledPGFpicture','pgf':'LaTeXPGFpicture','png':'PortableNetworkGraphics'}#

get_default_filetype()[source]#

Return the default savefig file format as specified inrcParams["savefig.format"] (default:'png').

The returned string does not include a period. This method isoverridden in backends that only support a single file type.

get_renderer()[source]#

print_pdf(fname_or_fh,*,metadata=None,**kwargs)[source]#

Use LaTeX to compile a pgf generated figure to pdf.

print_pgf(fname_or_fh,**kwargs)[source]#

Output pgf macros for drawing the figure so it can be included andrendered in latex documents.

print_png(fname_or_fh,**kwargs)[source]#

Use LaTeX to compile a pgf figure to pdf and convert it to png.

exceptionmatplotlib.backends.backend_pgf.LatexError(message,latex_output='')[source]#

Bases:Exception

classmatplotlib.backends.backend_pgf.LatexManager[source]#

Bases:object

The LatexManager opens an instance of the LaTeX application fordetermining the metrics of text elements. The LaTeX environment can bemodified by setting fonts and/or a custom preamble inrcParams.

get_width_height_descent(text,prop)[source]#

Get the width, total height, and descent (in TeX points) for a texttypeset by the current LaTeX environment.

classmatplotlib.backends.backend_pgf.PdfPages(filename,*,metadata=None)[source]#

Bases:object

A multi-page PDF file using the pgf backend

Examples

>>>importmatplotlib.pyplotasplt>>># Initialize:>>>withPdfPages('foo.pdf')aspdf:...# As many times as you like, create a figure fig and save it:...fig=plt.figure()...pdf.savefig(fig)...# When no figure is specified the current figure is saved...pdf.savefig()

Create a new PdfPages object.

Parameters:

filenamestr or path-like

Plots usingPdfPages.savefig will be written to a file at thislocation. Any older file with the same name is overwritten.

metadatadict, optional

Information dictionary object (see PDF reference section 10.2.1'Document Information Dictionary'), e.g.:{'Creator':'Mysoftware','Author':'Me','Title':'Awesome'}.

The standard keys are 'Title', 'Author', 'Subject', 'Keywords','Creator', 'Producer', 'CreationDate', 'ModDate', and'Trapped'. Values have been predefined for 'Creator', 'Producer'and 'CreationDate'. They can be removed by setting them toNone.

Note that some versions of LaTeX engines may ignore the 'Producer'key and set it to themselves.

close()[source]#

Finalize this object, running LaTeX in a temporary directoryand moving the final pdf file tofilename.

get_pagecount()[source]#

Return the current number of pages in the multipage pdf file.

savefig(figure=None,**kwargs)[source]#

Save aFigure to this file as a new page.

Any other keyword arguments are passed tosavefig.

Parameters:

figureFigure or int, default: the active figure

The figure, or index of the figure, that is saved to the file.

classmatplotlib.backends.backend_pgf.RendererPgf(figure,fh)[source]#

Bases:RendererBase

Create a new PGF renderer that translates any drawing instructioninto text commands to be interpreted in a latex pgfpicture environment.

Attributes:

figureFigure

Matplotlib figure to initialize height, width and dpi from.

fhfile-like

File handle for the output of the drawing commands.

draw_image(gc,x,y,im,transform=None)[source]#

Draw an RGBA image.

Parameters:

gcGraphicsContextBase

A graphics context with clipping information.

xfloat

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

yfloat

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

im(N, M, 4) array ofnumpy.uint8

An array of RGBA pixels.

transformAffine2DBase

If and only if the concrete backend is written such thatoption_scale_image returnsTrue, an affinetransformation (i.e., anAffine2DBase)may be passed todraw_image. The translation vector of thetransformation is given in physical units (i.e., dots or pixels).Note that the transformation does not overridex andy,and has to be appliedbefore translatingthe result byx andy (this can be accomplished by addingxandy to the translation vector defined bytransform).

draw_markers(gc,marker_path,marker_trans,path,trans,rgbFace=None)[source]#

Draw a marker at each ofpath's vertices (excluding control points).

The base (fallback) implementation makes multiple calls todraw_path.Backends may want to override this method in order to draw the markeronly once and reuse it multiple times.

Parameters:

gcGraphicsContextBase

The graphics context.

marker_pathPath

The path for the marker.

marker_transTransform

An affine transform applied to the marker.

pathPath

The locations to draw the markers.

transTransform

An affine transform applied to the path.

rgbFacecolor, optional

draw_path(gc,path,transform,rgbFace=None)[source]#

Draw aPath instance using the given affine transform.

draw_tex(gc,x,y,s,prop,angle,*,mtext=None)[source]#

Draw a TeX instance.

Parameters:

gcGraphicsContextBase

The graphics context.

xfloat

The x location of the text in display coords.

yfloat

The y location of the text baseline in display coords.

sstr

The TeX text string.

propFontProperties

The font properties.

anglefloat

The rotation angle in degrees anti-clockwise.

mtextText

The original text object to be rendered.

draw_text(gc,x,y,s,prop,angle,ismath=False,mtext=None)[source]#

Draw a text instance.

Parameters:

gcGraphicsContextBase

The graphics context.

xfloat

The x location of the text in display coords.

yfloat

The y location of the text baseline in display coords.

sstr

The text string.

propFontProperties

The font properties.

anglefloat

The rotation angle in degrees anti-clockwise.

ismathbool or "TeX"

If True, use mathtext parser.

mtextText

The original text object to be rendered.

Notes

Notes for backend implementers:

RendererBase.draw_text also supports passing "TeX" to theismathparameter to use TeX rendering, but this is not required for actualrendering backends, and indeed many builtin backends do not supportthis. Rather, TeX rendering is provided bydraw_tex.

flipy()[source]#

Return whether y values increase from top to bottom.

Note that this only affects drawing of texts.

get_canvas_width_height()[source]#

Return the canvas width and height in display coords.

get_text_width_height_descent(s,prop,ismath)[source]#

Get the width, height, and descent (offset from the bottom to the baseline), indisplay coords, of the strings withFontPropertiesprop.

Whitespace at the start and the end ofs is included in the reported width.

option_image_nocomposite()[source]#

Return whether image composition by Matplotlib should be skipped.

Raster backends should usually return False (letting the C-levelrasterizer take care of image composition); vector backends shouldusually returnnotrcParams["image.composite_image"].

option_scale_image()[source]#

Return whether arbitrary affine transformations indraw_image are supported (True for most vector backends).

points_to_pixels(points)[source]#

Convert points to display units.

You need to override this function (unless your backenddoesn't have a dpi, e.g., postscript or svg). Some imagingsystems assume some value for pixels per inch:

pointstopixels=points*pixels_per_inch/72*dpi/72

Parameters:

pointsfloat or array-like

Returns:

Points converted to pixels

matplotlib.backends.backend_pgf.make_pdf_to_png_converter()[source]#

Return a function that converts a pdf file to a png file.