patch to fix occasional arrayoutofbounds exception when working with hidden columns...
[jalview.git] / src / jalview / schemes / Consensus.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
3  * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
4  * 
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  * 
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  * 
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
18  */
19 package jalview.schemes;
20
21 // //////////////////////////////////////////
22 // This does nothing at all at the moment!!!!!!!!!!
23 // AW 15th Dec 2004
24 // ///////////////////////////////////////
25 public class Consensus
26 {
27   int[] mask;
28
29   double threshold;
30
31   String maskstr;
32
33   public Consensus(String mask, double threshold)
34   {
35     // this.id = id;
36     // this.mask = mask;
37     this.maskstr = mask;
38     setMask(mask);
39     this.threshold = threshold;
40   }
41
42   public void setMask(String s)
43   {
44     this.mask = setNums(s);
45
46     // for (int i=0; i < mask.length; i++) {
47     // System.out.println(mask[i] + " " + ResidueProperties.aa[mask[i]]);
48     // }
49   }
50
51   /**
52    * @deprecated Use {@link #isConserved(int[][],int,int,boolean)} instead
53    */
54   public boolean isConserved(int[][] cons2, int col, int size)
55   {
56     return isConserved(cons2, col, size, true);
57   }
58
59   public boolean isConserved(int[][] cons2, int col, int size,
60           boolean includeGaps)
61   {
62     int tot = 0;
63     if (!includeGaps)
64     {
65       size -= cons2[col][cons2[col].length - 1];
66     }
67     for (int i = 0; i < mask.length; i++)
68     {
69       tot += cons2[col][mask[i]];
70     }
71
72     if ((double) tot > ((threshold * size) / 100))
73     {
74       // System.out.println("True conserved "+tot+" from "+threshold+" out of
75       // "+size+" : "+maskstr);
76       return true;
77     }
78
79     return false;
80   }
81
82   int[] setNums(String s)
83   {
84     int[] out = new int[s.length()];
85     int i = 0;
86
87     while (i < s.length())
88     {
89       out[i] = ResidueProperties.aaIndex[s.charAt(i)];
90       i++;
91     }
92
93     return out;
94   }
95 }