Writing FView plugins

Overview

The fview program provides a simple extensibility mechanism. In outline, the steps required are:

• Create a subclass of fview.traited_plugin.HasTraits_FViewPlugin.
• Implement your GUI interaction using traits.
• Implement your realtime processing logic in your class’s process_frame() method. Note that this code will be run in a separate thread of execution from the GUI, so be careful to avoid share memory structures without locking. The buf argument is a numpy array (or else supports the numpy array interface).
• Optionally, handle the various options allowed by FView.
• Finally, register your FView plugin.

To test your plugin, you can you the fview command directly, or you may use fview_fmf_replay to test your plugin on a saved video recording.

Register your FView plugin

In your setup.py, use setuptools an add a motmot.fview.plugins key to entry_points. For the above example, this would be:

entry_points = {
  'motmot.fview.plugins':'fview_ext_trig = motmot.fview_ext_trig.fview_ext_trig:FviewExtTrig',
   }

Tutorials

• FView plugin tutorial: live histogram of image intensity values
  • Prerequisites
  • Step 1 - Build the file layout
  • Step 2 - Create setup.py
  • Step 3 - Create a do-nothing plugin
  • Step 4 - Create the plugin logic
  • Afterward: optional improvements
• FView plugin tutorial: periodic triggering of an external device
  • Prerequisites
  • Introduction
  • Create the plugin logic
• FView plugin tutorial: change-based triggering of an external device
  • Prerequisites
  • Introduction
  • Create the plugin logic