Clover icon

Coverage Report

  1. Project Clover database Wed Nov 6 2024 00:56:24 GMT
  2. Package jalview.renderer

File ContactMapRenderer.java

 

Coverage histogram

../../img/srcFileCovDistChart8.png
20% of files have more coverage

Code metrics

32
66
8
2
293
177
28
0.42
8.25
4
3.5

Classes

Class Line # Actions
ContactMapRenderer 40 59 27
0.693877669.4%
ContactMapRenderer.Shading 48 7 1
1.0100%
 

Contributing tests

This file is covered by 11 tests. .

Source view

1    /*
2    * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3    * Copyright (C) $$Year-Rel$$ The Jalview Authors
4    *
5    * This file is part of Jalview.
6    *
7    * Jalview is free software: you can redistribute it and/or
8    * modify it under the terms of the GNU General Public License
9    * as published by the Free Software Foundation, either version 3
10    * of the License, or (at your option) any later version.
11    *
12    * Jalview is distributed in the hope that it will be useful, but
13    * WITHOUT ANY WARRANTY; without even the implied warranty
14    * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15    * PURPOSE. See the GNU General Public License for more details.
16    *
17    * You should have received a copy of the GNU General Public License
18    * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19    * The Jalview Authors are detailed in the 'AUTHORS' file.
20    */
21    package jalview.renderer;
22   
23    import java.awt.Color;
24    import java.awt.Graphics;
25   
26    import jalview.api.AlignViewportI;
27    import jalview.datamodel.AlignmentAnnotation;
28    import jalview.datamodel.Annotation;
29    import jalview.datamodel.ColumnSelection;
30    import jalview.datamodel.ContactListI;
31    import jalview.datamodel.ContactMatrixI;
32    import jalview.datamodel.ContactRange;
33    import jalview.datamodel.HiddenColumns;
34    import jalview.renderer.api.AnnotationRowRendererI;
35   
36    /**
37    * @author jprocter
38    *
39    */
 
