burlap.behavior.singleagent.auxiliary.valuefunctionvis.common

Class PolicyGlyphPainter2D

java.lang.Object

burlap.behavior.singleagent.auxiliary.valuefunctionvis.common.PolicyGlyphPainter2D

All Implemented Interfaces:

StatePolicyPainter

public class PolicyGlyphPainter2D
extends java.lang.Object
implements StatePolicyPainter

An class for rendering the policy for states by painting different glyphs for different actions. There are three different ways to paint the policy: (1) just painting the glyph for the most likely action (and all that tie as the most likely); (2) glyphs for all actions whose likelihood is within some threshold of the most likely action; (3) glyphs for all actions with the glyphs scaled by how likely the action is.

Author:

James MacGlashan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PolicyGlyphPainter2D.PolicyGlyphRenderStyle MAXACTION paints only glphys for only those actions that have the highest likelihood MAXACTIONSOFTTIE paints the glyphs for all actions whose likelihood is within some threshold of the most likely action DISTSCALED paints glyphs for all actions and scales them by the likelihood of the action

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,ActionGlyphPainter>	actionNameToGlyphPainter The map from action names to glyphs that will be used to represent them.
protected int	numXCells Option used for specifying the number of possible states that will be rendered in a row (i.e., across the x-axis).
protected int	numYCells Option used for specifying the number of possible states that will be rendered in a column (i.e., across the y-axis).
protected PolicyGlyphPainter2D.PolicyGlyphRenderStyle	renderStyle The render style to use
protected double	softTieDelta The max probability difference from the most likely action for which an action that is not the most likely will still be rendered under the MAXACTIONSOFTTIE rendering style.
protected java.lang.String	xAttName The name of the attribute that is used for determining the x-position on the canvas
protected java.lang.String	xClassName The name of the class that holds the x-attribute used for determining the x-posiition on the canvas
protected java.lang.String	xObjectName The name of the object that holds the x-attribute used for determining the x-posiition on the canvas
protected java.lang.String	yAttName The name of the attribute that is used for determining the y-position on the canvas
protected java.lang.String	yClassName The name of the class that holds the y-attribute used for determining the y-posiition on the canvas
protected java.lang.String	yObjectName The name of the object that holds the y-attribute used for determining the y-posiition on the canvas

Constructor Summary

Constructors

Constructor and Description
PolicyGlyphPainter2D()

Method Summary

Methods

Modifier and Type	Method and Description
PolicyGlyphPainter2D.PolicyGlyphRenderStyle	getRenderStyle() Returns the rendering style
double	getSoftTieRenderStyleDelta() Returns the soft difference between max actions to determine ties when the MAXACTIONSOFSOFTTIE render style is used.
void	paintStatePolicy(java.awt.Graphics2D g2, State s, Policy policy, float cWidth, float cHeight) Paints a representation of the given policy for a specific state to a 2D graphics context.
protected float[]	rescaleRect(float x, float y, float width, float height, float scale) Takes in a rectangle specification and scales it equally along each direction by a scale factor.
void	setActionNameGlyphPainter(java.lang.String actionName, ActionGlyphPainter actionPainter) Sets which glyph painter to use for an action with the given name
void	setNumXCells(int numXCells) Sets the number of states that will be rendered along a row
void	setNumYCells(int numYCells) Sets the number of states that will be rendered along a row
void	setRenderStyle(PolicyGlyphPainter2D.PolicyGlyphRenderStyle renderStyle) Sets the rendering style
void	setSoftTieRenderStyleDelta(double delta) Sets the soft difference between max actions to determine ties when the MAXACTIONSOFSOFTTIE render style is used.
void	setXYAttByObjectClass(java.lang.String xClassName, java.lang.String xAttName, java.lang.String yClassName, java.lang.String yAttName) Will set the x-y attributes to use for cell rendering to the x y attributes of the first object in the state of the designated classes.
void	setXYAttByObjectReference(java.lang.String xObjectName, java.lang.String xAttName, java.lang.String yObjectName, java.lang.String yAttName) Will set the x-y attributes to use for cell rendering to the x y attributes of the designated object references.
protected ObjectInstance	xObjectInstance(State s) Returns the object instance in a state that holds the x-position information.
protected ObjectInstance	yObjectInstance(State s) Returns the object instance in a state that holds the y-position information.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

xAttName

protected java.lang.String xAttName

The name of the attribute that is used for determining the x-position on the canvas

yAttName

protected java.lang.String yAttName

The name of the attribute that is used for determining the y-position on the canvas

xClassName

protected java.lang.String xClassName

The name of the class that holds the x-attribute used for determining the x-posiition on the canvas

yClassName

protected java.lang.String yClassName

The name of the class that holds the y-attribute used for determining the y-posiition on the canvas

xObjectName

protected java.lang.String xObjectName

The name of the object that holds the x-attribute used for determining the x-posiition on the canvas

yObjectName

