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