org.epics.graphene

Class ValueColorSchemes

java.lang.Object

org.epics.graphene.ValueColorSchemes

public class ValueColorSchemes
extends Object

The ValueColorSchemes class contains several useful methods to associate a ValueColorScheme with a ColorScheme. It cannot be instantiated.

The ValueColorSchemes class has preset colors that represent a color scheme that can be associated with any range to create a value range. There are various predefined scales that can be found in ColorScheme.

Author:

carcassi, sjdallst, asbarber, jkfeng

Method Summary

Methods

Modifier and Type	Method and Description
static ValueColorScheme	boneScale(Range range) Returns a color scheme that varies linearly (black:dark blue:blue:light blue:white) for values within range.
static ValueColorScheme	coolScale(Range range) Returns a color scheme that varies linearly (cyan:magenta) for values within range.
static ValueColorScheme	copperScale(Range range) Returns a color scheme that varies linearly (black:dark brown:brown:light brown:tan) for values within range.
static ValueColorScheme	grayScale(Range range) Returns a color scheme that varies linearly (black:white) for values within range.
static ValueColorScheme	hotScale(Range range) Returns a color scheme that varies linearly (dark red:red:yellow:white) for values within range.
static ValueColorScheme	jetScale(Range range) Returns a color scheme that varies linearly (dark blue:blue:cyan:yellow:red:dark red) for values within range.
static ValueColorScheme	pinkScale(Range range) Returns a color scheme that varies linearly (dark red:dark pink:light pink) for values within range.
static ValueColorScheme	RangeGradient(Range range, ArrayList<Color> colors, ArrayList<Double> percentages) Returns a ValueColorScheme that varies linearly from color to color based on percentage.
static ValueColorScheme	schemeFor(ColorScheme color, Range range) Creates a Value scheme associated with the Color scheme and range.
static ValueColorScheme	singleRangeGradient(Range range, Color minValueColor, Color maxValueColor, Color nanColor) Returns a ValueColorScheme that varies linearly from one color to the next, based on range.
static ValueColorScheme	springScale(Range range) Returns a color scheme that varies linearly (magenta:yellow) for values within range.

Methods inherited from class java.lang.Object

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

Method Detail

schemeFor

public static ValueColorScheme schemeFor(ColorScheme color,
                         Range range)

Creates a Value scheme associated with the Color scheme and range. An unrecognized or null ColorScheme is handled as gray scale.

Parameters:

color - the color scheme to create a value scheme for

range - associates colors from a color scheme for different values within the range, can not be null

Returns:

a Value scheme for the specified Color scheme

grayScale

public static ValueColorScheme grayScale(Range range)

Returns a color scheme that varies linearly (black:white) for values within range. NaN = red: Single value case = black

Parameters:

range - can not be null.

Returns:

gray color range for the value range

jetScale

public static ValueColorScheme jetScale(Range range)

Returns a color scheme that varies linearly (dark blue:blue:cyan:yellow:red:dark red) for values within range. NaN = black: Single value case = cyan

Parameters:

range - can not be null

Returns:

jet (blue to yellow to red) color range for the value range

hotScale

public static ValueColorScheme hotScale(Range range)

Returns a color scheme that varies linearly (dark red:red:yellow:white) for values within range. NaN = blue: Single value case = red

Parameters:

range - can not be null

Returns:

hot (red to white) color range for the value range

coolScale

public static ValueColorScheme coolScale(Range range)

Returns a color scheme that varies linearly (cyan:magenta) for values within range. NaN = red: Single value case = cyan

Parameters:

range - can not be null

Returns:

cool (cyan to magenta) color range for the value range

springScale

public static ValueColorScheme springScale(Range range)

Returns a color scheme that varies linearly (magenta:yellow) for values within range. NaN = red: Single value case = magenta

Parameters:

range - can not be null

Returns:

spring (magenta to yellow) color range for the value range

boneScale

public static ValueColorScheme boneScale(Range range)

Returns a color scheme that varies linearly (black:dark blue:blue:light blue:white) for values within range. NaN = red: Single value case = blue

Parameters:

range - can not be null

Returns:

bone (black to blue to white) color range for the value range

copperScale

public static ValueColorScheme copperScale(Range range)

Returns a color scheme that varies linearly (black:dark brown:brown:light brown:tan) for values within range. NaN = red: Single value case = brown

Parameters:

range - can not be null

Returns:

copper (black to brown to tan) color range for the value range

pinkScale

public static ValueColorScheme pinkScale(Range range)

Returns a color scheme that varies linearly (dark red:dark pink:light pink) for values within range. NaN = red: Single value case = dark pink

Parameters:

range - can not be null

Returns:

pink (red to pink) color range for the value range

singleRangeGradient

public static ValueColorScheme singleRangeGradient(Range range,
                                   Color minValueColor,
                                   Color maxValueColor,
                                   Color nanColor)

Returns a ValueColorScheme that varies linearly from one color to the next, based on range.

Parameters:

range - can not be null

minValueColor - color that will be used for the lowest value in range. Can not be null.

maxValueColor - color that will be used for the highest value in range. Can not be null.

nanColor - color to be returned when value is NaN.

Returns:

linear value to color transformation scheme between two colors

RangeGradient

public static ValueColorScheme RangeGradient(Range range,
                             ArrayList<Color> colors,
                             ArrayList<Double> percentages)

Returns a ValueColorScheme that varies linearly from color to color based on percentage.

Parameters:

range - can not be null

colors - an ArrayList that specifies what colors ValueColorScheme will use. The last value should correspond to the color to be used when value is NaN.

percentages - an ArrayList that corresponds to colors, specifying what color corresponds to what percentage of range.

Returns:

linear value to color transformation scheme between multiple colors