src/jalview/analysis/AAFrequency.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, 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.util.Format;
  23 import jalview.datamodel.*;
  24
  25 /**
  26  * Takes in a vector or array of sequences and column start and column end and
  27  * returns a new Hashtable[] of size maxSeqLength, if Hashtable not supplied.
  28  * This class is used extensively in calculating alignment colourschemes that
  29  * depend on the amount of conservation in each alignment column.
  30  *
  31  * @author $author$
  32  * @version $Revision$
  33  */
  34 public class AAFrequency
  35 {
  36   // No need to store 1000s of strings which are not
  37   // visible to the user.
  38   public static final String MAXCOUNT = "C";
  39
  40   public static final String MAXRESIDUE = "R";
  41
  42   public static final String PID_GAPS = "G";
  43
  44   public static final String PID_NOGAPS = "N";
  45
  46   public static final String PROFILE = "P";
  47
  48   public static final Hashtable[] calculate(List<SequenceI> list,
  49           int start, int end)
  50   {
  51     return calculate(list, start, end, false);
  52   }
  53
  54   public static final Hashtable[] calculate(List<SequenceI> sequences,
  55           int start, int end, boolean profile)
  56   {
  57     SequenceI[] seqs = new SequenceI[sequences.size()];
  58     int width = 0;
  59     synchronized (sequences)
  60     {
  61       for (int i = 0; i < sequences.size(); i++)
  62       {
  63         seqs[i] = sequences.get(i);
  64         if (seqs[i].getLength() > width)
  65         {
  66           width = seqs[i].getLength();
  67         }
  68       }
  69
  70       Hashtable[] reply = new Hashtable[width];
  71
  72       if (end >= width)
  73       {
  74         end = width;
  75       }
  76
  77       calculate(seqs, start, end, reply, profile);
  78       return reply;
  79     }
  80   }
  81
  82   public static final void calculate(SequenceI[] sequences, int start,
  83           int end, Hashtable[] result)
  84   {
  85     calculate(sequences, start, end, result, false);
  86   }
  87
  88   public static final void calculate(SequenceI[] sequences, int start,
  89           int end, Hashtable[] result, boolean profile)
  90   {
  91     Hashtable residueHash;
  92     int maxCount, nongap, i, j, v, jSize = sequences.length;
  93     String maxResidue;
  94     char c;
  95     float percentage;
  96
  97     int[] values = new int[255];
  98
  99     char[] seq;
 100
 101     for (i = start; i < end; i++)
 102     {
 103       residueHash = new Hashtable();
 104       maxCount = 0;
 105       maxResidue = "";
 106       nongap = 0;
 107       values = new int[255];
 108
 109       for (j = 0; j < jSize; j++)
 110       {
 111         if (sequences[j] == null)
 112         {
 113           System.err
 114                   .println("WARNING: Consensus skipping null sequence - possible race condition.");
 115           continue;
 116         }
 117         seq = sequences[j].getSequence();
 118         if (seq.length > i)
 119         {
 120           c = seq[i];
 121
 122           if (c == '.' || c == ' ')
 123           {
 124             c = '-';
 125           }
 126
 127           if (c == '-')
 128           {
 129             values['-']++;
 130             continue;
 131           }
 132           else if ('a' <= c && c <= 'z')
 133           {
 134             c -= 32; // ('a' - 'A');
 135           }
 136
 137           nongap++;
 138           values[c]++;
 139
 140         }
 141         else
 142         {
 143           values['-']++;
 144         }
 145       }
 146
 147       for (v = 'A'; v < 'Z'; v++)
 148       {
 149         if (values[v] < 2 || values[v] < maxCount)
 150         {
 151           continue;
 152         }
 153
 154         if (values[v] > maxCount)
 155         {
 156           maxResidue = String.valueOf((char) v);
 157         }
 158         else if (values[v] == maxCount)
 159         {
 160           maxResidue += String.valueOf((char) v);
 161         }
 162         maxCount = values[v];
 163       }
 164
 165       if (maxResidue.length() == 0)
 166       {
 167         maxResidue = "-";
 168       }
 169       if (profile)
 170       {
 171         residueHash.put(PROFILE, new int[][]
 172         { values, new int[]
 173         { jSize, nongap } });
 174       }
 175       residueHash.put(MAXCOUNT, new Integer(maxCount));
 176       residueHash.put(MAXRESIDUE, maxResidue);
 177
 178       percentage = ((float) maxCount * 100) / jSize;
 179       residueHash.put(PID_GAPS, new Float(percentage));
 180
 181       percentage = ((float) maxCount * 100) / nongap;
 182       residueHash.put(PID_NOGAPS, new Float(percentage));
 183       result[i] = residueHash;
 184     }
 185   }
 186
 187   /**
 188    * Compute all or part of the annotation row from the given consensus
 189    * hashtable
 190    *
 191    * @param consensus
 192    *          - pre-allocated annotation row
 193    * @param hconsensus
 194    * @param iStart
 195    * @param width
 196    * @param ignoreGapsInConsensusCalculation
 197    * @param includeAllConsSymbols
 198    * @param nseq
 199    */
 200   public static void completeConsensus(AlignmentAnnotation consensus,
 201           Hashtable[] hconsensus, int iStart, int width,
 202           boolean ignoreGapsInConsensusCalculation,
 203           boolean includeAllConsSymbols, long nseq)
 204   {
 205     completeConsensus(consensus, hconsensus, iStart, width,
 206             ignoreGapsInConsensusCalculation, includeAllConsSymbols, null, nseq); // new
 207                                                                             // char[]
 208     // { 'A', 'C', 'G', 'T', 'U' });
 209   }
 210
 211   public static void completeConsensus(AlignmentAnnotation consensus,
 212           Hashtable[] hconsensus, int iStart, int width,
 213           boolean ignoreGapsInConsensusCalculation,
 214           boolean includeAllConsSymbols, char[] alphabet, long nseq)
 215   {
 216     float tval, value;
 217     if (consensus == null || consensus.annotations == null
 218             || consensus.annotations.length < width)
 219     {
 220       // called with a bad alignment annotation row - wait for it to be
 221       // initialised properly
 222       return;
 223     }
 224     String fmtstr="%3.1f";
 225     int precision=2;
 226     while (nseq>100) {
 227       precision++;
 228       nseq/=10;
 229     }
 230     if (precision>2)
 231     {
 232       fmtstr = "%"+(2+precision)+"."+precision+"f";
 233     }
 234     Format fmt = new Format(fmtstr);
 235     for (int i = iStart; i < width; i++)
 236     {
 237       Hashtable hci;
 238       if (i >= hconsensus.length || ((hci = hconsensus[i]) == null))
 239       {
 240         // happens if sequences calculated over were shorter than alignment
 241         // width
 242         consensus.annotations[i] = null;
 243         continue;
 244       }
 245       value = 0;
 246       Float fv;
 247       if (ignoreGapsInConsensusCalculation)
 248       {
 249         fv = (Float) hci.get(AAFrequency.PID_NOGAPS);
 250       }
 251       else
 252       {
 253         fv = (Float) hci.get(AAFrequency.PID_GAPS);
 254       }
 255       if (fv == null)
 256       {
 257         consensus.annotations[i] = null;
 258         // data has changed below us .. give up and
 259         continue;
 260       }
 261       value = fv.floatValue();
 262       String maxRes = hci.get(AAFrequency.MAXRESIDUE).toString();
 263       String mouseOver = hci.get(AAFrequency.MAXRESIDUE) + " ";
 264       if (maxRes.length() > 1)
 265       {
 266         mouseOver = "[" + maxRes + "] ";
 267         maxRes = "+";
 268       }
 269       int[][] profile = (int[][]) hci.get(AAFrequency.PROFILE);
 270       if (profile != null && includeAllConsSymbols)
 271       {
 272         mouseOver = "";
 273         if (alphabet != null)
 274         {
 275           for (int c = 0; c < alphabet.length; c++)
 276           {
 277             tval = profile[0][alphabet[c]] * 100f
 278                     / profile[1][ignoreGapsInConsensusCalculation ? 1 : 0];
 279             mouseOver += ((c == 0) ? "" : "; ") + alphabet[c] + " "
 280                     + fmt.form(tval) + "%";
 281           }
 282         }
 283         else
 284         {
 285           Object[] ca = new Object[profile[0].length];
 286           float[] vl = new float[profile[0].length];
 287           for (int c = 0; c < ca.length; c++)
 288           {
 289             ca[c] = new char[]
 290             { (char) c };
 291             vl[c] = profile[0][c];
 292           }
 293           ;
 294           jalview.util.QuickSort.sort(vl, ca);
 295           for (int p = 0, c = ca.length - 1; profile[0][((char[]) ca[c])[0]] > 0; c--)
 296           {
 297             if (((char[]) ca[c])[0] != '-')
 298             {
 299               tval = profile[0][((char[]) ca[c])[0]]
 300                       * 100f
 301                       / profile[1][ignoreGapsInConsensusCalculation ? 1 : 0];
 302               mouseOver += ((p == 0) ? "" : "; ") + ((char[]) ca[c])[0]
 303                       + " " + fmt.form(tval) + "%";
 304               p++;
 305
 306             }
 307           }
 308
 309         }
 310       }
 311       else
 312       {
 313         mouseOver += (fmt.form(value) + "%");
 314       }
 315       consensus.annotations[i] = new Annotation(maxRes, mouseOver, ' ',
 316               value);
 317     }
 318   }
 319
 320   /**
 321    * get the sorted profile for the given position of the consensus
 322    *
 323    * @param hconsensus
 324    * @return
 325    */
 326   public static int[] extractProfile(Hashtable hconsensus,
 327           boolean ignoreGapsInConsensusCalculation)
 328   {
 329     int[] rtnval = new int[64];
 330     int[][] profile = (int[][]) hconsensus.get(AAFrequency.PROFILE);
 331     if (profile == null)
 332       return null;
 333     Object[] ca = new Object[profile[0].length];
 334     float[] vl = new float[profile[0].length];
 335     for (int c = 0; c < ca.length; c++)
 336     {
 337       ca[c] = new char[]
 338       { (char) c };
 339       vl[c] = profile[0][c];
 340     }
 341     ;
 342     jalview.util.QuickSort.sort(vl, ca);
 343     rtnval[0] = 2;
 344     rtnval[1] = 0;
 345     for (int c = ca.length - 1; profile[0][((char[]) ca[c])[0]] > 0; c--)
 346     {
 347       if (((char[]) ca[c])[0] != '-')
 348       {
 349         rtnval[rtnval[0]++] = ((char[]) ca[c])[0];
 350         rtnval[rtnval[0]] = (int) (profile[0][((char[]) ca[c])[0]] * 100f / profile[1][ignoreGapsInConsensusCalculation ? 1
 351                 : 0]);
 352         rtnval[1] += rtnval[rtnval[0]++];
 353       }
 354     }
 355     return rtnval;
 356   }
 357 }