src/jalview/analysis/AAFrequency.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   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
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.analysis;
  22
  23 import jalview.datamodel.AlignedCodonFrame;
  24 import jalview.datamodel.AlignmentAnnotation;
  25 import jalview.datamodel.AlignmentI;
  26 import jalview.datamodel.Annotation;
  27 import jalview.datamodel.HiddenMarkovModel;
  28 import jalview.datamodel.Profile;
  29 import jalview.datamodel.ProfileI;
  30 import jalview.datamodel.Profiles;
  31 import jalview.datamodel.ProfilesI;
  32 import jalview.datamodel.ResidueCount;
  33 import jalview.datamodel.ResidueCount.SymbolCounts;
  34 import jalview.datamodel.SequenceI;
  35 import jalview.ext.android.SparseIntArray;
  36 import jalview.schemes.ResidueProperties;
  37 import jalview.util.Comparison;
  38 import jalview.util.Format;
  39 import jalview.util.MappingUtils;
  40 import jalview.util.QuickSort;
  41
  42 import java.awt.Color;
  43 import java.util.Arrays;
  44 import java.util.Hashtable;
  45 import java.util.List;
  46
  47 /**
  48  * Takes in a vector or array of sequences and column start and column end and
  49  * returns a new Hashtable[] of size maxSeqLength, if Hashtable not supplied.
  50  * This class is used extensively in calculating alignment colourschemes that
  51  * depend on the amount of conservation in each alignment column.
  52  *
  53  * @author $author$
  54  * @version $Revision$
  55  */
  56 public class AAFrequency
  57 {
  58   public static final String PROFILE = "P";
  59
  60   private static final String AMINO = "amino";
  61
  62   private static final String DNA = "DNA";
  63
  64   private static final String RNA = "RNA";
  65
  66   /*
  67    * Quick look-up of String value of char 'A' to 'Z'
  68    */
  69   private static final String[] CHARS = new String['Z' - 'A' + 1];
  70
  71   static
  72   {
  73     for (char c = 'A'; c <= 'Z'; c++)
  74     {
  75       CHARS[c - 'A'] = String.valueOf(c);
  76     }
  77   }
  78
  79   public static final ProfilesI calculate(List<SequenceI> list, int start,
  80           int end)
  81   {
  82     return calculate(list, start, end, false);
  83   }
  84
  85   public static final ProfilesI calculate(List<SequenceI> sequences,
  86           int start, int end, boolean profile)
  87   {
  88     SequenceI[] seqs = new SequenceI[sequences.size()];
  89     int width = 0;
  90     synchronized (sequences)
  91     {
  92       for (int i = 0; i < sequences.size(); i++)
  93       {
  94         seqs[i] = sequences.get(i);
  95         int length = seqs[i].getLength();
  96         if (length > width)
  97         {
  98           width = length;
  99         }
 100       }
 101
 102       if (end >= width)
 103       {
 104         end = width;
 105       }
 106
 107       ProfilesI reply = calculate(seqs, width, start, end, profile);
 108       return reply;
 109     }
 110   }
 111
 112
 113
 114   /**
 115    * Calculate the consensus symbol(s) for each column in the given range.
 116    *
 117    * @param sequences
 118    * @param width
 119    *          the full width of the alignment
 120    * @param start
 121    *          start column (inclusive, base zero)
 122    * @param end
 123    *          end column (exclusive)
 124    * @param saveFullProfile
 125    *          if true, store all symbol counts
 126    */
 127   public static final ProfilesI calculate(final SequenceI[] sequences,
 128           int width, int start, int end, boolean saveFullProfile)
 129   {
 130     // long now = System.currentTimeMillis();
 131     int seqCount = sequences.length;
 132     boolean nucleotide = false;
 133     int nucleotideCount = 0;
 134     int peptideCount = 0;
 135
 136     ProfileI[] result = new ProfileI[width];
 137
 138     for (int column = start; column < end; column++)
 139     {
 140       /*
 141        * Apply a heuristic to detect nucleotide data (which can
 142        * be counted in more compact arrays); here we test for
 143        * more than 90% nucleotide; recheck every 10 columns in case
 144        * of misleading data e.g. highly conserved Alanine in peptide!
 145        * Mistakenly guessing nucleotide has a small performance cost,
 146        * as it will result in counting in sparse arrays.
 147        * Mistakenly guessing peptide has a small space cost,
 148        * as it will use a larger than necessary array to hold counts.
 149        */
 150       if (nucleotideCount > 100 && column % 10 == 0)
 151       {
 152         nucleotide = (9 * peptideCount < nucleotideCount);
 153       }
 154       ResidueCount residueCounts = new ResidueCount(nucleotide);
 155
 156       for (int row = 0; row < seqCount; row++)
 157       {
 158         if (sequences[row] == null)
 159         {
 160           System.err
 161                   .println("WARNING: Consensus skipping null sequence - possible race condition.");
 162           continue;
 163         }
 164         char[] seq = sequences[row].getSequence();
 165         if (seq.length > column)
 166         {
 167           char c = seq[column];
 168           residueCounts.add(c);
 169           if (Comparison.isNucleotide(c))
 170           {
 171             nucleotideCount++;
 172           }
 173           else if (!Comparison.isGap(c))
 174           {
 175             peptideCount++;
 176           }
 177         }
 178         else
 179         {
 180           /*
 181            * count a gap if the sequence doesn't reach this column
 182            */
 183           residueCounts.addGap();
 184         }
 185       }
 186
 187       int maxCount = residueCounts.getModalCount();
 188       String maxResidue = residueCounts.getResiduesForCount(maxCount);
 189       int gapCount = residueCounts.getGapCount();
 190       ProfileI profile = new Profile(seqCount, gapCount, maxCount,
 191               maxResidue);
 192
 193       if (saveFullProfile)
 194       {
 195         profile.setCounts(residueCounts);
 196       }
 197
 198       result[column] = profile;
 199     }
 200     return new Profiles(result);
 201     // long elapsed = System.currentTimeMillis() - now;
 202     // System.out.println(elapsed);
 203   }
 204
 205   /**
 206    * Returns the full set of profiles for a hidden Markov model. The underlying
 207    * data is the raw probabilities of a residue being emitted at each node,
 208    * however the profiles returned by this function contain the percentage
 209    * chance of a residue emission.
 210    *
 211    * @param hmm
 212    * @param width
 213    *          The width of the Profile array (Profiles) to be returned.
 214    * @param start
 215    *          The alignment column on which the first profile is based.
 216    * @param end
 217    *          The alignment column on which the last profile is based.
 218    * @param saveFullProfile
 219    *          Flag for saving the counts for each profile
 220    * @param removeBelowBackground
 221    *          Flag for removing any characters with a match emission probability
 222    *          less than its background frequency
 223    * @return
 224    */
 225   public static ProfilesI calculateHMMProfiles(final HiddenMarkovModel hmm,
 226           int width, int start, int end, boolean saveFullProfile,
 227           boolean removeBelowBackground)
 228   {
 229     ProfileI[] result = new ProfileI[width];
 230     int symbolCount = hmm.getNumberOfSymbols();
 231     for (int column = start; column < end; column++)
 232     {
 233       ResidueCount counts = new ResidueCount();
 234       for (char symbol : hmm.getSymbols())
 235       {
 236         int value = getAnalogueCount(hmm, column, symbol,
 237                 removeBelowBackground);
 238         counts.put(symbol, value);
 239       }
 240       int maxCount = counts.getModalCount();
 241       String maxResidue = counts.getResiduesForCount(maxCount);
 242       int gapCount = counts.getGapCount();
 243       ProfileI profile = new Profile(symbolCount, gapCount, maxCount,
 244               maxResidue);
 245
 246       if (saveFullProfile)
 247       {
 248         profile.setCounts(counts);
 249       }
 250
 251       result[column] = profile;
 252     }
 253     return new Profiles(result);
 254   }
 255
 256   /**
 257    * Make an estimate of the profile size we are going to compute i.e. how many
 258    * different characters may be present in it. Overestimating has a cost of
 259    * using more memory than necessary. Underestimating has a cost of needing to
 260    * extend the SparseIntArray holding the profile counts.
 261    *
 262    * @param profileSizes
 263    *          counts of sizes of profiles so far encountered
 264    * @return
 265    */
 266   static int estimateProfileSize(SparseIntArray profileSizes)
 267   {
 268     if (profileSizes.size() == 0)
 269     {
 270       return 4;
 271     }
 272
 273     /*
 274      * could do a statistical heuristic here e.g. 75%ile
 275      * for now just return the largest value
 276      */
 277     return profileSizes.keyAt(profileSizes.size() - 1);
 278   }
 279
 280   /**
 281    * Derive the consensus annotations to be added to the alignment for display.
 282    * This does not recompute the raw data, but may be called on a change in
 283    * display options, such as 'ignore gaps', which may in turn result in a
 284    * change in the derived values.
 285    *
 286    * @param consensus
 287    *          the annotation row to add annotations to
 288    * @param profiles
 289    *          the source consensus data
 290    * @param startCol
 291    *          start column (inclusive)
 292    * @param endCol
 293    *          end column (exclusive)
 294    * @param ignoreGaps
 295    *          if true, normalise residue percentages ignoring gaps
 296    * @param showSequenceLogo
 297    *          if true include all consensus symbols, else just show modal
 298    *          residue
 299    * @param nseq
 300    *          number of sequences
 301    */
 302   public static void completeConsensus(AlignmentAnnotation consensus,
 303           ProfilesI profiles, int startCol, int endCol, boolean ignoreGaps,
 304           boolean showSequenceLogo, long nseq)
 305   {
 306     // long now = System.currentTimeMillis();
 307     if (consensus == null || consensus.annotations == null
 308             || consensus.annotations.length < endCol)
 309     {
 310       /*
 311        * called with a bad alignment annotation row
 312        * wait for it to be initialised properly
 313        */
 314       return;
 315     }
 316
 317     for (int i = startCol; i < endCol; i++)
 318     {
 319       ProfileI profile = profiles.get(i);
 320       if (profile == null)
 321       {
 322         /*
 323          * happens if sequences calculated over were
 324          * shorter than alignment width
 325          */
 326         consensus.annotations[i] = null;
 327         return;
 328       }
 329
 330       final int dp = getPercentageDp(nseq);
 331
 332       float value = profile.getPercentageIdentity(ignoreGaps);
 333
 334       String description = getTooltip(profile, value, showSequenceLogo,
 335               ignoreGaps, dp);
 336
 337       String modalResidue = profile.getModalResidue();
 338       if ("".equals(modalResidue))
 339       {
 340         modalResidue = "-";
 341       }
 342       else if (modalResidue.length() > 1)
 343       {
 344         modalResidue = "+";
 345       }
 346       consensus.annotations[i] = new Annotation(modalResidue, description,
 347               ' ', value);
 348     }
 349     // long elapsed = System.currentTimeMillis() - now;
 350     // System.out.println(-elapsed);
 351   }
 352
 353   /**
 354    * Derive the information annotations to be added to the alignment for
 355    * display. This does not recompute the raw data, but may be called on a
 356    * change in display options, such as 'ignore below background frequency',
 357    * which may in turn result in a change in the derived values.
 358    *
 359    * @param information
 360    *          the annotation row to add annotations to
 361    * @param profiles
 362    *          the source information data
 363    * @param startCol
 364    *          start column (inclusive)
 365    * @param endCol
 366    *          end column (exclusive)
 367    * @param ignoreGaps
 368    *          if true, normalise residue percentages
 369    * @param showSequenceLogo
 370    *          if true include all information symbols, else just show modal
 371    *          residue
 372    * @param nseq
 373    *          number of sequences
 374    */
 375   public static void completeInformation(AlignmentAnnotation information,
 376           ProfilesI profiles, int startCol, int endCol,
 377           boolean ignoreBelowBackground,
 378           boolean showSequenceLogo, long nseq)
 379   {
 380     // long now = System.currentTimeMillis();
 381     if (information == null || information.annotations == null
 382             || information.annotations.length < endCol)
 383     {
 384       /*
 385        * called with a bad alignment annotation row
 386        * wait for it to be initialised properly
 387        */
 388       return;
 389     }
 390
 391     Float max = 0f;
 392
 393     for (int i = startCol; i < endCol; i++)
 394     {
 395       ProfileI profile = profiles.get(i);
 396       if (profile == null)
 397       {
 398         /*
 399          * happens if sequences calculated over were
 400          * shorter than alignment width
 401          */
 402         information.annotations[i] = null;
 403         return;
 404       }
 405
 406       HiddenMarkovModel hmm;
 407
 408       SequenceI hmmSeq = information.sequenceRef;
 409
 410       hmm = hmmSeq.getHMM();
 411
 412       Float value = getInformationContent(i, hmm);
 413
 414       if (value > max)
 415       {
 416         max = value;
 417       }
 418
 419       String description = value + " bits";
 420       information.annotations[i] = new Annotation(
 421               Character.toString(hmm.getConsensusAtAlignColumn(i)),
 422               description, ' ', value);
 423     }
 424     information.graphMax = max;
 425     // long elapsed = System.currentTimeMillis() - now;
 426     // System.out.println(-elapsed);
 427   }
 428
 429   /**
 430    * Derive the gap count annotation row.
 431    *
 432    * @param gaprow
 433    *          the annotation row to add annotations to
 434    * @param profiles
 435    *          the source consensus data
 436    * @param startCol
 437    *          start column (inclusive)
 438    * @param endCol
 439    *          end column (exclusive)
 440    */
 441   public static void completeGapAnnot(AlignmentAnnotation gaprow,
 442           ProfilesI profiles, int startCol, int endCol, long nseq)
 443   {
 444     if (gaprow == null || gaprow.annotations == null
 445             || gaprow.annotations.length < endCol)
 446     {
 447       /*
 448        * called with a bad alignment annotation row
 449        * wait for it to be initialised properly
 450        */
 451       return;
 452     }
 453     // always set ranges again
 454     gaprow.graphMax = nseq;
 455     gaprow.graphMin = 0;
 456     double scale = 0.8/nseq;
 457     for (int i = startCol; i < endCol; i++)
 458     {
 459       ProfileI profile = profiles.get(i);
 460       if (profile == null)
 461       {
 462         /*
 463          * happens if sequences calculated over were
 464          * shorter than alignment width
 465          */
 466         gaprow.annotations[i] = null;
 467         return;
 468       }
 469
 470       final int gapped = profile.getNonGapped();
 471
 472       String description = "" + gapped;
 473
 474       gaprow.annotations[i] = new Annotation("", description,
 475               '\0', gapped, jalview.util.ColorUtils.bleachColour(
 476                       Color.DARK_GRAY, (float) scale * gapped));
 477     }
 478   }
 479
 480   /**
 481    * Returns a tooltip showing either
 482    * <ul>
 483    * <li>the full profile (percentages of all residues present), if
 484    * showSequenceLogo is true, or</li>
 485    * <li>just the modal (most common) residue(s), if showSequenceLogo is false</li>
 486    * </ul>
 487    * Percentages are as a fraction of all sequence, or only ungapped sequences
 488    * if ignoreGaps is true.
 489    *
 490    * @param profile
 491    * @param pid
 492    * @param showSequenceLogo
 493    * @param ignoreGaps
 494    * @param dp
 495    *          the number of decimal places to format percentages to
 496    * @return
 497    */
 498   static String getTooltip(ProfileI profile, float pid,
 499           boolean showSequenceLogo, boolean ignoreGaps, int dp)
 500   {
 501     ResidueCount counts = profile.getCounts();
 502
 503     String description = null;
 504     if (counts != null && showSequenceLogo)
 505     {
 506       int normaliseBy = ignoreGaps ? profile.getNonGapped() : profile
 507               .getHeight();
 508       description = counts.getTooltip(normaliseBy, dp);
 509     }
 510     else
 511     {
 512       StringBuilder sb = new StringBuilder(64);
 513       String maxRes = profile.getModalResidue();
 514       if (maxRes.length() > 1)
 515       {
 516         sb.append("[").append(maxRes).append("]");
 517       }
 518       else
 519       {
 520         sb.append(maxRes);
 521       }
 522       if (maxRes.length() > 0)
 523       {
 524         sb.append(" ");
 525         Format.appendPercentage(sb, pid, dp);
 526         sb.append("%");
 527       }
 528       description = sb.toString();
 529     }
 530     return description;
 531   }
 532
 533   /**
 534    * Returns the sorted profile for the given consensus data. The returned array
 535    * contains
 536    *
 537    * <pre>
 538    *    [profileType, numberOfValues, nonGapCount, charValue1, percentage1, charValue2, percentage2, ...]
 539    * in descending order of percentage value
 540    * </pre>
 541    *
 542    * @param profile
 543    *          the data object from which to extract and sort values
 544    * @param ignoreGaps
 545    *          if true, only non-gapped values are included in percentage
 546    *          calculations
 547    * @return
 548    */
 549   public static int[] extractProfile(ProfileI profile, boolean ignoreGaps)
 550   {
 551     int[] rtnval = new int[64];
 552     ResidueCount counts = profile.getCounts();
 553     if (counts == null)
 554     {
 555       return null;
 556     }
 557
 558     SymbolCounts symbolCounts = counts.getSymbolCounts();
 559     char[] symbols = symbolCounts.symbols;
 560     int[] values = symbolCounts.values;
 561     QuickSort.sort(values, symbols);
 562     int nextArrayPos = 2;
 563     int totalPercentage = 0;
 564     final int divisor = ignoreGaps ? profile.getNonGapped() : profile
 565             .getHeight();
 566
 567     /*
 568      * traverse the arrays in reverse order (highest counts first)
 569      */
 570     for (int i = symbols.length - 1; i >= 0; i--)
 571     {
 572       int theChar = symbols[i];
 573       int charCount = values[i];
 574
 575       rtnval[nextArrayPos++] = theChar;
 576       final int percentage = (charCount * 100) / divisor;
 577       rtnval[nextArrayPos++] = percentage;
 578       totalPercentage += percentage;
 579     }
 580     rtnval[0] = symbols.length;
 581     rtnval[1] = totalPercentage;
 582     int[] result = new int[rtnval.length + 1];
 583     result[0] = AlignmentAnnotation.SEQUENCE_PROFILE;
 584     System.arraycopy(rtnval, 0, result, 1, rtnval.length);
 585
 586     return result;
 587   }
 588
 589
 590   /**
 591    * Extract a sorted extract of cDNA codon profile data. The returned array
 592    * contains
 593    *
 594    * <pre>
 595    *    [profileType, numberOfValues, totalCount, charValue1, percentage1, charValue2, percentage2, ...]
 596    * in descending order of percentage value, where the character values encode codon triplets
 597    * </pre>
 598    *
 599    * @param hashtable
 600    * @return
 601    */
 602   public static int[] extractCdnaProfile(Hashtable hashtable,
 603           boolean ignoreGaps)
 604   {
 605     // this holds #seqs, #ungapped, and then codon count, indexed by encoded
 606     // codon triplet
 607     int[] codonCounts = (int[]) hashtable.get(PROFILE);
 608     int[] sortedCounts = new int[codonCounts.length - 2];
 609     System.arraycopy(codonCounts, 2, sortedCounts, 0,
 610             codonCounts.length - 2);
 611
 612     int[] result = new int[3 + 2 * sortedCounts.length];
 613     // first value is just the type of profile data
 614     result[0] = AlignmentAnnotation.CDNA_PROFILE;
 615
 616     char[] codons = new char[sortedCounts.length];
 617     for (int i = 0; i < codons.length; i++)
 618     {
 619       codons[i] = (char) i;
 620     }
 621     QuickSort.sort(sortedCounts, codons);
 622     int totalPercentage = 0;
 623     int distinctValuesCount = 0;
 624     int j = 3;
 625     int divisor = ignoreGaps ? codonCounts[1] : codonCounts[0];
 626     for (int i = codons.length - 1; i >= 0; i--)
 627     {
 628       final int codonCount = sortedCounts[i];
 629       if (codonCount == 0)
 630       {
 631         break; // nothing else of interest here
 632       }
 633       distinctValuesCount++;
 634       result[j++] = codons[i];
 635       final int percentage = codonCount * 100 / divisor;
 636       result[j++] = percentage;
 637       totalPercentage += percentage;
 638     }
 639     result[2] = totalPercentage;
 640
 641     /*
 642      * Just return the non-zero values
 643      */
 644     // todo next value is redundant if we limit the array to non-zero counts
 645     result[1] = distinctValuesCount;
 646     return Arrays.copyOfRange(result, 0, j);
 647   }
 648
 649   /**
 650    * Compute a consensus for the cDNA coding for a protein alignment.
 651    *
 652    * @param alignment
 653    *          the protein alignment (which should hold mappings to cDNA
 654    *          sequences)
 655    * @param hconsensus
 656    *          the consensus data stores to be populated (one per column)
 657    */
 658   public static void calculateCdna(AlignmentI alignment,
 659           Hashtable[] hconsensus)
 660   {
 661     final char gapCharacter = alignment.getGapCharacter();
 662     List<AlignedCodonFrame> mappings = alignment.getCodonFrames();
 663     if (mappings == null || mappings.isEmpty())
 664     {
 665       return;
 666     }
 667
 668     int cols = alignment.getWidth();
 669     for (int col = 0; col < cols; col++)
 670     {
 671       // todo would prefer a Java bean for consensus data
 672       Hashtable<String, int[]> columnHash = new Hashtable<>();
 673       // #seqs, #ungapped seqs, counts indexed by (codon encoded + 1)
 674       int[] codonCounts = new int[66];
 675       codonCounts[0] = alignment.getSequences().size();
 676       int ungappedCount = 0;
 677       for (SequenceI seq : alignment.getSequences())
 678       {
 679         if (seq.getCharAt(col) == gapCharacter)
 680         {
 681           continue;
 682         }
 683         List<char[]> codons = MappingUtils
 684                 .findCodonsFor(seq, col, mappings);
 685         for (char[] codon : codons)
 686         {
 687           int codonEncoded = CodingUtils.encodeCodon(codon);
 688           if (codonEncoded >= 0)
 689           {
 690             codonCounts[codonEncoded + 2]++;
 691             ungappedCount++;
 692           }
 693         }
 694       }
 695       codonCounts[1] = ungappedCount;
 696       // todo: sort values here, save counts and codons?
 697       columnHash.put(PROFILE, codonCounts);
 698       hconsensus[col] = columnHash;
 699     }
 700   }
 701
 702   /**
 703    * Derive displayable cDNA consensus annotation from computed consensus data.
 704    *
 705    * @param consensusAnnotation
 706    *          the annotation row to be populated for display
 707    * @param consensusData
 708    *          the computed consensus data
 709    * @param showProfileLogo
 710    *          if true show all symbols present at each position, else only the
 711    *          modal value
 712    * @param nseqs
 713    *          the number of sequences in the alignment
 714    */
 715   public static void completeCdnaConsensus(
 716           AlignmentAnnotation consensusAnnotation,
 717           Hashtable[] consensusData, boolean showProfileLogo, int nseqs)
 718   {
 719     if (consensusAnnotation == null
 720             || consensusAnnotation.annotations == null
 721             || consensusAnnotation.annotations.length < consensusData.length)
 722     {
 723       // called with a bad alignment annotation row - wait for it to be
 724       // initialised properly
 725       return;
 726     }
 727
 728     // ensure codon triplet scales with font size
 729     consensusAnnotation.scaleColLabel = true;
 730     for (int col = 0; col < consensusData.length; col++)
 731     {
 732       Hashtable hci = consensusData[col];
 733       if (hci == null)
 734       {
 735         // gapped protein column?
 736         continue;
 737       }
 738       // array holds #seqs, #ungapped, then codon counts indexed by codon
 739       final int[] codonCounts = (int[]) hci.get(PROFILE);
 740       int totalCount = 0;
 741
 742       /*
 743        * First pass - get total count and find the highest
 744        */
 745       final char[] codons = new char[codonCounts.length - 2];
 746       for (int j = 2; j < codonCounts.length; j++)
 747       {
 748         final int codonCount = codonCounts[j];
 749         codons[j - 2] = (char) (j - 2);
 750         totalCount += codonCount;
 751       }
 752
 753       /*
 754        * Sort array of encoded codons by count ascending - so the modal value
 755        * goes to the end; start by copying the count (dropping the first value)
 756        */
 757       int[] sortedCodonCounts = new int[codonCounts.length - 2];
 758       System.arraycopy(codonCounts, 2, sortedCodonCounts, 0,
 759               codonCounts.length - 2);
 760       QuickSort.sort(sortedCodonCounts, codons);
 761
 762       int modalCodonEncoded = codons[codons.length - 1];
 763       int modalCodonCount = sortedCodonCounts[codons.length - 1];
 764       String modalCodon = String.valueOf(CodingUtils
 765               .decodeCodon(modalCodonEncoded));
 766       if (sortedCodonCounts.length > 1
 767               && sortedCodonCounts[codons.length - 2] == sortedCodonCounts[codons.length - 1])
 768       {
 769         /*
 770          * two or more codons share the modal count
 771          */
 772         modalCodon = "+";
 773       }
 774       float pid = sortedCodonCounts[sortedCodonCounts.length - 1] * 100
 775               / (float) totalCount;
 776
 777       /*
 778        * todo ? Replace consensus hashtable with sorted arrays of codons and
 779        * counts (non-zero only). Include total count in count array [0].
 780        */
 781
 782       /*
 783        * Scan sorted array backwards for most frequent values first. Show
 784        * repeated values compactly.
 785        */
 786       StringBuilder mouseOver = new StringBuilder(32);
 787       StringBuilder samePercent = new StringBuilder();
 788       String percent = null;
 789       String lastPercent = null;
 790       int percentDecPl = getPercentageDp(nseqs);
 791
 792       for (int j = codons.length - 1; j >= 0; j--)
 793       {
 794         int codonCount = sortedCodonCounts[j];
 795         if (codonCount == 0)
 796         {
 797           /*
 798            * remaining codons are 0% - ignore, but finish off the last one if
 799            * necessary
 800            */
 801           if (samePercent.length() > 0)
 802           {
 803             mouseOver.append(samePercent).append(": ").append(percent)
 804                     .append("% ");
 805           }
 806           break;
 807         }
 808         int codonEncoded = codons[j];
 809         final int pct = codonCount * 100 / totalCount;
 810         String codon = String
 811                 .valueOf(CodingUtils.decodeCodon(codonEncoded));
 812         StringBuilder sb = new StringBuilder();
 813         Format.appendPercentage(sb, pct, percentDecPl);
 814         percent = sb.toString();
 815         if (showProfileLogo || codonCount == modalCodonCount)
 816         {
 817           if (percent.equals(lastPercent) && j > 0)
 818           {
 819             samePercent.append(samePercent.length() == 0 ? "" : ", ");
 820             samePercent.append(codon);
 821           }
 822           else
 823           {
 824             if (samePercent.length() > 0)
 825             {
 826               mouseOver.append(samePercent).append(": ")
 827                       .append(lastPercent).append("% ");
 828             }
 829             samePercent.setLength(0);
 830             samePercent.append(codon);
 831           }
 832           lastPercent = percent;
 833         }
 834       }
 835
 836       consensusAnnotation.annotations[col] = new Annotation(modalCodon,
 837               mouseOver.toString(), ' ', pid);
 838     }
 839   }
 840
 841   /**
 842    * Returns the number of decimal places to show for profile percentages. For
 843    * less than 100 sequences, returns zero (the integer percentage value will be
 844    * displayed). For 100-999 sequences, returns 1, for 1000-9999 returns 2, etc.
 845    *
 846    * @param nseq
 847    * @return
 848    */
 849   protected static int getPercentageDp(long nseq)
 850   {
 851     int scale = 0;
 852     while (nseq >= 100)
 853     {
 854       scale++;
 855       nseq /= 10;
 856     }
 857     return scale;
 858   }
 859
 860   /**
 861    * Returns the information content at a specified column.
 862    *
 863    * @param column
 864    *          Index of the column, starting from 0.
 865    * @return
 866    */
 867   public static float getInformationContent(int column,
 868           HiddenMarkovModel hmm)
 869   {
 870     float informationContent = 0f;
 871
 872     for (char symbol : hmm.getSymbols())
 873     {
 874       float freq = 0f;
 875       freq = ResidueProperties.backgroundFrequencies
 876               .get(hmm.getAlphabetType()).get(symbol);
 877       Double hmmProb = hmm.getMatchEmissionProbability(column, symbol);
 878       float prob = hmmProb.floatValue();
 879       informationContent += prob * (Math.log(prob / freq) / Math.log(2));
 880
 881     }
 882
 883     return informationContent;
 884   }
 885
 886   /**
 887    * Produces a HMM profile for a column in an alignment
 888    *
 889    * @param aa
 890    *          Alignment annotation for which the profile is being calculated.
 891    * @param column
 892    *          Column in the alignment the profile is being made for.
 893    * @param removeBelowBackground
 894    *          Boolean indicating whether to ignore residues with probabilities
 895    *          less than their background frequencies.
 896    * @return
 897    */
 898   public static int[] extractHMMProfile(HiddenMarkovModel hmm, int column,
 899           boolean removeBelowBackground)
 900   {
 901
 902     if (hmm != null)
 903     {
 904       int size = hmm.getNumberOfSymbols();
 905       char symbols[] = new char[size];
 906       int values[] = new int[size];
 907       List<Character> charList = hmm.getSymbols();
 908       Integer totalCount = 0;
 909
 910       for (int i = 0; i < size; i++)
 911       {
 912         char symbol = charList.get(i);
 913         symbols[i] = symbol;
 914         int value = getAnalogueCount(hmm, column, symbol,
 915                 removeBelowBackground);
 916         values[i] = value;
 917         totalCount += value;
 918       }
 919
 920       QuickSort.sort(values, symbols);
 921
 922       int[] profile = new int[3 + size * 2];
 923
 924       profile[0] = AlignmentAnnotation.SEQUENCE_PROFILE;
 925       profile[1] = size;
 926       profile[2] = 100;
 927
 928       if (totalCount != 0)
 929       {
 930         int arrayPos = 3;
 931         for (int k = size - 1; k >= 0; k--)
 932         {
 933           Float percentage;
 934           Integer value = values[k];
 935           if (removeBelowBackground)
 936           {
 937             percentage = (value.floatValue() / totalCount.floatValue())
 938                     * 100;
 939           }
 940           else
 941           {
 942             percentage = value.floatValue() / 100f;
 943           }
 944           int intPercent = Math.round(percentage);
 945           profile[arrayPos] = symbols[k];
 946           profile[arrayPos + 1] = intPercent;
 947           arrayPos += 2;
 948         }
 949       }
 950       return profile;
 951     }
 952     return null;
 953   }
 954
 955   /**
 956    * Converts the emission probability of a residue at a column in the alignment
 957    * to a 'count' to allow for processing by the annotation renderer.
 958    *
 959    * @param hmm
 960    * @param column
 961    * @param removeBelowBackground
 962    *          When true, this method returns 0 for any symbols with a match
 963    *          emission probability less than the background frequency.
 964    * @param symbol
 965    * @return
 966    */
 967   static int getAnalogueCount(HiddenMarkovModel hmm, int column,
 968           char symbol, boolean removeBelowBackground)
 969   {
 970     Double value;
 971
 972     value = hmm.getMatchEmissionProbability(column, symbol);
 973     double freq;
 974
 975     freq = ResidueProperties.backgroundFrequencies
 976             .get(hmm.getAlphabetType()).get(symbol);
 977     if (value < freq && removeBelowBackground)
 978     {
 979       return 0;
 980     }
 981
 982     value = value * 10000;
 983     return Math.round(value.floatValue());
 984   }
 985 }