JAL-1925 update source version in license
[jalview.git] / src / jalview / schemes / AnnotationColourGradient.java
index e975884..5f1c886 100755 (executable)
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b2)
+ * Copyright (C) 2015 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
@@ -23,6 +23,7 @@ package jalview.schemes;
 import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.AnnotatedCollectionI;
+import jalview.datamodel.Annotation;
 import jalview.datamodel.GraphLine;
 import jalview.datamodel.SequenceCollectionI;
 import jalview.datamodel.SequenceI;
@@ -47,12 +48,19 @@ public class AnnotationColourGradient extends FollowerColourScheme
 
   GraphLine annotationThreshold;
 
-  float r1, g1, b1, rr, gg, bb, dr, dg, db;
+  float r1, g1, b1, rr, gg, bb;
 
   private boolean predefinedColours = false;
 
   private boolean seqAssociated = false;
 
+  /**
+   * false if the scheme was constructed without a minColour and maxColour used
+   * to decide if existing colours should be taken from annotation elements when
+   * they exist
+   */
+  private boolean noGradient = false;
+
   IdentityHashMap<SequenceI, AlignmentAnnotation> seqannot = null;
 
   @Override
@@ -70,12 +78,9 @@ public class AnnotationColourGradient extends FollowerColourScheme
     acg.rr = rr;
     acg.gg = gg;
     acg.bb = bb;
-    acg.dr = dr;
-    acg.dg = dg;
-    acg.db = db;
     acg.predefinedColours = predefinedColours;
     acg.seqAssociated = seqAssociated;
-
+    acg.noGradient = noGradient;
     return acg;
   }
 
@@ -102,6 +107,16 @@ public class AnnotationColourGradient extends FollowerColourScheme
     {
       annotationThreshold = annotation.threshold;
     }
