gemseo_pymoo / post / core

plot_features module

Features for scatter plots.

class gemseo_pymoo.post.core.plot_features.Annotation3D(text, xyzs, *args, **kwargs)

Bases: matplotlib.text.Annotation

Annotation for 3D plots.

Instantiate a 3D annotation.

Parameters

• text (str) – The annotation text.

• xyzs (numpy.ndarray) – 2D array containing the starting and ending positions of the vector to be annotated.

• *args (Any) – The arguments for the Annotation.

• **kwargs (Any) – The keyword arguments for the Annotation.

Return type

None

add_callback(func)

Add a callback function that will be called whenever one of the .Artist’s properties changes.

Parameters

func (callable) –

The callback function. It must have the signature:

def func(artist: Artist) -> Any

where artist is the calling .Artist. Return values may exist but are ignored.

Returns

The observer id associated with the callback. This id can be used for removing the callback with .remove_callback later.

Return type

int

See also

remove_callback

contains(event)

Return whether the mouse event occurred inside the axis-aligned bounding-box of the text.

convert_xunits(x)

Convert x using the unit type of the xaxis.

If the artist is not in contained in an Axes or if the xaxis does not have units, x itself is returned.

convert_yunits(y)

Convert y using the unit type of the yaxis.

If the artist is not in contained in an Axes or if the yaxis does not have units, y itself is returned.

draggable(state=None, use_blit=False)

Set whether the annotation is draggable with the mouse.

Parameters

state (bool or None) –

• True or False: set the draggability.

• None: toggle the draggability.

By default it is set to None.

Returns

If the annotation is draggable, the corresponding .DraggableAnnotation helper is returned.

Return type

DraggableAnnotation or None

draw(renderer)

Update the plot to ensure the right projection of the text.

Parameters

renderer (matplotlib.backend_bases.RendererBase) – The object currently handling the drawing operations.

Return type

None

findobj(match=None, include_self=True)

Find artist objects.

Recursively find all .Artist instances contained in the artist.

Parameters

• match –

  A filter criterion for the matches. This can be

  • None: Return all objects contained in artist.

  • A function with signature def match(artist: Artist) -> bool. The result will only contain artists for which the function returns True.

  • A class instance: e.g., .Line2D. The result will only contain artists of this class or its subclasses (isinstance check).

  By default it is set to None.

• include_self (bool) –

  Include self in the list to be checked for a match.

  By default it is set to True.

Return type

list of .Artist

format_cursor_data(data)

Return a string representation of data.

Note

This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.

The default implementation converts ints and floats and arrays of ints and floats into a comma-separated string enclosed in square brackets, unless the artist has an associated colorbar, in which case scalar values are formatted using the colorbar’s formatter.

See also

get_cursor_data

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_animated()

Return whether the artist is animated.

get_anncoords()

Return the coordinate system to use for .Annotation.xyann.

See also xycoords in .Annotation.

get_annotation_clip()

Return the annotation’s clipping behavior.

See set_annotation_clip for the meaning of return values.

get_bbox_patch()

Return the bbox Patch, or None if the .patches.FancyBboxPatch is not made.

get_c()

Alias for get_color.

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_color()

Return the color of the text.

get_cursor_data(event)

Return the cursor data for a given event.

Note

This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.

Cursor data can be used by Artists to provide additional context information for a given event. The default implementation just returns None.

Subclasses can override the method and return arbitrary data. However, when doing so, they must ensure that .format_cursor_data can convert the data to a string representation.

The only current use case is displaying the z-value of an .AxesImage in the status bar of a plot window, while moving the mouse.

Parameters

event (matplotlib.backend_bases.MouseEvent) –

See also

format_cursor_data

get_family()

Alias for get_fontfamily.

get_figure()

Return the .Figure instance the artist belongs to.

get_font()

Alias for get_fontproperties.

get_font_properties()

Alias for get_fontproperties.

get_fontfamily()

Return the list of font families used for font lookup.

See also

font_manager.FontProperties.get_family

get_fontname()

Return the font name as a string.

See also

font_manager.FontProperties.get_name

get_fontproperties()

Return the .font_manager.FontProperties.

get_fontsize()

Return the font size as an integer.

See also

font_manager.FontProperties.get_size_in_points

get_fontstyle()

Return the font style as a string.

See also

font_manager.FontProperties.get_style

get_fontvariant()

Return the font variant as a string.

See also

font_manager.FontProperties.get_variant

get_fontweight()

Return the font weight as a string or a number.

See also

font_manager.FontProperties.get_weight

get_gid()

Return the group id.

get_ha()

Alias for get_horizontalalignment.

get_horizontalalignment()

Return the horizontal alignment as a string. Will be one of ‘left’, ‘center’ or ‘right’.

get_in_layout()

Return boolean flag, True if artist is included in layout calculations.

E.g. /tutorials/intermediate/constrainedlayout_guide, .Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').

get_label()

Return the label used for this artist in the legend.

get_math_fontfamily()

Return the font family name for math text rendered by Matplotlib.

The default value is :rc:`mathtext.fontset`.

See also

set_math_fontfamily

get_name()

Alias for get_fontname.

get_parse_math()

Return whether mathtext parsing is considered for this Text.

get_path_effects()

get_picker()

Return the picking behavior of the artist.

The possible values are described in .set_picker.

See also

set_picker, pickable, pick

get_position()

Return the (x, y) position of the text.

get_prop_tup(renderer=None)

[Deprecated] Return a hashable tuple of properties.

Not intended to be human readable, but useful for backends who want to cache derived information about text (e.g., layouts) and need to know if the text has changed.