protected java.lang.String yObjectName

The name of the object that holds the y-attribute used for determining the y-posiition on the canvas

numXCells

protected int numXCells

Option used for specifying the number of possible states that will be rendered in a row (i.e., across the x-axis). -1 causes the attribute categorical size to be used instead.

numYCells

protected int numYCells

Option used for specifying the number of possible states that will be rendered in a column (i.e., across the y-axis). -1 causes the attribute categorical size to be used instead.

renderStyle

protected PolicyGlyphPainter2D.PolicyGlyphRenderStyle renderStyle

The render style to use

softTieDelta

protected double softTieDelta

The max probability difference from the most likely action for which an action that is not the most likely will still be rendered under the MAXACTIONSOFTTIE rendering style.

actionNameToGlyphPainter

protected java.util.Map<java.lang.String,ActionGlyphPainter> actionNameToGlyphPainter

The map from action names to glyphs that will be used to represent them.

Constructor Detail

PolicyGlyphPainter2D

public PolicyGlyphPainter2D()

Method Detail

setXYAttByObjectClass

public void setXYAttByObjectClass(java.lang.String xClassName,
                         java.lang.String xAttName,
                         java.lang.String yClassName,
                         java.lang.String yAttName)

Will set the x-y attributes to use for cell rendering to the x y attributes of the first object in the state of the designated classes.

Parameters:

xClassName - the object class name containing the render x-axis attribute

xAttName - the render x-axis attribute name

yClassName - the object class name containing the render y-axis attribute

yAttName - the render y-axis attribute name

setXYAttByObjectReference

public void setXYAttByObjectReference(java.lang.String xObjectName,
                             java.lang.String xAttName,
                             java.lang.String yObjectName,
                             java.lang.String yAttName)

Will set the x-y attributes to use for cell rendering to the x y attributes of the designated object references.

Parameters:

xObjectName - the object name reference that contains the render x-axis attribute

xAttName - the render x-axis attribute name

yObjectName - the object name reference that contains the render y-axis attribute

yAttName - the render y-axis attribute name

setActionNameGlyphPainter

public void setActionNameGlyphPainter(java.lang.String actionName,
                             ActionGlyphPainter actionPainter)

Sets which glyph painter to use for an action with the given name

Parameters:

actionName - the name of the action

actionPainter - the glyph painter used to represent it

setNumXCells

public void setNumXCells(int numXCells)

Sets the number of states that will be rendered along a row

Parameters:

numXCells - the number of states that will be rendered along a row

setNumYCells

public void setNumYCells(int numYCells)

Sets the number of states that will be rendered along a row

Parameters:

numYCells - the number of states that will be rendered along a column

getRenderStyle

public PolicyGlyphPainter2D.PolicyGlyphRenderStyle getRenderStyle()

Returns the rendering style

Returns:

the rendering style

setRenderStyle

public void setRenderStyle(PolicyGlyphPainter2D.PolicyGlyphRenderStyle renderStyle)

Sets the rendering style

Parameters:

renderStyle - the rending style to use

setSoftTieRenderStyleDelta

public void setSoftTieRenderStyleDelta(double delta)

Sets the soft difference between max actions to determine ties when the MAXACTIONSOFSOFTTIE render style is used.

Parameters:

delta - the delta for determining ties.

getSoftTieRenderStyleDelta

public double getSoftTieRenderStyleDelta()

Returns the soft difference between max actions to determine ties when the MAXACTIONSOFSOFTTIE render style is used.

Returns:

the delta for determining ties.

paintStatePolicy

public void paintStatePolicy(java.awt.Graphics2D g2,
                    State s,
                    Policy policy,
                    float cWidth,
                    float cHeight)

Description copied from interface: StatePolicyPainter

Paints a representation of the given policy for a specific state to a 2D graphics context.

Specified by:

paintStatePolicy in interface StatePolicyPainter

Parameters:

g2 - graphics context to which the object should be painted

s - the state of the object to be painted

policy - the policy that can be used on state s

cWidth - width of the canvas size

cHeight - height of the canvas size

rescaleRect

protected float[] rescaleRect(float x,
                  float y,
                  float width,
                  float height,
                  float scale)

Takes in a rectangle specification and scales it equally along each direction by a scale factor.

Parameters:

x - the left side of the rectangle

y - the top side of the rectangle

width - the width of the rectangle

height - the height of the rectangle

scale - the scale factor

Returns:

a double array with the new x, y, width, and height values of the scaled rectangle.

xObjectInstance

protected ObjectInstance xObjectInstance(State s)

Returns the object instance in a state that holds the x-position information.

Parameters:

s - the state for which to get the x-position

Returns:

the object instance in a state that holds the x-position information.

yObjectInstance

protected ObjectInstance yObjectInstance(State s)

Returns the object instance in a state that holds the y-position information.

Parameters:

s - the state for which to get the y-position

Returns:

the object instance in a state that holds the y-position information.