src/jalview/schemes/ClustalxColourScheme.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.schemes;
  22
  23 import jalview.datamodel.AnnotatedCollectionI;
  24 import jalview.datamodel.SequenceCollectionI;
  25 import jalview.datamodel.SequenceI;
  26
  27 import java.awt.Color;
  28 import java.util.HashMap;
  29 import java.util.List;
  30 import java.util.Map;
  31
  32 public class ClustalxColourScheme extends ResidueColourScheme
  33 {
  34   private static final int EIGHTY_FIVE = 85;
  35
  36   private static final int FIFTY = 50;
  37
  38   private static final int EIGHTY = 80;
  39
  40   private static final int SIXTY = 60;
  41
  42   /*
  43    * Map from conventional colour names to Clustal version of the same
  44    */
  45   private static Map<Color, Color> colhash = new HashMap<Color, Color>();
  46
  47   private int[][] cons2;
  48
  49   private ConsensusColour[] colours;
  50
  51   private ConsensusColour[] residueColour;
  52
  53   private int size;
  54
  55   private Consensus[] conses = new Consensus[32];
  56
  57   private boolean includeGaps = true;
  58
  59   static
  60   {
  61     colhash.put(Color.RED, new Color(0.9f, 0.2f, 0.1f));
  62     colhash.put(Color.BLUE, new Color(0.5f, 0.7f, 0.9f));
  63     colhash.put(Color.GREEN, new Color(0.1f, 0.8f, 0.1f));
  64     colhash.put(Color.ORANGE, new Color(0.9f, 0.6f, 0.3f));
  65     colhash.put(Color.CYAN, new Color(0.1f, 0.7f, 0.7f));
  66     colhash.put(Color.PINK, new Color(0.9f, 0.5f, 0.5f));
  67     colhash.put(Color.MAGENTA, new Color(0.8f, 0.3f, 0.8f));
  68     colhash.put(Color.YELLOW, new Color(0.8f, 0.8f, 0.0f));
  69   }
  70
  71   public ClustalxColourScheme(AnnotatedCollectionI alignment,
  72           Map<SequenceI, SequenceCollectionI> hiddenReps)
  73   {
  74     alignmentChanged(alignment, hiddenReps);
  75   }
  76
  77   @Override
  78   public void alignmentChanged(AnnotatedCollectionI alignment,
  79           Map<SequenceI, SequenceCollectionI> hiddenReps)
  80   {
  81     int maxWidth = alignment.getWidth();
  82     List<SequenceI> seqs = alignment.getSequences(hiddenReps);
  83     cons2 = new int[maxWidth][24];
  84     includeGaps = isIncludeGaps(); // does nothing - TODO replace with call to
  85     // get the current setting of the
  86     // includeGaps param.
  87     int start = 0;
  88
  89     // Initialize the array
  90     for (int j = 0; j < 24; j++)
  91     {
  92       for (int i = 0; i < maxWidth; i++)
  93       {
  94         cons2[i][j] = 0;
  95       }
  96     }
  97
  98     int res;
  99     int i;
 100     int j = 0;
 101     char[] seq;
 102
 103     for (SequenceI sq : seqs)
 104     {
 105       seq = sq.getSequence();
 106
 107       int end_j = seq.length - 1;
 108
 109       for (i = start; i <= end_j; i++)
 110       {
 111         if ((seq.length - 1) < i)
 112         {
 113           res = 23;
 114         }
 115         else
 116         {
 117           res = ResidueProperties.aaIndex[seq[i]];
 118         }
 119
 120         cons2[i][res]++;
 121       }
 122
 123       j++;
 124     }
 125
 126     this.size = seqs.size();
 127     makeColours();
 128   }
 129
 130   public void makeColours()
 131   {
 132     conses[0] = new Consensus("WLVIMAFCYHP", SIXTY);
 133     conses[1] = new Consensus("WLVIMAFCYHP", EIGHTY);
 134     conses[2] = new Consensus("ED", FIFTY);
 135     conses[3] = new Consensus("KR", SIXTY);
 136     conses[4] = new Consensus("G", FIFTY);
 137     conses[5] = new Consensus("N", FIFTY);
 138     conses[6] = new Consensus("QE", FIFTY);
 139     conses[7] = new Consensus("P", FIFTY);
 140     conses[8] = new Consensus("TS", FIFTY);
 141
 142     conses[26] = new Consensus("A", EIGHTY_FIVE);
 143     conses[27] = new Consensus("C", EIGHTY_FIVE);
 144     conses[10] = new Consensus("E", EIGHTY_FIVE);
 145     conses[11] = new Consensus("F", EIGHTY_FIVE);
 146     conses[12] = new Consensus("G", EIGHTY_FIVE);
 147     conses[13] = new Consensus("H", EIGHTY_FIVE);
 148     conses[14] = new Consensus("I", EIGHTY_FIVE);
 149     conses[15] = new Consensus("L", EIGHTY_FIVE);
 150     conses[16] = new Consensus("M", EIGHTY_FIVE);
 151     conses[17] = new Consensus("N", EIGHTY_FIVE);
 152     conses[18] = new Consensus("P", EIGHTY_FIVE);
 153     conses[19] = new Consensus("Q", EIGHTY_FIVE);
 154     conses[20] = new Consensus("R", EIGHTY_FIVE);
 155     conses[21] = new Consensus("S", EIGHTY_FIVE);
 156     conses[22] = new Consensus("T", EIGHTY_FIVE);
 157     conses[23] = new Consensus("V", EIGHTY_FIVE);
 158     conses[24] = new Consensus("W", EIGHTY_FIVE);
 159     conses[25] = new Consensus("Y", EIGHTY_FIVE);
 160     conses[28] = new Consensus("K", EIGHTY_FIVE);
 161     conses[29] = new Consensus("D", EIGHTY_FIVE);
 162
 163     conses[30] = new Consensus("G", 0);
 164     conses[31] = new Consensus("P", 0);
 165
 166     // We now construct the colours
 167     colours = new ConsensusColour[11];
 168
 169     Consensus[] tmp8 = new Consensus[1];
 170     tmp8[0] = conses[30]; // G
 171     colours[7] = new ConsensusColour(colhash.get(Color.ORANGE), tmp8);
 172
 173     Consensus[] tmp9 = new Consensus[1];
 174     tmp9[0] = conses[31]; // P
 175     colours[8] = new ConsensusColour(colhash.get(Color.YELLOW), tmp9);
 176
 177     Consensus[] tmp10 = new Consensus[1];
 178     tmp10[0] = conses[27]; // C
 179     colours[9] = new ConsensusColour(colhash.get(Color.PINK), tmp8);
 180
 181     Consensus[] tmp1 = new Consensus[14];
 182     tmp1[0] = conses[0]; // %
 183     tmp1[1] = conses[1]; // #
 184     tmp1[2] = conses[26]; // A
 185     tmp1[3] = conses[27]; // C
 186     tmp1[4] = conses[11]; // F
 187     tmp1[5] = conses[13]; // H
 188     tmp1[6] = conses[14]; // I
 189     tmp1[7] = conses[15]; // L
 190     tmp1[8] = conses[16]; // M
 191     tmp1[9] = conses[23]; // V
 192     tmp1[10] = conses[24]; // W
 193     tmp1[11] = conses[25]; // Y
 194     tmp1[12] = conses[18]; // P
 195     tmp1[13] = conses[19]; // p
 196     colours[0] = new ConsensusColour(colhash.get(Color.BLUE), tmp1);
 197
 198     colours[10] = new ConsensusColour(colhash.get(Color.CYAN), tmp1);
 199
 200     Consensus[] tmp2 = new Consensus[5];
 201     tmp2[0] = conses[8]; // t
 202     tmp2[1] = conses[21]; // S
 203     tmp2[2] = conses[22]; // T
 204     tmp2[3] = conses[0]; // %
 205     tmp2[4] = conses[1]; // #
 206     colours[1] = new ConsensusColour(colhash.get(Color.GREEN), tmp2);
 207
 208     Consensus[] tmp3 = new Consensus[3];
 209
 210     tmp3[0] = conses[17]; // N
 211     tmp3[1] = conses[29]; // D
 212     tmp3[2] = conses[5]; // n
 213     colours[2] = new ConsensusColour(colhash.get(Color.GREEN), tmp3);
 214
 215     Consensus[] tmp4 = new Consensus[6];
 216     tmp4[0] = conses[6]; // q = QE
 217     tmp4[1] = conses[19]; // Q
 218     tmp4[2] = conses[22]; // E
 219     tmp4[3] = conses[3]; // +
 220     tmp4[4] = conses[28]; // K
 221     tmp4[5] = conses[20]; // R
 222     colours[3] = new ConsensusColour(colhash.get(Color.GREEN), tmp4);
 223
 224     Consensus[] tmp5 = new Consensus[4];
 225     tmp5[0] = conses[3]; // +
 226     tmp5[1] = conses[28]; // K
 227     tmp5[2] = conses[20]; // R
 228     tmp5[3] = conses[19]; // Q
 229     colours[4] = new ConsensusColour(colhash.get(Color.RED), tmp5);
 230
 231     Consensus[] tmp6 = new Consensus[6];
 232     tmp6[0] = conses[3]; // -
 233     tmp6[1] = conses[29]; // D
 234     tmp6[2] = conses[10]; // E
 235     tmp6[3] = conses[6]; // QE
 236     tmp6[4] = conses[19]; // Q
 237     tmp6[5] = conses[2]; // DE
 238     colours[5] = new ConsensusColour(colhash.get(Color.MAGENTA), tmp6);
 239
 240     Consensus[] tmp7 = new Consensus[5];
 241     tmp7[0] = conses[3]; // -
 242     tmp7[1] = conses[29]; // D
 243     tmp7[2] = conses[10]; // E
 244     tmp7[3] = conses[17]; // N
 245     tmp7[4] = conses[2]; // DE
 246     colours[6] = new ConsensusColour(colhash.get(Color.MAGENTA), tmp7);
 247
 248     // Now attach the ConsensusColours to the residue letters
 249     residueColour = new ConsensusColour[20];
 250     residueColour[0] = colours[0]; // A
 251     residueColour[1] = colours[4]; // R
 252     residueColour[2] = colours[2]; // N
 253     residueColour[3] = colours[6]; // D
 254     residueColour[4] = colours[0]; // C
 255     residueColour[5] = colours[3]; // Q
 256     residueColour[6] = colours[5]; // E
 257     residueColour[7] = colours[7]; // G
 258     residueColour[8] = colours[10]; // H
 259     residueColour[9] = colours[0]; // I
 260     residueColour[10] = colours[0]; // L
 261     residueColour[11] = colours[4]; // K
 262     residueColour[12] = colours[0]; // M
 263     residueColour[13] = colours[0]; // F
 264     residueColour[14] = colours[8]; // P
 265     residueColour[15] = colours[1]; // S
 266     residueColour[16] = colours[1]; // T
 267     residueColour[17] = colours[0]; // W
 268     residueColour[18] = colours[10]; // Y
 269     residueColour[19] = colours[0]; // V
 270   }
 271
 272   @Override
 273   public Color findColour(char c)
 274   {
 275     return Color.pink;
 276   }
 277
 278   @Override
 279   public Color findColour(char c, int j, SequenceI seq)
 280   {
 281     Color currentColour;
 282
 283     if (cons2.length <= j
 284             || (includeGaps && threshold != 0 && !aboveThreshold(c, j)))
 285     {
 286       return Color.white;
 287     }
 288
 289     int i = ResidueProperties.aaIndex[c];
 290
 291     currentColour = Color.white;
 292
 293     if (i > 19)
 294     {
 295       return currentColour;
 296     }
 297
 298     for (int k = 0; k < residueColour[i].conses.length; k++)
 299     {
 300       if (residueColour[i].conses[k].isConserved(cons2, j, size,
 301               includeGaps))
 302       {
 303         currentColour = residueColour[i].c;
 304       }
 305     }
 306
 307     if (i == 4)
 308     {
 309       if (conses[27].isConserved(cons2, j, size, includeGaps))
 310       {
 311         currentColour = colhash.get(Color.PINK);
 312       }
 313     }
 314
 315     if (conservationColouring)
 316     {
 317       currentColour = applyConservation(currentColour, j);
 318     }
 319
 320     return currentColour;
 321   }
 322
 323   /**
 324    * @return the includeGaps
 325    */
 326   protected boolean isIncludeGaps()
 327   {
 328     return includeGaps;
 329   }
 330
 331   /**
 332    * @param includeGaps
 333    *          the includeGaps to set
 334    */
 335   protected void setIncludeGaps(boolean includeGaps)
 336   {
 337     this.includeGaps = includeGaps;
 338   }
 339
 340   @Override
 341   public ColourSchemeI applyTo(AnnotatedCollectionI sg,
 342           Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
 343   {
 344     ClustalxColourScheme css = new ClustalxColourScheme(sg,
 345             hiddenRepSequences);
 346     css.includeGaps = includeGaps;
 347     return css;
 348   }
 349 }
 350
 351 class ConsensusColour
 352 {
 353   Consensus[] conses;
 354
 355   Color c;
 356
 357   public ConsensusColour(Color c, Consensus[] conses)
 358   {
 359     this.conses = conses;
 360
 361     // this.list = list;
 362     this.c = c;
 363   }
 364 }