JAL-3855 RGB colours from the alphafold paE scale.
[jalview.git] / src / jalview / renderer / ContactMapRenderer.java
1 /**
2  * 
3  */
4 package jalview.renderer;
5
6 import java.awt.Color;
7 import java.awt.Graphics;
8
9 import jalview.api.AlignViewportI;
10 import jalview.datamodel.AlignmentAnnotation;
11 import jalview.datamodel.Annotation;
12 import jalview.datamodel.ColumnSelection;
13 import jalview.datamodel.ContactListI;
14 import jalview.datamodel.ContactRange;
15 import jalview.datamodel.HiddenColumns;
16 import jalview.renderer.api.AnnotationRowRendererI;
17
18 /**
19  * @author jprocter
20  *
21  */
22 public class ContactMapRenderer implements AnnotationRowRendererI
23 {
24
25   @Override
26   public void renderRow(Graphics g, int charWidth, int charHeight,
27           boolean hasHiddenColumns, AlignViewportI viewport,
28           HiddenColumns hiddenColumns, ColumnSelection columnSelection,
29           AlignmentAnnotation _aa, Annotation[] aa_annotations, int sRes,
30           int eRes, float min, float max, int y)
31   {
32     if (sRes > aa_annotations.length)
33     {
34       return;
35     }
36     eRes = Math.min(eRes, aa_annotations.length);
37
38     int x = 0, y2 = y;
39
40     g.setColor(Color.pink);
41
42     g.drawLine(x, y2, (eRes - sRes) * charWidth, y2);
43
44     int column;
45     int aaMax = aa_annotations.length - 1;
46     while (x < eRes - sRes)
47     {
48       column = sRes + x;
49       if (hasHiddenColumns)
50       {
51         column = hiddenColumns.visibleToAbsoluteColumn(column);
52       }
53       // TODO: highlight columns selected
54       boolean colsel = false;
55       if (columnSelection != null)
56       {
57         colsel = columnSelection.contains(column);
58       }
59
60       if (column > aaMax)
61       {
62         break;
63       }
64
65       if (aa_annotations[column] == null)
66       {
67         x++;
68         continue;
69       }
70       if (_aa.sequenceRef != null)
71       {
72         // get the sequence position for the column
73         column = _aa.sequenceRef.findPosition(column) - 1;
74       }
75       ContactListI contacts = viewport.getContactList(_aa, column);
76       if (contacts == null)
77       {
78         return;
79       }
80       // Bean holding mapping from contact list to pixels
81       final ContactGeometry cgeom = new ContactGeometry(contacts,
82               _aa.graphHeight);
83
84       for (int ht = y2, eht = y2
85               - _aa.graphHeight; ht >= eht; ht -= cgeom.pixels_step)
86       {
87         ContactGeometry.contactInterval ci = cgeom.mapFor(y2 - ht,
88                 y2 - ht + cgeom.pixels_step);
89         // cstart = (int) Math.floor(((double) y2 - ht) * contacts_per_pixel);
90         // cend = (int) Math.min(contact_height,
91         // Math.ceil(cstart + contacts_per_pixel * pixels_step));
92
93         // TODO show maximum colour for range - sort of done
94         // also need a 'getMaxPosForRange(start,end)' to accurately render
95         Color col;
96         boolean rowsel = false;
97         if (!colsel && columnSelection != null)
98         {
99           if (_aa.sequenceRef == null)
100           {
101             rowsel = columnSelection.intersects(ci.cStart, ci.cEnd);
102           }
103           else
104           {
105             // TODO check we have correctly mapped cstart to local sequence
106             // numbering
107             int s = _aa.sequenceRef.findIndex(ci.cStart);
108             int e = _aa.sequenceRef.findIndex(ci.cEnd);
109             if (s > 0 && s < _aa.sequenceRef.getLength())
110             {
111               rowsel = columnSelection.intersects(s, e);
112             }
113           }
114         }
115         // TODO: show selected region
116         if (colsel || rowsel)
117         {
118
119           col = getSelectedColorForRange(min, max, contacts, ci.cStart,
120                   ci.cEnd);
121           g.setColor(col);
122         }
123         else
124         {
125           col = getColorForRange(min, max, contacts, ci.cStart, ci.cEnd);
126           g.setColor(col);
127         }
128         if (cgeom.pixels_step > 1)
129         {
130           g.fillRect(x * charWidth, ht, charWidth, 1 + cgeom.pixels_step);
131         }
132         else
133         {
134           g.drawLine(x * charWidth, ht, (x + 1) * charWidth, ht);
135         }
136       }
137       x++;
138     }
139
140   }
141
142   // Shading parameters
143   // currently hardwired for alphafold
144   Color maxColor = new Color(246, 252, 243),
145           minColor = new Color(0, 60, 26),
146           selMinColor = new Color(26, 0, 60),
147           selMaxColor = new Color(243, 246, 252);
148
149   Color shadeFor(float min, float max, float value)
150   {
151     return jalview.util.ColorUtils.getGraduatedColour(value, 0, minColor,
152             max, maxColor);
153   }
154
155   public Color getColorForRange(float min, float max, ContactListI cl,
156           int i, int j)
157   {
158     ContactRange cr = cl.getRangeFor(i, j);
159     // average for moment - probably more interested in maxIntProj though
160     return shadeFor(min, max, (float) cr.getMean());
161   }
162
163   public Color getSelectedColorForRange(float min, float max,
164           ContactListI cl, int i, int j)
165   {
166     ContactRange cr = cl.getRangeFor(i, j);
167     // average for moment - probably more interested in maxIntProj though
168     return jalview.util.ColorUtils.getGraduatedColour((float) cr.getMean(),
169             0, selMinColor, max, selMaxColor);
170   }
171
172 }