fractaldna.structure_models.random_placements.Arrow3D¶

class fractaldna.structure_models.random_placements.Arrow3D(start, end, *args, **kwargs)¶

Bases: FancyArrowPatch

Helper class to plot arrows

__init__(start, end, *args, **kwargs)¶

There are two ways for defining an arrow:

If posA and posB are given, a path connecting two points is created according to connectionstyle. The path will be clipped with patchA and patchB and further shrunken by shrinkA and shrinkB. An arrow is drawn along this resulting path using the arrowstyle parameter.
Alternatively if path is provided, an arrow is drawn along this path and patchA, patchB, shrinkA, and shrinkB are ignored.

Parameters¶

posA, posB(float, float), default: None

(x, y) coordinates of arrow tail and arrow head respectively.

path~matplotlib.path.Path, default: None

If provided, an arrow is drawn along this path and patchA, patchB, shrinkA, and shrinkB are ignored.

arrowstylestr or .ArrowStyle, default: ‘simple’

The .ArrowStyle with which the fancy arrow is drawn. If a string, it should be one of the available arrowstyle names, with optional comma-separated attributes. The optional attributes are meant to be scaled with the mutation_scale. The following arrow styles are available:

Class	Name	Attrs
Curve	`-`	None
CurveA	`<-`	head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveB	`->`	head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveAB	`<->`	head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveFilledA	`<\|-`	head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveFilledB	`-\|>`	head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveFilledAB	`<\|-\|>`	head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
BracketA	`]-`	widthA=1.0, lengthA=0.2, angleA=0
BracketB	`-[`	widthB=1.0, lengthB=0.2, angleB=0
BracketAB	`]-[`	widthA=1.0, lengthA=0.2, angleA=0, widthB=1.0, lengthB=0.2, angleB=0
BarAB	`\|-\|`	widthA=1.0, angleA=0, widthB=1.0, angleB=0
BracketCurve	`]->`	widthA=1.0, lengthA=0.2, angleA=None
CurveBracket	`<-[`	widthB=1.0, lengthB=0.2, angleB=None
Simple	`simple`	head_length=0.5, head_width=0.5, tail_width=0.2
Fancy	`fancy`	head_length=0.4, head_width=0.4, tail_width=0.4
Wedge	`wedge`	tail_width=0.3, shrink_factor=0.5

connectionstylestr or .ConnectionStyle or None, optional, default: ‘arc3’

The .ConnectionStyle with which posA and posB are connected. If a string, it should be one of the available connectionstyle names, with optional comma-separated attributes. The following connection styles are available:

Class	Name	Attrs
Arc3	`arc3`	rad=0.0
Angle3	`angle3`	angleA=90, angleB=0
Angle	`angle`	angleA=90, angleB=0, rad=0.0
Arc	`arc`	angleA=0, angleB=0, armA=None, armB=None, rad=0.0
Bar	`bar`	armA=0.0, armB=0.0, fraction=0.3, angle=None

patchA, patchB.Patch, default: None

Head and tail patches, respectively.

shrinkA, shrinkBfloat, default: 2

Shrinking factor of the tail and head of the arrow respectively.

mutation_scalefloat, default: 1

Value with which attributes of arrowstyle (e.g., head_length) will be scaled.

mutation_aspectNone or float, default: None

The height of the rectangle will be squeezed by this value before the mutation and the mutated box will be stretched by the inverse of it.

Other Parameters¶

**kwargs.Patch properties, optional

Here is a list of available .Patch properties:

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 and two offsets from the bottom left corner of the image alpha: unknown animated: bool antialiased or aa: bool or None capstyle: .CapStyle or {‘butt’, ‘projecting’, ‘round’} clip_box: .Bbox clip_on: bool clip_path: Patch or (Path, Transform) or None color: color 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 mouseover: bool path_effects: .AbstractPathEffect picker: None or bool or float or callable rasterized: bool sketch_params: (scale: float, length: float, randomness: float) snap: bool or None transform: .Transform url: str visible: bool zorder: float

In contrast to other patches, the default capstyle and joinstyle for FancyArrowPatch are set to "round".

Methods