Notes

Deprecated since version 3.5.

get_rasterized()

Return whether the artist is to be rasterized.

get_rotation()

Return the text angle in degrees between 0 and 360.

get_rotation_mode()

Return the text rotation mode.

get_size()

Alias for get_fontsize.

get_sketch_params()

Return the sketch parameters for the artist.

Returns

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.

Returns None if no sketch parameters were set.

Return type

tuple or None

get_snap()

Return the snap setting.

See .set_snap for details.

get_stretch()

Return the font stretch as a string or a number.

See also

font_manager.FontProperties.get_stretch

get_style()

Alias for get_fontstyle.

get_text()

Return the text string.

get_tightbbox(renderer)

Like .Artist.get_window_extent, but includes any clipping.

Parameters

renderer (.RendererBase subclass) – renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer())

Returns

The enclosing bounding box (in figure pixel coordinates).

Return type

.Bbox

get_transform()

Return the .Transform instance used by this artist.

get_transform_rotates_text()

Return whether rotations of the transform affect the text direction.

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_unitless_position()

Return the (x, y) unitless position of the text.

get_url()

Return the url.

get_usetex()

Return whether this Text object uses TeX for rendering.

get_va()

Alias for get_verticalalignment.

get_variant()

Alias for get_fontvariant.

get_verticalalignment()

Return the vertical alignment as a string. Will be one of ‘top’, ‘center’, ‘bottom’, ‘baseline’ or ‘center_baseline’.

get_visible()

Return the visibility.

get_weight()

Alias for get_fontweight.

get_window_extent(renderer=None)

Return the .Bbox bounding the text, in display units.

In addition to being used internally, this is useful for specifying clickable regions in a png file on a web page.

Parameters

• renderer (Renderer, optional) –

  A renderer is needed to compute the bounding box. If the artist has already been drawn, the renderer is cached; thus, it is only necessary to pass this argument when calling get_window_extent before the first draw. In practice, it is usually easier to trigger a draw first (e.g. by saving the figure).

  By default it is set to None.

• dpi (float, optional) – The dpi value for computing the bbox, defaults to self.figure.dpi (not the renderer dpi); should be set e.g. if to match regions with a figure saved with a custom dpi value.

get_wrap()

Return whether the text can be wrapped.

get_zorder()

Return the artist’s zorder.

have_units()

Return whether units are set on any axis.

is_transform_set()

Return whether the Artist has an explicitly set transform.

This is True after .set_transform has been called.

pchanged()

Call all of the registered callbacks.

This function is triggered internally when a property is changed.

See also

add_callback, remove_callback

pick(mouseevent)

Process a pick event.

Each child artist will fire a pick event if mouseevent is over the artist and the artist has picker set.

See also

set_picker, get_picker, pickable

pickable()

Return whether the artist is pickable.

See also

set_picker, get_picker, pick

properties()

Return a dictionary of all the properties of the artist.

remove()

Remove the artist from the figure if possible.

The effect will not be visible until the figure is redrawn, e.g., with .FigureCanvasBase.draw_idle. Call ~.axes.Axes.relim to update the axes limits if desired.

Note: ~.axes.Axes.relim will not see collections even if the collection was added to the axes with autolim = True.

Note: there is no support for removing the artist’s legend entry.

remove_callback(oid)

Remove a callback based on its observer id.

See also

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, anncoords=<UNSET>, annotation_clip=<UNSET>, backgroundcolor=<UNSET>, bbox=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, fontfamily=<UNSET>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linespacing=<UNSET>, math_fontfamily=<UNSET>, multialignment=<UNSET>, parse_math=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, rasterized=<UNSET>, rotation=<UNSET>, rotation_mode=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, transform_rotates_text=<UNSET>, url=<UNSET>, usetex=<UNSET>, verticalalignment=<UNSET>, visible=<UNSET>, wrap=<UNSET>, x=<UNSET>, y=<UNSET>, zorder=<UNSET>)

Set multiple properties at once.

Supported properties are

Properties:

agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alpha: scalar or None animated: bool anncoords: unknown annotation_clip: bool or None backgroundcolor: color bbox: dict with properties for .patches.FancyBboxPatch clip_box: .Bbox clip_on: bool clip_path: Patch or (Path, Transform) or None color or c: color figure: .Figure fontfamily or family: {FONTNAME, ‘serif’, ‘sans-serif’, ‘cursive’, ‘fantasy’, ‘monospace’} fontproperties or font or font_properties: .font_manager.FontProperties or str or pathlib.Path fontsize or size: float or {‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’} fontstretch or stretch: {a numeric value in range 0-1000, ‘ultra-condensed’, ‘extra-condensed’, ‘condensed’, ‘semi-condensed’, ‘normal’, ‘semi-expanded’, ‘expanded’, ‘extra-expanded’, ‘ultra-expanded’} fontstyle or style: {‘normal’, ‘italic’, ‘oblique’} fontvariant or variant: {‘normal’, ‘small-caps’} fontweight or weight: {a numeric value in range 0-1000, ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’} gid: str horizontalalignment or ha: {‘center’, ‘right’, ‘left’} in_layout: bool label: object linespacing: float (multiple of font size) math_fontfamily: str multialignment or ma: {‘left’, ‘right’, ‘center’} parse_math: bool path_effects: .AbstractPathEffect picker: None or bool or float or callable position: (float, float) rasterized: bool rotation: float or {‘vertical’, ‘horizontal’} rotation_mode: {None, ‘default’, ‘anchor’} sketch_params: (scale: float, length: float, randomness: float) snap: bool or None text: object transform: .Transform transform_rotates_text: bool url: str usetex: bool or None verticalalignment or va: {‘center’, ‘top’, ‘bottom’, ‘baseline’, ‘center_baseline’} visible: bool wrap: bool x: float y: float zorder: float

