PlotOptionsWidget

class menpowidgets.options.PlotOptionsWidget(legend_entries, render_function=None, style='minimal', tabs_style='minimal')[source]

Bases: MenpoWidget

Creates a widget for selecting options for rendering various curves in a graph. The widget consists of the following objects from ipywidgets and menpowidgets.tools:

No Object Property (self.) Description
1 LineOptionsWidget lines_wid Line options widget
2 MarkerOptionsWidget markers_wid Marker options widget
3 Dropdown curves_dropdown Curve selector
4 Tab lines_markers_tab Contains 1, 2
5 VBox lines_markers_box Contains 3, 4
6 LegendOptionsWidget legend_wid Legend options widget
7 AxesOptionsWidget axes_wid Axes options widget
8 ZoomTwoScalesWidget zoom_wid Zoom options widget
9 GridOptionsWidget grid_wid Grid options widget
10 Text x_label X label text
11 Text y_label Y label text
12 Text title Title text
13 Textarea legend_entries_text Legend entries text
14 VBox plot_related_options Contains 10 - 13
15 Tab options_tab Contains 14, 5 - 9

Note that:

  • The widget has memory about the properties of the objects that are passed into it through legend_entries.
  • The selected values of the current object object are stored in the self.selected_values trait.
  • To set the styling of this widget please refer to the style() and predefined_style() methods.
  • To update the handler callback function of the widget, please refer to the replace_render_function() method.
Parameters:
  • legend_entries (list of str) – The list of legend entries per curve.
  • render_function (callable or None, optional) –

    The render function that is executed when a widgets’ value changes. It must have signature render_function(change) where change is a dict with the following keys:

    • type : The type of notification (normally 'change').
    • owner : the HasTraits instance
    • old : the old value of the modified trait attribute
    • new : the new value of the modified trait attribute
    • name : the name of the modified trait attribute.

    If None, then nothing is assigned.

  • style (str (see below), optional) –

    Sets a predefined style at the widget. Possible options are:

    Style Description
    'minimal' Simple black and white style
    'success' Green-based style
    'info' Blue-based style
    'warning' Yellow-based style
    'danger' Red-based style
    '' No style
  • tabs_style (str (see below), optional) –

    Sets a predefined style at the tabs of the widget. Possible options are:

    Style Description
    'minimal' Simple black and white style
    'success' Green-based style
    'info' Blue-based style
    'warning' Yellow-based style
    'danger' Red-based style
    '' No style

Example

Let’s create a plot options widget. Firstly, we need to import it:

>>> from menpowidgets.options import PlotOptionsWidget

Let’s set some legend entries:

>>> legend_entries = ['method_1', 'method_2']

Now let’s define a render function that will get called on every widget change and will dynamically print the selected marker face colour and line width:

>>> from menpo.visualize import print_dynamic
>>> def render_function(change):
>>>     s = "Marker edge colours: {}, Line widths: {}".format(
>>>         wid.selected_values['marker_edge_colour'],
>>>         wid.selected_values['line_width'])
>>>     print_dynamic(s)

Create the widget with the initial options and display it:

>>> wid = PlotOptionsWidget(legend_entries,
>>>                         render_function=render_function,
>>>                         style='danger', tabs_style='info')
>>> wid

By playing around, the printed message gets updated. The style of the widget can be changed as:

>>> wid.predefined_style('minimal', 'info')
add_render_function(render_function)

Method that adds the provided render_function() as a callback handler to the selected_values trait of the widget. The given function is also stored in self._render_function.

Parameters:render_function (callable or None, optional) –

The render function that behaves as a callback handler of the selected_values trait for the change event. Its signature can be render_function() or render_function(change), where change is a dict with the following keys:

  • owner : the HasTraits instance
  • old : the old value of the modified trait attribute
  • new : the new value of the modified trait attribute
  • name : the name of the modified trait attribute.
  • type : 'change'

If None, then nothing is added.
add_traits(**traits)

Dynamically add trait attributes to the Widget.

call_render_function(old_value, new_value, type_value='change')

Method that calls the existing render_function() callback handler.

Parameters:
  • old_value (int or float or dict or list or tuple) – The old selected_values value.
  • new_value (int or float or dict or list or tuple) – The new selected_values value.
  • type_value (str, optional) – The trait event type.
close()

Close method.

Closes the underlying comm. When the comm is closed, all of the widget views are automatically removed from the front-end.

create_default_options()[source]

Function that returns a dict with default options. The returned dict has the following default keys and values:

  • title = ''
  • x_label = ''
  • y_label = ''
  • render_legend = True
  • legend_title = ''
  • legend_font_name = 'sans-serif'
  • legend_font_style = 'normal'
  • legend_font_size = 10
  • legend_font_weight = 'normal'
  • legend_marker_scale = 1.
  • legend_location = 2
  • legend_bbox_to_anchor = (1.05, 1.)
  • legend_border_axes_pad = 1.
  • legend_n_columns = 1
  • legend_horizontal_spacing = 1.
  • legend_vertical_spacing = 1.
  • legend_border = True
  • legend_border_padding = 0.5
  • legend_shadow = False
  • legend_rounded_corners = False
  • render_axes = True
  • axes_font_name = 'sans-serif'
  • axes_font_size = 10
  • axes_font_style = 'normal'
  • axes_font_weight = 'normal'
  • axes_x_limits = None
  • axes_y_limits = None
  • axes_x_ticks = None
  • axes_y_ticks = None
  • render_grid = True
  • grid_line_style = '--'
  • grid_line_width = 0.5
  • render_lines = [True] * self.n_curves
  • line_width = [1] * self.n_curves
  • line_colour = colours if self.n_curves > 1 else ['red']
  • line_style = ['-'] * self.n_curves
  • render_markers = [True] * self.n_curves
  • marker_size = [7] * self.n_curves
  • marker_face_colour = ['white'] * self.n_curves
  • marker_edge_colour = colours if self.n_curves > 1 else ['red']
  • marker_style = ['s'] * self.n_curves
  • marker_edge_width = [2.] * self.n_curves
  • zoom = [1., 1.]

