src/jalview/analysis/AAFrequency.java

   1 /*\r
   2 * Jalview - A Sequence Alignment Editor and Viewer\r
   3 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4 *\r
   5 * This program is free software; you can redistribute it and/or\r
   6 * modify it under the terms of the GNU General Public License\r
   7 * as published by the Free Software Foundation; either version 2\r
   8 * of the License, or (at your option) any later version.\r
   9 *\r
  10 * This program is distributed in the hope that it will be useful,\r
  11 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13 * GNU General Public License for more details.\r
  14 *\r
  15 * You should have received a copy of the GNU General Public License\r
  16 * along with this program; if not, write to the Free Software\r
  17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18 */\r
  19 package jalview.analysis;\r
  20 \r
  21 import jalview.analysis.*;\r
  22 \r
  23 import jalview.datamodel.*;\r
  24 \r
  25 import java.util.*;\r
  26 \r
  27 \r
  28 public class AAFrequency {\r
  29     // Takes in a vector of sequences and column start and column end\r
  30     // and returns a vector of size (end-start+1). Each element of the\r
  31     // vector contains a hashtable with the keys being residues and\r
  32     // the values being the count of each residue in that column.\r
  33     // This class is used extensively in calculating alignment colourschemes\r
  34     // that depend on the amount of conservation in each alignment column.\r
  35     public static Vector calculate(Vector sequences, int start, int end) {\r
  36         Vector result = new Vector();\r
  37 \r
  38         for (int i = start; i <= end; i++) {\r
  39             Hashtable residueHash = new Hashtable();\r
  40             int maxCount = 0;\r
  41             String maxResidue = "-";\r
  42             int nongap = 0;\r
  43 \r
  44             for (int j = 0; j < sequences.size(); j++) {\r
  45                 if (sequences.elementAt(j) instanceof Sequence) {\r
  46                     Sequence s = (Sequence) sequences.elementAt(j);\r
  47 \r
  48                     if (s.getSequence().length() > i) {\r
  49                         String res = s.getSequence().charAt(i) + "";\r
  50 \r
  51                         if (!jalview.util.Comparison.isGap(res.charAt(0))) {\r
  52                             nongap++;\r
  53                         } else {\r
  54                             res = "-"; // we always use this for gaps in the property vectors\r
  55                         }\r
  56 \r
  57                         if (residueHash.containsKey(res)) {\r
  58                             int count = ((Integer) residueHash.get(res)).intValue();\r
  59                             count++;\r
  60 \r
  61                             if (!jalview.util.Comparison.isGap(res.charAt(0)) &&\r
  62                                     (count >= maxCount)) {\r
  63                                 if (count > maxCount) {\r
  64                                     maxResidue = res;\r
  65                                 } else if (maxResidue.indexOf(res) == -1) {\r
  66                                     maxResidue += res;\r
  67                                 }\r
  68 \r
  69                                 maxCount = count;\r
  70                             }\r
  71 \r
  72                             residueHash.put(res, new Integer(count));\r
  73                         } else {\r
  74                             residueHash.put(res, new Integer(1));\r
  75                         }\r
  76                     } else {\r
  77                         if (residueHash.containsKey("-")) {\r
  78                             int count = ((Integer) residueHash.get("-")).intValue();\r
  79                             count++;\r
  80                             residueHash.put("-", new Integer(count));\r
  81                         } else {\r
  82                             residueHash.put("-", new Integer(1));\r
  83                         }\r
  84                     }\r
  85                 }\r
  86             }\r
  87 \r
  88             residueHash.put("maxCount", new Integer(maxCount));\r
  89 \r
  90             if (maxCount < 0) {\r
  91                 System.out.println("asasa " + maxCount);\r
  92             }\r
  93 \r
  94             residueHash.put("maxResidue", maxResidue);\r
  95             residueHash.put("size", new Integer(sequences.size()));\r
  96             residueHash.put("nongap", new Integer(nongap));\r
  97             result.addElement(residueHash);\r
  98         }\r
  99 \r
 100         return result;\r
 101     }\r
 102 \r
 103     public static Vector calculatePID(SequenceI refseq, Vector sequences,\r
 104         int window, int start, int end) {\r
 105         Vector result = new Vector();\r
 106 \r
 107         boolean init = true;\r
 108 \r
 109         Vector prev = null;\r
 110 \r
 111         for (int i = start; i <= end; i++) {\r
 112             Vector values = new Vector();\r
 113 \r
 114             result.addElement(values);\r
 115 \r
 116             // If start < window/2 then set value to zero.\r
 117             if ((i < (window / 2)) ||\r
 118                     (i >= (refseq.getSequence().length() - (window / 2)))) {\r
 119                 for (int j = 0; j < sequences.size(); j++) {\r
 120                     values.addElement(new Integer(0));\r
 121                 }\r
 122             } else if (init == true) {\r
 123                 init = false;\r
 124 \r
 125                 int winstart = i - (window / 2);\r
 126                 int winend = i + (window / 2);\r
 127 \r
 128                 if ((window % 2) != 0) {\r
 129                     winend++;\r
 130                 }\r
 131 \r
 132                 for (int j = 0; j < sequences.size(); j++) {\r
 133                     values.addElement(new Integer(0));\r
 134                 }\r
 135 \r
 136                 for (int k = winstart; k <= winend; k++) {\r
 137                     String refchar = refseq.getSequence().substring(k, k + 1);\r
 138 \r
 139                     if (jalview.util.Comparison.isGap(refchar.charAt(0))) {\r
 140                         refchar = "-";\r
 141                     } else {\r
 142                         for (int j = 0; j < sequences.size(); j++) {\r
 143                             Sequence s = (Sequence) sequences.elementAt(j);\r
 144 \r
 145                             if (s.getSequence().length() > k) {\r
 146                                 String res = s.getSequence().substring(k, k +\r
 147                                         1); // no gapchar test needed\r
 148 \r
 149                                 if (res.equals(refchar)) {\r
 150                                     int val = ((Integer) values.elementAt(j)).intValue();\r
 151                                     val++;\r
 152                                     values.setElementAt(new Integer(val), j);\r
 153                                 }\r
 154                             }\r
 155                         }\r
 156                     }\r
 157                 }\r
 158 \r
 159                 prev = values;\r
 160             } else {\r
 161                 int winstart = i - (window / 2);\r
 162                 int winend = i + (window / 2);\r
 163 \r
 164                 if ((window % 2) != 0) {\r
 165                     winend++;\r
 166                 }\r
 167 \r
 168                 // We need to take the previous set of values\r
 169                 // subtract the pid at winstart-1\r
 170                 // and add the pid at winend;\r
 171                 String pre_refchar = refseq.getSequence().substring(winstart -\r
 172                         1, winstart);\r
 173                 String pos_refchar = "-";\r
 174 \r
 175                 if (refseq.getSequence().length() > winend) {\r
 176                     pos_refchar = refseq.getSequence().substring(winend,\r
 177                             winend + 1);\r
 178                 }\r
 179 \r
 180                 for (int j = 0; j < sequences.size(); j++) {\r
 181                     // First copy the pid value from i-1\r
 182                     int val = ((Integer) prev.elementAt(j)).intValue();\r
 183 \r
 184                     Sequence s = (Sequence) sequences.elementAt(j);\r
 185 \r
 186                     String pre_char = s.getSequence().substring(winstart - 1,\r
 187                             winstart);\r
 188 \r
 189                     String pos_char = "-";\r
 190 \r
 191                     if (s.getSequence().length() > winend) {\r
 192                         pos_char = s.getSequence().substring(winend, winend +\r
 193                                 1);\r
 194                     }\r
 195 \r
 196                     // Now substract 1 if the chars at winstart-1 match\r
 197                     if ((jalview.util.Comparison.isGap(pre_refchar.charAt(0)) == false) &&\r
 198                             pre_char.equals(pre_refchar)) {\r
 199                         val--;\r
 200                     }\r
 201 \r
 202                     if ((jalview.util.Comparison.isGap(pos_refchar.charAt(0)) == false) &&\r
 203                             pos_char.equals(pos_refchar)) {\r
 204                         val++;\r
 205                     }\r
 206 \r
 207                     values.addElement(new Integer(val));\r
 208                 }\r
 209 \r
 210                 prev = values;\r
 211             }\r
 212         }\r
 213 \r
 214         return result;\r
 215     }\r
 216 \r
 217     public static Hashtable findBlocks(Vector seqs, int start, int end,\r
 218         Vector exc) {\r
 219         // start and end are in real (not relative coords);\r
 220         // The coords in the hashtable that is returned are in relative coords\r
 221         // i.e. start from 0\r
 222         Hashtable blocks = new Hashtable();\r
 223 \r
 224         boolean prev = false;\r
 225         int bstart = -1;\r
 226 \r
 227         for (int i = start; i <= end; i++) {\r
 228             SequenceI seq = (SequenceI) seqs.elementAt(0);\r
 229 \r
 230             char c = seq.getCharAt(i);\r
 231 \r
 232             boolean found = true;\r
 233 \r
 234             int j = 1;\r
 235 \r
 236             while ((j < seqs.size()) && (found == true)) {\r
 237                 SequenceI jseq = (SequenceI) seqs.elementAt(j);\r
 238 \r
 239                 if (!exc.contains(jseq)) {\r
 240                     char cc = jseq.getCharAt(i);\r
 241 \r
 242                     if (cc != c) {\r
 243                         found = false;\r
 244                     }\r
 245                 }\r
 246 \r
 247                 j++;\r
 248             }\r
 249 \r
 250             if ((prev == false) && (found == true)) {\r
 251                 bstart = i;\r
 252             } else if ((prev == true) && (found == false) && (bstart != -1)) {\r
 253                 int blockstart = bstart - start;\r
 254                 int blocklen = i - bstart;\r
 255 \r
 256                 //System.out.println("Start len " + blockstart + " " + blocklen);\r
 257                 for (int jj = blockstart; jj < (blockstart + blocklen); jj++) {\r
 258                     blocks.put(new Integer(jj), new Integer(blocklen));\r
 259                 }\r
 260 \r
 261                 bstart = -1;\r
 262             }\r
 263 \r
 264             prev = found;\r
 265         }\r
 266 \r
 267         if (bstart != -1) {\r
 268             int blockstart = bstart - start;\r
 269             int blocklen = end - bstart;\r
 270 \r
 271             //  System.out.println("Start len " + blockstart + " " + blocklen);\r
 272             for (int jj = blockstart; jj < (blockstart + blocklen); jj++) {\r
 273                 blocks.put(new Integer(blockstart), new Integer(blocklen));\r
 274             }\r
 275         }\r
 276 \r
 277         return blocks;\r
 278     }\r
 279 \r
 280     public static Hashtable findKmerCount(SequenceI seq, int start, int end,\r
 281         int window, int step, Vector kmers) {\r
 282         int tmpstart = start;\r
 283         Hashtable vals = new Hashtable();\r
 284 \r
 285         while (tmpstart <= end) {\r
 286             String tmpstr = seq.getSequence().substring(tmpstart -\r
 287                     (window / 2), tmpstart + (window / 2));\r
 288 \r
 289             int count = 0;\r
 290 \r
 291             //System.out.println("Str " + tmpstr);\r
 292             for (int ii = 0; ii < kmers.size(); ii++) {\r
 293                 String kmer = ((SequenceI) kmers.elementAt(ii)).getSequence();\r
 294 \r
 295                 int i = -1;\r
 296 \r
 297                 while (tmpstr.indexOf(kmer, i) != -1) {\r
 298                     i = tmpstr.indexOf(kmer, i);\r
 299 \r
 300                     i++;\r
 301                     count++;\r
 302                 }\r
 303 \r
 304                 ii++;\r
 305             }\r
 306 \r
 307             vals.put(new Integer(tmpstart), new Integer(count));\r
 308             tmpstart += step;\r
 309         }\r
 310 \r
 311         return vals;\r
 312     }\r
 313 \r
 314     public static Hashtable findBlockStarts(Vector seqs, int start, int end,\r
 315         Vector exc) {\r
 316         // start and end are in real (not relative coords);\r
 317         // The coords in the hashtable that is returned are in relative coords\r
 318         // i.e. start from 0\r
 319         Hashtable blocks = new Hashtable();\r
 320 \r
 321         boolean prev = false;\r
 322         int bstart = -1;\r
 323 \r
 324         for (int i = start; i <= end; i++) {\r
 325             SequenceI seq = (SequenceI) seqs.elementAt(0);\r
 326 \r
 327             char c = seq.getCharAt(i);\r
 328 \r
 329             boolean found = true;\r
 330 \r
 331             int j = 1;\r
 332 \r
 333             while ((j < seqs.size()) && (found == true)) {\r
 334                 SequenceI jseq = (SequenceI) seqs.elementAt(j);\r
 335 \r
 336                 if (!exc.contains(jseq)) {\r
 337                     char cc = jseq.getCharAt(i);\r
 338 \r
 339                     if (cc != c) {\r
 340                         found = false;\r
 341                     }\r
 342                 }\r
 343 \r
 344                 j++;\r
 345             }\r
 346 \r
 347             if ((prev == false) && (found == true)) {\r
 348                 bstart = i;\r
 349             } else if ((prev == true) && (found == false) && (bstart != -1)) {\r
 350                 int blockstart = bstart - start;\r
 351                 int blocklen = i - bstart;\r
 352 \r
 353                 //              System.out.println("Start len " + blockstart + " " + blocklen);\r
 354                 //for (int jj = blockstart; jj < blockstart + blocklen;jj++) {\r
 355                 blocks.put(new Integer(blockstart), new Integer(blocklen));\r
 356 \r
 357                 //      }\r
 358                 bstart = -1;\r
 359             }\r
 360 \r
 361             prev = found;\r
 362         }\r
 363 \r
 364         if (bstart != -1) {\r
 365             int blockstart = bstart - start;\r
 366             int blocklen = end - bstart;\r
 367 \r
 368             //  System.out.println("Start len " + blockstart + " " + blocklen);\r
 369             //for (int jj = blockstart; jj < blockstart + blocklen;jj++) {\r
 370             blocks.put(new Integer(blockstart), new Integer(blocklen));\r
 371 \r
 372             // }\r
 373         }\r
 374 \r
 375         return blocks;\r
 376     }\r
 377 }\r