*/
package jalview.ext.rbvi.chimera;
-import jalview.api.AlignViewportI;
-import jalview.api.AlignmentViewPanel;
-import jalview.api.FeatureRenderer;
-import jalview.datamodel.AlignmentI;
-import jalview.datamodel.MappedFeatures;
-import jalview.datamodel.SequenceFeature;
-import jalview.datamodel.SequenceI;
-import jalview.gui.Desktop;
-import jalview.structure.StructureMapping;
-import jalview.structure.StructureMappingcommandSet;
-import jalview.structure.StructureSelectionManager;
-import jalview.structures.models.AAStructureBindingModel;
-import jalview.util.ColorUtils;
-
import java.awt.Color;
import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.LinkedHashMap;
+import java.util.Arrays;
import java.util.List;
import java.util.Map;
+import jalview.structure.AtomSpecModel;
+import jalview.structure.StructureCommand;
+import jalview.structure.StructureCommandI;
+import jalview.structure.StructureCommandsBase;
+import jalview.util.ColorUtils;
+
/**
* Routines for generating Chimera commands for Jalview/Chimera binding
*
* @author JimP
+ * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/framecommand.html
*
*/
-public class ChimeraCommands extends StructureCommands
+public class ChimeraCommands extends StructureCommandsBase
{
- public static final String NAMESPACE_PREFIX = "jv_";
+ // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/focus.html
+ private static final StructureCommand FOCUS_VIEW = new StructureCommand("focus");
- /*
- * colour for residues shown in structure but hidden in alignment
- */
- private static final String COLOR_GRAY_HEX = "color "
- + ColorUtils.toTkCode(Color.GRAY);
+ // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/listen.html#listresattr
+ private static final StructureCommand LIST_RESIDUE_ATTRIBUTES = new StructureCommand("list resattr");
- /**
- * Constructs Chimera commands to colour residues as per the Jalview alignment
- *
- * @param colourMap
- * @param binding
- * @return
- */
- public static String[] getColourBySequenceCommand(
- Map<Object, AtomSpecModel> colourMap,
- AAStructureBindingModel binding)
- {
- List<String> colourCommands = buildColourCommands(colourMap, binding);
-
- return colourCommands.toArray(new String[colourCommands.size()]);
- }
+ // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/stop.html
+ private static final StructureCommand CLOSE_CHIMERA = new StructureCommand("stop really");
- /**
- * Traverse the map of colours/models/chains/positions to construct a list of
- * 'color' commands (one per distinct colour used). The format of each command
- * is
- *
- * <pre>
- * <blockquote>
- * color colorname #modelnumber:range.chain
- * e.g. color #00ff00 #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,...
- * </blockquote>
- * </pre>
- *
- * @param colourMap
- * @param binding
- * @return
- */
- protected static List<String> buildColourCommands(
- Map<Object, AtomSpecModel> colourMap,
- AAStructureBindingModel binding)
- {
- /*
- * This version concatenates all commands into a single String (semi-colon
- * delimited). If length limit issues arise, refactor to return one color
- * command per colour.
- */
- List<String> commands = new ArrayList<>();
- StringBuilder sb = new StringBuilder(256);
- sb.append(COLOR_GRAY_HEX);
-
- for (Object key : colourMap.keySet())
- {
- Color colour = (Color) key;
- String colourCode = ColorUtils.toTkCode(colour);
- sb.append("; ");
- sb.append("color ").append(colourCode).append(" ");
- final AtomSpecModel colourData = colourMap.get(colour);
- sb.append(getAtomSpec(colourData, binding));
- }
- commands.add(sb.toString());
- return commands;
- }
-
- /**
- * Constructs and returns Chimera commands to set attributes on residues
- * corresponding to features in Jalview. Attribute names are the Jalview feature
- * type, with a "jv_" prefix.
- *
- * @param ssm
- * @param files
- * @param seqs
- * @param viewPanel
- * @param binding
- * @return
- */
- public static StructureMappingcommandSet getSetAttributeCommandsForFeatures(
- AlignmentViewPanel viewPanel, AAStructureBindingModel binding)
- {
- StructureSelectionManager ssm = binding.getSsm();
- String[] files = binding.getStructureFiles();
- SequenceI[][] seqs = binding.getSequence();
-
- Map<String, Map<Object, AtomSpecModel>> featureMap = buildFeaturesMap(
- ssm, files, seqs, viewPanel);
-
- List<String> commands = buildSetAttributeCommands(featureMap, binding);
-
- StructureMappingcommandSet cs = new StructureMappingcommandSet(
- ChimeraCommands.class, null,
- commands.toArray(new String[commands.size()]));
-
- return cs;
- }
-
- /**
- * <pre>
- * Helper method to build a map of
- * { featureType, { feature value, AtomSpecModel } }
- * </pre>
- *
- * @param ssm
- * @param files
- * @param seqs
- * @param viewPanel
- * @return
- */
- protected static Map<String, Map<Object, AtomSpecModel>> buildFeaturesMap(
- StructureSelectionManager ssm, String[] files, SequenceI[][] seqs,
- AlignmentViewPanel viewPanel)
- {
- Map<String, Map<Object, AtomSpecModel>> theMap = new LinkedHashMap<>();
+ // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/listen.html
+ private static final StructureCommand STOP_NOTIFY_SELECTION = new StructureCommand("listen stop selection");
- FeatureRenderer fr = viewPanel.getFeatureRenderer();
- if (fr == null)
- {
- return theMap;
- }
+ private static final StructureCommand STOP_NOTIFY_MODELS = new StructureCommand("listen stop models");
- AlignViewportI viewport = viewPanel.getAlignViewport();
- List<String> visibleFeatures = fr.getDisplayedFeatureTypes();
+ // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/listen.html#listselection
+ private static final StructureCommand GET_SELECTION = new StructureCommand("list selection level residue");
- /*
- * if alignment is showing features from complement, we also transfer
- * these features to the corresponding mapped structure residues
- */
- boolean showLinkedFeatures = viewport.isShowComplementFeatures();
- List<String> complementFeatures = new ArrayList<>();
- FeatureRenderer complementRenderer = null;
- if (showLinkedFeatures)
- {
- AlignViewportI comp = fr.getViewport().getCodingComplement();
- if (comp != null)
- {
- complementRenderer = Desktop.getAlignFrameFor(comp)
- .getFeatureRenderer();
- complementFeatures = complementRenderer.getDisplayedFeatureTypes();
- }
- }
- if (visibleFeatures.isEmpty() && complementFeatures.isEmpty())
- {
- return theMap;
- }
+ private static final StructureCommand SHOW_BACKBONE = new StructureCommand(
+ "~display all;~ribbon;chain @CA|P");
- AlignmentI alignment = viewPanel.getAlignment();
- for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
- {
- StructureMapping[] mapping = ssm.getMapping(files[pdbfnum]);
+ private static final StructureCommandI COLOUR_BY_CHARGE = new StructureCommand(
+ "color white;color red ::ASP,GLU;color blue ::LYS,ARG;color yellow ::CYS");
- if (mapping == null || mapping.length < 1)
- {
- continue;
- }
+ // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/rainbow.html
+ private static final StructureCommandI COLOUR_BY_CHAIN = new StructureCommand(
+ "rainbow chain");
- for (int seqNo = 0; seqNo < seqs[pdbfnum].length; seqNo++)
- {
- for (int m = 0; m < mapping.length; m++)
- {
- final SequenceI seq = seqs[pdbfnum][seqNo];
- int sp = alignment.findIndex(seq);
- StructureMapping structureMapping = mapping[m];
- if (structureMapping.getSequence() == seq && sp > -1)
- {
- /*
- * found a sequence with a mapping to a structure;
- * now scan its features
- */
- if (!visibleFeatures.isEmpty())
- {
- scanSequenceFeatures(visibleFeatures, structureMapping, seq,
- theMap, pdbfnum);
- }
- if (showLinkedFeatures)
- {
- scanComplementFeatures(complementRenderer, structureMapping,
- seq, theMap, pdbfnum);
- }
- }
- }
- }
- }
- return theMap;
- }
+ // Chimera clause to exclude alternate locations in atom selection
+ private static final String NO_ALTLOCS = "&~@.B-Z&~@.2-9";
- /**
- * Scans visible features in mapped positions of the CDS/peptide complement, and
- * adds any found to the map of attribute values/structure positions
- *
- * @param complementRenderer
- * @param structureMapping
- * @param seq
- * @param theMap
- * @param modelNumber
- */
- protected static void scanComplementFeatures(
- FeatureRenderer complementRenderer,
- StructureMapping structureMapping, SequenceI seq,
- Map<String, Map<Object, AtomSpecModel>> theMap, int modelNumber)
+ @Override
+ public StructureCommandI colourResidues(String atomSpec, Color colour)
{
- /*
- * for each sequence residue mapped to a structure position...
- */
- for (int seqPos : structureMapping.getMapping().keySet())
- {
- /*
- * find visible complementary features at mapped position(s)
- */
- MappedFeatures mf = complementRenderer
- .findComplementFeaturesAtResidue(seq, seqPos);
- if (mf != null)
- {
- for (SequenceFeature sf : mf.features)
- {
- String type = sf.getType();
-
- /*
- * Don't copy features which originated from Chimera
- */
- if (JalviewChimeraBinding.CHIMERA_FEATURE_GROUP
- .equals(sf.getFeatureGroup()))
- {
- continue;
- }
-
- /*
- * record feature 'value' (score/description/type) as at the
- * corresponding structure position
- */
- List<int[]> mappedRanges = structureMapping
- .getPDBResNumRanges(seqPos, seqPos);
-
- if (!mappedRanges.isEmpty())
- {
- String value = sf.getDescription();
- if (value == null || value.length() == 0)
- {
- value = type;
- }
- float score = sf.getScore();
- if (score != 0f && !Float.isNaN(score))
- {
- value = Float.toString(score);
- }
- Map<Object, AtomSpecModel> featureValues = theMap.get(type);
- if (featureValues == null)
- {
- featureValues = new HashMap<>();
- theMap.put(type, featureValues);
- }
- for (int[] range : mappedRanges)
- {
- addAtomSpecRange(featureValues, value, modelNumber, range[0],
- range[1], structureMapping.getChain());
- }
- }
- }
- }
- }
+ // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/color.html
+ String colourCode = getColourString(colour);
+ return new StructureCommand("color " + colourCode + " " + atomSpec);
}
/**
- * Inspect features on the sequence; for each feature that is visible, determine
- * its mapped ranges in the structure (if any) according to the given mapping,
- * and add them to the map.
+ * Returns a colour formatted suitable for use in viewer command syntax
*
- * @param visibleFeatures
- * @param mapping
- * @param seq
- * @param theMap
- * @param modelNumber
+ * @param colour
+ * @return
*/
- protected static void scanSequenceFeatures(List<String> visibleFeatures,
- StructureMapping mapping, SequenceI seq,
- Map<String, Map<Object, AtomSpecModel>> theMap, int modelNumber)
+ protected String getColourString(Color colour)
{
- List<SequenceFeature> sfs = seq.getFeatures().getPositionalFeatures(
- visibleFeatures.toArray(new String[visibleFeatures.size()]));
- for (SequenceFeature sf : sfs)
- {
- String type = sf.getType();
-
- /*
- * Don't copy features which originated from Chimera
- */
- if (JalviewChimeraBinding.CHIMERA_FEATURE_GROUP
- .equals(sf.getFeatureGroup()))
- {
- continue;
- }
-
- List<int[]> mappedRanges = mapping.getPDBResNumRanges(sf.getBegin(),
- sf.getEnd());
-
- if (!mappedRanges.isEmpty())
- {
- String value = sf.getDescription();
- if (value == null || value.length() == 0)
- {
- value = type;
- }
- float score = sf.getScore();
- if (score != 0f && !Float.isNaN(score))
- {
- value = Float.toString(score);
- }
- Map<Object, AtomSpecModel> featureValues = theMap.get(type);
- if (featureValues == null)
- {
- featureValues = new HashMap<>();
- theMap.put(type, featureValues);
- }
- for (int[] range : mappedRanges)
- {
- addAtomSpecRange(featureValues, value, modelNumber, range[0],
- range[1], mapping.getChain());
- }
- }
- }
+ return ColorUtils.toTkCode(colour);
}
/**
*
* <pre>
* <blockquote> setattr r <featureName> " " #modelnumber:range.chain
- * e.g. setattr r jv:chain <value> #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,...
+ * e.g. setattr r jv_chain <value> #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,...
* </blockquote>
* </pre>
*
* @param binding
* @return
*/
- protected static List<String> buildSetAttributeCommands(
- Map<String, Map<Object, AtomSpecModel>> featureMap,
- AAStructureBindingModel binding)
+ @Override
+ public List<StructureCommandI> setAttributes(
+ Map<String, Map<Object, AtomSpecModel>> featureMap)
{
- List<String> commands = new ArrayList<>();
+ List<StructureCommandI> commands = new ArrayList<>();
for (String featureType : featureMap.keySet())
{
String attributeName = makeAttributeName(featureType);
* add a command to set the attribute on the mapped residues
* Put values in single quotes, encoding any embedded single quotes
*/
- StringBuilder sb = new StringBuilder(128);
+ AtomSpecModel atomSpecModel = values.get(value);
String featureValue = value.toString();
featureValue = featureValue.replaceAll("\\'", "'");
- sb.append("setattr r ").append(attributeName).append(" '")
- .append(featureValue).append("' ");
- sb.append(getAtomSpec(values.get(value), binding));
- commands.add(sb.toString());
+ StructureCommandI cmd = setAttribute(attributeName, featureValue,
+ atomSpecModel);
+ commands.add(cmd);
}
}
}
/**
+ * Returns a viewer command to set the given residue attribute value on
+ * residues specified by the AtomSpecModel, for example
+ *
+ * <pre>
+ * setatr res jv_chain 'primary' #1:12-34,48-55.B
+ * </pre>
+ *
+ * @param attributeName
+ * @param attributeValue
+ * @param atomSpecModel
+ * @return
+ */
+ protected StructureCommandI setAttribute(String attributeName,
+ String attributeValue,
+ AtomSpecModel atomSpecModel)
+ {
+ StringBuilder sb = new StringBuilder(128);
+ sb.append("setattr res ").append(attributeName).append(" '")
+ .append(attributeValue).append("' ");
+ sb.append(getAtomSpec(atomSpecModel, false));
+ return new StructureCommand(sb.toString());
+ }
+
+ /**
* Makes a prefixed and valid Chimera attribute name. A jv_ prefix is applied
* for a 'Jalview' namespace, and any non-alphanumeric character is converted
* to an underscore.
*
* @param featureType
* @return
- *
- * <pre>
- * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/setattr.html
- * </pre>
+ * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/setattr.html
*/
- protected static String makeAttributeName(String featureType)
+ @Override
+ protected String makeAttributeName(String featureType)
{
- StringBuilder sb = new StringBuilder();
- if (featureType != null)
- {
- for (char c : featureType.toCharArray())
- {
- sb.append(Character.isLetterOrDigit(c) ? c : '_');
- }
- }
- String attName = NAMESPACE_PREFIX + sb.toString();
+ String attName = super.makeAttributeName(featureType);
/*
* Chimera treats an attribute name ending in 'color' as colour-valued;
return attName;
}
+ @Override
+ public StructureCommandI colourByChain()
+ {
+ return COLOUR_BY_CHAIN;
+ }
+
+ @Override
+ public List<StructureCommandI> colourByCharge()
+ {
+ return Arrays.asList(COLOUR_BY_CHARGE);
+ }
+
+ @Override
+ public String getResidueSpec(String residue)
+ {
+ return "::" + residue;
+ }
+
+ @Override
+ public StructureCommandI setBackgroundColour(Color col)
+ {
+ // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/set.html#bgcolor
+ return new StructureCommand("set bgColor " + ColorUtils.toTkCode(col));
+ }
+
+ @Override
+ public StructureCommandI focusView()
+ {
+ return FOCUS_VIEW;
+ }
+
+ @Override
+ public List<StructureCommandI> superposeStructures(AtomSpecModel ref,
+ AtomSpecModel spec)
+ {
+ /*
+ * Form Chimera match command to match spec to ref
+ * (the first set of atoms are moved on to the second)
+ *
+ * match #1:1-30.B,81-100.B@CA #0:21-40.A,61-90.A@CA
+ *
+ * @see https://www.cgl.ucsf.edu/chimera/docs/UsersGuide/midas/match.html
+ */
+ StringBuilder cmd = new StringBuilder();
+ String atomSpecAlphaOnly = getAtomSpec(spec, true);
+ String refSpecAlphaOnly = getAtomSpec(ref, true);
+ cmd.append("match ").append(atomSpecAlphaOnly).append(" ").append(refSpecAlphaOnly);
+
+ /*
+ * show superposed residues as ribbon
+ */
+ String atomSpec = getAtomSpec(spec, false);
+ String refSpec = getAtomSpec(ref, false);
+ cmd.append("; ribbon ");
+ cmd.append(atomSpec).append("|").append(refSpec).append("; focus");
+
+ return Arrays.asList(new StructureCommand(cmd.toString()));
+ }
+
+ @Override
+ public StructureCommandI openCommandFile(String path)
+ {
+ // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/filetypes.html
+ return new StructureCommand("open cmd:" + path);
+ }
+
+ @Override
+ public StructureCommandI saveSession(String filepath)
+ {
+ // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/save.html
+ return new StructureCommand("save " + filepath);
+ }
+
/**
- * Returns the range(s) formatted as a Chimera atomspec
+ * Returns the range(s) modelled by {@code atomSpec} formatted as a Chimera
+ * atomspec string, e.g.
+ *
+ * <pre>
+ * #0:15.A,28.A,54.A,70-72.A|#1:2.A,6.A,11.A,13-14.A
+ * </pre>
+ *
+ * where
+ * <ul>
+ * <li>#0 is a model number</li>
+ * <li>15 or 70-72 is a residue number, or range of residue numbers</li>
+ * <li>.A is a chain identifier</li>
+ * <li>residue ranges are separated by comma</li>
+ * <li>atomspecs for distinct models are separated by | (or)</li>
+ * </ul>
+ *
+ * <pre>
*
+ * @param model
+ * @param alphaOnly
* @return
+ * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/frameatom_spec.html
*/
- public static String getAtomSpec(AtomSpecModel atomSpec,
- AAStructureBindingModel binding)
+ @Override
+ public String getAtomSpec(AtomSpecModel atomSpec, boolean alphaOnly)
{
StringBuilder sb = new StringBuilder(128);
boolean firstModel = true;
- for (Integer model : atomSpec.getModels())
+ for (String model : atomSpec.getModels())
{
if (!firstModel)
{
sb.append("|");
}
firstModel = false;
- sb.append(binding.getModelSpec(model)).append(":");
+ appendModel(sb, model, atomSpec, alphaOnly);
+ }
+ return sb.toString();
+ }
- boolean firstPositionForModel = true;
+ /**
+ * A helper method to append an atomSpec string for atoms in the given model
+ *
+ * @param sb
+ * @param model
+ * @param atomSpec
+ * @param alphaOnly
+ */
+ protected void appendModel(StringBuilder sb, String model,
+ AtomSpecModel atomSpec, boolean alphaOnly)
+ {
+ sb.append("#").append(model).append(":");
- for (String chain : atomSpec.getChains(model))
- {
- chain = " ".equals(chain) ? chain : chain.trim();
+ boolean firstPositionForModel = true;
- List<int[]> rangeList = atomSpec.getRanges(model, chain);
+ for (String chain : atomSpec.getChains(model))
+ {
+ chain = " ".equals(chain) ? chain : chain.trim();
- String chainToken = " ".equals(chain) ? "." : "." + chain;
- appendResidueRange(sb, rangeList, chainToken,
- firstPositionForModel);
+ List<int[]> rangeList = atomSpec.getRanges(model, chain);
+ for (int[] range : rangeList)
+ {
+ appendRange(sb, range[0], range[1], chain, firstPositionForModel,
+ false);
firstPositionForModel = false;
}
}
- return sb.toString();
+ if (alphaOnly)
+ {
+ /*
+ * restrict to alpha carbon, no alternative locations
+ * (needed to ensuring matching atom counts for superposition)
+ */
+ // TODO @P instead if RNA - add nucleotide flag to AtomSpecModel?
+ sb.append("@CA").append(NO_ALTLOCS);
+ }
}
- /**
- * Chimera atomspec requires chain to be specified for each start-end residue
- * range, otherwise it will apply to all chains
- *
- * @param sb
- * @param chain
- */
- protected static void appendChainToRange(StringBuilder sb, String chain)
+ @Override
+ public List<StructureCommandI> showBackbone()
+ {
+ return Arrays.asList(SHOW_BACKBONE);
+ }
+
+ @Override
+ public StructureCommandI loadFile(String file)
+ {
+ return new StructureCommand("open " + file);
+ }
+
+ @Override
+ public StructureCommandI openSession(String filepath)
+ {
+ // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/filetypes.html
+ // this version of the command has no dependency on file extension
+ return new StructureCommand("open chimera:" + filepath);
+ }
+
+ @Override
+ public StructureCommandI showStructures(AtomSpecModel restrictTo)
{
- sb.append(".");
- if (!" ".equals(chain))
+ if (restrictTo == null)
{
- sb.append(chain);
+ return new StructureCommand("ribbon");
}
+
+ String atomSpec = getAtomSpec(restrictTo, false);
+ String cmd = "ribbon " + atomSpec;
+ return new StructureCommand(cmd);
+ }
+
+ @Override
+ public StructureCommandI hideChain(String modelId, String chainId)
+ {
+ String what = "#" + modelId + ":." + chainId;
+ return new StructureCommand("~ribbon " + what + ";~display " + what);
+ }
+
+ @Override
+ public StructureCommandI hideAll()
+ {
+ return new StructureCommand("~display; ~ribbon");
+ }
+ public StructureCommandI closeViewer()
+ {
+ return CLOSE_CHIMERA;
+ }
+
+ @Override
+ public List<StructureCommandI> startNotifications(String uri)
+ {
+ // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/listen.html
+ List<StructureCommandI> cmds = new ArrayList<>();
+ cmds.add(new StructureCommand("listen start models url " + uri));
+ cmds.add(new StructureCommand("listen start select prefix SelectionChanged url " + uri));
+ return cmds;
+ }
+
+ @Override
+ public List<StructureCommandI> stopNotifications()
+ {
+ List<StructureCommandI> cmds = new ArrayList<>();
+ cmds.add(STOP_NOTIFY_MODELS);
+ cmds.add(STOP_NOTIFY_SELECTION);
+ return cmds;
+ }
+
+ @Override
+ public StructureCommandI getSelectedResidues()
+ {
+ return GET_SELECTION;
+ }
+
+ @Override
+ public StructureCommandI listResidueAttributes()
+ {
+ return LIST_RESIDUE_ATTRIBUTES;
+ }
+
+ @Override
+ public StructureCommandI getResidueAttributes(String attName)
+ {
+ // this alternative command
+ // list residues spec ':*/attName' attr attName
+ // doesn't report 'None' values (which is good), but
+ // fails for 'average.bfactor' (which is bad):
+ return new StructureCommand("list residues attr '" + attName + "'");
}
}