set_agg_filter(filter_func)

Set the agg filter.

Parameters

filter_func (callable) –

A filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array.

set_alpha(alpha)

Set the alpha value used for blending - not supported on all backends.

Parameters

alpha (scalar or None) – alpha must be within the 0-1 range, inclusive.

set_animated(b)

Set whether the artist is intended to be used in an animation.

If True, the artist is excluded from regular drawing of the figure. You have to call .Figure.draw_artist / .Axes.draw_artist explicitly on the artist. This appoach is used to speed up animations using blitting.

See also matplotlib.animation and /tutorials/advanced/blitting.

Parameters

b (bool) –

set_anncoords(coords)

Set the coordinate system to use for .Annotation.xyann.

See also xycoords in .Annotation.

set_annotation_clip(b)

Set the annotation’s clipping behavior.

Parameters

b (bool or None) –

• True: the annotation will only be drawn when self.xy is inside the axes.

• False: the annotation will always be drawn regardless of its position.

• None: the self.xy will be checked only if xycoords is “data”.

set_backgroundcolor(color)

Set the background color of the text by updating the bbox.

Parameters

color (color) –

See also

set_bbox

To change the position of the bounding box

set_bbox(rectprops)

Draw a bounding box around self.

Parameters

rectprops (dict with properties for .patches.FancyBboxPatch) – The default boxstyle is ‘square’. The mutation scale of the .patches.FancyBboxPatch is set to the fontsize.

Examples

t.set_bbox(dict(facecolor='red', alpha=0.5))

set_c(color)

Alias for set_color.

set_clip_box(clipbox)

Set the artist’s clip .Bbox.

Parameters

clipbox (.Bbox) –

set_clip_on(b)

Set whether the artist uses clipping.

When False artists will be visible outside of the axes which can lead to unexpected results.

Parameters

b (bool) –

set_clip_path(path, transform=None)

Set the artist’s clip path.

Parameters

• path (.Patch or .Path or .TransformedPath or None) – The clip path. If given a .Path, transform must be provided as well. If None, a previously set clip path is removed.

• transform (~matplotlib.transforms.Transform, optional) –

  Only used if path is a .Path, in which case the given .Path is converted to a .TransformedPath using transform.

  By default it is set to None.

Notes

For efficiency, if path is a .Rectangle this method will set the clipping box to the corresponding rectangle and set the clipping path to None.

For technical reasons (support of ~.Artist.set), a tuple (path, transform) is also accepted as a single positional parameter.

set_color(color)

Set the foreground color of the text

Parameters

color (color) –

set_family(fontname)

Alias for set_fontfamily.

set_figure(fig)

Set the .Figure instance the artist belongs to.

Parameters

fig (.Figure) –

set_font(fp)

Alias for set_fontproperties.

set_font_properties(fp)

Alias for set_fontproperties.

set_fontfamily(fontname)

Set the font family. May be either a single string, or a list of strings in decreasing priority. Each string may be either a real font name or a generic font class name. If the latter, the specific font names will be looked up in the corresponding rcParams.

If a Text instance is constructed with fontfamily=None, then the font is set to :rc:`font.family`, and the same is done when set_fontfamily() is called on an existing Text instance.

Parameters

fontname ({FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}) –

See also

font_manager.FontProperties.set_family

set_fontname(fontname)

Alias for set_family.

One-way alias only: the getter differs.

Parameters

fontname ({FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}) –

See also

font_manager.FontProperties.set_family

set_fontproperties(fp)

Set the font properties that control the text.

Parameters

fp (.font_manager.FontProperties or str or pathlib.Path) – If a str, it is interpreted as a fontconfig pattern parsed by .FontProperties. If a pathlib.Path, it is interpreted as the absolute path to a font file.

set_fontsize(fontsize)

Set the font size.

Parameters

fontsize (float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}) – If float, the fontsize in points. The string values denote sizes relative to the default font size.

See also

font_manager.FontProperties.set_size

set_fontstretch(stretch)

Set the font stretch (horizontal condensation or expansion).

Parameters

stretch ({a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}) –

See also

font_manager.FontProperties.set_stretch

set_fontstyle(fontstyle)

Set the font style.

Parameters

fontstyle ({'normal', 'italic', 'oblique'}) –

See also

font_manager.FontProperties.set_style

set_fontvariant(variant)

Set the font variant.

Parameters

variant ({'normal', 'small-caps'}) –

See also

font_manager.FontProperties.set_variant

set_fontweight(weight)

Set the font weight.

Parameters

weight ({a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}) –

See also

font_manager.FontProperties.set_weight

set_gid(gid)

Set the (group) id for the artist.

Parameters

gid (str) –

set_ha(align)

Alias for set_horizontalalignment.

set_horizontalalignment(align)

Set the horizontal alignment to one of

Parameters

align ({'center', 'right', 'left'}) –

set_in_layout(in_layout)

Set if artist is to be included in layout calculations, E.g. /tutorials/intermediate/constrainedlayout_guide, .Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').

Parameters

in_layout (bool) –

set_label(s)

Set a label that will be displayed in the legend.

Parameters

s (object) – s will be converted to a string by calling str.

set_linespacing(spacing)

Set the line spacing as a multiple of the font size.

The default line spacing is 1.2.

Parameters

spacing (float (multiple of font size)) –

set_ma(align)

