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