src/jalview/schemes/RNAHelicesColour.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
   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  */
  18 package jalview.schemes;
  19
  20 import java.awt.*;
  21 import java.util.Hashtable;
  22
  23 import jalview.datamodel.AlignmentAnnotation;
  24 import jalview.datamodel.SequenceI;
  25
  26 /**
  27  * Looks at the information computed from an RNA Stockholm format file on the
  28  * secondary structure of the alignment. Extracts the information on the
  29  * positions of the helices present and assigns colors.
  30  *
  31  * @author Lauren Michelle Lui
  32  * @version 2.5
  33  */
  34 public class RNAHelicesColour extends ResidueColourScheme
  35 {
  36
  37   /**
  38    * Stores random colors generated for the number of helices
  39    */
  40   public Hashtable helixcolorhash = new Hashtable();
  41
  42   /**
  43    * Maps sequence positions to the RNA helix they belong to. Key: position,
  44    * Value: helix
  45    */
  46   public Hashtable positionsToHelix = new Hashtable();
  47
  48   /**
  49    * Number of helices in the RNA secondary structure
  50    */
  51   int numHelix = 0;
  52
  53   public AlignmentAnnotation annotation;
  54
  55   /**
  56    * Creates a new RNAHelicesColour object.
  57    */
  58   public RNAHelicesColour(AlignmentAnnotation annotation)
  59   {
  60     super(ResidueProperties.nucleotideIndex);
  61     this.annotation = annotation;
  62     refresh();
  63   }
  64
  65   private long lastrefresh = -1;
  66
  67   public void refresh()
  68   {
  69     if (lastrefresh != annotation._rnasecstr.hashCode()
  70             && annotation.isValidStruc())
  71     {
  72       annotation.getRNAStruc();
  73       lastrefresh = annotation._rnasecstr.hashCode();
  74       numHelix = 0;
  75       positionsToHelix = new Hashtable();
  76
  77       // Figure out number of helices
  78       // Length of rnasecstr is the number of pairs of positions that base pair
  79       // with each other in the secondary structure
  80       for (int x = 0; x < this.annotation._rnasecstr.length; x++)
  81       {
  82
  83         /*
  84          * System.out.println(this.annotation._rnasecstr[x] + " Begin" +
  85          * this.annotation._rnasecstr[x].getBegin());
  86          */
  87         // System.out.println(this.annotation._rnasecstr[x].getFeatureGroup());
  88
  89         positionsToHelix.put(this.annotation._rnasecstr[x].getBegin(),
  90                 this.annotation._rnasecstr[x].getFeatureGroup());
  91         positionsToHelix.put(this.annotation._rnasecstr[x].getEnd(),
  92                 this.annotation._rnasecstr[x].getFeatureGroup());
  93
  94         if (Integer.parseInt(this.annotation._rnasecstr[x]
  95                 .getFeatureGroup()) > numHelix)
  96         {
  97           numHelix = Integer.parseInt(this.annotation._rnasecstr[x]
  98                   .getFeatureGroup());
  99         }
 100
 101       }
 102
 103       // Generate random colors and store
 104       for (int j = 0; j <= numHelix; j++)
 105       {
 106         if (!helixcolorhash.containsKey(Integer.toString(j)))
 107         {
 108           helixcolorhash.put(Integer.toString(j),
 109                   jalview.util.ColorUtils.generateRandomColor(Color.white));
 110         }
 111       }
 112     }
 113   }
 114
 115   /**
 116    * Returns default color base on purinepyrimidineIndex in
 117    * jalview.schemes.ResidueProperties (Allows coloring in sequence logo)
 118    *
 119    * @param c
 120    *          Character in sequence
 121    *
 122    * @return color in RGB
 123    */
 124   @Override
 125   public Color findColour(char c)
 126   {
 127     return ResidueProperties.purinepyrimidine[ResidueProperties.purinepyrimidineIndex[c]];
 128     // random colors for all positions
 129     // jalview.util.ColorUtils.generateRandomColor(Color.white); If you want
 130   }
 131
 132   /**
 133    * Returns color based on helices
 134    *
 135    * @param c
 136    *          Character in sequence
 137    * @param j
 138    *          Threshold
 139    *
 140    * @return Color in RGB
 141    */
 142   @Override
 143   public Color findColour(char c, int j, SequenceI seq)
 144   {
 145     refresh();
 146     Color currentColour = Color.white;
 147     String currentHelix = null;
 148     currentHelix = (String) positionsToHelix.get(j);
 149
 150     if (currentHelix != null)
 151     {
 152       currentColour = (Color) helixcolorhash.get(currentHelix);
 153     }
 154
 155     // System.out.println(c + " " + j + " helix " + currentHelix + " " +
 156     // currentColour);
 157     return currentColour;
 158   }
 159 }