JAL-2286 modal residue check + commenting
[jalview.git] / src / jalview / schemes / PIDColourScheme.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.SequenceGroup;
24 import jalview.datamodel.SequenceI;
25 import jalview.util.Comparison;
26
27 import java.awt.Color;
28
29 public class PIDColourScheme extends ResidueColourScheme
30 {
31   public Color[] pidColours;
32
33   public float[] thresholds;
34
35   SequenceGroup group;
36
37   public PIDColourScheme()
38   {
39     this.pidColours = ResidueProperties.pidColours;
40     this.thresholds = ResidueProperties.pidThresholds;
41   }
42
43   @Override
44   public Color findColour(char c, int j, SequenceI seq)
45   {
46     if ('a' <= c && c <= 'z')
47     {
48       c -= ('a' - 'A');
49     }
50
51     if (consensus == null || j >= consensus.length || consensus[j] == null)
52     {
53       return Color.white;
54     }
55
56     if ((threshold != 0) && !aboveThreshold(c, j))
57     {
58       return Color.white;
59     }
60
61     Color currentColour = Color.white;
62
63     double sc = 0;
64
65     if (consensus.length <= j)
66     {
67       return Color.white;
68     }
69
70     /*
71      * test whether this is the consensus (or joint consensus) residue
72      */
73     boolean matchesConsensus = consensus[j].getModalResidue().contains(
74             String.valueOf(c));
75     if (matchesConsensus)
76     {
77       sc = consensus[j].getPercentageIdentity(ignoreGaps);
78
79       if (!Comparison.isGap(c))
80       {
81         for (int i = 0; i < thresholds.length; i++)
82         {
83           if (sc > thresholds[i])
84           {
85             currentColour = pidColours[i];
86             break;
87           }
88         }
89       }
90     }
91
92     if (conservationColouring)
93     {
94       currentColour = applyConservation(currentColour, j);
95     }
96
97     return currentColour;
98   }
99 }