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