src/jalview/schemes/ScoreColourScheme.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   3  * Copyright (C) 2014 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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.schemes;
  20
  21 import jalview.datamodel.SequenceI;
  22
  23 import java.awt.Color;
  24
  25 /**
  26  * DOCUMENT ME!
  27  *
  28  * @author $author$
  29  * @version $Revision$
  30  */
  31 public class ScoreColourScheme extends ResidueColourScheme
  32 {
  33   /** DOCUMENT ME!! */
  34   public double min;
  35
  36   /** DOCUMENT ME!! */
  37   public double max;
  38
  39   /** DOCUMENT ME!! */
  40   public double[] scores;
  41
  42   /**
  43    * Creates a new ScoreColourScheme object.
  44    *
  45    * @param scores
  46    *          DOCUMENT ME!
  47    * @param min
  48    *          DOCUMENT ME!
  49    * @param max
  50    *          DOCUMENT ME!
  51    */
  52   public ScoreColourScheme(int symbolIndex[], double[] scores, double min,
  53           double max)
  54   {
  55     super(symbolIndex);
  56
  57     this.scores = scores;
  58     this.min = min;
  59     this.max = max;
  60
  61     // Make colours in constructor
  62     // Why wasn't this done earlier?
  63     int i, iSize = scores.length;
  64     colors = new Color[scores.length];
  65     for (i = 0; i < iSize; i++)
  66     {
  67       float red = (float) (scores[i] - (float) min) / (float) (max - min);
  68
  69       if (red > 1.0f)
  70       {
  71         red = 1.0f;
  72       }
  73
  74       if (red < 0.0f)
  75       {
  76         red = 0.0f;
  77       }
  78       colors[i] = makeColour(red);
  79     }
  80   }
  81
  82   /**
  83    * DOCUMENT ME!
  84    *
  85    * @param s
  86    *          DOCUMENT ME!
  87    * @param j
  88    *          DOCUMENT ME!
  89    *
  90    * @return DOCUMENT ME!
  91    */
  92   @Override
  93   public Color findColour(char c, int j, SequenceI seq)
  94   {
  95     if (threshold > 0)
  96     {
  97       if (!aboveThreshold(c, j))
  98       {
  99         return Color.white;
 100       }
 101     }
 102
 103     if (jalview.util.Comparison.isGap(c))
 104     {
 105       return Color.white;
 106     }
 107
 108     Color currentColour = colors[ResidueProperties.aaIndex[c]];
 109
 110     if (conservationColouring)
 111     {
 112       currentColour = applyConservation(currentColour, j);
 113     }
 114
 115     return currentColour;
 116   }
 117
 118   /**
 119    * DOCUMENT ME!
 120    *
 121    * @param c
 122    *          DOCUMENT ME!
 123    *
 124    * @return DOCUMENT ME!
 125    */
 126   public Color makeColour(float c)
 127   {
 128     return new Color(c, (float) 0.0, (float) 1.0 - c);
 129   }
 130 }