src/jalview/analysis/Conservation.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
   3  * Copyright (C) 2015 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.analysis;
  22
  23 import jalview.datamodel.AlignmentAnnotation;
  24 import jalview.datamodel.Annotation;
  25 import jalview.datamodel.Sequence;
  26 import jalview.datamodel.SequenceI;
  27
  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;
  33
  34 /**
  35  * Calculates conservation values for a given set of sequences
  36  *
  37  * @author $author$
  38  * @version $Revision$
  39  */
  40 public class Conservation
  41 {
  42   SequenceI[] sequences;
  43
  44   int start;
  45
  46   int end;
  47
  48   Vector seqNums; // vector of int vectors where first is sequence checksum
  49
  50   int maxLength = 0; // used by quality calcs
  51
  52   boolean seqNumsChanged = false; // updated after any change via calcSeqNum;
  53
  54   Hashtable[] total;
  55
  56   boolean canonicaliseAa = true; // if true then conservation calculation will
  57
  58   // map all symbols to canonical aa numbering
  59   // rather than consider conservation of that
  60   // symbol
  61
  62   /** Stores calculated quality values */
  63   public Vector quality;
  64
  65   /** Stores maximum and minimum values of quality values */
  66   public Double[] qualityRange = new Double[2];
  67
  68   String consString = "";
  69
  70   Sequence consSequence;
  71
  72   Hashtable propHash;
  73
  74   int threshold;
  75
  76   String name = "";
  77
  78   int[][] cons2;
  79
  80   private String[] consSymbs;
  81
  82   /**
  83    * Creates a new Conservation object.
  84    *
  85    * @param name
  86    *          Name of conservation
  87    * @param propHash
  88    *          hash of properties for each symbol
  89    * @param threshold
  90    *          to count the residues in residueHash(). commonly used value is 3
  91    * @param sequences
  92    *          sequences to be used in calculation
  93    * @param start
  94    *          start residue position
  95    * @param end
  96    *          end residue position
  97    */
  98   public Conservation(String name, Hashtable propHash, int threshold,
  99           List<SequenceI> sequences, int start, int end)
 100   {
 101     this.name = name;
 102     this.propHash = propHash;
 103     this.threshold = threshold;
 104     this.start = start;
 105     this.end = end;
 106
 107     maxLength = end - start + 1; // default width includes bounds of
 108     // calculation
 109
 110     int s, sSize = sequences.size();
 111     SequenceI[] sarray = new SequenceI[sSize];
 112     this.sequences = sarray;
 113     try
 114     {
 115       for (s = 0; s < sSize; s++)
 116       {
 117         sarray[s] = sequences.get(s);
 118         if (sarray[s].getLength() > maxLength)
 119         {
 120           maxLength = sarray[s].getLength();
 121         }
 122       }
 123     } catch (ArrayIndexOutOfBoundsException ex)
 124     {
 125       // bail - another thread has modified the sequence array, so the current
 126       // calculation is probably invalid.
 127       this.sequences = new SequenceI[0];
 128       maxLength = 0;
 129     }
 130   }
 131
 132   /**
 133    * Translate sequence i into a numerical representation and store it in the
 134    * i'th position of the seqNums array.
 135    *
 136    * @param i
 137    */
 138   private void calcSeqNum(int i)
 139   {
 140     String sq = null; // for dumb jbuilder not-inited exception warning
 141     int[] sqnum = null;
 142
 143     int sSize = sequences.length;
 144
 145     if ((i > -1) && (i < sSize))
 146     {
 147       sq = sequences[i].getSequenceAsString();
 148
 149       if (seqNums.size() <= i)
 150       {
 151         seqNums.addElement(new int[sq.length() + 1]);
 152       }
 153
 154       if (sq.hashCode() != ((int[]) seqNums.elementAt(i))[0])
 155       {
 156         int j;
 157         int len;
 158         seqNumsChanged = true;
 159         len = sq.length();
 160
 161         if (maxLength < len)
 162         {
 163           maxLength = len;
 164         }
 165
 166         sqnum = new int[len + 1]; // better to always make a new array -
 167         // sequence can change its length
 168         sqnum[0] = sq.hashCode();
 169
 170         for (j = 1; j <= len; j++)
 171         {
 172           sqnum[j] = jalview.schemes.ResidueProperties.aaIndex[sq
 173                   .charAt(j - 1)];
 174         }
 175
 176         seqNums.setElementAt(sqnum, i);
 177       }
 178       else
 179       {
 180         System.out.println("SEQUENCE HAS BEEN DELETED!!!");
 181       }
 182     }
 183     else
 184     {
 185       // JBPNote INFO level debug
 186       System.err
 187               .println("ERROR: calcSeqNum called with out of range sequence index for Alignment\n");
 188     }
 189   }
 190
 191   /**
 192    * Calculates the conservation values for given set of sequences
 193    */
 194   public void calculate()
 195   {
 196     Hashtable resultHash, ht;
 197     int thresh, j, jSize = sequences.length;
 198     int[] values; // Replaces residueHash
 199     String type, res = null;
 200     char c;
 201     Enumeration enumeration2;
 202
 203     total = new Hashtable[maxLength];
 204
 205     for (int i = start; i <= end; i++)
 206     {
 207       values = new int[255];
 208
 209       for (j = 0; j < jSize; j++)
 210       {
 211         if (sequences[j].getLength() > i)
 212         {
 213           c = sequences[j].getCharAt(i);
 214
 215           if (canonicaliseAa)
 216           { // lookup the base aa code symbol
 217             c = (char) jalview.schemes.ResidueProperties.aaIndex[sequences[j]
 218                     .getCharAt(i)];
 219             if (c > 20)
 220             {
 221               c = '-';
 222             }
 223             else
 224             {
 225               // recover canonical aa symbol
 226               c = jalview.schemes.ResidueProperties.aa[c].charAt(0);
 227             }
 228           }
 229           else
 230           {
 231             // original behaviour - operate on ascii symbols directly
 232             // No need to check if its a '-'
 233             if (c == '.' || c == ' ')
 234             {
 235               c = '-';
 236             }
 237
 238             if (!canonicaliseAa && 'a' <= c && c <= 'z')
 239             {
 240               c -= (32); // 32 = 'a' - 'A'
 241             }
 242           }
 243           values[c]++;
 244         }
 245         else
 246         {
 247           values['-']++;
 248         }
 249       }
 250
 251       // What is the count threshold to count the residues in residueHash()
 252       thresh = (threshold * (jSize)) / 100;
 253
 254       // loop over all the found residues
 255       resultHash = new Hashtable();
 256       for (char v = '-'; v < 'Z'; v++)
 257       {
 258
 259         if (values[v] > thresh)
 260         {
 261           res = String.valueOf(v);
 262
 263           // Now loop over the properties
 264           enumeration2 = propHash.keys();
 265
 266           while (enumeration2.hasMoreElements())
 267           {
 268             type = (String) enumeration2.nextElement();
 269             ht = (Hashtable) propHash.get(type);
 270
 271             // Have we ticked this before?
 272             if (!resultHash.containsKey(type))
 273             {
 274               if (ht.containsKey(res))
 275               {
 276                 resultHash.put(type, ht.get(res));
 277               }
 278               else
 279               {
 280                 resultHash.put(type, ht.get("-"));
 281               }
 282             }
 283             else if (((Integer) resultHash.get(type)).equals(ht.get(res)) == false)
 284             {
 285               resultHash.put(type, new Integer(-1));
 286             }
 287           }
 288         }
 289       }
 290
 291       if (total.length > 0)
 292       {
 293         total[i - start] = resultHash;
 294       }
 295     }
 296   }
 297
 298   /*****************************************************************************
 299    * count conservation for the j'th column of the alignment
 300    *
 301    * @return { gap count, conserved residue count}
 302    */
 303   public int[] countConsNGaps(int j)
 304   {
 305     int count = 0;
 306     int cons = 0;
 307     int nres = 0;
 308     int[] r = new int[2];
 309     char f = '$';
 310     int i, iSize = sequences.length;
 311     char c;
 312
 313     for (i = 0; i < iSize; i++)
 314     {
 315       if (j >= sequences[i].getLength())
 316       {
 317         count++;
 318         continue;
 319       }
 320
 321       c = sequences[i].getCharAt(j); // gaps do not have upper/lower case
 322
 323       if (jalview.util.Comparison.isGap((c)))
 324       {
 325         count++;
 326       }
 327       else
 328       {
 329         nres++;
 330
 331         if (nres == 1)
 332         {
 333           f = c;
 334           cons++;
 335         }
 336         else if (f == c)
 337         {
 338           cons++;
 339         }
 340       }
 341     }
 342
 343     r[0] = (nres == cons) ? 1 : 0;
 344     r[1] = count;
 345
 346     return r;
 347   }
 348
 349   /**
 350    * Calculates the conservation sequence
 351    *
 352    * @param consflag
 353    *          if true, poitiveve conservation; false calculates negative
 354    *          conservation
 355    * @param percentageGaps
 356    *          commonly used value is 25
 357    */
 358   public void verdict(boolean consflag, float percentageGaps)
 359   {
 360     StringBuffer consString = new StringBuffer();
 361     String type;
 362     Integer result;
 363     int[] gapcons;
 364     int totGaps, count;
 365     float pgaps;
 366     Hashtable resultHash;
 367     Enumeration enumeration;
 368
 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++)
 373     {
 374       consString.append('-');
 375     }
 376     consSymbs = new String[end - start + 1];
 377     for (int i = start; i <= end; i++)
 378     {
 379       gapcons = countConsNGaps(i);
 380       totGaps = gapcons[1];
 381       pgaps = ((float) totGaps * 100) / sequences.length;
 382       consSymbs[i - start] = new String();
 383
 384       if (percentageGaps > pgaps)
 385       {
 386         resultHash = total[i - start];
 387         // Now find the verdict
 388         count = 0;
 389         enumeration = resultHash.keys();
 390
 391         while (enumeration.hasMoreElements())
 392         {
 393           type = (String) enumeration.nextElement();
 394           result = (Integer) resultHash.get(type);
 395           // Do we want to count +ve conservation or +ve and -ve cons.?
 396           if (consflag)
 397           {
 398             if (result.intValue() == 1)
 399             {
 400               consSymbs[i - start] = type + " " + consSymbs[i - start];
 401               count++;
 402             }
 403           }
 404           else
 405           {
 406             if (result.intValue() != -1)
 407             {
 408               {
 409                 if (result.intValue() == 0)
 410                 {
 411                   consSymbs[i - start] = consSymbs[i - start] + " !" + type;
 412                 }
 413                 else
 414                 {
 415                   consSymbs[i - start] = type + " " + consSymbs[i - start];
 416                 }
 417               }
 418
 419               count++;
 420             }
 421           }
 422         }
 423
 424         if (count < 10)
 425         {
 426           consString.append(count); // Conserved props!=Identity
 427         }
 428         else
 429         {
 430           consString.append((gapcons[0] == 1) ? "*" : "+");
 431         }
 432       }
 433       else
 434       {
 435         consString.append('-');
 436       }
 437     }
 438
 439     consSequence = new Sequence(name, consString.toString(), start, end);
 440   }
 441
 442   /**
 443    *
 444    *
 445    * @return Conservation sequence
 446    */
 447   public Sequence getConsSequence()
 448   {
 449     return consSequence;
 450   }
 451
 452   // From Alignment.java in jalview118
 453   public void findQuality()
 454   {
 455     findQuality(0, maxLength - 1);
 456   }
 457
 458   /**
 459    * DOCUMENT ME!
 460    */
 461   private void percentIdentity2()
 462   {
 463     seqNums = new Vector();
 464     // calcSeqNum(s);
 465     int i = 0, iSize = sequences.length;
 466     // Do we need to calculate this again?
 467     for (i = 0; i < iSize; i++)
 468     {
 469       calcSeqNum(i);
 470     }
 471
 472     if ((cons2 == null) || seqNumsChanged)
 473     {
 474       cons2 = new int[maxLength][24];
 475
 476       // Initialize the array
 477       for (int j = 0; j < 24; j++)
 478       {
 479         for (i = 0; i < maxLength; i++)
 480         {
 481           cons2[i][j] = 0;
 482         }
 483       }
 484
 485       int[] sqnum;
 486       int j = 0;
 487
 488       while (j < sequences.length)
 489       {
 490         sqnum = (int[]) seqNums.elementAt(j);
 491
 492         for (i = 1; i < sqnum.length; i++)
 493         {
 494           cons2[i - 1][sqnum[i]]++;
 495         }
 496
 497         for (i = sqnum.length - 1; i < maxLength; i++)
 498         {
 499           cons2[i][23]++; // gap count
 500         }
 501
 502         j++;
 503       }
 504
 505       // unnecessary ?
 506
 507       /*
 508        * for (int i=start; i <= end; i++) { int max = -1000; int maxi = -1; int
 509        * maxj = -1;
 510        *
 511        * for (int j=0;j<24;j++) { if (cons2[i][j] > max) { max = cons2[i][j];
 512        * maxi = i; maxj = j; } } }
 513        */
 514     }
 515   }
 516
 517   /**
 518    * Calculates the quality of the set of sequences
 519    *
 520    * @param start
 521    *          Start residue
 522    * @param end
 523    *          End residue
 524    */
 525   public void findQuality(int start, int end)
 526   {
 527     quality = new Vector();
 528
 529     double max = -10000;
 530     int[][] BLOSUM62 = jalview.schemes.ResidueProperties.getBLOSUM62();
 531
 532     // Loop over columns // JBPNote Profiling info
 533     // long ts = System.currentTimeMillis();
 534     // long te = System.currentTimeMillis();
 535     percentIdentity2();
 536
 537     int size = seqNums.size();
 538     int[] lengths = new int[size];
 539     double tot, bigtot, sr, tmp;
 540     double[] x, xx;
 541     int l, j, i, ii, i2, k, seqNum;
 542
 543     for (l = 0; l < size; l++)
 544     {
 545       lengths[l] = ((int[]) seqNums.elementAt(l)).length - 1;
 546     }
 547
 548     for (j = start; j <= end; j++)
 549     {
 550       bigtot = 0;
 551
 552       // First Xr = depends on column only
 553       x = new double[24];
 554
 555       for (ii = 0; ii < 24; ii++)
 556       {
 557         x[ii] = 0;
 558
 559         for (i2 = 0; i2 < 24; i2++)
 560         {
 561           x[ii] += (((double) cons2[j][i2] * BLOSUM62[ii][i2]) + 4);
 562         }
 563
 564         x[ii] /= size;
 565       }
 566
 567       // Now calculate D for each position and sum
 568       for (k = 0; k < size; k++)
 569       {
 570         tot = 0;
 571         xx = new double[24];
 572         seqNum = (j < lengths[k]) ? ((int[]) seqNums.elementAt(k))[j + 1]
 573                 : 23; // Sequence, or gap at the end
 574
 575         // This is a loop over r
 576         for (i = 0; i < 23; i++)
 577         {
 578           sr = 0;
 579
 580           sr = (double) BLOSUM62[i][seqNum] + 4;
 581
 582           // Calculate X with another loop over residues
 583           // System.out.println("Xi " + i + " " + x[i] + " " + sr);
 584           xx[i] = x[i] - sr;
 585
 586           tot += (xx[i] * xx[i]);
 587         }
 588
 589         bigtot += Math.sqrt(tot);
 590       }
 591
 592       // This is the quality for one column
 593       if (max < bigtot)
 594       {
 595         max = bigtot;
 596       }
 597
 598       // bigtot = bigtot * (size-cons2[j][23])/size;
 599       quality.addElement(new Double(bigtot));
 600
 601       // Need to normalize by gaps
 602     }
 603
 604     double newmax = -10000;
 605
 606     for (j = start; j <= end; j++)
 607     {
 608       tmp = ((Double) quality.elementAt(j)).doubleValue();
 609       tmp = ((max - tmp) * (size - cons2[j][23])) / size;
 610
 611       // System.out.println(tmp+ " " + j);
 612       quality.setElementAt(new Double(tmp), j);
 613
 614       if (tmp > newmax)
 615       {
 616         newmax = tmp;
 617       }
 618     }
 619
 620     // System.out.println("Quality " + s);
 621     qualityRange[0] = new Double(0);
 622     qualityRange[1] = new Double(newmax);
 623   }
 624
 625   /**
 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.
 629    *
 630    * @param conservation
 631    *          conservation annotation row
 632    * @param quality2
 633    *          (optional - may be null)
 634    * @param istart
 635    *          first column for conservation
 636    * @param alWidth
 637    *          extent of conservation
 638    */
 639   public void completeAnnotations(AlignmentAnnotation conservation,
 640           AlignmentAnnotation quality2, int istart, int alWidth)
 641   {
 642     char[] sequence = getConsSequence().getSequence();
 643     float minR;
 644     float minG;
 645     float minB;
 646     float maxR;
 647     float maxG;
 648     float maxB;
 649     minR = 0.3f;
 650     minG = 0.0f;
 651     minB = 0f;
 652     maxR = 1.0f - minR;
 653     maxG = 0.9f - minG;
 654     maxB = 0f - minB; // scalable range for colouring both Conservation and
 655     // Quality
 656
 657     float min = 0f;
 658     float max = 11f;
 659     float qmin = 0f;
 660     float qmax = 0f;
 661
 662     char c;
 663
 664     if (conservation.annotations != null
 665             && conservation.annotations.length < alWidth)
 666     {
 667       conservation.annotations = new Annotation[alWidth];
 668     }
 669
 670     if (quality2 != null)
 671     {
 672       quality2.graphMax = qualityRange[1].floatValue();
 673       if (quality2.annotations != null
 674               && quality2.annotations.length < alWidth)
 675       {
 676         quality2.annotations = new Annotation[alWidth];
 677       }
 678       qmin = qualityRange[0].floatValue();
 679       qmax = qualityRange[1].floatValue();
 680     }
 681
 682     for (int i = 0; i < alWidth; i++)
 683     {
 684       float value = 0;
 685
 686       c = sequence[i];
 687
 688       if (Character.isDigit(c))
 689       {
 690         value = c - '0';
 691       }
 692       else if (c == '*')
 693       {
 694         value = 11;
 695       }
 696       else if (c == '+')
 697       {
 698         value = 10;
 699       }
 700
 701       float vprop = value - min;
 702       vprop /= max;
 703       int consp = i - start;
 704       String conssym = (value > 0 && consp > -1 && consp < consSymbs.length) ? consSymbs[consp]
 705               : "";
 706       conservation.annotations[i] = new Annotation(String.valueOf(c),
 707               conssym, ' ', value, new Color(minR + (maxR * vprop), minG
 708                       + (maxG * vprop), minB + (maxB * vprop)));
 709
 710       // Quality calc
 711       if (quality2 != null)
 712       {
 713         value = ((Double) quality.elementAt(i)).floatValue();
 714         vprop = value - qmin;
 715         vprop /= qmax;
 716         quality2.annotations[i] = new Annotation(" ",
 717                 String.valueOf(value), ' ', value, new Color(minR
 718                         + (maxR * vprop), minG + (maxG * vprop), minB
 719                         + (maxB * vprop)));
 720       }
 721     }
 722   }
 723
 724   /**
 725    * construct and call the calculation methods on a new Conservation object
 726    *
 727    * @param name
 728    *          - name of conservation
 729    * @param consHash
 730    *          - hash table of properties for each amino acid (normally
 731    *          ResidueProperties.propHash)
 732    * @param threshold
 733    *          - minimum number of conserved residues needed to indicate
 734    *          conservation (typically 3)
 735    * @param seqs
 736    * @param start
 737    *          first column in calculation window
 738    * @param end
 739    *          last column in calculation window
 740    * @param posOrNeg
 741    *          positive (true) or negative (false) conservation
 742    * @param consPercGaps
 743    *          percentage of gaps tolerated in column
 744    * @param calcQuality
 745    *          flag indicating if alignment quality should be calculated
 746    * @return Conservation object ready for use in visualization
 747    */
 748   public static Conservation calculateConservation(String name,
 749           Hashtable consHash, int threshold, List<SequenceI> seqs,
 750           int start, int end, boolean posOrNeg, int consPercGaps,
 751           boolean calcQuality)
 752   {
 753     Conservation cons = new Conservation(name, consHash, threshold, seqs,
 754             start, end);
 755     return calculateConservation(cons, posOrNeg, consPercGaps, calcQuality);
 756   }
 757
 758   /**
 759    * @param b
 760    *          positive (true) or negative (false) conservation
 761    * @param consPercGaps
 762    *          percentage of gaps tolerated in column
 763    * @param calcQuality
 764    *          flag indicating if alignment quality should be calculated
 765    * @return Conservation object ready for use in visualization
 766    */
 767   public static Conservation calculateConservation(Conservation cons,
 768           boolean b, int consPercGaps, boolean calcQuality)
 769   {
 770     cons.calculate();
 771     cons.verdict(b, consPercGaps);
 772
 773     if (calcQuality)
 774     {
 775       cons.findQuality();
 776     }
 777
 778     return cons;
 779   }
 780 }