Alias for set_multialignment.

set_math_fontfamily(fontfamily)

Set the font family for math text rendered by Matplotlib.

This does only affect Matplotlib’s own math renderer. It has no effect when rendering with TeX (usetex=True).

Parameters

fontfamily (str) –

The name of the font family.

Available font families are defined in the matplotlibrc.template file.

See also

get_math_fontfamily

set_multialignment(align)

Set the text alignment for multiline texts.

The layout of the bounding box of all the lines is determined by the horizontalalignment and verticalalignment properties. This property controls the alignment of the text lines within that box.

Parameters

align ({'left', 'right', 'center'}) –

set_name(fontname)

Alias for set_fontname.

set_parse_math(parse_math)

Override switch to disable any mathtext parsing for this Text.

Parameters

parse_math (bool) – If False, this Text will never use mathtext. If True, mathtext will be used if there is an even number of unescaped dollar signs.

set_path_effects(path_effects)

Set the path effects.

Parameters

path_effects (.AbstractPathEffect) –

set_picker(picker)

Define the picking behavior of the artist.

Parameters

picker (None or bool or float or callable) –

This can be one of the following:

• None: Picking is disabled for this artist (default).

• A boolean: If True then picking will be enabled and the artist will fire a pick event if the mouse event is over the artist.

• A float: If picker is a number it is interpreted as an epsilon tolerance in points and the artist will fire off an event if its data is within epsilon of the mouse event. For some artists like lines and patch collections, the artist may provide additional data to the pick event that is generated, e.g., the indices of the data within epsilon of the pick event

• A function: If picker is callable, it is a user supplied function which determines whether the artist is hit by the mouse event:

  hit, props = picker(artist, mouseevent)
  

  to determine the hit test. if the mouse event is over the artist, return hit=True and props is a dictionary of properties you want added to the PickEvent attributes.

set_position(xy)

Set the (x, y) position of the text.

Parameters

xy ((float, float)) –

set_rasterized(rasterized)

Force rasterized (bitmap) drawing for vector graphics output.

Rasterized drawing is not supported by all artists. If you try to enable this on an artist that does not support it, the command has no effect and a warning will be issued.

This setting is ignored for pixel-based output.

See also /gallery/misc/rasterization_demo.

Parameters

rasterized (bool) –

set_rotation(s)

Set the rotation of the text.

Parameters

s (float or {'vertical', 'horizontal'}) – The rotation angle in degrees in mathematically positive direction (counterclockwise). ‘horizontal’ equals 0, ‘vertical’ equals 90.

set_rotation_mode(m)

Set text rotation mode.

Parameters

m ({None, 'default', 'anchor'}) – If None or "default", the text will be first rotated, then aligned according to their horizontal and vertical alignments. If "anchor", then alignment occurs before rotation.

set_size(fontsize)

Alias for set_fontsize.

set_sketch_params(scale=None, length=None, randomness=None)

Set the sketch parameters.

Parameters

