org.youscope.uielements

Class HistogramPlot

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.youscope.uielements.HistogramPlot

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class HistogramPlot
extends javax.swing.JPanel

A plot showing a histogram.

Author:

langmo

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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 inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, 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

Constructor Summary

Constructors

Constructor and Description
HistogramPlot() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(java.awt.event.ActionListener listener) Adds an action listener which gets notified if the histogram range changed.
void	adjust() Automatically adjusts the minimal and maximal value of the histogram to reasonable values.
double	getLowerAdjustmentCuttoff() Returns the percentage of pixels (0 <= lowerAdjustmentCuttoff < 1) which is set in the auto-adjustment to be black.
double[]	getMinMax() Returns an array with two elements, where the first element is the selected minimum and the second the selected maximum.
double	getUpperAdjustmentCuttoff() Returns the percentage of pixels (0 <= upperAdjustmentCuttoff < 1) which is set in the auto-adjustment to be white.
void	paintComponent(java.awt.Graphics grp)
void	removeActionListener(java.awt.event.ActionListener listener) Removes a previously added listener.
void	setAutoAdjusting(boolean autoAdjusting) Sets if the lower and upper cuttoffs are adjusting automatically.
void	setAutoAdjustmentCuttoffs(double lowerAdjustmentCuttoff, double upperAdjustmentCuttoff) Sets the amount of pixels (in percent) which is set to black (lowerAdjustmentCuttoff) and white (upperAdjustmentCuttoff) in the auto-adjustment algorithm.
void	setBins(int[][] bins) Sets the histogram data.
void	setMinMax(double min, double max) Sets the minimum and the maximum of the histogram (in percentage of the total length).

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

HistogramPlot

public HistogramPlot()

Constructor.

Method Detail

addActionListener

public void addActionListener(java.awt.event.ActionListener listener)

Adds an action listener which gets notified if the histogram range changed.

Parameters:

listener - Listener for histogram range.

removeActionListener

public void removeActionListener(java.awt.event.ActionListener listener)

Removes a previously added listener.

Parameters:

listener - listener to remove.

setAutoAdjustmentCuttoffs

public void setAutoAdjustmentCuttoffs(double lowerAdjustmentCuttoff,
                                      double upperAdjustmentCuttoff)

Sets the amount of pixels (in percent) which is set to black (lowerAdjustmentCuttoff) and white (upperAdjustmentCuttoff) in the auto-adjustment algorithm. It has to be given that 0 <= lowerAdjustmentCuttoff < 1 0 <= upperAdjustmentCuttoff < 1 lowerAdjustmentCuttoff + upperAdjustmentCuttoff < 1

Parameters:

lowerAdjustmentCuttoff - The percentage of pixels which gets set to be black.

upperAdjustmentCuttoff - The percentage of pixels which gets set to be white.

Throws:

java.lang.IllegalArgumentException - Thrown if the bounds for the arguments are violated.

getLowerAdjustmentCuttoff

public double getLowerAdjustmentCuttoff()

Returns the percentage of pixels (0 <= lowerAdjustmentCuttoff < 1) which is set in the auto-adjustment to be black.

Returns:

Amount of pixels which is set to black in auto-adjustment.

getUpperAdjustmentCuttoff

public double getUpperAdjustmentCuttoff()

Returns the percentage of pixels (0 <= upperAdjustmentCuttoff < 1) which is set in the auto-adjustment to be white.

Returns:

Amount of pixels which is set to white in auto-adjustment.

setAutoAdjusting

public void setAutoAdjusting(boolean autoAdjusting)

Sets if the lower and upper cuttoffs are adjusting automatically.

Parameters:

autoAdjusting -

getMinMax

public double[] getMinMax()

Returns an array with two elements, where the first element is the selected minimum and the second the selected maximum.

Returns:

Minimum and maximum.

setMinMax

public void setMinMax(double min,
                      double max)

Sets the minimum and the maximum of the histogram (in percentage of the total length). This method is thread save.

Parameters:

min - Minimum of the histogram cutoff (0-1)

max - Maximum of the histogram cutoff (0-1)

setBins

public void setBins(int[][] bins)

Sets the histogram data.

Parameters:

bins - The bins of the histogram.

adjust

public void adjust()

Automatically adjusts the minimal and maximal value of the histogram to reasonable values.

paintComponent

public void paintComponent(java.awt.Graphics grp)

Overrides:

paintComponent in class javax.swing.JComponent