ColorMap.java

Go to the documentation of this file.

/*
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2007 - INRIA - Jean-Baptiste Silvy
 * desc : Class to handle Scilab colormaps
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 *
 */

package org.scilab.modules.renderer.utils;


public class ColorMap {
        
        private static final String COMMA = ", ";
        
        private static final int NBCOL = 3;
        
        private static final int BLACK_INDEX = -1;
        private static final int WHITE_INDEX = -2;
        
        private double[] redChannel;
        private double[] greenChannel;
        private double[] blueChannel;
        private int colormapSize;
        
        public ColorMap() {
          redChannel   = null;
          greenChannel = null;
          blueChannel  = null;
          colormapSize = 0;
        }
        
        public static ColorMap create() {
                return new ColorMap();
        }
        
        public void getColor(int colorIndex, double[] color) {
                color[0] = getRedChannel(colorIndex);
                color[1] = getGreenChannel(colorIndex);
                color[2] = getBlueChannel(colorIndex);
        }
        
        public double[] getColor(int colorIndex) {
                double[] res = new double[NBCOL];
                getColor(colorIndex, res);
                return res;
        }
        
        public double[][] getColors(int[] colorIndices) {
                int nbIndices = colorIndices.length;
                double[][] res = new double[nbIndices][];
                for (int i = 0; i < nbIndices; i++) {
                        res[i] = getColor(colorIndices[i]);
                }
                return res;
        }
        
        public double getRedChannel(int colorIndex) {
                return redChannel[clampColorIndex(colorIndex)];
        }
        
        public double getGreenChannel(int colorIndex) {
                return greenChannel[clampColorIndex(colorIndex)];
        }
        
        public double getBlueChannel(int colorIndex) {
                return blueChannel[clampColorIndex(colorIndex)];
        }
        
        public int clampColorIndex(int colorIndex) {
                if (colorIndex <= 0) {
                        return 0;
                } else if (colorIndex >= colormapSize + 1) {
                        return colormapSize + 1;
                } else {
                        return colorIndex;
                }
        }
        
        public void setData(double[] newData) {
                
                // new size
                setSize(newData.length / NBCOL);
                
                // red channel
                System.arraycopy(newData, 0, redChannel, 0, colormapSize);
                
                // green channel
                System.arraycopy(newData, colormapSize, greenChannel, 0, colormapSize);

                // blue channel
                System.arraycopy(newData, 2 * colormapSize, blueChannel, 0, colormapSize);

        }
        
        public double[] getData() {
                double[] res = new double[NBCOL * colormapSize];
                getData(res);
                return res;
        }
        
        public void getData(double[] data) {
                // copy channels
                System.arraycopy(redChannel  , 0, data,                0, colormapSize);
                System.arraycopy(greenChannel, 0, data,     colormapSize, colormapSize);
                System.arraycopy(blueChannel , 0, data, 2 * colormapSize, colormapSize);
        }
        
        public int getSize() {
                return colormapSize;
        }
        
        public void setSize(int newSize) {
                colormapSize = newSize;
                redChannel = new double[colormapSize + 2]; // +2 for black and white
                greenChannel = new double[colormapSize + 2]; // +2 for black and white
                blueChannel = new double[colormapSize + 2]; // +2 for black and white
                
                // add black and whit colors
                redChannel[colormapSize    ] = 0.0; // black
                redChannel[colormapSize + 1] = 1.0; // white
                
                // green channel
                greenChannel[colormapSize    ] = 0.0; // black
                greenChannel[colormapSize + 1] = 1.0; // white
                
                // blue channel
                blueChannel[colormapSize    ] = 0.0; // black
                blueChannel[colormapSize + 1] = 1.0; // white
        }
        
        public void setColor(int index, double[] color) {
                redChannel[index] = color[0];
                greenChannel[index] = color[1];
                blueChannel[index] = color[2];
        }
        
        public int convertScilabToColorMapIndex(int scilabIndex) {
                if (scilabIndex == BLACK_INDEX || scilabIndex == 0) {
                        // black color
                        return colormapSize;
                } else if (scilabIndex == WHITE_INDEX) {
                        // white color
                        return colormapSize + 1;
                } else if (scilabIndex < WHITE_INDEX) {
                        // first index
                        return 0;
                } else if (scilabIndex >= colormapSize) {
                        // last index
                        return colormapSize - 1;
                } else {
                        return scilabIndex - 1;
                }
        }
        
        public String toString() {
                String res = "";
                for (int i = 0; i < getSize() + 2; i++) {
                        res += "[" + redChannel[i] + COMMA + greenChannel[i] + COMMA + blueChannel[i] + "]\n";
                }
                return res;
        }
}

---