Merge branch 'features/JAL-2446NCList' into features/JAL-2574findFeaturesByColumn
[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.AnnotatedCollectionI;
24 import jalview.datamodel.SequenceCollectionI;
25 import jalview.datamodel.SequenceGroup;
26 import jalview.datamodel.SequenceI;
27 import jalview.util.Comparison;
28
29 import java.awt.Color;
30 import java.util.Map;
31
32 public class PIDColourScheme extends ResidueColourScheme
33 {
34   private static final Color[] pidColours = { new Color(100, 100, 255),
35       new Color(153, 153, 255), new Color(204, 204, 255), };
36
37   private static final float[] thresholds = { 80, 60, 40, };
38
39   SequenceGroup group;
40
41   public PIDColourScheme()
42   {
43   }
44
45   @Override
46   public Color findColour(char c, int j, SequenceI seq,
47           String consensusResidue, float pid)
48   {
49     /*
50      * compare as upper case; note consensusResidue is 
51      * always computed as uppercase
52      */
53     if ('a' <= c && c <= 'z')
54     {
55       c -= ('a' - 'A');
56     }
57
58     if (consensusResidue == null || Comparison.isGap(c))
59     {
60       return Color.white;
61     }
62
63     Color colour = Color.white;
64
65     /*
66      * test whether this is the consensus (or joint consensus) residue
67      */
68     boolean matchesConsensus = consensusResidue.contains(
69             String.valueOf(c));
70     if (matchesConsensus)
71     {
72       for (int i = 0; i < thresholds.length; i++)
73       {
74         if (pid > thresholds[i])
75         {
76           colour = pidColours[i];
77           break;
78         }
79       }
80     }
81
82     return colour;
83   }
84
85   @Override
86   public String getSchemeName()
87   {
88     return JalviewColourScheme.PID.toString();
89   }
90
91   /**
92    * Returns a new instance of this colour scheme with which the given data may
93    * be coloured
94    */
95   @Override
96   public ColourSchemeI getInstance(AnnotatedCollectionI coll,
97           Map<SequenceI, SequenceCollectionI> hrs)
98   {
99     return new PIDColourScheme();
100   }
101
102   @Override
103   public boolean isSimple()
104   {
105     return false;
106   }
107 }