src/jalview/schemes/ScoreColourScheme.java

   1 /*\r
   2 * Jalview - A Sequence Alignment Editor and Viewer\r
   3 * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4 *\r
   5 * This program is free software; you can redistribute it and/or\r
   6 * modify it under the terms of the GNU General Public License\r
   7 * as published by the Free Software Foundation; either version 2\r
   8 * of the License, or (at your option) any later version.\r
   9 *\r
  10 * This program is distributed in the hope that it will be useful,\r
  11 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13 * GNU General Public License for more details.\r
  14 *\r
  15 * You should have received a copy of the GNU General Public License\r
  16 * along with this program; if not, write to the Free Software\r
  17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18 */\r
  19 package jalview.schemes;\r
  20 \r
  21 import java.awt.*;\r
  22 \r
  23 \r
  24 /**\r
  25  * DOCUMENT ME!\r
  26  *\r
  27  * @author $author$\r
  28  * @version $Revision$\r
  29  */\r
  30 public class ScoreColourScheme extends ResidueColourScheme\r
  31 {\r
  32     /** DOCUMENT ME!! */\r
  33     public double min;\r
  34 \r
  35     /** DOCUMENT ME!! */\r
  36     public double max;\r
  37 \r
  38     /** DOCUMENT ME!! */\r
  39     public double[] scores;\r
  40 \r
  41     /**\r
  42      * Creates a new ScoreColourScheme object.\r
  43      *\r
  44      * @param scores DOCUMENT ME!\r
  45      * @param min DOCUMENT ME!\r
  46      * @param max DOCUMENT ME!\r
  47      */\r
  48     public ScoreColourScheme(double[] scores, double min, double max)\r
  49     {\r
  50         super();\r
  51 \r
  52         this.scores = scores;\r
  53         this.min = min;\r
  54         this.max = max;\r
  55 \r
  56         // Make colours in constructor\r
  57         // Why wasn't this done earlier?\r
  58         int i, iSize=scores.length;\r
  59         colors = new Color[scores.length];\r
  60         for (i = 0; i < iSize; i++)\r
  61         {\r
  62           float red = (float) (scores[i] - (float) min) / (float) (max - min);\r
  63 \r
  64           if (red > 1.0f)\r
  65           {\r
  66             red = 1.0f;\r
  67           }\r
  68 \r
  69           if (red < 0.0f)\r
  70           {\r
  71             red = 0.0f;\r
  72           }\r
  73           colors[i] = makeColour(red);\r
  74         }\r
  75     }\r
  76 \r
  77     /**\r
  78      * DOCUMENT ME!\r
  79      *\r
  80      * @param s DOCUMENT ME!\r
  81      * @param j DOCUMENT ME!\r
  82      *\r
  83      * @return DOCUMENT ME!\r
  84      */\r
  85     public Color findColour(String s, int j)\r
  86     {\r
  87         if (threshold > 0)\r
  88         {\r
  89             if (!aboveThreshold(s, j))\r
  90             {\r
  91                 return Color.white;\r
  92             }\r
  93         }\r
  94 \r
  95         char c = s.charAt(0);\r
  96 \r
  97         if (jalview.util.Comparison.isGap(c))\r
  98         {\r
  99             return Color.white;\r
 100         }\r
 101 \r
 102         Color currentColour = colors[ ResidueProperties.aaIndex[c] ];\r
 103 \r
 104         if(conservationColouring)\r
 105           currentColour =  applyConservation(currentColour, j);\r
 106 \r
 107         return currentColour;\r
 108     }\r
 109 \r
 110     /**\r
 111      * DOCUMENT ME!\r
 112      *\r
 113      * @param c DOCUMENT ME!\r
 114      *\r
 115      * @return DOCUMENT ME!\r
 116      */\r
 117     public Color makeColour(float c)\r
 118     {\r
 119         return new Color(c, (float) 0.0, (float) 1.0 - c);\r
 120     }\r
 121 }\r