X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fext%2Frbvi%2Fchimera%2FChimeraCommands.java;h=bfad8fb7e1dee597505a432f184cceff622d6646;hb=0b6e9403e96ee9f0d41211b2f90130ff850c4e98;hp=9ef89fd8d538c4a4ebefbe27454121d5496aa091;hpb=fb315d08a73717eebc3d3a8832a9456fcef52484;p=jalview.git diff --git a/src/jalview/ext/rbvi/chimera/ChimeraCommands.java b/src/jalview/ext/rbvi/chimera/ChimeraCommands.java index 9ef89fd..bfad8fb 100644 --- a/src/jalview/ext/rbvi/chimera/ChimeraCommands.java +++ b/src/jalview/ext/rbvi/chimera/ChimeraCommands.java @@ -20,25 +20,19 @@ */ package jalview.ext.rbvi.chimera; -import jalview.api.FeatureRenderer; -import jalview.api.SequenceRenderer; -import jalview.datamodel.AlignmentI; -import jalview.datamodel.SequenceFeature; -import jalview.datamodel.SequenceI; -import jalview.structure.StructureMapping; -import jalview.structure.StructureMappingcommandSet; -import jalview.structure.StructureSelectionManager; -import jalview.util.ColorUtils; -import jalview.util.Comparison; +import java.util.Locale; 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 MCview.PDBChain; +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 @@ -46,485 +40,409 @@ import MCview.PDBChain; * @author JimP * */ -public class ChimeraCommands +public class ChimeraCommands extends StructureCommandsBase { + // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/focus.html + private static final StructureCommand FOCUS_VIEW = new StructureCommand("focus"); + + // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/listen.html#listresattr + private static final StructureCommand LIST_RESIDUE_ATTRIBUTES = new StructureCommand("list resattr"); + + // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/stop.html + private static final StructureCommand CLOSE_CHIMERA = new StructureCommand("stop really"); + + // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/listen.html + private static final StructureCommand STOP_NOTIFY_SELECTION = new StructureCommand("listen stop selection"); + + private static final StructureCommand STOP_NOTIFY_MODELS = new StructureCommand("listen stop models"); + + // 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"); - private static final String NAMESPACE_PREFIX = "jv_"; + private static final StructureCommand SHOW_BACKBONE = new StructureCommand( + "~display all;~ribbon;chain @CA|P"); + + private static final StructureCommandI COLOUR_BY_CHARGE = new StructureCommand( + "color white;color red ::ASP,GLU;color blue ::LYS,ARG;color yellow ::CYS"); + + // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/rainbow.html + private static final StructureCommandI COLOUR_BY_CHAIN = new StructureCommand( + "rainbow chain"); + + // Chimera clause to exclude alternate locations in atom selection + private static final String NO_ALTLOCS = "&~@.B-Z&~@.2-9"; + + @Override + public StructureCommandI colourResidues(String atomSpec, Color colour) + { + // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/color.html + String colourCode = getColourString(colour); + return new StructureCommand("color " + colourCode + " " + atomSpec); + } /** - * Constructs Chimera commands to colour residues as per the Jalview alignment + * Returns a colour formatted suitable for use in viewer command syntax * - * @param ssm - * @param files - * @param sequence - * @param sr - * @param fr - * @param alignment + * @param colour * @return */ - public static StructureMappingcommandSet getColourBySequenceCommand( - StructureSelectionManager ssm, String[] files, - SequenceI[][] sequence, SequenceRenderer sr, FeatureRenderer fr, - AlignmentI alignment) + protected String getColourString(Color colour) { - Map colourMap = buildColoursMap( - ssm, files, sequence, sr, fr, alignment); - - List colourCommands = buildColourCommands(colourMap); - - StructureMappingcommandSet cs = new StructureMappingcommandSet( - ChimeraCommands.class, null, - colourCommands.toArray(new String[colourCommands.size()])); - - return cs; + return ColorUtils.toTkCode(colour); } /** - * 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 + * Traverse the map of features/values/models/chains/positions to construct a + * list of 'setattr' commands (one per distinct feature type and value). + *

+ * The format of each command is * *

-   * 
- * color colorname #modelnumber:range.chain - * e.g. color #00ff00 #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,... + *
setattr r " " #modelnumber:range.chain + * e.g. setattr r jv_chain <value> #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,... *
*
* - * @param colourMap + * @param featureMap * @return */ - protected static List buildColourCommands( - Map colourMap) + @Override + public List setAttributes( + Map> featureMap) { - /* - * 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 commands = new ArrayList(); - StringBuilder sb = new StringBuilder(256); - boolean firstColour = true; - for (Object key : colourMap.keySet()) + List commands = new ArrayList<>(); + for (String featureType : featureMap.keySet()) { - Color colour = (Color) key; - String colourCode = ColorUtils.toTkCode(colour); - if (!firstColour) - { - sb.append("; "); - } - sb.append("color ").append(colourCode).append(" "); - firstColour = false; - final AtomSpecModel colourData = colourMap - .get(colour); - sb.append(colourData.getAtomSpec()); - } - commands.add(sb.toString()); - return commands; - } + String attributeName = makeAttributeName(featureType); - /** - * Traverses a map of { modelNumber, {chain, {list of from-to ranges} } } and - * builds a Chimera format atom spec - * - * @param modelAndChainRanges - */ - protected static String getAtomSpec( - Map>> modelAndChainRanges) - { - StringBuilder sb = new StringBuilder(128); - boolean firstModelForColour = true; - for (Integer model : modelAndChainRanges.keySet()) - { - boolean firstPositionForModel = true; - if (!firstModelForColour) - { - sb.append("|"); - } - firstModelForColour = false; - sb.append("#").append(model).append(":"); + /* + * clear down existing attributes for this feature + */ + // 'problem' - sets attribute to None on all residues - overkill? + // commands.add("~setattr r " + attributeName + " :*"); - final Map> modelData = modelAndChainRanges - .get(model); - for (String chain : modelData.keySet()) + Map values = featureMap.get(featureType); + for (Object value : values.keySet()) { - boolean hasChain = !"".equals(chain.trim()); - for (int[] range : modelData.get(chain)) - { - if (!firstPositionForModel) - { - sb.append(","); - } - if (range[0] == range[1]) - { - sb.append(range[0]); - } - else - { - sb.append(range[0]).append("-").append(range[1]); - } - if (hasChain) - { - sb.append(".").append(chain); - } - firstPositionForModel = false; - } + /* + * for each distinct value recorded for this feature type, + * add a command to set the attribute on the mapped residues + * Put values in single quotes, encoding any embedded single quotes + */ + AtomSpecModel atomSpecModel = values.get(value); + String featureValue = value.toString(); + featureValue = featureValue.replaceAll("\\'", "'"); + StructureCommandI cmd = setAttribute(attributeName, featureValue, + atomSpecModel); + commands.add(cmd); } } - return sb.toString(); + + return commands; } /** + * Returns a viewer command to set the given residue attribute value on + * residues specified by the AtomSpecModel, for example + * *
-   * Build a data structure which maps contiguous subsequences for each colour. 
-   * This generates a data structure from which we can easily generate the 
-   * Chimera command for colour by sequence.
-   * Color
-   *     Model number
-   *         Chain
-   *             list of start/end ranges
-   * Ordering is by order of addition (for colours and positions), natural ordering (for models and chains)
+   * setatr res jv_chain 'primary' #1:12-34,48-55.B
    * 
+ * + * @param attributeName + * @param attributeValue + * @param atomSpecModel + * @return */ - protected static Map buildColoursMap( - StructureSelectionManager ssm, String[] files, - SequenceI[][] sequence, SequenceRenderer sr, FeatureRenderer fr, - AlignmentI alignment) + protected StructureCommandI setAttribute(String attributeName, + String attributeValue, + AtomSpecModel atomSpecModel) { - Map colourMap = new LinkedHashMap(); - Color lastColour = null; - for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++) - { - StructureMapping[] mapping = ssm.getMapping(files[pdbfnum]); - - if (mapping == null || mapping.length < 1) - { - continue; - } - - int startPos = -1, lastPos = -1; - String lastChain = ""; - for (int s = 0; s < sequence[pdbfnum].length; s++) - { - for (int sp, m = 0; m < mapping.length; m++) - { - final SequenceI seq = sequence[pdbfnum][s]; - if (mapping[m].getSequence() == seq - && (sp = alignment.findIndex(seq)) > -1) - { - SequenceI asp = alignment.getSequenceAt(sp); - for (int r = 0; r < asp.getLength(); r++) - { - // no mapping to gaps in sequence - if (Comparison.isGap(asp.getCharAt(r))) - { - continue; - } - int pos = mapping[m].getPDBResNum(asp.findPosition(r)); - - if (pos < 1 || pos == lastPos) - { - continue; - } - - Color colour = sr.getResidueColour(seq, r, fr); - final String chain = mapping[m].getChain(); - - /* - * Just keep incrementing the end position for this colour range - * _unless_ colour, PDB model or chain has changed, or there is a - * gap in the mapped residue sequence - */ - final boolean newColour = !colour.equals(lastColour); - final boolean nonContig = lastPos + 1 != pos; - final boolean newChain = !chain.equals(lastChain); - if (newColour || nonContig || newChain) - { - if (startPos != -1) - { - addRange(colourMap, lastColour, pdbfnum, startPos, - lastPos, lastChain); - } - startPos = pos; - } - lastColour = colour; - lastPos = pos; - lastChain = chain; - } - // final colour range - if (lastColour != null) - { - addRange(colourMap, lastColour, pdbfnum, startPos, - lastPos, lastChain); - } - // break; - } - } - } - } - return colourMap; + 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()); } /** - * Helper method to add one contiguous colour range to the colour map. + * 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 map - * @param key - * @param model - * @param startPos - * @param endPos - * @param chain + * @param featureType + * @return + * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/setattr.html */ - protected static void addRange(Map map, - Object key, int model, int startPos, int endPos, String chain) + @Override + protected String makeAttributeName(String featureType) { + String attName = super.makeAttributeName(featureType); + /* - * Get/initialize map of data for the colour + * Chimera treats an attribute name ending in 'color' as colour-valued; + * Jalview doesn't, so prevent this by appending an underscore */ - AtomSpecModel atomSpec = map.get(key); - if (atomSpec == null) + if (attName.toUpperCase(Locale.ROOT).endsWith("COLOR")) { - atomSpec = new AtomSpecModel(); - map.put(key, atomSpec); + attName += "_"; } - atomSpec.addRange(model, startPos, endPos, chain); + return attName; } - /** - * 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 fr - * @param alignment - * @return - */ - public static StructureMappingcommandSet getSetAttributeCommandsForFeatures( - StructureSelectionManager ssm, String[] files, - SequenceI[][] seqs, FeatureRenderer fr, AlignmentI alignment) + @Override + public StructureCommandI colourByChain() { - Map> featureMap = buildFeaturesMap( - ssm, files, seqs, fr, alignment); + return COLOUR_BY_CHAIN; + } - List commands = buildSetAttributeCommands(featureMap); + @Override + public List colourByCharge() + { + return Arrays.asList(COLOUR_BY_CHARGE); + } - StructureMappingcommandSet cs = new StructureMappingcommandSet( - ChimeraCommands.class, null, - commands.toArray(new String[commands.size()])); + @Override + public String getResidueSpec(String residue) + { + return "::" + residue; + } - return cs; + @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)); } - /** - *
-   * Helper method to build a map of 
-   *   { featureType, { feature value, AtomSpecModel } }
-   * 
- * - * @param ssm - * @param files - * @param seqs - * @param fr - * @param alignment - * @return - */ - protected static Map> buildFeaturesMap( - StructureSelectionManager ssm, String[] files, - SequenceI[][] seqs, FeatureRenderer fr, AlignmentI alignment) + @Override + public StructureCommandI focusView() { - Map> theMap = new LinkedHashMap>(); + return FOCUS_VIEW; + } - List visibleFeatures = fr.getDisplayedFeatureTypes(); - if (visibleFeatures.isEmpty()) - { - return theMap; - } - - for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++) + @Override + public List showChains(List toShow) + { + /* + * Construct a chimera command like + * + * ~display #*;~ribbon #*;ribbon :.A,:.B + */ + StringBuilder cmd = new StringBuilder(64); + boolean first = true; + for (String chain : toShow) { - StructureMapping[] mapping = ssm.getMapping(files[pdbfnum]); - - if (mapping == null || mapping.length < 1) - { - continue; - } - - for (int seqNo = 0; seqNo < seqs[pdbfnum].length; seqNo++) + String[] tokens = chain.split(":"); + if (tokens.length == 2) { - for (int m = 0; m < mapping.length; m++) + String showChainCmd = tokens[0] + ":." + tokens[1]; + if (!first) { - final SequenceI seq = seqs[pdbfnum][seqNo]; - int sp = alignment.findIndex(seq); - if (mapping[m].getSequence() == seq && sp > -1) - { - /* - * found a sequence with a mapping to a structure; - * now scan its features - */ - SequenceI asp = alignment.getSequenceAt(sp); - - scanSequenceFeatures(visibleFeatures, mapping[m], asp, theMap, - pdbfnum); - } + cmd.append(","); } + cmd.append(showChainCmd); + first = false; } } - return theMap; + + /* + * could append ";focus" to this command to resize the display to fill the + * window, but it looks more helpful not to (easier to relate chains to the + * whole) + */ + final String command = "~display #*; ~ribbon #*; ribbon :" + + cmd.toString(); + return Arrays.asList(new StructureCommand(command)); } - /** - * 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 - * - * @param visibleFeatures - * @param mapping - * @param seq - * @param theMap - * @param modelNumber - */ - protected static void scanSequenceFeatures(List visibleFeatures, - StructureMapping mapping, SequenceI seq, - Map> theMap, int modelNumber) + @Override + public List superposeStructures(AtomSpecModel ref, + AtomSpecModel spec, boolean isNucleotide) { - SequenceFeature[] sfs = seq.getSequenceFeatures(); - if (sfs == null) - { - return; - } + /* + * 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); - for (SequenceFeature sf : sfs) - { - String type = sf.getType(); - if (!visibleFeatures.contains(type) || suppressFeature(type)) - { - continue; - } - List mappedRanges = mapping.getPDBResNumRanges(sf.getBegin(), - sf.getEnd()); + /* + * 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"); - if (!mappedRanges.isEmpty()) - { - String value = sf.getDescription(); - if (value == null || value.length() == 0) - { - value = type; - } - float score = sf.getScore(); - if (score != 0f && score != Float.NaN) - { - value = Float.toString(score); - } - Map featureValues = theMap.get(type); - if (featureValues == null) - { - featureValues = new HashMap(); - theMap.put(type, featureValues); - } - for (int[] range : mappedRanges) - { - addRange(featureValues, value, modelNumber, range[0], range[1], - mapping.getChain()); - } - } - } + return Arrays.asList(new StructureCommand(cmd.toString())); } - /** - * Answers true if the feature type is one we don't wish to propagate to - * Chimera - for now, RESNUM - * - * @param type - * @return - */ - static boolean suppressFeature(String type) + @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) { - return PDBChain.RESNUM_FEATURE.equals(type); + // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/save.html + return new StructureCommand("save " + filepath); } /** - * Traverse the map of features/values/models/chains/positions to construct a - * list of 'setattr' commands (one per distinct feature type and value). - *

- * The format of each command is + * Returns the range(s) modelled by {@code atomSpec} formatted as a Chimera + * atomspec string, e.g. * *

-   * 
setattr r " " #modelnumber:range.chain - * e.g. setattr r jv:chain #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,... - *
+ * #0:15.A,28.A,54.A,70-72.A|#1:2.A,6.A,11.A,13-14.A *
* - * @param featureMap + * where + *
    + *
  • #0 is a model number
  • + *
  • 15 or 70-72 is a residue number, or range of residue numbers
  • + *
  • .A is a chain identifier
  • + *
  • residue ranges are separated by comma
  • + *
  • atomspecs for distinct models are separated by | (or)
  • + *
+ * + *
+   * 
+   * @param model
+   * @param alphaOnly
    * @return
+   * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/frameatom_spec.html
    */
-  protected static List buildSetAttributeCommands(
-          Map> featureMap)
+  @Override
+  public String getAtomSpec(AtomSpecModel atomSpec, boolean alphaOnly)
   {
-    List commands = new ArrayList();
-    for (String featureType : featureMap.keySet())
+    StringBuilder sb = new StringBuilder(128);
+    boolean firstModel = true;
+    for (String model : atomSpec.getModels())
     {
-      String attributeName = makeAttributeName(featureType);
-
-      /*
-       * clear down existing attributes for this feature
-       */
-      // 'problem' - sets attribute to None on all residues - overkill?
-      // commands.add("~setattr r " + attributeName + " :*");
-
-      Map values = featureMap.get(featureType);
-      for (Object value : values.keySet())
+      if (!firstModel)
       {
-        /*
-         * for each distinct value recorded for this feature type,
-         * add a command to set the attribute on the mapped residues
-         */
-        StringBuilder sb = new StringBuilder(128);
-        sb.append("setattr r ").append(attributeName).append(" \"")
-                .append(value.toString()).append("\" ");
-        sb.append(values.get(value).getAtomSpec());
-        commands.add(sb.toString());
+        sb.append("|");
       }
+      firstModel = false;
+      appendModel(sb, model, atomSpec, alphaOnly);
     }
-
-    return commands;
+    return 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.
+   * A helper method to append an atomSpec string for atoms in the given model
    * 
-   * @param featureType
-   * @return 
-   * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/setattr.html
-   * 
+ * @param sb + * @param model + * @param atomSpec + * @param alphaOnly */ - protected static String makeAttributeName(String featureType) + protected void appendModel(StringBuilder sb, String model, + AtomSpecModel atomSpec, boolean alphaOnly) { - StringBuilder sb = new StringBuilder(); - if (featureType != null) + sb.append("#").append(model).append(":"); + + boolean firstPositionForModel = true; + + for (String chain : atomSpec.getChains(model)) { - for (char c : featureType.toCharArray()) + chain = " ".equals(chain) ? chain : chain.trim(); + + List rangeList = atomSpec.getRanges(model, chain); + for (int[] range : rangeList) { - sb.append(Character.isLetterOrDigit(c) ? c : '_'); + appendRange(sb, range[0], range[1], chain, firstPositionForModel, + false); + firstPositionForModel = false; } } - String attName = NAMESPACE_PREFIX + sb.toString(); - - /* - * Chimera treats an attribute name ending in 'color' as colour-valued; - * Jalview doesn't, so prevent this by appending an underscore - */ - if (attName.toUpperCase().endsWith("COLOR")) + if (alphaOnly) { - attName += "_"; + /* + * 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); } + } - return attName; + @Override + public List 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 closeViewer() + { + return CLOSE_CHIMERA; + } + + @Override + public List startNotifications(String uri) + { + // https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/listen.html + List 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 stopNotifications() + { + List 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 + "'"); } }