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