JAL-580 ensure WUSS annotation string is up to date, pair list regenerated if necessa...
[jalview.git] / src / jalview / analysis / Conservation.java
index 04914fc..6957b5c 100755 (executable)
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * 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.
  * 
@@ -85,7 +85,7 @@ public class Conservation
    *          end residue position
    */
   public Conservation(String name, Hashtable propHash, int threshold,
-          Vector sequences, int start, int end)
+          List<SequenceI> sequences, int start, int end)
   {
     this.name = name;
     this.propHash = propHash;
@@ -102,7 +102,7 @@ public class Conservation
     try {
     for (s = 0; s < sSize; s++)
     {
-      sarray[s] = (SequenceI) sequences.elementAt(s);
+      sarray[s] = (SequenceI) sequences.get(s);
       if (sarray[s].getLength() > maxLength)
       {
         maxLength = sarray[s].getLength();
@@ -694,4 +694,42 @@ public class Conservation
       }
     }
   }
+
+  /**
+   * construct and call the calculation methods on a new Conservation object
+   * @param name - name of conservation
+   * @param consHash - hash table of properties for each amino acid (normally ResidueProperties.propHash)
+   * @param threshold - minimum number of conserved residues needed to indicate conservation (typically 3)
+   * @param seqs
+   * @param start first column in calculation window
+   * @param end last column in calculation window
+   * @param posOrNeg positive (true) or negative (false) conservation 
+   * @param consPercGaps percentage of gaps tolerated in column
+   * @param calcQuality flag indicating if alignment quality should be calculated  
+   * @return Conservation object ready for use in visualization
+   */
+  public static Conservation calculateConservation(String name,
+          Hashtable consHash, int threshold, List<SequenceI> seqs, int start, int end, boolean posOrNeg, int consPercGaps, boolean calcQuality)
+  {
+    Conservation cons = new Conservation(name, consHash, threshold, seqs, start,end);
+    return calculateConservation(cons, posOrNeg, consPercGaps, calcQuality);
+  }
+  /**
+  * @param b positive (true) or negative (false) conservation 
+  * @param consPercGaps percentage of gaps tolerated in column
+  * @param calcQuality flag indicating if alignment quality should be calculated  
+  * @return Conservation object ready for use in visualization
+  */
+ public static Conservation calculateConservation(Conservation cons, boolean b, int consPercGaps, boolean calcQuality)
+ {
+   cons.calculate();
+    cons.verdict(b, consPercGaps); 
+
+    if (calcQuality)
+    {
+      cons.findQuality();
+    }
+
+    return cons;
+  }
 }