• scale (float, 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.

  By default it is set to None.

• length (float, optional) –

  The length of the wiggle along the line, in pixels (default 128.0)

  By default it is set to None.

• randomness (float, optional) –

  The scale factor by which the length is shrunken or expanded (default 16.0)

  The PGF backend uses this argument as an RNG seed and not as described above. Using the same seed yields the same random shape.

  By default it is set to None.

set_snap(snap)

Set the snapping behavior.

Snapping aligns positions with the pixel grid, which results in clearer images. For example, if a black line of 1px width was defined at a position in between two pixels, the resulting image would contain the interpolated value of that line in the pixel grid, which would be a grey value on both adjacent pixel positions. In contrast, snapping will move the line to the nearest integer pixel value, so that the resulting image will really contain a 1px wide black line.

Snapping is currently only supported by the Agg and MacOSX backends.

Parameters

snap (bool or None) –

Possible values:

• True: Snap vertices to the nearest pixel center.

• False: Do not modify vertex positions.

• None: (auto) If the path contains only rectilinear line segments, round to the nearest pixel center.

set_stretch(stretch)

Alias for set_fontstretch.

set_style(fontstyle)

Alias for set_fontstyle.

set_text(s)

Set the text string s.

It may contain newlines (\n) or math in LaTeX syntax.

Parameters

s (object) – Any object gets converted to its str representation, except for None which is converted to an empty string.

set_transform(t)

Set the artist transform.

Parameters

t (.Transform) –

set_transform_rotates_text(t)

Whether rotations of the transform affect the text direction.

Parameters

t (bool) –

set_url(url)

Set the url for the artist.

Parameters

url (str) –

set_usetex(usetex)

Parameters

usetex (bool or None) – Whether to render using TeX, None means to use :rc:`text.usetex`.

set_va(align)

Alias for set_verticalalignment.

set_variant(variant)

Alias for set_fontvariant.

set_verticalalignment(align)

Set the vertical alignment.

Parameters

align ({'center', 'top', 'bottom', 'baseline', 'center_baseline'}) –

set_visible(b)

Set the artist’s visibility.

Parameters

b (bool) –

set_weight(weight)

Alias for set_fontweight.

set_wrap(wrap)

Set whether the text can be wrapped.

Parameters

wrap (bool) –

Notes

Wrapping does not work together with savefig(..., bbox_inches='tight') (which is also used internally by %matplotlib inline in IPython/Jupyter). The ‘tight’ setting rescales the canvas to accommodate all content and happens before wrapping.

set_x(x)

Set the x position of the text.

Parameters

x (float) –

set_y(y)

Set the y position of the text.

Parameters

y (float) –

set_zorder(level)

Set the zorder for the artist. Artists with lower zorder values are drawn first.

Parameters

level (float) –

update(kwargs)

Update this artist’s properties from the dict props.

Parameters

props (dict) –

update_bbox_position_size(renderer)

Update the location and the size of the bbox.

This method should be used when the position and size of the bbox needs to be updated before actually drawing the bbox.

update_from(other)

Copy properties from other to self.

update_positions(renderer)

Update the pixel positions of the annotation text and the arrow patch.

property anncoords

The coordinate system to use for .Annotation.xyann.

property axes

The ~.axes.Axes instance the artist resides in, or None.

property mouseover

If this property is set to True, the artist will be queried for custom context information when the mouse cursor moves over it.

See also get_cursor_data(), ToolCursorPosition and NavigationToolbar2.

property stale

Whether the artist is ‘stale’ and needs to be re-drawn for the output to match the internal state of the artist.

property sticky_edges

x and y sticky edge lists for autoscaling.

When performing autoscaling, if a data limit coincides with a value in the corresponding sticky_edges list, then no margin will be added–the view limit “sticks” to the edge. A typical use case is histograms, where one usually expects no margin on the bottom edge (0) of the histogram.

Moreover, margin expansion “bumps” against sticky edges and cannot cross them. For example, if the upper data limit is 1.0, the upper view limit computed by simple margin application is 1.2, but there is a sticky edge at 1.1, then the actual upper view limit will be 1.1.

This attribute cannot be assigned to; however, the x and y lists can be modified in place as needed.

Examples

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

property xyann

The text position.

See also xytext in .Annotation.

property xycoords

zorder = 3

class gemseo_pymoo.post.core.plot_features.Arrow3D(xyzs, *args, **kwargs)

Bases: matplotlib.patches.FancyArrowPatch

Arrow patch for 3D plots.

Instantiate a 3D arrow.

Parameters

• xyzs (numpy.ndarray) – 2D array containing the starting and ending positions of the arrow.

• *args (Any) – The arguments for the FancyArrowPatch.

• **kwargs (Any) – The keyword arguments for the FancyArrowPatch.

Return type

None

add_callback(func)

Add a callback function that will be called whenever one of the .Artist’s properties changes.

Parameters

func (callable) –

The callback function. It must have the signature:

def func(artist: Artist) -> Any

where artist is the calling .Artist. Return values may exist but are ignored.

Returns

The observer id associated with the callback. This id can be used for removing the callback with .remove_callback later.

Return type

int

See also

remove_callback

contains(mouseevent, radius=None)

Test whether the mouse event occurred in the patch.

Return type

(bool, empty dict)

contains_point(point, radius=None)

Return whether the given point is inside the patch.

Parameters

• point ((float, float)) – The point (x, y) to check, in target coordinates of self.get_transform(). These are display coordinates for patches that are added to a figure or axes.

• radius (float, optional) –

  Add an additional margin on the patch in target coordinates of self.get_transform(). See .Path.contains_point for further details.

  By default it is set to None.

Return type

bool

Notes

The proper use of this method depends on the transform of the patch. Isolated patches do not have a transform. In this case, the patch creation coordinates and the point coordinates match. The following example checks that the center of a circle is within the circle

>>> center = 0, 0
>>> c = Circle(center, radius=1)
>>> c.contains_point(center)
True

The convention of checking against the transformed patch stems from the fact that this method is predominantly used to check if display coordinates (e.g. from mouse events) are within the patch. If you want to do the above check with data coordinates, you have to properly transform them first:

>>> center = 0, 0
>>> c = Circle(center, radius=1)
>>> plt.gca().add_patch(c)
>>> transformed_center = c.get_transform().transform(center)
>>> c.contains_point(transformed_center)
True

contains_points(points, radius=None)

Return whether the given points are inside the patch.

Parameters

• points ((N, 2) array) – The points to check, in target coordinates of self.get_transform(). These are display coordinates for patches that are added to a figure or axes. Columns contain x and y values.

• radius (float, optional) –

  Add an additional margin on the patch in target coordinates of self.get_transform(). See .Path.contains_point for further details.

  By default it is set to None.

Return type

length-N bool array

Notes

The proper use of this method depends on the transform of the patch. See the notes on .Patch.contains_point.

convert_xunits(x)

Convert x using the unit type of the xaxis.

If the artist is not in contained in an Axes or if the xaxis does not have units, x itself is returned.

convert_yunits(y)

Convert y using the unit type of the yaxis.

If the artist is not in contained in an Axes or if the yaxis does not have units, y itself is returned.

do_3d_projection()

Update the plot to ensure the right projection of the arrow.

Returns

The minimum z value between the starting and ending positions of the arrow

after the 3d projection.

Return type

float

draw(renderer)

Draw the Artist (and its children) using the given renderer.

This has no effect if the artist is not visible (.Artist.get_visible returns False).

Parameters

renderer (.RendererBase subclass.) –

Notes

This method is overridden in the Artist subclasses.

findobj(match=None, include_self=True)

Find artist objects.

Recursively find all .Artist instances contained in the artist.

Parameters

• match –

  A filter criterion for the matches. This can be

  • None: Return all objects contained in artist.

  • A function with signature def match(artist: Artist) -> bool. The result will only contain artists for which the function returns True.

  • A class instance: e.g., .Line2D. The result will only contain artists of this class or its subclasses (isinstance check).

  By default it is set to None.

• include_self (bool) –

  Include self in the list to be checked for a match.

  By default it is set to True.

Return type

list of .Artist

format_cursor_data(data)

Return a string representation of data.

Note

This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.

The default implementation converts ints and floats and arrays of ints and floats into a comma-separated string enclosed in square brackets, unless the artist has an associated colorbar, in which case scalar values are formatted using the colorbar’s formatter.

See also

get_cursor_data

get_aa()

Alias for get_antialiased.

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_animated()

Return whether the artist is animated.

get_antialiased()

Return whether antialiasing is used for drawing.

get_arrowstyle()

Return the arrowstyle object.

get_capstyle()

Return the capstyle.

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_connectionstyle()

Return the ConnectionStyle used.

get_cursor_data(event)

Return the cursor data for a given event.

Note

This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself.

Cursor data can be used by Artists to provide additional context information for a given event. The default implementation just returns None.

Subclasses can override the method and return arbitrary data. However, when doing so, they must ensure that .format_cursor_data can convert the data to a string representation.

The only current use case is displaying the z-value of an .AxesImage in the status bar of a plot window, while moving the mouse.

Parameters

event (matplotlib.backend_bases.MouseEvent) –

See also

format_cursor_data

get_data_transform()

Return the ~.transforms.Transform mapping data coordinates to physical coordinates.

get_dpi_cor()

[Deprecated] dpi_cor is currently used for linewidth-related things and shrink factor. Mutation scale is affected by this.

Return type

scalar

Notes

Deprecated since version 3.4.

get_ec()

Alias for get_edgecolor.

get_edgecolor()

Return the edge color.

get_extents()

Return the Patch’s axis-aligned extents as a ~.transforms.Bbox.

get_facecolor()

Return the face color.

get_fc()

Alias for get_facecolor.

get_figure()

Return the .Figure instance the artist belongs to.

get_fill()

Return whether the patch is filled.

get_gid()

Return the group id.

get_hatch()

Return the hatching pattern.

get_in_layout()

Return boolean flag, True if artist is included in layout calculations.

E.g. /tutorials/intermediate/constrainedlayout_guide, .Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').

get_joinstyle()

Return the joinstyle.

get_label()

Return the label used for this artist in the legend.

get_linestyle()

Return the linestyle.

get_linewidth()

Return the line width in points.

get_ls()

Alias for get_linestyle.

get_lw()

Alias for get_linewidth.

get_mutation_aspect()

Return the aspect ratio of the bbox mutation.

get_mutation_scale()

Return the mutation scale.

Return type

scalar

get_patch_transform()

Return the ~.transforms.Transform instance mapping patch coordinates to data coordinates.

For example, one may define a patch of a circle which represents a radius of 5 by providing coordinates for a unit circle, and a transform which scales the coordinates (the patch coordinate) by 5.

get_path()

Return the path of the arrow in the data coordinates.

get_path_effects()

get_picker()

Return the picking behavior of the artist.

The possible values are described in .set_picker.

See also

set_picker, pickable, pick

get_rasterized()

Return whether the artist is to be rasterized.

get_sketch_params()

Return the sketch parameters for the artist.

Returns

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.

Returns None if no sketch parameters were set.

Return type

tuple or None

get_snap()

Return the snap setting.

See .set_snap for details.

get_tightbbox(renderer)

Like .Artist.get_window_extent, but includes any clipping.

Parameters

renderer (.RendererBase subclass) – renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer())

