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