org.opentrafficsim.graphs

Class ContourPlot

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.opentrafficsim.graphs.AbstractOTSPlot

org.opentrafficsim.graphs.ContourPlot

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, EventListenerInterface, Dataset, SeriesDataset, XYDataset, XYZDataset, Identifiable, LaneBasedGTUSampler, MultipleViewerChart

Direct Known Subclasses:

AccelerationContourPlot, DensityContourPlot, FlowContourPlot, SpeedContourPlot

public abstract class ContourPlot
extends AbstractOTSPlot
implements ActionListener, XYZDataset, MultipleViewerChart, LaneBasedGTUSampler, EventListenerInterface, Serializable

Common code for a contour plot.
The data collection code for acceleration assumes constant acceleration during the evaluation period of the GTU.

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

$LastChangedDate: 2015-09-14 01:33:02 +0200 (Mon, 14 Sep 2015) $, @version $Revision: 1401 $, by $Author: averbraeck $, initial version Jul 16, 2014

Author:

Peter Knoppers

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

Modifier and Type	Field and Description
protected static Time	INITIALLOWERTIMEBOUND Initial lower bound for the time scale.
protected static Time	INITIALUPPERTIMEBOUND Initial upper bound for the time scale.
protected static double[]	STANDARDDISTANCEGRANULARITIES Distance granularity values.
protected static int	STANDARDINITIALDISTANCEGRANULARITYINDEX Index of the initial distance granularity in standardTimeGranularites.
protected static int	STANDARDINITIALTIMEGRANULARITYINDEX Index of the initial time granularity in standardTimeGranularites.
protected static double[]	STANDARDTIMEGRANULARITIES Time granularity values.
protected Axis	xAxis Definition of the X-axis.
protected Axis	yAxis Definition of the Y-axis.

Fields inherited from class org.opentrafficsim.graphs.AbstractOTSPlot

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
ContourPlot(String caption, Axis xAxis, List<Lane> path, double redValue, double yellowValue, double greenValue, String valueFormat, String legendFormat, double legendStep) Create a new ContourPlot.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent actionEvent)
protected void	addData(LaneBasedGTU gtu, Lane lane) Add data for a GTU on a lane to this graph.
abstract double	computeZValue(int firstTimeBin, int endTimeBin, int firstDistanceBin, int endDistanceBin) Combine values in a range of time bins and distance bins to obtain a combined density value of the ranges.
protected JFreeChart	createChart(JFrame container) Create the visualization.
abstract void	extendXRange(DoubleScalarInterface newUpperLimit) Increase storage for sample data.
Length	getCumulativeLength(int index) Retrieve the cumulative length of the sampled path at the end of a path element.
DomainOrder	getDomainOrder()
DatasetGroup	getGroup()
int	getItemCount(int series)
int	getSeriesCount()
Number	getX(int series, int item)
Axis	getXAxis() Get the X axis.
double	getXValue(int series, int item)
Number	getY(int series, int item)
Axis	getYAxis() Get the Y axis.
double	getYValue(int series, int item)
Number	getZ(int series, int item)
double	getZValue(int series, int item)
abstract void	incrementBinData(int timeBin, int distanceBin, double duration, double distanceCovered, double acceleration) Increment the data of one bin.
int	indexOf(Comparable seriesKey)
void	notify(EventInterface event)
void	reGraph() Redraw this ContourGraph (after the underlying data, or a granularity setting has been changed).
void	setGroup(DatasetGroup group)
protected int	xAxisBin(int item) Return the x-axis bin number (the column number) of an item.
protected int	xAxisBins() Retrieve the number of cells to use along the time axis.
protected int	yAxisBin(int item) Return the y-axis bin number (the row number) of an item.
protected int	yAxisBins() Retrieve the number of cells to use along the distance axis.

Methods inherited from class org.opentrafficsim.graphs.AbstractOTSPlot

addChangeListener, addViewer, generatePNG, getCaption, getGraphType, getId, getListenerList, getPath, notifyListeners, removeChangeListener, setChart

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.SeriesDataset

getSeriesKey

Methods inherited from interface org.jfree.data.general.Dataset

addChangeListener, removeChangeListener

Methods inherited from interface org.opentrafficsim.graphs.MultipleViewerChart

addViewer

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

xAxis

protected final Axis xAxis

Definition of the X-axis.

yAxis

protected final Axis yAxis

Definition of the Y-axis.

STANDARDTIMEGRANULARITIES

protected static final double[] STANDARDTIMEGRANULARITIES

Time granularity values.

STANDARDINITIALTIMEGRANULARITYINDEX

protected static final int STANDARDINITIALTIMEGRANULARITYINDEX

Index of the initial time granularity in standardTimeGranularites.

See Also:

Constant Field Values

STANDARDDISTANCEGRANULARITIES

protected static final double[] STANDARDDISTANCEGRANULARITIES

Distance granularity values.

STANDARDINITIALDISTANCEGRANULARITYINDEX

protected static final int STANDARDINITIALDISTANCEGRANULARITYINDEX

Index of the initial distance granularity in standardTimeGranularites.

See Also:

Constant Field Values

INITIALLOWERTIMEBOUND

protected static final Time INITIALLOWERTIMEBOUND

Initial lower bound for the time scale.

INITIALUPPERTIMEBOUND

protected static final Time INITIALUPPERTIMEBOUND

Initial upper bound for the time scale.

Constructor Detail

ContourPlot

