src/jalview/schemes/Blosum62ColourScheme.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.SequenceI;
  26 import jalview.util.Comparison;
  27
  28 import java.awt.Color;
  29 import java.util.Map;
  30
  31 public class Blosum62ColourScheme extends ResidueColourScheme
  32 {
  33   private static final Color LIGHT_BLUE = new Color(204, 204, 255);
  34   private static final Color DARK_BLUE = new Color(154, 154, 255);
  35
  36   public Blosum62ColourScheme()
  37   {
  38     super();
  39   }
  40
  41   /**
  42    * Returns a new instance of this colour scheme with which the given data may
  43    * be coloured
  44    */
  45   @Override
  46   public ColourSchemeI getInstance(AnnotatedCollectionI coll,
  47           Map<SequenceI, SequenceCollectionI> hrs)
  48   {
  49     return new Blosum62ColourScheme();
  50   }
  51
  52   @Override
  53   public Color findColour(char res, int j, SequenceI seq,
  54           String consensusResidue, float pid)
  55   {
  56     /*
  57      * compare as upper case; note toUpperCase does nothing
  58      * if the string is already uppercase
  59      */
  60     consensusResidue = consensusResidue.toUpperCase();
  61     if ('a' <= res && res <= 'z')
  62     {
  63       res -= ('a' - 'A');
  64     }
  65
  66     if (Comparison.isGap(res) || consensusResidue == null)
  67     {
  68       return Color.white;
  69     }
  70
  71     Color colour;
  72
  73     if (consensusResidue.indexOf(res) > -1)
  74     {
  75       colour = DARK_BLUE;
  76     }
  77     else
  78     {
  79       int c = 0;
  80
  81       for (char consensus : consensusResidue.toCharArray())
  82       {
  83         c += ResidueProperties.getBLOSUM62(consensus, res);
  84       }
  85
  86       if (c > 0)
  87       {
  88         colour = LIGHT_BLUE;
  89       }
  90       else
  91       {
  92         colour = Color.white;
  93       }
  94     }
  95     return colour;
  96   }
  97
  98   @Override
  99   public boolean isPeptideSpecific()
 100   {
 101     return true;
 102   }
 103
 104   @Override
 105   public String getSchemeName()
 106   {
 107     return JalviewColourScheme.Blosum62.toString();
 108   }
 109
 110   @Override
 111   public boolean isSimple()
 112   {
 113     return false;
 114   }
 115 }