icy.gui.component.math

Class HistogramPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

icy.gui.component.BorderedPanel

icy.gui.component.math.HistogramPanel

All Implemented Interfaces:

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

Direct Known Subclasses:

HistogramPanel, ScalerViewer.ScalerHistogramPanel

public class HistogramPanel
extends BorderedPanel

Histogram component.

Author:

Stephane

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HistogramPanel.HistogramPanelListener

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

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

Constructor Summary

Constructors

Constructor and Description
HistogramPanel(double minValue, double maxValue, boolean integer) Create a new histogram panel for the specified value range.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(HistogramPanel.HistogramPanelListener l)
void	addValue(double value) Deprecated. Use getHistogram.addValue(double) instead.
void	addValues(byte[] array, boolean signed) Deprecated. Use getHistogram.addValue(byte[]) instead.
void	addValues(double[] array) Deprecated. Use getHistogram.addValue(double[]) instead.
void	addValues(float[] array) Deprecated. Use getHistogram.addValue(float[]) instead.
void	addValues(int[] array, boolean signed) Deprecated. Use getHistogram.addValue(int[]) instead.
void	addValues(long[] array, boolean signed) Deprecated. Use getHistogram.addValue(long[]) instead.
void	addValues(java.lang.Object array, boolean signed) Deprecated. Use getHistogram.addValue(Object, boolean signed) instead.
void	addValues(short[] array, boolean signed) Deprecated. Use getHistogram.addValue(short[]) instead.
int	dataToPixel(double value) Convert a data value to the corresponding pixel position
void	done() Invoke this method when the histogram calculation has been completed to refresh data cache.
double	getAdjustedBinSize(int index) Returns the adjusted size (linear / log normalized) of the specified bin.
java.awt.Color	getBackgroundColor() Returns the background color
int	getBinNumber()
int[]	getBins()
int	getBinSize(int index) Returns the size of the specified bin (number of element in the bin)
double	getBinWidth()
java.awt.Color	getColor() Returns the drawing color
Histogram	getHistogram() Get histogram object
double[]	getHistogramData() Get computed histogram data
boolean	getLogScaling() Returns true if histogram is displayed with LOG scaling
double	getMaxValue() Returns the maximum allowed value of the histogram.
double	getMinValue() Returns the minimum allowed value of the histogram.
boolean	getUseLAFColors() Returns true if histogram use LAF color scheme.
boolean	isIntegerType() Returns true if the input value are integer values only.
boolean	isUpdating() Returns true when histogram is being calculated.
int	pixelToBin(int value) Convert a pixel position to corresponding bin index
double	pixelToData(int value) Convert a pixel position to corresponding data value
void	removeListener(HistogramPanel.HistogramPanelListener l)
void	reset() Call this method to inform you start histogram computation (allow the panel to display "computing" message).
void	setBackgroundColor(java.awt.Color value) Set the background color
void	setColor(java.awt.Color value) Set the drawing color
void	setLogScaling(boolean value) Set to true to display histogram with LOG scaling (else it uses linear scaling).
void	setMinMaxIntValues(double min, double max, boolean intType) Set minimum, maximum and integer values at once
void	setUseLAFColors(boolean value) Set to true to use LAF color scheme.

Methods inherited from class icy.gui.component.BorderedPanel

getClientHeight, getClientWidth, getClientX, getClientY

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HistogramPanel

public HistogramPanel(double minValue,
              double maxValue,
              boolean integer)

Create a new histogram panel for the specified value range.
By default it uses a Logarithm representation (modifiable via setLogScaling(boolean)

Parameters:

minValue -

maxValue -

integer -

Method Detail

isUpdating

public boolean isUpdating()

Returns true when histogram is being calculated.

reset

public void reset()

Call this method to inform you start histogram computation (allow the panel to display "computing" message).
You need to call done() when computation is done.

See Also:

done()

addValue

@Deprecated
public void addValue(double value)

Deprecated. Use getHistogram.addValue(double) instead.

addValues

@Deprecated
public void addValues(java.lang.Object array,
                        boolean signed)

Deprecated. Use getHistogram.addValue(Object, boolean signed) instead.

addValues

@Deprecated
public void addValues(byte[] array,
                        boolean signed)

Deprecated. Use getHistogram.addValue(byte[]) instead.

addValues

@Deprecated
public void addValues(short[] array,
                        boolean signed)

Deprecated. Use getHistogram.addValue(short[]) instead.

addValues

@Deprecated
public void addValues(int[] array,
                        boolean signed)

Deprecated. Use getHistogram.addValue(int[]) instead.

addValues

@Deprecated
public void addValues(long[] array,
                        boolean signed)

Deprecated. Use getHistogram.addValue(long[]) instead.

addValues

@Deprecated
public void addValues(float[] array)

Deprecated. Use getHistogram.addValue(float[]) instead.

addValues

@Deprecated
public void addValues(double[] array)

Deprecated. Use getHistogram.addValue(double[]) instead.

getAdjustedBinSize

public double getAdjustedBinSize(int index)

Returns the adjusted size (linear / log normalized) of the specified bin.

See Also:

getBinSize(int)

getBinSize

public int getBinSize(int index)

Returns the size of the specified bin (number of element in the bin)

See Also:

Histogram.getBinSize(int)

getBinNumber

public int getBinNumber()

See Also:

Histogram.getBinNumber()

getBinWidth

public double getBinWidth()

See Also:

Histogram.getBinWidth()

getBins

public int[] getBins()

See Also:

Histogram.getBins()

done

public void done()

Invoke this method when the histogram calculation has been completed to refresh data cache.

getMinValue

public double getMinValue()

Returns the minimum allowed value of the histogram.

getMaxValue

public double getMaxValue()

Returns the maximum allowed value of the histogram.

isIntegerType

public boolean isIntegerType()

Returns true if the input value are integer values only.
This is used to adapt the bin number of histogram..

getLogScaling

public boolean getLogScaling()

Returns true if histogram is displayed with LOG scaling

getUseLAFColors

public boolean getUseLAFColors()

Returns true if histogram use LAF color scheme.

See Also:

getColor(), getBackgroundColor()

getColor

public java.awt.Color getColor()

Returns the drawing color

getBackgroundColor

public java.awt.Color getBackgroundColor()

Returns the background color

getHistogram

public Histogram getHistogram()

Get histogram object

getHistogramData

public double[] getHistogramData()

Get computed histogram data

setMinMaxIntValues

public void setMinMaxIntValues(double min,
                      double max,
                      boolean intType)

Set minimum, maximum and integer values at once

setLogScaling

public void setLogScaling(boolean value)

Set to true to display histogram with LOG scaling (else it uses linear scaling).

setUseLAFColors

public void setUseLAFColors(boolean value)

Set to true to use LAF color scheme.

See Also:

setColor(Color), setBackgroundColor(Color)

setColor

public void setColor(java.awt.Color value)

Set the drawing color

setBackgroundColor

public void setBackgroundColor(java.awt.Color value)

Set the background color

dataToPixel

public int dataToPixel(double value)

Convert a data value to the corresponding pixel position

pixelToData

public double pixelToData(int value)

Convert a pixel position to corresponding data value

pixelToBin

public int pixelToBin(int value)

Convert a pixel position to corresponding bin index

addListener

public void addListener(HistogramPanel.HistogramPanelListener l)

removeListener

public void removeListener(HistogramPanel.HistogramPanelListener l)