src/jalview/schemes/PIDColourScheme.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.api.AlignViewportI;
  24 import jalview.datamodel.AnnotatedCollectionI;
  25 import jalview.datamodel.SequenceGroup;
  26 import jalview.datamodel.SequenceI;
  27 import jalview.util.Comparison;
  28
  29 import java.awt.Color;
  30
  31 public class PIDColourScheme extends ResidueColourScheme
  32 {
  33   private static final Color[] pidColours = { new Color(100, 100, 255),
  34       new Color(153, 153, 255), new Color(204, 204, 255), };
  35
  36   private static final float[] thresholds = { 80, 60, 40, };
  37
  38   SequenceGroup group;
  39
  40   public PIDColourScheme()
  41   {
  42   }
  43
  44   @Override
  45   public Color findColour(char c, int j, SequenceI seq,
  46           String consensusResidue, float pid)
  47   {
  48     /*
  49      * compare as upper case; note consensusResidue is
  50      * always computed as uppercase
  51      */
  52     if ('a' <= c && c <= 'z')
  53     {
  54       c -= ('a' - 'A');
  55     }
  56
  57     if (consensusResidue == null || Comparison.isGap(c))
  58     {
  59       return Color.white;
  60     }
  61
  62     Color colour = Color.white;
  63
  64     /*
  65      * test whether this is the consensus (or joint consensus) residue
  66      */
  67     boolean matchesConsensus = consensusResidue.contains(String.valueOf(c));
  68     if (matchesConsensus)
  69     {
  70       for (int i = 0; i < thresholds.length; i++)
  71       {
  72         if (pid > thresholds[i])
  73         {
  74           colour = pidColours[i];
  75           break;
  76         }
  77       }
  78     }
  79
  80     return colour;
  81   }
  82
  83   @Override
  84   public String getSchemeName()
  85   {
  86     return JalviewColourScheme.PID.toString();
  87   }
  88
  89   /**
  90    * Returns a new instance of this colour scheme with which the given data may
  91    * be coloured
  92    */
  93   @Override
  94   public ColourSchemeI getInstance(AlignViewportI view,
  95           AnnotatedCollectionI coll)
  96   {
  97     return new PIDColourScheme();
  98   }
  99
 100   @Override
 101   public boolean isSimple()
 102   {
 103     return false;
 104   }
 105 }