src/jalview/schemes/CovariationColourScheme.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.api.AlignViewportI;
  24 import jalview.datamodel.AlignmentAnnotation;
  25 import jalview.datamodel.AnnotatedCollectionI;
  26 import jalview.util.ColorUtils;
  27
  28 import java.awt.Color;
  29 import java.util.Hashtable;
  30 import java.util.Map;
  31
  32 /**
  33  * Became RNAHelicesColour.java. Placeholder for true covariation color scheme
  34  *
  35  * @author Lauren Michelle Lui
  36  * @version 2.5
  37  */
  38 public class CovariationColourScheme extends ResidueColourScheme
  39 {
  40   public Map<String, Color> helixcolorhash = new Hashtable<>();
  41
  42   public Map<Integer, String> positionsToHelix = new Hashtable<>();
  43
  44   int numHelix = 0;
  45
  46   public AlignmentAnnotation annotation;
  47
  48   /**
  49    * Returns a new instance of this colour scheme with which the given data may
  50    * be coloured
  51    */
  52   @Override
  53   public ColourSchemeI getInstance(AlignViewportI view,
  54           AnnotatedCollectionI coll)
  55   {
  56     return new CovariationColourScheme(coll.getAlignmentAnnotation()[0]);
  57   }
  58
  59   /**
  60    * Creates a new CovariationColourScheme object.
  61    */
  62   public CovariationColourScheme(AlignmentAnnotation annotation)
  63   {
  64     this.annotation = annotation;
  65
  66     for (int x = 0; x < this.annotation._rnasecstr.length; x++)
  67     {
  68       // System.out.println(this.annotation._rnasecstr[x] + " Begin" +
  69       // this.annotation._rnasecstr[x].getBegin());
  70       // System.out.println(this.annotation._rnasecstr[x].getFeatureGroup());
  71       // pairs.put(this.annotation._rnasecstr[x].getBegin(),
  72       // this.annotation._rnasecstr[x].getEnd());
  73
  74       positionsToHelix.put(this.annotation._rnasecstr[x].getBegin(),
  75               this.annotation._rnasecstr[x].getFeatureGroup());
  76       positionsToHelix.put(this.annotation._rnasecstr[x].getEnd(),
  77               this.annotation._rnasecstr[x].getFeatureGroup());
  78
  79       if (Integer.parseInt(
  80               this.annotation._rnasecstr[x].getFeatureGroup()) > numHelix)
  81       {
  82         numHelix = Integer
  83                 .parseInt(this.annotation._rnasecstr[x].getFeatureGroup());
  84       }
  85
  86     }
  87
  88     for (int j = 0; j <= numHelix; j++)
  89     {
  90       helixcolorhash.put(String.valueOf(j),
  91               ColorUtils.generateRandomColor(Color.white));
  92     }
  93
  94   }
  95
  96   /**
  97    * DOCUMENT ME!
  98    *
  99    * @param n
 100    *          DOCUMENT ME!
 101    *
 102    * @return DOCUMENT ME!
 103    */
 104   @Override
 105   public Color findColour(char c)
 106   {
 107     // System.out.println("called"); log.debug
 108     // Generate a random pastel color
 109
 110     return ResidueProperties.purinepyrimidine[ResidueProperties.purinepyrimidineIndex[c]];// jalview.util.ColorUtils.generateRandomColor(Color.white);
 111   }
 112
 113   /**
 114    * DOCUMENT ME!
 115    *
 116    * @param n
 117    *          DOCUMENT ME!
 118    * @param j
 119    *          DOCUMENT ME!
 120    *
 121    * @return DOCUMENT ME!
 122    */
 123   public Color findColour(char c, int j)
 124   {
 125     Color currentColour = Color.white;
 126     String currentHelix = null;
 127     // System.out.println(c + " " + j);
 128     currentHelix = positionsToHelix.get(j);
 129     // System.out.println(positionsToHelix.get(j));
 130
 131     if (currentHelix != null)
 132     {
 133       currentColour = helixcolorhash.get(currentHelix);
 134     }
 135
 136     // System.out.println(c + " " + j + " helix " + currentHelix + " " +
 137     // currentColour);
 138     return currentColour;
 139   }
 140
 141   @Override
 142   public boolean isNucleotideSpecific()
 143   {
 144     return true;
 145   }
 146
 147   @Override
 148   public String getSchemeName()
 149   {
 150     return "Covariation";
 151   }
 152
 153   @Override
 154   public boolean isSimple()
 155   {
 156     return false;
 157   }
 158 }