`__init__`(start, end, args, *kwargs)	There are two ways for defining an arrow:
`add_callback`(func)	Add a callback function that will be called whenever one of the .Artist's properties changes.
`contains`(mouseevent[, radius])	Test whether the mouse event occurred in the patch.
`contains_point`(point[, radius])	Return whether the given point is inside the patch.
`contains_points`(points[, radius])	Return whether the given points are inside the patch.
`convert_xunits`(x)	Convert x using the unit type of the xaxis.
`convert_yunits`(y)	Convert y using the unit type of the yaxis.
`draw`(renderer)	Draw the Artist (and its children) using the given renderer.
`findobj`([match, include_self])	Find artist objects.
`format_cursor_data`(data)	Return a string representation of 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.
`get_data_transform`()	Return the ~.transforms.Transform mapping data coordinates to physical coordinates.
`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.
`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_mouseover`()	Return whether this artist is queried for custom context information when the mouse cursor moves over it.
`get_mutation_aspect`()	Return the aspect ratio of the bbox mutation.
`get_mutation_scale`()	Return the mutation scale.
`get_patch_transform`()	Return the ~.transforms.Transform instance mapping patch coordinates to data coordinates.
`get_path`()	Return the path of the arrow in the data coordinates.
`get_path_effects`()
`get_picker`()	Return the picking behavior of the artist.
`get_rasterized`()	Return whether the artist is to be rasterized.
`get_sketch_params`()	Return the sketch parameters for the artist.
`get_snap`()	Return the snap setting.
`get_tightbbox`([renderer])	Like .Artist.get_window_extent, but includes any clipping.
`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.
`get_visible`()	Return the visibility.
`get_window_extent`([renderer])	Get the artist's bounding box in display space.
`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.
`pchanged`()	Call all of the registered callbacks.
`pick`(mouseevent)	Process a pick event.
`pickable`()	Return whether the artist is pickable.
`properties`()	Return a dictionary of all the properties of the artist.
`remove`()	Remove the artist from the figure if possible.
`remove_callback`(oid)	Remove a callback based on its observer id.
`set`(*[, agg_filter, alpha, animated, ...])	Set multiple properties at once.
`set_aa`(aa)	Alias for set_antialiased.
`set_agg_filter`(filter_func)	Set the agg filter.
`set_alpha`(alpha)	Set the alpha value used for blending - not supported on all backends.
`set_animated`(b)	Set whether the artist is intended to be used in an animation.
`set_antialiased`(aa)	Set whether to use antialiased rendering.
`set_arrowstyle`([arrowstyle])	Set the arrow style, possibly with further attributes.
`set_capstyle`(s)	Set the .CapStyle.
`set_clip_box`(clipbox)	Set the artist's clip .Bbox.
`set_clip_on`(b)	Set whether the artist uses clipping.
`set_clip_path`(path[, transform])	Set the artist's clip path.
`set_color`(c)	Set both the edgecolor and the facecolor.
`set_connectionstyle`([connectionstyle])	Set the connection style, possibly with further attributes.
`set_ec`(color)	Alias for set_edgecolor.
`set_edgecolor`(color)	Set the patch edge color.
`set_facecolor`(color)	Set the patch face color.
`set_fc`(color)	Alias for set_facecolor.
`set_figure`(fig)	Set the .Figure instance the artist belongs to.
`set_fill`(b)	Set whether to fill the patch.
`set_gid`(gid)	Set the (group) id for the artist.
`set_hatch`(hatch)	Set the hatching pattern.
`set_in_layout`(in_layout)	Set if artist is to be included in layout calculations, E.g.
`set_joinstyle`(s)	Set the .JoinStyle.
`set_label`(s)	Set a label that will be displayed in the legend.
`set_linestyle`(ls)	Set the patch linestyle.
`set_linewidth`(w)	Set the patch linewidth in points.
`set_ls`(ls)	Alias for set_linestyle.
`set_lw`(w)	Alias for set_linewidth.
`set_mouseover`(mouseover)	Set whether this artist is queried for custom context information when the mouse cursor moves over it.
`set_mutation_aspect`(aspect)	Set the aspect ratio of the bbox mutation.
`set_mutation_scale`(scale)	Set the mutation scale.
`set_patchA`(patchA)	Set the tail patch.
`set_patchB`(patchB)	Set the head patch.
`set_path_effects`(path_effects)	Set the path effects.
`set_picker`(picker)	Define the picking behavior of the artist.
`set_positions`(posA, posB)	Set the start and end positions of the connecting path.
`set_rasterized`(rasterized)	Force rasterized (bitmap) drawing for vector graphics output.
`set_sketch_params`([scale, length, randomness])	Set the sketch parameters.
`set_snap`(snap)	Set the snapping behavior.
`set_transform`(t)	Set the artist transform.
`set_url`(url)	Set the url for the artist.
`set_visible`(b)	Set the artist's visibility.
`set_zorder`(level)	Set the zorder for the artist.
`update`(props)	Update this artist's properties from the dict props.
`update_from`(other)	Copy properties from other to self.

Attributes

`axes`	The ~.axes.Axes instance the artist resides in, or None.
`fill`	Return whether the patch is filled.
`mouseover`	Return whether this artist is queried for custom context information when the mouse cursor moves over it.
`stale`	Whether the artist is 'stale' and needs to be re-drawn for the output to match the internal state of the artist.
`sticky_edges`	`x` and `y` sticky edge lists for autoscaling.
`zorder`

add_callback(func)¶

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

Parameters¶

funccallable

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¶

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

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.
radiusfloat, optional: Additional margin on the patch in target coordinates of self.get_transform(). See .Path.contains_point for further details.

Returns¶

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.
radiusfloat, optional: Additional margin on the patch in target coordinates of self.get_transform(). See .Path.contains_point for further details.

Returns¶

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 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 contained in an Axes or if the yaxis does not have units, y itself is returned.

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.

property fill¶: Return whether the patch is filled.

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).

include_selfbool

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

Returns¶

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.

Parameters¶

event : matplotlib.backend_bases.MouseEvent

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.

Returns None if no sketch parameters were set.

get_snap()¶

Return the snap setting.

See .set_snap for details.

get_tightbbox(renderer=None)¶

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¶

.Bbox: The enclosing bounding box (in figure pixel coordinates).

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 Bézier 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.

property mouseover¶: Return whether this artist is queried for custom context information when the mouse cursor moves over it.

pchanged()¶

Call all of the registered callbacks.

This function is triggered internally when a property is changed.

Parameters¶

filter_funccallable: A filter function, which takes a (m, n, depth) float array and a dpi value, and returns a (m, n, depth) array and two offsets from the bottom left corner of the image

set_alpha(alpha)¶

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

Parameters¶

alphascalar 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 approach 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, **kwargs)¶

Set the arrow style, possibly with further attributes.

Attributes from the previous arrow style are not reused.

Without argument (or with arrowstyle=None), the available box styles are returned as a human-readable string.

Parameters¶

arrowstylestr or matplotlib.patches.ArrowStyle

The style of the arrow: either a .ArrowStyle instance, or a string, which is the style name and optionally comma separated attributes (e.g. “Fancy,head_length=0.2”). Such a string is used to construct a .ArrowStyle object, as documented in that class.

The following arrow styles are available:

%(ArrowStyle:table_and_accepts)s

**kwargs

Additional attributes for the arrow style. See the table above for supported parameters.

Examples¶

set_arrowstyle("Fancy,head_length=0.2")
set_arrowstyle("fancy", head_length=0.2)

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

Typically would be created from a .TransformedBbox. For instance TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) is the default clipping for an artist added to an Axes.

set_clip_on(b)¶

Set whether the artist uses clipping.

When False, artists will be visible outside 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.

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

Parameters¶

connectionstylestr or matplotlib.patches.ConnectionStyle

The style of the connection: either a .ConnectionStyle instance, or a string, which is the style name and optionally comma separated attributes (e.g. “Arc,armA=30,rad=10”). Such a string is used to construct a .ConnectionStyle object, as documented in that class.

The following connection styles are available:

Class	Name	Attrs
Arc3	`arc3`	rad=0.0
Angle3	`angle3`	angleA=90, angleB=0
Angle	`angle`	angleA=90, angleB=0, rad=0.0
Arc	`arc`	angleA=0, angleB=0, armA=None, armB=None, rad=0.0
Bar	`bar`	armA=0.0, armB=0.0, fraction=0.3, angle=None

**kwargs

Additional attributes for the connection style. See the table above for supported parameters.

Examples¶

set_connectionstyle("Arc,armA=30,rad=10")
set_connectionstyle("arc", armA=30, rad=10)

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¶

sobject: 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_mouseover(mouseover)¶: Set whether this artist is queried for custom context information when the mouse cursor moves over it.

Parameters¶

mouseover : bool

See Also¶

get_cursor_data .ToolCursorPosition .NavigationToolbar2

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¶

pickerNone 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 start and end positions of the connecting path.

Parameters¶

posA, posBNone, 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¶

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, optional

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

randomnessfloat, 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.

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¶

snapbool 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

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)

update(props)¶: Update this artist’s properties from the dict props.

Parameters¶

props : dict

update_from(other)¶: Copy properties from other to self.

fractaldna.structure_models.random_placements.Arrow3D¶

Parameters¶

Other Parameters¶

Parameters¶

Returns¶

See Also¶

Returns¶

Parameters¶

Returns¶

Notes¶

Parameters¶

Returns¶

Notes¶

Parameters¶

Notes¶

Parameters¶

Returns¶

See Also¶

Parameters¶

See Also¶

Returns¶

See Also¶

Returns¶

Parameters¶

Returns¶

See Also¶

See Also¶

See Also¶

See Also¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Examples¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Notes¶

Parameters¶

See Also¶

Parameters¶

Examples¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

See Also¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Parameters¶

Examples¶

Parameters¶