src/jalview/renderer/OverviewRenderer.java

   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 jalview.api.AlignmentColsCollectionI;
  24 import jalview.api.AlignmentRowsCollectionI;
  25 import jalview.datamodel.AlignmentAnnotation;
  26 import jalview.datamodel.Annotation;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.renderer.seqfeatures.FeatureColourFinder;
  29 import jalview.renderer.seqfeatures.FeatureRenderer;
  30 import jalview.viewmodel.OverviewDimensions;
  31
  32 import java.awt.Color;
  33 import java.awt.Graphics;
  34 import java.awt.image.BufferedImage;
  35
  36 public class OverviewRenderer
  37 {
  38   private FeatureColourFinder finder;
  39
  40   private jalview.api.SequenceRenderer sr;
  41
  42   // image to render on
  43   private BufferedImage miniMe;
  44
  45   // raw number of pixels to allocate to each column
  46   private float pixelsPerCol;
  47
  48   // raw number of pixels to allocate to each row
  49   private float pixelsPerSeq;
  50
  51   public OverviewRenderer(jalview.api.SequenceRenderer seqRenderer,
  52           FeatureRenderer ftRenderer, OverviewDimensions od)
  53   {
  54     sr = seqRenderer;
  55     finder = new FeatureColourFinder(ftRenderer);
  56
  57     pixelsPerCol = od.getPixelsPerCol();
  58     pixelsPerSeq = od.getPixelsPerSeq();
  59     miniMe = new BufferedImage(od.getWidth(), od.getHeight(),
  60             BufferedImage.TYPE_INT_RGB);
  61   }
  62
  63   /**
  64    * Draw alignment rows and columns onto an image
  65    *
  66    * @param rit
  67    *          Iterator over rows to be drawn
  68    * @param cit
  69    *          Iterator over columns to be drawn
  70    * @return image containing the drawing
  71    */
  72   public BufferedImage draw(AlignmentRowsCollectionI rows,
  73           AlignmentColsCollectionI cols)
  74   {
  75     int rgbcolor = Color.white.getRGB();
  76     int seqIndex = 0;
  77     int pixelRow = 0;
  78     for (int alignmentRow : rows)
  79     {
  80       // get details of this alignment row
  81       boolean hidden = rows.isHidden(alignmentRow);
  82       SequenceI seq = rows.getSequence(alignmentRow);
  83
  84       // calculate where this row extends to in pixels
  85       int endRow = Math.min(Math.round((seqIndex + 1) * pixelsPerSeq) - 1,
  86               miniMe.getHeight() - 1);
  87
  88       int colIndex = 0;
  89       int pixelCol = 0;
  90       for (int alignmentCol : cols)
  91       {
  92         // calculate where this column extends to in pixels
  93         int endCol = Math.min(
  94                 Math.round((colIndex + 1) * pixelsPerCol) - 1,
  95                 miniMe.getWidth() - 1);
  96
  97         // determine the colour based on the sequence and column position
  98         rgbcolor = getColumnColourFromSequence(seq,
  99                 hidden || cols.isHidden(alignmentCol), alignmentCol, finder);
 100
 101         // fill in the appropriate number of pixels
 102         for (int row = pixelRow; row <= endRow; ++row)
 103         {
 104           for (int col = pixelCol; col <= endCol; ++col)
 105           {
 106             miniMe.setRGB(col, row, rgbcolor);
 107           }
 108         }
 109
 110         pixelCol = endCol + 1;
 111         colIndex++;
 112       }
 113       pixelRow = endRow + 1;
 114       seqIndex++;
 115     }
 116     return miniMe;
 117   }
 118
 119   /*
 120    * Find the colour of a sequence at a specified column position
 121    */
 122   private int getColumnColourFromSequence(jalview.datamodel.SequenceI seq,
 123           boolean isHidden, int lastcol, FeatureColourFinder fcfinder)
 124   {
 125     Color color = Color.white;
 126
 127     if ((seq != null) && (seq.getLength() > lastcol))
 128     {
 129       color = sr.getResidueColour(seq, lastcol, fcfinder);
 130     }
 131
 132     if (isHidden)
 133     {
 134       color = color.darker().darker();
 135     }
 136
 137     return color.getRGB();
 138   }
 139
 140   /**
 141    * Draw the alignment annotation in the overview panel
 142    *
 143    * @param g
 144    *          the graphics object to draw on
 145    * @param anno
 146    *          alignment annotation information
 147    * @param charWidth
 148    *          alignment character width value
 149    * @param y
 150    *          y-position for the annotation graph
 151    * @param cols
 152    *          the collection of columns used in the overview panel
 153    */
 154   public void drawGraph(Graphics g, AlignmentAnnotation anno, int charWidth,
 155           int y, AlignmentColsCollectionI cols)
 156   {
 157     Annotation[] annotations = anno.annotations;
 158     g.setColor(Color.white);
 159     g.fillRect(0, 0, miniMe.getWidth(), y);
 160
 161     int height;
 162     int colIndex = 0;
 163     int pixelCol = 0;
 164     for (int alignmentCol : cols)
 165     {
 166       if (alignmentCol >= annotations.length)
 167       {
 168         break; // no more annotations to draw here
 169       }
 170       else
 171       {
 172         int endCol = Math.min(
 173                 Math.round((colIndex + 1) * pixelsPerCol) - 1,
 174                 miniMe.getWidth() - 1);
 175
 176         if (annotations[alignmentCol] != null)
 177         {
 178           if (annotations[alignmentCol].colour == null)
 179           {
 180             g.setColor(Color.black);
 181           }
 182           else
 183           {
 184             g.setColor(annotations[alignmentCol].colour);
 185           }
 186
 187           height = (int) ((annotations[alignmentCol].value / anno.graphMax) * y);
 188           if (height > y)
 189           {
 190             height = y;
 191           }
 192
 193           g.fillRect(pixelCol, y - height, endCol - pixelCol + 1, height);
 194         }
 195         pixelCol = endCol + 1;
 196         colIndex++;
 197       }
 198     }
 199   }
 200 }