AnimationOptionsWidget

class menpowidgets.options.AnimationOptionsWidget(index, render_function=None, index_style='buttons', interval=0.2, interval_step=0.05, description='Index: ', loop_enabled=True, style='minimal', continuous_update=False)

Bases: MenpoWidget

Creates a widget for animating through a list of objects. The widget consists of the following objects from ipywidgets and menpowidgets.tools:

No	Object	Property (self.)	Description
1	ToggleButton	play_stop_toggle	The play/stop button
2	Button	fast_forward_button	Increase speed
3	Button	fast_backward_button	Decrease speed
4	ToggleButton	loop_toggle	Repeat mode
5	HBox	animation_box	Contains 1, 2, 3, 4
8	IndexButtonsWidget IndexSliderWidget	index_wid	The index selector

Note that:

• The selected values 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 state of the widget, please refer to the set_widget_state() method.
• To update the handler callback function of the widget, please refer to the replace_render_function() method.

Parameters:

• index (dict) –

  The initial options. It must be a dict with the following keys:

  • min : (int) The minimum value (e.g. 0).
  • max : (int) The maximum value (e.g. 100).
  • step : (int) The index step (e.g. 1).
  • index : (int) The index value (e.g. 10).
• 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.

• index_style ({'buttons', 'slider'}, optional) – If 'buttons', then IndexButtonsWidget class is called. If 'slider', then IndexSliderWidget class is called.
• interval (float, optional) – The interval between the animation progress in seconds.
• interval_step (float, optional) – The interval step (in seconds) that is applied when fast forward/backward buttons are pressed.
• description (str, optional) – The title of the widget.
• loop_enabled (bool, optional) – If True, then after reach the minimum (maximum) index values, the counting will continue from the end (beginning). If False, the counting will stop at the minimum (maximum) value.
• 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

• continuous_update (bool, optional) – If True and index_style is set to 'slider', then the render and update functions are called while moving the slider’s handle. If False, then the the functions are called only when the handle (mouse click) is released.

Example

Let’s create an animation widget and then update its state. Firstly, we need to import it:

>>> from menpowidgets.options import AnimationOptionsWidget

Now let’s define a render function that will get called on every widget change and will dynamically print the selected index:

>>> from menpo.visualize import print_dynamic
>>> def render_function(change):
>>>     s = "Selected index: {}".format(wid.selected_values)
>>>     print_dynamic(s)

Create the widget with some initial options and display it:

>>> index = {'min': 0, 'max': 100, 'step': 1, 'index': 10}
>>> wid = AnimationOptionsWidget(index, index_style='buttons',
>>>                              render_function=render_function,
>>>                              style='info')
>>> wid

By pressing the buttons (or simply pressing the Play button), the printed message gets updated. Finally, let’s change the widget status with a new dictionary of options:

>>> new_options = {'min': 0, 'max': 20, 'step': 2, 'index': 16}
>>> wid.set_widget_state(new_options, allow_callback=False)

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.

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)

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

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.

set_widget_state(index, allow_callback=True)

Method that updates the state of the widget, if the provided index values are different than self.selected_values.

Parameters:

• index (dict) –

  The selected options. It must be a dict with the following keys:

  • min : (int) The minimum value (e.g. 0).
  • max : (int) The maximum value (e.g. 100).
  • step : (int) The index step (e.g. 1).
  • index : (int) The index value (e.g. 10).
• allow_callback (bool, optional) – If True, it allows triggering of any callback functions.

stop_animation()

Method that stops an active annotation by setting self.play_stop_toggle.value = False.

style(box_style=None, border_visible=False, border_colour='black', border_style='solid', border_width=1, border_radius=0, padding=0, margin=0, font_family='', font_size=None, font_style='', font_weight='')

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