JAL-2629 storage and lifecycle of alignment/group HMM annotations revised
[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 saveFullProfile
197    *          if true, all residue counts are saved (enables profile logo)
198    * @param removeBelowBackground
199    *          if true, symbols with a match emission probability less than
200    *          background frequency are ignored
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     SequenceI hmmSeq = information.sequenceRef;
371     HiddenMarkovModel hmm = hmmSeq.getHMM();
372
373     for (int column = startCol; column < endCol; column++)
374     {
375       ProfileI profile = profiles.get(column);
376       if (profile == null)
377       {
378         /*
379          * happens if sequences calculated over were 
380          * shorter than alignment width
381          */
382         information.annotations[column] = null;
383         return 0f;
384       }
385       
386       float value = hmm.getInformationContent(column);
387       boolean isNaN = Float.isNaN(value);
388       if (!isNaN)
389       {
390         max = Math.max(max, value);
391       }
392
393       String description = isNaN ? null
394               : String.format("%.4f bits", value);
395       information.annotations[column] = new Annotation(
396               Character.toString(Character
397                       .toUpperCase(hmm.getConsensusAtAlignColumn(column))),
398               description, ' ', value);
399     }
400
401     max = Math.max(max, currentMax);
402     information.graphMax = max;
403     return max;
404   }
405
406   /**
407    * Derive the occupancy count annotation
408    * 
409    * @param occupancy
410    *          the annotation row to add annotations to
411    * @param profiles
412    *          the source consensus data
413    * @param startCol
414    *          start column (inclusive)
415    * @param endCol
416    *          end column (exclusive)
417    */
418   public static void completeOccupancyAnnot(AlignmentAnnotation occupancy,
419           ProfilesI profiles, int startCol, int endCol, long nseq)
420   {
421     if (occupancy == null || occupancy.annotations == null
422             || occupancy.annotations.length < endCol)
423     {
424       /*
425        * called with a bad alignment annotation row 
426        * wait for it to be initialised properly
427        */
428       return;
429     }
430     // always set ranges again
431     occupancy.graphMax = nseq;
432     occupancy.graphMin = 0;
433     double scale = 0.8 / nseq;
434     for (int i = startCol; i < endCol; i++)
435     {
436       ProfileI profile = profiles.get(i);
437       if (profile == null)
438       {
439         /*
440          * happens if sequences calculated over were 
441          * shorter than alignment width
442          */
443         occupancy.annotations[i] = null;
444         return;
445       }
446
447       final int gapped = profile.getNonGapped();
448
449       String description = "" + gapped;
450
451       occupancy.annotations[i] = new Annotation("", description, '\0',
452               gapped,
453               jalview.util.ColorUtils.bleachColour(Color.DARK_GRAY,
454                       (float) scale * gapped));
455     }
456   }
457
458   /**
459    * Returns a tooltip showing either
460    * <ul>
461    * <li>the full profile (percentages of all residues present), if
462    * showSequenceLogo is true, or</li>
463    * <li>just the modal (most common) residue(s), if showSequenceLogo is
464    * false</li>
465    * </ul>
466    * Percentages are as a fraction of all sequence, or only ungapped sequences
467    * if ignoreGaps is true.
468    * 
469    * @param profile
470    * @param pid
471    * @param showSequenceLogo
472    * @param ignoreGaps
473    * @param dp
474    *          the number of decimal places to format percentages to
475    * @return
476    */
477   static String getTooltip(ProfileI profile, float pid,
478           boolean showSequenceLogo, boolean ignoreGaps, int dp)
479   {
480     ResidueCount counts = profile.getCounts();
481
482     String description = null;
483     if (counts != null && showSequenceLogo)
484     {
485       int normaliseBy = ignoreGaps ? profile.getNonGapped()
486               : profile.getHeight();
487       description = counts.getTooltip(normaliseBy, dp);
488     }
489     else
490     {
491       StringBuilder sb = new StringBuilder(64);
492       String maxRes = profile.getModalResidue();
493       if (maxRes.length() > 1)
494       {
495         sb.append("[").append(maxRes).append("]");
496       }
497       else
498       {
499         sb.append(maxRes);
500       }
501       if (maxRes.length() > 0)
502       {
503         sb.append(" ");
504         Format.appendPercentage(sb, pid, dp);
505         sb.append("%");
506       }
507       description = sb.toString();
508     }
509     return description;
510   }
511
512   /**
513    * Returns the sorted profile for the given consensus data. The returned array
514    * contains
515    * 
516    * <pre>
517    *    [profileType, numberOfValues, nonGapCount, charValue1, percentage1, charValue2, percentage2, ...]
518    * in descending order of percentage value
519    * </pre>
520    * 
521    * @param profile
522    *          the data object from which to extract and sort values
523    * @param ignoreGaps
524    *          if true, only non-gapped values are included in percentage
525    *          calculations
526    * @return
527    */
528   public static int[] extractProfile(ProfileI profile, boolean ignoreGaps)
529   {
530     int[] rtnval = new int[64];
531     ResidueCount counts = profile.getCounts();
532     if (counts == null)
533     {
534       return null;
535     }
536
537     SymbolCounts symbolCounts = counts.getSymbolCounts();
538     char[] symbols = symbolCounts.symbols;
539     int[] values = symbolCounts.values;
540     QuickSort.sort(values, symbols);
541     int nextArrayPos = 2;
542     int totalPercentage = 0;
543     final int divisor = ignoreGaps ? profile.getNonGapped()
544             : profile.getHeight();
545
546     /*
547      * traverse the arrays in reverse order (highest counts first)
548      */
549     for (int i = symbols.length - 1; i >= 0; i--)
550     {
551       int theChar = symbols[i];
552       int charCount = values[i];
553
554       rtnval[nextArrayPos++] = theChar;
555       final int percentage = (charCount * 100) / divisor;
556       rtnval[nextArrayPos++] = percentage;
557       totalPercentage += percentage;
558     }
559     rtnval[0] = symbols.length;
560     rtnval[1] = totalPercentage;
561     int[] result = new int[rtnval.length + 1];
562     result[0] = AlignmentAnnotation.SEQUENCE_PROFILE;
563     System.arraycopy(rtnval, 0, result, 1, rtnval.length);
564
565     return result;
566   }
567
568
569   /**
570    * Extract a sorted extract of cDNA codon profile data. The returned array
571    * contains
572    * 
573    * <pre>
574    *    [profileType, numberOfValues, totalCount, charValue1, percentage1, charValue2, percentage2, ...]
575    * in descending order of percentage value, where the character values encode codon triplets
576    * </pre>
577    * 
578    * @param hashtable
579    * @return
580    */
581   public static int[] extractCdnaProfile(Hashtable hashtable,
582           boolean ignoreGaps)
583   {
584     // this holds #seqs, #ungapped, and then codon count, indexed by encoded
585     // codon triplet
586     int[] codonCounts = (int[]) hashtable.get(PROFILE);
587     int[] sortedCounts = new int[codonCounts.length - 2];
588     System.arraycopy(codonCounts, 2, sortedCounts, 0,
589             codonCounts.length - 2);
590
591     int[] result = new int[3 + 2 * sortedCounts.length];
592     // first value is just the type of profile data
593     result[0] = AlignmentAnnotation.CDNA_PROFILE;
594
595     char[] codons = new char[sortedCounts.length];
596     for (int i = 0; i < codons.length; i++)
597     {
598       codons[i] = (char) i;
599     }
600     QuickSort.sort(sortedCounts, codons);
601     int totalPercentage = 0;
602     int distinctValuesCount = 0;
603     int j = 3;
604     int divisor = ignoreGaps ? codonCounts[1] : codonCounts[0];
605     for (int i = codons.length - 1; i >= 0; i--)
606     {
607       final int codonCount = sortedCounts[i];
608       if (codonCount == 0)
609       {
610         break; // nothing else of interest here
611       }
612       distinctValuesCount++;
613       result[j++] = codons[i];
614       final int percentage = codonCount * 100 / divisor;
615       result[j++] = percentage;
616       totalPercentage += percentage;
617     }
618     result[2] = totalPercentage;
619
620     /*
621      * Just return the non-zero values
622      */
623     // todo next value is redundant if we limit the array to non-zero counts
624     result[1] = distinctValuesCount;
625     return Arrays.copyOfRange(result, 0, j);
626   }
627
628   /**
629    * Compute a consensus for the cDNA coding for a protein alignment.
630    * 
631    * @param alignment
632    *          the protein alignment (which should hold mappings to cDNA
633    *          sequences)
634    * @param hconsensus
635    *          the consensus data stores to be populated (one per column)
636    */
637   public static void calculateCdna(AlignmentI alignment,
638           Hashtable[] hconsensus)
639   {
640     final char gapCharacter = alignment.getGapCharacter();
641     List<AlignedCodonFrame> mappings = alignment.getCodonFrames();
642     if (mappings == null || mappings.isEmpty())
643     {
644       return;
645     }
646
647     int cols = alignment.getWidth();
648     for (int col = 0; col < cols; col++)
649     {
650       // todo would prefer a Java bean for consensus data
651       Hashtable<String, int[]> columnHash = new Hashtable<>();
652       // #seqs, #ungapped seqs, counts indexed by (codon encoded + 1)
653       int[] codonCounts = new int[66];
654       codonCounts[0] = alignment.getSequences().size();
655       int ungappedCount = 0;
656       for (SequenceI seq : alignment.getSequences())
657       {
658         if (seq.getCharAt(col) == gapCharacter)
659         {
660           continue;
661         }
662         List<char[]> codons = MappingUtils.findCodonsFor(seq, col,
663                 mappings);
664         for (char[] codon : codons)
665         {
666           int codonEncoded = CodingUtils.encodeCodon(codon);
667           if (codonEncoded >= 0)
668           {
669             codonCounts[codonEncoded + 2]++;
670             ungappedCount++;
671           }
672         }
673       }
674       codonCounts[1] = ungappedCount;
675       // todo: sort values here, save counts and codons?
676       columnHash.put(PROFILE, codonCounts);
677       hconsensus[col] = columnHash;
678     }
679   }
680
681   /**
682    * Derive displayable cDNA consensus annotation from computed consensus data.
683    * 
684    * @param consensusAnnotation
685    *          the annotation row to be populated for display
686    * @param consensusData
687    *          the computed consensus data
688    * @param showProfileLogo
689    *          if true show all symbols present at each position, else only the
690    *          modal value
691    * @param nseqs
692    *          the number of sequences in the alignment
693    */
694   public static void completeCdnaConsensus(
695           AlignmentAnnotation consensusAnnotation,
696           Hashtable[] consensusData, boolean showProfileLogo, int nseqs)
697   {
698     if (consensusAnnotation == null
699             || consensusAnnotation.annotations == null
700             || consensusAnnotation.annotations.length < consensusData.length)
701     {
702       // called with a bad alignment annotation row - wait for it to be
703       // initialised properly
704       return;
705     }
706
707     // ensure codon triplet scales with font size
708     consensusAnnotation.scaleColLabel = true;
709     for (int col = 0; col < consensusData.length; col++)
710     {
711       Hashtable hci = consensusData[col];
712       if (hci == null)
713       {
714         // gapped protein column?
715         continue;
716       }
717       // array holds #seqs, #ungapped, then codon counts indexed by codon
718       final int[] codonCounts = (int[]) hci.get(PROFILE);
719       int totalCount = 0;
720
721       /*
722        * First pass - get total count and find the highest
723        */
724       final char[] codons = new char[codonCounts.length - 2];
725       for (int j = 2; j < codonCounts.length; j++)
726       {
727         final int codonCount = codonCounts[j];
728         codons[j - 2] = (char) (j - 2);
729         totalCount += codonCount;
730       }
731
732       /*
733        * Sort array of encoded codons by count ascending - so the modal value
734        * goes to the end; start by copying the count (dropping the first value)
735        */
736       int[] sortedCodonCounts = new int[codonCounts.length - 2];
737       System.arraycopy(codonCounts, 2, sortedCodonCounts, 0,
738               codonCounts.length - 2);
739       QuickSort.sort(sortedCodonCounts, codons);
740
741       int modalCodonEncoded = codons[codons.length - 1];
742       int modalCodonCount = sortedCodonCounts[codons.length - 1];
743       String modalCodon = String
744               .valueOf(CodingUtils.decodeCodon(modalCodonEncoded));
745       if (sortedCodonCounts.length > 1 && sortedCodonCounts[codons.length
746               - 2] == sortedCodonCounts[codons.length - 1])
747       {
748         /*
749          * two or more codons share the modal count
750          */
751         modalCodon = "+";
752       }
753       float pid = sortedCodonCounts[sortedCodonCounts.length - 1] * 100
754               / (float) totalCount;
755
756       /*
757        * todo ? Replace consensus hashtable with sorted arrays of codons and
758        * counts (non-zero only). Include total count in count array [0].
759        */
760
761       /*
762        * Scan sorted array backwards for most frequent values first. Show
763        * repeated values compactly.
764        */
765       StringBuilder mouseOver = new StringBuilder(32);
766       StringBuilder samePercent = new StringBuilder();
767       String percent = null;
768       String lastPercent = null;
769       int percentDecPl = getPercentageDp(nseqs);
770
771       for (int j = codons.length - 1; j >= 0; j--)
772       {
773         int codonCount = sortedCodonCounts[j];
774         if (codonCount == 0)
775         {
776           /*
777            * remaining codons are 0% - ignore, but finish off the last one if
778            * necessary
779            */
780           if (samePercent.length() > 0)
781           {
782             mouseOver.append(samePercent).append(": ").append(percent)
783                     .append("% ");
784           }
785           break;
786         }
787         int codonEncoded = codons[j];
788         final int pct = codonCount * 100 / totalCount;
789         String codon = String
790                 .valueOf(CodingUtils.decodeCodon(codonEncoded));
791         StringBuilder sb = new StringBuilder();
792         Format.appendPercentage(sb, pct, percentDecPl);
793         percent = sb.toString();
794         if (showProfileLogo || codonCount == modalCodonCount)
795         {
796           if (percent.equals(lastPercent) && j > 0)
797           {
798             samePercent.append(samePercent.length() == 0 ? "" : ", ");
799             samePercent.append(codon);
800           }
801           else
802           {
803             if (samePercent.length() > 0)
804             {
805               mouseOver.append(samePercent).append(": ").append(lastPercent)
806                       .append("% ");
807             }
808             samePercent.setLength(0);
809             samePercent.append(codon);
810           }
811           lastPercent = percent;
812         }
813       }
814
815       consensusAnnotation.annotations[col] = new Annotation(modalCodon,
816               mouseOver.toString(), ' ', pid);
817     }
818   }
819
820   /**
821    * Returns the number of decimal places to show for profile percentages. For
822    * less than 100 sequences, returns zero (the integer percentage value will be
823    * displayed). For 100-999 sequences, returns 1, for 1000-9999 returns 2, etc.
824    * 
825    * @param nseq
826    * @return
827    */
828   protected static int getPercentageDp(long nseq)
829   {
830     int scale = 0;
831     while (nseq >= 100)
832     {
833       scale++;
834       nseq /= 10;
835     }
836     return scale;
837   }
838
839   /**
840    * Returns the sorted HMM profile for the given column of the alignment. The
841    * returned array contains
842    * 
843    * <pre>
844    *    [profileType=0, numberOfValues, 100, charValue1, percentage1, charValue2, percentage2, ...]
845    * in descending order of percentage value
846    * </pre>
847    * 
848    * @param hmm
849    * @param column
850    * @param removeBelowBackground
851    *          if true, ignores residues with probability less than their
852    *          background frequency
853    * @param infoHeight
854    *          if true, uses the log ratio 'information' measure to scale the
855    *          value
856    * @return
857    */
858   public static int[] extractHMMProfile(HiddenMarkovModel hmm, int column,
859           boolean removeBelowBackground, boolean infoHeight)
860   {
861     if (hmm == null)
862     {
863       return null;
864     }
865     String alphabet = hmm.getSymbols();
866     int size = alphabet.length();
867     char symbols[] = new char[size];
868     int values[] = new int[size];
869     int totalCount = 0;
870
871     for (int i = 0; i < size; i++)
872     {
873       char symbol = alphabet.charAt(i);
874       symbols[i] = symbol;
875       int value = getAnalogueCount(hmm, column, symbol,
876               removeBelowBackground, infoHeight);
877       values[i] = value;
878       totalCount += value;
879     }
880
881     /*
882      * sort symbols by increasing emission probability
883      */
884     QuickSort.sort(values, symbols);
885
886     int[] profile = new int[3 + size * 2];
887
888     profile[0] = AlignmentAnnotation.SEQUENCE_PROFILE;
889     profile[1] = size;
890     profile[2] = 100;
891
892     /*
893      * order symbol/count profile by decreasing emission probability
894      */
895     if (totalCount != 0)
896     {
897       int arrayPos = 3;
898       for (int k = size - 1; k >= 0; k--)
899       {
900         Float percentage;
901         int value = values[k];
902         if (removeBelowBackground)
903         {
904           percentage = ((float) value) / totalCount * 100f;
905         }
906         else
907         {
908           percentage = value / 100f;
909         }
910         int intPercent = Math.round(percentage);
911         profile[arrayPos] = symbols[k];
912         profile[arrayPos + 1] = intPercent;
913         arrayPos += 2;
914       }
915     }
916     return profile;
917   }
918
919   /**
920    * Converts the emission probability of a residue at a column in the alignment
921    * to a 'count', suitable for rendering as an annotation value
922    * 
923    * @param hmm
924    * @param column
925    * @param symbol
926    * @param removeBelowBackground
927    *          if true, returns 0 for any symbol with a match emission
928    *          probability less than the background frequency
929    * @infoHeight if true, uses the log ratio 'information content' to scale the
930    *             value
931    * @return
932    */
933   static int getAnalogueCount(HiddenMarkovModel hmm, int column,
934           char symbol, boolean removeBelowBackground, boolean infoHeight)
935   {
936     double value = hmm.getMatchEmissionProbability(column, symbol);
937     double freq = ResidueProperties.backgroundFrequencies
938             .get(hmm.getAlphabetType()).get(symbol);
939     if (value < freq && removeBelowBackground)
940     {
941       return 0;
942     }
943
944     if (infoHeight)
945     {
946       value = value * (Math.log(value / freq) / LOG2);
947     }
948
949     value = value * 10000d;
950     return Math.round((float) value);
951   }
952 }