org.openimaj.vis.general

Class XYPlotVisualisation<O>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.openimaj.vis.VisualisationImpl<List<XYPlotVisualisation.LocatedObject<O>>>

org.openimaj.vis.general.XYPlotVisualisation<O>

Type Parameters:

O - The type of object to be visualised

All Implemented Interfaces:

ComponentListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, AnimatedVisualisationListener, Visualisation<List<XYPlotVisualisation.LocatedObject<O>>>, VisualisationImageProvider

Direct Known Subclasses:

BarVisualisation, DiversityAxis, DotPlotVisualisation, LabelledPointVisualisation, WorldMap

public class XYPlotVisualisation<O>
extends VisualisationImpl<List<XYPlotVisualisation.LocatedObject<O>>>

Abstract visualisation for plotting X,Y items. Uses the AxesRenderer2D to determine the scale of the visualisation.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

See Also:

Serialized Form

Created:

3 Jun 2013

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XYPlotVisualisation.LocatedObject<O> Class that locates an object.

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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 and Description
protected AxesRenderer2D<Float[],MBFImage>	axesRenderer2D The renderer for the axes
protected ItemPlotter<O,Float[],MBFImage>	plotter The item plotter to use

Fields inherited from class org.openimaj.vis.VisualisationImpl

clearBeforeDraw, data, visImage

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
XYPlotVisualisation(int width, int height) Constructor that provides the width and height of the visualisation and a null plotter
XYPlotVisualisation(int width, int height, ItemPlotter<O,Float[],MBFImage> plotter) Constructor that provides the width and height of the visualisation.
XYPlotVisualisation(ItemPlotter<O,Float[],MBFImage> plotter) Default constructor

Method Summary

Modifier and Type	Method and Description
void	addPoint(double x, double y, O object) Add an object to the plot
void	beforeAxesRender(MBFImage visImage, AxesRenderer2D<Float[],MBFImage> renderer) A method that can be overridden to plot something prior to the axes being drawn.
void	clearData() Clear the data list.
AxesRenderer2D<Float[],MBFImage>	getAxesRenderer() Provides access to the underlying axes renderer so that various changes can be made to the visualisation.
boolean	isAutoPositionXAxis()
boolean	isAutoScaleAxes()
boolean	isRenderAxesLast()
void	removePoint(O object) Remove a specific object
void	setAutoPositionXAxis(boolean autoPositionXAxis)
void	setAutoScaleAxes(boolean autoScaleAxes)
void	setData(List<XYPlotVisualisation.LocatedObject<O>> data) Set the data to be visualised.
void	setItemPlotter(ItemPlotter<O,Float[],MBFImage> plotter) Set the plotter
void	setRenderAxesLast(boolean renderAxesLast)
void	update() Called to update the visualisation.
protected void	validateData() Set up the min/max of the axes based on the data.

Methods inherited from class org.openimaj.vis.VisualisationImpl

addOverlay, componentHidden, componentMoved, componentResized, componentShown, getRequiredSize, getVisualisationImage, isAllowResize, newVisualisationAvailable, paint, removeOverlay, setAllowResize, setClearBeforeDraw, setRequiredSize, showWindow, update, updateVis, updateVis

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, paintBorder, paintChildren, paintComponent, 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

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

Field Detail

axesRenderer2D

protected final AxesRenderer2D<Float[],MBFImage> axesRenderer2D

The renderer for the axes

plotter

protected ItemPlotter<O,Float[],MBFImage> plotter

The item plotter to use

Constructor Detail

XYPlotVisualisation

public XYPlotVisualisation(ItemPlotter<O,Float[],MBFImage> plotter)

Default constructor

Parameters:

plotter - The item plotter to use

XYPlotVisualisation

public XYPlotVisualisation(int width,
                           int height,
                           ItemPlotter<O,Float[],MBFImage> plotter)

Constructor that provides the width and height of the visualisation.

Parameters:

width - Width of the vis in pixels

height - Height of the vis in pixels

plotter - The item plotter to use

XYPlotVisualisation

public XYPlotVisualisation(int width,
                           int height)

Constructor that provides the width and height of the visualisation and a null plotter

Parameters:

width - Width of the vis in pixels

height - Height of the vis in pixels

Method Detail

update

public void update()

Called to update the visualisation. This method can expect the visImage member to be available and of the correct size. The method simply needs to draw the visualisation to this MBFImage. You should wrap any drawing code in a synchronized block, synchronized on the visImage - this stops the image being repainted to the screen half way through drawing.

Update is called from the paint() method so should ideally not force a repaint() as this will call a continuous repaint loop.

Specified by:

update in class VisualisationImpl<List<XYPlotVisualisation.LocatedObject<O>>>

See Also:

VisualisationImpl.update()

beforeAxesRender

public void beforeAxesRender(MBFImage visImage,
                             AxesRenderer2D<Float[],MBFImage> renderer)

A method that can be overridden to plot something prior to the axes being drawn.

Parameters:

visImage - The image to draw to

renderer - The axes renderer

addPoint

public void addPoint(double x,
                     double y,
                     O object)

Add an object to the plot

Parameters:

x - x location of data point

y - y location of data point

object - The object

removePoint

public void removePoint(O object)

Remove a specific object

Parameters:

object - The object

setItemPlotter

public void setItemPlotter(ItemPlotter<O,Float[],MBFImage> plotter)

Set the plotter

Parameters:

plotter - The plotter

getAxesRenderer

public AxesRenderer2D<Float[],MBFImage> getAxesRenderer()

Provides access to the underlying axes renderer so that various changes can be made to the visualisation.

Returns:

The axes renderer.

clearData

public void clearData()

Clear the data list.

setData

public void setData(List<XYPlotVisualisation.LocatedObject<O>> data)

Set the data to be visualised.

Specified by:

setData in interface Visualisation<List<XYPlotVisualisation.LocatedObject<O>>>

Overrides:

setData in class VisualisationImpl<List<XYPlotVisualisation.LocatedObject<O>>>

Parameters:

data - The data to be visualised

See Also:

VisualisationImpl.setData(java.lang.Object)

validateData

protected void validateData()

Set up the min/max of the axes based on the data.

isAutoScaleAxes

public boolean isAutoScaleAxes()

Returns:

the autoScaleAxes

setAutoScaleAxes

public void setAutoScaleAxes(boolean autoScaleAxes)

Parameters:

autoScaleAxes - the autoScaleAxes to set

isAutoPositionXAxis

public boolean isAutoPositionXAxis()

Returns:

the autoPositionXAxis

setAutoPositionXAxis

public void setAutoPositionXAxis(boolean autoPositionXAxis)

Parameters:

autoPositionXAxis - the autoPositionXAxis to set

isRenderAxesLast

public boolean isRenderAxesLast()

Returns:

the renderAxesLast

setRenderAxesLast

public void setRenderAxesLast(boolean renderAxesLast)

Parameters:

renderAxesLast - the renderAxesLast to set