org.openimaj.vis.world

Class WorldMap<T>

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<T>

org.openimaj.vis.world.WorldMap<T>

Type Parameters:

T - The type of data to plot on the image

All Implemented Interfaces:

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

public class WorldMap<T>
extends XYPlotVisualisation<T>
implements AnimatedVisualisationProvider

Draws a world map visualisation as an XY plot. The XY coordinates are scaled to be equal to longitude and latitude.

Author:

Sina Samangooei (ss@ecs.soton.ac.uk), David Dupplaw (dpd@ecs.soton.ac.uk)

See Also:

Serialized Form

Created:

11 Jun 2013

Nested Class Summary

Nested classes/interfaces inherited from class org.openimaj.vis.general.XYPlotVisualisation

XYPlotVisualisation.LocatedObject<O>

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 inherited from class org.openimaj.vis.general.XYPlotVisualisation

axesRenderer2D, plotter

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
WorldMap(int width, int height, ItemPlotter<T,Float[],MBFImage> plotter)
WorldMap(int width, int height, ItemPlotter<T,Float[],MBFImage> plotter, int xmin, int xmax, int ymin, int ymax)

Method Summary

Modifier and Type	Method and Description
void	addAnimatedVisualisationListener(AnimatedVisualisationListener avl) Add a visualisation listener to be informed of animation events.
void	addHighlightCountry(String countryCode) Add a country to highlight
void	addHighlightCountry(String countryCode, Float[] colour) Add a country to highlight
void	animateCountryColour(String countryCode, ValueAnimator<Float[]> colourAnimator) Animate the colour of a country
void	beforeAxesRender(MBFImage visImage, AxesRenderer2D<Float[],MBFImage> axesRenderer) A method that can be overridden to plot something prior to the axes being drawn.
void	clearData() Clear the data list.
protected void	drawSea(MBFImage img) Fill the image with the sea's colour.
protected void	fireAnimationEvent() Fire the animation event
String	getCountryCodeByName(String countryName) Returns a country code for a given country name.
Point2d	getCountryLocation(String countryCode) Returns the lat/long of a country given its country code
Float[]	getDefaultCountryLandColour()
Float[]	getDefaultCountryOutlineColour()
Float[]	getHighlightCountryLandColour()
Float[]	getSeaColour()
static void	main(String[] args) Demonstration method.
void	removeAnimatedVisualisationListener(AnimatedVisualisationListener avl) Remove a given listener from being informed of animation events.
void	removeHighlightCountry(String countryCode) Remove a highlighted country
void	setDefaultCountryLandColour(Float[] defaultCountryLandColour)
void	setDefaultCountryOutlineColour(Float[] defaultCountryOutlineColour)
void	setHighlightCountryLandColour(Float[] highlightCountryLandColour)
void	setSeaColour(Float[] seaColour)

Methods inherited from class org.openimaj.vis.general.XYPlotVisualisation

addPoint, getAxesRenderer, isAutoPositionXAxis, isAutoScaleAxes, isRenderAxesLast, removePoint, setAutoPositionXAxis, setAutoScaleAxes, setData, setItemPlotter, setRenderAxesLast, update, validateData

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

Methods inherited from interface org.openimaj.vis.VisualisationImageProvider

getVisualisationImage, setRequiredSize, updateVis

Constructor Detail

WorldMap

public WorldMap(int width,
                int height,
                ItemPlotter<T,Float[],MBFImage> plotter)

Parameters:

width - Width of the visualisation

height - Height of the visualisation

plotter - The plotter to plot data with

WorldMap

public WorldMap(int width,
                int height,
                ItemPlotter<T,Float[],MBFImage> plotter,
                int xmin,
                int xmax,
                int ymin,
                int ymax)

Parameters:

width - Width of the visualisation

height - Height of the visualisation

plotter - The plotter to plot data with

xmin - min x value to be plotted

xmax - max x value to be plotted

ymin - min y value to be plotted

ymax - max y value to be plotted