40    public abstract class ContactMapRenderer implements AnnotationRowRendererI
41    {
42    /**
43    * bean holding colours for shading
44    *
45    * @author jprocter
46    *
47    */
 
48    public class Shading
49    {
50    /**
51    * shown when no data available from map
52    */
53    Color no_data;
54   
55    /**
56    * shown for region not currently visible - should normally not see this
57    */
58    Color hidden;
59   
60    /**
61    * linear shading scheme min/max
62    */
63    Color maxColor, minColor;
64   
65    /**
66    * linear shading scheme min/max for selected region
67    */
68    Color selMinColor, selMaxColor;
69   
70    /**
71    *
72    * @param no_data
73    * - colour when no data available
74    * @param hidden
75    * - colour if this row is hidden
76    * @param maxColor
77    * - colour for maximum value of contact
78    * @param minColor
79    * - colour for minimum value of contact
80    * @param selMinColor
81    * - min colour if the contact has been selected
82    * @param selMaxColor
83    * - max colour if contact is selected
84    */
 
85  137 toggle public Shading(Color no_data, Color hidden, Color maxColor,
86    Color minColor, Color selMinColor, Color selMaxColor)
87    {
88  137 super();
89  137 this.no_data = no_data;
90  137 this.hidden = hidden;
91  137 this.maxColor = maxColor;
92  137 this.minColor = minColor;
93  137 this.selMinColor = selMinColor;
94  137 this.selMaxColor = selMaxColor;
95    }
96   
97    }
98   
99    final Shading shade;
100   
101    /**
102    * build an EBI-AlphaFold style renderer of PAE matrices
103    *
104    * @return
105    */
 
106  137 toggle public static ContactMapRenderer newPAERenderer()
107    {
108  137 return new ContactMapRenderer()
109    {
 
110  137 toggle @Override
111    public Shading getShade()
112    {
113  137 return new Shading(Color.pink, Color.red,
114   
115    new Color(247, 252, 245), new Color(0, 68, 28),
116    new Color(28, 0, 68), new Color(245, 247, 252));
117    }
118    };
119    }
120   
121    /**
122    *
123    * @return instance of Shading used to initialise the renderer
124    */
125    public abstract Shading getShade();
126   
 
127  137 toggle public ContactMapRenderer()
128    {
129  137 this.shade = getShade();
130    }
131   
 
132  137 toggle @Override
133    public void renderRow(Graphics g, int charWidth, int charHeight,
134    boolean hasHiddenColumns, AlignViewportI viewport,
135    HiddenColumns hiddenColumns, ColumnSelection columnSelection,
136    AlignmentAnnotation _aa, Annotation[] aa_annotations, int sRes,
137    int eRes, float min, float max, int y)
138    {
139  137 if (sRes > aa_annotations.length)
140    {
141  0 return;
142    }
143  137 eRes = Math.min(eRes, aa_annotations.length);
144   
145  137 int x = 0, topY = y;
146   
147    // uncomment below to render whole area of matrix as pink
148    // g.setColor(shade.no_data);
149    // g.fillRect(x, topY-_aa.height, (eRes - sRes) * charWidth,
150    // _aa.graphHeight);
151   
152  137 boolean showGroups = _aa.isShowGroupsForContactMatrix();
153  137 int column;
154  137 int aaMax = aa_annotations.length - 1;
155  137 ContactMatrixI cm = viewport.getContactMatrix(_aa);
156  137 if (cm == null)
157    {
158  0 return;
159    }
160  8184 while (x < eRes - sRes)
161    {
162  8047 column = sRes + x;
163  8047 if (hasHiddenColumns)
164    {
165  0 column = hiddenColumns.visibleToAbsoluteColumn(column);
166    }
167    // TODO: highlight columns selected
168  8047 boolean colsel = false;
169  8047 if (columnSelection != null)
170    {
171  8047 colsel = columnSelection.contains(column);
172    }
173   
174  8047 if (column > aaMax)
175    {
176  0 break;
177    }
178   
179  8047 if (aa_annotations[column] == null)
180    {
181  4689 x++;
182  4689 continue;
183    }
184  3358 ContactListI contacts = viewport.getContactList(_aa, column);
185  3358 if (contacts == null)
186    {
187  0 x++;
188  0 continue;
189    }
190    // ContactListI from viewport can map column -> group
191  3358 Color gpcol = (cm == null) ? Color.white
192    : contacts.getColourForGroup(); // cm.getColourForGroup(cm.getGroupsFor(column));
193    // feature still in development - highlight or omit regions hidden in
194    // the alignment - currently marks them as red rows
195  3358 boolean maskHiddenCols = false;
196    // TODO: optionally pass visible column mask to the ContactGeometry object
197    // so it maps
198    // only visible contacts to geometry
199    // Bean holding mapping from contact list to pixels
200    // TODO: allow bracketing/limiting of range on contacts to render (like
201    // visible column mask but more flexible?)
202   
203    // COntactListI provides mapping for column -> cm-groupmapping
204  3358 final ContactGeometry cgeom = new ContactGeometry(contacts,
205    _aa.graphHeight);
206   
207  3358 for (int ht = 0, botY = topY
208  137674 - _aa.height; ht < _aa.graphHeight; ht += cgeom.pixels_step)
209    {
210  134319 ContactGeometry.contactInterval ci = cgeom.mapFor(ht);
211    // cstart = (int) Math.floor(((double) y2 - ht) * contacts_per_pixel);
212    // cend = (int) Math.min(contact_height,
213    // Math.ceil(cstart + contacts_per_pixel * pixels_step));
214   
215  134318 Color col;
216  134318 boolean rowsel = false;
217  134320 boolean containsHidden = false;
218  134319 if (columnSelection != null)
219    {
220  134319 rowsel = cgeom.intersects(ci, columnSelection, hiddenColumns,
221    maskHiddenCols);
222    }
223    // TODO: show selected region
224  134320 if (colsel || rowsel)
225    {
226   
227  0 col = getSelectedColorForRange(min, max, contacts, ci.cStart,
228    ci.cEnd);
229  0 if (colsel && rowsel)
230    {
231  0 col = new Color(col.getBlue(), col.getGreen(), col.getRed());
232    }
233    else
234    {
235  0 col = new Color(col.getBlue(), col.getBlue(), col.getBlue());
236    }
237    }
238    else
239    {
240  134320 col = getColorForRange(min, max, contacts, ci.cStart, ci.cEnd);
241    }
242  134318 if (containsHidden)
243    {
244  0 col = shade.hidden;
245    }
246  134320 if (showGroups && gpcol != null && gpcol != Color.white)
247    {
248    // todo - could overlay group as a transparent rectangle ?
249  0 col = new Color((int) ((col.getRed() + gpcol.getRed()) / 2f),
250    (int) ((col.getGreen() + gpcol.getGreen()) / 2f),
251    (int) ((col.getBlue() + gpcol.getBlue()) / 2f));
252    }
253  134320 g.setColor(col);
254  134319 if (cgeom.pixels_step > 1)
255    {
256  0 g.fillRect(x * charWidth, botY + ht, charWidth,
257    cgeom.pixels_step);
258    }
259    else
260    {
261  134319 g.drawLine(x * charWidth, botY + ht, (x + 1) * charWidth,
262    botY + ht);
263    }
264    }
265  3358 x++;
266    }
267   
268    }
269   
 
270  134315 toggle Color shadeFor(float min, float max, float value)
271    {
272  134315 return jalview.util.ColorUtils.getGraduatedColour(value, 0,
273    shade.minColor, max, shade.maxColor);
274    }
275   
 
276  134320 toggle public Color getColorForRange(float min, float max, ContactListI cl,
277    int i, int j)
278    {
279  134320 ContactRange cr = cl.getRangeFor(i, j);
280    // average for moment - probably more interested in maxIntProj though
281  134315 return shadeFor(min, max, (float) cr.getMean());
282    }
283   
 
284  0 toggle public Color getSelectedColorForRange(float min, float max,
285    ContactListI cl, int i, int j)
286    {
287  0 ContactRange cr = cl.getRangeFor(i, j);
288    // average for moment - probably more interested in maxIntProj though
289  0 return jalview.util.ColorUtils.getGraduatedColour((float) cr.getMin(),
290    0, shade.selMinColor, max, shade.selMaxColor);
291    }
292   
293    }
  • Report generated by OpenClover v 4.4.1 on Wed Nov 6 2024 01:03:43 GMT using coverage data from Wed Nov 6 2024 01:03:32 GMT.
  • OpenClover is free and open-source software.