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.ColumnSelection;
8 import jalview.schemes.ColourSchemeI;
10 import java.awt.BasicStroke;
11 import java.awt.Color;
13 import java.awt.FontMetrics;
14 import java.awt.Graphics;
15 import java.awt.Graphics2D;
16 import java.awt.Image;
17 import java.awt.font.LineMetrics;
18 import java.awt.geom.AffineTransform;
19 import java.awt.image.ImageObserver;
20 import java.util.Hashtable;
22 import com.stevesoft.pat.Regex;
24 public class AnnotationRenderer
27 public AnnotationRenderer()
29 // TODO Auto-generated constructor stub
32 public void drawStemAnnot(Graphics g, AlignmentAnnotation row, int lastSSX, int x, int y, int iconOffset, int startRes, int column, boolean validRes, boolean validEnd)
34 g.setColor(STEM_COLOUR);
35 int sCol = (lastSSX / charWidth) + startRes;
37 int x2 = (x * charWidth);
38 Regex closeparen = new Regex("(\\))");
40 String dc = (column == 0 || row.annotations[column-1]==null) ? ""
41 : row.annotations[column - 1].displayCharacter;
43 boolean diffupstream = sCol == 0 || row.annotations[sCol - 1] == null
44 || !dc.equals(row.annotations[sCol - 1].displayCharacter);
45 boolean diffdownstream = !validRes || !validEnd
46 || row.annotations[column] == null
47 || !dc.equals(row.annotations[column].displayCharacter);
48 // System.out.println("Column "+column+" diff up: "+diffupstream+" down:"+diffdownstream);
49 // If a closing base pair half of the stem, display a backward arrow
50 if (column > 0 && closeparen.search(dc))
53 // if (validRes && column>1 && row.annotations[column-2]!=null &&
54 // dc.equals(row.annotations[column-2].displayCharacter))
56 g.fillPolygon(new int[]
57 { lastSSX + 5, lastSSX + 5, lastSSX }, new int[]
58 { y + iconOffset, y + 14 + iconOffset, y + 8 + iconOffset }, 3);
68 // display a forward arrow
71 g.fillPolygon(new int[]
72 { x2 - 5, x2 - 5, x2 }, new int[]
73 { y + iconOffset, y + 14 + iconOffset, y + 8 + iconOffset }, 3);
82 g.fillRect(x1, y + 4 + iconOffset, x2 - x1, 7);
84 private int charWidth,endRes,charHeight;
85 private boolean validCharWidth, hasHiddenColumns;
86 private FontMetrics fm;
87 private boolean MAC=new jalview.util.Platform().isAMac();
88 boolean av_renderHistogram = true, av_renderProfile = true, av_normaliseProfile=false;
89 ColourSchemeI profcolour=null;
90 private ColumnSelection columnSelection;
91 private Hashtable[] hconsensus;
92 private Hashtable[] hStrucConsensus;
93 private boolean av_ignoreGapsConsensus;
96 * attributes set from AwtRenderPanelI
99 * old image used when data is currently being calculated and cannot be rendered
101 private Image fadedImage;
103 * panel being rendered into
105 private ImageObserver annotationPanel;
107 * width of image to render in panel
109 private int imgWidth;
111 // public void updateFromAnnotationPanel(FontMetrics annotFM, AlignViewportI av)
112 public void updateFromAwtRenderPanel(AwtRenderPanelI annotPanel, AlignViewportI av)
114 fm = annotPanel.getFontMetrics();
115 annotationPanel = annotPanel;
116 fadedImage=annotPanel.getFadedImage();
117 imgWidth=annotPanel.getFadedImageWidth();
118 updateFromAlignViewport(av);
120 public void updateFromAlignViewport(AlignViewportI av)
122 charWidth = av.getCharWidth();
123 endRes = av.getEndRes();
124 charHeight = av.getCharHeight();
125 hasHiddenColumns = av.hasHiddenColumns();
126 validCharWidth = av.isValidCharWidth();
127 av_renderHistogram = av.isShowConsensusHistogram();
128 av_renderProfile = av.isShowSequenceLogo();
129 av_normaliseProfile= av.isNormaliseSequenceLogo();
130 profcolour = av.getGlobalColourScheme();
131 if (profcolour == null)
133 // Set the default colour for sequence logo if the alignnent has no colourscheme set
134 profcolour = av.getAlignment().isNucleotide() ? new jalview.schemes.NucleotideColourScheme() : new jalview.schemes.ZappoColourScheme();
136 columnSelection = av.getColumnSelection();
137 hconsensus = av.getSequenceConsensusHash();//hconsensus;
138 hStrucConsensus = av.getRnaStructureConsensusHash(); //hStrucConsensus;
139 av_ignoreGapsConsensus=av.getIgnoreGapsConsensus();
141 public int[] getProfileFor(AlignmentAnnotation aa, int column)
143 // TODO : consider refactoring the global alignment calculation properties/rendering attributes as a global 'alignment group' which holds all vis settings for the alignment as a whole rather than a subset
145 if (aa.autoCalculated && aa.label.startsWith("Consensus"))
147 if (aa.groupRef != null && aa.groupRef.consensusData != null
148 && aa.groupRef.isShowSequenceLogo())
150 return AAFrequency.extractProfile(
151 aa.groupRef.consensusData[column], aa.groupRef
152 .getIgnoreGapsConsensus());
154 // TODO extend annotation row to enable dynamic and static profile data to
156 if (aa.groupRef == null && aa.sequenceRef == null
159 return AAFrequency.extractProfile(hconsensus[column], av_ignoreGapsConsensus);
164 if (aa.autoCalculated && aa.label.startsWith("StrucConsensus"))
166 if (aa.groupRef != null && aa.groupRef.consensusData != null
167 && aa.groupRef.isShowSequenceLogo())
169 //TODO check what happens for group selections
170 return StructureFrequency.extractProfile(
171 aa.groupRef.consensusData[column], aa.groupRef
172 .getIgnoreGapsConsensus());
174 // TODO extend annotation row to enable dynamic and static profile data
177 if (aa.groupRef == null && aa.sequenceRef == null
180 return StructureFrequency.extractProfile(hStrucConsensus[column],
181 av_ignoreGapsConsensus);
191 * @param annotationPanel TODO
199 public void drawComponent(AwtRenderPanelI annotPanel, AlignViewportI av, Graphics g, int activeRow, int startRes, int endRes)
202 // AnnotationPanel needs to implement: ImageObserver, access to AlignViewport
203 updateFromAwtRenderPanel(annotPanel, av);
204 AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
211 boolean validRes = false;
212 boolean validEnd = false;
213 boolean labelAllCols = false;
214 boolean centreColLabels, centreColLabelsDef = av
215 .getCentreColumnLabels();
216 boolean scaleColLabel = false;
217 boolean[] graphGroupDrawn = new boolean[aa.length];
218 int charOffset = 0; // offset for a label
219 float fmWidth, fmScaling = 1f; // scaling for a label to fit it into a
221 Font ofont = g.getFont();
223 for (int i = 0; i < aa.length; i++)
225 AlignmentAnnotation row = aa[i];
231 centreColLabels = row.centreColLabels || centreColLabelsDef;
232 labelAllCols = row.showAllColLabels;
233 scaleColLabel = row.scaleColLabel;
238 if (row.graphGroup > -1 && graphGroupDrawn[row.graphGroup])
243 // this is so that we draw the characters below the graph
248 iconOffset = charHeight - fm.getDescent();
252 else if (row.hasText)
254 iconOffset = charHeight - fm.getDescent();
262 if (aa[i].autoCalculated && av.isCalculationInProgress(aa[i]))
266 g.drawImage(fadedImage, 0, y - row.height, imgWidth, y, 0, y
267 - row.height, imgWidth, y, annotationPanel);
268 g.setColor(Color.black);
269 // g.drawString("Calculating "+aa[i].label+"....",20, y-row.height/2);
274 /* else if (annotationPanel.av.updatingConservation
275 && aa[i].label.equals("Conservation"))
279 g.drawImage(annotationPanel.fadedImage, 0, y - row.height, annotationPanel.imgWidth, y, 0, y
280 - row.height, annotationPanel.imgWidth, y, annotationPanel);
282 g.setColor(Color.black);
283 // g.drawString("Calculating Conservation.....",20, y-row.height/2);
287 else if (annotationPanel.av.updatingConservation && aa[i].label.equals("Quality"))
291 g.drawImage(annotationPanel.fadedImage, 0, y - row.height, annotationPanel.imgWidth, y, 0, y
292 - row.height, annotationPanel.imgWidth, y, annotationPanel);
293 g.setColor(Color.black);
294 // / g.drawString("Calculating Quality....",20, y-row.height/2);
299 // first pass sets up state for drawing continuation from left-hand column
301 x = (startRes == 0) ? 0 : -1;
302 while (x < endRes - startRes)
304 if (hasHiddenColumns)
306 column = columnSelection.adjustForHiddenColumns(
308 if (column > row.annotations.length - 1)
315 column = startRes + x;
318 if ((row.annotations == null) || (row.annotations.length <= column)
319 || (row.annotations[column] == null))
331 g.setColor(Color.red);
333 if (columnSelection != null)
335 for (int n = 0; n < columnSelection.size(); n++)
337 int v = columnSelection.columnAt(n);
341 g.fillRect(x * charWidth, y, charWidth,
347 if (!row.isValidStruc())
349 g.setColor(Color.orange);
350 g.fillRect((int)row.getInvalidStrucPos()*charWidth, y, charWidth, charHeight);
354 && row.annotations[column].displayCharacter != null
355 && (row.annotations[column].displayCharacter.length() > 0))
358 if (centreColLabels || scaleColLabel)
360 fmWidth = (float) fm.charsWidth(
361 row.annotations[column].displayCharacter
363 row.annotations[column].displayCharacter.length());
367 // justify the label and scale to fit in column
368 if (fmWidth > charWidth)
370 // scale only if the current font isn't already small enough
371 fmScaling = charWidth;
372 fmScaling /= fmWidth;
373 g.setFont(ofont.deriveFont(AffineTransform
374 .getScaleInstance(fmScaling, 1.0)));
375 // and update the label's width to reflect the scaling.
383 .charWidth(row.annotations[column].displayCharacter
386 charOffset = (int) ((charWidth - fmWidth) / 2f);
388 if (row.annotations[column].colour == null)
389 g.setColor(Color.black);
391 g.setColor(row.annotations[column].colour);
393 if (column == 0 || row.graph > 0)
395 g.drawString(row.annotations[column].displayCharacter,
396 (x * charWidth) + charOffset, y + iconOffset);
398 else if (row.annotations[column - 1] == null
400 || !row.annotations[column].displayCharacter
401 .equals(row.annotations[column - 1].displayCharacter) || (row.annotations[column].displayCharacter
402 .length() < 2 && row.annotations[column].secondaryStructure == ' ')))
404 g.drawString(row.annotations[column].displayCharacter, x
405 * charWidth + charOffset, y + iconOffset);
412 char ss = validRes ? row.annotations[column].secondaryStructure
416 // distinguish between forward/backward base-pairing
417 if (row.annotations[column].displayCharacter.indexOf(')') > -1)
422 if (!validRes || (ss != lastSS))
429 drawHelixAnnot(g, row, lastSSX, x, y, iconOffset, startRes,
430 column, validRes, validEnd);
434 drawSheetAnnot(g, row, lastSSX, x, y, iconOffset, startRes,
435 column, validRes, validEnd);
438 case 'S': // Stem case for RNA secondary structure
439 case 's': // and opposite direction
440 drawStemAnnot(g, row, lastSSX, x, y, iconOffset, startRes,
441 column, validRes, validEnd);
445 g.setColor(Color.gray);
446 g.fillRect(lastSSX, y + 6 + iconOffset, (x * charWidth)
462 lastSSX = (x * charWidth);
469 if (column >= row.annotations.length)
471 column = row.annotations.length - 1;
478 if ((row.annotations == null) || (row.annotations.length <= column)
479 || (row.annotations[column] == null))
495 drawHelixAnnot(g, row, lastSSX, x, y, iconOffset, startRes,
496 column, validRes, validEnd);
500 drawSheetAnnot(g, row, lastSSX, x, y, iconOffset, startRes,
501 column, validRes, validEnd);
504 case 'S': // Stem case for RNA secondary structure
505 drawStemAnnot(g, row, lastSSX, x, y, iconOffset, startRes,
506 column, validRes, validEnd);
509 drawGlyphLine(g, row, lastSSX, x, y, iconOffset, startRes,
510 column, validRes, validEnd);
515 if (row.graph > 0 && row.graphHeight > 0)
517 if (row.graph == AlignmentAnnotation.LINE_GRAPH)
519 if (row.graphGroup > -1 && !graphGroupDrawn[row.graphGroup])
521 float groupmax = -999999, groupmin = 9999999;
522 for (int gg = 0; gg < aa.length; gg++)
524 if (aa[gg].graphGroup != row.graphGroup)
531 aa[gg].visible = false;
534 if (aa[gg].graphMax > groupmax)
536 groupmax = aa[gg].graphMax;
538 if (aa[gg].graphMin < groupmin)
540 groupmin = aa[gg].graphMin;
544 for (int gg = 0; gg < aa.length; gg++)
546 if (aa[gg].graphGroup == row.graphGroup)
548 drawLineGraph(g, aa[gg], startRes, endRes, y, groupmin,
549 groupmax, row.graphHeight);
553 graphGroupDrawn[row.graphGroup] = true;
557 drawLineGraph( g, row, startRes, endRes, y, row.graphMin,
558 row.graphMax, row.graphHeight);
561 else if (row.graph == AlignmentAnnotation.BAR_GRAPH)
563 drawBarGraph(g, row, startRes, endRes, row.graphMin,
568 if (row.graph > 0 && row.hasText)
580 private Color GLYPHLINE_COLOR=Color.gray;
581 private Color SHEET_COLOUR=Color.green;
582 private Color HELIX_COLOUR=Color.red;
583 private Color STEM_COLOUR=Color.blue;
586 public void drawGlyphLine(Graphics g, AlignmentAnnotation row, int lastSSX, int x, int y, int iconOffset, int startRes, int column, boolean validRes, boolean validEnd)
588 g.setColor(GLYPHLINE_COLOR);
590 .fillRect(lastSSX, y + 6 + iconOffset, (x * charWidth)
594 public void drawSheetAnnot(Graphics g, AlignmentAnnotation row, int lastSSX, int x, int y, int iconOffset, int startRes, int column, boolean validRes, boolean validEnd)
596 g.setColor(SHEET_COLOUR);
598 if (!validEnd || !validRes || row.annotations[column] == null
599 || row.annotations[column].secondaryStructure != 'E')
601 g.fillRect(lastSSX, y + 4 + iconOffset, (x * charWidth) - lastSSX
605 { (x * charWidth) - 4, (x * charWidth) - 4,
606 (x * charWidth) }, new int[]
607 { y + iconOffset, y + 14 + iconOffset, y + 7 + iconOffset },
612 g.fillRect(lastSSX, y + 4 + iconOffset, (x + 1) * charWidth
618 public void drawHelixAnnot(Graphics g, AlignmentAnnotation row, int lastSSX, int x, int y, int iconOffset, int startRes, int column, boolean validRes, boolean validEnd)
620 g.setColor(HELIX_COLOUR);
622 int sCol = (lastSSX / charWidth) + startRes;
624 int x2 = (x * charWidth);
628 int ofs = charWidth / 2;
629 // Off by 1 offset when drawing rects and ovals
630 // to offscreen image on the MAC
631 g.fillRoundRect(lastSSX, y + 4 + iconOffset, x2 - x1, 8, 8, 8);
632 if (sCol == 0 || row.annotations[sCol - 1] == null
633 || row.annotations[sCol - 1].secondaryStructure != 'H')
638 // g.setColor(Color.orange);
639 g.fillRoundRect(lastSSX, y + 4 + iconOffset, x2 - x1 - ofs + 1, 8,
642 if (!validRes || row.annotations[column] == null
643 || row.annotations[column].secondaryStructure != 'H')
649 // g.setColor(Color.magenta);
650 g.fillRoundRect(lastSSX + ofs, y + 4 + iconOffset, x2 - x1 - ofs
658 if (sCol == 0 || row.annotations[sCol - 1] == null
659 || row.annotations[sCol - 1].secondaryStructure != 'H')
661 g.fillArc(lastSSX, y + 4 + iconOffset, charWidth, 8, 90, 180);
665 if (!validRes || row.annotations[column] == null
666 || row.annotations[column].secondaryStructure != 'H')
668 g.fillArc((x * charWidth) - charWidth, y + 4 + iconOffset,
669 charWidth, 8, 270, 180);
673 g.fillRect(x1, y + 4 + iconOffset, x2 - x1, 8);
676 public void drawLineGraph(Graphics g, AlignmentAnnotation aa, int sRes, int eRes, int y, float min, float max, int graphHeight)
678 if (sRes > aa.annotations.length)
685 // Adjustment for fastpaint to left
691 eRes = Math.min(eRes, aa.annotations.length);
699 float range = max - min;
704 y2 = y - (int) ((0 - min / range) * graphHeight);
707 g.setColor(Color.gray);
708 g.drawLine(x - charWidth, y2, (eRes - sRes + 1) * charWidth, y2);
710 eRes = Math.min(eRes, aa.annotations.length);
713 int aaMax = aa.annotations.length - 1;
715 while (x < eRes - sRes)
718 if (hasHiddenColumns)
720 column = columnSelection.adjustForHiddenColumns(column);
728 if (aa.annotations[column] == null
729 || aa.annotations[column - 1] == null)
735 if (aa.annotations[column].colour == null)
736 g.setColor(Color.black);
738 g.setColor(aa.annotations[column].colour);
741 - (int) (((aa.annotations[column - 1].value - min) / range) * graphHeight);
743 - (int) (((aa.annotations[column].value - min) / range) * graphHeight);
745 g.drawLine(x * charWidth - charWidth / 2, y1, x * charWidth
746 + charWidth / 2, y2);
750 if (aa.threshold != null)
752 g.setColor(aa.threshold.colour);
753 Graphics2D g2 = (Graphics2D) g;
754 g2.setStroke(new BasicStroke(1, BasicStroke.CAP_SQUARE,
755 BasicStroke.JOIN_ROUND, 3f, new float[]
758 y2 = (int) (y - ((aa.threshold.value - min) / range) * graphHeight);
759 g.drawLine(0, y2, (eRes - sRes) * charWidth, y2);
760 g2.setStroke(new BasicStroke());
764 public void drawBarGraph(Graphics g, AlignmentAnnotation aa, int sRes, int eRes, float min, float max, int y)
766 if (sRes > aa.annotations.length)
770 Font ofont = g.getFont();
771 eRes = Math.min(eRes, aa.annotations.length);
773 int x = 0, y1 = y, y2 = y;
775 float range = max - min;
779 y2 = y - (int) ((0 - min / (range)) * aa.graphHeight);
782 g.setColor(Color.gray);
784 g.drawLine(x, y2, (eRes - sRes) * charWidth, y2);
787 int aaMax = aa.annotations.length - 1;
788 boolean renderHistogram = true, renderProfile = true, normaliseProfile=false;
789 // if (aa.autoCalculated && aa.label.startsWith("Consensus"))
791 // TODO: generalise this to have render styles for consensus/profile data
792 if (aa.groupRef != null)
794 renderHistogram = aa.groupRef.isShowConsensusHistogram();
795 renderProfile = aa.groupRef.isShowSequenceLogo();
796 normaliseProfile= aa.groupRef.isNormaliseSequenceLogo();
800 renderHistogram = av_renderHistogram;
801 renderProfile = av_renderProfile;
802 normaliseProfile= av_normaliseProfile;
805 while (x < eRes - sRes)
808 if (hasHiddenColumns)
810 column = columnSelection.adjustForHiddenColumns(column);
818 if (aa.annotations[column] == null)
823 if (aa.annotations[column].colour == null)
824 g.setColor(Color.black);
826 g.setColor(aa.annotations[column].colour);
829 - (int) (((aa.annotations[column].value - min) / (range)) * aa.graphHeight);
835 g.fillRect(x * charWidth, y2, charWidth, y1 - y2);
839 g.fillRect(x * charWidth, y1, charWidth, y2 - y1);
842 // draw profile if available
843 if (renderProfile && aa.annotations[column].value != 0)
846 int profl[] = getProfileFor(aa, column);
847 // just try to draw the logo if profl is not null
851 float ht = normaliseProfile ? y-aa.graphHeight : y1;
852 double htn = normaliseProfile ? aa.graphHeight : (y2 - y1);// aa.graphHeight;
858 * profl.length == 52 indicates that the profile of a secondary
859 * structure conservation row was accesed.
860 * Therefore dc gets length 2, to have space for a basepair instead of
861 * just a single nucleotide
863 if (profl.length == 52)
871 LineMetrics lm=g.getFontMetrics(ofont).getLineMetrics("Q", g);
872 double scale = 1f/(normaliseProfile ? profl[1] : 100f);
873 float ofontHeight = 1f/lm.getAscent();// magnify to fill box
875 for (int c = 2; profl != null && c < profl[0];)
877 dc[0] = (char) profl[c++];
879 if (aa.label.startsWith("StrucConsensus"))
881 dc[1] = (char) profl[c++];
885 wdth /= (float) fm.charsWidth(dc, 0, dc.length);
889 // if (aa.annotations[column].value==0) {
890 // g.setFont(ofont.deriveFont(AffineTransform.getScaleInstance(wdth,
891 // (ht2=(aa.graphHeight*0.1/av.charHeight)))));
894 scl=((double)htn)*scale* ((double) profl[c++]);
895 lm = ofont.getLineMetrics(dc, 0, 1, g.getFontMetrics().getFontRenderContext());
896 g.setFont(ofont.deriveFont(AffineTransform.getScaleInstance(
897 wdth, scl/lm.getAscent())));
898 lm = g.getFontMetrics().getLineMetrics(dc, 0, 1, g);
902 // ? );// try to get a
903 // colourscheme for the
904 // group(aa.groupRef.cs==null)
905 // ? av.textColour2 :
906 // cs.findColour(dc));
907 // System.out.println(dc[0]);
908 // Debug - render boxes around characters
909 // g.setColor(Color.red);
910 // g.drawRect(x*av.charWidth, (int)ht, av.charWidth, (int)(scl));
911 // g.setColor(profcolour.findColour(dc[0]).darker());
912 g.setColor(profcolour.findColour(dc[0]));
913 // (av.globalColourScheme!=null)
914 g.drawChars(dc, 0, dc.length, x * charWidth,
915 (int) (ht + (scl-lm.getDescent()-lm.getBaselineOffsets()[lm.getBaselineIndex()])));
916 // ht+=g.getFontMetrics().getAscent()-g.getFontMetrics().getDescent();
924 if (aa.threshold != null)
926 g.setColor(aa.threshold.colour);
927 Graphics2D g2 = (Graphics2D) g;
928 g2.setStroke(new BasicStroke(1, BasicStroke.CAP_SQUARE,
929 BasicStroke.JOIN_ROUND, 3f, new float[]
932 y2 = (int) (y - ((aa.threshold.value - min) / range) * aa.graphHeight);
933 g.drawLine(0, y2, (eRes - sRes) * charWidth, y2);
934 g2.setStroke(new BasicStroke());
937 // used by overview window
938 public void drawGraph(Graphics g, AlignmentAnnotation aa, int width,
939 int y, int sRes, int eRes)
941 eRes = Math.min(eRes, aa.annotations.length);
942 g.setColor(Color.white);
943 g.fillRect(0, 0, width, y);
944 g.setColor(new Color(0, 0, 180));
948 for (int j = sRes; j < eRes; j++)
950 if (aa.annotations[j] != null)
952 if (aa.annotations[j].colour == null)
953 g.setColor(Color.black);
955 g.setColor(aa.annotations[j].colour);
957 height = (int) ((aa.annotations[j].value / aa.graphMax) * y);
963 g.fillRect(x, y - height, charWidth, height);