src/jalview/ext/jmol/JmolCommands.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 java.awt.Color;
  24 import java.util.ArrayList;
  25 import java.util.Arrays;
  26 import java.util.List;
  27 import java.util.Map;
  28
  29 import jalview.api.AlignViewportI;
  30 import jalview.api.AlignmentViewPanel;
  31 import jalview.api.FeatureRenderer;
  32 import jalview.api.SequenceRenderer;
  33 import jalview.datamodel.AlignmentI;
  34 import jalview.datamodel.HiddenColumns;
  35 import jalview.datamodel.SequenceI;
  36 import jalview.renderer.seqfeatures.FeatureColourFinder;
  37 import jalview.structure.AtomSpecModel;
  38 import jalview.structure.StructureCommand;
  39 import jalview.structure.StructureCommandI;
  40 import jalview.structure.StructureCommandsBase;
  41 import jalview.structure.StructureMapping;
  42 import jalview.structure.StructureSelectionManager;
  43 import jalview.util.Comparison;
  44 import jalview.util.Platform;
  45
  46 /**
  47  * Routines for generating Jmol commands for Jalview/Jmol binding
  48  *
  49  * @author JimP
  50  *
  51  */
  52 public class JmolCommands extends StructureCommandsBase
  53 {
  54   private static final String COMMA = ",";
  55
  56   private static final StructureCommand SHOW_BACKBONE = new StructureCommand(
  57           "select *; cartoons off; backbone");
  58
  59   private static final StructureCommand FOCUS_VIEW = new StructureCommand("zoom 0");
  60
  61   private static final StructureCommand COLOUR_ALL_WHITE = new StructureCommand(
  62           "select *;color white;");
  63
  64   private static final StructureCommandI COLOUR_BY_CHARGE = new StructureCommand(
  65           "select *;color white;select ASP,GLU;color red;"
  66                   + "select LYS,ARG;color blue;select CYS;color yellow");
  67
  68   private static final StructureCommandI COLOUR_BY_CHAIN = new StructureCommand(
  69           "select *;color chain");
  70
  71   private static final String PIPE = "|";
  72
  73   private static final String HYPHEN = "-";
  74
  75   private static final String COLON = ":";
  76
  77   private static final String SLASH = "/";
  78
  79   /**
  80    * Returns a string representation of the given colour suitable for inclusion
  81    * in Jmol commands
  82    *
  83    * @param c
  84    * @return
  85    */
  86   protected String getColourString(Color c)
  87   {
  88     return c == null ? null
  89             : String.format("[%d,%d,%d]", c.getRed(), c.getGreen(),
  90                     c.getBlue());
  91   }
  92
  93   @Override
  94   public StructureCommandI colourByChain()
  95   {
  96     return COLOUR_BY_CHAIN;
  97   }
  98
  99   @Override
 100   public List<StructureCommandI> colourByCharge()
 101   {
 102     return Arrays.asList(COLOUR_BY_CHARGE);
 103   }
 104
 105   @Override
 106   public List<StructureCommandI> colourByResidues(Map<String, Color> colours)
 107   {
 108     List<StructureCommandI> cmds = super.colourByResidues(colours);
 109     cmds.add(0, COLOUR_ALL_WHITE);
 110     return cmds;
 111   }
 112
 113   @Override
 114   public StructureCommandI setBackgroundColour(Color col)
 115   {
 116     return new StructureCommand("background " + getColourString(col));
 117   }
 118
 119   @Override
 120   public StructureCommandI focusView()
 121   {
 122     return FOCUS_VIEW;
 123   }
 124
 125   @Override
 126   public List<StructureCommandI> showChains(List<String> toShow)
 127   {
 128     StringBuilder atomSpec = new StringBuilder(128);
 129     boolean first = true;
 130     for (String chain : toShow)
 131     {
 132       String[] tokens = chain.split(":");
 133       if (tokens.length == 2)
 134       {
 135         if (!first)
 136         {
 137           atomSpec.append(" or ");
 138         }
 139         first = false;
 140         atomSpec.append(":").append(tokens[1]).append(" /").append(tokens[0]);
 141       }
 142     }
 143
 144     String spec = atomSpec.toString();
 145     String command = "select *;restrict " + spec + ";cartoon;center "
 146             + spec;
 147     return Arrays.asList(new StructureCommand(command));
 148   }
 149
 150   /**
 151    * Returns a command to superpose atoms in {@code atomSpec} to those in
 152    * {@code refAtoms}, restricted to alpha carbons only (Phosphorous for rna).
 153    * For example
 154    *
 155    * <pre>
 156    * compare {2.1} {1.1} SUBSET {(*.CA | *.P) and conformation=1}
 157    *         ATOMS {1-87:A}{2-54:A|61-94:A} ROTATE TRANSLATE 1.0;
 158    * </pre>
 159    *
 160    * where {@code conformation=1} excludes ALTLOC atom locations, and 1.0 is the
 161    * time in seconds to animate the action. For this example, atoms in model 2
 162    * are moved towards atoms in model 1.
 163    * <p>
 164    * The two atomspecs should each be for one model only, but may have more than
 165    * one chain. The number of atoms specified should be the same for both
 166    * models, though if not, Jmol may make a 'best effort' at superposition.
 167    *
 168    * @see https://chemapps.stolaf.edu/jmol/docs/#compare
 169    */
 170   @Override
 171   public List<StructureCommandI> superposeStructures(AtomSpecModel refAtoms,
 172           AtomSpecModel atomSpec)
 173   {
 174     StringBuilder sb = new StringBuilder(64);
 175     String refModel = refAtoms.getModels().iterator().next();
 176     String model2 = atomSpec.getModels().iterator().next();
 177     sb.append(String.format("compare {%s.1} {%s.1}", model2, refModel));
 178     sb.append(" SUBSET {(*.CA | *.P) and conformation=1} ATOMS {");
 179
 180     /*
 181      * command examples don't include modelspec with atoms, getAtomSpec does;
 182      * it works, so leave it as it is for simplicity
 183      */
 184     sb.append(getAtomSpec(atomSpec, true)).append("}{");
 185     sb.append(getAtomSpec(refAtoms, true)).append("}");
 186     sb.append(" ROTATE TRANSLATE ");
 187     sb.append(getCommandSeparator());
 188
 189     /*
 190      * show residues used for superposition as ribbon
 191      */
 192     sb.append("select ").append(getAtomSpec(atomSpec, false)).append("|");
 193     sb.append(getAtomSpec(refAtoms, false)).append(getCommandSeparator())
 194             .append("cartoons");
 195
 196     return Arrays.asList(new StructureCommand(sb.toString()));
 197   }
 198
 199   @Override
 200   public StructureCommandI openCommandFile(String path)
 201   {
 202     /*
 203      * https://chemapps.stolaf.edu/jmol/docs/#script
 204      * not currently used in Jalview
 205      */
 206     return new StructureCommand("script " + path);
 207   }
 208
 209   @Override
 210   public StructureCommandI saveSession(String filepath)
 211   {
 212     /*
 213      * https://chemapps.stolaf.edu/jmol/docs/#writemodel
 214      */
 215     return new StructureCommand("write STATE \"" + filepath + "\"");
 216   }
 217
 218   @Override
 219   protected StructureCommandI colourResidues(String atomSpec, Color colour)
 220   {
 221     StringBuilder sb = new StringBuilder(atomSpec.length()+20);
 222     sb.append("select ").append(atomSpec).append(getCommandSeparator())
 223             .append("color").append(getColourString(colour));
 224     return new StructureCommand(sb.toString());
 225   }
 226
 227   @Override
 228   protected String getResidueSpec(String residue)
 229   {
 230     return residue;
 231   }
 232
 233   /**
 234    * Generates a Jmol atomspec string like
 235    *
 236    * <pre>
 237    * (61-64,70)&:A/1.1,(12-25,41-44)&:B/1.1,12:A/2.1
 238    * for model 1, chain A, residues 61-64 and 70, chain B residues 12-25 and 41-44, model 2 chain A residue 12
 239    * </pre>
 240    *
 241    * Note the brackets to group multiple residue ranges for the same chain
 242    * (without bracketing, ranges would apply to all chains)
 243    *
 244    * Parameter {@code alphaOnly} is not used here - this restriction is made by
 245    * a separate clause in the {@code compare} (superposition) command.
 246    */
 247   @Override
 248   public String getAtomSpec(AtomSpecModel model, boolean alphaOnly)
 249   {
 250     StringBuilder sb = new StringBuilder(128);
 251
 252     boolean firstChain = true;
 253     for (String modelNo : model.getModels())
 254     {
 255       for (String chain : model.getChains(modelNo))
 256       {
 257         if (!firstChain)
 258         {
 259           sb.append(COMMA);
 260         }
 261         firstChain = false;
 262         List<int[]> rangeList = model.getRanges(modelNo, chain);
 263         if (rangeList.size() > 1)
 264         {
 265           sb.append("(");
 266         }
 267         boolean firstRange = true;
 268         for (int[] range : rangeList)
 269         {
 270           if (!firstRange)
 271           {
 272             sb.append(COMMA);
 273           }
 274           firstRange = false;
 275           firstChain = false;
 276           sb.append(range[0]);
 277           if (range[0] != range[1])
 278           {
 279             sb.append(HYPHEN).append(range[1]);
 280           }
 281         }
 282         if (rangeList.size() > 1)
 283         {
 284           sb.append(")&");
 285         }
 286         sb.append(COLON).append(chain.trim()).append(SLASH);
 287         sb.append(String.valueOf(modelNo)).append(".1");
 288       }
 289     }
 290
 291     return sb.toString();
 292   }
 293
 294   @Override
 295   public List<StructureCommandI> showBackbone()
 296   {
 297     return Arrays.asList(SHOW_BACKBONE);
 298   }
 299
 300   @Override
 301   public StructureCommandI loadFile(String file)
 302   {
 303     // https://chemapps.stolaf.edu/jmol/docs/#loadfiles
 304     return new StructureCommand("load FILES \"" +
 305             Platform.escapeBackslashes(file) + "\"");
 306   }
 307
 308   /**
 309    * Obsolete method, only referenced from
 310    * jalview.javascript.MouseOverStructureListener
 311    *
 312    * @param ssm
 313    * @param files
 314    * @param sequence
 315    * @param sr
 316    * @param viewPanel
 317    * @return
 318    */
 319   @Deprecated
 320   public String[] colourBySequence(StructureSelectionManager ssm,
 321           String[] files, SequenceI[][] sequence, SequenceRenderer sr,
 322           AlignmentViewPanel viewPanel)
 323   {
 324     // TODO delete method
 325
 326     FeatureRenderer fr = viewPanel.getFeatureRenderer();
 327     FeatureColourFinder finder = new FeatureColourFinder(fr);
 328     AlignViewportI viewport = viewPanel.getAlignViewport();
 329     HiddenColumns cs = viewport.getAlignment().getHiddenColumns();
 330     AlignmentI al = viewport.getAlignment();
 331     List<String> cset = new ArrayList<>();
 332
 333     for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
 334     {
 335       StructureMapping[] mapping = ssm.getMapping(files[pdbfnum]);
 336       StringBuilder command = new StringBuilder(128);
 337       List<String> str = new ArrayList<>();
 338
 339       if (mapping == null || mapping.length < 1)
 340       {
 341         continue;
 342       }
 343
 344       for (int s = 0; s < sequence[pdbfnum].length; s++)
 345       {
 346         for (int sp, m = 0; m < mapping.length; m++)
 347         {
 348           if (mapping[m].getSequence() == sequence[pdbfnum][s]
 349                   && (sp = al.findIndex(sequence[pdbfnum][s])) > -1)
 350           {
 351             int lastPos = StructureMapping.UNASSIGNED_VALUE;
 352             SequenceI asp = al.getSequenceAt(sp);
 353             for (int r = 0; r < asp.getLength(); r++)
 354             {
 355               // no mapping to gaps in sequence
 356               if (Comparison.isGap(asp.getCharAt(r)))
 357               {
 358                 continue;
 359               }
 360               int pos = mapping[m].getPDBResNum(asp.findPosition(r));
 361
 362               if (pos == lastPos)
 363               {
 364                 continue;
 365               }
 366               if (pos == StructureMapping.UNASSIGNED_VALUE)
 367               {
 368                 // terminate current colour op
 369                 if (command.length() > 0
 370                         && command.charAt(command.length() - 1) != ';')
 371                 {
 372                   command.append(";");
 373                 }
 374                 // reset lastPos
 375                 lastPos = StructureMapping.UNASSIGNED_VALUE;
 376                 continue;
 377               }
 378
 379               lastPos = pos;
 380
 381               Color col = sr.getResidueColour(sequence[pdbfnum][s], r,
 382                       finder);
 383
 384               /*
 385                * shade hidden regions darker
 386                */
 387               if (!cs.isVisible(r))
 388               {
 389                 col = Color.GRAY;
 390               }
 391
 392               String newSelcom = (mapping[m].getChain() != " "
 393                       ? ":" + mapping[m].getChain()
 394                       : "") + "/" + (pdbfnum + 1) + ".1" + ";color"
 395                       + getColourString(col);
 396               if (command.length() > newSelcom.length() && command
 397                       .substring(command.length() - newSelcom.length())
 398                       .equals(newSelcom))
 399               {
 400                 command = JmolCommands.condenseCommand(command, pos);
 401                 continue;
 402               }
 403               // TODO: deal with case when buffer is too large for Jmol to parse
 404               // - execute command and flush
 405
 406               if (command.length() > 0
 407                       && command.charAt(command.length() - 1) != ';')
 408               {
 409                 command.append(";");
 410               }
 411
 412               if (command.length() > 51200)
 413               {
 414                 // add another chunk
 415                 str.add(command.toString());
 416                 command.setLength(0);
 417               }
 418               command.append("select " + pos);
 419               command.append(newSelcom);
 420             }
 421             // break;
 422           }
 423         }
 424       }
 425       {
 426         // add final chunk
 427         str.add(command.toString());
 428         command.setLength(0);
 429       }
 430       cset.addAll(str);
 431
 432     }
 433     return cset.toArray(new String[cset.size()]);
 434   }
 435
 436   /**
 437    * Helper method
 438    *
 439    * @param command
 440    * @param pos
 441    * @return
 442    */
 443   @Deprecated
 444   private static StringBuilder condenseCommand(
 445           StringBuilder command,
 446           int pos)
 447   {
 448
 449     // work back to last 'select'
 450     int p = command.length(), q = p;
 451     do
 452     {
 453       p -= 6;
 454       if (p < 1)
 455       {
 456         p = 0;
 457       }
 458       ;
 459     } while ((q = command.indexOf("select", p)) == -1 && p > 0);
 460
 461     StringBuilder sb = new StringBuilder(command.substring(0, q + 7));
 462
 463     command = command.delete(0, q + 7);
 464
 465     String start;
 466
 467     if (command.indexOf("-") > -1)
 468     {
 469       start = command.substring(0, command.indexOf("-"));
 470     }
 471     else
 472     {
 473       start = command.substring(0, command.indexOf(":"));
 474     }
 475
 476     sb.append(start + "-" + pos + command.substring(command.indexOf(":")));
 477
 478     return sb;
 479   }
 480
 481   @Override
 482   public StructureCommandI openSession(String filepath)
 483   {
 484     return loadFile(filepath);
 485   }
 486 }