src/jalview/schemes/ResidueColourScheme.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 jalview.analysis.*;\r
  22 \r
  23 import java.awt.*;\r
  24 \r
  25 import java.util.*;\r
  26 \r
  27 \r
  28 /**\r
  29  * DOCUMENT ME!\r
  30  *\r
  31  * @author $author$\r
  32  * @version $Revision$\r
  33  */\r
  34 public class ResidueColourScheme implements ColourSchemeI\r
  35 {\r
  36 \r
  37     boolean conservationColouring = false;\r
  38     boolean consensusColouring = false;\r
  39 \r
  40     Color[] colors;\r
  41     int threshold = 0;\r
  42 \r
  43     /* Set when threshold colouring to either pid_gaps or pid_nogaps*/\r
  44     protected String ignoreGaps = AAFrequency.PID_GAPS;\r
  45 \r
  46     /** Consenus as a hashtable array */\r
  47     Hashtable [] consensus;\r
  48 \r
  49     /** Conservation string as a char array */\r
  50    char [] conservation;\r
  51 \r
  52    /** DOCUMENT ME!! */\r
  53    int inc = 30;\r
  54 \r
  55    /**\r
  56     * The colour to be calculated, manipulated and returned\r
  57     */\r
  58    Color currentColour = null;\r
  59 \r
  60 \r
  61 \r
  62     /**\r
  63      * Creates a new ResidueColourScheme object.\r
  64      *\r
  65      * @param colors DOCUMENT ME!\r
  66      * @param threshold DOCUMENT ME!\r
  67      */\r
  68     public ResidueColourScheme(Color[] colours, int threshold)\r
  69     {\r
  70         this.colors = colours;\r
  71         this.threshold = threshold;\r
  72     }\r
  73 \r
  74     /**\r
  75      * Creates a new ResidueColourScheme object.\r
  76      */\r
  77     public ResidueColourScheme()\r
  78     {\r
  79     }\r
  80 \r
  81     /**\r
  82     * Find a colour without an index in a sequence\r
  83     */\r
  84    public Color findColour(String aa)\r
  85    {\r
  86        return colors[ResidueProperties.aaIndex[aa.charAt(0)]];\r
  87    }\r
  88 \r
  89 \r
  90 \r
  91    public Color findColour(String s, int j)\r
  92    {\r
  93 \r
  94        int index = ResidueProperties.aaIndex[s.charAt(0)];\r
  95 \r
  96        if ((threshold == 0) || aboveThreshold(ResidueProperties.aa[index], j))\r
  97        {\r
  98            currentColour = colors[index];\r
  99        }\r
 100        else\r
 101        {\r
 102            currentColour = Color.white;\r
 103        }\r
 104 \r
 105        if(conservationColouring)\r
 106          applyConservation(j);\r
 107 \r
 108 \r
 109        return currentColour;\r
 110    }\r
 111 \r
 112 \r
 113     /**\r
 114      * Get the percentage threshold for this colour scheme\r
 115      *\r
 116      * @return Returns the percentage threshold\r
 117      */\r
 118     public int getThreshold()\r
 119     {\r
 120         return threshold;\r
 121     }\r
 122 \r
 123     /**\r
 124      * DOCUMENT ME!\r
 125      *\r
 126      * @param ct DOCUMENT ME!\r
 127      */\r
 128     public void setThreshold(int ct, boolean ignoreGaps)\r
 129     {\r
 130         threshold = ct;\r
 131         if(ignoreGaps)\r
 132           this.ignoreGaps = AAFrequency.PID_NOGAPS;\r
 133         else\r
 134           this.ignoreGaps = AAFrequency.PID_GAPS;\r
 135     }\r
 136 \r
 137     /**\r
 138      * DOCUMENT ME!\r
 139      *\r
 140      * @param s DOCUMENT ME!\r
 141      * @param j DOCUMENT ME!\r
 142      *\r
 143      * @return DOCUMENT ME!\r
 144      */\r
 145     public boolean aboveThreshold(String s, int j)\r
 146     {\r
 147       char c = s.charAt(0);\r
 148       if ('a' <= c && c <= 'z')\r
 149         {\r
 150           // TO UPPERCASE !!!\r
 151           //Faster than toUpperCase\r
 152           c -= ('a' - 'A');\r
 153           s = String.valueOf(c);\r
 154         }\r
 155 \r
 156         if (consensus == null || consensus[j] == null)\r
 157           return false;\r
 158 \r
 159         if ( ( ( (Integer) consensus[j].get(AAFrequency.MAXCOUNT)).intValue() != -1) &&\r
 160             consensus[j].contains(s))\r
 161         {\r
 162           if ( ( (Float) consensus[j].get(ignoreGaps)).floatValue() >= threshold)\r
 163           {\r
 164             return true;\r
 165           }\r
 166         }\r
 167 \r
 168         return false;\r
 169     }\r
 170 \r
 171 \r
 172     public boolean conservationApplied()\r
 173     {\r
 174       return conservationColouring;\r
 175     }\r
 176 \r
 177     public void setConservationInc(int i)\r
 178     {\r
 179       inc = i;\r
 180     }\r
 181 \r
 182     public int getConservationInc()\r
 183     {\r
 184       return inc;\r
 185     }\r
 186 \r
 187     /**\r
 188      * DOCUMENT ME!\r
 189      *\r
 190      * @param consensus DOCUMENT ME!\r
 191      */\r
 192     public void setConsensus(Hashtable [] consensus)\r
 193     {\r
 194       if(consensus==null)\r
 195         return;\r
 196 \r
 197       this.consensus = consensus;\r
 198     }\r
 199 \r
 200 \r
 201 \r
 202     public void setConservation(Conservation cons)\r
 203     {\r
 204       if(cons==null)\r
 205       {\r
 206         conservationColouring = false;\r
 207         conservation = null;\r
 208       }\r
 209       else\r
 210       {\r
 211         conservationColouring = true;\r
 212         int i, iSize = cons.getConsSequence().getLength();\r
 213         conservation = new char[iSize];\r
 214         for (i = 0; i < iSize; i++)\r
 215           conservation[i] = cons.getConsSequence().getCharAt(i);\r
 216       }\r
 217 \r
 218     }\r
 219 \r
 220 \r
 221     /**\r
 222     * DOCUMENT ME!\r
 223     *\r
 224     * @param s DOCUMENT ME!\r
 225     * @param i DOCUMENT ME!\r
 226     *\r
 227     * @return DOCUMENT ME!\r
 228     */\r
 229 \r
 230    void applyConservation(int i)\r
 231    {\r
 232 \r
 233      if ((conservation[i] != '*') && (conservation[i] != '+'))\r
 234      {\r
 235        if(jalview.util.Comparison.isGap(conservation[i]))\r
 236        {\r
 237          currentColour = Color.white;\r
 238        }\r
 239        else\r
 240        {\r
 241          float t = 11 - (conservation[i] - '0');\r
 242          if(t==0)\r
 243          {\r
 244            currentColour = Color.white;\r
 245            return;\r
 246          }\r
 247 \r
 248          int red = currentColour.getRed();\r
 249          int green = currentColour.getGreen();\r
 250          int blue = currentColour.getBlue();\r
 251 \r
 252          int dr = 255 - red;\r
 253          int dg = 255 - green;\r
 254          int db = 255 - blue;\r
 255 \r
 256          dr *= t / 10f;\r
 257          dg *= t / 10f;\r
 258          db *= t / 10f;\r
 259 \r
 260          red += (inc / 20f) * dr;\r
 261          green += (inc / 20f) * dg;\r
 262          blue += (inc / 20f) * db;\r
 263 \r
 264          if (red > 255 || green > 255 || blue > 255)\r
 265            currentColour = Color.white;\r
 266          else\r
 267            currentColour = new Color(red, green, blue);\r
 268        }\r
 269        }\r
 270    }\r
 271 \r
 272 \r
 273 }\r