jdeschamps / EMU-guide

Guide to EMU, a Micro-Manager plugin to load easily reconfigurable user interfaces.

Home Page:https://jdeschamps.github.io/EMU-guide/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

EMUEMU guide

Why use EMU?

Micro-Manager controls the devices on your microscope using device properties (e.g. laser on/off). All device properties can be accessed through the device property browser. However, controlling the microscope through a long list of properties is cumbersome, slow and rather aimed at the microscope engineer than at the user. While interactions with device properties can be facilitated by using configuration preset groups or the quick access plugin, these cannot replace a user interface (UI) tailored to the microscope.

Tailored interfaces have the advantage of rendering the control of the microscope intuitive. However, tailoring the UI often means hard-coded references to the specific device properties of the microscope and a need to recompile it every time something changes on the microscope.

Easier Micro-manager User interface (EMU) offers means to make your Micro-Manager interface reconfigurable:

  • Rapid design compatible with drag and drop softwares (e.g. Eclipse WindowBuilder).
  • Functional Micro-Manager UI with only few lines of code thanks to EMU's back-end.
  • Flexible and transferable: easy and intuitive configuration through EMU's interface.

Guide

  1. Installation
  2. Quick introduction
  3. EMU: user guide
    1. Principle
    2. Configuration
      1. Configuration wizard
      2. Configuration manager
    3. Plugin menu
  4. Programming guide
    1. EMU principle
    2. JComponents
    3. ConfigurablePanel
      1. UIProperty
      2. SwingUIListeners
      3. UIParameter
      4. InternalProperty
    4. ConfigurableMainFrame
      1. Methods to implement
      2. Plugin Settings
    5. UIPlugin
    6. Using Eclipse
  5. Resources
    1. Tutorial
    2. Examples
    3. htSMLM
    4. Javadoc

Cite us

Deschamps, J., Ries, J. EMU: reconfigurable graphical user interfaces for Micro-Manager. BMC Bioinformatics 21, 456 (2020). doi: 10.1186/s12859-020-03727-8

Contact us

By email: joran.deschamps(at)fht(dot)org On image.sc: post and tag @jdeschamps.

Resources

Tutorial

The EMU tutorial offers a detailed walk through of how to build a UI for EMU using a drag and drop software (Eclipse WindowBuilder).

Examples

This repository offers example plugins for EMU:

  • A base plugin to help kick-start a new EMU plugin.
  • A plugin controlling a single iBeamSmart laser (Toptica).
  • A simple UI controlling four lasers and a filterwheel.

Note that the latter two plugins are distributed with EMU in Micro-Manager 2-gamma.

htSMLM

htSMLM is a complex EMU plugin used by the Ries lab (EMBL) to control their automated localization microscopes.

Source-code and javadoc

The Javadoc is available is the EMU repository.

About

Guide to EMU, a Micro-Manager plugin to load easily reconfigurable user interfaces.

https://jdeschamps.github.io/EMU-guide/

License:Other


Languages

Language:Java 100.0%