triana.types

Class ImageMap

java.lang.Object

triana.types.TrianaType

triana.types.TrianaPixelMap

triana.types.ImageMap

All Implemented Interfaces:

java.io.Serializable, SequenceInterface

public class ImageMap
extends TrianaPixelMap

ImageMap contains a PixelMap image and a Key table that describes how a matrix of numbers was converted into the image color values. See class PixelMap for details of the Triana color scale for these maps. ImageMap also contains various parameters that govern how values from a matrix are mapped into colors.

See Also:

Serialized Form

Field Summary

Fields inherited from class triana.types.TrianaPixelMap

pixelMap

Fields inherited from class triana.types.TrianaType

NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors

Constructor and Description
ImageMap() Default constructor.
ImageMap(double[][] matrix, double toRed, double toGreen, double toBlue, boolean loWhite, boolean hiWhite, boolean logarithmic) Constuctor using a matrix and parameters that govern the map.
ImageMap(MatrixType parent, double toRed, double toGreen, double toBlue, boolean loWhite, boolean hiWhite, boolean logarithmic) Constuctor using a MatrixType and parameters that govern the map.

Method Summary

Methods

Modifier and Type	Method and Description
int	colorOf(double data) Returns the Triana Color Map color value associated with a given data value.
protected void	copyData(TrianaType source) Implement the abstract copyData method of TrianaType.
TrianaType	copyMe() This is one of the most important methods of Triana data.
protected void	copyParameters(TrianaType source) Over-ride the copyParameters method to copy the parameter valid.
double	dataFrom(int color) Returns the data value associated with a particular color value.
double[]	getColorKeyTable() Returns the key table that lists the values of the input data associated with each color
MatrixType	getParent() Return a reference to the MatrixType parent so that its graphing information can be used.
boolean	hasParent() Return information as to whether a parent MatrixType exists.
boolean	isHighWhite() Returns true if the data values above that mapped to Blue are mapped to white, false if black
boolean	isLogScale() Returns true if the data values are mapped to colors logarithmically, false if linear
boolean	isLowWhite() Returns true if the data values below that mapped to Red are mapped to white, false if black
void	setColorKeyTable(double[] newKeyTable) Sets the key table that lists the values of the input data associated with each color

Methods inherited from class triana.types.TrianaPixelMap

getPixelMap, getTrianaImage, isValid, setPixelMap, updateObsoletePointers

Methods inherited from class triana.types.TrianaType

containerSize, dataExists, deleteFromContainer, getDataContainer, getFromContainer, getSequenceNumber, insertIntoContainer, inspectDataContainer, setDataContainer, setSequenceNumber

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageMap

public ImageMap()

Default constructor.

ImageMap

public ImageMap(double[][] matrix,
        double toRed,
        double toGreen,
        double toBlue,
        boolean loWhite,
        boolean hiWhite,
        boolean logarithmic)

Constuctor using a matrix and parameters that govern the map.

Parameters:

matrix - The input data matrix

toRed - The data value mapped to the lowest color (0)

toGreen - The data value mapped to the middle color (127)

toBlue - The data value mapped to the highest color (255)

loWhite - true if values below toRed are white, false if black

hiWhite - true if values above toBlue are white, false if black

logarithmic - true if the scaling to color values is logarithmic, false if linear

ImageMap

public ImageMap(MatrixType parent,
        double toRed,
        double toGreen,
        double toBlue,
        boolean loWhite,
        boolean hiWhite,
        boolean logarithmic)

Constuctor using a MatrixType and parameters that govern the map. This should be the normal way to do create an ImageMap in Triana. Only the real part of the data held in the MatrixType parent is used.

Parameters:

parent - The input MatrixType whose data is used

toRed - The data value mapped to the lowest color (0)

toGreen - The data value mapped to the middle color (127)

toBlue - The data value mapped to the highest color (255)

loWhite - true if values below toRed are white, false if black

hiWhite - true if values above toBlue are white, false if black

logarithmic - true if the scaling to color values is logarithmic, false if linear

Method Detail

getColorKeyTable

public double[] getColorKeyTable()

Returns the key table that lists the values of the input data associated with each color

Returns:

double[] The values of the input data for each color

isHighWhite

public boolean isHighWhite()

Returns true if the data values above that mapped to Blue are mapped to white, false if black

Returns:

boolean true if the data values above Blue are White

isLowWhite

public boolean isLowWhite()

Returns true if the data values below that mapped to Red are mapped to white, false if black

Returns:

boolean true if the data values below Red are White

isLogScale

public boolean isLogScale()

Returns true if the data values are mapped to colors logarithmically, false if linear

Returns:

boolean true if the data values are mapped to colors logarithmically

setColorKeyTable

public void setColorKeyTable(double[] newKeyTable)

Sets the key table that lists the values of the input data associated with each color

Parameters:

newKeyTable - The values of the input data for each color

getParent

public MatrixType getParent()

Return a reference to the MatrixType parent so that its graphing information can be used.

Returns:

MatrixType The parent object that provided the data

hasParent

public boolean hasParent()

Return information as to whether a parent MatrixType exists.

Returns:

boolean True if the present object was derived from a MatrixType

colorOf

public int colorOf(double data)

Returns the Triana Color Map color value associated with a given data value. To convert this to rgb values, use the class methods of class PixelMap, such as PixelMap.rgbOf(). The Triana Color Map is defined in PixelMap.

Parameters:

data - The data value

Returns:

The Triana Color Map color value associated with the given data value

dataFrom

public double dataFrom(int color)

Returns the data value associated with a particular color value. To obtain the color value from an rgb int, use the class methods of class PixelMap, such as PixelMap.colorOf(). The Triana Color Map is defined in PixelMap.

Parameters:

color - The Triana Color Map color value

Returns:

The data value associated with the given color value

copyMe

public TrianaType copyMe()

This is one of the most important methods of Triana data. types. It returns a copy of the type invoking it. This must be overridden for every derived data type derived. If not, the data cannot be copied to be given to other units. Copying must be done by value, not by reference.

To override, the programmer should not invoke the super.copyMe method. Instead, create an object of the current type and call methods copyData and copyParameters. If these have been written correctly, then they will do the copying. The code should createTool, for type YourType:

 YourType y = null; try { y =
 (YourType)getClass().newInstance(); y.copyData( this ); y.copyParameters( this ); y.setLegend( this.getLegend()
 ); } catch (IllegalAccessException ee) { System.out.println("Illegal Access: " + ee.getMessage()); } catch
 (InstantiationException ee) { System.out.println("Couldn't be instantiated: " + ee.getMessage()); } return y;
 

The copied object's data should be identical to the original. The method here modifies only one item: a String indicating that the object was created as a copy is added to the description StringVector.

Overrides:

copyMe in class TrianaPixelMap

Returns:

TrianaType Copy by value of the current Object except for an updated description

copyData

protected void copyData(TrianaType source)

Implement the abstract copyData method of TrianaType. This copies an image from the given object to the present one.

Overrides:

copyData in class TrianaPixelMap

Parameters:

source - The TrianaImage whose image is being copied

copyParameters

protected void copyParameters(TrianaType source)

Over-ride the copyParameters method to copy the parameter valid.

Overrides:

copyParameters in class TrianaPixelMap

Parameters:

source - The object from which the copy will be made