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.JDialogAHElocal

All Implemented Interfaces:

AlgorithmInterface, ScriptableActionInterface, DialogDefaultsInterface, ActionDiscovery, java.awt.event.ActionListener, java.awt.event.FocusListener, java.awt.event.ItemListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants
```
public class JDialogAHElocal
extends JDialogScriptableBase
implements AlgorithmInterface, ActionDiscovery, ScriptableActionInterface
```
Dialog to get user input, then call the algorithm. The user has the option to generate a new image or replace the source image.
In should be noted, that the algorithms are executed in their own thread.

Version:

1.0; 17 September 2001

Author:

parsonsd, Matthew J. McAuliffe, Ph.D.

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
  javax.swing.JDialog.AccessibleJDialog
- Nested classes/interfaces inherited from class java.awt.Dialog
  java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
- Nested classes/interfaces inherited from class java.awt.Window
  java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type
- Nested classes/interfaces inherited from class java.awt.Container
  java.awt.Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field	Description
`private AlgorithmAHElocal`	`aheAlgo`	DOCUMENT ME!
`private javax.swing.JCheckBox`	`blueBox`
`private javax.swing.JRadioButton`	`CIELabButton`
`private boolean`	`clamp`	DOCUMENT ME!
`private javax.swing.JCheckBox`	`clampCheckBox`	DOCUMENT ME!
`private javax.swing.JLabel`	`clampLabel`	DOCUMENT ME!
`private int`	`clampValue`	DOCUMENT ME!
`private javax.swing.JTextField`	`clampValueText`	DOCUMENT ME!
`private javax.swing.ButtonGroup`	`colorGroup`
`private JPanelColorChannels`	`colorPanel`	DOCUMENT ME!
`private javax.swing.JComboBox`	`comboBoxKernelShape`	DOCUMENT ME!
`private javax.swing.JComboBox`	`comboBoxKernelSize`	DOCUMENT ME!
`private javax.swing.JComboBox`	`comboBoxScaleMax`	DOCUMENT ME!
`private javax.swing.JCheckBox`	`greenBox`
`private ModelImage`	`image`	DOCUMENT ME!
`private int`	`kernelShape`	DOCUMENT ME!
`private int`	`kernelSize`	DOCUMENT ME!
`private float[]`	`Lmax`
`private float[]`	`Lmin`
`private javax.swing.JLabel`	`minThresholdLabel`	DOCUMENT ME!
`private javax.swing.JTextField`	`minThresholdText`	DOCUMENT ME!
`private float`	`minThresholdValue`	DOCUMENT ME!
`private float`	`minThresholdValueL`
`private float`	`minThresholdValueRGB`
`private JPanelAlgorithmOutputOptions`	`outputPanel`	DOCUMENT ME!
`private javax.swing.JCheckBox`	`redBox`
`private ModelImage`	`resultImage`	DOCUMENT ME!
`private javax.swing.JRadioButton`	`RGBButton`
`private int`	`scaleMaxValue`	DOCUMENT ME!
`private static long`	`serialVersionUID`	Use serialVersionUID for interoperability.
`private boolean`	`threshold`	DOCUMENT ME!
`private javax.swing.JCheckBox`	`thresholdCheckBox`	DOCUMENT ME!
`private java.lang.String[]`	`titles`	DOCUMENT ME!
`private boolean`	`useBlue`
`private boolean`	`useCIELab`
`private boolean`	`useGreen`
`private boolean`	`useRed`
`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
`JDialogAHElocal()`	Empty constructor needed for dynamic instantiation (used during scripting).
`JDialogAHElocal(java.awt.Frame theParentFrame, ModelImage im)`	Creates a new JDialogAHElocal object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`actionPerformed(java.awt.event.ActionEvent event)`	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`	`buildClamping(javax.swing.JPanel holder, java.awt.GridBagConstraints gbc, java.awt.GridBagLayout gbl)`	controls the entire creation of the clamping panel and all controls related to the display of the clamping parameter. places the clamping panel into the holder panel.
`private javax.swing.JPanel`	`buildKernelPanel(java.awt.GridBagConstraints gbc, java.awt.GridBagLayout gbl)`	Creates the panel that allow user to select the kernel size and shape of the image when building the histogram.
`protected void`	`buildKernelShape(javax.swing.JPanel holder, java.awt.GridBagConstraints gbc, java.awt.GridBagLayout gbl)`	Creates the comboBox that allows user to define the way the neighboring pixels are chosen for the histogram.
`protected void`	`buildKernelSize(javax.swing.JPanel holder, java.awt.GridBagConstraints gbc, java.awt.GridBagLayout gbl)`	Creates the editable text comboBox that allows user to define the number of neighboring pixels used for the histogram. the number given may only be odd, as this is the total number of pixels chosen on both sides.
`protected void`	`buildScaleMax(javax.swing.JPanel holder, java.awt.GridBagConstraints gbc, java.awt.GridBagLayout gbl)`	define the possibilities of where the scale max comes from.
`protected void`	`buildThreshold(javax.swing.JPanel holder, java.awt.GridBagConstraints gbc, java.awt.GridBagLayout gbl)`	Creates the txt-box that allows user to insert the bottom-end pixels to skip.
`protected void`	`callAlgorithm()`	Once all the necessary variables are set, call the local AHE algorithm based on what type of image this is and whether or not there is a separate destination image.
`private void`	`convertRGBtoCIELab(float[] buffer, float[] L, float[] a, float[] b, float[] Lmin, float[] Lmax)`
`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()`	Used to perform actions after the execution of the algorithm is completed (e.g., put the result image in the image table).
`ActionMetadata`	`getActionMetadata()`	Return meta-information about this discoverable action for categorization and labeling purposes.
`java.lang.String`	`getOutputImageName(java.lang.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.
`protected void`	`makeFloatingPointOnly(javax.swing.JTextField txt)`	Takes a text field, and forces the textfield to accept numbers, backspace and delete-key entries.
`protected void`	`makeNumericsOnly(javax.swing.JTextField txt)`	Takes a text field, and forces the textfield to accept numbers, backspace and delete-key entries.
`void`	`setClampFlag(boolean flag)`	Accessor that sets the clamp flag.
`void`	`setClampingValue(int value)`	Accessor that sets the clamping value.
`protected void`	`setGUIFromParams()`	Set the dialog GUI using the script parameters while running this algorithm as part of a script.
`void`	`setKernelShape(int value)`	Accessor that sets the kernel shape.
`void`	`setKernelSize(int value)`	Accessor that sets the kernel size.
`void`	`setScaleMaxValue(int value)`	Accessor that sets the max scale value (from the combo box).
`void`	`setThresholdFlag(boolean flag)`	Accessor that sets the threshold flag.
`void`	`setThresholdValue(float value)`	Accessor that sets the minThreshold value.
`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

