src/jalview/schemes/AnnotationColourGradient.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.schemes;
  22
  23 import jalview.datamodel.AlignmentAnnotation;
  24 import jalview.datamodel.AlignmentI;
  25 import jalview.datamodel.AnnotatedCollectionI;
  26 import jalview.datamodel.Annotation;
  27 import jalview.datamodel.GraphLine;
  28 import jalview.datamodel.SequenceCollectionI;
  29 import jalview.datamodel.SequenceI;
  30
  31 import java.awt.Color;
  32 import java.util.IdentityHashMap;
  33 import java.util.Map;
  34
  35 public class AnnotationColourGradient extends FollowerColourScheme
  36 {
  37   public static final int NO_THRESHOLD = -1;
  38
  39   public static final int BELOW_THRESHOLD = 0;
  40
  41   public static final int ABOVE_THRESHOLD = 1;
  42
  43   public AlignmentAnnotation annotation;
  44
  45   int aboveAnnotationThreshold = -1;
  46
  47   public boolean thresholdIsMinMax = false;
  48
  49   GraphLine annotationThreshold;
  50
  51   float r1, g1, b1, rr, gg, bb;
  52
  53   private boolean predefinedColours = false;
  54
  55   private boolean seqAssociated = false;
  56   /**
  57    * false if the scheme was constructed without a minColour and maxColour used
  58    * to decide if existing colours should be taken from annotation elements when
  59    * they exist
  60    */
  61   private boolean noGradient = false;
  62   IdentityHashMap<SequenceI, AlignmentAnnotation> seqannot = null;
  63
  64   @Override
  65   public ColourSchemeI applyTo(AnnotatedCollectionI sg,
  66           Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
  67   {
  68     AnnotationColourGradient acg = new AnnotationColourGradient(annotation,
  69             colourScheme, aboveAnnotationThreshold);
  70     acg.thresholdIsMinMax = thresholdIsMinMax;
  71     acg.annotationThreshold = (annotationThreshold == null) ? null
  72             : new GraphLine(annotationThreshold);
  73     acg.r1 = r1;
  74     acg.g1 = g1;
  75     acg.b1 = b1;
  76     acg.rr = rr;
  77     acg.gg = gg;
  78     acg.bb = bb;
  79     acg.predefinedColours = predefinedColours;
  80     acg.seqAssociated = seqAssociated;
  81     acg.noGradient = noGradient;
  82     return acg;
  83   }
  84
  85   /**
  86    * Creates a new AnnotationColourGradient object.
  87    */
  88   public AnnotationColourGradient(AlignmentAnnotation annotation,
  89           ColourSchemeI originalColour, int aboveThreshold)
  90   {
  91     if (originalColour instanceof AnnotationColourGradient)
  92     {
  93       colourScheme = ((AnnotationColourGradient) originalColour).colourScheme;
  94     }
  95     else
  96     {
  97       colourScheme = originalColour;
  98     }
  99
 100     this.annotation = annotation;
 101
 102     aboveAnnotationThreshold = aboveThreshold;
 103
 104     if (aboveThreshold != NO_THRESHOLD && annotation.threshold != null)
 105     {
 106       annotationThreshold = annotation.threshold;
 107     }
 108     // clear values so we don't get weird black bands...
 109     r1 = 254;
 110     g1 = 254;
 111     b1 = 254;
 112     rr = 0;
 113     gg = 0;
 114     bb = 0;
 115
 116     noGradient = true;
 117   }
 118
 119   /**
 120    * Creates a new AnnotationColourGradient object.
 121    */
 122   public AnnotationColourGradient(AlignmentAnnotation annotation,
 123           Color minColour, Color maxColour, int aboveThreshold)
 124   {
 125     this.annotation = annotation;
 126
 127     aboveAnnotationThreshold = aboveThreshold;
 128
 129     if (aboveThreshold != NO_THRESHOLD && annotation.threshold != null)
 130     {
 131       annotationThreshold = annotation.threshold;
 132     }
 133
 134     r1 = minColour.getRed();
 135     g1 = minColour.getGreen();
 136     b1 = minColour.getBlue();
 137
 138     rr = maxColour.getRed() - r1;
 139     gg = maxColour.getGreen() - g1;
 140     bb = maxColour.getBlue() - b1;
 141
 142     noGradient = false;
 143     aamax = annotation.graphMax;
 144     aamin = annotation.graphMin;
 145     if (annotation.isRNA())
 146     {
 147       ColourSchemeProperty.initRnaHelicesShading(1 + (int) aamax);
 148     }
 149   }
 150
 151   @Override
 152   public void alignmentChanged(AnnotatedCollectionI alignment,
 153           Map<SequenceI, SequenceCollectionI> hiddenReps)
 154   {
 155     super.alignmentChanged(alignment, hiddenReps);
 156
 157     if (seqAssociated && annotation.getCalcId() != null)
 158     {
 159       if (seqannot != null)
 160       {
 161         seqannot.clear();
 162       }
 163       else
 164       {
 165         seqannot = new IdentityHashMap<SequenceI, AlignmentAnnotation>();
 166       }
 167       // resolve the context containing all the annotation for the sequence
 168       AnnotatedCollectionI alcontext = alignment instanceof AlignmentI ? alignment
 169               : alignment.getContext();
 170       boolean f = true,rna=false;
 171       for (AlignmentAnnotation alan : alcontext.findAnnotation(annotation
 172               .getCalcId()))
 173       {
 174         if (alan.sequenceRef != null
 175                 && (alan.label != null && annotation != null && alan.label
 176                         .equals(annotation.label)))
 177         {
 178           if (!rna && alan.isRNA())
 179           {
 180             rna = true;
 181           }
 182           seqannot.put(alan.sequenceRef, alan);
 183           if (f || alan.graphMax > aamax)
 184           {
 185             aamax = alan.graphMax;
 186           }
 187           if (f || alan.graphMin < aamin)
 188           {
 189             aamin = alan.graphMin;
 190           }
 191           f = false;
 192         }
 193       }
 194       if (rna)
 195       {
 196         ColourSchemeProperty.resetRnaHelicesShading();
 197         ColourSchemeProperty.initRnaHelicesShading(1 + (int) aamax);
 198       }
 199     }
 200   }
 201
 202   float aamin = 0f, aamax = 0f;
 203   public String getAnnotation()
 204   {
 205     return annotation.label;
 206   }
 207
 208   public int getAboveThreshold()
 209   {
 210     return aboveAnnotationThreshold;
 211   }
 212
 213   public float getAnnotationThreshold()
 214   {
 215     if (annotationThreshold == null)
 216     {
 217       return 0;
 218     }
 219     else
 220     {
 221       return annotationThreshold.value;
 222     }
 223   }
 224
 225   public Color getMinColour()
 226   {
 227     return new Color((int) r1, (int) g1, (int) b1);
 228   }
 229
 230   public Color getMaxColour()
 231   {
 232     return new Color((int) (r1 + rr), (int) (g1 + gg), (int) (b1 + bb));
 233   }
 234
 235   /**
 236    * DOCUMENT ME!
 237    *
 238    * @param n
 239    *          DOCUMENT ME!
 240    *
 241    * @return DOCUMENT ME!
 242    */
 243   public Color findColour(char c)
 244   {
 245     return Color.red;
 246   }
 247
 248   /**
 249    * DOCUMENT ME!
 250    *
 251    * @param n
 252    *          DOCUMENT ME!
 253    * @param j
 254    *          DOCUMENT ME!
 255    *
 256    * @return DOCUMENT ME!
 257    */
 258   @Override
 259   public Color findColour(char c, int j, SequenceI seq)
 260   {
 261     Color currentColour = Color.white;
 262     AlignmentAnnotation annotation = (seqAssociated && seqannot!=null ? seqannot.get(seq)
 263             : this.annotation);
 264     if (annotation == null)
 265     {
 266       return currentColour;
 267     }
 268     if ((threshold == 0) || aboveThreshold(c, j))
 269     {
 270       if (annotation.annotations != null
 271               && j < annotation.annotations.length
 272               && annotation.annotations[j] != null
 273               && !jalview.util.Comparison.isGap(c))
 274       {
 275         Annotation aj = annotation.annotations[j];
 276         // 'use original colours' => colourScheme != null
 277         // -> look up colour to be used
 278         // predefined colours => preconfigured shading
 279         // -> only use original colours reference if thresholding enabled &
 280         // minmax exists
 281         // annotation.hasIcons => null or black colours replaced with glyph
 282         // colours
 283         // -> reuse original colours if present
 284         // -> if thresholding enabled then return colour on non-whitespace glyph
 285
 286         if (aboveAnnotationThreshold == NO_THRESHOLD
 287                 || (annotationThreshold != null && (aboveAnnotationThreshold == ABOVE_THRESHOLD ? aj.value >= annotationThreshold.value
 288                         : aj.value <= annotationThreshold.value)))
 289         {
 290           if (predefinedColours && aj.colour != null
 291                   && !aj.colour.equals(Color.black))
 292           {
 293             currentColour = aj.colour;
 294           }
 295           else if (annotation.hasIcons
 296                   && annotation.graph == AlignmentAnnotation.NO_GRAPH)
 297           {
 298             if (aj.secondaryStructure > ' ' && aj.secondaryStructure != '.'
 299                     && aj.secondaryStructure != '-')
 300             {
 301               if (colourScheme != null)
 302               {
 303                 currentColour = colourScheme.findColour(c, j, seq);
 304               }
 305               else
 306               {
 307                 if (annotation.isRNA())
 308                 {
 309                   currentColour = ColourSchemeProperty.rnaHelices[(int) aj.value];
 310                 }
 311                 else
 312                 {
 313                   currentColour = annotation.annotations[j].secondaryStructure == 'H' ? jalview.renderer.AnnotationRenderer.HELIX_COLOUR
 314                           : annotation.annotations[j].secondaryStructure == 'E' ? jalview.renderer.AnnotationRenderer.SHEET_COLOUR
 315                                   : jalview.renderer.AnnotationRenderer.STEM_COLOUR;
 316                 }
 317               }
 318             }
 319             else
 320             {
 321               //
 322               return Color.white;
 323             }
 324           }
 325           else if (noGradient)
 326           {
 327             if (colourScheme != null)
 328             {
 329               currentColour = colourScheme.findColour(c, j, seq);
 330             }
 331             else
 332             {
 333               if (aj.colour != null)
 334               {
 335                 currentColour = aj.colour;
 336               }
 337             }
 338           }
 339           else
 340           {
 341             currentColour = shadeCalculation(annotation, j);
 342           }
 343         }
 344         if (conservationColouring)
 345         {
 346           currentColour = applyConservation(currentColour, j);
 347         }
 348       }
 349     }
 350     return currentColour;
 351   }
 352
 353   private Color shadeCalculation(AlignmentAnnotation annotation, int j)
 354   {
 355
 356     // calculate a shade
 357     float range = 1f;
 358     if (thresholdIsMinMax
 359             && annotation.threshold != null
 360             && aboveAnnotationThreshold == ABOVE_THRESHOLD
 361             && annotation.annotations[j].value >= annotation.threshold.value)
 362     {
 363       range = (annotation.annotations[j].value - annotation.threshold.value)
 364               / (annotation.graphMax - annotation.threshold.value);
 365     }
 366     else if (thresholdIsMinMax && annotation.threshold != null
 367             && aboveAnnotationThreshold == BELOW_THRESHOLD
 368             && annotation.annotations[j].value >= annotation.graphMin)
 369     {
 370       range = (annotation.annotations[j].value - annotation.graphMin)
 371               / (annotation.threshold.value - annotation.graphMin);
 372     }
 373     else
 374     {
 375       if (annotation.graphMax != annotation.graphMin)
 376       {
 377         range = (annotation.annotations[j].value - annotation.graphMin)
 378                 / (annotation.graphMax - annotation.graphMin);
 379       }
 380       else
 381       {
 382         range = 0f;
 383       }
 384     }
 385
 386     int dr = (int) (rr * range + r1), dg = (int) (gg * range + g1), db = (int) (bb
 387             * range + b1);
 388
 389     return new Color(dr, dg, db);
 390
 391   }
 392   public boolean isPredefinedColours()
 393   {
 394     return predefinedColours;
 395   }
 396
 397   public void setPredefinedColours(boolean predefinedColours)
 398   {
 399     this.predefinedColours = predefinedColours;
 400   }
 401
 402   public boolean isSeqAssociated()
 403   {
 404     return seqAssociated;
 405   }
 406
 407   public void setSeqAssociated(boolean sassoc)
 408   {
 409     seqAssociated = sassoc;
 410   }
 411 }