org.shapelogic.imageutil
Class BaseImageOperation

java.lang.Object
  org.shapelogic.imageutil.BaseImageOperation

All Implemented Interfaces:

java.lang.Runnable, ImageOperation

Direct Known Subclasses:

BaseParticleCounter, BaseVectorizer, DistanceBasedColorHypothesisFinder, PixelHandlerOperation, SegmentCounter

public abstract class BaseImageOperation
extends java.lang.Object
implements ImageOperation

Class to subclass when writing filters.

Author:

Sami Badawi

Field Summary

protected java.lang.String	_arg This is an argument with information about what should be run.
protected GuiWrapper	_guiWrapper
protected SLImage	_image
protected KeyValueParser	_keyValueParser
protected int	_setupReturnValue

Constructor Summary

BaseImageOperation()

BaseImageOperation(int setupReturnValue)

BaseImageOperation(int setupReturnValue, SLImage imp)

BaseImageOperation(int setupReturnValue, java.lang.String arg, SLImage imp)

BaseImageOperation(SLImage imp)

Method Summary

GuiWrapper	getGuiWrapper()
SLImage	getImage() How to get the SLImage in run().
KeyValueParser	getKeyValueParser()
int	getSetupReturnValue()
boolean	isImageValid() Filter capability is encoded in _setupReturnValue compare it to the type input image. XXX This is not fully implemented yet.
void	setArg(java.lang.String arg)
void	setGuiWrapper(GuiWrapper guiWrapper) If you want the object to write to a GUI, set a GUIWrapper.
void	setKeyValueParser(KeyValueParser keyValueParser)
void	setSetupReturnValue(int setupReturnValue)
int	setup(java.lang.String arg, SLImage image) If you are using the ImageOperation to fit into a ImageJ PlugInFilter use this to instantiate arg and image.
java.lang.String	showAbout()
void	showMessage(java.lang.String title, java.lang.String text) This wrapper only implement displaying a simple text string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Runnable

run

Field Detail

_image

protected SLImage _image

_guiWrapper

protected GuiWrapper _guiWrapper

_arg

protected java.lang.String _arg

This is an argument with information about what should be run.

_setupReturnValue

protected int _setupReturnValue

_keyValueParser

protected KeyValueParser _keyValueParser

Constructor Detail

BaseImageOperation

public BaseImageOperation(int setupReturnValue,
                          java.lang.String arg,
                          SLImage imp)

BaseImageOperation

public BaseImageOperation(int setupReturnValue,
                          SLImage imp)

BaseImageOperation

public BaseImageOperation(SLImage imp)

BaseImageOperation

public BaseImageOperation(int setupReturnValue)

BaseImageOperation

public BaseImageOperation()

Method Detail

getImage

public SLImage getImage()

Description copied from interface: ImageOperation

How to get the SLImage in run().

Specified by:

getImage in interface ImageOperation

setup

public int setup(java.lang.String arg,
                 SLImage image)

If you are using the ImageOperation to fit into a ImageJ PlugInFilter use this to instantiate arg and image.

Specified by:

setup in interface ImageOperation

showMessage

public void showMessage(java.lang.String title,
                        java.lang.String text)

Description copied from interface: ImageOperation

This wrapper only implement displaying a simple text string.

Specified by:

showMessage in interface ImageOperation

setGuiWrapper

public void setGuiWrapper(GuiWrapper guiWrapper)

Description copied from interface: ImageOperation

If you want the object to write to a GUI, set a GUIWrapper.

Specified by:

setGuiWrapper in interface ImageOperation

getGuiWrapper

public GuiWrapper getGuiWrapper()

Specified by:

getGuiWrapper in interface ImageOperation

isImageValid

public boolean isImageValid()

Filter capability is encoded in _setupReturnValue compare it to the type input image.
XXX This is not fully implemented yet.

Specified by:

isImageValid in interface ImageOperation

getSetupReturnValue

public int getSetupReturnValue()

Specified by:

getSetupReturnValue in interface ImageOperation

setSetupReturnValue

public void setSetupReturnValue(int setupReturnValue)

Specified by:

setSetupReturnValue in interface ImageOperation

showAbout

public java.lang.String showAbout()

Specified by:

showAbout in interface ImageOperation

getKeyValueParser

public KeyValueParser getKeyValueParser()

Specified by:

getKeyValueParser in interface ImageOperation

setKeyValueParser

public void setKeyValueParser(KeyValueParser keyValueParser)

Specified by:

setKeyValueParser in interface ImageOperation

setArg

public void setArg(java.lang.String arg)

Specified by:

setArg in interface ImageOperation