JAL-2416 scoreMatrices removed from ResidueProperties
[jalview.git] / src / jalview / analysis / AlignSeq.java
index b9119ed..f623a96 100755 (executable)
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.analysis;
-import java.util.*;
 
-import java.awt.*;
-
-import jalview.datamodel.*;
-import jalview.schemes.*;
-import jalview.util.*;
+import jalview.analysis.scoremodels.ScoreMatrix;
+import jalview.analysis.scoremodels.ScoreModels;
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.Mapping;
+import jalview.datamodel.Sequence;
+import jalview.datamodel.SequenceI;
+import jalview.schemes.ResidueProperties;
+import jalview.util.Comparison;
+import jalview.util.Format;
+import jalview.util.MapList;
+import jalview.util.MessageManager;
+
+import java.awt.Color;
+import java.awt.Graphics;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.StringTokenizer;
 
 /**
  * 
@@ -39,19 +52,19 @@ public class AlignSeq
 
   public static final String DNA = "dna";
 
-  static String[] dna =
-  { "A", "C", "G", "T", "-" };
+  private static final String NEWLINE = System.lineSeparator();
+
+  static String[] dna = { "A", "C", "G", "T", "-" };
 
   // "C", "T", "A", "G", "-"};
-  static String[] pep =
-  { "A", "R", "N", "D", "C", "Q", "E", "G", "H", "I", "L", "K", "M", "F",
-      "P", "S", "T", "W", "Y", "V", "B", "Z", "X", "-" };
+  static String[] pep = { "A", "R", "N", "D", "C", "Q", "E", "G", "H", "I",
+      "L", "K", "M", "F", "P", "S", "T", "W", "Y", "V", "B", "Z", "X", "-" };
 
-  int[][] score;
+  float[][] score;
 
-  int[][] E;
+  float[][] E;
 
-  int[][] F;
+  float[][] F;
 
   int[][] traceback;
 
@@ -94,7 +107,7 @@ public class AlignSeq
   int count;
 
   /** DOCUMENT ME!! */
-  public int maxscore;
+  public float maxscore;
 
   float pid;
 
@@ -104,7 +117,7 @@ public class AlignSeq
 
   int gapExtend = 20;
 
-  int[][] lookup = ResidueProperties.getBLOSUM62();
+  float[][] lookup = ResidueProperties.getBLOSUM62();
 
   String[] intToStr = pep;
 
@@ -153,7 +166,7 @@ public class AlignSeq
    * 
    * @return DOCUMENT ME!
    */
-  public int getMaxScore()
+  public float getMaxScore()
   {
     return maxscore;
   }
@@ -269,11 +282,44 @@ public class AlignSeq
   }
 
   /**
+   * 
+   * @return aligned instance of Seq 1
+   */
+  public SequenceI getAlignedSeq1()
+  {
+    SequenceI alSeq1 = new Sequence(s1.getName(), getAStr1());
+    alSeq1.setStart(s1.getStart() + getSeq1Start() - 1);
+    alSeq1.setEnd(s1.getStart() + getSeq1End() - 1);
+    alSeq1.setDatasetSequence(s1.getDatasetSequence() == null ? s1 : s1
+            .getDatasetSequence());
+    return alSeq1;
+  }
+
+  /**
+   * 
+   * @return aligned instance of Seq 2
+   */
+  public SequenceI getAlignedSeq2()
+  {
+    SequenceI alSeq2 = new Sequence(s2.getName(), getAStr2());
+    alSeq2.setStart(s2.getStart() + getSeq2Start() - 1);
+    alSeq2.setEnd(s2.getStart() + getSeq2End() - 1);
+    alSeq2.setDatasetSequence(s2.getDatasetSequence() == null ? s2 : s2
+            .getDatasetSequence());
+    return alSeq2;
+  }
+
+  /**
    * Construct score matrix for sequences with standard DNA or PEPTIDE matrix
-   * @param s1 - sequence 1
-   * @param string1 - string to use for s1
-   * @param s2 - sequence 2
-   * @param string2 - string to use for s2
+   * 
+   * @param s1
+   *          - sequence 1
+   * @param string1
+   *          - string to use for s1
+   * @param s2
+   *          - sequence 2
+   * @param string2
+   *          - string to use for s2
    * @param type
    *          DNA or PEPTIDE
    */
@@ -288,11 +334,17 @@ public class AlignSeq
 
   /**
    * Construct score matrix for sequences with custom substitution matrix
-   * @param s1 - sequence 1
-   * @param string1 - string to use for s1
-   * @param s2 - sequence 2
-   * @param string2 - string to use for s2
-   * @param scoreMatrix - substitution matrix to use for alignment
+   * 
+   * @param s1
+   *          - sequence 1
+   * @param string1
+   *          - string to use for s1
+   * @param s2
+   *          - sequence 2
+   * @param string2
+   *          - string to use for s2
+   * @param scoreMatrix
+   *          - substitution matrix to use for alignment
    */
   public void SeqInit(SequenceI s1, String string1, SequenceI s2,
           String string2, ScoreMatrix scoreMatrix)
