Package gov.nih.mipav.view.dialogs

Class JDialogEntropyMinimization

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

gov.nih.mipav.view.dialogs.JDialogBase

gov.nih.mipav.view.dialogs.JDialogScriptableBase

gov.nih.mipav.view.dialogs.JDialogEntropyMinimization

All Implemented Interfaces:

AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

public class JDialogEntropyMinimization
extends JDialogScriptableBase
implements AlgorithmInterface, ActionDiscovery

DOCUMENT ME!

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class gov.nih.mipav.view.dialogs.JDialogBase

JDialogBase.CancelAction, JDialogBase.HelpAction, JDialogBase.OKAction

Nested classes/interfaces inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
private int	displayLoc	DOCUMENT ME!
private AlgorithmEntropyMinimization	emAlgo	DOCUMENT ME!
private ModelImage	image	DOCUMENT ME!
private JRadioButton	m2Button	DOCUMENT ME!
private JRadioButton	m3Button	DOCUMENT ME!
private JRadioButton	ma2Button	DOCUMENT ME!
private JRadioButton	newImage	DOCUMENT ME!
private ButtonGroup	noiseGroup	DOCUMENT ME!
private int	noiseType	DOCUMENT ME!
private JRadioButton	replaceImage	DOCUMENT ME!
private ModelImage	resultImage	DOCUMENT ME!
private static final long	serialVersionUID	Use serialVersionUID for interoperability.
private boolean	subsample	DOCUMENT ME!
private JCheckBox	subsampleCheckbox	DOCUMENT ME!
private JCheckBox	thresholdCheckbox	DOCUMENT ME!
private JLabel	thresholdLabel	DOCUMENT ME!
private float	thresholdLevel	DOCUMENT ME!
private boolean	thresholdSelected	DOCUMENT ME!
private JTextField	thresholdText	DOCUMENT ME!
private String[]	titles	DOCUMENT ME!
private ViewUserInterface	userInterface	DOCUMENT ME!

Fields inherited from class gov.nih.mipav.view.dialogs.JDialogScriptableBase

displayInNewFrame, isComplete, scriptParameters

Fields inherited from class gov.nih.mipav.view.dialogs.JDialogBase

applyButton, bar, cancelButton, cancelFlag, closeButton, HELP, helpButton, mainDialogPanel, NEW, OKButton, parentFrame, progressBar, REPLACE, runInSeparateThread, runningScriptFlag, runQuiet, serif12, serif12B, voiManager

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
JDialogEntropyMinimization()	Empty constructor needed for dynamic instantiation (used during scripting).
JDialogEntropyMinimization(Frame theParentFrame, ModelImage im)	Creates new dialog for entering parameters for entropy minimization.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent event)	actionPerformed - Closes dialog box when the OK button is pressed and calls the algorithm.
void	algorithmPerformed(AlgorithmBase algorithm)	This method is required if the AlgorithmPerformed interface is implemented.
protected void	callAlgorithm()	Once all the necessary variables are set, call the Entropy Minimization algorithm based on what type of image this is and whether or not there is a separate destination image.
ParameterTable	createInputParameters()	Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in setGUIFromParams()).
ParameterTable	createOutputParameters()	Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).
protected void	doPostAlgorithmActions()	Store the result image in the script runner's image table now that the action execution is finished.
ActionMetadata	getActionMetadata()	Return meta-information about this discoverable action for categorization and labeling purposes.
String	getOutputImageName(String imageParamName)	Returns the name of an image output by this algorithm, the image returned depends on the parameter label given (which can be used to retrieve the image object from the image registry).
ModelImage	getResultImage()	Accessor that returns the image.
private void	init()	Sets up the GUI (panels, buttons, etc) and displays it on the screen.
boolean	isActionComplete()	Returns whether the action has successfully completed its execution.
void	setDisplayLocNew()	Accessor that sets the display loc variable to new, so that a new image is created once the algorithm completes.
void	setDisplayLocReplace()	Accessor that sets the display loc variable to replace, so the current image is replaced once the algorithm completes.
protected void	setGUIFromParams()	Set the dialog GUI using the script parameters while running this algorithm as part of a script.
void	setNoiseType(int noiseType)	Accessor that sets noiseType variable.
void	setSubsample(boolean subsample)	Accessor that sets the subsample variable.
void	setThresholdLevel(float thresholdLevel)	Accessor that sets the thresholdLevel variable.
void	setThresholdSelected(boolean thresholdSelected)	Accessor that sets the thresholdSelected variable.
private boolean	setVariables()	Use the GUI results to set up the variables needed to run the algorithm.
protected void	storeParamsFromGUI()	Record the parameters just used to run this algorithm in a script.

