Merge branch 'documentation/JAL-2325_release2101' into releases/Release_2_10_Branch
[jalview.git] / 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    * Maps sequence positions to the RNA helix they belong to. Key: position,
45    * Value: helix TODO: Revise or drop in favour of annotation position numbers
46    */
47   public Hashtable<Integer, String> positionsToHelix = new Hashtable<Integer, String>();
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     ColourSchemeProperty.resetRnaHelicesShading();
64     refresh();
65   }
66
67   public RNAHelicesColour(AnnotatedCollectionI alignment)
68   {
69     super(ResidueProperties.nucleotideIndex);
70     ColourSchemeProperty.resetRnaHelicesShading();
71     alignmentChanged(alignment, null);
72   }
73
74   /**
75    * clones colour settings and annotation row data
76    * 
77    * @param rnaHelicesColour
78    */
79   public RNAHelicesColour(RNAHelicesColour rnaHelicesColour)
80   {
81     super(ResidueProperties.nucleotideIndex);
82     annotation = rnaHelicesColour.annotation;
83     refresh();
84   }
85
86   @Override
87   public void alignmentChanged(AnnotatedCollectionI alignment,
88           Map<SequenceI, SequenceCollectionI> hiddenReps)
89   {
90
91     // This loop will find the first rna structure annotation by which to colour
92     // the sequences.
93     AlignmentAnnotation[] annotations = alignment.getAlignmentAnnotation();
94     if (annotations == null)
95     {
96       return;
97     }
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<Integer, String>();
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       ColourSchemeProperty.initRnaHelicesShading(numHelix);
154     }
155   }
156
157   /**
158    * Returns default color base on purinepyrimidineIndex in
159    * jalview.schemes.ResidueProperties (Allows coloring in sequence logo)
160    * 
161    * @param c
162    *          Character in sequence
163    * 
164    * @return color in RGB
165    */
166   @Override
167   public Color findColour(char c)
168   {
169     return ResidueProperties.purinepyrimidine[ResidueProperties.purinepyrimidineIndex[c]];
170     // random colors for all positions
171     // jalview.util.ColorUtils.generateRandomColor(Color.white); If you want
172   }
173
174   /**
175    * Returns color based on helices
176    * 
177    * @param c
178    *          Character in sequence
179    * @param j
180    *          position in sequence - used to locate helix
181    * 
182    * @return Color in RGB
183    */
184   @Override
185   public Color findColour(char c, int j, SequenceI seq)
186   {
187     refresh();
188     Color currentColour = Color.white;
189     String currentHelix = null;
190     currentHelix = positionsToHelix.get(j);
191     if (currentHelix != null)
192     {
193       currentColour = ColourSchemeProperty.rnaHelices[Integer
194               .parseInt(currentHelix)];
195     }
196     return currentColour;
197   }
198
199   @Override
200   public ColourSchemeI applyTo(AnnotatedCollectionI sg,
201           Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
202   {
203     return new RNAHelicesColour(this);
204   }
205 }