JAL-4134 column grouping model and methods moved to their own object held by by Conta...
[jalview.git] / src / jalview / ws / datamodel / alphafold / PAEContactMatrix.java
index 30c77d2..0ba9584 100644 (file)
@@ -1,54 +1,55 @@
 package jalview.ws.datamodel.alphafold;
 
+import java.awt.Color;
+import java.io.BufferedInputStream;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
 import java.util.ArrayList;
 import java.util.BitSet;
+import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.Map.Entry;
+
+import org.json.simple.JSONObject;
 
 import jalview.analysis.AverageDistanceEngine;
 import jalview.bin.Console;
+import jalview.datamodel.Annotation;
 import jalview.datamodel.BinaryNode;
 import jalview.datamodel.ContactListI;
 import jalview.datamodel.ContactListImpl;
 import jalview.datamodel.ContactListProviderI;
 import jalview.datamodel.ContactMatrixI;
+import jalview.datamodel.GroupSet;
+import jalview.datamodel.GroupSetI;
+import jalview.datamodel.Mapping;
+import jalview.datamodel.SequenceDummy;
 import jalview.datamodel.SequenceI;
+import jalview.io.DataSourceType;
+import jalview.io.FileFormatException;
+import jalview.io.FileParse;
+import jalview.util.MapList;
 import jalview.util.MapUtils;
+import jalview.ws.dbsources.EBIAlfaFold;
 
