updated to jalview 2.1 and begun ArchiveClient/VamsasClient/VamsasStore updates.
[jalview.git] / src / jalview / schemes / ResidueColourScheme.java
index 95946f9..add76a0 100755 (executable)
-package jalview.schemes;\r
-\r
-import jalview.datamodel.*;\r
-import java.util.*;\r
-import java.awt.*;\r
-\r
-public class ResidueColourScheme implements ColourSchemeI {\r
-    Color    [] colors;\r
-    int         threshold = 90;\r
-\r
-    public ResidueColourScheme(Color[] colors, int threshold) {\r
-       this.colors    = colors;\r
-       this.threshold = threshold;\r
-    }\r
-\r
-    public ResidueColourScheme() {\r
-    }\r
-\r
-    public Color findColour(String aa)\r
-    {\r
-      return colors[((Integer)(ResidueProperties.aaHash.get(aa))).intValue()];\r
-    }\r
-\r
-    public Color findColour(SequenceI seq,String s, int j, Vector aa) {\r
-  try {\r
-           return colors[((Integer)(ResidueProperties.aaHash.get(s))).intValue()];\r
-       } catch (Exception e) {\r
-           return Color.white;\r
-       }\r
-    }\r
-\r
-    // aa should maybe be a class\r
-    public Color getColour(SequenceI seq, int j,Vector aa) {\r
-\r
-       Color  c       = Color.white;\r
-       String s       = seq.getSequence(j,j+1);\r
-\r
-       if (threshold > 0 && aa != null)\r
-        {\r
-           if (aboveThreshold(aa,seq,j,threshold))\r
-               c = findColour(seq,s,j,aa);\r
-       }\r
-        else\r
-           c = findColour(seq,s,j,aa);\r
-\r
-\r
-      return c;\r
-    }\r
-    public int getThreshold() {\r
-       return threshold;\r
-    }\r
-\r
-    public void setThreshold(int ct) {\r
-       threshold = ct;\r
-    }\r
-\r
-    public Vector  getColours(SequenceI s, Vector aa) {\r
-       Vector colours = new Vector();\r
-\r
-       for (int j = 0; j < s.getLength(); j++)\r
-           colours.addElement(getColour(s,j,aa));\r
-\r
-       return colours;\r
-    }\r
-\r
-    public Vector getColours(SequenceGroup sg, Vector aa) {\r
-       Vector colours = new Vector();\r
-\r
-       for (int j = 0; j < sg.getSize(); j++) {\r
-           SequenceI s = sg.getSequenceAt(j);\r
-\r
-           for (int i = 0; i < s.getLength();i++) {\r
-               colours.addElement(getColour(s,i,aa));\r
-           }\r
-       }\r
-       return colours;\r
-    }\r
-\r
-    public boolean aboveThreshold(Vector aa,SequenceI seq, int j, int threshold) {\r
-       String    s    = seq.getSequence(j,j+1);\r
-       Hashtable hash = (Hashtable)aa.elementAt(j);\r
-\r
-       if (j < aa.size()) {\r
-           String maxRes = (String)hash.get("maxResidue");\r
-\r
-           double sc = 0;\r
-\r
-           if (((Integer)hash.get("maxCount")).intValue() != -1  && hash.contains(s)) {\r
-               int maxCount = ((Integer)hash.get("maxCount")).intValue();\r
-               int resCount = ((Integer)hash.get(s)).intValue();\r
-\r
-               sc = resCount * 100.0 / resCount;\r
-\r
-               // This should be isGap somewhere\r
-               if  ( !s.equals("-")  && !s.equals(".") && !s.equals(" ")) {\r
-                   if (sc >= (double)threshold) {\r
-                       return true;\r
-                   }\r
-               }\r
-           }\r
-       }\r
-       return false;\r
-    }\r
-\r
-    public boolean canThreshold() {\r
-       return true;\r
-    }\r
-    public boolean isUserDefinable() {\r
-       return false;\r
-    }\r
-}\r
+/*
+* Jalview - A Sequence Alignment Editor and Viewer
+* Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+*
+* This program is free software; you can redistribute it and/or
+* modify it under the terms of the GNU General Public License
+* as published by the Free Software Foundation; either version 2
+* of the License, or (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with this program; if not, write to the Free Software
+* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+*/
+package jalview.schemes;
+
+import jalview.analysis.*;
+
+import java.awt.*;
+
+import java.util.*;
+
+
+/**
+ * DOCUMENT ME!
+ *
+ * @author $author$
+ * @version $Revision$
+ */
+public class ResidueColourScheme implements ColourSchemeI
+{
+
+    boolean conservationColouring = false;
+    boolean consensusColouring = false;
+
+    Color[] colors;
+    int threshold = 0;
+
+    /* Set when threshold colouring to either pid_gaps or pid_nogaps*/
+    protected String ignoreGaps = "pid_gaps";
+
+    /** Consenus as a hashtable array */
+    Hashtable [] consensus;
+
+    /** Conservation string as a char array */
+   char [] conservation;
+
+   /** DOCUMENT ME!! */
+   int inc = 30;
+
+   /**
+    * The colour to be calculated, manipulated and returned
+    */
+   Color currentColour = null;
+
+
+
+    /**
+     * Creates a new ResidueColourScheme object.
+     *
+     * @param colors DOCUMENT ME!
+     * @param threshold DOCUMENT ME!
+     */
+    public ResidueColourScheme(Color[] colours, int threshold)
+    {
+        this.colors = colours;
+        this.threshold = threshold;
+    }
+
+    /**
+     * Creates a new ResidueColourScheme object.
+     */
+    public ResidueColourScheme()
+    {
+    }
+
+    /**
+    * Find a colour without an index in a sequence
+    */
+   public Color findColour(String aa)
+   {
+       return colors[((Integer) (ResidueProperties.aaHash.get(aa))).intValue()];
+   }
+
+
+
+   public Color findColour(String s, int j)
+   {
+
+       int index = ((Integer) (ResidueProperties.aaHash.get(s))).intValue();
+
+       if ((threshold == 0) || aboveThreshold(ResidueProperties.aa[index], j))
+       {
+           currentColour = colors[index];
+       }
+       else
+       {
+           currentColour = Color.white;
+       }
+
+       if(conservationColouring)
+         applyConservation(j);
+
+
+       return currentColour;
+   }
+
+
+    /**
+     * Get the percentage threshold for this colour scheme
+     *
+     * @return Returns the percentage threshold
+     */
+    public int getThreshold()
+    {
+        return threshold;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param ct DOCUMENT ME!
+     */
+    public void setThreshold(int ct, boolean ignoreGaps)
+    {
+        threshold = ct;
+        if(ignoreGaps)
+          this.ignoreGaps = "pid_nogaps";
+        else
+          this.ignoreGaps = "pid_gaps";
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param s DOCUMENT ME!
+     * @param j DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public boolean aboveThreshold(String s, int j)
+    {
+        if ((((Integer) consensus[j].get("maxCount")).intValue() != -1) &&
+                consensus[j].contains(s))
+        {
+            if (((Float)consensus[j].get(ignoreGaps)).floatValue() >= threshold)
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+
+    public boolean conservationApplied()
+    {
+      return conservationColouring;
+    }
+
+    public void setConservationInc(int i)
+    {
+      inc = i;
+    }
+
+    public int getConservationInc()
+    {
+      return inc;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param consensus DOCUMENT ME!
+     */
+    public void setConsensus(Vector vconsensus)
+    {
+      if(vconsensus==null)
+        return;
+
+       int i, iSize=vconsensus.size();
+       consensus = new Hashtable[iSize];
+       for(i=0; i<iSize; i++)
+        consensus[i] = (Hashtable)vconsensus.elementAt(i);
+    }
+
+
+    public void setConservation(Conservation cons)
+    {
+      if(cons==null)
+      {
+        conservationColouring = false;
+        conservation = null;
+      }
+      else
+      {
+        conservationColouring = true;
+        int i, iSize = cons.getConsSequence().getLength();
+        conservation = new char[iSize];
+        for (i = 0; i < iSize; i++)
+          conservation[i] = cons.getConsSequence().getCharAt(i);
+      }
+
+    }
+
+
+    /**
+    * DOCUMENT ME!
+    *
+    * @param s DOCUMENT ME!
+    * @param i DOCUMENT ME!
+    *
+    * @return DOCUMENT ME!
+    */
+
+   void applyConservation(int i)
+   {
+
+     if ((conservation[i] != '*') && (conservation[i] != '+'))
+     {
+       if(jalview.util.Comparison.isGap(conservation[i]))
+       {
+         currentColour = Color.white;
+       }
+       else
+       {
+         float t = 11 - (conservation[i] - '0');
+         if(t==0)
+         {
+           currentColour = Color.white;
+           return;
+         }
+
+         int red = currentColour.getRed();
+         int green = currentColour.getGreen();
+         int blue = currentColour.getBlue();
+
+         int dr = 255 - red;
+         int dg = 255 - green;
+         int db = 255 - blue;
+
+         dr *= t / 10f;
+         dg *= t / 10f;
+         db *= t / 10f;
+
+         red += (inc / 20f) * dr;
+         green += (inc / 20f) * dg;
+         blue += (inc / 20f) * db;
+
+         if (red > 255 || green > 255 || blue > 255)
+           currentColour = Color.white;
+         else
+           currentColour = new Color(red, green, blue);
+       }
+       }
+   }
+
+
+}