@@ -307,7 +359,7 @@ public class AlignSeq
    * construct score matrix for string1 and string2 (after removing any existing
    * gaps
    * 
-   * @param string1 
+   * @param string1
    * @param string2
    */
   private void SeqInit(String string1, String string2)
@@ -330,13 +382,13 @@ public class AlignSeq
     seq2 = new int[s2str.length()];
 
     // System.out.println("seq2 " + rt.freeMemory() + " " + rt.totalMemory());
-    score = new int[s1str.length()][s2str.length()];
+    score = new float[s1str.length()][s2str.length()];
 
     // System.out.println("score " + rt.freeMemory() + " " + rt.totalMemory());
-    E = new int[s1str.length()][s2str.length()];
+    E = new float[s1str.length()][s2str.length()];
 
     // System.out.println("E " + rt.freeMemory() + " " + rt.totalMemory());
-    F = new int[s1str.length()][s2str.length()];
+    F = new float[s1str.length()][s2str.length()];
     traceback = new int[s1str.length()][s2str.length()];
 
     // System.out.println("F " + rt.freeMemory() + " " + rt.totalMemory());
@@ -372,11 +424,11 @@ public class AlignSeq
 
     if (type.equals(AlignSeq.PEP))
     {
-      lookup = ResidueProperties.getDefaultPeptideMatrix();
+      lookup = ScoreModels.getInstance().getDefaultModel(true).getMatrix();
     }
     else if (type.equals(AlignSeq.DNA))
     {
-      lookup = ResidueProperties.getDefaultDnaMatrix();
+      lookup = ScoreModels.getInstance().getDefaultModel(false).getMatrix();
     }
   }
 
@@ -398,8 +450,8 @@ public class AlignSeq
     else
     {
       output.append("Wrong type = dna or pep only");
-      throw new Error("Unknown Type " + type2
-              + " - dna or pep are the only allowed values.");
+      throw new Error(MessageManager.formatMessage(
+              "error.unknown_type_dna_or_pep", new String[] { type2 }));
     }
   }
 
@@ -409,7 +461,7 @@ public class AlignSeq
   public void traceAlignment()
   {
     // Find the maximum score along the rhs or bottom row
-    int max = -9999;
+    float max = -9999;
 
     for (int i = 0; i < seq1.length; i++)
     {
@@ -526,24 +578,32 @@ public class AlignSeq
       }
     }
     int len = 72 - maxid - 1;
-    int nochunks = ((aseq1.length - count) / len) + 1;
+    int nochunks = ((aseq1.length - count) / len)
+            + ((aseq1.length - count) % len > 0 ? 1 : 0);
     pid = 0;
 
-    output.append("Score = " + score[maxi][maxj] + "\n");
-    output.append("Length of alignment = " + (aseq1.length - count) + "\n");
+    output.append("Score = ").append(score[maxi][maxj]).append(NEWLINE);
+    output.append("Length of alignment = ")
+            .append(String.valueOf(aseq1.length - count)).append(NEWLINE);
     output.append("Sequence ");
     output.append(new Format("%" + maxid + "s").form(s1.getName()));
-    output.append(" :  " + s1.getStart() + " - " + s1.getEnd()
-            + " (Sequence length = " + s1str.length() + ")\n");
+    output.append(" :  ").append(String.valueOf(s1.getStart()))
+            .append(" - ").append(String.valueOf(s1.getEnd()));
+    output.append(" (Sequence length = ")
+            .append(String.valueOf(s1str.length())).append(")")
+            .append(NEWLINE);
     output.append("Sequence ");
     output.append(new Format("%" + maxid + "s").form(s2.getName()));
-    output.append(" :  " + s2.getStart() + " - " + s2.getEnd()
-            + " (Sequence length = " + s2str.length() + ")\n\n");
+    output.append(" :  ").append(String.valueOf(s2.getStart()))
+            .append(" - ").append(String.valueOf(s2.getEnd()));
+    output.append(" (Sequence length = ")
+            .append(String.valueOf(s2str.length())).append(")")
+            .append(NEWLINE).append(NEWLINE);
 
     for (int j = 0; j < nochunks; j++)
     {
       // Print the first aligned sequence
-      output.append(new Format("%" + (maxid) + "s").form(s1id) + " ");
+      output.append(new Format("%" + (maxid) + "s").form(s1id)).append(" ");
 
       for (int i = 0; i < len; i++)
       {
@@ -553,15 +613,18 @@ public class AlignSeq
         }
       }
 
