Merge branch 'documentation/JAL-2325_release2101' into releases/Release_2_10_Branch
[jalview.git] / src / jalview / schemes / Blosum62ColourScheme.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 import jalview.util.Comparison;
27
28 import java.awt.Color;
29 import java.util.Map;
30
31 public class Blosum62ColourScheme extends ResidueColourScheme
32 {
33   private static final Color LIGHT_BLUE = new Color(204, 204, 255);
34   private static final Color DARK_BLUE = new Color(154, 154, 255);
35
36   public Blosum62ColourScheme()
37   {
38     super();
39   }
40
41   @Override
42   public Color findColour(char res, int j, SequenceI seq)
43   {
44     if ('a' <= res && res <= 'z')
45     {
46       // TO UPPERCASE !!!
47       res -= ('a' - 'A');
48     }
49
50     if (consensus == null || consensus.get(j) == null
51             || (threshold != 0 && !aboveThreshold(res, j)))
52     {
53       return Color.white;
54     }
55
56     Color currentColour;
57
58     if (!Comparison.isGap(res))
59     {
60       /*
61        * test if this is the consensus (or joint consensus) residue
62        */
63       String max = consensus.get(j).getModalResidue();
64
65       if (max.indexOf(res) > -1)
66       {
67         currentColour = DARK_BLUE;
68       }
69       else
70       {
71         int c = 0;
72         int max_aa = 0;
73         int n = max.length();
74
75         do
76         {
77           c += ResidueProperties.getBLOSUM62(max.charAt(max_aa), res);
78         } while (++max_aa < n);
79
80         if (c > 0)
81         {
82           currentColour = LIGHT_BLUE;
83         }
84         else
85         {
86           currentColour = Color.white;
87         }
88       }
89
90       if (conservationColouring)
91       {
92         currentColour = applyConservation(currentColour, j);
93       }
94     }
95     else
96     {
97       return Color.white;
98     }
99
100     return currentColour;
101   }
102
103   @Override
104   public ColourSchemeI applyTo(AnnotatedCollectionI sg,
105           Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
106   {
107     ColourSchemeI newcs = super.applyTo(sg, hiddenRepSequences);
108     return newcs;
109   }
110 }