1 package jalview.renderer;
3 import jalview.analysis.AAFrequency;
4 import jalview.analysis.StructureFrequency;
5 import jalview.api.AlignViewportI;
6 import jalview.datamodel.AlignmentAnnotation;
7 import jalview.datamodel.Annotation;
8 import jalview.datamodel.ColumnSelection;
9 import jalview.schemes.ColourSchemeI;
11 import java.awt.BasicStroke;
12 import java.awt.Color;
14 import java.awt.FontMetrics;
15 import java.awt.Graphics;
16 import java.awt.Graphics2D;
17 import java.awt.Image;
18 import java.awt.font.LineMetrics;
19 import java.awt.geom.AffineTransform;
20 import java.awt.image.ImageObserver;
21 import java.util.Hashtable;
23 import com.stevesoft.pat.Regex;
25 public class AnnotationRenderer
28 public AnnotationRenderer()
30 // TODO Auto-generated constructor stub
33 public void drawStemAnnot(Graphics g, Annotation[] row_annotations,
34 int lastSSX, int x, int y, int iconOffset, int startRes,
35 int column, boolean validRes, boolean validEnd)
37 g.setColor(STEM_COLOUR);
38 int sCol = (lastSSX / charWidth) + startRes;
40 int x2 = (x * charWidth);
41 Regex closeparen = new Regex("(\\))");
43 String dc = (column == 0 || row_annotations[column - 1] == null) ? ""
44 : row_annotations[column - 1].displayCharacter;
46 boolean diffupstream = sCol == 0 || row_annotations[sCol - 1] == null
47 || !dc.equals(row_annotations[sCol - 1].displayCharacter);
48 boolean diffdownstream = !validRes || !validEnd
49 || row_annotations[column] == null
50 || !dc.equals(row_annotations[column].displayCharacter);
51 // System.out.println("Column "+column+" diff up: "+diffupstream+" down:"+diffdownstream);
52 // If a closing base pair half of the stem, display a backward arrow
53 if (column > 0 && closeparen.search(dc))
56 // if (validRes && column>1 && row_annotations[column-2]!=null &&
57 // dc.equals(row_annotations[column-2].displayCharacter))
59 g.fillPolygon(new int[]
60 { lastSSX + 5, lastSSX + 5, lastSSX }, new int[]
61 { y + iconOffset, y + 14 + iconOffset, y + 8 + iconOffset }, 3);
71 // display a forward arrow
74 g.fillPolygon(new int[]
75 { x2 - 5, x2 - 5, x2 }, new int[]
76 { y + iconOffset, y + 14 + iconOffset, y + 8 + iconOffset }, 3);
85 g.fillRect(x1, y + 4 + iconOffset, x2 - x1, 7);
88 private int charWidth, endRes, charHeight;
90 private boolean validCharWidth, hasHiddenColumns;
92 private FontMetrics fm;
94 private final boolean MAC = new jalview.util.Platform().isAMac();
96 boolean av_renderHistogram = true, av_renderProfile = true,
97 av_normaliseProfile = false;
99 ColourSchemeI profcolour = null;
101 private ColumnSelection columnSelection;
103 private Hashtable[] hconsensus;
105 private Hashtable[] hStrucConsensus;
107 private boolean av_ignoreGapsConsensus;
110 * attributes set from AwtRenderPanelI
113 * old image used when data is currently being calculated and cannot be
116 private Image fadedImage;
119 * panel being rendered into
121 private ImageObserver annotationPanel;
124 * width of image to render in panel
126 private int imgWidth;
128 // public void updateFromAnnotationPanel(FontMetrics annotFM, AlignViewportI
130 public void updateFromAwtRenderPanel(AwtRenderPanelI annotPanel,
133 fm = annotPanel.getFontMetrics();
134 annotationPanel = annotPanel;
135 fadedImage = annotPanel.getFadedImage();
136 imgWidth = annotPanel.getFadedImageWidth();
137 updateFromAlignViewport(av);
140 public void updateFromAlignViewport(AlignViewportI av)
142 charWidth = av.getCharWidth();
143 endRes = av.getEndRes();
144 charHeight = av.getCharHeight();
145 hasHiddenColumns = av.hasHiddenColumns();
146 validCharWidth = av.isValidCharWidth();
147 av_renderHistogram = av.isShowConsensusHistogram();
148 av_renderProfile = av.isShowSequenceLogo();
149 av_normaliseProfile = av.isNormaliseSequenceLogo();
150 profcolour = av.getGlobalColourScheme();
151 if (profcolour == null)
153 // Set the default colour for sequence logo if the alignnent has no
155 profcolour = av.getAlignment().isNucleotide() ? new jalview.schemes.NucleotideColourScheme()
156 : new jalview.schemes.ZappoColourScheme();
158 columnSelection = av.getColumnSelection();
159 hconsensus = av.getSequenceConsensusHash();// hconsensus;
160 hStrucConsensus = av.getRnaStructureConsensusHash(); // hStrucConsensus;
161 av_ignoreGapsConsensus = av.getIgnoreGapsConsensus();
164 public int[] getProfileFor(AlignmentAnnotation aa, int column)
166 // TODO : consider refactoring the global alignment calculation
167 // properties/rendering attributes as a global 'alignment group' which holds
168 // all vis settings for the alignment as a whole rather than a subset
170 if (aa.autoCalculated && aa.label.startsWith("Consensus"))
172 if (aa.groupRef != null && aa.groupRef.consensusData != null
173 && aa.groupRef.isShowSequenceLogo())
175 return AAFrequency.extractProfile(
176 aa.groupRef.consensusData[column],
177 aa.groupRef.getIgnoreGapsConsensus());
179 // TODO extend annotation row to enable dynamic and static profile data to
181 if (aa.groupRef == null && aa.sequenceRef == null && av_renderProfile)
183 return AAFrequency.extractProfile(hconsensus[column],
184 av_ignoreGapsConsensus);
189 if (aa.autoCalculated && aa.label.startsWith("StrucConsensus"))
191 // TODO implement group structure consensus
193 * if (aa.groupRef != null && aa.groupRef.consensusData != null &&
194 * aa.groupRef.isShowSequenceLogo()) { //TODO check what happens for
195 * group selections return StructureFrequency.extractProfile(
196 * aa.groupRef.consensusData[column], aa.groupRef
197 * .getIgnoreGapsConsensus()); }
199 // TODO extend annotation row to enable dynamic and static profile data
202 if (aa.groupRef == null && aa.sequenceRef == null
203 && av_renderProfile && hStrucConsensus != null
204 && hStrucConsensus.length > column)
206 return StructureFrequency.extractProfile(hStrucConsensus[column],
207 av_ignoreGapsConsensus);
215 * Render the annotation rows associated with an alignment.
220 * data and view settings to render
222 * destination for graphics
224 * row where a mouse event occured (or -1)
226 * first column that will be drawn
228 * last column that will be drawn
229 * @return true if the fadedImage was used for any alignment annotation rows
230 * currently being calculated
232 public boolean drawComponent(AwtRenderPanelI annotPanel,
233 AlignViewportI av, Graphics g, int activeRow, int startRes,
236 boolean usedFaded = false;
238 // AnnotationPanel needs to implement: ImageObserver, access to
240 updateFromAwtRenderPanel(annotPanel, av);
241 fm = g.getFontMetrics();
242 AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
249 boolean validRes = false;
250 boolean validEnd = false;
251 boolean labelAllCols = false;
252 boolean centreColLabels, centreColLabelsDef = av
253 .getCentreColumnLabels();
254 boolean scaleColLabel = false;
255 boolean[] graphGroupDrawn = new boolean[aa.length];
256 int charOffset = 0; // offset for a label
257 float fmWidth, fmScaling = 1f; // scaling for a label to fit it into a
259 Font ofont = g.getFont();
261 for (int i = 0; i < aa.length; i++)
263 AlignmentAnnotation row = aa[i];
264 Annotation[] row_annotations = row.annotations;
269 centreColLabels = row.centreColLabels || centreColLabelsDef;
270 labelAllCols = row.showAllColLabels;
271 scaleColLabel = row.scaleColLabel;
276 if (row.graphGroup > -1 && graphGroupDrawn[row.graphGroup])
281 // this is so that we draw the characters below the graph
286 iconOffset = charHeight - fm.getDescent();
290 else if (row.hasText)
292 iconOffset = charHeight - fm.getDescent();
300 if (row.autoCalculated && av.isCalculationInProgress(row))
304 g.drawImage(fadedImage, 0, y - row.height, imgWidth, y, 0, y
305 - row.height, imgWidth, y, annotationPanel);
306 g.setColor(Color.black);
307 // g.drawString("Calculating "+aa[i].label+"....",20, y-row.height/2);
313 * else if (annotationPanel.av.updatingConservation &&
314 * aa[i].label.equals("Conservation")) {
316 * y += charHeight; g.drawImage(annotationPanel.fadedImage, 0, y -
317 * row.height, annotationPanel.imgWidth, y, 0, y - row.height,
318 * annotationPanel.imgWidth, y, annotationPanel);
320 * g.setColor(Color.black); //
321 * g.drawString("Calculating Conservation.....",20, y-row.height/2);
323 * continue; } else if (annotationPanel.av.updatingConservation &&
324 * aa[i].label.equals("Quality")) {
326 * y += charHeight; g.drawImage(annotationPanel.fadedImage, 0, y -
327 * row.height, annotationPanel.imgWidth, y, 0, y - row.height,
328 * annotationPanel.imgWidth, y, annotationPanel); g.setColor(Color.black);
329 * // / g.drawString("Calculating Quality....",20, y-row.height/2);
333 // first pass sets up state for drawing continuation from left-hand column
335 x = (startRes == 0) ? 0 : -1;
336 while (x < endRes - startRes)
338 if (hasHiddenColumns)
340 column = columnSelection.adjustForHiddenColumns(startRes + x);
341 if (column > row_annotations.length - 1)
348 column = startRes + x;
351 if ((row_annotations == null) || (row_annotations.length <= column)
352 || (row_annotations[column] == null))
364 g.setColor(Color.red);
366 if (columnSelection != null)
368 for (int n = 0; n < columnSelection.size(); n++)
370 int v = columnSelection.columnAt(n);
374 g.fillRect(x * charWidth, y, charWidth, charHeight);
379 if (!row.isValidStruc())
381 g.setColor(Color.orange);
382 g.fillRect((int) row.getInvalidStrucPos() * charWidth, y,
383 charWidth, charHeight);
387 && row_annotations[column].displayCharacter != null
388 && (row_annotations[column].displayCharacter.length() > 0))
391 if (centreColLabels || scaleColLabel)
393 fmWidth = fm.charsWidth(
394 row_annotations[column].displayCharacter
396 row_annotations[column].displayCharacter.length());
400 // justify the label and scale to fit in column
401 if (fmWidth > charWidth)
403 // scale only if the current font isn't already small enough
404 fmScaling = charWidth;
405 fmScaling /= fmWidth;
406 g.setFont(ofont.deriveFont(AffineTransform
407 .getScaleInstance(fmScaling, 1.0)));
408 // and update the label's width to reflect the scaling.
416 .charWidth(row_annotations[column].displayCharacter
419 charOffset = (int) ((charWidth - fmWidth) / 2f);
421 if (row_annotations[column].colour == null)
422 g.setColor(Color.black);
424 g.setColor(row_annotations[column].colour);
426 if (column == 0 || row.graph > 0)
428 g.drawString(row_annotations[column].displayCharacter,
429 (x * charWidth) + charOffset, y + iconOffset);
431 else if (row_annotations[column - 1] == null
433 || !row_annotations[column].displayCharacter
434 .equals(row_annotations[column - 1].displayCharacter) || (row_annotations[column].displayCharacter
435 .length() < 2 && row_annotations[column].secondaryStructure == ' ')))
437 g.drawString(row_annotations[column].displayCharacter, x
438 * charWidth + charOffset, y + iconOffset);
445 char ss = validRes ? row_annotations[column].secondaryStructure
449 // distinguish between forward/backward base-pairing
450 if (row_annotations[column].displayCharacter.indexOf(')') > -1)
455 if (!validRes || (ss != lastSS))
462 drawHelixAnnot(g, row_annotations, lastSSX, x, y,
463 iconOffset, startRes, column, validRes, validEnd);
467 drawSheetAnnot(g, row_annotations, lastSSX, x, y,
468 iconOffset, startRes, column, validRes, validEnd);
471 case 'S': // Stem case for RNA secondary structure
472 case 's': // and opposite direction
473 drawStemAnnot(g, row_annotations, lastSSX, x, y,
474 iconOffset, startRes, column, validRes, validEnd);
478 g.setColor(Color.gray);
479 g.fillRect(lastSSX, y + 6 + iconOffset, (x * charWidth)
495 lastSSX = (x * charWidth);
502 if (column >= row_annotations.length)
504 column = row_annotations.length - 1;
511 if ((row_annotations == null) || (row_annotations.length <= column)
512 || (row_annotations[column] == null))
528 drawHelixAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
529 startRes, column, validRes, validEnd);
533 drawSheetAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
534 startRes, column, validRes, validEnd);
537 case 'S': // Stem case for RNA secondary structure
538 drawStemAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
539 startRes, column, validRes, validEnd);
542 drawGlyphLine(g, row_annotations, lastSSX, x, y, iconOffset,
543 startRes, column, validRes, validEnd);
548 if (row.graph > 0 && row.graphHeight > 0)
550 if (row.graph == AlignmentAnnotation.LINE_GRAPH)
552 if (row.graphGroup > -1 && !graphGroupDrawn[row.graphGroup])
554 float groupmax = -999999, groupmin = 9999999;
555 for (int gg = 0; gg < aa.length; gg++)
557 if (aa[gg].graphGroup != row.graphGroup)
564 aa[gg].visible = false;
566 if (aa[gg].graphMax > groupmax)
568 groupmax = aa[gg].graphMax;
570 if (aa[gg].graphMin < groupmin)
572 groupmin = aa[gg].graphMin;
576 for (int gg = 0; gg < aa.length; gg++)
578 if (aa[gg].graphGroup == row.graphGroup)
580 drawLineGraph(g, aa[gg], aa[gg].annotations, startRes,
581 endRes, y, groupmin, groupmax, row.graphHeight);
585 graphGroupDrawn[row.graphGroup] = true;
589 drawLineGraph(g, row, row_annotations, startRes, endRes, y,
590 row.graphMin, row.graphMax, row.graphHeight);
593 else if (row.graph == AlignmentAnnotation.BAR_GRAPH)
595 drawBarGraph(g, row, row_annotations, startRes, endRes,
596 row.graphMin, row.graphMax, y);
600 if (row.graph > 0 && row.hasText)
613 private final Color GLYPHLINE_COLOR = Color.gray;
615 private final Color SHEET_COLOUR = Color.green;
617 private final Color HELIX_COLOUR = Color.red;
619 private final Color STEM_COLOUR = Color.blue;
621 public void drawGlyphLine(Graphics g, Annotation[] row, int lastSSX,
622 int x, int y, int iconOffset, int startRes, int column,
623 boolean validRes, boolean validEnd)
625 g.setColor(GLYPHLINE_COLOR);
626 g.fillRect(lastSSX, y + 6 + iconOffset, (x * charWidth) - lastSSX, 2);
629 public void drawSheetAnnot(Graphics g, Annotation[] row, int lastSSX,
630 int x, int y, int iconOffset, int startRes, int column,
631 boolean validRes, boolean validEnd)
633 g.setColor(SHEET_COLOUR);
635 if (!validEnd || !validRes || row == null || row[column] == null
636 || row[column].secondaryStructure != 'E')
638 g.fillRect(lastSSX, y + 4 + iconOffset,
639 (x * charWidth) - lastSSX - 4, 7);
640 g.fillPolygon(new int[]
641 { (x * charWidth) - 4, (x * charWidth) - 4, (x * charWidth) },
643 { y + iconOffset, y + 14 + iconOffset, y + 7 + iconOffset },
648 g.fillRect(lastSSX, y + 4 + iconOffset,
649 (x + 1) * charWidth - lastSSX, 7);
654 public void drawHelixAnnot(Graphics g, Annotation[] row, int lastSSX,
655 int x, int y, int iconOffset, int startRes, int column,
656 boolean validRes, boolean validEnd)
658 g.setColor(HELIX_COLOUR);
660 int sCol = (lastSSX / charWidth) + startRes;
662 int x2 = (x * charWidth);
666 int ofs = charWidth / 2;
667 // Off by 1 offset when drawing rects and ovals
668 // to offscreen image on the MAC
669 g.fillRoundRect(lastSSX, y + 4 + iconOffset, x2 - x1, 8, 8, 8);
670 if (sCol == 0 || row[sCol - 1] == null
671 || row[sCol - 1].secondaryStructure != 'H')
676 // g.setColor(Color.orange);
677 g.fillRoundRect(lastSSX, y + 4 + iconOffset, x2 - x1 - ofs + 1, 8,
680 if (!validRes || row[column] == null
681 || row[column].secondaryStructure != 'H')
687 // g.setColor(Color.magenta);
688 g.fillRoundRect(lastSSX + ofs, y + 4 + iconOffset, x2 - x1 - ofs
696 if (sCol == 0 || row[sCol - 1] == null
697 || row[sCol - 1].secondaryStructure != 'H')
699 g.fillArc(lastSSX, y + 4 + iconOffset, charWidth, 8, 90, 180);
703 if (!validRes || row[column] == null
704 || row[column].secondaryStructure != 'H')
706 g.fillArc((x * charWidth) - charWidth, y + 4 + iconOffset, charWidth,
711 g.fillRect(x1, y + 4 + iconOffset, x2 - x1, 8);
714 public void drawLineGraph(Graphics g, AlignmentAnnotation _aa,
715 Annotation[] aa_annotations, int sRes, int eRes, int y,
716 float min, float max, int graphHeight)
718 if (sRes > aa_annotations.length)
725 // Adjustment for fastpaint to left
731 eRes = Math.min(eRes, aa_annotations.length);
739 float range = max - min;
744 y2 = y - (int) ((0 - min / range) * graphHeight);
747 g.setColor(Color.gray);
748 g.drawLine(x - charWidth, y2, (eRes - sRes + 1) * charWidth, y2);
750 eRes = Math.min(eRes, aa_annotations.length);
753 int aaMax = aa_annotations.length - 1;
755 while (x < eRes - sRes)
758 if (hasHiddenColumns)
760 column = columnSelection.adjustForHiddenColumns(column);
768 if (aa_annotations[column] == null
769 || aa_annotations[column - 1] == null)
775 if (aa_annotations[column].colour == null)
776 g.setColor(Color.black);
778 g.setColor(aa_annotations[column].colour);
781 - (int) (((aa_annotations[column - 1].value - min) / range) * graphHeight);
783 - (int) (((aa_annotations[column].value - min) / range) * graphHeight);
785 g.drawLine(x * charWidth - charWidth / 2, y1, x * charWidth
786 + charWidth / 2, y2);
790 if (_aa.threshold != null)
792 g.setColor(_aa.threshold.colour);
793 Graphics2D g2 = (Graphics2D) g;
794 g2.setStroke(new BasicStroke(1, BasicStroke.CAP_SQUARE,
795 BasicStroke.JOIN_ROUND, 3f, new float[]
798 y2 = (int) (y - ((_aa.threshold.value - min) / range) * graphHeight);
799 g.drawLine(0, y2, (eRes - sRes) * charWidth, y2);
800 g2.setStroke(new BasicStroke());
804 public void drawBarGraph(Graphics g, AlignmentAnnotation _aa,
805 Annotation[] aa_annotations, int sRes, int eRes, float min,
808 if (sRes > aa_annotations.length)
812 Font ofont = g.getFont();
813 eRes = Math.min(eRes, aa_annotations.length);
815 int x = 0, y1 = y, y2 = y;
817 float range = max - min;
821 y2 = y - (int) ((0 - min / (range)) * _aa.graphHeight);
824 g.setColor(Color.gray);
826 g.drawLine(x, y2, (eRes - sRes) * charWidth, y2);
829 int aaMax = aa_annotations.length - 1;
830 boolean renderHistogram = true, renderProfile = true, normaliseProfile = false;
831 // if (aa.autoCalculated && aa.label.startsWith("Consensus"))
833 // TODO: generalise this to have render styles for consensus/profile data
834 if (_aa.groupRef != null)
836 renderHistogram = _aa.groupRef.isShowConsensusHistogram();
837 renderProfile = _aa.groupRef.isShowSequenceLogo();
838 normaliseProfile = _aa.groupRef.isNormaliseSequenceLogo();
842 renderHistogram = av_renderHistogram;
843 renderProfile = av_renderProfile;
844 normaliseProfile = av_normaliseProfile;
847 while (x < eRes - sRes)
850 if (hasHiddenColumns)
852 column = columnSelection.adjustForHiddenColumns(column);
860 if (aa_annotations[column] == null)
865 if (aa_annotations[column].colour == null)
866 g.setColor(Color.black);
868 g.setColor(aa_annotations[column].colour);
871 - (int) (((aa_annotations[column].value - min) / (range)) * _aa.graphHeight);
877 g.fillRect(x * charWidth, y2, charWidth, y1 - y2);
881 g.fillRect(x * charWidth, y1, charWidth, y2 - y1);
884 // draw profile if available
888 int profl[] = getProfileFor(_aa, column);
889 // just try to draw the logo if profl is not null
890 if (profl != null && profl[1] != 0)
892 float ht = normaliseProfile ? y - _aa.graphHeight : y1;
893 double htn = normaliseProfile ? _aa.graphHeight : (y2 - y1);// aa.graphHeight;
900 * profl.length == 74 indicates that the profile of a secondary
901 * structure conservation row was accesed. Therefore dc gets length 2,
902 * to have space for a basepair instead of just a single nucleotide
904 if (profl.length == 74)
912 LineMetrics lm = g.getFontMetrics(ofont).getLineMetrics("Q", g);
913 double scale = 1f / (normaliseProfile ? profl[1] : 100f);
914 float ofontHeight = 1f / lm.getAscent();// magnify to fill box
916 for (int c = 2; c < profl[0];)
918 dc[0] = (char) profl[c++];
920 if (_aa.label.startsWith("StrucConsensus"))
922 dc[1] = (char) profl[c++];
926 wdth /= fm.charsWidth(dc, 0, dc.length);
930 scl = htn * scale * profl[c++];
931 lm = ofont.getLineMetrics(dc, 0, 1, g.getFontMetrics()
932 .getFontRenderContext());
933 g.setFont(ofont.deriveFont(AffineTransform.getScaleInstance(
934 wdth, scl / lm.getAscent())));
935 lm = g.getFontMetrics().getLineMetrics(dc, 0, 1, g);
937 // Debug - render boxes around characters
938 // g.setColor(Color.red);
939 // g.drawRect(x*av.charWidth, (int)ht, av.charWidth,
941 // g.setColor(profcolour.findColour(dc[0]).darker());
942 g.setColor(profcolour.findColour(dc[0], column, null));
944 hght = (ht + (scl - lm.getDescent() - lm.getBaselineOffsets()[lm
945 .getBaselineIndex()]));
947 g.drawChars(dc, 0, dc.length, x * charWidth, (int) hght);
955 if (_aa.threshold != null)
957 g.setColor(_aa.threshold.colour);
958 Graphics2D g2 = (Graphics2D) g;
959 g2.setStroke(new BasicStroke(1, BasicStroke.CAP_SQUARE,
960 BasicStroke.JOIN_ROUND, 3f, new float[]
963 y2 = (int) (y - ((_aa.threshold.value - min) / range)
965 g.drawLine(0, y2, (eRes - sRes) * charWidth, y2);
966 g2.setStroke(new BasicStroke());
970 // used by overview window
971 public void drawGraph(Graphics g, AlignmentAnnotation _aa,
972 Annotation[] aa_annotations, int width, int y, int sRes, int eRes)
974 eRes = Math.min(eRes, aa_annotations.length);
975 g.setColor(Color.white);
976 g.fillRect(0, 0, width, y);
977 g.setColor(new Color(0, 0, 180));
981 for (int j = sRes; j < eRes; j++)
983 if (aa_annotations[j] != null)
985 if (aa_annotations[j].colour == null)
986 g.setColor(Color.black);
988 g.setColor(aa_annotations[j].colour);
990 height = (int) ((aa_annotations[j].value / _aa.graphMax) * y);
996 g.fillRect(x, y - height, charWidth, height);