src/jalview/renderer/ContactMapRenderer.java

   1 /**
   2  *
   3  */
   4 package jalview.renderer;
   5
   6 import java.awt.Color;
   7 import java.awt.Graphics;
   8 import java.util.Iterator;
   9
  10 import jalview.api.AlignViewportI;
  11 import jalview.datamodel.AlignmentAnnotation;
  12 import jalview.datamodel.Annotation;
  13 import jalview.datamodel.ColumnSelection;
  14 import jalview.datamodel.ContactListI;
  15 import jalview.datamodel.ContactMatrixI;
  16 import jalview.datamodel.ContactRange;
  17 import jalview.datamodel.HiddenColumns;
  18 import jalview.renderer.api.AnnotationRowRendererI;
  19
  20 /**
  21  * @author jprocter
  22  *
  23  */
  24 public abstract class ContactMapRenderer implements AnnotationRowRendererI
  25 {
  26   /**
  27    * bean holding colours for shading
  28    *
  29    * @author jprocter
  30    *
  31    */
  32   public class Shading
  33   {
  34     /**
  35      * shown when no data available from map
  36      */
  37     Color no_data;
  38     /**
  39      * shown for region not currently visible - should normally not see this
  40      */
  41     Color hidden;
  42     /**
  43      * linear shading scheme min/max
  44      */
  45     Color maxColor, minColor;
  46
  47     /**
  48      * linear shading scheme min/max for selected region
  49      */
  50     Color selMinColor, selMaxColor;
  51
  52     public Shading(Color no_data, Color hidden, Color maxColor,
  53             Color minColor, Color selMinColor, Color selMaxColor)
  54     {
  55       super();
  56       this.no_data = no_data;
  57       this.hidden = hidden;
  58       this.maxColor = maxColor;
  59       this.minColor = minColor;
  60       this.selMinColor = selMinColor;
  61       this.selMaxColor = selMaxColor;
  62     }
  63
  64   }
  65
  66   final Shading shade;
  67
  68   /**
  69    * build an EBI-AlphaFold style renderer of PAE matrices
  70    *
  71    * @return
  72    */
  73   public static ContactMapRenderer newPAERenderer()
  74   {
  75     return new ContactMapRenderer()
  76     {
  77       @Override
  78       public Shading getShade()
  79       {
  80         return new Shading(Color.pink, Color.red,
  81
  82                 new Color(246, 252, 243), new Color(0, 60, 26),
  83                 new Color(26, 0, 60), new Color(243, 246, 252));
  84       }
  85     };
  86   }
  87
  88   /**
  89    *
  90    * @return instance of Shading used to initialise the renderer
  91    */
  92   public abstract Shading getShade();
  93
  94   public ContactMapRenderer()
  95   {
  96     this.shade = getShade();
  97   }
  98
  99   @Override
 100   public void renderRow(Graphics g, int charWidth, int charHeight,
 101           boolean hasHiddenColumns, AlignViewportI viewport,
 102           HiddenColumns hiddenColumns, ColumnSelection columnSelection,
 103           AlignmentAnnotation _aa, Annotation[] aa_annotations, int sRes,
 104           int eRes, float min, float max, int y)
 105   {
 106     if (sRes > aa_annotations.length)
 107     {
 108       return;
 109     }
 110     eRes = Math.min(eRes, aa_annotations.length);
 111
 112     int x = 0, topY = y;
 113
 114     // uncomment below to render whole area of matrix as pink
 115     // g.setColor(shade.no_data);
 116     // g.fillRect(x, topY-_aa.height, (eRes - sRes) * charWidth, _aa.graphHeight);
 117
 118     boolean showGroups = _aa.isShowGroupsForContactMatrix();
 119     int column;
 120     int aaMax = aa_annotations.length - 1;
 121     ContactMatrixI cm = viewport.getContactMatrix(_aa);
 122     while (x < eRes - sRes)
 123     {
 124       column = sRes + x;
 125       if (hasHiddenColumns)
 126       {
 127         column = hiddenColumns.visibleToAbsoluteColumn(column);
 128       }
 129       // TODO: highlight columns selected
 130       boolean colsel = false;
 131       if (columnSelection != null)
 132       {
 133         colsel = columnSelection.contains(column);
 134       }
 135
 136       if (column > aaMax)
 137       {
 138         break;
 139       }
 140
 141       if (aa_annotations[column] == null)
 142       {
 143         x++;
 144         continue;
 145       }
 146       ContactListI contacts = viewport.getContactList(_aa, column);
 147       if (contacts == null)
 148       {
 149         x++;
 150         continue;
 151       }
 152       // ContactListI from viewport can map column -> group
 153       Color gpcol = (cm == null) ? Color.white
 154               : contacts.getColourForGroup(); // cm.getColourForGroup(cm.getGroupsFor(column));
 155       // feature still in development - highlight or omit regions hidden in
 156       // the alignment - currently marks them as red rows
 157       boolean maskHiddenCols = false;
 158       // TODO: optionally pass visible column mask to the ContactGeometry object
 159       // so it maps
 160       // only visible contacts to geometry
 161       // Bean holding mapping from contact list to pixels
 162       // TODO: allow bracketing/limiting of range on contacts to render (like
 163       // visible column mask but more flexible?)
 164
 165       // COntactListI provides mapping for column -> cm-groupmapping
 166       final ContactGeometry cgeom = new ContactGeometry(contacts,
 167               _aa.graphHeight);
 168
 169       for (int ht = 0, botY = topY
 170               - _aa.height; ht < _aa.graphHeight; ht += cgeom.pixels_step)
 171       {
 172         ContactGeometry.contactInterval ci = cgeom.mapFor(ht,
 173                 ht + cgeom.pixels_step);
 174         // cstart = (int) Math.floor(((double) y2 - ht) * contacts_per_pixel);
 175         // cend = (int) Math.min(contact_height,
 176         // Math.ceil(cstart + contacts_per_pixel * pixels_step));
 177
 178         Color col;
 179         boolean rowsel = false, containsHidden = false;
 180         if (columnSelection != null)
 181         {
 182           rowsel = cgeom.intersects(ci, columnSelection, hiddenColumns,
 183                   maskHiddenCols);
 184         }
 185         // TODO: show selected region
 186         if (colsel || rowsel)
 187         {
 188
 189           col = getSelectedColorForRange(min, max, contacts, ci.cStart,
 190                   ci.cEnd);
 191           if (colsel && rowsel)
 192           {
 193             col = new Color(col.getBlue(), col.getGreen(), col.getRed());
 194           }
 195           else
 196           {
 197             col = new Color(col.getBlue(), col.getBlue(), col.getBlue());
 198           }
 199         }
 200         else
 201         {
 202           col = getColorForRange(min, max, contacts, ci.cStart, ci.cEnd);
 203         }
 204         if (containsHidden)
 205         {
 206           col = shade.hidden;
 207         }
 208         if (showGroups && gpcol != null && gpcol != Color.white)
 209         {
 210           // todo - could overlay group as a transparent rectangle ?
 211           col = new Color(
 212                   (int) (((float) (col.getRed() + gpcol.getRed())) / 2f),
 213                   (int) (((float) (col.getGreen() + gpcol.getGreen()))
 214                           / 2f),
 215                   (int) (((float) (col.getBlue() + gpcol.getBlue())) / 2f));
 216         }
 217         g.setColor(col);
 218         if (cgeom.pixels_step > 1)
 219         {
 220           g.fillRect(x * charWidth, botY+ht, charWidth, 1 + cgeom.pixels_step);
 221         }
 222         else
 223         {
 224           g.drawLine(x * charWidth, botY+ht, (x + 1) * charWidth, botY+ht);
 225         }
 226       }
 227       x++;
 228     }
 229
 230   }
 231
 232   Color shadeFor(float min, float max, float value)
 233   {
 234     return jalview.util.ColorUtils.getGraduatedColour(value, 0,
 235             shade.minColor, max, shade.maxColor);
 236   }
 237
 238   public Color getColorForRange(float min, float max, ContactListI cl,
 239           int i, int j)
 240   {
 241     ContactRange cr = cl.getRangeFor(i, j);
 242     // average for moment - probably more interested in maxIntProj though
 243     return shadeFor(min, max, (float) cr.getMean());
 244   }
 245
 246   public Color getSelectedColorForRange(float min, float max,
 247           ContactListI cl, int i, int j)
 248   {
 249     ContactRange cr = cl.getRangeFor(i, j);
 250     // average for moment - probably more interested in maxIntProj though
 251     return jalview.util.ColorUtils.getGraduatedColour((float) cr.getMean(),
 252             0, shade.selMinColor, max, shade.selMaxColor);
 253   }
 254
 255 }