src/jalview/ext/jmol/JmolParser.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.ext.jmol;
  22
  23 import jalview.datamodel.AlignmentAnnotation;
  24 import jalview.datamodel.Annotation;
  25 import jalview.datamodel.SequenceI;
  26 import jalview.io.FileParse;
  27 import jalview.io.StructureFile;
  28 import jalview.schemes.ResidueProperties;
  29 import jalview.structure.StructureImportSettings;
  30 import jalview.util.MessageManager;
  31
  32 import java.io.IOException;
  33 import java.util.ArrayList;
  34 import java.util.HashMap;
  35 import java.util.List;
  36 import java.util.Map;
  37 import java.util.Vector;
  38
  39 import javajs.awt.Dimension;
  40
  41 import org.jmol.api.JmolStatusListener;
  42 import org.jmol.api.JmolViewer;
  43 import org.jmol.c.CBK;
  44 import org.jmol.c.STR;
  45 import org.jmol.modelset.ModelSet;
  46 import org.jmol.viewer.Viewer;
  47
  48 import MCview.Atom;
  49 import MCview.PDBChain;
  50 import MCview.Residue;
  51
  52 /**
  53  * Import and process files with Jmol for file like PDB, mmCIF
  54  *
  55  * @author jprocter
  56  *
  57  */
  58 public class JmolParser extends StructureFile implements JmolStatusListener
  59 {
  60   Viewer viewer = null;
  61
  62   public JmolParser(boolean addAlignmentAnnotations, boolean predictSecStr,
  63           boolean externalSecStr, String inFile, String type)
  64           throws IOException
  65   {
  66     super(inFile, type);
  67   }
  68
  69   public JmolParser(boolean addAlignmentAnnotations, boolean predictSecStr,
  70           boolean externalSecStr, FileParse fp) throws IOException
  71   {
  72     super(fp);
  73   }
  74
  75   public JmolParser()
  76   {
  77   }
  78
  79   /**
  80    * Calls the Jmol library to parse the PDB/mmCIF file, and then inspects the
  81    * resulting object model to generate Jalview-style sequences, with secondary
  82    * structure annotation added where available (i.e. where it has been computed
  83    * by Jmol using DSSP).
  84    *
  85    * @see jalview.io.AlignFile#parse()
  86    */
  87   @Override
  88   public void parse() throws IOException
  89   {
  90     setChains(new Vector<PDBChain>());
  91     Viewer jmolModel = getJmolData();
  92     jmolModel.openReader(getDataName(), getDataName(), getReader());
  93     waitForScript(jmolModel);
  94
  95     /*
  96      * Convert one or more Jmol Model objects to Jalview sequences
  97      */
  98     if (jmolModel.ms.mc > 0)
  99     {
 100       transformJmolModelToJalview(jmolModel.ms);
 101     }
 102   }
 103
 104   /**
 105    * create a headless jmol instance for dataprocessing
 106    *
 107    * @return
 108    */
 109   private Viewer getJmolData()
 110   {
 111     if (viewer == null)
 112     {
 113       try
 114       {
 115         viewer = (Viewer) JmolViewer.allocateViewer(null, null, null, null,
 116                 null, "-x -o -n", this);
 117         // ensure the 'new' (DSSP) not 'old' (Ramachandran) SS method is used
 118         viewer.setBooleanProperty("defaultStructureDSSP", true);
 119       } catch (ClassCastException x)
 120       {
 121         throw new Error(MessageManager.formatMessage(
 122                 "error.jmol_version_not_compatible_with_jalview_version",
 123                 new String[] { JmolViewer.getJmolVersion() }), x);
 124       }
 125     }
 126     return viewer;
 127   }
 128
 129   public void transformJmolModelToJalview(ModelSet ms) throws IOException
 130   {
 131     try
 132     {
 133       String lastID = "";
 134       List<SequenceI> rna = new ArrayList<SequenceI>();
 135       List<SequenceI> prot = new ArrayList<SequenceI>();
 136       PDBChain tmpchain;
 137       String pdbId = (String) ms.getInfo(0, "title");
 138       setId(pdbId);
 139       List<Atom> significantAtoms = convertSignificantAtoms(ms);
 140       for (Atom tmpatom : significantAtoms)
 141       {
 142         try
 143         {
 144           tmpchain = findChain(tmpatom.chain);
 145           if (tmpatom.resNumIns.trim().equals(lastID))
 146           {
 147             // phosphorylated protein - seen both CA and P..
 148             continue;
 149           }
 150           tmpchain.atoms.addElement(tmpatom);
 151         } catch (Exception e)
 152         {
 153           tmpchain = new PDBChain(pdbId, tmpatom.chain);
 154           getChains().add(tmpchain);
 155           tmpchain.atoms.addElement(tmpatom);
 156         }
 157         lastID = tmpatom.resNumIns.trim();
 158       }
 159       xferSettings();
 160
 161       makeResidueList();
 162       makeCaBondList();
 163
 164       if (getId() == null)
 165       {
 166         setId(safeName(getDataName()));
 167       }
 168       for (PDBChain chain : getChains())
 169       {
 170         SequenceI chainseq = postProcessChain(chain);
 171         if (isRNA(chainseq))
 172         {
 173           rna.add(chainseq);
 174         }
 175         else
 176         {
 177           prot.add(chainseq);
 178         }
 179
 180         if (StructureImportSettings.isProcessSecondaryStructure())
 181         {
 182           createAnnotation(chainseq, chain, ms.at);
 183         }
 184       }
 185     } catch (OutOfMemoryError er)
 186     {
 187       System.out
 188               .println("OUT OF MEMORY LOADING TRANSFORMING JMOL MODEL TO JALVIEW MODEL");
 189       throw new IOException(
 190               MessageManager
 191                       .getString("exception.outofmemory_loading_mmcif_file"));
 192     }
 193   }
 194
 195   private List<Atom> convertSignificantAtoms(ModelSet ms)
 196   {
 197     List<Atom> significantAtoms = new ArrayList<Atom>();
 198     HashMap<String, org.jmol.modelset.Atom> chainTerMap = new HashMap<String, org.jmol.modelset.Atom>();
 199     org.jmol.modelset.Atom prevAtom = null;
 200     for (org.jmol.modelset.Atom atom : ms.at)
 201     {
 202       if (atom.getAtomName().equalsIgnoreCase("CA")
 203               || atom.getAtomName().equalsIgnoreCase("P"))
 204       {
 205         if (!atomValidated(atom, prevAtom, chainTerMap))
 206         {
 207           continue;
 208         }
 209         Atom curAtom = new Atom(atom.x, atom.y, atom.z);
 210         curAtom.atomIndex = atom.getIndex();
 211         curAtom.chain = atom.getChainIDStr();
 212         curAtom.insCode = atom.group.getInsertionCode() == '\000' ? ' '
 213                 : atom.group.getInsertionCode();
 214         curAtom.name = atom.getAtomName();
 215         curAtom.number = atom.getAtomNumber();
 216         curAtom.resName = atom.getGroup3(true);
 217         curAtom.resNumber = atom.getResno();
 218         curAtom.occupancy = ms.occupancies != null ? ms.occupancies[atom
 219                 .getIndex()] : Float.valueOf(atom.getOccupancy100());
 220         curAtom.resNumIns = "" + curAtom.resNumber + curAtom.insCode;
 221         curAtom.tfactor = atom.getBfactor100() / 100f;
 222         curAtom.type = 0;
 223         // significantAtoms.add(curAtom);
 224         // ignore atoms from subsequent models
 225         if (!significantAtoms.contains(curAtom))
 226         {
 227           significantAtoms.add(curAtom);
 228         }
 229         prevAtom = atom;
 230       }
 231     }
 232     return significantAtoms;
 233   }
 234
 235   private boolean atomValidated(org.jmol.modelset.Atom curAtom,
 236           org.jmol.modelset.Atom prevAtom,
 237           HashMap<String, org.jmol.modelset.Atom> chainTerMap)
 238   {
 239     // System.out.println("Atom: " + curAtom.getAtomNumber()
 240     // + "   Last atom index " + curAtom.group.lastAtomIndex);
 241     if (chainTerMap == null || prevAtom == null)
 242     {
 243       return true;
 244     }
 245     String curAtomChId = curAtom.getChainIDStr();
 246     String prevAtomChId = prevAtom.getChainIDStr();
 247     // new chain encoutered
 248     if (!prevAtomChId.equals(curAtomChId))
 249     {
 250       // On chain switch add previous chain termination to xTerMap if not exists
 251       if (!chainTerMap.containsKey(prevAtomChId))
 252       {
 253         chainTerMap.put(prevAtomChId, prevAtom);
 254       }
 255       // if current atom belongs to an already terminated chain and the resNum
 256       // diff < 5 then mark as valid and update termination Atom
 257       if (chainTerMap.containsKey(curAtomChId))
 258       {
 259         if ((curAtom.getResno() - chainTerMap.get(curAtomChId).getResno()) < 5)
 260         {
 261           chainTerMap.put(curAtomChId, curAtom);
 262           return true;
 263         }
 264         return false;
 265       }
 266     }
 267     // atom with previously terminated chain encountered
 268     else if (chainTerMap.containsKey(curAtomChId))
 269     {
 270       if ((curAtom.getResno() - chainTerMap.get(curAtomChId).getResno()) < 5)
 271       {
 272         chainTerMap.put(curAtomChId, curAtom);
 273         return true;
 274       }
 275       return false;
 276     }
 277     // HETATM with resNum jump > 2
 278     return !(curAtom.isHetero() && ((curAtom.getResno() - prevAtom
 279             .getResno()) > 2));
 280   }
 281
 282   private void createAnnotation(SequenceI sequence, PDBChain chain,
 283           org.jmol.modelset.Atom[] jmolAtoms)
 284   {
 285     char[] secstr = new char[sequence.getLength()];
 286     char[] secstrcode = new char[sequence.getLength()];
 287
 288     // Ensure Residue size equals Seq size
 289     if (chain.residues.size() != sequence.getLength())
 290     {
 291       return;
 292     }
 293     int annotIndex = 0;
 294     for (Residue residue : chain.residues)
 295     {
 296       Atom repAtom = residue.getAtoms().get(0);
 297       STR proteinStructureSubType = jmolAtoms[repAtom.atomIndex].group
 298               .getProteinStructureSubType();
 299       setSecondaryStructure(proteinStructureSubType, annotIndex, secstr,
 300               secstrcode);
 301       ++annotIndex;
 302     }
 303     addSecondaryStructureAnnotation(chain.pdbid, sequence, secstr,
 304             secstrcode, chain.id, sequence.getStart());
 305   }
 306
 307   /**
 308    * Helper method that adds an AlignmentAnnotation for secondary structure to
 309    * the sequence, provided at least one secondary structure prediction has been
 310    * made
 311    *
 312    * @param modelTitle
 313    * @param seq
 314    * @param secstr
 315    * @param secstrcode
 316    * @param chainId
 317    * @param firstResNum
 318    * @return
 319    */
 320   protected void addSecondaryStructureAnnotation(String modelTitle,
 321           SequenceI sq, char[] secstr, char[] secstrcode, String chainId,
 322           int firstResNum)
 323   {
 324     char[] seq = sq.getSequence();
 325     boolean ssFound = false;
 326     Annotation asecstr[] = new Annotation[seq.length + firstResNum - 1];
 327     for (int p = 0; p < seq.length; p++)
 328     {
 329       if (secstr[p] >= 'A' && secstr[p] <= 'z')
 330       {
 331         try
 332         {
 333         asecstr[p] = new Annotation(String.valueOf(secstr[p]), null,
 334                 secstrcode[p], Float.NaN);
 335         ssFound = true;
 336         } catch (Exception e)
 337         {
 338           // e.printStackTrace();
 339         }
 340       }
 341     }
 342
 343     if (ssFound)
 344     {
 345       String mt = modelTitle == null ? getDataName() : modelTitle;
 346       mt += chainId;
 347       AlignmentAnnotation ann = new AlignmentAnnotation(
 348               "Secondary Structure", "Secondary Structure for " + mt,
 349               asecstr);
 350       ann.belowAlignment = true;
 351       ann.visible = true;
 352       ann.autoCalculated = false;
 353       ann.setCalcId(getClass().getName());
 354       ann.adjustForAlignment();
 355       ann.validateRangeAndDisplay();
 356       annotations.add(ann);
 357       sq.addAlignmentAnnotation(ann);
 358     }
 359   }
 360
 361   private void waitForScript(Viewer jmd)
 362   {
 363     while (jmd.isScriptExecuting())
 364     {
 365       try
 366       {
 367         Thread.sleep(50);
 368
 369       } catch (InterruptedException x)
 370       {
 371       }
 372     }
 373   }
 374
 375   /**
 376    * Convert Jmol's secondary structure code to Jalview's, and stored it in the
 377    * secondary structure arrays at the given sequence position
 378    *
 379    * @param proteinStructureSubType
 380    * @param pos
 381    * @param secstr
 382    * @param secstrcode
 383    */
 384   protected void setSecondaryStructure(STR proteinStructureSubType,
 385           int pos, char[] secstr, char[] secstrcode)
 386   {
 387     switch (proteinStructureSubType)
 388     {
 389     case HELIX310:
 390       secstr[pos] = '3';
 391       break;
 392     case HELIX:
 393     case HELIXALPHA:
 394       secstr[pos] = 'H';
 395       break;
 396     case HELIXPI:
 397       secstr[pos] = 'P';
 398       break;
 399     case SHEET:
 400       secstr[pos] = 'E';
 401       break;
 402     default:
 403       secstr[pos] = 0;
 404     }
 405
 406     switch (proteinStructureSubType)
 407     {
 408     case HELIX310:
 409     case HELIXALPHA:
 410     case HELIXPI:
 411     case HELIX:
 412       secstrcode[pos] = 'H';
 413       break;
 414     case SHEET:
 415       secstrcode[pos] = 'E';
 416       break;
 417     default:
 418       secstrcode[pos] = 0;
 419     }
 420   }
 421
 422   /**
 423    * Convert any non-standard peptide codes to their standard code table
 424    * equivalent. (Initial version only does Selenomethionine MSE->MET.)
 425    *
 426    * @param threeLetterCode
 427    * @param seq
 428    * @param pos
 429    */
 430   protected void replaceNonCanonicalResidue(String threeLetterCode,
 431           char[] seq, int pos)
 432   {
 433     String canonical = ResidueProperties
 434             .getCanonicalAminoAcid(threeLetterCode);
 435     if (canonical != null && !canonical.equalsIgnoreCase(threeLetterCode))
 436     {
 437       seq[pos] = ResidueProperties.getSingleCharacterCode(canonical);
 438     }
 439   }
 440
 441   /**
 442    * Not implemented - returns null
 443    */
 444   @Override
 445   public String print()
 446   {
 447     return null;
 448   }
 449
 450   /**
 451    * Not implemented
 452    */
 453   @Override
 454   public void setCallbackFunction(String callbackType,
 455           String callbackFunction)
 456   {
 457   }
 458
 459   @Override
 460   public void notifyCallback(CBK cbType, Object[] data)
 461   {
 462     String strInfo = (data == null || data[1] == null ? null : data[1]
 463             .toString());
 464     switch (cbType)
 465     {
 466     case ECHO:
 467       sendConsoleEcho(strInfo);
 468       break;
 469     case SCRIPT:
 470       notifyScriptTermination((String) data[2],
 471               ((Integer) data[3]).intValue());
 472       break;
 473     case MEASURE:
 474       String mystatus = (String) data[3];
 475       if (mystatus.indexOf("Picked") >= 0
 476               || mystatus.indexOf("Sequence") >= 0)
 477       {
 478         // Picking mode
 479         sendConsoleMessage(strInfo);
 480       }
 481       else if (mystatus.indexOf("Completed") >= 0)
 482       {
 483         sendConsoleEcho(strInfo.substring(strInfo.lastIndexOf(",") + 2,
 484                 strInfo.length() - 1));
 485       }
 486       break;
 487     case MESSAGE:
 488       sendConsoleMessage(data == null ? null : strInfo);
 489       break;
 490     case PICK:
 491       sendConsoleMessage(strInfo);
 492       break;
 493     default:
 494       break;
 495     }
 496   }
 497
 498   String lastConsoleEcho = "";
 499
 500   private void sendConsoleEcho(String string)
 501   {
 502     lastConsoleEcho += string;
 503     lastConsoleEcho += "\n";
 504   }
 505
 506   String lastConsoleMessage = "";
 507
 508   private void sendConsoleMessage(String string)
 509   {
 510     lastConsoleMessage += string;
 511     lastConsoleMessage += "\n";
 512   }
 513
 514   int lastScriptTermination = -1;
 515
 516   String lastScriptMessage = "";
 517
 518   private void notifyScriptTermination(String string, int intValue)
 519   {
 520     lastScriptMessage += string;
 521     lastScriptMessage += "\n";
 522     lastScriptTermination = intValue;
 523   }
 524
 525   @Override
 526   public boolean notifyEnabled(CBK callbackPick)
 527   {
 528     switch (callbackPick)
 529     {
 530     case MESSAGE:
 531     case SCRIPT:
 532     case ECHO:
 533     case LOADSTRUCT:
 534     case ERROR:
 535       return true;
 536     default:
 537       return false;
 538     }
 539   }
 540
 541   /**
 542    * Not implemented - returns null
 543    */
 544   @Override
 545   public String eval(String strEval)
 546   {
 547     return null;
 548   }
 549
 550   /**
 551    * Not implemented - returns null
 552    */
 553   @Override
 554   public float[][] functionXY(String functionName, int x, int y)
 555   {
 556     return null;
 557   }
 558
 559   /**
 560    * Not implemented - returns null
 561    */
 562   @Override
 563   public float[][][] functionXYZ(String functionName, int nx, int ny, int nz)
 564   {
 565     return null;
 566   }
 567
 568   /**
 569    * Not implemented - returns null
 570    */
 571   @Override
 572   public String createImage(String fileName, String imageType,
 573           Object text_or_bytes, int quality)
 574   {
 575     return null;
 576   }
 577
 578   /**
 579    * Not implemented - returns null
 580    */
 581   @Override
 582   public Map<String, Object> getRegistryInfo()
 583   {
 584     return null;
 585   }
 586
 587   /**
 588    * Not implemented
 589    */
 590   @Override
 591   public void showUrl(String url)
 592   {
 593   }
 594
 595   /**
 596    * Not implemented - returns null
 597    */
 598   @Override
 599   public Dimension resizeInnerPanel(String data)
 600   {
 601     return null;
 602   }
 603
 604   @Override
 605   public Map<String, Object> getJSpecViewProperty(String arg0)
 606   {
 607     return null;
 608   }
 609
 610   public boolean isPredictSecondaryStructure()
 611   {
 612     return predictSecondaryStructure;
 613   }
 614
 615   public void setPredictSecondaryStructure(boolean predictSecondaryStructure)
 616   {
 617     this.predictSecondaryStructure = predictSecondaryStructure;
 618   }
 619
 620   public boolean isVisibleChainAnnotation()
 621   {
 622     return visibleChainAnnotation;
 623   }
 624
 625   public void setVisibleChainAnnotation(boolean visibleChainAnnotation)
 626   {
 627     this.visibleChainAnnotation = visibleChainAnnotation;
 628   }
 629
 630 }