org.opentrafficsim.draw.graphs

Class AbstractContourPlot<Z extends Number>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.opentrafficsim.draw.graphs.AbstractPlot

org.opentrafficsim.draw.graphs.AbstractBoundedPlot

org.opentrafficsim.draw.graphs.AbstractSpaceTimePlot

org.opentrafficsim.draw.graphs.AbstractSamplerPlot

org.opentrafficsim.draw.graphs.AbstractContourPlot<Z>

Type Parameters:

Z - z-value type

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, Dataset, Identifiable

Direct Known Subclasses:

ContourPlotAcceleration, ContourPlotDelay, ContourPlotDensity, ContourPlotFlow, ContourPlotSpeed

public abstract class AbstractContourPlot<Z extends Number>
extends AbstractSamplerPlot

Class for contour plots. The data that is plotted is stored in a ContourDataSource, which may be shared among several contour plots along the same path. This abstract class takes care of the interactions between the plot and the data pool. Sub classes only need to specify a few plot specific variables and functionalities.

Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 4 okt. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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.opentrafficsim.draw.graphs.AbstractPlot

DEFAULT_INITIAL_UPPER_TIME_BOUND, GRAPH_ADD_EVENT, GRAPH_REMOVE_EVENT

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
AbstractContourPlot(String caption, OTSSimulatorInterface simulator, ContourDataSource<?> dataPool, BoundsPaintScale paintScale, Z legendStep, String legendFormat, String valueFormat) Constructor with specified paint scale.
AbstractContourPlot(String caption, OTSSimulatorInterface simulator, ContourDataSource<?> dataPool, Z legendStep, String legendFormat, Z minValue, Z maxValue, String valueFormat) Constructor with default paint scale.

Method Summary

Modifier and Type	Method and Description
protected void	addPopUpMenuItems(JPopupMenu popupMenu) Overridable method to add pop up items.
protected abstract ContourDataSource.ContourDataType<Z,?>	getContourDataType() Returns the contour data type for use in a ContourDataSource.
protected ContourDataSource<?>	getDataPool() Returns the data pool for sub classes.
DomainOrder	getDomainOrder()
int	getItemCount(int series)
int	getRangeBinCount() Returns the number of items in each column.
int	getSeriesCount()
Comparable<String>	getSeriesKey(int series)
double	getSpaceGranularity() Returns the space granularity, just for information.
protected String	getStatusLabel(double domainValue, double rangeValue) Returns the status label when the mouse is over the given location.
double	getTimeGranularity() Returns the time granularity, just for information.
protected abstract double	getValue(int item, double cellLength, double cellSpan) Obtain value for cell from the data pool.
Number	getX(int series, int item)
double	getXValue(int series, int item)
Number	getY(int series, int item)
double	getYValue(int series, int item)
Number	getZ(int series, int item)
double	getZValue(int series, int item)
protected void	increaseTime(Time time) Increase the simulated time span.
int	indexOf(Comparable seriesKey)
protected abstract double	scale(double si) Scale the value from SI to the desired unit for users.
protected void	setInterpolation(boolean interpolate) Sets the check box for interpolated rendering and block renderer setting.
protected void	setSmoothing(boolean smooth) Sets the check box for smooth rendering.
protected void	setSpaceGranularityRadioButton(double granularity) Sets the correct space granularity radio button to selected.
protected void	setTimeGranularityRadioButton(double granularity) Sets the correct time granularity radio button to selected.

Methods inherited from class org.opentrafficsim.draw.graphs.AbstractSamplerPlot

getEndLocation, getPath, getSampler, getTrajectories

Methods inherited from class org.opentrafficsim.draw.graphs.AbstractSpaceTimePlot

setAutoBoundDomain, setAutoBoundRange, setChart, update

Methods inherited from class org.opentrafficsim.draw.graphs.AbstractBoundedPlot

setLowerDomainBound, setLowerRangeBound, setUpperDomainBound, setUpperRangeBound

Methods inherited from class org.opentrafficsim.draw.graphs.AbstractPlot

addChangeListener, encodeAsPng, getCaption, getChart, getChartMouseListener, getGraphType, getGroup, getId, getUpdateTime, notifyPlotChange, removeChangeListener, setGroup, setStatusLabel, setUpdateInterval

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

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, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, 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, getPeer, 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, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, 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 org.jfree.data.general.Dataset

addChangeListener, getGroup, removeChangeListener, setGroup

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

AbstractContourPlot

public AbstractContourPlot(String caption,
                           OTSSimulatorInterface simulator,
                           ContourDataSource<?> dataPool,
                           BoundsPaintScale paintScale,
                           Z legendStep,
                           String legendFormat,
                           String valueFormat)