Methods inherited from class gov.nih.mipav.view.dialogs.JDialogScriptableBase

getDialogActionString, insertScriptLine, isComplete, scriptRun, setComplete

Methods inherited from class gov.nih.mipav.view.dialogs.JDialogBase

buildApplyButton, buildButtons, buildCancelButton, buildCancelButton, buildCloseButton, buildHelpButton, buildImageComboBox, buildOKButton, buildOKButton, buildOKCancelButtons, buildTitledBorder, buildTitledBorder, createLabel, createProgressBar, createProgressBar, createTextField, focusGained, focusLost, getDialogName, isCancelled, isQuietRunning, isRunInSeparateThread, isScriptRunning, itemStateChanged, loadDefaults, loadDefaults, makeImageName, makeString, openNewFrame, saveDefaults, saveDefaults, setLeftHandSystem, setQuietRunning, setScriptRunning, setSeparateThread, setVisible, setVisible, setVisibleMenuBar, setVisibleStandard, setVOIManager, setWCSystem, testParameter, testParameterMin, updateFFTFileInfo, updateFileInfo, updateFileInfoOtherModality, updateFileInfoStatic, updateFileInfoStatic, updateFileTypeInfo, updateFileTypeInfo, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nih.mipav.view.dialogs.ActionDiscovery

scriptRun

Field Details

serialVersionUID

private static final long serialVersionUID

Use serialVersionUID for interoperability.

See Also:

• Constant Field Values

displayLoc

private int displayLoc

DOCUMENT ME!

emAlgo

private AlgorithmEntropyMinimization emAlgo

DOCUMENT ME!

image

private ModelImage image

DOCUMENT ME!

m2Button

private JRadioButton m2Button

DOCUMENT ME!

m3Button

private JRadioButton m3Button

DOCUMENT ME!

ma2Button

private JRadioButton ma2Button

DOCUMENT ME!

newImage

private JRadioButton newImage

DOCUMENT ME!

noiseGroup

private ButtonGroup noiseGroup

DOCUMENT ME!

noiseType

private int noiseType

DOCUMENT ME!

replaceImage

private JRadioButton replaceImage

DOCUMENT ME!

resultImage

private ModelImage resultImage

DOCUMENT ME!

subsample

private boolean subsample

DOCUMENT ME!

subsampleCheckbox

private JCheckBox subsampleCheckbox

DOCUMENT ME!

thresholdCheckbox

private JCheckBox thresholdCheckbox

DOCUMENT ME!

thresholdLabel

private JLabel thresholdLabel

DOCUMENT ME!

thresholdLevel

private float thresholdLevel

DOCUMENT ME!

thresholdSelected

private boolean thresholdSelected

DOCUMENT ME!

thresholdText

private JTextField thresholdText

DOCUMENT ME!

titles

private String[] titles

DOCUMENT ME!

userInterface

private ViewUserInterface userInterface

DOCUMENT ME!

Constructor Details

JDialogEntropyMinimization

public JDialogEntropyMinimization()

Empty constructor needed for dynamic instantiation (used during scripting).

JDialogEntropyMinimization

public JDialogEntropyMinimization(Frame theParentFrame,
 ModelImage im)

Creates new dialog for entering parameters for entropy minimization.

Parameters:

theParentFrame - Parent frame

im - Source image

Method Details

storeParamsFromGUI

protected void storeParamsFromGUI()
                           throws ParserException

Record the parameters just used to run this algorithm in a script.

