Package com.xinapse.apps.active

Class SelectableROICalculation

java.lang.Object

com.xinapse.apps.active.SelectableROICalculation

All Implemented Interfaces:

ROICalculation

public abstract class SelectableROICalculation
extends Object
implements ROICalculation

An interface implemented by classes that can perform calculations on propagated ROIs.

Nested Class Summary

Nested classes/interfaces inherited from interface com.xinapse.apps.active.ROICalculation

ROICalculation.SpecifierPanel

Constructor Summary

Constructors

Constructor	Description
SelectableROICalculation()	Default constructor for use by sub-classes.

Method Summary

Modifier and Type	Method	Description
static org.apache.commons.cli.Option[]	getCalcOptions()	Returns an array of Options that are used with the ROICalculation.
static ROICalculation	getInstance()	Returns an instance of this ROICalculation.
static String	getOptionName()	Returns the option name for selecting this ROI calculation method.
abstract ROICalculation.SpecifierPanel	getSpecifierPanel(com.xinapse.apps.active.ROIPropagateFrame parentFrame, String preferencesNodeName)	Returns a ROICalculation.SpecifierPanel that can be used to select and specify a SelectableROICalculation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xinapse.apps.active.ROICalculation

doCalc, getCalculationDescription, getCalculationName

Constructor Details

SelectableROICalculation

public SelectableROICalculation()

Default constructor for use by sub-classes.

Method Details

getOptionName

public static String getOptionName()

Returns the option name for selecting this ROI calculation method.

Must be overridden.

Returns:

the option name of this ROI calcualtion method.

getCalcOptions

public static org.apache.commons.cli.Option[] getCalcOptions()

Returns an array of Options that are used with the ROICalculation.

Must be overridden.

Returns:

an array of Options that are used with the ROICalculation.

getInstance

public static ROICalculation getInstance()

Returns an instance of this ROICalculation.

Must be overridden.

Returns:

an instance of the ROICalculation.

getSpecifierPanel

public abstract ROICalculation.SpecifierPanel getSpecifierPanel(com.xinapse.apps.active.ROIPropagateFrame parentFrame,
 String preferencesNodeName)

Returns a ROICalculation.SpecifierPanel that can be used to select and specify a SelectableROICalculation.

Parameters:

parentFrame - the parent frame in which the panel will be embedded.

preferencesNodeName - the Preferences node name used if the panel has its initial settings set from user preferences, or its settings are save to user Preferences.

Returns:

a ROICalculation.SpecifierPanel that can be used to select and specify a SelectableROICalculation.