Returns

The enclosing bounding box (in figure pixel coordinates).

Return type

.Bbox

get_transform()

Return the ~.transforms.Transform applied to the Patch.

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_verts()

Return a copy of the vertices used in this patch.

If the patch contains Bezier curves, the curves will be interpolated by line segments. To access the curves as curves, use get_path.

get_visible()

Return the visibility.

get_window_extent(renderer=None)

Get the artist’s bounding box in display space.

The bounding box’ width and height are nonnegative.

Subclasses should override for inclusion in the bounding box “tight” calculation. Default is to return an empty bounding box at 0, 0.

Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.

get_zorder()

Return the artist’s zorder.

have_units()

Return whether units are set on any axis.

is_transform_set()

Return whether the Artist has an explicitly set transform.

This is True after .set_transform has been called.

pchanged()

Call all of the registered callbacks.

This function is triggered internally when a property is changed.

See also

add_callback, remove_callback

pick(mouseevent)

Process a pick event.

Each child artist will fire a pick event if mouseevent is over the artist and the artist has picker set.

See also

set_picker, get_picker, pickable

pickable()

Return whether the artist is pickable.

See also

set_picker, get_picker, pick

properties()

Return a dictionary of all the properties of the artist.

remove()

Remove the artist from the figure if possible.

The effect will not be visible until the figure is redrawn, e.g., with .FigureCanvasBase.draw_idle. Call ~.axes.Axes.relim to update the axes limits if desired.

Note: ~.axes.Axes.relim will not see collections even if the collection was added to the axes with autolim = True.

Note: there is no support for removing the artist’s legend entry.

remove_callback(oid)

Remove a callback based on its observer id.

See also

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, arrowstyle=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, connectionstyle=<UNSET>, dpi_cor=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mutation_aspect=<UNSET>, mutation_scale=<UNSET>, patchA=<UNSET>, patchB=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, positions=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

Set multiple properties at once.

Supported properties are

Properties:

agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alpha: scalar or None animated: bool antialiased or aa: bool or None arrowstyle: None or ArrowStyle or str, default: None capstyle: .CapStyle or {‘butt’, ‘projecting’, ‘round’} clip_box: .Bbox clip_on: bool clip_path: Patch or (Path, Transform) or None color: color connectionstyle: str or .ConnectionStyle or None, optional dpi_cor: unknown edgecolor or ec: color or None facecolor or fc: color or None figure: .Figure fill: bool gid: str hatch: {‘/’, ‘\’, ‘|’, ‘-’, ‘+’, ‘x’, ‘o’, ‘O’, ‘.’, ‘*’} in_layout: bool joinstyle: .JoinStyle or {‘miter’, ‘round’, ‘bevel’} label: object linestyle or ls: {‘-’, ‘–’, ‘-.’, ‘:’, ‘’, (offset, on-off-seq), …} linewidth or lw: float or None mutation_aspect: float mutation_scale: float patchA: .patches.Patch patchB: .patches.Patch path_effects: .AbstractPathEffect picker: None or bool or float or callable positions: unknown rasterized: bool sketch_params: (scale: float, length: float, randomness: float) snap: bool or None transform: .Transform url: str visible: bool zorder: float

set_aa(aa)

Alias for set_antialiased.

set_agg_filter(filter_func)

Set the agg filter.

Parameters

filter_func (callable) –

A filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array.

set_alpha(alpha)

Set the alpha value used for blending - not supported on all backends.

Parameters

alpha (scalar or None) – alpha must be within the 0-1 range, inclusive.

set_animated(b)

Set whether the artist is intended to be used in an animation.

If True, the artist is excluded from regular drawing of the figure. You have to call .Figure.draw_artist / .Axes.draw_artist explicitly on the artist. This appoach is used to speed up animations using blitting.

See also matplotlib.animation and /tutorials/advanced/blitting.

Parameters

b (bool) –

set_antialiased(aa)

Set whether to use antialiased rendering.

Parameters

aa (bool or None) –

set_arrowstyle(arrowstyle=None, **kw)

Set the arrow style. Old attributes are forgotten. Without arguments (or with arrowstyle=None) returns available box styles as a list of strings.

Parameters

arrowstyle (None or ArrowStyle or str, default: None) –

Can be a string with arrowstyle name with optional comma-separated attributes, e.g.:

set_arrowstyle("Fancy,head_length=0.2")

Alternatively attributes can be provided as keywords, e.g.:

set_arrowstyle("fancy", head_length=0.2)

By default it is set to None.

set_capstyle(s)

Set the .CapStyle.

The default capstyle is ‘round’ for .FancyArrowPatch and ‘butt’ for all other patches.

Parameters

s (.CapStyle or {‘butt’, ‘projecting’, ‘round’}) –

set_clip_box(clipbox)

Set the artist’s clip .Bbox.

Parameters

clipbox (.Bbox) –

set_clip_on(b)

Set whether the artist uses clipping.

When False artists will be visible outside of the axes which can lead to unexpected results.

Parameters

b (bool) –

set_clip_path(path, transform=None)

Set the artist’s clip path.

Parameters

• path (.Patch or .Path or .TransformedPath or None) – The clip path. If given a .Path, transform must be provided as well. If None, a previously set clip path is removed.

• transform (~matplotlib.transforms.Transform, optional) –

  Only used if path is a .Path, in which case the given .Path is converted to a .TransformedPath using transform.

  By default it is set to None.

Notes

For efficiency, if path is a .Rectangle this method will set the clipping box to the corresponding rectangle and set the clipping path to None.

For technical reasons (support of ~.Artist.set), a tuple (path, transform) is also accepted as a single positional parameter.

set_color(c)

Set both the edgecolor and the facecolor.

Parameters

c (color) –

See also

Patch.set_facecolor, Patch.set_edgecolor

set_connectionstyle(connectionstyle, **kw)

Set the connection style. Old attributes are forgotten.

Parameters

connectionstyle (str or .ConnectionStyle or None, optional) –

Can be a string with connectionstyle name with optional comma-separated attributes, e.g.:

set_connectionstyle("arc,angleA=0,armA=30,rad=10")

Alternatively, the attributes can be provided as keywords, e.g.:

set_connectionstyle("arc", angleA=0,armA=30,rad=10)

Without any arguments (or with connectionstyle=None), return available styles as a list of strings.

set_dpi_cor(dpi_cor)

[Deprecated] dpi_cor is currently used for linewidth-related things and shrink factor. Mutation scale is affected by this.

Parameters

dpi_cor (float) –

Notes

Deprecated since version 3.4.

set_ec(color)

Alias for set_edgecolor.

set_edgecolor(color)

Set the patch edge color.

Parameters

color (color or None) –

set_facecolor(color)

Set the patch face color.

Parameters

color (color or None) –

set_fc(color)

Alias for set_facecolor.

set_figure(fig)

Set the .Figure instance the artist belongs to.

Parameters

fig (.Figure) –

set_fill(b)

Set whether to fill the patch.

Parameters

b (bool) –

set_gid(gid)

Set the (group) id for the artist.

Parameters

gid (str) –

set_hatch(hatch)

Set the hatching pattern.

hatch can be one of:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Letters can be combined, in which case all the specified hatchings are done. If same letter repeats, it increases the density of hatching of that pattern.

Hatching is supported in the PostScript, PDF, SVG and Agg backends only.

Parameters

