2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.ext.rbvi.chimera;
23 import java.awt.Color;
24 import java.util.ArrayList;
25 import java.util.Arrays;
26 import java.util.List;
29 import jalview.structure.AtomSpecModel;
30 import jalview.structure.StructureCommand;
31 import jalview.structure.StructureCommandI;
32 import jalview.structure.StructureCommandsBase;
33 import jalview.util.ColorUtils;
36 * Routines for generating Chimera commands for Jalview/Chimera binding
41 public class ChimeraCommands extends StructureCommandsBase
43 private static final StructureCommand SHOW_BACKBONE = new StructureCommand(
44 "~display all;~ribbon;chain @CA|P");
46 private static final StructureCommandI COLOUR_BY_CHARGE = new StructureCommand(
47 "color white;color red ::ASP,GLU;color blue ::LYS,ARG;color yellow ::CYS");
49 private static final StructureCommandI COLOUR_BY_CHAIN = new StructureCommand(
52 // Chimera clause to exclude alternate locations in atom selection
53 private static final String NO_ALTLOCS = "&~@.B-Z&~@.2-9";
56 public StructureCommandI colourResidues(String atomSpec, Color colour)
58 // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/color.html
59 String colourCode = getColourString(colour);
60 return new StructureCommand("color " + colourCode + " " + atomSpec);
64 * Returns a colour formatted suitable for use in viewer command syntax
69 protected String getColourString(Color colour)
71 return ColorUtils.toTkCode(colour);
75 * Traverse the map of features/values/models/chains/positions to construct a
76 * list of 'setattr' commands (one per distinct feature type and value).
78 * The format of each command is
81 * <blockquote> setattr r <featureName> " " #modelnumber:range.chain
82 * e.g. setattr r jv_chain <value> #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,...
90 public List<StructureCommandI> setAttributes(
91 Map<String, Map<Object, AtomSpecModel>> featureMap)
93 List<StructureCommandI> commands = new ArrayList<>();
94 for (String featureType : featureMap.keySet())
96 String attributeName = makeAttributeName(featureType);
99 * clear down existing attributes for this feature
101 // 'problem' - sets attribute to None on all residues - overkill?
102 // commands.add("~setattr r " + attributeName + " :*");
104 Map<Object, AtomSpecModel> values = featureMap.get(featureType);
105 for (Object value : values.keySet())
108 * for each distinct value recorded for this feature type,
109 * add a command to set the attribute on the mapped residues
110 * Put values in single quotes, encoding any embedded single quotes
112 AtomSpecModel atomSpecModel = values.get(value);
113 String featureValue = value.toString();
114 featureValue = featureValue.replaceAll("\\'", "'");
115 StructureCommandI cmd = setAttribute(attributeName, featureValue,
125 * Returns a viewer command to set the given residue attribute value on
126 * residues specified by the AtomSpecModel, for example
129 * setatr res jv_chain 'primary' #1:12-34,48-55.B
132 * @param attributeName
133 * @param attributeValue
134 * @param atomSpecModel
137 protected StructureCommandI setAttribute(String attributeName,
138 String attributeValue,
139 AtomSpecModel atomSpecModel)
141 StringBuilder sb = new StringBuilder(128);
142 sb.append("setattr res ").append(attributeName).append(" '")
143 .append(attributeValue).append("' ");
144 sb.append(getAtomSpec(atomSpecModel, false));
145 return new StructureCommand(sb.toString());
149 * Makes a prefixed and valid Chimera attribute name. A jv_ prefix is applied
150 * for a 'Jalview' namespace, and any non-alphanumeric character is converted
155 * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/setattr.html
158 protected String makeAttributeName(String featureType)
160 String attName = super.makeAttributeName(featureType);
163 * Chimera treats an attribute name ending in 'color' as colour-valued;
164 * Jalview doesn't, so prevent this by appending an underscore
166 if (attName.toUpperCase().endsWith("COLOR"))
175 public StructureCommandI colourByChain()
177 return COLOUR_BY_CHAIN;
181 public List<StructureCommandI> colourByCharge()
183 return Arrays.asList(COLOUR_BY_CHARGE);
187 public String getResidueSpec(String residue)
189 return "::" + residue;
193 public StructureCommandI setBackgroundColour(Color col)
195 // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/set.html#bgcolor
196 return new StructureCommand("set bgColor " + ColorUtils.toTkCode(col));
200 public StructureCommandI focusView()
202 // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/focus.html
203 return new StructureCommand("focus");
207 public List<StructureCommandI> showChains(List<String> toShow)
210 * Construct a chimera command like
212 * ~display #*;~ribbon #*;ribbon :.A,:.B
214 StringBuilder cmd = new StringBuilder(64);
215 boolean first = true;
216 for (String chain : toShow)
218 String[] tokens = chain.split(":");
219 if (tokens.length == 2)
221 String showChainCmd = tokens[0] + ":." + tokens[1];
226 cmd.append(showChainCmd);
232 * could append ";focus" to this command to resize the display to fill the
233 * window, but it looks more helpful not to (easier to relate chains to the
236 final String command = "~display #*; ~ribbon #*; ribbon :"
238 return Arrays.asList(new StructureCommand(command));
242 public List<StructureCommandI> superposeStructures(AtomSpecModel ref,
246 * Form Chimera match command to match spec to ref
247 * (the first set of atoms are moved on to the second)
249 * match #1:1-30.B,81-100.B@CA #0:21-40.A,61-90.A@CA
251 * @see https://www.cgl.ucsf.edu/chimera/docs/UsersGuide/midas/match.html
253 StringBuilder cmd = new StringBuilder();
254 String atomSpecAlphaOnly = getAtomSpec(spec, true);
255 String refSpecAlphaOnly = getAtomSpec(ref, true);
256 cmd.append("match ").append(atomSpecAlphaOnly).append(" ").append(refSpecAlphaOnly);
259 * show superposed residues as ribbon
261 String atomSpec = getAtomSpec(spec, false);
262 String refSpec = getAtomSpec(ref, false);
263 cmd.append("; ribbon ");
264 cmd.append(atomSpec).append("|").append(refSpec).append("; focus");
266 return Arrays.asList(new StructureCommand(cmd.toString()));
270 public StructureCommandI openCommandFile(String path)
272 // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/filetypes.html
273 return new StructureCommand("open cmd:" + path);
277 public StructureCommandI saveSession(String filepath)
279 // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/save.html
280 return new StructureCommand("save " + filepath);
284 * Returns the range(s) modelled by {@code atomSpec} formatted as a Chimera
285 * atomspec string, e.g.
288 * #0:15.A,28.A,54.A,70-72.A|#1:2.A,6.A,11.A,13-14.A
293 * <li>#0 is a model number</li>
294 * <li>15 or 70-72 is a residue number, or range of residue numbers</li>
295 * <li>.A is a chain identifier</li>
296 * <li>residue ranges are separated by comma</li>
297 * <li>atomspecs for distinct models are separated by | (or)</li>
305 * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/frameatom_spec.html
308 public String getAtomSpec(AtomSpecModel atomSpec, boolean alphaOnly)
310 StringBuilder sb = new StringBuilder(128);
311 boolean firstModel = true;
312 for (String model : atomSpec.getModels())
319 appendModel(sb, model, atomSpec, alphaOnly);
321 return sb.toString();
325 * A helper method to append an atomSpec string for atoms in the given model
332 protected void appendModel(StringBuilder sb, String model,
333 AtomSpecModel atomSpec, boolean alphaOnly)
335 sb.append("#").append(model).append(":");
337 boolean firstPositionForModel = true;
339 for (String chain : atomSpec.getChains(model))
341 chain = " ".equals(chain) ? chain : chain.trim();
343 List<int[]> rangeList = atomSpec.getRanges(model, chain);
344 for (int[] range : rangeList)
346 appendRange(sb, range[0], range[1], chain, firstPositionForModel,
348 firstPositionForModel = false;
354 * restrict to alpha carbon, no alternative locations
355 * (needed to ensuring matching atom counts for superposition)
357 // TODO @P instead if RNA - add nucleotide flag to AtomSpecModel?
358 sb.append("@CA").append(NO_ALTLOCS);
363 public List<StructureCommandI> showBackbone()
365 return Arrays.asList(SHOW_BACKBONE);
369 public StructureCommandI loadFile(String file)
371 return new StructureCommand("open " + file);
375 * Overrides the default method to concatenate colour commands into one
378 public List<StructureCommandI> colourBySequence(
379 Map<Object, AtomSpecModel> colourMap)
381 List<StructureCommandI> commands = new ArrayList<>();
382 StringBuilder sb = new StringBuilder(colourMap.size() * 20);
383 boolean first = true;
384 for (Object key : colourMap.keySet())
386 Color colour = (Color) key;
387 final AtomSpecModel colourData = colourMap.get(colour);
388 StructureCommandI command = getColourCommand(colourData, colour);
391 sb.append(getCommandSeparator());
394 sb.append(command.getCommand());
397 commands.add(new StructureCommand(sb.toString()));
402 public StructureCommandI openSession(String filepath)
404 // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/filetypes.html
405 // this version of the command has no dependency on file extension
406 return new StructureCommand("open chimera:" + filepath);
410 public StructureCommandI closeViewer()
412 // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/stop.html
413 return new StructureCommand("stop really");