2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.analysis;
23 import jalview.datamodel.AlignmentAnnotation;
24 import jalview.datamodel.Annotation;
25 import jalview.datamodel.Sequence;
26 import jalview.datamodel.SequenceI;
28 import java.awt.Color;
29 import java.util.Enumeration;
30 import java.util.Hashtable;
31 import java.util.List;
32 import java.util.Vector;
35 * Calculates conservation values for a given set of sequences
40 public class Conservation
42 SequenceI[] sequences;
48 Vector seqNums; // vector of int vectors where first is sequence checksum
50 int maxLength = 0; // used by quality calcs
52 boolean seqNumsChanged = false; // updated after any change via calcSeqNum;
56 boolean canonicaliseAa = true; // if true then conservation calculation will
58 // map all symbols to canonical aa numbering
59 // rather than consider conservation of that
62 /** Stores calculated quality values */
63 public Vector quality;
65 /** Stores maximum and minimum values of quality values */
66 public Double[] qualityRange = new Double[2];
68 String consString = "";
70 Sequence consSequence;
80 private String[] consSymbs;
83 * Creates a new Conservation object.
86 * Name of conservation
88 * hash of properties for each symbol
90 * to count the residues in residueHash(). commonly used value is 3
92 * sequences to be used in calculation
94 * start residue position
96 * end residue position
98 public Conservation(String name, Hashtable propHash, int threshold,
99 List<SequenceI> sequences, int start, int end)
102 this.propHash = propHash;
103 this.threshold = threshold;
107 maxLength = end - start + 1; // default width includes bounds of
110 int s, sSize = sequences.size();
111 SequenceI[] sarray = new SequenceI[sSize];
112 this.sequences = sarray;
115 for (s = 0; s < sSize; s++)
117 sarray[s] = sequences.get(s);
118 if (sarray[s].getLength() > maxLength)
120 maxLength = sarray[s].getLength();
123 } catch (ArrayIndexOutOfBoundsException ex)
125 // bail - another thread has modified the sequence array, so the current
126 // calculation is probably invalid.
127 this.sequences = new SequenceI[0];
133 * Translate sequence i into a numerical representation and store it in the
134 * i'th position of the seqNums array.
138 private void calcSeqNum(int i)
140 String sq = null; // for dumb jbuilder not-inited exception warning
143 int sSize = sequences.length;
145 if ((i > -1) && (i < sSize))
147 sq = sequences[i].getSequenceAsString();
149 if (seqNums.size() <= i)
151 seqNums.addElement(new int[sq.length() + 1]);
154 if (sq.hashCode() != ((int[]) seqNums.elementAt(i))[0])
158 seqNumsChanged = true;
166 sqnum = new int[len + 1]; // better to always make a new array -
167 // sequence can change its length
168 sqnum[0] = sq.hashCode();
170 for (j = 1; j <= len; j++)
172 sqnum[j] = jalview.schemes.ResidueProperties.aaIndex[sq
176 seqNums.setElementAt(sqnum, i);
180 System.out.println("SEQUENCE HAS BEEN DELETED!!!");
185 // JBPNote INFO level debug
187 .println("ERROR: calcSeqNum called with out of range sequence index for Alignment\n");
192 * Calculates the conservation values for given set of sequences
194 public void calculate()
196 Hashtable resultHash, ht;
197 int thresh, j, jSize = sequences.length;
198 int[] values; // Replaces residueHash
199 String type, res = null;
201 Enumeration enumeration2;
203 total = new Hashtable[maxLength];
205 for (int i = start; i <= end; i++)
207 values = new int[255];
209 for (j = 0; j < jSize; j++)
211 if (sequences[j].getLength() > i)
213 c = sequences[j].getCharAt(i);
216 { // lookup the base aa code symbol
217 c = (char) jalview.schemes.ResidueProperties.aaIndex[sequences[j]
225 // recover canonical aa symbol
226 c = jalview.schemes.ResidueProperties.aa[c].charAt(0);
231 // original behaviour - operate on ascii symbols directly
232 // No need to check if its a '-'
233 if (c == '.' || c == ' ')
238 if (!canonicaliseAa && 'a' <= c && c <= 'z')
240 c -= (32); // 32 = 'a' - 'A'
251 // What is the count threshold to count the residues in residueHash()
252 thresh = (threshold * (jSize)) / 100;
254 // loop over all the found residues
255 resultHash = new Hashtable();
256 for (char v = '-'; v < 'Z'; v++)
259 if (values[v] > thresh)
261 res = String.valueOf(v);
263 // Now loop over the properties
264 enumeration2 = propHash.keys();
266 while (enumeration2.hasMoreElements())
268 type = (String) enumeration2.nextElement();
269 ht = (Hashtable) propHash.get(type);
271 // Have we ticked this before?
272 if (!resultHash.containsKey(type))
274 if (ht.containsKey(res))
276 resultHash.put(type, ht.get(res));
280 resultHash.put(type, ht.get("-"));
283 else if (((Integer) resultHash.get(type)).equals(ht.get(res)) == false)
285 resultHash.put(type, new Integer(-1));
291 if (total.length > 0)
293 total[i - start] = resultHash;
298 /*****************************************************************************
299 * count conservation for the j'th column of the alignment
301 * @return { gap count, conserved residue count}
303 public int[] countConsNGaps(int j)
308 int[] r = new int[2];
310 int i, iSize = sequences.length;
313 for (i = 0; i < iSize; i++)
315 if (j >= sequences[i].getLength())
321 c = sequences[i].getCharAt(j); // gaps do not have upper/lower case
323 if (jalview.util.Comparison.isGap((c)))
343 r[0] = (nres == cons) ? 1 : 0;
350 * Calculates the conservation sequence
353 * if true, poitiveve conservation; false calculates negative
355 * @param percentageGaps
356 * commonly used value is 25
358 public void verdict(boolean consflag, float percentageGaps)
360 StringBuffer consString = new StringBuffer();
366 Hashtable resultHash;
367 Enumeration enumeration;
369 // NOTE THIS SHOULD CHECK IF THE CONSEQUENCE ALREADY
370 // EXISTS AND NOT OVERWRITE WITH '-', BUT THIS CASE
371 // DOES NOT EXIST IN JALVIEW 2.1.2
372 for (int i = 0; i < start; i++)
374 consString.append('-');
376 consSymbs = new String[end - start + 1];
377 for (int i = start; i <= end; i++)
379 gapcons = countConsNGaps(i);
380 totGaps = gapcons[1];
381 pgaps = ((float) totGaps * 100) / sequences.length;
382 consSymbs[i - start] = new String();
384 if (percentageGaps > pgaps)
386 resultHash = total[i - start];
387 // Now find the verdict
389 enumeration = resultHash.keys();
391 while (enumeration.hasMoreElements())
393 type = (String) enumeration.nextElement();
394 result = (Integer) resultHash.get(type);
395 // Do we want to count +ve conservation or +ve and -ve cons.?
398 if (result.intValue() == 1)
400 consSymbs[i - start] = type + " " + consSymbs[i - start];
406 if (result.intValue() != -1)
409 if (result.intValue() == 0)
411 consSymbs[i - start] = consSymbs[i - start] + " !" + type;
415 consSymbs[i - start] = type + " " + consSymbs[i - start];
426 consString.append(count); // Conserved props!=Identity
430 consString.append((gapcons[0] == 1) ? "*" : "+");
435 consString.append('-');
439 consSequence = new Sequence(name, consString.toString(), start, end);
445 * @return Conservation sequence
447 public Sequence getConsSequence()
452 // From Alignment.java in jalview118
453 public void findQuality()
455 findQuality(0, maxLength - 1);
461 private void percentIdentity2()
463 seqNums = new Vector();
465 int i = 0, iSize = sequences.length;
466 // Do we need to calculate this again?
467 for (i = 0; i < iSize; i++)
472 if ((cons2 == null) || seqNumsChanged)
474 cons2 = new int[maxLength][24];
476 // Initialize the array
477 for (int j = 0; j < 24; j++)
479 for (i = 0; i < maxLength; i++)
488 while (j < sequences.length)
490 sqnum = (int[]) seqNums.elementAt(j);
492 for (i = 1; i < sqnum.length; i++)
494 cons2[i - 1][sqnum[i]]++;
497 for (i = sqnum.length - 1; i < maxLength; i++)
499 cons2[i][23]++; // gap count
508 * for (int i=start; i <= end; i++) { int max = -1000; int maxi = -1; int
511 * for (int j=0;j<24;j++) { if (cons2[i][j] > max) { max = cons2[i][j];
512 * maxi = i; maxj = j; } } }
518 * Calculates the quality of the set of sequences
525 public void findQuality(int start, int end)
527 quality = new Vector();
530 int[][] BLOSUM62 = jalview.schemes.ResidueProperties.getBLOSUM62();
532 // Loop over columns // JBPNote Profiling info
533 // long ts = System.currentTimeMillis();
534 // long te = System.currentTimeMillis();
537 int size = seqNums.size();
538 int[] lengths = new int[size];
539 double tot, bigtot, sr, tmp;
541 int l, j, i, ii, i2, k, seqNum;
543 for (l = 0; l < size; l++)
545 lengths[l] = ((int[]) seqNums.elementAt(l)).length - 1;
548 for (j = start; j <= end; j++)
552 // First Xr = depends on column only
555 for (ii = 0; ii < 24; ii++)
559 for (i2 = 0; i2 < 24; i2++)
561 x[ii] += (((double) cons2[j][i2] * BLOSUM62[ii][i2]) + 4);
567 // Now calculate D for each position and sum
568 for (k = 0; k < size; k++)
572 seqNum = (j < lengths[k]) ? ((int[]) seqNums.elementAt(k))[j + 1]
573 : 23; // Sequence, or gap at the end
575 // This is a loop over r
576 for (i = 0; i < 23; i++)
580 sr = (double) BLOSUM62[i][seqNum] + 4;
582 // Calculate X with another loop over residues
583 // System.out.println("Xi " + i + " " + x[i] + " " + sr);
586 tot += (xx[i] * xx[i]);
589 bigtot += Math.sqrt(tot);
592 // This is the quality for one column
598 // bigtot = bigtot * (size-cons2[j][23])/size;
599 quality.addElement(new Double(bigtot));
601 // Need to normalize by gaps
604 double newmax = -10000;
606 for (j = start; j <= end; j++)
608 tmp = ((Double) quality.elementAt(j)).doubleValue();
609 tmp = ((max - tmp) * (size - cons2[j][23])) / size;
611 // System.out.println(tmp+ " " + j);
612 quality.setElementAt(new Double(tmp), j);
620 // System.out.println("Quality " + s);
621 qualityRange[0] = new Double(0);
622 qualityRange[1] = new Double(newmax);
626 * complete the given consensus and quuality annotation rows. Note: currently
627 * this method will enlarge the given annotation row if it is too small,
628 * otherwise will leave its length unchanged.
630 * @param conservation
631 * conservation annotation row
633 * (optional - may be null)
635 * first column for conservation
637 * extent of conservation
639 public void completeAnnotations(AlignmentAnnotation conservation,
640 AlignmentAnnotation quality2, int istart, int alWidth)
642 char[] sequence = getConsSequence().getSequence();
654 maxB = 0f - minB; // scalable range for colouring both Conservation and
664 if (conservation.annotations != null
665 && conservation.annotations.length < alWidth)
667 conservation.annotations = new Annotation[alWidth];
670 if (quality2 != null)
672 quality2.graphMax = qualityRange[1].floatValue();
673 if (quality2.annotations != null
674 && quality2.annotations.length < alWidth)
676 quality2.annotations = new Annotation[alWidth];
678 qmin = qualityRange[0].floatValue();
679 qmax = qualityRange[1].floatValue();
682 for (int i = 0; i < alWidth; i++)
688 if (Character.isDigit(c))
701 float vprop = value - min;
703 int consp = i - start;
704 String conssym = (value > 0 && consp > -1 && consp < consSymbs.length) ? consSymbs[consp]
706 conservation.annotations[i] = new Annotation(String.valueOf(c),
707 conssym, ' ', value, new Color(minR + (maxR * vprop), minG
708 + (maxG * vprop), minB + (maxB * vprop)));
711 if (quality2 != null)
713 value = ((Double) quality.elementAt(i)).floatValue();
714 vprop = value - qmin;
716 quality2.annotations[i] = new Annotation(" ",
717 String.valueOf(value), ' ', value, new Color(minR
718 + (maxR * vprop), minG + (maxG * vprop), minB
725 * construct and call the calculation methods on a new Conservation object
728 * - name of conservation
730 * - hash table of properties for each amino acid (normally
731 * ResidueProperties.propHash)
733 * - minimum number of conserved residues needed to indicate
734 * conservation (typically 3)
737 * first column in calculation window
739 * last column in calculation window
741 * positive (true) or negative (false) conservation
742 * @param consPercGaps
743 * percentage of gaps tolerated in column
745 * flag indicating if alignment quality should be calculated
746 * @return Conservation object ready for use in visualization
748 public static Conservation calculateConservation(String name,
749 Hashtable consHash, int threshold, List<SequenceI> seqs,
750 int start, int end, boolean posOrNeg, int consPercGaps,
753 Conservation cons = new Conservation(name, consHash, threshold, seqs,
755 return calculateConservation(cons, posOrNeg, consPercGaps, calcQuality);
760 * positive (true) or negative (false) conservation
761 * @param consPercGaps
762 * percentage of gaps tolerated in column
764 * flag indicating if alignment quality should be calculated
765 * @return Conservation object ready for use in visualization
767 public static Conservation calculateConservation(Conservation cons,
768 boolean b, int consPercGaps, boolean calcQuality)
771 cons.verdict(b, consPercGaps);