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

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 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.Object	xKey variable key for the x variable
protected VariableDomain	xRange Range of the x key
protected double	xWidth Width of x cells
protected java.lang.Object	yKey variable key for the y variable
protected VariableDomain	yRange Range of the y key
protected double	yWidth width of y cells

Constructor Summary

Constructors

Constructor and Description
PolicyGlyphPainter2D()

Method Summary

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	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	setXYKeys(java.lang.Object xKey, java.lang.Object yKey, VariableDomain xRange, VariableDomain yRange, double xWidth, double yWidth) Sets the variable keys for the x and y variables in the state and the width of cells along those domains.

Methods inherited from class java.lang.Object

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

Field Detail

xKey

protected java.lang.Object xKey

variable key for the x variable

yKey

protected java.lang.Object yKey

variable key for the y variable

xRange

protected VariableDomain xRange

Range of the x key

yRange

protected VariableDomain yRange

Range of the y key

xWidth

protected double xWidth

Width of x cells

yWidth

protected double yWidth

width of y cells

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

setXYKeys

public void setXYKeys(java.lang.Object xKey,
                      java.lang.Object yKey,
                      VariableDomain xRange,
                      VariableDomain yRange,
                      double xWidth,
                      double yWidth)

Sets the variable keys for the x and y variables in the state and the width of cells along those domains. The widths along the x dimension are how much of the variable space each rendered state will take.

Parameters:

xKey - the x variable key

yKey - the y variable key

xRange - the range of the x values

yRange - the range of the y values

xWidth - the width of a state along the x domain

yWidth - the width of a state alone the y domain

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

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.