Methods inherited from interface gov.nih.mipav.model.scripting.ScriptableActionInterface
insertScriptLine, scriptRun

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    Use serialVersionUID for interoperability.
    
    See Also:
    
    Constant Field Values
  - aheAlgo
```
private AlgorithmAHElocal aheAlgo
```
    DOCUMENT ME!
  - clamp
```
private boolean clamp
```
    DOCUMENT ME!
  - clampCheckBox
```
private javax.swing.JCheckBox clampCheckBox
```
    DOCUMENT ME!
  - clampLabel
```
private javax.swing.JLabel clampLabel
```
    DOCUMENT ME!
  - clampValue
```
private int clampValue
```
    DOCUMENT ME!
  - clampValueText
```
private javax.swing.JTextField clampValueText
```
    DOCUMENT ME!
  - colorPanel
```
private JPanelColorChannels colorPanel
```
    DOCUMENT ME!
  - comboBoxKernelShape
```
private javax.swing.JComboBox comboBoxKernelShape
```
    DOCUMENT ME!
  - comboBoxKernelSize
```
private javax.swing.JComboBox comboBoxKernelSize
```
    DOCUMENT ME!
  - comboBoxScaleMax
```
private javax.swing.JComboBox comboBoxScaleMax
```
    DOCUMENT ME!
  - image
```
private ModelImage image
```
    DOCUMENT ME!
  - kernelShape
```
private int kernelShape
```
    DOCUMENT ME!
  - kernelSize
```
private int kernelSize
```
    DOCUMENT ME!
  - minThresholdLabel
```
private javax.swing.JLabel minThresholdLabel
```
    DOCUMENT ME!
  - minThresholdText
```
private javax.swing.JTextField minThresholdText
```
    DOCUMENT ME!
  - minThresholdValueL
```
private float minThresholdValueL
```
  - minThresholdValueRGB
```
private float minThresholdValueRGB
```
  - minThresholdValue
```
private float minThresholdValue
```
    DOCUMENT ME!
  - outputPanel
```
private JPanelAlgorithmOutputOptions outputPanel
```
    DOCUMENT ME!
  - resultImage
```
private ModelImage resultImage
```
    DOCUMENT ME!
  - scaleMaxValue
```
private int scaleMaxValue
```
    DOCUMENT ME!
  - threshold
