Package com.github.celldynamics.quimp.plugin

This package contains interfaces that define QuimP plugins.

See: Description

Interface Summary

Interface	Description
IQuimpCorePlugin	General definition of plugin interface for QuimP.
IQuimpFilter	Interface for plugin filter used in QuimP Bar.
IQuimpNestPlugin	This core plugin accepts Nest as input and can modify it.
IQuimpPlugin	Interface for plugins used in QuimP Bar.
IQuimpPluginAttachImage	Allow to attach image to filter.
IQuimpPluginAttachImagePlus	Allow to attach image plus to filter.
IQuimpPluginAttachNest	Allow to attach Nest to filter.
IQuimpPluginExchangeData	Allow to attach upload and download configuration from plugin.
IQuimpPluginFilter	This interface supports plugins used in QuimP Bar.
IQuimpPluginSynchro	The interface that add synchronisation between plugin and QuimP.

Class Summary

Class	Description
AbstractOptionsParser	This is template allows for serialize/deserialize plugin options to/from macro string.
AbstractPluginBase	Base template of QuimP (legacy Fiji compatible) plugins.
AbstractPluginOptions	This abstract class serves basic methods for processing parameters strings specified in macros.
AbstractPluginQconf	Template of plugin focused at processing QCONF/paQP files.
AbstractPluginTemplate	General purpose plugin template for UI plugins.
ParamList	List of parameters in [key,value] HashList, where both key and value are java.lang.String and key is case insensitive.

Exception Summary

Exception	Description
QuimpPluginException	Basic class derived from Exception for purposes of QuimP plugins.

Annotation Types Summary

Annotation Type	Description
EscapedPath	This annotation denotes that annotated field will be escaped by specified symbols.

Package com.github.celldynamics.quimp.plugin Description

This package contains interfaces that define QuimP plugins. There are two kinds of Quimp plugins:

1. Utilised by BOA module - those must implement IQuimpBOAPoint2dFilter or IQuimpBOASnakeFilter
2. General purpose plugins - they constitute extensible QuimP Toolbar. They implement IQuimpPlugin

General purpose plugins differ from standard IJ plugins based only on PlugInFilter or PlugIn interfaces (those are extended by IQuimpPlugin and IQuimpPluginFilter respectively. General purpose plugins are meant to be used with QCONF file platform. If plugin works like standard IJ plugin it should implement only IJ interfaces or IQuimp interfaces but it can be based on e.g. AbstractOptionsParser. General plugins can be run from IJ macro scripts thus they also implement PlugIn interface (via IQuimpPlugin), thus their architecture should follow IJ guidelines:

1. Default constructor should do nothing for running the plugin
2. Other constructor are allowed, for example for testing
3. The main runner is PlugIn.run(String) method. Input parameter for PlugIn.run(String)can be used for passing parameters from e.g. parameterised constructor. It is not that parameter that contain options given in IJ macro scripts. It can be epmty or null.
4. Plugin should be able to run with options given in IJ macro - in this case without UI and with showing all messages in console.

Plugin template

Abstract class AbstractOptionsParser contains basic code that supports macros and calls from UI. Only for plugins that interfere with QCONF platform

Author:

p.baniukiewicz