adams.data.imagej.transformer
Class Command

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.image.AbstractImageTransformer<ImagePlusContainer>
              adams.data.imagej.transformer.AbstractImageJTransformer
                  adams.data.imagej.transformer.Command

All Implemented Interfaces:

CleanUpHandler, Debuggable, Destroyable, OptionHandler, SizeOfHandler, Serializable, Comparable

public class Command
extends AbstractImageJTransformer

A transformer that allows the execution of ImageJ commands.
Note(s):
- the options for the command can be obtained when recording macros
in ImageJ

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-command <java.lang.String> (property: command)
    The ImageJ command to execute.
    default: Add Specified Noise...
 

-command-options <java.lang.String> (property: commandOptions)
    The options for the command (not all commands take options).
    default: standard=25
 

Version:

$Revision: 4753 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected String	m_Command the command to run.
protected String	m_CommandOptions the options for the command.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

Command()

Method Summary

void	cleanUp() Cleans up data structures, frees up memory.
String	commandOptionsTipText() Returns the tip text for this property.
String	commandTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
protected ImagePlusContainer[]	doTransform(ImagePlusContainer img) Performs no transformation at all, just returns the input.
String	getCommand() Returns the command to execute.
String	getCommandOptions() Returns the options for the command.
String	globalInfo() Returns a string describing the object.
void	setCommand(String value) Sets the command to execute.
void	setCommandOptions(String value) Sets the options for the command.

Methods inherited from class adams.data.imagej.transformer.AbstractImageJTransformer

checkImage, forCommandLine, forName, getTransformations

Methods inherited from class adams.data.image.AbstractImageTransformer

compareTo, destroy, equals, shallowCopy, shallowCopy, transform

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Field Detail

m_Command

protected String m_Command

the command to run.

m_CommandOptions

protected String m_CommandOptions

the options for the command.

Constructor Detail

Command

public Command()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setCommand

public void setCommand(String value)

Sets the command to execute.

Parameters:

value - the command

getCommand

public String getCommand()

Returns the command to execute.

Returns:

the command

commandTipText

public String commandTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setCommandOptions

public void setCommandOptions(String value)

Sets the options for the command.

Parameters:

value - the options

getCommandOptions

public String getCommandOptions()

Returns the options for the command.

Returns:

the options

commandOptionsTipText

public String commandOptionsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

doTransform

protected ImagePlusContainer[] doTransform(ImagePlusContainer img)

Performs no transformation at all, just returns the input.

Specified by:

doTransform in class AbstractImageTransformer<ImagePlusContainer>

Parameters:

img - the image to process (can be modified, since it is a copy)

Returns:

the copy of the image

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface CleanUpHandler

Overrides:

cleanUp in class AbstractImageTransformer<ImagePlusContainer>