rayoptics.mpl.interactivefigure module

class SelectInfo(artist, info)

Bases: tuple

artist

the artist

info

a dictionary of artist specific details of selection

artist_str(a)

display_artist_and_event(callback_str, event, artist)

class InteractiveFigure(do_draw_frame=False, do_draw_axes=False, oversize_factor=0.05, aspect='equal', view_bbox=None, do_scale_bounds=False, **kwargs)

Bases: StyledFigure

Base class for domain specific figures with support for input events

The InteractiveFigure class supplies common implementations for:

• polyline and polygon 2D graphics

• selection support for mpl graphic objects

• mouse/touch event handling

• interface commands for zooming and panning the display area

do_draw_frame

if True, draw frame around the figure

do_draw_axes

if True, draw coordinate axes for the figure

oversize_factor

what fraction to oversize the view bounding box

aspect

‘equal’ for 1:1 aspect ratio, ‘auto’ for best ratio

artist_filter

an (optional) callable applied in find_artists_at_location(), returns True if rejected

connect_events(action_dict=None)

connect to all the events we need

disconnect_events()

disconnect all the stored connection ids

property is_unit_aspect_ratio

refresh(**kwargs)

Call update_data() followed by plot(), return self.

Parameters:

kwargs – keyword arguments are passed to update_data

Returns:

self (class Figure) so scripting envs will auto display results

update_data(**kwargs)

action_complete()

register_action(*args, **kwargs)

register_pan(on_finished)

register_zoom_box(on_finished)

update_patches(shapes)

loop over the input shapes, fetching their current geometry and attaching it to the corresponding Artist

create_patches(handles)

create_polygon(poly, linewidth=0.5, **kwargs)

create_polyline(poly, linewidth=0.5, hilite_linewidth=2, **kwargs)

create_vertex(vertex, markersize=5, hilite_markersize=7, **kwargs)

get_artist_for_handle(handle) → SelectInfo

update_axis_limits(bbox)

fit_axis_limits()

returns a numpy bounding box that fits the current data

set_view_bbox(bbox)

fit()

zoom(factor)

zoom_in()

zoom_out()

draw_frame(do_draw_frame)

draw_axes(do_draw_axes)

plot()

Draw the actual figure.

find_artists_at_location(event) → list[SelectInfo]

Returns a list of shapes in zorder at the event location.

do_shape_action(event, target: SelectInfo, event_key)

Execute the target shape’s action for the event_key.

This is the default function that the do_action callable attribute is initialized to.

on_select(event)

on_key_press(event)

on_motion(event)

on_press(event)

on_release(event)

on release we reset the press data

find_artists_and_hilite(event) → list[SelectInfo]

identify and hilite artists at the mouse event location

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, canvas=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, constrained_layout=<UNSET>, constrained_layout_pads=<UNSET>, dpi=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, figheight=<UNSET>, figwidth=<UNSET>, frameon=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, layout_engine=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, size_inches=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, tight_layout=<UNSET>, transform=<UNSET>, url=<UNSET>, view_bbox=<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 and two offsets from the bottom left corner of the image alpha: scalar or None animated: bool canvas: FigureCanvas clip_box: ~matplotlib.transforms.BboxBase or None clip_on: bool clip_path: Patch or (Path, Transform) or None constrained_layout: unknown constrained_layout_pads: unknown dpi: float edgecolor: color facecolor: color figheight: float figure: ~matplotlib.figure.Figure figwidth: float frameon: bool gid: str in_layout: bool label: object layout_engine: {‘constrained’, ‘compressed’, ‘tight’, ‘none’, .LayoutEngine, None} linewidth: number mouseover: bool path_effects: list of .AbstractPathEffect picker: None or bool or float or callable rasterized: bool size_inches: (float, float) or float sketch_params: (scale: float, length: float, randomness: float) snap: bool or None tight_layout: unknown transform: ~matplotlib.transforms.Transform url: str view_bbox: unknown visible: bool zorder: float

update_artist_hiliting(hilited_artists, new_artists)

manage artist hiliting in response to mouse event

class PanAction(**kwargs)

Bases: object

wrapper class to handle pan action, handing off to Axes

class ZoomBoxAction(fig, **kwargs)

Bases: object

handle zoom box action by using a RectangleSelector widget

enter_polyline(point_filter=None, constrain_to_wedge=True, **inputs)

Graphical input of a 2d polyline

snap_to_grid_fct(grid_space: float)