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