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