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.StructureMapping;
  33 import jalview.structure.StructureViewSettings;
  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.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().equals(pdbid))
 203       {
 204         SequenceFeature tx = new SequenceFeature(features[i]);
 205         tx.setBegin(1 + residues.elementAt(tx.getBegin() - offset).atoms
 206                 .elementAt(0).alignmentMapping);
 207         tx.setEnd(1 + residues.elementAt(tx.getEnd() - offset).atoms
 208                 .elementAt(0).alignmentMapping);
 209         tx.setStatus(status
 210                 + ((tx.getStatus() == null || tx.getStatus().length() == 0) ? ""
 211                         : ":" + tx.getStatus()));
 212         if (tx.begin != 0 && tx.end != 0)
 213         {
 214           sq.addSequenceFeature(tx);
 215         }
 216       }
 217     }
 218     return features;
 219   }
 220
 221   /**
 222    * Traverses the list of residues and constructs bonds where CA-to-CA atoms or
 223    * P-to-P atoms are found. Also sets the 'isNa' flag if more than 99% of
 224    * residues contain a P not a CA.
 225    */
 226   public void makeCaBondList()
 227   {
 228     boolean na = false;
 229     int numNa = 0;
 230     for (int i = 0; i < (residues.size() - 1); i++)
 231     {
 232       Residue tmpres = residues.elementAt(i);
 233       Residue tmpres2 = residues.elementAt(i + 1);
 234       Atom at1 = tmpres.findAtom("CA");
 235       Atom at2 = tmpres2.findAtom("CA");
 236       na = false;
 237       if ((at1 == null) && (at2 == null))
 238       {
 239         na = true;
 240         at1 = tmpres.findAtom("P");
 241         at2 = tmpres2.findAtom("P");
 242       }
 243       if ((at1 != null) && (at2 != null))
 244       {
 245         if (at1.chain.equals(at2.chain))
 246         {
 247           if (na)
 248           {
 249             numNa++;
 250           }
 251           makeBond(at1, at2);
 252         }
 253       }
 254       else
 255       {
 256         System.out.println("not found " + i);
 257       }
 258     }
 259
 260     /*
 261      * If > 99% 'P', flag as nucleotide; note the count doesn't include the last
 262      * residue
 263      */
 264     if (residues.size() > 1 && (numNa / (residues.size() - 1) > 0.99))
 265     {
 266       isNa = true;
 267     }
 268   }
 269
 270   /**
 271    * Construct a bond from atom1 to atom2 and add it to the list of bonds for
 272    * this chain
 273    *
 274    * @param at1
 275    * @param at2
 276    */
 277   public void makeBond(Atom at1, Atom at2)
 278   {
 279     bonds.addElement(new Bond(at1, at2));
 280   }
 281
 282   /**
 283    * Traverses the list of atoms and
 284    * <ul>
 285    * <li>constructs a list of Residues, each containing all the atoms that share
 286    * the same residue number</li>
 287    * <li>adds a RESNUM sequence feature for each position</li>
 288    * <li>creates the sequence string</li>
 289    * <li>determines if nucleotide</li>
 290    * <li>saves the residue number of the first atom as 'offset'</li>
 291    * <li>adds temp factor annotation if the flag is set to do so</li>
 292    * </ul>
 293    *
 294    * @param visibleChainAnnotation
 295    */
 296   public void makeResidueList(boolean visibleChainAnnotation)
 297   {
 298     int count = 0;
 299     Object symbol;
 300     boolean deoxyn = false;
 301     boolean nucleotide = false;
 302     StringBuilder seq = new StringBuilder(256);
 303     Vector<SequenceFeature> resFeatures = new Vector<SequenceFeature>();
 304     Vector<Annotation> resAnnotation = new Vector<Annotation>();
 305     int i, iSize = atoms.size() - 1;
 306     int resNumber = -1;
 307     char insCode = ' ';
 308     for (i = 0; i <= iSize; i++)
 309     {
 310       Atom tmp = atoms.elementAt(i);
 311       resNumber = tmp.resNumber;
 312       insCode = tmp.insCode;
 313
 314       int res = resNumber;
 315       char ins = insCode;
 316
 317       if (i == 0)
 318       {
 319         offset = resNumber;
 320       }
 321
 322       Vector<Atom> resAtoms = new Vector<Atom>();
 323       // Add atoms to a vector while the residue number
 324       // remains the same as the first atom's resNumber (res)
 325       while ((resNumber == res) && (ins == insCode) && (i < atoms.size()))
 326       {
 327         resAtoms.add(atoms.elementAt(i));
 328         i++;
 329
 330         if (i < atoms.size())
 331         {
 332           resNumber = atoms.elementAt(i).resNumber;
 333           insCode = atoms.elementAt(i).insCode;
 334         }
 335         else
 336         {
 337           resNumber++;
 338         }
 339       }
 340
 341       // We need this to keep in step with the outer for i = loop
 342       i--;
 343
 344       // Add inserted residues as features to the base residue
 345       Atom currAtom = resAtoms.get(0);
 346       if (currAtom.insCode != ' '
 347               && !residues.isEmpty()
 348               && residues.lastElement().atoms.get(0).resNumber == currAtom.resNumber)
 349       {
 350         SequenceFeature sf = new SequenceFeature("INSERTION",
 351                 currAtom.resName + ":" + currAtom.resNumIns + " " + pdbid
 352                         + id, "", offset + count - 1, offset + count - 1,
 353                 "PDB_INS");
 354         resFeatures.addElement(sf);
 355         residues.lastElement().atoms.addAll(resAtoms);
 356       }
 357       else
 358       {
 359
 360       // Make a new Residue object with the new atoms vector
 361       residues.addElement(new Residue(resAtoms, resNumber - 1, count));
 362
 363       Residue tmpres = residues.lastElement();
 364       Atom tmpat = tmpres.atoms.get(0);
 365       // Make A new SequenceFeature for the current residue numbering
 366         SequenceFeature sf = new SequenceFeature("RESNUM", tmpat.resName
 367               + ":" + tmpat.resNumIns + " " + pdbid + id, "", offset
 368               + count, offset + count, pdbid);
 369       resFeatures.addElement(sf);
 370       resAnnotation.addElement(new Annotation(tmpat.tfactor));
 371       // Keep totting up the sequence
 372
 373       if ((symbol = ResidueProperties.getAA3Hash().get(tmpat.resName)) == null)
 374       {
 375         String nucname = tmpat.resName.trim();
 376         // use the aaIndex rather than call 'toLower' - which would take a bit
 377         // more time.
 378         deoxyn = nucname.length() == 2
 379                 && ResidueProperties.aaIndex[nucname.charAt(0)] == ResidueProperties.aaIndex['D'];
 380         if (tmpat.name.equalsIgnoreCase("CA")
 381                 || ResidueProperties.nucleotideIndex[nucname
 382                         .charAt((deoxyn ? 1 : 0))] == -1)
 383         {
 384             char r = ResidueProperties
 385                     .getSingleCharacterCode(ResidueProperties
 386                             .getCanonicalAminoAcid(tmpat.resName));
 387             seq.append(r == '0' ? 'X' : r);
 388             // System.err.println("PDBReader:Null aa3Hash for " +
 389             // tmpat.resName);
 390         }
 391         else
 392         {
 393           // nucleotide flag
 394           nucleotide = true;
 395           seq.append(nucname.charAt((deoxyn ? 1 : 0)));
 396         }
 397       }
 398       else
 399       {
 400         if (nucleotide)
 401         {
 402           System.err
 403                   .println("Warning: mixed nucleotide and amino acid chain.. its gonna do bad things to you!");
 404         }
 405         seq.append(ResidueProperties.aa[((Integer) symbol).intValue()]);
 406       }
 407         count++;
 408       }
 409     }
 410
 411     if (id.length() < 1)
 412     {
 413       id = " ";
 414     }
 415     isNa = nucleotide;
 416     sequence = new Sequence(id, seq.toString(), offset, resNumber - 1); // Note:
 417     // resNumber-offset
 418     // ~=
 419     // seq.size()
 420     // Add normalised feature scores to RESNUM indicating start/end of sequence
 421     // sf.setScore(offset+count);
 422
 423     // System.out.println("PDB Sequence is :\nSequence = " + seq);
 424     // System.out.println("No of residues = " + residues.size());
 425
 426     if (StructureViewSettings.isShowSeqFeatures())
 427     {
 428     for (i = 0, iSize = resFeatures.size(); i < iSize; i++)
 429     {
 430       sequence.addSequenceFeature(resFeatures.elementAt(i));
 431       resFeatures.setElementAt(null, i);
 432     }
 433     }
 434     if (visibleChainAnnotation)
 435     {
 436       Annotation[] annots = new Annotation[resAnnotation.size()];
 437       float max = 0;
 438       for (i = 0, iSize = annots.length; i < iSize; i++)
 439       {
 440         annots[i] = resAnnotation.elementAt(i);
 441         if (annots[i].value > max)
 442         {
 443           max = annots[i].value;
 444         }
 445         resAnnotation.setElementAt(null, i);
 446       }
 447
 448       AlignmentAnnotation tfactorann = new AlignmentAnnotation(
 449               "Temperature Factor", "Temperature Factor for " + pdbid + id,
 450               annots, 0, max, AlignmentAnnotation.LINE_GRAPH);
 451       tfactorann.setSequenceRef(sequence);
 452       sequence.addAlignmentAnnotation(tfactorann);
 453     }
 454   }
 455
 456   /**
 457    * Colour start/end of bonds by charge
 458    * <ul>
 459    * <li>ASP and GLU red</li>
 460    * <li>LYS and ARG blue</li>
 461    * <li>CYS yellow</li>
 462    * <li>others light gray</li>
 463    * </ul>
 464    */
 465   public void setChargeColours()
 466   {
 467     for (Bond b : bonds)
 468     {
 469       if (b.at1 != null && b.at2 != null)
 470       {
 471         b.startCol = getChargeColour(b.at1.resName);
 472         b.endCol = getChargeColour(b.at2.resName);
 473       }
 474       else
 475       {
 476         b.startCol = Color.gray;
 477         b.endCol = Color.gray;
 478       }
 479     }
 480   }
 481
 482   public static Color getChargeColour(String resName)
 483   {
 484     Color result = Color.lightGray;
 485     if ("ASP".equals(resName) || "GLU".equals(resName))
 486     {
 487       result = Color.red;
 488     }
 489     else if ("LYS".equals(resName) || "ARG".equals(resName))
 490     {
 491       result = Color.blue;
 492     }
 493     else if ("CYS".equals(resName))
 494     {
 495       result = Color.yellow;
 496     }
 497     return result;
 498   }
 499
 500   /**
 501    * Sets the start/end colours of bonds to those of the start/end atoms
 502    * according to the specified colour scheme. Note: currently only works for
 503    * peptide residues.
 504    *
 505    * @param cs
 506    */
 507   public void setChainColours(ColourSchemeI cs)
 508   {
 509     int index;
 510     for (Bond b : bonds)
 511     {
 512       try
 513       {
 514         index = ResidueProperties.aa3Hash.get(b.at1.resName).intValue();
 515         b.startCol = cs.findColour(ResidueProperties.aa[index].charAt(0));
 516
 517         index = ResidueProperties.aa3Hash.get(b.at2.resName).intValue();
 518         b.endCol = cs.findColour(ResidueProperties.aa[index].charAt(0));
 519
 520       } catch (Exception e)
 521       {
 522         b.startCol = Color.gray;
 523         b.endCol = Color.gray;
 524       }
 525     }
 526   }
 527
 528   public void setChainColours(Color col)
 529   {
 530     for (Bond b : bonds)
 531     {
 532       b.startCol = col;
 533       b.endCol = col;
 534     }
 535   }
 536
 537   /**
 538    * copy any sequence annotation onto the sequence mapped using the provided
 539    * StructureMapping
 540    *
 541    * @param mapping
 542    *          - positional mapping between destination sequence and pdb resnum
 543    * @param sqmpping
 544    *          - mapping between destination sequence and local chain
 545    */
 546   public void transferResidueAnnotation(StructureMapping mapping,
 547           jalview.datamodel.Mapping sqmpping)
 548   {
 549     SequenceI sq = mapping.getSequence();
 550     SequenceI dsq = sq;
 551     if (sq != null)
 552     {
 553       while (dsq.getDatasetSequence() != null)
 554       {
 555         dsq = dsq.getDatasetSequence();
 556       }
 557       // any annotation will be transferred onto the dataset sequence
 558
 559       if (shadow != null && shadow.getAnnotation() != null)
 560       {
 561
 562         for (AlignmentAnnotation ana : shadow.getAnnotation())
 563         {
 564           List<AlignmentAnnotation> transfer = sq.getAlignmentAnnotations(
 565                   ana.getCalcId(), ana.label);
 566           if (transfer == null || transfer.size() == 0)
 567           {
 568             ana = new AlignmentAnnotation(ana);
 569             ana.liftOver(sequence, shadowMap);
 570             ana.liftOver(dsq, sqmpping);
 571             dsq.addAlignmentAnnotation(ana);
 572           }
 573           else
 574           {
 575             continue;
 576           }
 577         }
 578       }
 579       else
 580       {
 581         if (sequence != null && sequence.getAnnotation() != null)
 582         {
 583           for (AlignmentAnnotation ana : sequence.getAnnotation())
 584           {
 585             List<AlignmentAnnotation> transfer = sq
 586                     .getAlignmentAnnotations(ana.getCalcId(), ana.label);
 587             if (transfer == null || transfer.size() == 0)
 588             {
 589               ana = new AlignmentAnnotation(ana);
 590               ana.liftOver(dsq, sqmpping);
 591               // mapping.transfer(ana);
 592             }
 593             else
 594             {
 595               continue;
 596             }
 597           }
 598         }
 599       }
 600       if (false)
 601       {
 602         // Useful for debugging mappings - adds annotation for mapped position
 603         float min = -1, max = 0;
 604         Annotation[] an = new Annotation[sq.getEnd() - sq.getStart() + 1];
 605         for (int i = sq.getStart(), j = sq.getEnd(), k = 0; i <= j; i++, k++)
 606         {
 607           int prn = mapping.getPDBResNum(k + 1);
 608
 609           an[k] = new Annotation(prn);
 610           if (min == -1)
 611           {
 612             min = k;
 613             max = k;
 614           }
 615           else
 616           {
 617             if (min > k)
 618             {
 619               min = k;
 620             }
 621             else if (max < k)
 622             {
 623               max = k;
 624             }
 625           }
 626         }
 627         sq.addAlignmentAnnotation(new AlignmentAnnotation("PDB.RESNUM",
 628                 "PDB Residue Numbering for " + this.pdbid + ":" + this.id,
 629                 an, min, max, AlignmentAnnotation.LINE_GRAPH));
 630       }
 631     }
 632   }
 633 }