src/jalview/schemes/AnnotationColourGradient.java

   1 /*\r
   2 * Jalview - A Sequence Alignment Editor and Viewer\r
   3 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4 *\r
   5 * This program is free software; you can redistribute it and/or\r
   6 * modify it under the terms of the GNU General Public License\r
   7 * as published by the Free Software Foundation; either version 2\r
   8 * of the License, or (at your option) any later version.\r
   9 *\r
  10 * This program is distributed in the hope that it will be useful,\r
  11 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13 * GNU General Public License for more details.\r
  14 *\r
  15 * You should have received a copy of the GNU General Public License\r
  16 * along with this program; if not, write to the Free Software\r
  17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18 */\r
  19 package jalview.schemes;\r
  20 \r
  21 import java.awt.*;\r
  22 \r
  23 import jalview.datamodel.*;\r
  24 \r
  25 public class AnnotationColourGradient extends ResidueColourScheme\r
  26 {\r
  27     public static int NO_THRESHOLD = -1;\r
  28     public static int BELOW_THRESHOLD = 0;\r
  29     public static int ABOVE_THRESHOLD = 1;\r
  30 \r
  31     AlignmentAnnotation annotation;\r
  32     int aboveAnnotationThreshold = -1;\r
  33 \r
  34     GraphLine annotationThreshold;\r
  35 \r
  36     float r1, g1, b1, rr, gg, bb, dr, dg, db;\r
  37     float range = 0;\r
  38 \r
  39     ColourSchemeI colourScheme;\r
  40 \r
  41     /**\r
  42      * Creates a new AnnotationColourGradient object.\r
  43      */\r
  44     public AnnotationColourGradient(AlignmentAnnotation annotation,\r
  45                                     ColourSchemeI originalColour,\r
  46                                     int aboveThreshold)\r
  47     {\r
  48       if(originalColour instanceof AnnotationColourGradient)\r
  49       {\r
  50         colourScheme = ((AnnotationColourGradient)originalColour).colourScheme;\r
  51       }\r
  52       else\r
  53         colourScheme = originalColour;\r
  54 \r
  55       this.annotation = annotation;\r
  56 \r
  57       aboveAnnotationThreshold = aboveThreshold;\r
  58 \r
  59       if(aboveThreshold!=NO_THRESHOLD && annotation.threshold!=null)\r
  60         annotationThreshold = annotation.threshold;\r
  61     }\r
  62 \r
  63     /**\r
  64      * Creates a new AnnotationColourGradient object.\r
  65      */\r
  66     public AnnotationColourGradient(AlignmentAnnotation annotation,\r
  67         Color minColour, Color maxColour, int aboveThreshold)\r
  68     {\r
  69       this.annotation = annotation;\r
  70 \r
  71       aboveAnnotationThreshold = aboveThreshold;\r
  72 \r
  73       if(aboveThreshold!=NO_THRESHOLD && annotation.threshold!=null)\r
  74         annotationThreshold = annotation.threshold;\r
  75 \r
  76       r1 = minColour.getRed();\r
  77       g1 = minColour.getGreen();\r
  78       b1 = minColour.getBlue();\r
  79 \r
  80       rr = maxColour.getRed() - r1;\r
  81       gg = maxColour.getGreen() - g1;\r
  82       bb = maxColour.getBlue() - b1;\r
  83 \r
  84       range = annotation.graphMax - annotation.graphMin;\r
  85 \r
  86     }\r
  87 \r
  88     public Color getMinColour()\r
  89     {\r
  90       return new Color( (int) r1, (int) g1, (int) b1);\r
  91     }\r
  92 \r
  93     public Color getMaxColour()\r
  94     {\r
  95       return new Color( (int) (r1 + rr), (int) (g1 + gg), (int) (b1 + bb));\r
  96     }\r
  97 \r
  98     /**\r
  99      * DOCUMENT ME!\r
 100      *\r
 101      * @param n DOCUMENT ME!\r
 102      *\r
 103      * @return DOCUMENT ME!\r
 104      */\r
 105     public Color findColour(String n)\r
 106     {\r
 107         return Color.red;\r
 108     }\r
 109 \r
 110     /**\r
 111      * DOCUMENT ME!\r
 112      *\r
 113      * @param n DOCUMENT ME!\r
 114      * @param j DOCUMENT ME!\r
 115      *\r
 116      * @return DOCUMENT ME!\r
 117      */\r
 118     public Color findColour(String n, int j)\r
 119     {\r
 120         if ((threshold == 0) || aboveThreshold(n, j))\r
 121         {\r
 122           if( j+1>annotation.annotations.length || annotation.annotations[j]==null)\r
 123             currentColour = Color.white;\r
 124           else\r
 125           {\r
 126             if(  aboveAnnotationThreshold==NO_THRESHOLD\r
 127                || (annotationThreshold!=null && aboveAnnotationThreshold==ABOVE_THRESHOLD && annotation.annotations[j].value>=annotationThreshold.value)\r
 128                || (annotationThreshold!=null && aboveAnnotationThreshold==BELOW_THRESHOLD && annotation.annotations[j].value<=annotationThreshold.value))\r
 129             {\r
 130               if(colourScheme!=null)\r
 131               {\r
 132                 currentColour = colourScheme.findColour(n, j);\r
 133               }\r
 134               else if(range!=0)\r
 135               {\r
 136                 dr = rr *\r
 137                     ( (annotation.annotations[j].value - annotation.graphMin) /\r
 138                      range)\r
 139                     + r1;\r
 140                 dg = gg *\r
 141                     ( (annotation.annotations[j].value - annotation.graphMin) /\r
 142                      range)\r
 143                     + g1;\r
 144                 db = bb *\r
 145                     ( (annotation.annotations[j].value - annotation.graphMin) /\r
 146                      range)\r
 147                     + b1;\r
 148 \r
 149                 currentColour = new Color( (int) dr, (int) dg, (int) db);\r
 150               }\r
 151               else\r
 152                 currentColour = Color.white;\r
 153             }\r
 154             else\r
 155               currentColour = Color.white;\r
 156           }\r
 157         }\r
 158         else\r
 159         {\r
 160             return Color.white;\r
 161         }\r
 162 \r
 163         if(conservationColouring)\r
 164          applyConservation(j);\r
 165 \r
 166        return currentColour;\r
 167     }\r
 168 }\r