burlap.behavior.singleagent.auxiliary.valuefunctionvis

Class ValueFunctionVisualizerGUI

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

burlap.behavior.singleagent.auxiliary.valuefunctionvis.ValueFunctionVisualizerGUI

All Implemented Interfaces:

java.awt.event.ItemListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ValueFunctionVisualizerGUI
extends javax.swing.JFrame
implements java.awt.event.ItemListener

Provides a GUI for a value function and policy visualizer. Provides a toggle button for rendering the policy if the policy is provided.

Author:

James MacGlashan

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cHeight Visualizer canvas height
protected int	cWidth Visualizer canvas width
protected PolicyRenderLayer	pLayer The policy renderer
protected StaticDomainPainter	sdp Painter used to visualize general state-independent domain information
protected javax.swing.JCheckBox	showPolicy The button to enable the visualization of the policy
protected StatePolicyPainter	spp Painter used to visualize the policy
protected java.util.List<State>	statesToVisualize
protected StateValuePainter	svp Painter used to visualize the value function
protected ValueFunctionRenderLayer	vfLayer The value function renderer
protected MultiLayerRenderer	visualizer The multi-layer render layer canvas

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
ValueFunctionVisualizerGUI(java.util.List<State> states, StateValuePainter svp, ValueFunction valueFunction) Initializes the visualizer GUI.

Method Summary

Modifier and Type	Method and Description
static ValueFunctionVisualizerGUI	createGridWorldBasedValueFunctionVisualizerGUI(java.util.List<State> states, ValueFunction valueFunction, Policy p, java.lang.Object xVar, java.lang.Object yVar, VariableDomain xRange, VariableDomain yRange, double xWidth, double yWidth, java.lang.String northActionName, java.lang.String southActionName, java.lang.String eastActionName, java.lang.String westActionName) A method for creating common 2D arrow glyped value function and policy visualization.
MultiLayerRenderer	getMultiLayerRenderer() Returns the MultiLayerRenderer used in this GUI.
StatePolicyPainter	getSpp() Returns the state-wise policy painter
StateValuePainter	getSvp() Returns the State-wise value function painter
void	initGUI() Initializes the GUI and presents it to the user.
void	itemStateChanged(java.awt.event.ItemEvent e) Called when the check back for the policy rendering is checked or unchecked.
void	setBgColor(java.awt.Color col) Sets the canvas background color
void	setPolicy(Policy p) Sets the policy to render
void	setSpp(StatePolicyPainter spp) Sets the state-wise policy painter
void	setSvp(StateValuePainter svp) Sets the state-wise value function painter

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 java.awt.MenuContainer

getFont, postEvent

Field Detail

visualizer

protected MultiLayerRenderer visualizer

The multi-layer render layer canvas

vfLayer

protected ValueFunctionRenderLayer vfLayer

The value function renderer

pLayer

protected PolicyRenderLayer pLayer

The policy renderer

svp

protected StateValuePainter svp

Painter used to visualize the value function

spp

protected StatePolicyPainter spp

Painter used to visualize the policy

statesToVisualize

protected java.util.List<State> statesToVisualize

sdp

protected StaticDomainPainter sdp

Painter used to visualize general state-independent domain information

showPolicy

protected javax.swing.JCheckBox showPolicy

The button to enable the visualization of the policy

cWidth

protected int cWidth

Visualizer canvas width

cHeight

protected int cHeight

Visualizer canvas height

Constructor Detail

ValueFunctionVisualizerGUI

public ValueFunctionVisualizerGUI(java.util.List<State> states,
                                  StateValuePainter svp,
                                  ValueFunction valueFunction)

Initializes the visualizer GUI.

Parameters:

states - the states whose value should be rendered.

svp - the value function state visualizer to use.

valueFunction - the valueFunction that can return the state values.

Method Detail

createGridWorldBasedValueFunctionVisualizerGUI

public static ValueFunctionVisualizerGUI createGridWorldBasedValueFunctionVisualizerGUI(java.util.List<State> states,
                                                                                        ValueFunction valueFunction,
                                                                                        Policy p,
                                                                                        java.lang.Object xVar,
                                                                                        java.lang.Object yVar,
                                                                                        VariableDomain xRange,
                                                                                        VariableDomain yRange,
                                                                                        double xWidth,
                                                                                        double yWidth,
                                                                                        java.lang.String northActionName,
                                                                                        java.lang.String southActionName,
                                                                                        java.lang.String eastActionName,
                                                                                        java.lang.String westActionName)

A method for creating common 2D arrow glyped value function and policy visualization. The value of states will be represented by colored cells from red (lowest value) to blue (highest value). North-south-east-west actions will be rendered with arrows using ArrowActionGlyph objects. The GUI will not be launched by default; call the initGUI() on the returned object to start it.

Parameters:

states - the states whose value should be rendered.

valueFunction - the valueFunction that can return the state values.

p - the policy to render

xVar - the variable key for the x variable

yVar - the variable key for the y variable

xRange - xRange the range of the x variable

yRange - the range of the y variable

xWidth - the width of each rendered state within the x domain

yWidth - the width of the each rendered state within the y domain

northActionName - the name of the north action

southActionName - the name of the south action

eastActionName - the name of the east action

westActionName - the name of the west action

Returns:

a ValueFunctionVisualizerGUI

getMultiLayerRenderer

public MultiLayerRenderer getMultiLayerRenderer()

Returns the MultiLayerRenderer used in this GUI.

Returns:

the MultiLayerRenderer used in this GUI.

getSvp

public StateValuePainter getSvp()

Returns the State-wise value function painter

Returns:

the State-wise value function painter

setSvp

public void setSvp(StateValuePainter svp)

Sets the state-wise value function painter

Parameters:

svp - state-wise value function painter

getSpp

public StatePolicyPainter getSpp()

Returns the state-wise policy painter

Returns:

the state-wise policy painter

setSpp

public void setSpp(StatePolicyPainter spp)

Sets the state-wise policy painter

Parameters:

spp - the state-wise policy painter

setBgColor

public void setBgColor(java.awt.Color col)

Sets the canvas background color

Parameters:

col - the canvas background color

setPolicy

public void setPolicy(Policy p)

Sets the policy to render

Parameters:

p - the policy to render

initGUI

public void initGUI()

Initializes the GUI and presents it to the user.

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)

Called when the check back for the policy rendering is checked or unchecked.

Specified by:

itemStateChanged in interface java.awt.event.ItemListener