JAL-967, JAL-1114, JAL-1115 - modified render and calculation api to work on bare...
[jalview.git] / src / jalview / analysis / AAFrequency.java
index 6c21c74..7e77b0f 100755 (executable)
@@ -1,20 +1,19 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
- * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
- * 
- * This program is free software; you can redistribute it and/or
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  */
 package jalview.analysis;
 
@@ -27,7 +26,7 @@ import jalview.datamodel.*;
  * returns a new Hashtable[] of size maxSeqLength, if Hashtable not supplied.
  * This class is used extensively in calculating alignment colourschemes that
  * depend on the amount of conservation in each alignment column.
- * 
+ *
  * @author $author$
  * @version $Revision$
  */
@@ -43,14 +42,23 @@ public class AAFrequency
 
   public static final String PID_NOGAPS = "N";
 
-  public static final Hashtable[] calculate(Vector sequences, int start,
+  public static final String PROFILE = "P";
+
+  public static final Hashtable[] calculate(List<SequenceI> list, int start,
           int end)
   {
+    return calculate(list, start, end, false);
+  }
+
+  public static final Hashtable[] calculate(List<SequenceI> sequences, int start,
+          int end, boolean profile)
+  {
     SequenceI[] seqs = new SequenceI[sequences.size()];
     int width = 0;
+    synchronized (sequences) {
     for (int i = 0; i < sequences.size(); i++)
     {
-      seqs[i] = (SequenceI) sequences.elementAt(i);
+      seqs[i] = sequences.get(i);
       if (seqs[i].getLength() > width)
       {
         width = seqs[i].getLength();
@@ -64,14 +72,20 @@ public class AAFrequency
       end = width;
     }
 
-    calculate(seqs, start, end, reply);
-
+    calculate(seqs, start, end, reply, profile);
     return reply;
   }
+  }
 
   public static final void calculate(SequenceI[] sequences, int start,
           int end, Hashtable[] result)
   {
+    calculate(sequences, start, end, result, false);
+  }
+
+  public static final void calculate(SequenceI[] sequences, int start,
+          int end, Hashtable[] result, boolean profile)
+  {
     Hashtable residueHash;
     int maxCount, nongap, i, j, v, jSize = sequences.length;
     String maxResidue;
@@ -92,6 +106,11 @@ public class AAFrequency
 
       for (j = 0; j < jSize; j++)
       {
+        if (sequences[j]==null)
+        {
+          System.err.println("WARNING: Consensus skipping null sequence - possible race condition.");
+          continue;
+        }
         seq = sequences[j].getSequence();
         if (seq.length > i)
         {
@@ -144,59 +163,184 @@ public class AAFrequency
       {
         maxResidue = "-";
       }
-
+      if (profile)
+      {
+        residueHash.put(PROFILE, new int[][]
+        { values, new int[]
+        { jSize, nongap } });
+      }
       residueHash.put(MAXCOUNT, new Integer(maxCount));
       residueHash.put(MAXRESIDUE, maxResidue);
 
-      percentage = ((float) maxCount * 100) / (float) jSize;
+      percentage = ((float) maxCount * 100) / jSize;
       residueHash.put(PID_GAPS, new Float(percentage));
 
-      percentage = ((float) maxCount * 100) / (float) nongap;
+      percentage = ((float) maxCount * 100) / nongap;
       residueHash.put(PID_NOGAPS, new Float(percentage));
       result[i] = residueHash;
     }
   }
 
   /**
-   * Compute all or part of the annotation row from the given consensus hashtable
-   * @param consensus - pre-allocated annotation row 
+   * Compute all or part of the annotation row from the given consensus
+   * hashtable
+   *
+   * @param consensus
+   *          - pre-allocated annotation row
    * @param hconsensus
    * @param iStart
    * @param width
    * @param ignoreGapsInConsensusCalculation
+   * @param includeAllConsSymbols
    */
   public static void completeConsensus(AlignmentAnnotation consensus,
           Hashtable[] hconsensus, int iStart, int width,
-          boolean ignoreGapsInConsensusCalculation)
+          boolean ignoreGapsInConsensusCalculation,
+          boolean includeAllConsSymbols)
+  {
+    completeConsensus(consensus, hconsensus, iStart, width,
+            ignoreGapsInConsensusCalculation, includeAllConsSymbols, null); // new
+                                                                            // char[]
+    // { 'A', 'C', 'G', 'T', 'U' });
+  }
+
+  public static void completeConsensus(AlignmentAnnotation consensus,
+          Hashtable[] hconsensus, int iStart, int width,
+          boolean ignoreGapsInConsensusCalculation,
+          boolean includeAllConsSymbols, char[] alphabet)
   {
+    float tval, value;
+    if (consensus == null || consensus.annotations == null
+            || consensus.annotations.length < width)
+    {
+      // called with a bad alignment annotation row - wait for it to be
+      // initialised properly
+      return;
+    }
     for (int i = iStart; i < width; i++)
     {
-      float value = 0;
+      Hashtable hci;
+      if (i >= hconsensus.length || ((hci=hconsensus[i])==null))
+      {
+        // happens if sequences calculated over were shorter than alignment
+        // width
+        consensus.annotations[i] = null;
+        continue;
+      }
+
+      value = 0;
+      Float fv;
       if (ignoreGapsInConsensusCalculation)
       {
-        value = ((Float) hconsensus[i].get(AAFrequency.PID_NOGAPS))
-                .floatValue();
+        fv = (Float) hci.get(AAFrequency.PID_NOGAPS);
       }
       else
       {
-        value = ((Float) hconsensus[i].get(AAFrequency.PID_GAPS))
-                .floatValue();
+        fv = (Float) hci.get(AAFrequency.PID_GAPS);
       }
-
-      String maxRes = hconsensus[i].get(AAFrequency.MAXRESIDUE)
-              .toString();
-      String mouseOver = hconsensus[i].get(AAFrequency.MAXRESIDUE)
-              + " ";
-
+      if (fv==null)
+      {
+        consensus.annotations[i] = null;
+        // data has changed below us .. give up and
+        continue;
+      }
+      value = fv.floatValue();
+      String maxRes = hci.get(AAFrequency.MAXRESIDUE).toString();
+      String mouseOver = hci.get(AAFrequency.MAXRESIDUE) + " ";
       if (maxRes.length() > 1)
       {
         mouseOver = "[" + maxRes + "] ";
         maxRes = "+";
       }
+      int[][] profile = (int[][]) hci.get(AAFrequency.PROFILE);
+      if (profile != null && includeAllConsSymbols)
+      {
+        mouseOver = "";
+        if (alphabet != null)
+        {
+          for (int c = 0; c < alphabet.length; c++)
+          {
+            tval = profile[0][alphabet[c]]
+                    * 100f
+                    / profile[1][ignoreGapsInConsensusCalculation ? 1
+                            : 0];
+            mouseOver += ((c == 0) ? "" : "; ") + alphabet[c] + " "
+                    + ((int) tval) + "%";
+          }
+        }
+        else
+        {
+          Object[] ca = new Object[profile[0].length];
+          float[] vl = new float[profile[0].length];
+          for (int c = 0; c < ca.length; c++)
+          {
+            ca[c] = new char[]
+            { (char) c };
+            vl[c] = profile[0][c];
+          }
+          ;
+          jalview.util.QuickSort.sort(vl, ca);
+          for (int p = 0, c = ca.length - 1; profile[0][((char[]) ca[c])[0]] > 0; c--)
+          {
+            if (((char[]) ca[c])[0] != '-')
+            {
+              tval = profile[0][((char[]) ca[c])[0]]
+                      * 100f
+                      / profile[1][ignoreGapsInConsensusCalculation ? 1
+                              : 0];
+              mouseOver += ((p == 0) ? "" : "; ") + ((char[]) ca[c])[0]
+                      + " " + ((int) tval) + "%";
+              p++;
+
+            }
+          }
 
-      mouseOver += ((int) value + "%");
+        }
+      }
+      else
+      {
+        mouseOver += ((int) value + "%");
+      }
       consensus.annotations[i] = new Annotation(maxRes, mouseOver, ' ',
               value);
     }
   }
+
+  /**
+   * get the sorted profile for the given position of the consensus
+   *
+   * @param hconsensus
+   * @return
+   */
+  public static int[] extractProfile(Hashtable hconsensus,
+          boolean ignoreGapsInConsensusCalculation)
+  {
+    int[] rtnval = new int[64];
+    int[][] profile = (int[][]) hconsensus.get(AAFrequency.PROFILE);
+    if (profile == null)
+      return null;
+    Object[] ca = new Object[profile[0].length];
+    float[] vl = new float[profile[0].length];
+    for (int c = 0; c < ca.length; c++)
+    {
+      ca[c] = new char[]
+      { (char) c };
+      vl[c] = profile[0][c];
+    }
+    ;
+    jalview.util.QuickSort.sort(vl, ca);
+    rtnval[0] = 2;
+    rtnval[1]=0;
+    for (int c = ca.length - 1; profile[0][((char[]) ca[c])[0]] > 0; c--)
+    {
+      if (((char[]) ca[c])[0] != '-')
+      {
+        rtnval[rtnval[0]++] = ((char[]) ca[c])[0];
+        rtnval[rtnval[0]] = (int) (profile[0][((char[]) ca[c])[0]] * 100f / profile[1][ignoreGapsInConsensusCalculation ? 1
+                : 0]);
+        rtnval[1]+=rtnval[rtnval[0]++];
+      }
+    }
+    return rtnval;
+  }
 }