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