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