Constructor with specified paint scale.

Parameters:

caption - String; caption

simulator - OTSSimulatorInterface; simulator

dataPool - ContourDataSource<?>; data pool

paintScale - BoundsPaintScale; paint scale

legendStep - Z; increment between color legend entries

legendFormat - String; format string for the captions in the color legend

valueFormat - String; format string used to create status label (under the mouse)

AbstractContourPlot

public AbstractContourPlot(String caption,
                           OTSSimulatorInterface simulator,
                           ContourDataSource<?> dataPool,
                           Z legendStep,
                           String legendFormat,
                           Z minValue,
                           Z maxValue,
                           String valueFormat)

Constructor with default paint scale.

Parameters:

caption - String; caption

simulator - OTSSimulatorInterface; simulator

dataPool - ContourDataSource<?>; data pool

legendStep - Z; increment between color legend entries

legendFormat - String; format string for the captions in the color legend

minValue - Z; minimum value

maxValue - Z; maximum value

valueFormat - String; format string used to create status label (under the mouse)

Method Detail

addPopUpMenuItems

protected void addPopUpMenuItems(JPopupMenu popupMenu)

Overridable method to add pop up items.

Overrides:

addPopUpMenuItems in class AbstractSpaceTimePlot

Parameters:

popupMenu - JPopupMenu; pop up menu

getTimeGranularity

public double getTimeGranularity()

Returns the time granularity, just for information.

Returns:

double; time granularity

getSpaceGranularity

public double getSpaceGranularity()

Returns the space granularity, just for information.

Returns:

double; space granularity

setSpaceGranularityRadioButton

protected final void setSpaceGranularityRadioButton(double granularity)

Sets the correct space granularity radio button to selected. This is done from a DataPool to keep multiple plots consistent.

Parameters:

granularity - double; space granularity

setTimeGranularityRadioButton

protected final void setTimeGranularityRadioButton(double granularity)

Sets the correct time granularity radio button to selected. This is done from a DataPool to keep multiple plots consistent.

Parameters:

granularity - double; time granularity

setSmoothing

protected final void setSmoothing(boolean smooth)

Sets the check box for smooth rendering. This is done from a DataPool to keep multiple plots consistent.

Parameters:

smooth - boolean; selected or not

setInterpolation

protected final void setInterpolation(boolean interpolate)

Sets the check box for interpolated rendering and block renderer setting. This is done from a DataPool to keep multiple plots consistent.

Parameters:

interpolate - boolean; selected or not

getDataPool

protected final ContourDataSource<?> getDataPool()

Returns the data pool for sub classes.

Returns:

ContourDataSource; data pool for subclasses

getItemCount

public final int getItemCount(int series)

getX

public final Number getX(int series,
                         int item)

getXValue

public final double getXValue(int series,
                              int item)

getY

public final Number getY(int series,
                         int item)

getYValue

public final double getYValue(int series,
                              int item)

getZ

public final Number getZ(int series,
                         int item)

getSeriesKey

public final Comparable<String> getSeriesKey(int series)

indexOf

public final int indexOf(Comparable seriesKey)

getDomainOrder

public final DomainOrder getDomainOrder()

getZValue

public final double getZValue(int series,
                              int item)

getSeriesCount

public final int getSeriesCount()

getRangeBinCount

public int getRangeBinCount()

Returns the number of items in each column.

Returns:

int; number of items in each column

getStatusLabel

protected final String getStatusLabel(double domainValue,
                                      double rangeValue)

Returns the status label when the mouse is over the given location.

Specified by:

getStatusLabel in class AbstractPlot

Parameters:

domainValue - double; domain value (x-axis)

rangeValue - double; range value (y-axis)

Returns:

String; status label when the mouse is over the given location

increaseTime

protected final void increaseTime(Time time)

Increase the simulated time span.

Specified by:

increaseTime in class AbstractPlot

Parameters:

time - Time; time to increase to

getValue

protected abstract double getValue(int item,
                                   double cellLength,
                                   double cellSpan)

Obtain value for cell from the data pool.

Parameters:

item - int; item number

cellLength - double; cell length

cellSpan - double; cell duration

Returns:

double; value for cell from the data pool

scale

protected abstract double scale(double si)

Scale the value from SI to the desired unit for users.

Parameters:

si - double; SI value

Returns:

double; scaled value

getContourDataType

protected abstract ContourDataSource.ContourDataType<Z,?> getContourDataType()

Returns the contour data type for use in a ContourDataSource.

Returns:

CountorDataType; contour data type