-      output.append("\n");
-      output.append(new Format("%" + (maxid) + "s").form(" ") + " ");
+      output.append(NEWLINE);
+      output.append(new Format("%" + (maxid) + "s").form(" ")).append(" ");
 
       // Print out the matching chars
       for (int i = 0; i < len; i++)
       {
         if ((i + (j * len)) < astr1.length())
         {
-          if (astr1.charAt(i + (j * len)) == astr2.charAt(i + (j * len))
+          boolean sameChar = Comparison.isSameResidue(
+                  astr1.charAt(i + (j * len)), astr2.charAt(i + (j * len)),
+                  false);
+          if (sameChar
                   && !jalview.util.Comparison.isGap(astr1.charAt(i
                           + (j * len))))
           {
@@ -588,9 +651,9 @@ public class AlignSeq
       }
 
       // Now print the second aligned sequence
-      output = output.append("\n");
-      output = output.append(new Format("%" + (maxid) + "s").form(s2id)
-              + " ");
+      output = output.append(NEWLINE);
+      output = output.append(new Format("%" + (maxid) + "s").form(s2id))
+              .append(" ");
 
       for (int i = 0; i < len; i++)
       {
@@ -600,13 +663,11 @@ public class AlignSeq
         }
       }
 
-      output = output.append("\n\n");
+      output.append(NEWLINE).append(NEWLINE);
     }
 
-    pid = pid / (float) (aseq1.length - count) * 100;
-    output = output.append(new Format("Percentage ID = %2.2f\n\n")
-            .form(pid));
-
+    pid = pid / (aseq1.length - count) * 100;
+    output = output.append(new Format("Percentage ID = %2.2f\n").form(pid));
     try
     {
       os.print(output.toString());
@@ -668,7 +729,7 @@ public class AlignSeq
   public int findTrace(int i, int j)
   {
     int t = 0;
-    int max = score[i - 1][j - 1] + (lookup[seq1[i]][seq2[j]] * 10);
+    float max = score[i - 1][j - 1] + (lookup[seq1[i]][seq2[j]] * 10);
 
     if (F[i][j] > max)
     {
@@ -754,19 +815,23 @@ public class AlignSeq
   }
 
   /**
-   * DOCUMENT ME!
+   * Returns the given sequence with all of the given gap characters removed.
    * 
-   * @param gapChar
-   *          DOCUMENT ME!
+   * @param gapChars
+   *          a string of characters to be treated as gaps
    * @param seq
-   *          DOCUMENT ME!
+   *          the input sequence
    * 
-   * @return DOCUMENT ME!
+   * @return
    */
-  public static String extractGaps(String gapChar, String seq)
+  public static String extractGaps(String gapChars, String seq)
   {
-    StringTokenizer str = new StringTokenizer(seq, gapChar);
-    StringBuffer newString = new StringBuffer();
+    if (gapChars == null || seq == null)
+    {
+      return null;
+    }
+    StringTokenizer str = new StringTokenizer(seq, gapChars);
+    StringBuilder newString = new StringBuilder(seq.length());
 
     while (str.hasMoreTokens())
     {
@@ -779,27 +844,27 @@ public class AlignSeq
   /**
    * DOCUMENT ME!
    * 
-   * @param i1
+   * @param f1
    *          DOCUMENT ME!
-   * @param i2
+   * @param f2
    *          DOCUMENT ME!
-   * @param i3
+   * @param f3
    *          DOCUMENT ME!
    * 
    * @return DOCUMENT ME!
    */
-  public int max(int i1, int i2, int i3)
+  public float max(float f1, float f2, float f3)
   {
-    int max = i1;
+    float max = f1;
 
-    if (i2 > i1)
+    if (f2 > f1)
     {
-      max = i2;
+      max = f2;
     }
 
-    if (i3 > max)
+    if (f3 > max)
     {
-      max = i3;
+      max = f3;
     }
 
     return max;
@@ -808,20 +873,20 @@ public class AlignSeq
   /**
    * DOCUMENT ME!
    * 
-   * @param i1
+   * @param f1
    *          DOCUMENT ME!
-   * @param i2
+   * @param f2
    *          DOCUMENT ME!
    * 
    * @return DOCUMENT ME!
    */
-  public int max(int i1, int i2)
+  public float max(float f1, float f2)
   {
-    int max = i1;
+    float max = f1;
 
-    if (i2 > i1)
+    if (f2 > f1)
     {
-      max = i2;
+      max = f2;
     }
 
     return max;
@@ -886,6 +951,7 @@ public class AlignSeq
   public static void displayMatrix(Graphics g, int[][] mat, int n, int m,
           int psize)
   {
+    // TODO method dosen't seem to be referenced anywhere delete??
     int max = -1000;
     int min = 1000;
 
@@ -970,22 +1036,29 @@ public class AlignSeq
 
       if (allowmismatch || c1 == c2)
       {
-        lastmatch = true;
-        // extend mapping interval.
-        if (lp1 + 1 != alignpos || lp2+1 !=pdbpos)
+        // extend mapping interval
+        if (lp1 + 1 != alignpos || lp2 + 1 != pdbpos)
         {
           as1.add(Integer.valueOf(alignpos));
           as2.add(Integer.valueOf(pdbpos));
         }
+        lastmatch = true;
         lp1 = alignpos;
         lp2 = pdbpos;
       }
       else
       {
+        // extend mapping interval
+        if (lastmatch)
+        {
+          as1.add(Integer.valueOf(lp1));
+          as2.add(Integer.valueOf(lp2));
+        }
         lastmatch = false;
       }
     }
     // construct range pairs
+
     int[] mapseq1 = new int[as1.size() + (lastmatch ? 1 : 0)], mapseq2 = new int[as2
             .size() + (lastmatch ? 1 : 0)];
     int i = 0;
@@ -1013,6 +1086,104 @@ public class AlignSeq
   }
 
   /**
+   * matches ochains against al and populates seqs with the best match between
+   * each ochain and the set in al
+   * 
+   * @param ochains
+   * @param al
+   * @param dnaOrProtein
+   * @param removeOldAnnots
+   *          when true, old annotation is cleared before new annotation
+   *          transferred
+   * @return List<List<SequenceI> originals, List<SequenceI> replacement,
+   *         List<AlignSeq> alignment between each>
+   */
+  public static List<List<? extends Object>> replaceMatchingSeqsWith(
+          List<SequenceI> seqs, List<AlignmentAnnotation> annotations,
+          List<SequenceI> ochains, AlignmentI al, String dnaOrProtein,
+          boolean removeOldAnnots)
+  {
+    List<SequenceI> orig = new ArrayList<SequenceI>(), repl = new ArrayList<SequenceI>();
+    List<AlignSeq> aligs = new ArrayList<AlignSeq>();
+    if (al != null && al.getHeight() > 0)
+    {
+      ArrayList<SequenceI> matches = new ArrayList<SequenceI>();
+      ArrayList<AlignSeq> aligns = new ArrayList<AlignSeq>();
+
+      for (SequenceI sq : ochains)
+      {
+        SequenceI bestm = null;
+        AlignSeq bestaseq = null;
+        float bestscore = 0;
+        for (SequenceI msq : al.getSequences())
+        {
+          AlignSeq aseq = doGlobalNWAlignment(msq, sq, dnaOrProtein);
+          if (bestm == null || aseq.getMaxScore() > bestscore)
+          {
+            bestscore = aseq.getMaxScore();
+            bestaseq = aseq;
+            bestm = msq;
+          }
+        }
+        System.out.println("Best Score for " + (matches.size() + 1) + " :"
+                + bestscore);
+        matches.add(bestm);
+        aligns.add(bestaseq);
+        al.deleteSequence(bestm);
+      }
+      for (int p = 0, pSize = seqs.size(); p < pSize; p++)
+      {
+        SequenceI sq, sp = seqs.get(p);
+        int q;
+        if ((q = ochains.indexOf(sp)) > -1)
+        {
+          seqs.set(p, sq = matches.get(q));
+          orig.add(sp);
+          repl.add(sq);
+          sq.setName(sp.getName());
+          sq.setDescription(sp.getDescription());
+          Mapping sp2sq;
+          sq.transferAnnotation(sp,
+                  sp2sq = aligns.get(q).getMappingFromS1(false));
+          aligs.add(aligns.get(q));
+          int inspos = -1;
+          for (int ap = 0; ap < annotations.size();)
+          {
+            if (annotations.get(ap).sequenceRef == sp)
+            {
+              if (inspos == -1)
+              {
+                inspos = ap;
+              }
+              if (removeOldAnnots)
+              {
+                annotations.remove(ap);
+              }
+              else
+              {
+                AlignmentAnnotation alan = annotations.remove(ap);
+                alan.liftOver(sq, sp2sq);
+                alan.setSequenceRef(sq);
+                sq.addAlignmentAnnotation(alan);
+              }
+            }
+            else
+            {
+              ap++;
+            }
+          }
+          if (sq.getAnnotation() != null && sq.getAnnotation().length > 0)
+          {
+            annotations.addAll(inspos == -1 ? annotations.size() : inspos,
+                    Arrays.asList(sq.getAnnotation()));
+          }
+        }
+      }
+    }
+    return Arrays.asList(orig, repl, aligs);
+  }
+
+  /**
    * compute the PID vector used by the redundancy filter.
    * 
    * @param originalSequences