where colours = sample_colours_from_colourmap(self.n_curves, 'Paired').

has_trait(name)

Returns True if the object has a trait with the specified name.

observe(handler, names=traitlets.All, type='change')

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Parameters:
  • handler (callable) – A callable that is called when a trait changes. Its signature should be handler(change), where change```is a dictionary. The change dictionary at least holds a 'type' key. * ``type: the type of notification. Other keys may be passed depending on the value of ‘type’. In the case where type is ‘change’, we also have the following keys: * owner : the HasTraits instance * old : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.
  • names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.
  • type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.
predefined_style(style, tabs_style='minimal')[source]

Function that sets a predefined style on the widget.

Parameters:
  • style (str (see below)) –

    Style options:

    Style Description
    'minimal' Simple black and white style
    'success' Green-based style
    'info' Blue-based style
    'warning' Yellow-based style
    'danger' Red-based style
    '' No style
  • tabs_style (str (see below)) –

    Tabs style options:

    Style Description
    'minimal' Simple black and white style
    'success' Green-based style
    'info' Blue-based style
    'warning' Yellow-based style
    'danger' Red-based style
    '' No style
remove_render_function()

Method that removes the current self._render_function() as a callback handler to the selected_values trait of the widget and sets self._render_function = None.

replace_render_function(render_function)

Method that replaces the current self._render_function() with the given render_function() as a callback handler to the selected_values trait of the widget.

Parameters:render_function (callable or None, optional) –

The render function that behaves as a callback handler of the selected_values trait for the change event. Its signature can be render_function() or render_function(change), where change is a dict with the following keys:

  • owner : the HasTraits instance
  • old : the old value of the modified trait attribute
  • new : the new value of the modified trait attribute
  • name : the name of the modified trait attribute.
  • type : 'change'

If None, then nothing is added.
style(box_style=None, border_visible=False, border_colour='black', border_style='solid', border_width=1, border_radius=0, padding='0.2cm', margin=0, tabs_box_style=None, tabs_border_visible=True, tabs_border_colour='black', tabs_border_style='solid', tabs_border_width=1, tabs_border_radius=1, tabs_padding=0, tabs_margin=0, font_family='', font_size=None, font_style='', font_weight='')[source]

Function that defines the styling of the widget.

Parameters:
  • box_style (str or None (see below), optional) –

    Possible widget style options:

    'success', 'info', 'warning', 'danger', '', None
  • border_visible (bool, optional) – Defines whether to draw the border line around the widget.
  • border_colour (str, optional) – The colour of the border around the widget.
  • border_style (str, optional) – The line style of the border around the widget.
  • border_width (float, optional) – The line width of the border around the widget.
  • border_radius (float, optional) – The radius of the border around the widget.
  • padding (float, optional) – The padding around the widget.
  • margin (float, optional) – The margin around the widget.
  • tabs_box_style (See Below, optional) –

    Possible tab widgets style options:

    'success', 'info', 'warning', 'danger', '', None
  • tabs_border_visible (bool, optional) – Defines whether to draw the border line around the tab widgets.
  • tabs_border_colour (str, optional) – The colour of the border around the tab widgets.
  • tabs_border_style (str, optional) – The line style of the border around the tab widgets.
  • tabs_border_width (float, optional) – The line width of the border around the tab widgets.
  • tabs_border_radius (float, optional) – The radius of the corners of the box of the tab widgets.
  • tabs_padding (float, optional) – The padding around the tab widgets.
  • tabs_margin (float, optional) – The margin around the tab widgets.
  • font_family (str (see below), optional) –

    The font family to be used. Example options:

    'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace',
'helvetica'
  • font_size (int, optional) – The font size.
  • font_style (str (see below), optional) –

    The font style. Example options:

    'normal', 'italic', 'oblique'
  • font_weight (See Below, optional) –

    The font weight. Example options:

    'ultralight', 'light', 'normal', 'regular', 'book', 'medium',
'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy',
'extra bold', 'black'
trait_names(**metadata)

Get a list of all the names of this class’ traits.

traits(**metadata)

Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should take a single value as an argument and return a boolean. If any function returns False, then the trait is not included in the output. If a metadata key doesn’t exist, None will be passed to the function.

unobserve(handler, names=traitlets.All, type='change')

Remove a trait change handler.

This is used to unregister handlers to trait change notificiations.

Parameters:
  • handler (callable) – The callable called when a trait attribute changes.
  • names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.
  • type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.
unobserve_all(name=traitlets.All)

Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.