src/MCview/PDBChain.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 MCview;
  22
  23 import jalview.analysis.AlignSeq;
  24 import jalview.datamodel.AlignmentAnnotation;
  25 import jalview.datamodel.Annotation;
  26 import jalview.datamodel.Mapping;
  27 import jalview.datamodel.Sequence;
  28 import jalview.datamodel.SequenceFeature;
  29 import jalview.datamodel.SequenceI;
  30 import jalview.schemes.ColourSchemeI;
  31 import jalview.schemes.ResidueProperties;
  32 import jalview.structure.StructureImportSettings;
  33 import jalview.structure.StructureMapping;
  34
  35 import java.awt.Color;
  36 import java.util.List;
  37 import java.util.Vector;
  38
  39 public class PDBChain
  40 {
  41   /**
  42    * SequenceFeature group for PDB File features added to sequences
  43    */
  44   private static final String PDBFILEFEATURE = "PDBFile";
  45
  46   private static final String IEASTATUS = "IEA:jalview";
  47
  48   public String id;
  49
  50   public Vector<Bond> bonds = new Vector<Bond>();
  51
  52   public Vector<Atom> atoms = new Vector<Atom>();
  53
  54   public Vector<Residue> residues = new Vector<Residue>();
  55
  56   public int offset;
  57
  58   /**
  59    * sequence is the sequence extracted by the chain parsing code
  60    */
  61   public SequenceI sequence;
  62
  63   /**
  64    * shadow is the sequence created by any other parsing processes (e.g. Jmol,
  65    * RNAview)
  66    */
  67   public SequenceI shadow = null;
  68
  69   public boolean isNa = false;
  70
  71   public boolean isVisible = true;
  72
  73   public int pdbstart = 0;
  74
  75   public int pdbend = 0;
  76
  77   public int seqstart = 0;
  78
  79   public int seqend = 0;
  80
  81   public String pdbid = "";
  82
  83   public PDBChain(String pdbid, String id)
  84   {
  85     this.pdbid = pdbid == null ? pdbid : pdbid.toLowerCase();
  86     this.id = id;
  87   }
  88
  89   /**
  90    * character used to write newlines
  91    */
  92   protected String newline = System.getProperty("line.separator");
  93
  94   public Mapping shadowMap;
  95
  96   public void setNewlineString(String nl)
  97   {
  98     newline = nl;
  99   }
 100
 101   public String getNewlineString()
 102   {
 103     return newline;
 104   }
 105
 106   public String print()
 107   {
 108     StringBuilder tmp = new StringBuilder(256);
 109
 110     for (Bond b : bonds)
 111     {
 112       tmp.append(b.at1.resName).append(" ").append(b.at1.resNumber)
 113               .append(" ").append(offset).append(newline);
 114     }
 115
 116     return tmp.toString();
 117   }
 118
 119   /**
 120    * Annotate the residues with their corresponding positions in s1 using the
 121    * alignment in as NOTE: This clears all atom.alignmentMapping values on the
 122    * structure.
 123    *
 124    * @param as
 125    * @param s1
 126    */
 127   public void makeExactMapping(AlignSeq as, SequenceI s1)
 128   {
 129     int pdbpos = as.getSeq2Start() - 2;
 130     int alignpos = s1.getStart() + as.getSeq1Start() - 3;
 131     // first clear out any old alignmentMapping values:
 132     for (Atom atom : atoms)
 133     {
 134       atom.alignmentMapping = -1;
 135     }
 136     // and now trace the alignment onto the atom set.
 137     for (int i = 0; i < as.astr1.length(); i++)
 138     {
 139       if (as.astr1.charAt(i) != '-')
 140       {
 141         alignpos++;
 142       }
 143
 144       if (as.astr2.charAt(i) != '-')
 145       {
 146         pdbpos++;
 147       }
 148
 149       if (as.astr1.charAt(i) == as.astr2.charAt(i))
 150       {
 151         if (pdbpos >= residues.size())
 152         {
 153           continue;
 154         }
 155         Residue res = residues.elementAt(pdbpos);
 156         for (Atom atom : res.atoms)
 157         {
 158           atom.alignmentMapping = alignpos;
 159         }
 160       }
 161     }
 162   }
 163
 164   /**
 165    * copy over the RESNUM seqfeatures from the internal chain sequence to the
 166    * mapped sequence
 167    *
 168    * @param seq
 169    * @param status
 170    *          The Status of the transferred annotation
 171    * @return the features added to sq (or its dataset)
 172    */
 173   public SequenceFeature[] transferRESNUMFeatures(SequenceI seq,
 174           String status)
 175   {
 176     SequenceI sq = seq;
 177     while (sq != null && sq.getDatasetSequence() != null)
 178     {
 179       sq = sq.getDatasetSequence();
 180       if (sq == sequence)
 181       {
 182         return null;
 183       }
 184     }
 185     /**
 186      * Remove any existing features for this chain if they exist ?
 187      * SequenceFeature[] seqsfeatures=seq.getSequenceFeatures(); int
 188      * totfeat=seqsfeatures.length; // Remove any features for this exact chain
 189      * ? for (int i=0; i<seqsfeatures.length; i++) { }
 190      */
 191     if (status == null)
 192     {
 193       status = PDBChain.IEASTATUS;
 194     }
 195     SequenceFeature[] features = sequence.getSequenceFeatures();
 196     if (features == null)
 197     {
 198       return null;
 199     }
 200     for (int i = 0; i < features.length; i++)
 201     {
 202       if (features[i].getFeatureGroup() != null
 203               && features[i].getFeatureGroup().equals(pdbid))
 204       {
 205         SequenceFeature tx = new SequenceFeature(features[i]);
 206         tx.setBegin(1 + residues.elementAt(tx.getBegin() - offset).atoms
 207                 .elementAt(0).alignmentMapping);
 208         tx.setEnd(1 + residues.elementAt(tx.getEnd() - offset).atoms
 209                 .elementAt(0).alignmentMapping);
 210         tx.setStatus(status
 211                 + ((tx.getStatus() == null || tx.getStatus().length() == 0) ? ""
 212                         : ":" + tx.getStatus()));
 213         if (tx.begin != 0 && tx.end != 0)
 214         {
 215           sq.addSequenceFeature(tx);
 216         }
 217       }
 218     }
 219     return features;
 220   }
 221
 222   /**
 223    * Traverses the list of residues and constructs bonds where CA-to-CA atoms or
 224    * P-to-P atoms are found. Also sets the 'isNa' flag if more than 99% of
 225    * residues contain a P not a CA.
 226    */
 227   public void makeCaBondList()
 228   {
 229     boolean na = false;
 230     int numNa = 0;
 231     for (int i = 0; i < (residues.size() - 1); i++)
 232     {
 233       Residue tmpres = residues.elementAt(i);
 234       Residue tmpres2 = residues.elementAt(i + 1);
 235       Atom at1 = tmpres.findAtom("CA");
 236       Atom at2 = tmpres2.findAtom("CA");
 237       na = false;
 238       if ((at1 == null) && (at2 == null))
 239       {
 240         na = true;
 241         at1 = tmpres.findAtom("P");
 242         at2 = tmpres2.findAtom("P");
 243       }
 244       if ((at1 != null) && (at2 != null))
 245       {
 246         if (at1.chain.equals(at2.chain))
 247         {
 248           if (na)
 249           {
 250             numNa++;
 251           }
 252           makeBond(at1, at2);
 253         }
 254       }
 255       else
 256       {
 257         System.out.println("not found " + i);
 258       }
 259     }
 260
 261     /*
 262      * If > 99% 'P', flag as nucleotide; note the count doesn't include the last
 263      * residue
 264      */
 265     if (residues.size() > 1 && (numNa / (residues.size() - 1) > 0.99))
 266     {
 267       isNa = true;
 268     }
 269   }
 270
 271   /**
 272    * Construct a bond from atom1 to atom2 and add it to the list of bonds for
 273    * this chain
 274    *
 275    * @param at1
 276    * @param at2
 277    */
 278   public void makeBond(Atom at1, Atom at2)
 279   {
 280     bonds.addElement(new Bond(at1, at2));
 281   }
 282
 283   /**
 284    * Traverses the list of atoms and
 285    * <ul>
 286    * <li>constructs a list of Residues, each containing all the atoms that share
 287    * the same residue number</li>
 288    * <li>adds a RESNUM sequence feature for each position</li>
 289    * <li>creates the sequence string</li>
 290    * <li>determines if nucleotide</li>
 291    * <li>saves the residue number of the first atom as 'offset'</li>
 292    * <li>adds temp factor annotation if the flag is set to do so</li>
 293    * </ul>
 294    *
 295    * @param visibleChainAnnotation
 296    */
 297   public void makeResidueList(boolean visibleChainAnnotation)
 298   {
 299     int count = 0;
 300     Object symbol;
 301     boolean deoxyn = false;
 302     boolean nucleotide = false;
 303     StringBuilder seq = new StringBuilder(256);
 304     Vector<SequenceFeature> resFeatures = new Vector<SequenceFeature>();
 305     Vector<Annotation> resAnnotation = new Vector<Annotation>();
 306     int i, iSize = atoms.size() - 1;
 307     int resNumber = -1;
 308     char insCode = ' ';
 309     for (i = 0; i <= iSize; i++)
 310     {
 311       Atom tmp = atoms.elementAt(i);
 312       resNumber = tmp.resNumber;
 313       insCode = tmp.insCode;
 314
 315       int res = resNumber;
 316       char ins = insCode;
 317
 318       if (i == 0)
 319       {
 320         offset = resNumber;
 321       }
 322
 323       Vector<Atom> resAtoms = new Vector<Atom>();
 324       // Add atoms to a vector while the residue number
 325       // remains the same as the first atom's resNumber (res)
 326       while ((resNumber == res) && (ins == insCode) && (i < atoms.size()))
 327       {
 328         resAtoms.add(atoms.elementAt(i));
 329         i++;
 330
 331         if (i < atoms.size())
 332         {
 333           resNumber = atoms.elementAt(i).resNumber;
 334           insCode = atoms.elementAt(i).insCode;
 335         }
 336         else
 337         {
 338           resNumber++;
 339         }
 340       }
 341
 342       // We need this to keep in step with the outer for i = loop
 343       i--;
 344
 345       // Add inserted residues as features to the base residue
 346       Atom currAtom = resAtoms.get(0);
 347       if (currAtom.insCode != ' '
 348               && !residues.isEmpty()
 349               && residues.lastElement().atoms.get(0).resNumber == currAtom.resNumber)
 350       {
 351         SequenceFeature sf = new SequenceFeature("INSERTION",
 352                 currAtom.resName + ":" + currAtom.resNumIns + " " + pdbid
 353                         + id, "", offset + count - 1, offset + count - 1,
 354                 "PDB_INS");
 355         resFeatures.addElement(sf);
 356         residues.lastElement().atoms.addAll(resAtoms);
 357       }
 358       else
 359       {
 360
 361         // Make a new Residue object with the new atoms vector
 362         residues.addElement(new Residue(resAtoms, resNumber - 1, count));
 363
 364         Residue tmpres = residues.lastElement();
 365         Atom tmpat = tmpres.atoms.get(0);
 366         // Make A new SequenceFeature for the current residue numbering
 367         SequenceFeature sf = new SequenceFeature("RESNUM", tmpat.resName
 368                 + ":" + tmpat.resNumIns + " " + pdbid + id, "", offset
 369                 + count, offset + count, pdbid);
 370         resFeatures.addElement(sf);
 371         resAnnotation.addElement(new Annotation(tmpat.tfactor));
 372         // Keep totting up the sequence
 373
 374         if ((symbol = ResidueProperties.getAA3Hash().get(tmpat.resName)) == null)
 375         {
 376           String nucname = tmpat.resName.trim();
 377           // use the aaIndex rather than call 'toLower' - which would take a bit
 378           // more time.
 379           deoxyn = nucname.length() == 2
 380                   && ResidueProperties.aaIndex[nucname.charAt(0)] == ResidueProperties.aaIndex['D'];
 381           if (tmpat.name.equalsIgnoreCase("CA")
 382                   || ResidueProperties.nucleotideIndex[nucname
 383                           .charAt((deoxyn ? 1 : 0))] == -1)
 384           {
 385             char r = ResidueProperties
 386                     .getSingleCharacterCode(ResidueProperties
 387                             .getCanonicalAminoAcid(tmpat.resName));
 388             seq.append(r == '0' ? 'X' : r);
 389             // System.err.println("PDBReader:Null aa3Hash for " +
 390             // tmpat.resName);
 391           }
 392           else
 393           {
 394             // nucleotide flag
 395             nucleotide = true;
 396             seq.append(nucname.charAt((deoxyn ? 1 : 0)));
 397           }
 398         }
 399         else
 400         {
 401           if (nucleotide)
 402           {
 403             System.err
 404                     .println("Warning: mixed nucleotide and amino acid chain.. its gonna do bad things to you!");
 405           }
 406           seq.append(ResidueProperties.aa[((Integer) symbol).intValue()]);
 407         }
 408         count++;
 409       }
 410     }
 411
 412     if (id.length() < 1)
 413     {
 414       id = " ";
 415     }
 416     isNa = nucleotide;
 417     sequence = new Sequence(id, seq.toString(), offset, resNumber - 1); // Note:
 418     // resNumber-offset
 419     // ~=
 420     // seq.size()
 421     // Add normalised feature scores to RESNUM indicating start/end of sequence
 422     // sf.setScore(offset+count);
 423
 424     // System.out.println("PDB Sequence is :\nSequence = " + seq);
 425     // System.out.println("No of residues = " + residues.size());
 426
 427     if (StructureImportSettings.isShowSeqFeatures())
 428     {
 429       for (i = 0, iSize = resFeatures.size(); i < iSize; i++)
 430       {
 431         sequence.addSequenceFeature(resFeatures.elementAt(i));
 432         resFeatures.setElementAt(null, i);
 433       }
 434     }
 435     if (visibleChainAnnotation)
 436     {
 437       Annotation[] annots = new Annotation[resAnnotation.size()];
 438       float max = 0;
 439       for (i = 0, iSize = annots.length; i < iSize; i++)
 440       {
 441         annots[i] = resAnnotation.elementAt(i);
 442         if (annots[i].value > max)
 443         {
 444           max = annots[i].value;
 445         }
 446         resAnnotation.setElementAt(null, i);
 447       }
 448
 449       AlignmentAnnotation tfactorann = new AlignmentAnnotation(
 450               "Temperature Factor", "Temperature Factor for " + pdbid + id,
 451               annots, 0, max, AlignmentAnnotation.LINE_GRAPH);
 452       tfactorann.setSequenceRef(sequence);
 453       sequence.addAlignmentAnnotation(tfactorann);
 454     }
 455   }
 456
 457   /**
 458    * Colour start/end of bonds by charge
 459    * <ul>
 460    * <li>ASP and GLU red</li>
 461    * <li>LYS and ARG blue</li>
 462    * <li>CYS yellow</li>
 463    * <li>others light gray</li>
 464    * </ul>
 465    */
 466   public void setChargeColours()
 467   {
 468     for (Bond b : bonds)
 469     {
 470       if (b.at1 != null && b.at2 != null)
 471       {
 472         b.startCol = getChargeColour(b.at1.resName);
 473         b.endCol = getChargeColour(b.at2.resName);
 474       }
 475       else
 476       {
 477         b.startCol = Color.gray;
 478         b.endCol = Color.gray;
 479       }
 480     }
 481   }
 482
 483   public static Color getChargeColour(String resName)
 484   {
 485     Color result = Color.lightGray;
 486     if ("ASP".equals(resName) || "GLU".equals(resName))
 487     {
 488       result = Color.red;
 489     }
 490     else if ("LYS".equals(resName) || "ARG".equals(resName))
 491     {
 492       result = Color.blue;
 493     }
 494     else if ("CYS".equals(resName))
 495     {
 496       result = Color.yellow;
 497     }
 498     return result;
 499   }
 500
 501   /**
 502    * Sets the start/end colours of bonds to those of the start/end atoms
 503    * according to the specified colour scheme. Note: currently only works for
 504    * peptide residues.
 505    *
 506    * @param cs
 507    */
 508   public void setChainColours(ColourSchemeI cs)
 509   {
 510     int index;
 511     for (Bond b : bonds)
 512     {
 513       try
 514       {
 515         index = ResidueProperties.aa3Hash.get(b.at1.resName).intValue();
 516         b.startCol = cs.findColour(ResidueProperties.aa[index].charAt(0));
 517
 518         index = ResidueProperties.aa3Hash.get(b.at2.resName).intValue();
 519         b.endCol = cs.findColour(ResidueProperties.aa[index].charAt(0));
 520
 521       } catch (Exception e)
 522       {
 523         b.startCol = Color.gray;
 524         b.endCol = Color.gray;
 525       }
 526     }
 527   }
 528
 529   public void setChainColours(Color col)
 530   {
 531     for (Bond b : bonds)
 532     {
 533       b.startCol = col;
 534       b.endCol = col;
 535     }
 536   }
 537
 538   /**
 539    * copy any sequence annotation onto the sequence mapped using the provided
 540    * StructureMapping
 541    *
 542    * @param mapping
 543    *          - positional mapping between destination sequence and pdb resnum
 544    * @param sqmpping
 545    *          - mapping between destination sequence and local chain
 546    */
 547   public void transferResidueAnnotation(StructureMapping mapping,
 548           jalview.datamodel.Mapping sqmpping)
 549   {
 550     SequenceI sq = mapping.getSequence();
 551     SequenceI dsq = sq;
 552     if (sq != null)
 553     {
 554       while (dsq.getDatasetSequence() != null)
 555       {
 556         dsq = dsq.getDatasetSequence();
 557       }
 558       // any annotation will be transferred onto the dataset sequence
 559
 560       if (shadow != null && shadow.getAnnotation() != null)
 561       {
 562
 563         for (AlignmentAnnotation ana : shadow.getAnnotation())
 564         {
 565           List<AlignmentAnnotation> transfer = sq.getAlignmentAnnotations(
 566                   ana.getCalcId(), ana.label);
 567           if (transfer == null || transfer.size() == 0)
 568           {
 569             ana = new AlignmentAnnotation(ana);
 570             ana.liftOver(sequence, shadowMap);
 571             ana.liftOver(dsq, sqmpping);
 572             dsq.addAlignmentAnnotation(ana);
 573           }
 574           else
 575           {
 576             continue;
 577           }
 578         }
 579       }
 580       else
 581       {
 582         if (sequence != null && sequence.getAnnotation() != null)
 583         {
 584           for (AlignmentAnnotation ana : sequence.getAnnotation())
 585           {
 586             List<AlignmentAnnotation> transfer = dsq
 587                     .getAlignmentAnnotations(ana.getCalcId(), ana.label);
 588             if (transfer == null || transfer.size() == 0)
 589             {
 590               ana = new AlignmentAnnotation(ana);
 591               ana.liftOver(dsq, sqmpping);
 592               dsq.addAlignmentAnnotation(ana);
 593               // mapping.transfer(ana);
 594             }
 595             else
 596             {
 597               continue;
 598             }
 599           }
 600         }
 601       }
 602       if (false)
 603       {
 604         // Useful for debugging mappings - adds annotation for mapped position
 605         float min = -1, max = 0;
 606         Annotation[] an = new Annotation[sq.getEnd() - sq.getStart() + 1];
 607         for (int i = sq.getStart(), j = sq.getEnd(), k = 0; i <= j; i++, k++)
 608         {
 609           int prn = mapping.getPDBResNum(k + 1);
 610
 611           an[k] = new Annotation(prn);
 612           if (min == -1)
 613           {
 614             min = k;
 615             max = k;
 616           }
 617           else
 618           {
 619             if (min > k)
 620             {
 621               min = k;
 622             }
 623             else if (max < k)
 624             {
 625               max = k;
 626             }
 627           }
 628         }
 629         sq.addAlignmentAnnotation(new AlignmentAnnotation("PDB.RESNUM",
 630                 "PDB Residue Numbering for " + this.pdbid + ":" + this.id,
 631                 an, min, max, AlignmentAnnotation.LINE_GRAPH));
 632       }
 633     }
 634   }
 635 }