Specified by:

storeParamsFromGUI in class JDialogScriptableBase

Throws:

ParserException - If there is a problem creating/recording the new parameters.

setGUIFromParams

protected void setGUIFromParams()

Set the dialog GUI using the script parameters while running this algorithm as part of a script.

Specified by:

setGUIFromParams in class JDialogScriptableBase

doPostAlgorithmActions

protected void doPostAlgorithmActions()

Store the result image in the script runner's image table now that the action execution is finished.

Overrides:

doPostAlgorithmActions in class JDialogScriptableBase

actionPerformed

public void actionPerformed(ActionEvent event)

actionPerformed - Closes dialog box when the OK button is pressed and calls the algorithm.

Specified by:

actionPerformed in interface ActionListener

Overrides:

actionPerformed in class JDialogBase

Parameters:

event - event that triggers function

algorithmPerformed

public void algorithmPerformed(AlgorithmBase algorithm)

This method is required if the AlgorithmPerformed interface is implemented. It is called by the algorithms when it has completed or failed to to complete, so that the dialog can be display the result image and/or clean up.

Specified by:

algorithmPerformed in interface AlgorithmInterface

Parameters:

algorithm - Algorithm that caused the event.

getResultImage

public ModelImage getResultImage()

Accessor that returns the image.

Returns:

the result image

setDisplayLocNew

public void setDisplayLocNew()

Accessor that sets the display loc variable to new, so that a new image is created once the algorithm completes.

setDisplayLocReplace

public void setDisplayLocReplace()

Accessor that sets the display loc variable to replace, so the current image is replaced once the algorithm completes.

setNoiseType

public void setNoiseType(int noiseType)

Accessor that sets noiseType variable.

Parameters:

noiseType - int

setSubsample

public void setSubsample(boolean subsample)

Accessor that sets the subsample variable.

Parameters:

subsample - boolean

setThresholdLevel

public void setThresholdLevel(float thresholdLevel)

Accessor that sets the thresholdLevel variable.

Parameters:

thresholdLevel - float

setThresholdSelected

public void setThresholdSelected(boolean thresholdSelected)

Accessor that sets the thresholdSelected variable.

Parameters:

thresholdSelected - boolean

callAlgorithm

protected void callAlgorithm()

Once all the necessary variables are set, call the Entropy Minimization algorithm based on what type of image this is and whether or not there is a separate destination image.

Specified by:

callAlgorithm in class JDialogScriptableBase

init

private void init()

Sets up the GUI (panels, buttons, etc) and displays it on the screen.

setVariables

private boolean setVariables()

Use the GUI results to set up the variables needed to run the algorithm.

Returns:

true if parameters set successfully, false otherwise.

getActionMetadata

public ActionMetadata getActionMetadata()

Return meta-information about this discoverable action for categorization and labeling purposes.

Specified by:

getActionMetadata in interface ActionDiscovery

Returns:

Metadata for this action.

createInputParameters

public ParameterTable createInputParameters()

Returns a table listing the input parameters of this algorithm (which should match up with the scripting parameters used in setGUIFromParams()).

Specified by:

createInputParameters in interface ActionDiscovery

Returns:

A parameter table listing the inputs of this algorithm.

createOutputParameters

public ParameterTable createOutputParameters()

Returns a table listing the output parameters of this algorithm (usually just labels used to obtain output image names later).

Specified by:

createOutputParameters in interface ActionDiscovery

Returns:

A parameter table listing the outputs of this algorithm.

getOutputImageName

public String getOutputImageName(String imageParamName)

Returns the name of an image output by this algorithm, the image returned depends on the parameter label given (which can be used to retrieve the image object from the image registry).

Specified by:

getOutputImageName in interface ActionDiscovery

Parameters:

imageParamName - The output image parameter label for which to get the image name.

Returns:

The image name of the requested output image parameter label.

isActionComplete

public boolean isActionComplete()

Returns whether the action has successfully completed its execution.

Specified by:

isActionComplete in interface ActionDiscovery

Returns:

True, if the action is complete. False, if the action failed or is still running.