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       if (jSize==1)
 147       {
 148         maxResidue = String.valueOf(c);
 149         maxCount=1;
 150       } else {for (v = 'A'; v < 'Z'; v++)
 151       {
 152         if (values[v] < 2 || values[v] < maxCount)
 153         {
 154           continue;
 155         }
 156
 157         if (values[v] > maxCount)
 158         {
 159           maxResidue = String.valueOf((char) v);
 160         }
 161         else if (values[v] == maxCount)
 162         {
 163           maxResidue += String.valueOf((char) v);
 164         }
 165         maxCount = values[v];
 166       }
 167       }
 168       if (maxResidue.length() == 0)
 169       {
 170         maxResidue = "-";
 171       }
 172       if (profile)
 173       {
 174         residueHash.put(PROFILE, new int[][]
 175         { values, new int[]
 176         { jSize, nongap } });
 177       }
 178       residueHash.put(MAXCOUNT, new Integer(maxCount));
 179       residueHash.put(MAXRESIDUE, maxResidue);
 180
 181       percentage = ((float) maxCount * 100) / jSize;
 182       residueHash.put(PID_GAPS, new Float(percentage));
 183
 184       percentage = ((float) maxCount * 100) / nongap;
 185       residueHash.put(PID_NOGAPS, new Float(percentage));
 186       result[i] = residueHash;
 187     }
 188   }
 189
 190   /**
 191    * Compute all or part of the annotation row from the given consensus
 192    * hashtable
 193    *
 194    * @param consensus
 195    *          - pre-allocated annotation row
 196    * @param hconsensus
 197    * @param iStart
 198    * @param width
 199    * @param ignoreGapsInConsensusCalculation
 200    * @param includeAllConsSymbols
 201    * @param nseq
 202    */
 203   public static void completeConsensus(AlignmentAnnotation consensus,
 204           Hashtable[] hconsensus, int iStart, int width,
 205           boolean ignoreGapsInConsensusCalculation,
 206           boolean includeAllConsSymbols, long nseq)
 207   {
 208     completeConsensus(consensus, hconsensus, iStart, width,
 209             ignoreGapsInConsensusCalculation, includeAllConsSymbols, null, nseq); // new
 210                                                                             // char[]
 211     // { 'A', 'C', 'G', 'T', 'U' });
 212   }
 213
 214   public static void completeConsensus(AlignmentAnnotation consensus,
 215           Hashtable[] hconsensus, int iStart, int width,
 216           boolean ignoreGapsInConsensusCalculation,
 217           boolean includeAllConsSymbols, char[] alphabet, long nseq)
 218   {
 219     float tval, value;
 220     if (consensus == null || consensus.annotations == null
 221             || consensus.annotations.length < width)
 222     {
 223       // called with a bad alignment annotation row - wait for it to be
 224       // initialised properly
 225       return;
 226     }
 227     String fmtstr="%3.1f";
 228     int precision=0;
 229     while (nseq>=10) {
 230       precision++;
 231       nseq/=10;
 232     }
 233     final Format fmt;
 234     if (precision>1)
 235     {
 236       //if (precision>2)
 237       {
 238         fmtstr = "%"+(2+precision)+"."+(precision)+"f";
 239       }
 240       fmt = new Format(fmtstr);
 241     } else {
 242       fmt = null;
 243     }
 244     for (int i = iStart; i < width; i++)
 245     {
 246       Hashtable hci;
 247       if (i >= hconsensus.length || ((hci = hconsensus[i]) == null))
 248       {
 249         // happens if sequences calculated over were shorter than alignment
 250         // width
 251         consensus.annotations[i] = null;
 252         continue;
 253       }
 254       value = 0;
 255       Float fv;
 256       if (ignoreGapsInConsensusCalculation)
 257       {
 258         fv = (Float) hci.get(AAFrequency.PID_NOGAPS);
 259       }
 260       else
 261       {
 262         fv = (Float) hci.get(AAFrequency.PID_GAPS);
 263       }
 264       if (fv == null)
 265       {
 266         consensus.annotations[i] = null;
 267         // data has changed below us .. give up and
 268         continue;
 269       }
 270       value = fv.floatValue();
 271       String maxRes = hci.get(AAFrequency.MAXRESIDUE).toString();
 272       String mouseOver = hci.get(AAFrequency.MAXRESIDUE) + " ";
 273       if (maxRes.length() > 1)
 274       {
 275         mouseOver = "[" + maxRes + "] ";
 276         maxRes = "+";
 277       }
 278       int[][] profile = (int[][]) hci.get(AAFrequency.PROFILE);
 279       if (profile != null && includeAllConsSymbols)
 280       {
 281         mouseOver = "";
 282         if (alphabet != null)
 283         {
 284           for (int c = 0; c < alphabet.length; c++)
 285           {
 286             tval = profile[0][alphabet[c]] * 100f
 287                     / profile[1][ignoreGapsInConsensusCalculation ? 1 : 0];
 288             mouseOver += ((c == 0) ? "" : "; ") + alphabet[c] + " "
 289                     + ((fmt!=null) ? fmt.form(tval) : ((int) tval)) + "%";
 290           }
 291         }
 292         else
 293         {
 294           Object[] ca = new Object[profile[0].length];
 295           float[] vl = new float[profile[0].length];
 296           for (int c = 0; c < ca.length; c++)
 297           {
 298             ca[c] = new char[]
 299             { (char) c };
 300             vl[c] = profile[0][c];
 301           }
 302           ;
 303           jalview.util.QuickSort.sort(vl, ca);
 304           for (int p = 0, c = ca.length - 1; profile[0][((char[]) ca[c])[0]] > 0; c--)
 305           {
 306             if (((char[]) ca[c])[0] != '-')
 307             {
 308               tval = profile[0][((char[]) ca[c])[0]]
 309                       * 100f
 310                       / profile[1][ignoreGapsInConsensusCalculation ? 1 : 0];
 311               mouseOver += ((p == 0) ? "" : "; ") + ((char[]) ca[c])[0]
 312                       + " " + ((fmt!=null) ? fmt.form(tval) : ((int) tval)) + "%";
 313               p++;
 314
 315             }
 316           }
 317
 318         }
 319       }
 320       else
 321       {
 322         mouseOver += ((fmt!=null) ? fmt.form(value) : ((int) value)) + "%";
 323       }
 324       consensus.annotations[i] = new Annotation(maxRes, mouseOver, ' ',
 325               value);
 326     }
 327   }
 328
 329   /**
 330    * get the sorted profile for the given position of the consensus
 331    *
 332    * @param hconsensus
 333    * @return
 334    */
 335   public static int[] extractProfile(Hashtable hconsensus,
 336           boolean ignoreGapsInConsensusCalculation)
 337   {
 338     int[] rtnval = new int[64];
 339     int[][] profile = (int[][]) hconsensus.get(AAFrequency.PROFILE);
 340     if (profile == null)
 341       return null;
 342     Object[] ca = new Object[profile[0].length];
 343     float[] vl = new float[profile[0].length];
 344     for (int c = 0; c < ca.length; c++)
 345     {
 346       ca[c] = new char[]
 347       { (char) c };
 348       vl[c] = profile[0][c];
 349     }
 350     ;
 351     jalview.util.QuickSort.sort(vl, ca);
 352     rtnval[0] = 2;
 353     rtnval[1] = 0;
 354     for (int c = ca.length - 1; profile[0][((char[]) ca[c])[0]] > 0; c--)
 355     {
 356       if (((char[]) ca[c])[0] != '-')
 357       {
 358         rtnval[rtnval[0]++] = ((char[]) ca[c])[0];
 359         rtnval[rtnval[0]] = (int) (profile[0][((char[]) ca[c])[0]] * 100f / profile[1][ignoreGapsInConsensusCalculation ? 1
 360                 : 0]);
 361         rtnval[1] += rtnval[rtnval[0]++];
 362       }
 363     }
 364     return rtnval;
 365   }
 366 }