Method Detail

addHighlightCountry

public void addHighlightCountry(String countryCode)

Add a country to highlight

Parameters:

countryCode - The country code to highlight

addHighlightCountry

public void addHighlightCountry(String countryCode,
                                Float[] colour)

Add a country to highlight

Parameters:

countryCode - The country code to highlight

colour - The colour to highlight the country

removeHighlightCountry

public void removeHighlightCountry(String countryCode)

Remove a highlighted country

Parameters:

countryCode - The country code to remove

drawSea

protected void drawSea(MBFImage img)

Fill the image with the sea's colour. Uses the member seaColour to determine this. If you want another sea texture, override this method.

beforeAxesRender

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

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

Overrides:

beforeAxesRender in class XYPlotVisualisation<T>

Parameters:

visImage - The image to draw to

axesRenderer - The axes renderer

See Also:

XYPlotVisualisation.beforeAxesRender(org.openimaj.image.MBFImage, org.openimaj.vis.general.AxesRenderer2D)

getSeaColour

public Float[] getSeaColour()

Returns:

the seaColour

setSeaColour

public void setSeaColour(Float[] seaColour)

Parameters:

seaColour - the seaColour to set

getDefaultCountryOutlineColour

public Float[] getDefaultCountryOutlineColour()

Returns:

the defaultCountryOutlineColour

setDefaultCountryOutlineColour

public void setDefaultCountryOutlineColour(Float[] defaultCountryOutlineColour)

Parameters:

defaultCountryOutlineColour - the defaultCountryOutlineColour to set

getDefaultCountryLandColour

public Float[] getDefaultCountryLandColour()

Returns:

the defaultCountryLandColour

setDefaultCountryLandColour

public void setDefaultCountryLandColour(Float[] defaultCountryLandColour)

Parameters:

defaultCountryLandColour - the defaultCountryLandColour to set

getHighlightCountryLandColour

public Float[] getHighlightCountryLandColour()

Returns:

the highlightCountryLandColour

setHighlightCountryLandColour

public void setHighlightCountryLandColour(Float[] highlightCountryLandColour)

Parameters:

highlightCountryLandColour - the highlightCountryLandColour to set

getCountryCodeByName

public String getCountryCodeByName(String countryName)

Returns a country code for a given country name.

Parameters:

countryName - The country name

Returns:

the country code

getCountryLocation

public Point2d getCountryLocation(String countryCode)

Returns the lat/long of a country given its country code

Parameters:

countryCode - The country code

Returns:

The lat long as a point2d

clearData

public void clearData()

Description copied from class: XYPlotVisualisation

Clear the data list.

Overrides:

clearData in class XYPlotVisualisation<T>

addAnimatedVisualisationListener

public void addAnimatedVisualisationListener(AnimatedVisualisationListener avl)

Add a visualisation listener to be informed of animation events.

Specified by:

addAnimatedVisualisationListener in interface AnimatedVisualisationProvider

Parameters:

avl - The listener to add

See Also:

AnimatedVisualisationProvider.addAnimatedVisualisationListener(org.openimaj.vis.AnimatedVisualisationListener)

removeAnimatedVisualisationListener

public void removeAnimatedVisualisationListener(AnimatedVisualisationListener avl)

Remove a given listener from being informed of animation events.

Specified by:

removeAnimatedVisualisationListener in interface AnimatedVisualisationProvider

Parameters:

avl - The listener to remove

See Also:

AnimatedVisualisationProvider.removeAnimatedVisualisationListener(org.openimaj.vis.AnimatedVisualisationListener)

fireAnimationEvent

protected void fireAnimationEvent()

Fire the animation event

animateCountryColour

public void animateCountryColour(String countryCode,
                                 ValueAnimator<Float[]> colourAnimator)

Animate the colour of a country

Parameters:

countryCode - The country to animate

colourAnimator - The colour animator

main

public static void main(String[] args)

Demonstration method.

Parameters:

args - command-line args (unused)