matplotlib.backends.backend_ps

A PostScript backend, which can produce both PostScript .ps and .eps.

matplotlib.backends.backend_ps.FigureCanvas

alias of FigureCanvasPS

class matplotlib.backends.backend_ps.FigureCanvasPS(figure=None)

Bases: FigureCanvasBase

draw()

Render the Figure.

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

filetypes = {'eps': 'Encapsulated Postscript', 'ps': 'Postscript'}

fixed_dpi = 72

get_default_filetype()

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

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

print_eps(outfile, *args, metadata=None, papertype=None, orientation='portrait', **kwargs)

print_ps(outfile, *args, metadata=None, papertype=None, orientation='portrait', **kwargs)

class matplotlib.backends.backend_ps.PsBackendHelper

Bases: object

class matplotlib.backends.backend_ps.RendererPS(width, height, pswriter, imagedpi=72)

Bases: RendererPDFPSBase

The renderer handles all the drawing primitives using a graphics context instance that controls the colors/styles.

create_hatch(hatch)

draw_gouraud_triangle(gc, points, colors, trans)

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, points, colors, trans)

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)

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)

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

The base (fallback) implementation makes multiple calls to draw_path. 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_mathtext(gc, x, y, s, prop, angle)

Draw the math text using matplotlib.mathtext.

draw_path(gc, path, transform, rgbFace=None)

Draw a Path instance using the given affine transform.

draw_path_collection(gc, master_transform, paths, all_transforms, offsets, offset_trans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)

Draw a collection of paths.

Each path is first transformed by the corresponding entry in all_transforms (a list of (3, 3) matrices) and then by master_transform. They are then translated by the corresponding entry in offsets, which has been first transformed by offset_trans.

facecolors, edgecolors, linewidths, linestyles, and antialiased are lists that set the corresponding properties.

offset_position is unused now, but the argument is kept for backwards compatibility.

The base (fallback) implementation makes multiple calls to draw_path. 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_tex(gc, x, y, s, prop, angle, *, mtext=None)

draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)

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.

propmatplotlib.font_manager.FontProperties

The font properties.

anglefloat

The rotation angle in degrees anti-clockwise.

mtextmatplotlib.text.Text

The original text object to be rendered.

Notes

Note for backend implementers:

When you are trying to determine if you have gotten your bounding box right (which is what enables the text layout/alignment to work properly), it helps to change the line in text.py:

if 0: bbox_artist(self, renderer)

to if 1, and then the actual bounding box will be plotted along with your text.

get_image_magnification()

Get the factor by which to magnify images passed to draw_image. Allows a backend to have images at a different resolution to other artists.

set_color(r, g, b, store=True)

set_font(fontname, fontsize, store=True)

set_linecap(linecap, store=True)

set_linedash(offset, seq, store=True)

set_linejoin(linejoin, store=True)

set_linewidth(linewidth, store=True)

matplotlib.backends.backend_ps.convert_psfrags(tmpfile, psfrags, font_preamble, custom_preamble, paper_width, paper_height, orientation)

[Deprecated]

Notes

Deprecated since version 3.6:

matplotlib.backends.backend_ps.get_bbox_header(lbrt, rotated=False)

Return a postscript header string for the given bbox lbrt=(l, b, r, t). Optionally, return rotate command.

matplotlib.backends.backend_ps.gs_distill(tmpfile, eps=False, ptype='letter', bbox=None, rotated=False)

Use ghostscript's pswrite or epswrite device to distill a file. This yields smaller files without illegal encapsulated postscript operators. The output is low-level, converting text to outlines.

matplotlib.backends.backend_ps.pstoeps(tmpfile, bbox=None, rotated=False)

Convert the postscript to encapsulated postscript. The bbox of the eps file will be replaced with the given bbox argument. If None, original bbox will be used.

matplotlib.backends.backend_ps.quote_ps_string(s)

[Deprecated] Quote dangerous characters of S for use in a PostScript string constant.

Notes

Deprecated since version 3.6: Use a vendored copy of this function instead.

matplotlib.backends.backend_ps.xpdf_distill(tmpfile, eps=False, ptype='letter', bbox=None, rotated=False)

Use ghostscript's ps2pdf and xpdf's/poppler's pdftops to distill a file. This yields smaller files without illegal encapsulated postscript operators. This distiller is preferred, generating high-level postscript output that treats text as text.