merge from 2_4_Release branch
[jalview.git] / src / jalview / analysis / AAFrequency.java
index 4a68f81..36534a3 100755 (executable)
-/*\r
-* Jalview - A Sequence Alignment Editor and Viewer\r
-* Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
-*\r
-* This program is free software; you can redistribute it and/or\r
-* modify it under the terms of the GNU General Public License\r
-* as published by the Free Software Foundation; either version 2\r
-* of the License, or (at your option) any later version.\r
-*\r
-* This program is distributed in the hope that it will be useful,\r
-* but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-* GNU General Public License for more details.\r
-*\r
-* You should have received a copy of the GNU General Public License\r
-* along with this program; if not, write to the Free Software\r
-* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
-*/\r
-package jalview.analysis;\r
-\r
-import jalview.datamodel.*;\r
-\r
-import java.util.*;\r
-\r
-\r
-/**\r
- * Takes in a vector or array of sequences and column start and column end\r
- * and returns a new Hashtable[] of size maxSeqLength, if Hashtable not supplied.\r
- * This class is used extensively in calculating alignment colourschemes\r
- * that depend on the amount of conservation in each alignment column.\r
- * @author $author$\r
- * @version $Revision$\r
- */\r
-public class AAFrequency\r
-{\r
-  //No need to store 1000s of strings which are not\r
-  //visible to the user.\r
-  public static final String MAXCOUNT = "C";\r
-  public static final String MAXRESIDUE="R";\r
-  public static final String PID_GAPS = "G";\r
-  public static final String PID_NOGAPS="N";\r
-\r
-   public static final Hashtable [] calculate(Vector sequences, int start, int end)\r
-   {\r
-     SequenceI [] seqs = new SequenceI[sequences.size()];\r
-     int width = 0;\r
-     for(int i=0; i<sequences.size(); i++)\r
-     {\r
-       seqs[i] = (SequenceI) sequences.elementAt(i);\r
-       if(seqs[i].getLength()>width)\r
-         width = seqs[i].getLength();\r
-     }\r
-\r
-     Hashtable [] reply = new Hashtable[width];\r
-\r
-     if(end>=width)\r
-     {\r
-       end = width;\r
-     }\r
-\r
-     calculate(seqs, start, end, reply);\r
-\r
-     return reply;\r
-   }\r
-\r
-public static final void calculate(SequenceI[] sequences,\r
-                                  int start, int end,\r
-                                  Hashtable [] result)\r
-{\r
-  Hashtable residueHash;\r
-  int maxCount, nongap, i, j, v, jSize = sequences.length;\r
-  String maxResidue;\r
-  char c;\r
-  float percentage;\r
-\r
-  int[] values = new int[255];\r
-\r
-  char [] seq;\r
-\r
-  for (i = start; i < end; i++)\r
-  {\r
-    residueHash = new Hashtable();\r
-    maxCount = 0;\r
-    maxResidue = "";\r
-    nongap = 0;\r
-    values = new int[255];\r
-\r
-    for (j = 0; j < jSize; j++)\r
-    {\r
-      seq = sequences[j].getSequence();\r
-      if (seq.length > i)\r
-      {\r
-        c = seq[i];\r
-\r
-        if(c == '.' || c==' ')\r
-          c = '-';\r
-\r
-        if(c=='-')\r
-        {\r
-          values['-']++;\r
-          continue;\r
-        }\r
-        else if ('a' <= c && c <= 'z')\r
-        {\r
-          c -= 32 ;//('a' - 'A');\r
-        }\r
-\r
-        nongap++;\r
-        values[c]++;\r
-\r
-      }\r
-      else\r
-      {\r
-        values['-']++;\r
-      }\r
-    }\r
-\r
-    for (v = 'A'; v < 'Z'; v++)\r
-    {\r
-      if (values[v] < 2 || values[v] < maxCount)\r
-        continue;\r
-\r
-      if (values[v] > maxCount)\r
-      {\r
-        maxResidue = String.valueOf( (char) v);\r
-      }\r
-      else if (values[v] == maxCount)\r
-      {\r
-        maxResidue += String.valueOf( (char) v);\r
-      }\r
-      maxCount = values[v];\r
-    }\r
-\r
-    if(maxResidue.length()==0)\r
-      maxResidue = "-";\r
-\r
-    residueHash.put(MAXCOUNT, new Integer(maxCount));\r
-    residueHash.put(MAXRESIDUE, maxResidue);\r
-\r
-    percentage = ( (float) maxCount * 100) / (float) jSize;\r
-    residueHash.put(PID_GAPS, new Float(percentage));\r
-\r
-    percentage = ( (float) maxCount * 100) / (float) nongap;\r
-    residueHash.put(PID_NOGAPS, new Float(percentage));\r
-    result[i] = residueHash;\r
-  }\r
-}\r
-}\r
-\r
-\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
+ * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * 
+ * This program 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
+ */
+package jalview.analysis;
+
+import java.util.*;
+
+import jalview.datamodel.*;
+
+/**
+ * Takes in a vector or array of sequences and column start and column end and
+ * 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$
+ */
+public class AAFrequency
+{
+  // No need to store 1000s of strings which are not
+  // visible to the user.
+  public static final String MAXCOUNT = "C";
+
+  public static final String MAXRESIDUE = "R";
+
+  public static final String PID_GAPS = "G";
+
+  public static final String PID_NOGAPS = "N";
+
+  public static final Hashtable[] calculate(Vector sequences, int start,
+          int end)
+  {
+    SequenceI[] seqs = new SequenceI[sequences.size()];
+    int width = 0;
+    for (int i = 0; i < sequences.size(); i++)
+    {
+      seqs[i] = (SequenceI) sequences.elementAt(i);
+      if (seqs[i].getLength() > width)
+      {
+        width = seqs[i].getLength();
+      }
+    }
+
+    Hashtable[] reply = new Hashtable[width];
+
+    if (end >= width)
+    {
+      end = width;
+    }
+
+    calculate(seqs, start, end, reply);
+
+    return reply;
+  }
+
+  public static final void calculate(SequenceI[] sequences, int start,
+          int end, Hashtable[] result)
+  {
+    Hashtable residueHash;
+    int maxCount, nongap, i, j, v, jSize = sequences.length;
+    String maxResidue;
+    char c;
+    float percentage;
+
+    int[] values = new int[255];
+
+    char[] seq;
+
+    for (i = start; i < end; i++)
+    {
+      residueHash = new Hashtable();
+      maxCount = 0;
+      maxResidue = "";
+      nongap = 0;
+      values = new int[255];
+
+      for (j = 0; j < jSize; j++)
+      {
+        seq = sequences[j].getSequence();
+        if (seq.length > i)
+        {
+          c = seq[i];
+
+          if (c == '.' || c == ' ')
+          {
+            c = '-';
+          }
+
+          if (c == '-')
+          {
+            values['-']++;
+            continue;
+          }
+          else if ('a' <= c && c <= 'z')
+          {
+            c -= 32; // ('a' - 'A');
+          }
+
+          nongap++;
+          values[c]++;
+
+        }
+        else
+        {
+          values['-']++;
+        }
+      }
+
+      for (v = 'A'; v < 'Z'; v++)
+      {
+        if (values[v] < 2 || values[v] < maxCount)
+        {
+          continue;
+        }
+
+        if (values[v] > maxCount)
+        {
+          maxResidue = String.valueOf((char) v);
+        }
+        else if (values[v] == maxCount)
+        {
+          maxResidue += String.valueOf((char) v);
+        }
+        maxCount = values[v];
+      }
+
+      if (maxResidue.length() == 0)
+      {
+        maxResidue = "-";
+      }
+
+      residueHash.put(MAXCOUNT, new Integer(maxCount));
+      residueHash.put(MAXRESIDUE, maxResidue);
+
+      percentage = ((float) maxCount * 100) / (float) jSize;
+      residueHash.put(PID_GAPS, new Float(percentage));
+
+      percentage = ((float) maxCount * 100) / (float) nongap;
+      residueHash.put(PID_NOGAPS, new Float(percentage));
+      result[i] = residueHash;
+    }
+  }
+}