src/jalview/analysis/StructureFrequency.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
   3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.analysis;
  19
  20 import java.util.*;
  21
  22 import jalview.datamodel.*;
  23
  24 /**
  25  * Takes in a vector or array of sequences and column start and column end and
  26  * returns a new Hashtable[] of size maxSeqLength, if Hashtable not supplied.
  27  * This class is used extensively in calculating alignment colourschemes that
  28  * depend on the amount of conservation in each alignment column.
  29  *
  30  * @author $author$
  31  * @version $Revision$
  32  */
  33 public class StructureFrequency
  34 {
  35   // No need to store 1000s of strings which are not
  36   // visible to the user.
  37   public static final String MAXCOUNT = "C";
  38
  39   public static final String MAXRESIDUE = "R";
  40
  41   public static final String PID_GAPS = "G";
  42
  43   public static final String PID_NOGAPS = "N";
  44
  45   public static final String PROFILE = "P";
  46
  47   public static final String PAIRPROFILE = "B";
  48
  49 /**
  50  * Returns the 3' position of a base pair
  51  * @param pairs Secondary structure annotation
  52  * @param indice 5' position of a base pair
  53  * @return 3' position of a base pair
  54  */
  55   public static int findPair(SequenceFeature[] pairs, int indice)
  56   {
  57     for (int i = 0; i < pairs.length; i++)
  58     {
  59       if (pairs[i].getBegin() == indice)
  60       {
  61         return pairs[i].getEnd();
  62       }
  63     }
  64     return -1;
  65   }
  66
  67   /**
  68    * Method to calculate a 'base pair consensus row', very similar to nucleotide
  69    * consensus but takes into account a given structure
  70    *
  71    * @param sequences
  72    * @param start
  73    * @param end
  74    * @param result
  75    * @param profile
  76    * @param rnaStruc
  77    */
  78   public static final void calculate(SequenceI[] sequences, int start,
  79           int end, Hashtable[] result, boolean profile,
  80           AlignmentAnnotation rnaStruc)
  81   {
  82     Hashtable residueHash;
  83     String maxResidue;
  84     char[] seq, struc = rnaStruc.getRNAStruc().toCharArray();
  85     SequenceFeature[] rna = rnaStruc._rnasecstr;
  86     char c, s, cEnd;
  87     int count, nonGap = 0, i, bpEnd = -1, j, jSize = sequences.length;
  88     int[] values;
  89     int[][] pairs;
  90     float percentage;
  91
  92     for (i = start; i < end; i++) // foreach column
  93     {
  94       residueHash = new Hashtable();
  95       maxResidue = "-";
  96       values = new int[255];
  97       pairs = new int[255][255];
  98       bpEnd = -1;
  99       if(i<struc.length){
 100         s = struc[i];
 101       }else{
 102         s = '-';
 103       }
 104       if (s == '.' || s == ' ')
 105       {
 106         s = '-';
 107       }
 108
 109       if (s != '(')
 110       {
 111         if (s == '-')
 112         {
 113           values['-']++;
 114         }
 115       }
 116       else
 117       {
 118         for (j = 0; j < jSize; j++) // foreach row
 119         {
 120           if (sequences[j] == null)
 121           {
 122             System.err
 123                     .println("WARNING: Consensus skipping null sequence - possible race condition.");
 124             continue;
 125           }
 126           seq = sequences[j].getSequence();
 127
 128           if (seq.length > i)
 129           {
 130             c = seq[i];
 131
 132             // standard representation for gaps in sequence and structure
 133             if (c == '.' || c == ' ')
 134             {
 135               c = '-';
 136             }
 137
 138             if (c == '-')
 139             {
 140               values['-']++;
 141               continue;
 142             }
 143             bpEnd = findPair(rna, i);
 144             cEnd = seq[bpEnd];
 145             if (checkBpType(c, cEnd))
 146             {
 147               values['H']++; // H means it's a helix (structured)
 148             }
 149             pairs[c][cEnd]++;
 150
 151             maxResidue = "H";
 152           }
 153         }
 154         // nonGap++;
 155       }
 156       // UPDATE this for new values
 157       if (profile)
 158       {
 159         residueHash.put(PROFILE, new int[][]
 160         { values, new int[]
 161         { jSize, (jSize - values['-']) } });
 162
 163         residueHash.put(PAIRPROFILE, pairs);
 164       }
 165
 166       count = values['H'];
 167
 168       residueHash.put(MAXCOUNT, new Integer(count));
 169       residueHash.put(MAXRESIDUE, maxResidue);
 170
 171       percentage = ((float) count * 100) / (float) jSize;
 172       residueHash.put(PID_GAPS, new Float(percentage));
 173
 174       // percentage = ((float) count * 100) / (float) nongap;
 175       // residueHash.put(PID_NOGAPS, new Float(percentage));
 176       if (result[i] == null)
 177       {
 178         result[i] = residueHash;
 179       }
 180       if (bpEnd > 0)
 181       {
 182         result[bpEnd] = residueHash;
 183       }
 184     }
 185   }
 186
 187   /**
 188    * Method to check if a base-pair is a canonical or a wobble bp
 189    *
 190    * @param up
 191    *          5' base
 192    * @param down
 193    *          3' base
 194    * @return True if it is a canonical/wobble bp
 195    */
 196   public static boolean checkBpType(char up, char down)
 197   {
 198     if (up > 'Z')
 199     {
 200       up -= 32;
 201     }
 202     if (down > 'Z')
 203     {
 204       down -= 32;
 205     }
 206
 207     switch (up)
 208     {
 209     case 'A':
 210       switch (down)
 211       {
 212       case 'T':
 213         return true;
 214       case 'U':
 215         return true;
 216       }
 217       break;
 218     case 'C':
 219       switch (down)
 220       {
 221       case 'G':
 222         return true;
 223       }
 224       break;
 225     case 'T':
 226       switch (down)
 227       {
 228       case 'A':
 229         return true;
 230       case 'G':
 231         return true;
 232       }
 233       break;
 234     case 'G':
 235       switch (down)
 236       {
 237       case 'C':
 238         return true;
 239       case 'T':
 240         return true;
 241       case 'U':
 242         return true;
 243       }
 244       break;
 245     case 'U':
 246       switch (down)
 247       {
 248       case 'A':
 249         return true;
 250       case 'G':
 251         return true;
 252       }
 253       break;
 254     }
 255     return false;
 256   }
 257
 258   /**
 259    * Compute all or part of the annotation row from the given consensus
 260    * hashtable
 261    *
 262    * @param consensus
 263    *          - pre-allocated annotation row
 264    * @param hconsensus
 265    * @param iStart
 266    * @param width
 267    * @param ignoreGapsInConsensusCalculation
 268    * @param includeAllConsSymbols
 269    */
 270   public static void completeConsensus(AlignmentAnnotation consensus,
 271           Hashtable[] hconsensus, int iStart, int width,
 272           boolean ignoreGapsInConsensusCalculation,
 273           boolean includeAllConsSymbols)
 274   {
 275     completeConsensus(consensus, hconsensus, iStart, width,
 276             ignoreGapsInConsensusCalculation, includeAllConsSymbols, null); // new
 277     // char[]
 278     // { 'A', 'C', 'G', 'T', 'U' });
 279   }
 280
 281   public static void completeConsensus(AlignmentAnnotation consensus,
 282           Hashtable[] hconsensus, int iStart, int width,
 283           boolean ignoreGapsInConsensusCalculation,
 284           boolean includeAllConsSymbols, char[] alphabet)
 285   {
 286     float tval, value;
 287     if (consensus == null || consensus.annotations == null
 288             || consensus.annotations.length < width)
 289     {
 290       // called with a bad alignment annotation row - wait for it to be
 291       // initialised properly
 292       return;
 293     }
 294     for (int i = iStart; i < width; i++)
 295     {
 296       if (i >= hconsensus.length)
 297       {
 298         // happens if sequences calculated over were shorter than alignment
 299         // width
 300         consensus.annotations[i] = null;
 301         continue;
 302       }
 303       value = 0;
 304       if (ignoreGapsInConsensusCalculation)
 305       {
 306         value = ((Float) hconsensus[i].get(StructureFrequency.PID_NOGAPS))
 307                 .floatValue();
 308       }
 309       else
 310       {
 311         value = ((Float) hconsensus[i].get(StructureFrequency.PID_GAPS))
 312                 .floatValue();
 313       }
 314
 315       String maxRes = hconsensus[i].get(StructureFrequency.MAXRESIDUE)
 316               .toString();
 317       String mouseOver = hconsensus[i].get(StructureFrequency.MAXRESIDUE)
 318               + " ";
 319       if (maxRes.length() > 1)
 320       {
 321         mouseOver = "[" + maxRes + "] ";
 322         maxRes = "+";
 323       }
 324       int[][] profile = (int[][]) hconsensus[i]
 325               .get(StructureFrequency.PROFILE);
 326       if (profile != null && includeAllConsSymbols) // Just responsible for the
 327       // tooltip
 328       //TODO Update tooltips for Structure row
 329       {
 330         mouseOver = "";
 331         if (alphabet != null)
 332         {
 333           for (int c = 0; c < alphabet.length; c++)
 334           {
 335             tval = ((float) profile[0][alphabet[c]])
 336                     * 100f
 337                     / (float) profile[1][ignoreGapsInConsensusCalculation ? 1
 338                             : 0];
 339             mouseOver += ((c == 0) ? "" : "; ") + alphabet[c] + " "
 340                     + ((int) tval) + "%";
 341           }
 342         }
 343         else
 344         {
 345           Object[] ca = new Object[profile[0].length];
 346           float[] vl = new float[profile[0].length];
 347           for (int c = 0; c < ca.length; c++)
 348           {
 349             ca[c] = new char[]
 350             { (char) c };
 351             vl[c] = (float) profile[0][c];
 352           }
 353           ;
 354           jalview.util.QuickSort.sort(vl, ca);
 355           for (int p = 0, c = ca.length - 1; profile[0][((char[]) ca[c])[0]] > 0; c--)
 356           {
 357             if (((char[]) ca[c])[0] != '-')
 358             {
 359               tval = ((float) profile[0][((char[]) ca[c])[0]])
 360                       * 100f
 361                       / (float) profile[1][ignoreGapsInConsensusCalculation ? 1
 362                               : 0];
 363               mouseOver += ((p == 0) ? "" : "; ") + ((char[]) ca[c])[0]
 364                       + " " + ((int) tval) + "%";
 365               p++;
 366
 367             }
 368           }
 369
 370         }
 371       }
 372       else
 373       {
 374         mouseOver += ((int) value + "%");
 375       }
 376       consensus.annotations[i] = new Annotation(maxRes, mouseOver, ' ',
 377               value);
 378     }
 379   }
 380
 381   /**
 382    * get the sorted base-pair profile for the given position of the consensus
 383    *
 384    * @param hconsensus
 385    * @return profile of the given column
 386    */
 387   public static int[] extractProfile(Hashtable hconsensus,
 388           boolean ignoreGapsInConsensusCalculation, int column)
 389   {
 390     // TODO is there a more elegant way to acces the column number?
 391     /*
 392      * calculate the frequence of the 16 bp variations for this column 'somehow'
 393      * transfer this via getProfile and let it correctly draw
 394      */
 395     int[] rtnval = new int[51]; // 2*(5*5)+1
 396     int[][] profile = (int[][]) hconsensus.get(StructureFrequency.PROFILE);
 397     int[][] pairs = (int[][]) hconsensus
 398             .get(StructureFrequency.PAIRPROFILE);
 399
 400     if (profile == null)
 401       return null;
 402
 403     Object[] ca = new Object[625];
 404     float[] vl = new float[625];
 405     int x=0;
 406     for (int c = 65; c < 90; c++)
 407     {
 408       for(int d = 65; d< 90; d++)
 409       {
 410       ca[x] = new int[]{ c, d};
 411       vl[x] = (float) pairs[c][d];
 412       x++;
 413       }
 414     }
 415     jalview.util.QuickSort.sort(vl, ca);
 416
 417     rtnval[0] = 1;
 418     for (int c=624; c>0; c--)
 419     {
 420       if (vl[c]>0)
 421       {
 422         rtnval[rtnval[0]++] = ((int[]) ca[c])[0];
 423         rtnval[rtnval[0]++] = ((int[]) ca[c])[1];
 424         rtnval[rtnval[0]++] = (int) ((float) vl[c] * 100f / (float) profile[1][ignoreGapsInConsensusCalculation ? 1
 425                 : 0]);
 426        }
 427     }
 428
 429     return rtnval;
 430   }
 431
 432   public static void main(String args[])
 433   {
 434     // Short test to see if checkBpType works
 435     ArrayList<String> test = new ArrayList<String>();
 436     test.add("A");
 437     test.add("c");
 438     test.add("g");
 439     test.add("T");
 440     test.add("U");
 441     for (String i : test)
 442     {
 443       for (String j : test)
 444       {
 445         System.out.println(i + "-" + j + ": "
 446                 + StructureFrequency.checkBpType(i.charAt(0), j.charAt(0)));
 447       }
 448     }
 449   }
 450 }