src/jalview/schemes/RNAHelicesColour.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.datamodel.AlignmentAnnotation;
  24 import jalview.datamodel.AnnotatedCollectionI;
  25 import jalview.datamodel.SequenceCollectionI;
  26 import jalview.datamodel.SequenceI;
  27
  28 import java.awt.Color;
  29 import java.util.Hashtable;
  30 import java.util.Map;
  31
  32 /**
  33  * Looks at the information computed from an RNA Stockholm format file on the
  34  * secondary structure of the alignment. Extracts the information on the
  35  * positions of the helices present and assigns colors.
  36  *
  37  * @author Lauren Michelle Lui
  38  * @version 2.5
  39  */
  40 public class RNAHelicesColour extends ResidueColourScheme
  41 {
  42
  43   /**
  44    * Stores random colors generated for the number of helices
  45    */
  46   public Hashtable helixcolorhash = new Hashtable();
  47
  48   /**
  49    * Maps sequence positions to the RNA helix they belong to. Key: position,
  50    * Value: helix
  51    */
  52   public Hashtable positionsToHelix = new Hashtable();
  53
  54   /**
  55    * Number of helices in the RNA secondary structure
  56    */
  57   int numHelix = 0;
  58
  59   public AlignmentAnnotation annotation;
  60
  61   /**
  62    * Creates a new RNAHelicesColour object.
  63    */
  64   public RNAHelicesColour(AlignmentAnnotation annotation)
  65   {
  66     super(ResidueProperties.nucleotideIndex);
  67     this.annotation = annotation;
  68     refresh();
  69   }
  70
  71   public RNAHelicesColour(AnnotatedCollectionI alignment)
  72   {
  73     super(ResidueProperties.nucleotideIndex);
  74     alignmentChanged(alignment, null);
  75   }
  76
  77   /**
  78    * clones colour settings and annotation row data
  79    *
  80    * @param rnaHelicesColour
  81    */
  82   public RNAHelicesColour(RNAHelicesColour rnaHelicesColour)
  83   {
  84     super(ResidueProperties.nucleotideIndex);
  85     helixcolorhash = rnaHelicesColour.helixcolorhash;
  86     annotation = rnaHelicesColour.annotation;
  87     refresh();
  88   }
  89
  90   @Override
  91   public void alignmentChanged(AnnotatedCollectionI alignment,
  92           Map<SequenceI, SequenceCollectionI> hiddenReps)
  93   {
  94
  95     // This loop will find the first rna structure annotation by which to colour
  96     // the sequences.
  97     AlignmentAnnotation[] annotations = alignment.getAlignmentAnnotation();
  98     for (int i = 0; i < annotations.length; i++)
  99     {
 100
 101       // is this a sensible way of determining type of annotation?
 102       if (annotations[i].visible && annotations[i].isRNA()
 103               && annotations[i].isValidStruc())
 104       {
 105         annotation = annotations[i];
 106         break;
 107       }
 108     }
 109
 110     refresh();
 111
 112   }
 113
 114   private long lastrefresh = -1;
 115
 116   public void refresh()
 117   {
 118
 119     if (annotation != null
 120             && ((annotation._rnasecstr == null || lastrefresh != annotation._rnasecstr
 121                     .hashCode()) && annotation.isValidStruc()))
 122     {
 123       annotation.getRNAStruc();
 124       lastrefresh = annotation._rnasecstr.hashCode();
 125       numHelix = 0;
 126       positionsToHelix = new Hashtable();
 127
 128       // Figure out number of helices
 129       // Length of rnasecstr is the number of pairs of positions that base pair
 130       // with each other in the secondary structure
 131       for (int x = 0; x < this.annotation._rnasecstr.length; x++)
 132       {
 133
 134         /*
 135          * System.out.println(this.annotation._rnasecstr[x] + " Begin" +
 136          * this.annotation._rnasecstr[x].getBegin());
 137          */
 138         // System.out.println(this.annotation._rnasecstr[x].getFeatureGroup());
 139
 140         positionsToHelix.put(this.annotation._rnasecstr[x].getBegin(),
 141                 this.annotation._rnasecstr[x].getFeatureGroup());
 142         positionsToHelix.put(this.annotation._rnasecstr[x].getEnd(),
 143                 this.annotation._rnasecstr[x].getFeatureGroup());
 144
 145         if (Integer.parseInt(this.annotation._rnasecstr[x]
 146                 .getFeatureGroup()) > numHelix)
 147         {
 148           numHelix = Integer.parseInt(this.annotation._rnasecstr[x]
 149                   .getFeatureGroup());
 150         }
 151
 152       }
 153
 154       // Generate random colors and store
 155       for (int j = 0; j <= numHelix; j++)
 156       {
 157         if (!helixcolorhash.containsKey(Integer.toString(j)))
 158         {
 159           helixcolorhash.put(Integer.toString(j),
 160                   jalview.util.ColorUtils.generateRandomColor(Color.white));
 161         }
 162       }
 163     }
 164   }
 165
 166   /**
 167    * Returns default color base on purinepyrimidineIndex in
 168    * jalview.schemes.ResidueProperties (Allows coloring in sequence logo)
 169    *
 170    * @param c
 171    *          Character in sequence
 172    *
 173    * @return color in RGB
 174    */
 175   @Override
 176   public Color findColour(char c)
 177   {
 178     return ResidueProperties.purinepyrimidine[ResidueProperties.purinepyrimidineIndex[c]];
 179     // random colors for all positions
 180     // jalview.util.ColorUtils.generateRandomColor(Color.white); If you want
 181   }
 182
 183   /**
 184    * Returns color based on helices
 185    *
 186    * @param c
 187    *          Character in sequence
 188    * @param j
 189    *          Threshold
 190    *
 191    * @return Color in RGB
 192    */
 193   @Override
 194   public Color findColour(char c, int j, SequenceI seq)
 195   {
 196     refresh();
 197     Color currentColour = Color.white;
 198     String currentHelix = null;
 199     currentHelix = (String) positionsToHelix.get(j);
 200
 201     if (currentHelix != null)
 202     {
 203       currentColour = (Color) helixcolorhash.get(currentHelix);
 204     }
 205
 206     // System.out.println(c + " " + j + " helix " + currentHelix + " " +
 207     // currentColour);
 208     return currentColour;
 209   }
 210
 211   @Override
 212   public ColourSchemeI applyTo(AnnotatedCollectionI sg,
 213           Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
 214   {
 215     return new RNAHelicesColour(this);
 216   }
 217 }