public ContourPlot(String caption,
                   Axis xAxis,
                   List<Lane> path,
                   double redValue,
                   double yellowValue,
                   double greenValue,
                   String valueFormat,
                   String legendFormat,
                   double legendStep)
            throws OTSSimulationException

Create a new ContourPlot.

Parameters:

caption - String; text to show above the plotting area

xAxis - Axis; the X (time) axis

path - ArrayList<Lane>; the series of Lanes that will provide the data for this TrajectoryPlot

redValue - Double; contour value that will be rendered in Red

yellowValue - Double; contour value that will be rendered in Yellow

greenValue - Double; contour value that will be rendered in Green

valueFormat - String; format string for the contour values

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

legendStep - Double; increment between color legend entries

Throws:

OTSSimulationException - when the scale cannot be generated

Method Detail

notify

public void notify(EventInterface event)
            throws RemoteException

Specified by:

notify in interface EventListenerInterface

Throws:

RemoteException

getCumulativeLength

public final Length getCumulativeLength(int index)

Retrieve the cumulative length of the sampled path at the end of a path element.

Parameters:

index - int; the index of the path element; if -1, the total length of the path is returned

Returns:

Length; the cumulative length at the end of the specified path element

createChart

protected final JFreeChart createChart(JFrame container)

Create the visualization.

Specified by:

createChart in class AbstractOTSPlot

Parameters:

container - JFrame; the JFrame that will be filled with chart and the status label

Returns:

JFreeChart; the visualization

actionPerformed

public final void actionPerformed(ActionEvent actionEvent)

Specified by:

actionPerformed in interface ActionListener

reGraph

public final void reGraph()

Redraw this ContourGraph (after the underlying data, or a granularity setting has been changed).

Specified by:

reGraph in interface LaneBasedGTUSampler

Specified by:

reGraph in class AbstractOTSPlot

getSeriesCount

public final int getSeriesCount()

Specified by:

getSeriesCount in interface SeriesDataset

yAxisBins

protected final int yAxisBins()

Retrieve the number of cells to use along the distance axis.

Returns:

Integer; the number of cells to use along the distance axis

yAxisBin

protected final int yAxisBin(int item)

Return the y-axis bin number (the row number) of an item.
Do not rely on the (current) fact that the data is stored column by column!

Parameters:

item - Integer; the item

Returns:

Integer; the bin number along the y axis of the item

xAxisBin

protected final int xAxisBin(int item)

Return the x-axis bin number (the column number) of an item.
Do not rely on the (current) fact that the data is stored column by column!

Parameters:

item - Integer; the item

Returns:

Integer; the bin number along the x axis of the item

xAxisBins

protected final int xAxisBins()

Retrieve the number of cells to use along the time axis.

Returns:

Integer; the number of cells to use along the time axis

getItemCount

public final int getItemCount(int series)

Specified by:

getItemCount in interface XYDataset

getX

public final Number getX(int series,
                         int item)

Specified by:

getX in interface XYDataset

getXValue

public final double getXValue(int series,
                              int item)

Specified by:

getXValue in interface XYDataset

getY

public final Number getY(int series,
                         int item)

Specified by:

getY in interface XYDataset

getYValue

public final double getYValue(int series,
                              int item)

Specified by:

getYValue in interface XYDataset

getZ

public final Number getZ(int series,
                         int item)

Specified by:

getZ in interface XYZDataset

getGroup

public final DatasetGroup getGroup()

Specified by:

getGroup in interface Dataset

setGroup

public void setGroup(DatasetGroup group)

Specified by:

setGroup in interface Dataset

indexOf

public final int indexOf(Comparable seriesKey)

Specified by:

indexOf in interface SeriesDataset

getDomainOrder

public final DomainOrder getDomainOrder()

Specified by:

getDomainOrder in interface XYDataset

addData

protected final void addData(LaneBasedGTU gtu,
                             Lane lane)

Add data for a GTU on a lane to this graph.

Parameters:

gtu - the gtu to add the data for

lane - the lane on which the GTU is registered

extendXRange

public abstract void extendXRange(DoubleScalarInterface newUpperLimit)

Increase storage for sample data.
This is only implemented for the time axis.

Parameters:

newUpperLimit - DoubleScalar<?> new upper limit for the X range

incrementBinData

public abstract void incrementBinData(int timeBin,
                                      int distanceBin,
                                      double duration,
                                      double distanceCovered,
                                      double acceleration)

Increment the data of one bin.

Parameters:

timeBin - Integer; the rank of the bin on the time-scale

distanceBin - Integer; the rank of the bin on the distance-scale

duration - Double; the time spent in this bin

distanceCovered - Double; the distance covered in this bin

acceleration - Double; the average acceleration in this bin

getZValue

public final double getZValue(int series,
                              int item)

Specified by:

getZValue in interface XYZDataset

computeZValue

public abstract double computeZValue(int firstTimeBin,
                                     int endTimeBin,
                                     int firstDistanceBin,
                                     int endDistanceBin)

Combine values in a range of time bins and distance bins to obtain a combined density value of the ranges.

Parameters:

firstTimeBin - Integer; the first time bin to use

endTimeBin - Integer; one higher than the last time bin to use

firstDistanceBin - Integer; the first distance bin to use

endDistanceBin - Integer; one higher than the last distance bin to use

Returns:

Double; the density value (or Double.NaN if no value can be computed)

getXAxis

public final Axis getXAxis()

Get the X axis.

Returns:

Axis

getYAxis

public final Axis getYAxis()

Get the Y axis.

Returns:

Axis