org.micromanager.data

Interface ProcessorPlugin

All Superinterfaces:

MMGenericPlugin, MMPlugin, org.scijava.plugin.SciJavaPlugin

public interface ProcessorPlugin
extends MMPlugin

A ProcessorPlugin is the "root" class for creating Processors, which are used to modify images as they are collected by Micro-Manager. This base class provides access to the various components that allow for creation and configuration of Processors.

Method Summary

Modifier and Type	Method and Description
ProcessorConfigurator	createConfigurator(PropertyMap settings) Generate any GUI needed to configure the plugin, using the provided settings to initialize the GUI.
ProcessorFactory	createFactory(PropertyMap settings) Generate a ProcessorFactory that can be used to generate Processor instances.

Methods inherited from interface org.micromanager.MMPlugin

getCopyright, getHelpText, getName, getVersion, setContext

Method Detail

createConfigurator

ProcessorConfigurator createConfigurator(PropertyMap settings)

Generate any GUI needed to configure the plugin, using the provided settings to initialize the GUI. Note that the provided settings may be empty but will never be null.

Parameters:

settings - Default values to use to set up the configurator.

Returns:

a PluginConfigurator object used to set parameters for the plugin. This should be a new object each time this method is called.

createFactory

ProcessorFactory createFactory(PropertyMap settings)

Generate a ProcessorFactory that can be used to generate Processor instances. The ProcessorFactory should not refer to any external objects; everything it needs to know should be contained within the passed-in PropertyMap.

Parameters:

settings - The settings used to configure the factory. These settings may have been generated by a PluginConfigurator.

Returns:

a ProcessorFactory based on the provided settings.