TestPalette (Demo 2.1.1 API)

java.lang.Object
- org.tinfour.demo.utils.TestPalette

```
public class TestPalette
extends Object
```
Provides definitions and operations for assigning color values to data.

Constructor Summary

Constructors
Constructor and Description
`TestPalette()` Default constructor using the blue to yellow palette.
`TestPalette(String name, float[][] rgb)` Construct a palette colorizer using the palette specified as an array of red/green/blue values in the range 0 to 255.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getARGB(double z, double zMin, double zMax)` Assigns a color value in the ARGB system to a z value based on its position within a range of values and the palette associated with this instance.
`static TestPalette`	`getBlueToYellowPalette()` Gets an instance of the palette colorizer using the blue-to-yellow palette.
`Color`	`getColor(double z, double zMin, double zMax)` Assigns a Color object to a z value based on its position within a range of values and the palette associated with this instance.
`static TestPalette`	`getDefaultPalette()` Gets an instance of the palette colorizer using the default palette.
`static Icon`	`getIconByName(String name, int width, int height)` Gets an icon depicting the palette for User Interface purposes.
`static TestPalette`	`getLinearGrayPalette()` Constructs an instance of the palette colorizer using the a linear interpolation of values in the RGB color space.
`String`	`getName()` Gets the name of the palette
`static TestPalette`	`getPaletteByName(String paletteName)` Gets the palette specified by name
`static List<String>`	`getPaletteNames()` Gets a list of the names of palettes defined by this class.
`static TestPalette`	`getPurpleTonesPalette()` Gets an instance of the palette colorizer using the purple-tones palette.
`static TestPalette`	`getRainbowPalette()` Constructs an instance of the palette colorizer using the rainbow palette.
`static TestPalette`	`getRedToYellowToWhitePalette()` Constructs an instance of the palette colorizer using the red-to-yellow-to-white palette.
`static void`	`loadRecipiesFromStream(InputStream ins, boolean flip)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TestPalette
```
public TestPalette(String name,
                   float[][] rgb)
```
    Construct a palette colorizer using the palette specified as an array of red/green/blue values in the range 0 to 255.
    
    Parameters:
    
    name - the name of the palette (null if not used)
    
    rgb - an n by 3 array of rgb values.
  - TestPalette
```
public TestPalette()
```
    Default constructor using the blue to yellow palette.
- Method Detail
  - getBlueToYellowPalette
```
public static TestPalette getBlueToYellowPalette()
```
    Gets an instance of the palette colorizer using the blue-to-yellow palette. The palette used is based on the CIE LCH model which tends to give better color transitions for the blue-to-yellow range than the simpler RGB model.
    
    Returns:
    
    a valid instance.
  - getDefaultPalette
```
public static TestPalette getDefaultPalette()
```
    Gets an instance of the palette colorizer using the default palette. The choice of palette for this routine is undefined and subject to change.
    
    Returns:
    
    a valid instance.
  - getPurpleTonesPalette
```
public static TestPalette getPurpleTonesPalette()
```
    Gets an instance of the palette colorizer using the purple-tones palette. The palette used is based on the CIE LCH model which tends to give better color transitions for the blue-to-yellow range than the simpler RGB model.
    
    Returns:
    
    a valid instance.
  - getRedToYellowToWhitePalette
```
public static TestPalette getRedToYellowToWhitePalette()
```
    Constructs an instance of the palette colorizer using the red-to-yellow-to-white palette.
    
    Returns:
    
    a valid instance.
  - getRainbowPalette
```
public static TestPalette getRainbowPalette()
```
    Constructs an instance of the palette colorizer using the rainbow palette.
    
    Returns:
    
    a valid instance.
  - getLinearGrayPalette
```
public static TestPalette getLinearGrayPalette()
```
    Constructs an instance of the palette colorizer using the a linear interpolation of values in the RGB color space.
    
    Returns:
    
    a valid instance.
  - getARGB
```
public int getARGB(double z,
                   double zMin,
                   double zMax)
```
    Assigns a color value in the ARGB system to a z value based on its position within a range of values and the palette associated with this instance.
    The alpha channel value (high-order byte) for the return is always set to fully opaque for valid inputs. If given a undefined input value (Double.NaN), a zero (fully transparent) value will be returned. If given a z value outside the specified region, its value will be constrained as necessary.
    
    Parameters:
    
    z - the z value of interest
    
    zMin - the value associated with the minimum-index color in the palette.
    
    zMax - the value associated with the maximum-index color in the palette.
    
    Returns:
    
    an integer in the ARGB format
  - getColor
```
public Color getColor(double z,
                      double zMin,
                      double zMax)
```
    Assigns a Color object to a z value based on its position within a range of values and the palette associated with this instance.
    The alpha channel value (high-order byte) for the return is always set to fully opaque for valid inputs. If given a undefined input value (Double.NaN), a zero (fully transparent) value will be returned. If given a z value outside the specified region, its value will be constrained as necessary.
    
    Parameters:
    
    z - the z value of interest
    
    zMin - the value associated with the minimum-index color in the palette.
    
    zMax - the value associated with the maximum-index color in the palette.
    
    Returns:
    
    an integer in the ARGB format
  - getPaletteByName
```
public static TestPalette getPaletteByName(String paletteName)
```
    Gets the palette specified by name
    
    Parameters:
    
    paletteName - a valid string matching one a named palette defined by this class.
    
    Returns:
    
    if found, a valid palette; otherwise, a null
  - getPaletteNames
```
public static List<String> getPaletteNames()
```
    Gets a list of the names of palettes defined by this class.
    
    Returns:
    
    a valid, non-empty list.
  - getName
```
public String getName()
```
    Gets the name of the palette
    
    Returns:
    
    a valid string.
  - getIconByName
```
public static Icon getIconByName(String name,
                                 int width,
                                 int height)
```
    Gets an icon depicting the palette for User Interface purposes.
    
    Parameters:
    
    name - the name of the palette
    
    width - the width of the icon
    
    height - the height of the icon
    
    Returns:
    
    if the name is recognized, a valid icon; otherwise, a null.
  - loadRecipiesFromStream
```
public static void loadRecipiesFromStream(InputStream ins,
                                          boolean flip)
                                   throws IOException,
                                          NumberFormatException
```
    Throws:
    
    IOException
    
    NumberFormatException

Class TestPalette

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TestPalette

TestPalette

Method Detail

getBlueToYellowPalette

getDefaultPalette

getPurpleTonesPalette

getRedToYellowToWhitePalette

getRainbowPalette

getLinearGrayPalette

getARGB

getColor

getPaletteByName

getPaletteNames

getName

getIconByName

loadRecipiesFromStream