-public class PAEContactMatrix implements ContactMatrixI
+public class PAEContactMatrix extends MappableContactMatrix<PAEContactMatrix> implements ContactMatrixI
 {
-
-  SequenceI refSeq = null;
-
-  /**
-   * the length that refSeq is expected to be (excluding gaps, of course)
-   */
-  int length;
-
   int maxrow = 0, maxcol = 0;
 
-  int[] indices1, indices2;
-
   float[][] elements;
 
   float maxscore;
 
-  private void setRefSeq(SequenceI _refSeq)
-  {
-    refSeq = _refSeq;
-    while (refSeq.getDatasetSequence() != null)
-    {
-      refSeq = refSeq.getDatasetSequence();
-    }
-    length = _refSeq.getEnd() - _refSeq.getStart() + 1;
-  }
+
   @SuppressWarnings("unchecked")
-  public PAEContactMatrix(SequenceI _refSeq, Map<String, Object> pae_obj)
+  public PAEContactMatrix(SequenceI _refSeq, Map<String, Object> pae_obj) throws FileFormatException
   {
     setRefSeq(_refSeq);
     // convert the lists to primitive arrays and store
-    
+
     if (!MapUtils.containsAKey(pae_obj, "predicted_aligned_error", "pae"))
     {
       parse_version_1_pAE(pae_obj);
@@ -59,32 +60,50 @@ public class PAEContactMatrix implements ContactMatrixI
       parse_version_2_pAE(pae_obj);
     }
   }
+
   /**
    * construct a sequence associated PAE matrix directly from a float array
+   * 
    * @param _refSeq
    * @param matrix
    */
   public PAEContactMatrix(SequenceI _refSeq, float[][] matrix)
   {
     setRefSeq(_refSeq);
-    maxcol=0;
-    for (float[] row:matrix)
+    maxcol = 0;
+    for (float[] row : matrix)
     {
-      if (row.length>maxcol)
+      if (row.length > maxcol)
       {
-        maxcol=row.length;
+        maxcol = row.length;
       }
-      maxscore=row[0];
-      for (float f:row)
+      maxscore = row[0];
+      for (float f : row)
       {
-        if (maxscore<f) {
-          maxscore=f;
+        if (maxscore < f)
+        {
+          maxscore = f;
         }
       }
     }
-    maxrow=matrix.length;
+    maxrow = matrix.length;
     elements = matrix;
-    
+
+  }
+
+  /**
+   * new matrix with specific mapping to a reference sequence
+   * @param newRefSeq
+   * @param newFromMapList
+   * @param elements2
+   * @param grps2 
+   */
+  public PAEContactMatrix(SequenceI newRefSeq,
+          MapList newFromMapList, float[][] elements2, GroupSet grps2)
+  {
+    this(newRefSeq,elements2);
+    toSeq = newFromMapList;
+    grps= grps2;
   }
 
   /**
@@ -95,24 +114,41 @@ public class PAEContactMatrix implements ContactMatrixI
   @SuppressWarnings("unchecked")
   private void parse_version_2_pAE(Map<String, Object> pae_obj)
   {
-    // this is never going to be reached by the integer rounding.. or is it ?
-    maxscore = ((Double) MapUtils.getFirst(pae_obj,
-            "max_predicted_aligned_error", "max_pae")).floatValue();
+    maxscore = -1;
+    // look for a maxscore element - if there is one...
+    try
+    {
+      // this is never going to be reached by the integer rounding.. or is it ?
+      maxscore = ((Double) MapUtils.getFirst(pae_obj,
+              "max_predicted_aligned_error", "max_pae")).floatValue();
+    } catch (Throwable t)
+    {
+      // ignore if a key is not found.
+    }
     List<List<Long>> scoreRows = ((List<List<Long>>) MapUtils
-            .getFirst(pae_obj, "predicted_aligned_error", "pae"))
-            ;
+            .getFirst(pae_obj, "predicted_aligned_error", "pae"));
     elements = new float[scoreRows.size()][scoreRows.size()];
     int row = 0, col = 0;
-    for (List<Long> scoreRow:scoreRows)
+    for (List<Long> scoreRow : scoreRows)
     {
       Iterator<Long> scores = scoreRow.iterator();
       while (scores.hasNext())
       {
         Object d = scores.next();
+
         if (d instanceof Double)
+        {
           elements[row][col++] = ((Double) d).longValue();
+        }
         else
-          elements[row][col++] = (float) ((Long)d).longValue();
+        {
+          elements[row][col++] = (float) ((Long) d).longValue();
+        }
+        
+        if (maxscore < elements[row][col - 1])
+        {
+          maxscore = elements[row][col - 1];
+        }
       }
       row++;
       col = 0;
@@ -134,10 +170,26 @@ public class PAEContactMatrix implements ContactMatrixI
     // dataset refSeq
     Iterator<Long> rows = ((List<Long>) pae_obj.get("residue1")).iterator();
     Iterator<Long> cols = ((List<Long>) pae_obj.get("residue2")).iterator();
+    // two pass - to allocate the elements array
+    while (rows.hasNext())
+    {
+      int row = rows.next().intValue();
+      int col = cols.next().intValue();
+      if (maxrow < row)
+      {
+        maxrow = row;
+      }
+      if (maxcol < col)
+      {
+        maxcol = col;
+      }
+
+    }
+    rows = ((List<Long>) pae_obj.get("residue1")).iterator();
+    cols = ((List<Long>) pae_obj.get("residue2")).iterator();
     Iterator<Double> scores = ((List<Double>) pae_obj.get("distance"))
             .iterator();
-    // assume square matrix
-    elements = new float[length][length];
+    elements = new float[maxrow][maxcol];
     while (scores.hasNext())
     {
       float escore = scores.next().floatValue();
@@ -159,9 +211,23 @@ public class PAEContactMatrix implements ContactMatrixI
   }
 
   @Override
-  public ContactListI getContactList(final int _column)
+  public ContactListI getContactList(final int column)
   {
-    if (_column < 0 || _column >= elements.length)
+//    final int _column;
+//    if (toSeq != null)
+//    {
+//      int[] word = toSeq.locateInTo(column, column);
+//      if (word == null)
+//      {
+//        return null;
+//      }
+//      _column = word[0];
+//    }
+//    else
+//    {
+//      _column = column;
+//    }
+    if (column < 0 || column >= elements.length)
     {
       return null;
     }
@@ -171,28 +237,33 @@ public class PAEContactMatrix implements ContactMatrixI
       @Override
       public int getPosition()
       {
-        return _column;
+        return column;
       }
 
       @Override
       public int getContactHeight()
       {
-        return maxcol-1;
+        return maxcol - 1;
       }
 
       @Override
-      public double getContactAt(int column)
+      public double getContactAt(int mcolumn)
       {
-        if (column < 0 || column >= elements[_column].length)
+        if (mcolumn < 0 || mcolumn >= elements[column].length)
         {
           return -1;
         }
-        return elements[_column][column];
+        return elements[column][mcolumn];
       }
     });
   }
 
   @Override
+  protected double getElementAt(int _column, int i)
+  {
+    return elements[_column][i];
+  }
+  @Override
   public float getMin()
   {
     return 0;
@@ -205,99 +276,74 @@ public class PAEContactMatrix implements ContactMatrixI
   }
 
   @Override
-  public boolean hasReferenceSeq()
-  {
-    return (refSeq != null);
-  }
-
-  @Override
-  public SequenceI getReferenceSeq()
-  {
-    return refSeq;
-  }
-
-  @Override
   public String getAnnotDescr()
   {
-    return "Predicted Alignment Error for " + refSeq.getName();
+    return "Predicted Alignment Error"+((refSeq==null) ? "" : (" for " + refSeq.getName()));
   }
 
   @Override
   public String getAnnotLabel()
   {
-    return "pAE Matrix";
+    StringBuilder label = new StringBuilder("PAE Matrix");
+    //if (this.getReferenceSeq() != null)
+    //{
+    //  label.append(":").append(this.getReferenceSeq().getDisplayId(false));
+    //}
+    return label.toString();
   }
 
-  public static final String PAEMATRIX="PAE_MATRIX";
+  public static final String PAEMATRIX = "PAE_MATRIX";
+
   @Override
   public String getType()
   {
     return PAEMATRIX;
   }
+
   @Override
   public int getWidth()
   {
     return length;
   }
+
   @Override
   public int getHeight()
   {
     return length;
   }
-  List<BitSet> groups=null;
-  @Override
-  public boolean hasGroups()
-  {
-    return groups!=null;
-  }
-  String newick=null;
-  public String getNewickString()
-  {
-    return newick;
-  }
-  public void makeGroups(float thresh,boolean abs)
+  
+  public static void validateContactMatrixFile(String fileName) throws FileFormatException,IOException
   {
-    AverageDistanceEngine clusterer = new AverageDistanceEngine(null, null, this);
-    double height = clusterer.findHeight(clusterer.getTopNode());
-    newick = new jalview.io.NewickFile(clusterer.getTopNode(),false,true).print();
-
-    Console.trace("Newick string\n"+newick);
-
-    List<BinaryNode> nodegroups;
-    if (abs ? height > thresh : 0 < thresh && thresh < 1)
+    FileInputStream infile=null;
+    try {
+      infile = new FileInputStream(new File(fileName));
+    } catch (Throwable t)
     {
-      float cut = abs ? (float) (thresh / height) : thresh;
-      Console.debug("Threshold "+cut+" for height="+height);
-
-      nodegroups = clusterer.groupNodes(cut);
+      new IOException("Couldn't open "+fileName,t);      
     }
-    else
+    
+    
+    JSONObject paeDict=null;
+    try {
+      paeDict = EBIAlfaFold.parseJSONtoPAEContactMatrix(infile);
+    } catch (Throwable t)
     {
-      nodegroups = new ArrayList<BinaryNode>();
-      nodegroups.add(clusterer.getTopNode());
+      new FileFormatException("Couldn't parse "+fileName+" as a JSON dict or array containing a dict");
     }
-
-    groups = new ArrayList<>();
-    for (BinaryNode root:nodegroups)
+    
+    PAEContactMatrix matrix = new PAEContactMatrix(new SequenceDummy("Predicted"), (Map<String,Object>)paeDict);
+    if (matrix.getWidth()<=0)
     {
-      BitSet gpset=new BitSet();
-      for (BinaryNode leaf:clusterer.findLeaves(root))
-      {
-        gpset.set((Integer)leaf.element());
-      }
-      groups.add(gpset);
+      throw new FileFormatException("No data in PAE matrix read from '"+fileName+"'");
     }
   }
-  
+
   @Override
-  public BitSet getGroupsFor(int column)
+  protected PAEContactMatrix newMappableContactMatrix(
+          SequenceI newRefSeq, MapList newFromMapList)
   {
-    for (BitSet gp:groups) {
-      if (gp.get(column))
-      {
-        return gp;
-      }
-    }
-    return ContactMatrixI.super.getGroupsFor(column);
-  }
+    PAEContactMatrix pae=new PAEContactMatrix(newRefSeq, newFromMapList,
+              elements, new GroupSet(grps));
+    return pae;
+  } 
 }