JAL-3285 change method declaration in AAFrequency to match develop
[jalview.git] / 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, nonGapCount, 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     int[] rtnval = new int[64];
522     ResidueCount counts = profile.getCounts();
523     if (counts == null)
524     {
525       return null;
526     }
527
528     SymbolCounts symbolCounts = counts.getSymbolCounts();
529     char[] symbols = symbolCounts.symbols;
530     int[] values = symbolCounts.values;
531     QuickSort.sort(values, symbols);
532     int nextArrayPos = 2;
533     int totalPercentage = 0;
534     final int divisor = ignoreGaps ? profile.getNonGapped()
535             : profile.getHeight();
536
537     /*
538      * traverse the arrays in reverse order (highest counts first)
539      */
540     for (int i = symbols.length - 1; i >= 0; i--)
541     {
542       int theChar = symbols[i];
543       int charCount = values[i];
544
545       rtnval[nextArrayPos++] = theChar;
546       final int percentage = (charCount * 100) / divisor;
547       rtnval[nextArrayPos++] = percentage;
548       totalPercentage += percentage;
549     }
550     rtnval[0] = symbols.length;
551     rtnval[1] = totalPercentage;
552     int[] result = new int[rtnval.length + 1];
553     result[0] = AlignmentAnnotation.SEQUENCE_PROFILE;
554     System.arraycopy(rtnval, 0, result, 1, rtnval.length);
555
556     return result;
557   }
558
559
560   /**
561    * Extract a sorted extract of cDNA codon profile data. The returned array
562    * contains
563    * 
564    * <pre>
565    *    [profileType, numberOfValues, totalCount, charValue1, percentage1, charValue2, percentage2, ...]
566    * in descending order of percentage value, where the character values encode codon triplets
567    * </pre>
568    * 
569    * @param hashtable
570    * @return
571    */
572   public static int[] extractCdnaProfile(Hashtable hashtable,
573           boolean ignoreGaps)
574   {
575     // this holds #seqs, #ungapped, and then codon count, indexed by encoded
576     // codon triplet
577     int[] codonCounts = (int[]) hashtable.get(PROFILE);
578     int[] sortedCounts = new int[codonCounts.length - 2];
579     System.arraycopy(codonCounts, 2, sortedCounts, 0,
580             codonCounts.length - 2);
581
582     int[] result = new int[3 + 2 * sortedCounts.length];
583     // first value is just the type of profile data
584     result[0] = AlignmentAnnotation.CDNA_PROFILE;
585
586     char[] codons = new char[sortedCounts.length];
587     for (int i = 0; i < codons.length; i++)
588     {
589       codons[i] = (char) i;
590     }
591     QuickSort.sort(sortedCounts, codons);
592     int totalPercentage = 0;
593     int distinctValuesCount = 0;
594     int j = 3;
595     int divisor = ignoreGaps ? codonCounts[1] : codonCounts[0];
596     for (int i = codons.length - 1; i >= 0; i--)
597     {
598       final int codonCount = sortedCounts[i];
599       if (codonCount == 0)
600       {
601         break; // nothing else of interest here
602       }
603       distinctValuesCount++;
604       result[j++] = codons[i];
605       final int percentage = codonCount * 100 / divisor;
606       result[j++] = percentage;
607       totalPercentage += percentage;
608     }
609     result[2] = totalPercentage;
610
611     /*
612      * Just return the non-zero values
613      */
614     // todo next value is redundant if we limit the array to non-zero counts
615     result[1] = distinctValuesCount;
616     return Arrays.copyOfRange(result, 0, j);
617   }
618
619   /**
620    * Compute a consensus for the cDNA coding for a protein alignment.
621    * 
622    * @param alignment
623    *          the protein alignment (which should hold mappings to cDNA
624    *          sequences)
625    * @param hconsensus
626    *          the consensus data stores to be populated (one per column)
627    */
628   public static void calculateCdna(AlignmentI alignment,
629           Hashtable[] hconsensus)
630   {
631     final char gapCharacter = alignment.getGapCharacter();
632     List<AlignedCodonFrame> mappings = alignment.getCodonFrames();
633     if (mappings == null || mappings.isEmpty())
634     {
635       return;
636     }
637
638     int cols = alignment.getWidth();
639     for (int col = 0; col < cols; col++)
640     {
641       // todo would prefer a Java bean for consensus data
642       Hashtable<String, int[]> columnHash = new Hashtable<>();
643       // #seqs, #ungapped seqs, counts indexed by (codon encoded + 1)
644       int[] codonCounts = new int[66];
645       codonCounts[0] = alignment.getSequences().size();
646       int ungappedCount = 0;
647       for (SequenceI seq : alignment.getSequences())
648       {
649         if (seq.getCharAt(col) == gapCharacter)
650         {
651           continue;
652         }
653         List<char[]> codons = MappingUtils.findCodonsFor(seq, col,
654                 mappings);
655         for (char[] codon : codons)
656         {
657           int codonEncoded = CodingUtils.encodeCodon(codon);
658           if (codonEncoded >= 0)
659           {
660             codonCounts[codonEncoded + 2]++;
661             ungappedCount++;
662           }
663         }
664       }
665       codonCounts[1] = ungappedCount;
666       // todo: sort values here, save counts and codons?
667       columnHash.put(PROFILE, codonCounts);
668       hconsensus[col] = columnHash;
669     }
670   }
671
672   /**
673    * Derive displayable cDNA consensus annotation from computed consensus data.
674    * 
675    * @param consensusAnnotation
676    *          the annotation row to be populated for display
677    * @param consensusData
678    *          the computed consensus data
679    * @param showProfileLogo
680    *          if true show all symbols present at each position, else only the
681    *          modal value
682    * @param nseqs
683    *          the number of sequences in the alignment
684    */
685   public static void completeCdnaConsensus(
686           AlignmentAnnotation consensusAnnotation,
687           Hashtable[] consensusData, boolean showProfileLogo, int nseqs)
688   {
689     if (consensusAnnotation == null
690             || consensusAnnotation.annotations == null
691             || consensusAnnotation.annotations.length < consensusData.length)
692     {
693       // called with a bad alignment annotation row - wait for it to be
694       // initialised properly
695       return;
696     }
697
698     // ensure codon triplet scales with font size
699     consensusAnnotation.scaleColLabel = true;
700     for (int col = 0; col < consensusData.length; col++)
701     {
702       Hashtable hci = consensusData[col];
703       if (hci == null)
704       {
705         // gapped protein column?
706         continue;
707       }
708       // array holds #seqs, #ungapped, then codon counts indexed by codon
709       final int[] codonCounts = (int[]) hci.get(PROFILE);
710       int totalCount = 0;
711
712       /*
713        * First pass - get total count and find the highest
714        */
715       final char[] codons = new char[codonCounts.length - 2];
716       for (int j = 2; j < codonCounts.length; j++)
717       {
718         final int codonCount = codonCounts[j];
719         codons[j - 2] = (char) (j - 2);
720         totalCount += codonCount;
721       }
722
723       /*
724        * Sort array of encoded codons by count ascending - so the modal value
725        * goes to the end; start by copying the count (dropping the first value)
726        */
727       int[] sortedCodonCounts = new int[codonCounts.length - 2];
728       System.arraycopy(codonCounts, 2, sortedCodonCounts, 0,
729               codonCounts.length - 2);
730       QuickSort.sort(sortedCodonCounts, codons);
731
732       int modalCodonEncoded = codons[codons.length - 1];
733       int modalCodonCount = sortedCodonCounts[codons.length - 1];
734       String modalCodon = String
735               .valueOf(CodingUtils.decodeCodon(modalCodonEncoded));
736       if (sortedCodonCounts.length > 1 && sortedCodonCounts[codons.length
737               - 2] == sortedCodonCounts[codons.length - 1])
738       {
739         /*
740          * two or more codons share the modal count
741          */
742         modalCodon = "+";
743       }
744       float pid = sortedCodonCounts[sortedCodonCounts.length - 1] * 100
745               / (float) totalCount;
746
747       /*
748        * todo ? Replace consensus hashtable with sorted arrays of codons and
749        * counts (non-zero only). Include total count in count array [0].
750        */
751
752       /*
753        * Scan sorted array backwards for most frequent values first. Show
754        * repeated values compactly.
755        */
756       StringBuilder mouseOver = new StringBuilder(32);
757       StringBuilder samePercent = new StringBuilder();
758       String percent = null;
759       String lastPercent = null;
760       int percentDecPl = getPercentageDp(nseqs);
761
762       for (int j = codons.length - 1; j >= 0; j--)
763       {
764         int codonCount = sortedCodonCounts[j];
765         if (codonCount == 0)
766         {
767           /*
768            * remaining codons are 0% - ignore, but finish off the last one if
769            * necessary
770            */
771           if (samePercent.length() > 0)
772           {
773             mouseOver.append(samePercent).append(": ").append(percent)
774                     .append("% ");
775           }
776           break;
777         }
778         int codonEncoded = codons[j];
779         final int pct = codonCount * 100 / totalCount;
780         String codon = String
781                 .valueOf(CodingUtils.decodeCodon(codonEncoded));
782         StringBuilder sb = new StringBuilder();
783         Format.appendPercentage(sb, pct, percentDecPl);
784         percent = sb.toString();
785         if (showProfileLogo || codonCount == modalCodonCount)
786         {
787           if (percent.equals(lastPercent) && j > 0)
788           {
789             samePercent.append(samePercent.length() == 0 ? "" : ", ");
790             samePercent.append(codon);
791           }
792           else
793           {
794             if (samePercent.length() > 0)
795             {
796               mouseOver.append(samePercent).append(": ").append(lastPercent)
797                       .append("% ");
798             }
799             samePercent.setLength(0);
800             samePercent.append(codon);
801           }
802           lastPercent = percent;
803         }
804       }
805
806       consensusAnnotation.annotations[col] = new Annotation(modalCodon,
807               mouseOver.toString(), ' ', pid);
808     }
809   }
810
811   /**
812    * Returns the number of decimal places to show for profile percentages. For
813    * less than 100 sequences, returns zero (the integer percentage value will be
814    * displayed). For 100-999 sequences, returns 1, for 1000-9999 returns 2, etc.
815    * 
816    * @param nseq
817    * @return
818    */
819   protected static int getPercentageDp(long nseq)
820   {
821     int scale = 0;
822     while (nseq >= 100)
823     {
824       scale++;
825       nseq /= 10;
826     }
827     return scale;
828   }
829
830   /**
831    * Returns the sorted HMM profile for the given column of the alignment. The
832    * returned array contains
833    * 
834    * <pre>
835    *    [profileType=0, numberOfValues, 100, charValue1, percentage1, charValue2, percentage2, ...]
836    * in descending order of percentage value
837    * </pre>
838    * 
839    * @param hmm
840    * @param column
841    * @param removeBelowBackground
842    *          if true, ignores residues with probability less than their
843    *          background frequency
844    * @param infoHeight
845    *          if true, uses the log ratio 'information' measure to scale the
846    *          value
847    * @return
848    */
849   public static int[] extractHMMProfile(HiddenMarkovModel hmm, int column,
850           boolean removeBelowBackground, boolean infoHeight)
851   {
852     if (hmm == null)
853     {
854       return null;
855     }
856     String alphabet = hmm.getSymbols();
857     int size = alphabet.length();
858     char symbols[] = new char[size];
859     int values[] = new int[size];
860     int totalCount = 0;
861
862     for (int i = 0; i < size; i++)
863     {
864       char symbol = alphabet.charAt(i);
865       symbols[i] = symbol;
866       int value = getAnalogueCount(hmm, column, symbol,
867               removeBelowBackground, infoHeight);
868       values[i] = value;
869       totalCount += value;
870     }
871
872     /*
873      * sort symbols by increasing emission probability
874      */
875     QuickSort.sort(values, symbols);
876
877     int[] profile = new int[3 + size * 2];
878
879     profile[0] = AlignmentAnnotation.SEQUENCE_PROFILE;
880     profile[1] = size;
881     profile[2] = 100;
882
883     /*
884      * order symbol/count profile by decreasing emission probability
885      */
886     if (totalCount != 0)
887     {
888       int arrayPos = 3;
889       for (int k = size - 1; k >= 0; k--)
890       {
891         Float percentage;
892         int value = values[k];
893         if (removeBelowBackground)
894         {
895           percentage = ((float) value) / totalCount * 100f;
896         }
897         else
898         {
899           percentage = value / 100f;
900         }
901         int intPercent = Math.round(percentage);
902         profile[arrayPos] = symbols[k];
903         profile[arrayPos + 1] = intPercent;
904         arrayPos += 2;
905       }
906     }
907     return profile;
908   }
909
910   /**
911    * Converts the emission probability of a residue at a column in the alignment
912    * to a 'count', suitable for rendering as an annotation value
913    * 
914    * @param hmm
915    * @param column
916    * @param symbol
917    * @param removeBelowBackground
918    *          if true, returns 0 for any symbol with a match emission
919    *          probability less than the background frequency
920    * @infoHeight if true, uses the log ratio 'information content' to scale the
921    *             value
922    * @return
923    */
924   static int getAnalogueCount(HiddenMarkovModel hmm, int column,
925           char symbol, boolean removeBelowBackground, boolean infoHeight)
926   {
927     double value = hmm.getMatchEmissionProbability(column, symbol);
928     double freq = ResidueProperties.backgroundFrequencies
929             .get(hmm.getAlphabetType()).get(symbol);
930     if (value < freq && removeBelowBackground)
931     {
932       return 0;
933     }
934
935     if (infoHeight)
936     {
937       value = value * (Math.log(value / freq) / LOG2);
938     }
939
940     value = value * 10000d;
941     return Math.round((float) value);
942   }
943 }