theba.core.Plugin Interface Reference

List of all members.

Public Member Functions
void	setup (ThebaGUI f)
void	process (Stack stack)
String	getName ()
String	getAbout ()
String	getCategory ()

---

Detailed Description

Definition at line 5 of file Plugin.java.

---

Member Function Documentation

String theba.core.Plugin.getAbout

(

)

This function returns a short description of this plugin

Returns:

A description of this plugin

Implemented in theba.plugins.Dilate3DPlugin, theba.plugins.DilatePlugin, theba.plugins.DistanceMap2DPlugin, theba.plugins.DistanceMapPlugin, theba.plugins.Erode3DPlugin, theba.plugins.ErodePlugin, theba.plugins.Median3DPlugin, and theba.plugins.WatershedPlugin.

String theba.core.Plugin.getCategory

(

)

Returns a general gategory for this plugion, plugins in the same category will be grouped on the menus, if this function returns null the plugin will be placed on the root-menu

Returns:

A category description or null if none

Implemented in theba.plugins.Dilate3DPlugin, theba.plugins.DilatePlugin, theba.plugins.DistanceMap2DPlugin, theba.plugins.DistanceMapPlugin, theba.plugins.Erode3DPlugin, theba.plugins.ErodePlugin, theba.plugins.Median3DPlugin, and theba.plugins.WatershedPlugin.

String theba.core.Plugin.getName

(

)

This function returns the name of this plugin

Returns:

The (menu)-name of this plugin

Implemented in theba.plugins.Dilate3DPlugin, theba.plugins.DilatePlugin, theba.plugins.DistanceMap2DPlugin, theba.plugins.DistanceMapPlugin, theba.plugins.Erode3DPlugin, theba.plugins.ErodePlugin, theba.plugins.Median3DPlugin, and theba.plugins.WatershedPlugin.

Referenced by theba.core.gui.ThebaGUI.actionPerformed().

void theba.core.Plugin.process

(

Stack

stack

)

This function is called when the user selects this plugin for execution on the current volume

Parameters:

stack

Implemented in theba.plugins.Dilate3DPlugin, theba.plugins.DilatePlugin, theba.plugins.DistanceMap2DPlugin, theba.plugins.DistanceMapPlugin, theba.plugins.Erode3DPlugin, theba.plugins.ErodePlugin, theba.plugins.Median3DPlugin, and theba.plugins.WatershedPlugin.

void theba.core.Plugin.setup

(

ThebaGUI

f

)

This function is called once for each plugin, to enable some parameters to be initialized

Parameters:

f

The control instance that created this plugin ( gives access to progressbars etc)

Implemented in theba.plugins.Dilate3DPlugin, theba.plugins.DilatePlugin, theba.plugins.DistanceMap2DPlugin, theba.plugins.DistanceMapPlugin, theba.plugins.Erode3DPlugin, theba.plugins.ErodePlugin, theba.plugins.Median3DPlugin, and theba.plugins.WatershedPlugin.

---

The documentation for this interface was generated from the following file:

• src/theba/core/Plugin.java