Merge branch 'develop' into features/JAL-4134_use_annotation_row_for_colours_and_groups
[jalview.git] / src / jalview / renderer / ContactMapRenderer.java
index 7a435c3..a8f6c1b 100644 (file)
@@ -5,12 +5,14 @@ package jalview.renderer;
 
 import java.awt.Color;
 import java.awt.Graphics;
+import java.util.Iterator;
 
 import jalview.api.AlignViewportI;
 import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.Annotation;
 import jalview.datamodel.ColumnSelection;
 import jalview.datamodel.ContactListI;
+import jalview.datamodel.ContactMatrixI;
 import jalview.datamodel.ContactRange;
 import jalview.datamodel.HiddenColumns;
 import jalview.renderer.api.AnnotationRowRendererI;
@@ -19,8 +21,80 @@ import jalview.renderer.api.AnnotationRowRendererI;
  * @author jprocter
  *
  */
-public class ContactMapRenderer implements AnnotationRowRendererI
+public abstract class ContactMapRenderer implements AnnotationRowRendererI
 {
+  /**
+   * bean holding colours for shading
+   * 
+   * @author jprocter
+   *
+   */
+  public class Shading
+  {
+    /**
+     * shown when no data available from map
+     */
+    Color no_data;
+    /**
+     * shown for region not currently visible - should normally not see this
+     */
+    Color hidden;
+    /**
+     * linear shading scheme min/max
+     */
+    Color maxColor, minColor;
+
+    /**
+     * linear shading scheme min/max for selected region
+     */
+    Color selMinColor, selMaxColor;
+
+    public Shading(Color no_data, Color hidden, Color maxColor,
+            Color minColor, Color selMinColor, Color selMaxColor)
+    {
+      super();
+      this.no_data = no_data;
+      this.hidden = hidden;
+      this.maxColor = maxColor;
+      this.minColor = minColor;
+      this.selMinColor = selMinColor;
+      this.selMaxColor = selMaxColor;
+    }
+
+  }
+
+  final Shading shade;
+
+  /**
+   * build an EBI-AlphaFold style renderer of PAE matrices
+   * 
+   * @return
+   */
+  public static ContactMapRenderer newPAERenderer()
+  {
+    return new ContactMapRenderer()
+    {
+      @Override
+      public Shading getShade()
+      {
+        return new Shading(Color.pink, Color.red,
+
+                new Color(246, 252, 243), new Color(0, 60, 26),
+                new Color(26, 0, 60), new Color(243, 246, 252));
+      }
+    };
+  }
+
+  /**
+   * 
+   * @return instance of Shading used to initialise the renderer
+   */
+  public abstract Shading getShade();
+
+  public ContactMapRenderer()
+  {
+    this.shade = getShade();
+  }
 
   @Override
   public void renderRow(Graphics g, int charWidth, int charHeight,
@@ -37,12 +111,13 @@ public class ContactMapRenderer implements AnnotationRowRendererI
 
     int x = 0, y2 = y;
 
-    g.setColor(Color.pink);
+    g.setColor(shade.no_data);
 
     g.drawLine(x, y2, (eRes - sRes) * charWidth, y2);
 
     int column;
     int aaMax = aa_annotations.length - 1;
+    ContactMatrixI cm = viewport.getContactMatrix(_aa);
     while (x < eRes - sRes)
     {
       column = sRes + x;
@@ -67,17 +142,26 @@ public class ContactMapRenderer implements AnnotationRowRendererI
         x++;
         continue;
       }
-      if (_aa.sequenceRef != null)
-      {
-        // get the sequence position for the column
-        column = _aa.sequenceRef.findPosition(column) - 1;
-      }
       ContactListI contacts = viewport.getContactList(_aa, column);
       if (contacts == null)
       {
-        return;
+        x++;
+        continue;
       }
+      // ContactListI from viewport can map column -> group
+      Color gpcol = (cm == null) ? Color.white
+              : contacts.getColourForGroup(); // cm.getColourForGroup(cm.getGroupsFor(column));
+      // feature still in development - highlight or omit regions hidden in
+      // the alignment - currently marks them as red rows
+      boolean maskHiddenCols = false;
+      // TODO: optionally pass visible column mask to the ContactGeometry object
+      // so it maps
+      // only visible contacts to geometry
       // Bean holding mapping from contact list to pixels
+      // TODO: allow bracketing/limiting of range on contacts to render (like
+      // visible column mask but more flexible?)
+
+      // COntactListI provides mapping for column -> cm-groupmapping
       final ContactGeometry cgeom = new ContactGeometry(contacts,
               _aa.graphHeight);
 
@@ -90,27 +174,12 @@ public class ContactMapRenderer implements AnnotationRowRendererI
         // cend = (int) Math.min(contact_height,
         // Math.ceil(cstart + contacts_per_pixel * pixels_step));
 
-        // TODO show maximum colour for range - sort of done
-        // also need a 'getMaxPosForRange(start,end)' to accurately render
         Color col;
-        boolean rowsel = false;
-        if (!colsel && columnSelection != null)
+        boolean rowsel = false, containsHidden = false;
+        if (columnSelection != null)
         {
-          if (_aa.sequenceRef == null)
-          {
-            rowsel = columnSelection.intersects(ci.cStart, ci.cEnd);
-          }
-          else
-          {
-            // TODO check we have correctly mapped cstart to local sequence
-            // numbering
-            int s = _aa.sequenceRef.findIndex(ci.cStart);
-            int e = _aa.sequenceRef.findIndex(ci.cEnd);
-            if (s > 0 && s < _aa.sequenceRef.getLength())
-            {
-              rowsel = columnSelection.intersects(s, e);
-            }
-          }
+          rowsel = cgeom.intersects(ci, columnSelection, hiddenColumns,
+                  maskHiddenCols);
         }
         // TODO: show selected region
         if (colsel || rowsel)
@@ -118,13 +187,33 @@ public class ContactMapRenderer implements AnnotationRowRendererI
 
           col = getSelectedColorForRange(min, max, contacts, ci.cStart,
                   ci.cEnd);
-          g.setColor(col);
+          if (colsel && rowsel)
+          {
+            col = new Color(col.getBlue(), col.getGreen(), col.getRed());
+          }
+          else
+          {
+            col = new Color(col.getBlue(), col.getBlue(), col.getBlue());
+          }
         }
         else
         {
           col = getColorForRange(min, max, contacts, ci.cStart, ci.cEnd);
-          g.setColor(col);
         }
+        if (containsHidden)
+        {
+          col = shade.hidden;
+        }
+        if (gpcol != null && gpcol != Color.white)
+        {
+          // todo - could overlay group as a transparent rectangle ?
+          col = new Color(
+                  (int) (((float) (col.getRed() + gpcol.getRed())) / 2f),
+                  (int) (((float) (col.getGreen() + gpcol.getGreen()))
+                          / 2f),
+                  (int) (((float) (col.getBlue() + gpcol.getBlue())) / 2f));
+        }
+        g.setColor(col);
         if (cgeom.pixels_step > 1)
         {
           g.fillRect(x * charWidth, ht, charWidth, 1 + cgeom.pixels_step);
@@ -139,14 +228,10 @@ public class ContactMapRenderer implements AnnotationRowRendererI
 
   }
 
-  // Shading parameters
-  Color minColor = Color.white, maxColor = Color.green.darker().darker(),
-          selMaxColor = Color.magenta.darker();
-
   Color shadeFor(float min, float max, float value)
   {
-    return jalview.util.ColorUtils.getGraduatedColour(value, 0, minColor,
-            max, maxColor);
+    return jalview.util.ColorUtils.getGraduatedColour(value, 0,
+            shade.minColor, max, shade.maxColor);
   }
 
   public Color getColorForRange(float min, float max, ContactListI cl,
@@ -163,7 +248,7 @@ public class ContactMapRenderer implements AnnotationRowRendererI
     ContactRange cr = cl.getRangeFor(i, j);
     // average for moment - probably more interested in maxIntProj though
     return jalview.util.ColorUtils.getGraduatedColour((float) cr.getMean(),
-            0, minColor, max, selMaxColor);
+            0, shade.selMinColor, max, shade.selMaxColor);
   }
 
 }