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