+    // clear values so we don't get weird black bands...
+    r1 = 254;
+    g1 = 254;
+    b1 = 254;
+    rr = 0;
+    gg = 0;
+    bb = 0;
+
+    noGradient = true;
+    checkLimits();
   }
 
   /**
@@ -126,6 +141,21 @@ public class AnnotationColourGradient extends FollowerColourScheme
     rr = maxColour.getRed() - r1;
     gg = maxColour.getGreen() - g1;
     bb = maxColour.getBlue() - b1;
+
+    noGradient = false;
+    checkLimits();
+  }
+
+  private void checkLimits()
+  {
+    aamax = annotation.graphMax;
+    aamin = annotation.graphMin;
+    if (annotation.isRNA())
+    {
+      // reset colour palette
+      ColourSchemeProperty.resetRnaHelicesShading();
+      ColourSchemeProperty.initRnaHelicesShading(1 + (int) aamax);
+    }
   }
 
   @Override
@@ -147,6 +177,7 @@ public class AnnotationColourGradient extends FollowerColourScheme
       // resolve the context containing all the annotation for the sequence
       AnnotatedCollectionI alcontext = alignment instanceof AlignmentI ? alignment
               : alignment.getContext();
+      boolean f = true, rna = false;
       for (AlignmentAnnotation alan : alcontext.findAnnotation(annotation
               .getCalcId()))
       {
@@ -154,12 +185,31 @@ public class AnnotationColourGradient extends FollowerColourScheme
                 && (alan.label != null && annotation != null && alan.label
                         .equals(annotation.label)))
         {
+          if (!rna && alan.isRNA())
+          {
+            rna = true;
+          }
           seqannot.put(alan.sequenceRef, alan);
+          if (f || alan.graphMax > aamax)
+          {
+            aamax = alan.graphMax;
+          }
+          if (f || alan.graphMin < aamin)
+          {
+            aamin = alan.graphMin;
+          }
+          f = false;
         }
       }
+      if (rna)
+      {
+        ColourSchemeProperty.initRnaHelicesShading(1 + (int) aamax);
+      }
     }
   }
 
+  float aamin = 0f, aamax = 0f;
+
   public String getAnnotation()
   {
     return annotation.label;
@@ -219,8 +269,8 @@ public class AnnotationColourGradient extends FollowerColourScheme
   public Color findColour(char c, int j, SequenceI seq)
   {
     Color currentColour = Color.white;
-    AlignmentAnnotation annotation = (seqAssociated ? seqannot.get(seq)
-            : this.annotation);
+    AlignmentAnnotation annotation = (seqAssociated && seqannot != null ? seqannot
+            .get(seq) : this.annotation);
     if (annotation == null)
     {
       return currentColour;
@@ -232,72 +282,122 @@ public class AnnotationColourGradient extends FollowerColourScheme
               && annotation.annotations[j] != null
               && !jalview.util.Comparison.isGap(c))
       {
+        Annotation aj = annotation.annotations[j];
+        // 'use original colours' => colourScheme != null
+        // -> look up colour to be used
+        // predefined colours => preconfigured shading
+        // -> only use original colours reference if thresholding enabled &
+        // minmax exists
+        // annotation.hasIcons => null or black colours replaced with glyph
+        // colours
+        // -> reuse original colours if present
+        // -> if thresholding enabled then return colour on non-whitespace glyph
 
-        if (annotation.annotations[j].colour != null)
-        {
-          if (predefinedColours || annotation.hasIcons)
-          {
-            return annotation.annotations[j].colour;
-          }
-        }
-        else
-        {
-          if (predefinedColours)
-          {
-            return currentColour;
-          }
-        }
         if (aboveAnnotationThreshold == NO_THRESHOLD
-                || (annotationThreshold != null
-                        && aboveAnnotationThreshold == ABOVE_THRESHOLD && annotation.annotations[j].value >= annotationThreshold.value)
-                || (annotationThreshold != null
-                        && aboveAnnotationThreshold == BELOW_THRESHOLD && annotation.annotations[j].value <= annotationThreshold.value))
+                || (annotationThreshold != null && (aboveAnnotationThreshold == ABOVE_THRESHOLD ? aj.value >= annotationThreshold.value
+                        : aj.value <= annotationThreshold.value)))
         {
-
-          float range = 1f;
-          if (thresholdIsMinMax
-                  && annotation.threshold != null
-                  && aboveAnnotationThreshold == ABOVE_THRESHOLD
-                  && annotation.annotations[j].value >= annotation.threshold.value)
+          if (predefinedColours && aj.colour != null
+                  && !aj.colour.equals(Color.black))
           {
-            range = (annotation.annotations[j].value - annotation.threshold.value)
-                    / (annotation.graphMax - annotation.threshold.value);
+            currentColour = aj.colour;
           }
-          else if (thresholdIsMinMax && annotation.threshold != null
-                  && aboveAnnotationThreshold == BELOW_THRESHOLD
-                  && annotation.annotations[j].value >= annotation.graphMin)
+          else if (annotation.hasIcons
+                  && annotation.graph == AlignmentAnnotation.NO_GRAPH)
           {
-            range = (annotation.annotations[j].value - annotation.graphMin)
-                    / (annotation.threshold.value - annotation.graphMin);
+            if (aj.secondaryStructure > ' ' && aj.secondaryStructure != '.'
+                    && aj.secondaryStructure != '-')
+            {
+              if (colourScheme != null)
+              {
+                currentColour = colourScheme.findColour(c, j, seq);
+              }
+              else
+              {
+                if (annotation.isRNA())
+                {
+                  currentColour = ColourSchemeProperty.rnaHelices[(int) aj.value];
+                }
+                else
+                {
+                  currentColour = annotation.annotations[j].secondaryStructure == 'H' ? jalview.renderer.AnnotationRenderer.HELIX_COLOUR
+                          : annotation.annotations[j].secondaryStructure == 'E' ? jalview.renderer.AnnotationRenderer.SHEET_COLOUR
+                                  : jalview.renderer.AnnotationRenderer.STEM_COLOUR;
+                }
+              }
+            }
+            else
+            {
+              //
+              return Color.white;
+            }
           }
-          else
+          else if (noGradient)
           {
-            range = (annotation.annotations[j].value - annotation.graphMin)
-                    / (annotation.graphMax - annotation.graphMin);
-          }
-
-          if (colourScheme != null)
-          {
-            currentColour = colourScheme.findColour(c, j, seq);
+            if (colourScheme != null)
+            {
+              currentColour = colourScheme.findColour(c, j, seq);
+            }
+            else
+            {
+              if (aj.colour != null)
+              {
+                currentColour = aj.colour;
+              }
+            }
           }
           else
           {
-            dr = rr * range + r1;
-            dg = gg * range + g1;
-            db = bb * range + b1;
-
-            currentColour = new Color((int) dr, (int) dg, (int) db);
+            currentColour = shadeCalculation(annotation, j);
           }
         }
+        if (conservationColouring)
+        {
+          currentColour = applyConservation(currentColour, j);
+        }
       }
     }
+    return currentColour;
+  }
+
+  private Color shadeCalculation(AlignmentAnnotation annotation, int j)
+  {
 
-    if (conservationColouring)
+    // calculate a shade
+    float range = 1f;
+    if (thresholdIsMinMax
+            && annotation.threshold != null
+            && aboveAnnotationThreshold == ABOVE_THRESHOLD
+            && annotation.annotations[j].value >= annotation.threshold.value)
     {
-      currentColour = applyConservation(currentColour, j);
+      range = (annotation.annotations[j].value - annotation.threshold.value)
+              / (annotation.graphMax - annotation.threshold.value);
+    }
+    else if (thresholdIsMinMax && annotation.threshold != null
+            && aboveAnnotationThreshold == BELOW_THRESHOLD
+            && annotation.annotations[j].value >= annotation.graphMin)
+    {
+      range = (annotation.annotations[j].value - annotation.graphMin)
+              / (annotation.threshold.value - annotation.graphMin);
+    }
+    else
+    {
+      if (annotation.graphMax != annotation.graphMin)
+      {
+        range = (annotation.annotations[j].value - annotation.graphMin)
+                / (annotation.graphMax - annotation.graphMin);
+      }
+      else
+      {
+        range = 0f;
+      }
     }
 
-    return currentColour;
+    int dr = (int) (rr * range + r1), dg = (int) (gg * range + g1), db = (int) (bb
+            * range + b1);
+
+    return new Color(dr, dg, db);
+
   }
 
   public boolean isPredefinedColours()