```
private boolean threshold
```
    DOCUMENT ME!
  - thresholdCheckBox
```
private javax.swing.JCheckBox thresholdCheckBox
```
    DOCUMENT ME!
  - titles
```
private java.lang.String[] titles
```
    DOCUMENT ME!
  - userInterface
```
private ViewUserInterface userInterface
```
    DOCUMENT ME!
  - useCIELab
```
private boolean useCIELab
```
  - colorGroup
```
private javax.swing.ButtonGroup colorGroup
```
  - CIELabButton
```
private javax.swing.JRadioButton CIELabButton
```
  - RGBButton
```
private javax.swing.JRadioButton RGBButton
```
  - redBox
```
private javax.swing.JCheckBox redBox
```
  - greenBox
```
private javax.swing.JCheckBox greenBox
```
  - blueBox
```
private javax.swing.JCheckBox blueBox
```
  - useRed
```
private boolean useRed
```
  - useGreen
```
private boolean useGreen
```
  - useBlue
```
private boolean useBlue
```
  - Lmin
```
private float[] Lmin
```
  - Lmax
```
private float[] Lmax
```
- Constructor Detail
  - JDialogAHElocal
```
public JDialogAHElocal()
```
    Empty constructor needed for dynamic instantiation (used during scripting).
  - JDialogAHElocal
```
public JDialogAHElocal(java.awt.Frame theParentFrame,
                       ModelImage im)
```
    Creates a new JDialogAHElocal object.
    
    Parameters:
    
    theParentFrame - Parent frame.
    
    im - Source image.
- Method Detail
  - actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent event)
```
    Closes dialog box when the OK button is pressed and calls the algorithm.
    
    Specified by:
    
    actionPerformed in interface java.awt.event.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.
  - setClampFlag
```
public void setClampFlag(boolean flag)
```
    Accessor that sets the clamp flag.
    
    Parameters:
    
    flag - true indicates clamp, false otherwise.
  - setClampingValue
```
public void setClampingValue(int value)
```
    Accessor that sets the clamping value.
    
    Parameters:
    
    value - Value to set clamping to.
  - setKernelShape
```
public void setKernelShape(int value)
```
    Accessor that sets the kernel shape.
    
    Parameters:
    
    value - Value to set kernel shape to.
  - setKernelSize
```
public void setKernelSize(int value)
```
    Accessor that sets the kernel size.
    
    Parameters:
    
    value - Value to set kernel size to.
  - setScaleMaxValue
```
public void setScaleMaxValue(int value)
```
    Accessor that sets the max scale value (from the combo box).
    
    Parameters:
    
    value - Value to set max scale value to - local, slice, or image.
  - setThresholdFlag
```
public void setThresholdFlag(boolean flag)
```
    Accessor that sets the threshold flag.
    
    Parameters:
    
    flag - true indicates threshold, false otherwise.
  - setThresholdValue
```
public void setThresholdValue(float value)
```
    Accessor that sets the minThreshold value.
    
    Parameters:
    
    value - Value to set minThresholdValue to.
  - buildClamping
```
protected void buildClamping(javax.swing.JPanel holder,
                             java.awt.GridBagConstraints gbc,
                             java.awt.GridBagLayout gbl)
```
    controls the entire creation of the clamping panel and all controls related to the display of the clamping parameter. places the clamping panel into the holder panel.
    
    Parameters:
    
    holder - DOCUMENT ME!
    
    gbc - DOCUMENT ME!
    
    gbl - DOCUMENT ME!
  - buildKernelShape
```
protected void buildKernelShape(javax.swing.JPanel holder,
                                java.awt.GridBagConstraints gbc,
                                java.awt.GridBagLayout gbl)
```
    Creates the comboBox that allows user to define the way the neighboring pixels are chosen for the histogram. The kernel-shape may be
    
    square
    
    cross (shaped like a '+')
    
    builds the label to be used, applies it to the left side of the JPanel holder, then builds the drop-box so the user may make a selection, and applies it to the far-right of the JPanel holder.
    Parameters:
    
    holder - DOCUMENT ME!
    
    gbc - DOCUMENT ME!
    
    gbl - DOCUMENT ME!
  - buildKernelSize
```
protected void buildKernelSize(javax.swing.JPanel holder,
                               java.awt.GridBagConstraints gbc,
                               java.awt.GridBagLayout gbl)
