burlap.behavior.singleagent.auxiliary.valuefunctionvis.common

Class LandmarkColorBlendInterpolation

java.lang.Object

burlap.behavior.singleagent.auxiliary.valuefunctionvis.common.LandmarkColorBlendInterpolation

All Implemented Interfaces:

ColorBlend

public class LandmarkColorBlendInterpolation
extends java.lang.Object
implements ColorBlend

A ColorBlend instance that takes as input a set of "landmark" Color objects and corresponding values between them. For a given value, it interpolates between the two landmarks values than lower bound and upper bound the input. The interpolation is by default linear. However, it can also be specified to first find the normalized distance between the bounding landmark values and raise it to a power, which may produce more obvious perceptual changes to small changes in value.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.awt.Color>	landmarkColors The landmark colors
protected java.util.List<java.lang.Double>	landmarkValues The value position of each landmark
protected java.util.List<java.lang.Double>	originalLandmarkValues The original set landmark values set before any rescaling was performed.
protected double	polyDegree The power to raise the normalized distance

Constructor Summary

Constructors

Constructor and Description
LandmarkColorBlendInterpolation()
LandmarkColorBlendInterpolation(double polyDegree) Initializes the color blend with a power to raise the normalized distance of values.

Method Summary

Modifier and Type	Method and Description
void	addNextLandMark(double val, java.awt.Color c) Adds the next landmark between which interpolation should occur.
java.awt.Color	color(double v) Returns a Color for a given double value
double	getPolynomialDegree() Returns the power to raise the normalized distance
protected float	interpolate(float s, float e, float t) Returns the point that is a normalized distance t between s and e
void	rescale(double minV, double maxV) Tells this object the minimum value and the maximum value it can receive.
void	setPolynomialDegree(double polyDegree) Sets the color blend to raise the normalized distance of values to the given degree.

Methods inherited from class java.lang.Object

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

Field Detail

landmarkValues

protected java.util.List<java.lang.Double> landmarkValues

The value position of each landmark

originalLandmarkValues

protected java.util.List<java.lang.Double> originalLandmarkValues

The original set landmark values set before any rescaling was performed.

landmarkColors

protected java.util.List<java.awt.Color> landmarkColors

The landmark colors

polyDegree

protected double polyDegree

The power to raise the normalized distance

Constructor Detail

LandmarkColorBlendInterpolation

public LandmarkColorBlendInterpolation()

LandmarkColorBlendInterpolation

public LandmarkColorBlendInterpolation(double polyDegree)

Initializes the color blend with a power to raise the normalized distance of values.

Parameters:

polyDegree - the polynomial degree to use in interpolation

Method Detail

setPolynomialDegree

public void setPolynomialDegree(double polyDegree)

Sets the color blend to raise the normalized distance of values to the given degree.

Parameters:

polyDegree - the power to raise the normalized distance

getPolynomialDegree

public double getPolynomialDegree()

Returns the power to raise the normalized distance

Returns:

the power to raise the normalized distance

addNextLandMark

public void addNextLandMark(double val,
                            java.awt.Color c)

Adds the next landmark between which interpolation should occur. Assumes that the value val is greater than the last landmark value added.

Parameters:

val - the value of the landmark

c - the color for the landmark

rescale

public void rescale(double minV,
                    double maxV)

Description copied from interface: ColorBlend

Tells this object the minimum value and the maximum value it can receive.

Specified by:

rescale in interface ColorBlend

Parameters:

minV - the minimum value

maxV - the maximum value

color

public java.awt.Color color(double v)

Description copied from interface: ColorBlend

Returns a Color for a given double value

Specified by:

color in interface ColorBlend

Parameters:

v - the input double value

Returns:

a Color for a given double value

interpolate

protected float interpolate(float s,
                            float e,
                            float t)

Returns the point that is a normalized distance t between s and e

Parameters:

s - the start value

e - the end value

t - the normalized distance between s and e

Returns:

the point that is a normalized distance t between s and e