hatch ({'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}) –

set_in_layout(in_layout)

Set if artist is to be included in layout calculations, E.g. /tutorials/intermediate/constrainedlayout_guide, .Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').

Parameters

in_layout (bool) –

set_joinstyle(s)

Set the .JoinStyle.

The default joinstyle is ‘round’ for .FancyArrowPatch and ‘miter’ for all other patches.

Parameters

s (.JoinStyle or {‘miter’, ‘round’, ‘bevel’}) –

set_label(s)

Set a label that will be displayed in the legend.

Parameters

s (object) – s will be converted to a string by calling str.

set_linestyle(ls)

Set the patch linestyle.

linestyle	description
'-' or 'solid'	solid line
'--' or 'dashed'	dashed line
'-.' or 'dashdot'	dash-dotted line
':' or 'dotted'	dotted line
'none', 'None', ' ', or ''	draw nothing

Alternatively a dash tuple of the following form can be provided:

(offset, onoffseq)

where onoffseq is an even length tuple of on and off ink in points.

Parameters

ls ({'-', '--', '-.', ':', '', (offset, on-off-seq), ...}) – The line style.

set_linewidth(w)

Set the patch linewidth in points.

Parameters

w (float or None) –

set_ls(ls)

Alias for set_linestyle.

set_lw(w)

Alias for set_linewidth.

set_mutation_aspect(aspect)

Set the aspect ratio of the bbox mutation.

Parameters

aspect (float) –

set_mutation_scale(scale)

Set the mutation scale.

Parameters

scale (float) –

set_patchA(patchA)

Set the tail patch.

Parameters

patchA (.patches.Patch) –

set_patchB(patchB)

Set the head patch.

Parameters

patchB (.patches.Patch) –

set_path_effects(path_effects)

Set the path effects.

Parameters

path_effects (.AbstractPathEffect) –

set_picker(picker)

Define the picking behavior of the artist.

Parameters

picker (None or bool or float or callable) –

This can be one of the following:

• None: Picking is disabled for this artist (default).

• A boolean: If True then picking will be enabled and the artist will fire a pick event if the mouse event is over the artist.

• A float: If picker is a number it is interpreted as an epsilon tolerance in points and the artist will fire off an event if its data is within epsilon of the mouse event. For some artists like lines and patch collections, the artist may provide additional data to the pick event that is generated, e.g., the indices of the data within epsilon of the pick event

• A function: If picker is callable, it is a user supplied function which determines whether the artist is hit by the mouse event:

  hit, props = picker(artist, mouseevent)
  

  to determine the hit test. if the mouse event is over the artist, return hit=True and props is a dictionary of properties you want added to the PickEvent attributes.

set_positions(posA, posB)

Set the begin and end positions of the connecting path.

Parameters

• posA (None, tuple) – (x, y) coordinates of arrow tail and arrow head respectively. If None use current value.

• posB (None, tuple) – (x, y) coordinates of arrow tail and arrow head respectively. If None use current value.

set_rasterized(rasterized)

Force rasterized (bitmap) drawing for vector graphics output.

Rasterized drawing is not supported by all artists. If you try to enable this on an artist that does not support it, the command has no effect and a warning will be issued.

This setting is ignored for pixel-based output.

See also /gallery/misc/rasterization_demo.

Parameters

rasterized (bool) –

set_sketch_params(scale=None, length=None, randomness=None)

Set the sketch parameters.

Parameters

• scale (float, 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.

  By default it is set to None.

• length (float, optional) –

  The length of the wiggle along the line, in pixels (default 128.0)

  By default it is set to None.

• randomness (float, optional) –

  The scale factor by which the length is shrunken or expanded (default 16.0)

  The PGF backend uses this argument as an RNG seed and not as described above. Using the same seed yields the same random shape.

  By default it is set to None.

set_snap(snap)

Set the snapping behavior.

Snapping aligns positions with the pixel grid, which results in clearer images. For example, if a black line of 1px width was defined at a position in between two pixels, the resulting image would contain the interpolated value of that line in the pixel grid, which would be a grey value on both adjacent pixel positions. In contrast, snapping will move the line to the nearest integer pixel value, so that the resulting image will really contain a 1px wide black line.

Snapping is currently only supported by the Agg and MacOSX backends.

Parameters

snap (bool or None) –

Possible values:

• True: Snap vertices to the nearest pixel center.

• False: Do not modify vertex positions.

• None: (auto) If the path contains only rectilinear line segments, round to the nearest pixel center.

set_transform(t)

Set the artist transform.

Parameters

t (.Transform) –

set_url(url)

Set the url for the artist.

Parameters

url (str) –

set_visible(b)

Set the artist’s visibility.

Parameters

b (bool) –

set_zorder(level)

Set the zorder for the artist. Artists with lower zorder values are drawn first.

Parameters

level (float) –

update(props)

Update this artist’s properties from the dict props.

Parameters

props (dict) –

update_from(other)

Copy properties from other to self.

property axes

The ~.axes.Axes instance the artist resides in, or None.

property fill

Return whether the patch is filled.

property get_path_in_displaycoord

property mouseover

If this property is set to True, the artist will be queried for custom context information when the mouse cursor moves over it.

See also get_cursor_data(), ToolCursorPosition and NavigationToolbar2.

property stale

Whether the artist is ‘stale’ and needs to be re-drawn for the output to match the internal state of the artist.

property sticky_edges

x and y sticky edge lists for autoscaling.

When performing autoscaling, if a data limit coincides with a value in the corresponding sticky_edges list, then no margin will be added–the view limit “sticks” to the edge. A typical use case is histograms, where one usually expects no margin on the bottom edge (0) of the histogram.

Moreover, margin expansion “bumps” against sticky edges and cannot cross them. For example, if the upper data limit is 1.0, the upper view limit computed by simple margin application is 1.2, but there is a sticky edge at 1.1, then the actual upper view limit will be 1.1.

This attribute cannot be assigned to; however, the x and y lists can be modified in place as needed.

Examples

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

validCap = ('butt', 'projecting', 'round')

validJoin = ('miter', 'round', 'bevel')

zorder = 1