```
    Creates the editable text comboBox that allows user to define the number of neighboring pixels used for the histogram. the number given may only be odd, as this is the total number of pixels chosen on both sides. For any pixel, there are floor(kernelSize/2) pixels in either the horizontal or vertical direction. Alternatively, it describes a box of the number here on a side, for which the pixel in question is at the center. The drop-box has pre-selected:
    
    21
    
    45
    
    65
    
    129
    
    but any odd figure could be entered.
    
    builds the label to be used, applies it to the left side of the JPanel holder, then builds the drop-box so the user may make a selection, and applies it to the far-right of the JPanel holder.
    Parameters:
    
    holder - DOCUMENT ME!
    
    gbc - DOCUMENT ME!
    
    gbl - DOCUMENT ME!
  - buildScaleMax
```
protected void buildScaleMax(javax.swing.JPanel holder,
                             java.awt.GridBagConstraints gbc,
                             java.awt.GridBagLayout gbl)
```
    define the possibilities of where the scale max comes from.
    
    Parameters:
    
    holder - DOCUMENT ME!
    
    gbc - DOCUMENT ME!
    
    gbl - DOCUMENT ME!
  - buildThreshold
```
protected void buildThreshold(javax.swing.JPanel holder,
                              java.awt.GridBagConstraints gbc,
                              java.awt.GridBagLayout gbl)
```
    Creates the txt-box that allows user to insert the bottom-end pixels to skip. Number entered into the textfield is minimum value of the pixels considered. Defaults to the image minimum.
    
    Parameters:
    
    holder - DOCUMENT ME!
    
    gbc - DOCUMENT ME!
    
    gbl - DOCUMENT ME!
  - convertRGBtoCIELab
```
private void convertRGBtoCIELab(float[] buffer,
                                float[] L,
                                float[] a,
                                float[] b,
                                float[] Lmin,
                                float[] Lmax)
```
  - callAlgorithm
```
protected void callAlgorithm()
```
    Once all the necessary variables are set, call the local AHE 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
    
    See Also:
    
    AlgorithmAHElocal
  - doPostAlgorithmActions
```
protected void doPostAlgorithmActions()
```
    Used to perform actions after the execution of the algorithm is completed (e.g., put the result image in the image table). Defaults to no action, override to actually have it do something.
    
    Overrides:
    
    doPostAlgorithmActions in class JDialogScriptableBase
  - makeFloatingPointOnly
```
protected void makeFloatingPointOnly(javax.swing.JTextField txt)
```
    Takes a text field, and forces the textfield to accept numbers, backspace and delete-key entries.
    
    Parameters:
    
    txt - Text field to modify.
  - makeNumericsOnly
```
protected void makeNumericsOnly(javax.swing.JTextField txt)
```
    Takes a text field, and forces the textfield to accept numbers, backspace and delete-key entries.
    
    Parameters:
    
    txt - Text field to modify.
  - 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
  - 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.
  - buildKernelPanel
```
private javax.swing.JPanel buildKernelPanel(java.awt.GridBagConstraints gbc,
                                            java.awt.GridBagLayout gbl)
```
    Creates the panel that allow user to select the kernel size and shape of the image when building the histogram. Contains clamping attributes.
    
    Parameters:
    
    gbc - DOCUMENT ME!
    
    gbl - DOCUMENT ME!
    
    Returns:
    
    the panel that allows setting kernel attributes
  - 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 java.lang.String getOutputImageName(java.lang.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.

Class JDialogAHElocal

Nested Class Summary

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

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

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

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

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

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

Field Summary

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

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

Fields inherited from class javax.swing.JDialog

Fields inherited from class java.awt.Dialog

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Fields inherited from interface javax.swing.WindowConstants

Constructor Summary

Method Summary

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

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

Methods inherited from class javax.swing.JDialog

Methods inherited from class java.awt.Dialog

Methods inherited from class java.awt.Window

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nih.mipav.model.scripting.ScriptableActionInterface

Field Detail

serialVersionUID

aheAlgo

clamp

clampCheckBox

clampLabel

clampValue

clampValueText

colorPanel

comboBoxKernelShape

comboBoxKernelSize

comboBoxScaleMax

image

kernelShape

kernelSize

minThresholdLabel

minThresholdText

minThresholdValueL

minThresholdValueRGB

minThresholdValue

outputPanel

resultImage

scaleMaxValue

threshold

thresholdCheckBox

titles

userInterface

useCIELab

colorGroup

CIELabButton

RGBButton

redBox

greenBox

blueBox

useRed

useGreen

useBlue

Lmin

Lmax

Constructor Detail

JDialogAHElocal

JDialogAHElocal

Method Detail

actionPerformed

algorithmPerformed

getResultImage

setClampFlag

setClampingValue

setKernelShape

setKernelSize

setScaleMaxValue

setThresholdFlag