src/jalview/ext/rbvi/chimera/ChimeraCommands.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.rbvi.chimera;
  22
  23 import jalview.api.AlignViewportI;
  24 import jalview.api.AlignmentViewPanel;
  25 import jalview.api.FeatureRenderer;
  26 import jalview.api.SequenceRenderer;
  27 import jalview.datamodel.AlignmentI;
  28 import jalview.datamodel.HiddenColumns;
  29 import jalview.datamodel.SequenceFeature;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.renderer.seqfeatures.FeatureColourFinder;
  32 import jalview.structure.StructureMapping;
  33 import jalview.structure.StructureMappingcommandSet;
  34 import jalview.structure.StructureSelectionManager;
  35 import jalview.util.ColorUtils;
  36 import jalview.util.Comparison;
  37
  38 import java.awt.Color;
  39 import java.util.ArrayList;
  40 import java.util.HashMap;
  41 import java.util.LinkedHashMap;
  42 import java.util.List;
  43 import java.util.Map;
  44
  45 /**
  46  * Routines for generating Chimera commands for Jalview/Chimera binding
  47  *
  48  * @author JimP
  49  *
  50  */
  51 public class ChimeraCommands
  52 {
  53   public static final String NAMESPACE_PREFIX = "jv_";
  54
  55   private static final String COLOR_GRAY_HEX = "color "
  56           + ColorUtils.toTkCode(Color.GRAY);
  57
  58   /**
  59    * Constructs Chimera commands to colour residues as per the Jalview alignment
  60    *
  61    * @param ssm
  62    * @param files
  63    * @param sequence
  64    * @param sr
  65    * @param fr
  66    * @param viewPanel
  67    * @return
  68    */
  69   public static StructureMappingcommandSet[] getColourBySequenceCommand(
  70           StructureSelectionManager ssm, String[] files,
  71           SequenceI[][] sequence, SequenceRenderer sr,
  72           AlignmentViewPanel viewPanel)
  73   {
  74     Map<Object, AtomSpecModel> colourMap = buildColoursMap(ssm, files,
  75             sequence, sr, viewPanel);
  76
  77     List<String> colourCommands = buildColourCommands(colourMap);
  78
  79     StructureMappingcommandSet cs = new StructureMappingcommandSet(
  80             ChimeraCommands.class, null,
  81             colourCommands.toArray(new String[colourCommands.size()]));
  82
  83     return new StructureMappingcommandSet[] { cs };
  84   }
  85
  86   /**
  87    * Traverse the map of colours/models/chains/positions to construct a list of
  88    * 'color' commands (one per distinct colour used). The format of each command
  89    * is
  90    *
  91    * <pre>
  92    * <blockquote>
  93    * color colorname #modelnumber:range.chain
  94    * e.g. color #00ff00 #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,...
  95    * </blockquote>
  96    * </pre>
  97    *
  98    * @param colourMap
  99    * @return
 100    */
 101   protected static List<String> buildColourCommands(
 102           Map<Object, AtomSpecModel> colourMap)
 103   {
 104     /*
 105      * This version concatenates all commands into a single String (semi-colon
 106      * delimited). If length limit issues arise, refactor to return one color
 107      * command per colour.
 108      */
 109     List<String> commands = new ArrayList<>();
 110     StringBuilder sb = new StringBuilder(256);
 111     sb.append(COLOR_GRAY_HEX);
 112
 113     for (Object key : colourMap.keySet())
 114     {
 115       Color colour = (Color) key;
 116       String colourCode = ColorUtils.toTkCode(colour);
 117       sb.append("; ");
 118       sb.append("color ").append(colourCode).append(" ");
 119       final AtomSpecModel colourData = colourMap.get(colour);
 120       sb.append(colourData.getAtomSpec());
 121     }
 122     commands.add(sb.toString());
 123     return commands;
 124   }
 125
 126   /**
 127    * Traverses a map of { modelNumber, {chain, {list of from-to ranges} } } and
 128    * builds a Chimera format atom spec
 129    *
 130    * @param modelAndChainRanges
 131    */
 132   protected static String getAtomSpec(
 133           Map<Integer, Map<String, List<int[]>>> modelAndChainRanges)
 134   {
 135     StringBuilder sb = new StringBuilder(128);
 136     boolean firstModelForColour = true;
 137     for (Integer model : modelAndChainRanges.keySet())
 138     {
 139       boolean firstPositionForModel = true;
 140       if (!firstModelForColour)
 141       {
 142         sb.append("|");
 143       }
 144       firstModelForColour = false;
 145       sb.append("#").append(model).append(":");
 146
 147       final Map<String, List<int[]>> modelData = modelAndChainRanges
 148               .get(model);
 149       for (String chain : modelData.keySet())
 150       {
 151         boolean hasChain = !"".equals(chain.trim());
 152         for (int[] range : modelData.get(chain))
 153         {
 154           if (!firstPositionForModel)
 155           {
 156             sb.append(",");
 157           }
 158           if (range[0] == range[1])
 159           {
 160             sb.append(range[0]);
 161           }
 162           else
 163           {
 164             sb.append(range[0]).append("-").append(range[1]);
 165           }
 166           if (hasChain)
 167           {
 168             sb.append(".").append(chain);
 169           }
 170           firstPositionForModel = false;
 171         }
 172       }
 173     }
 174     return sb.toString();
 175   }
 176
 177   /**
 178    * <pre>
 179    * Build a data structure which records contiguous subsequences for each colour.
 180    * From this we can easily generate the Chimera command for colour by sequence.
 181    * Color
 182    *     Model number
 183    *         Chain
 184    *             list of start/end ranges
 185    * Ordering is by order of addition (for colours and positions), natural ordering (for models and chains)
 186    * </pre>
 187    */
 188   protected static Map<Object, AtomSpecModel> buildColoursMap(
 189           StructureSelectionManager ssm, String[] files,
 190           SequenceI[][] sequence, SequenceRenderer sr,
 191           AlignmentViewPanel viewPanel)
 192   {
 193     FeatureRenderer fr = viewPanel.getFeatureRenderer();
 194     FeatureColourFinder finder = new FeatureColourFinder(fr);
 195     AlignViewportI viewport = viewPanel.getAlignViewport();
 196     HiddenColumns cs = viewport.getAlignment().getHiddenColumns();
 197     AlignmentI al = viewport.getAlignment();
 198     Map<Object, AtomSpecModel> colourMap = new LinkedHashMap<>();
 199     Color lastColour = null;
 200
 201     for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
 202     {
 203       StructureMapping[] mapping = ssm.getMapping(files[pdbfnum]);
 204
 205       if (mapping == null || mapping.length < 1)
 206       {
 207         continue;
 208       }
 209
 210       int startPos = -1, lastPos = -1;
 211       String lastChain = "";
 212       for (int s = 0; s < sequence[pdbfnum].length; s++)
 213       {
 214         for (int sp, m = 0; m < mapping.length; m++)
 215         {
 216           final SequenceI seq = sequence[pdbfnum][s];
 217           if (mapping[m].getSequence() == seq
 218                   && (sp = al.findIndex(seq)) > -1)
 219           {
 220             SequenceI asp = al.getSequenceAt(sp);
 221             for (int r = 0; r < asp.getLength(); r++)
 222             {
 223               // no mapping to gaps in sequence
 224               if (Comparison.isGap(asp.getCharAt(r)))
 225               {
 226                 continue;
 227               }
 228               int pos = mapping[m].getPDBResNum(asp.findPosition(r));
 229
 230               if (pos < 1 || pos == lastPos)
 231               {
 232                 continue;
 233               }
 234
 235               Color colour = sr.getResidueColour(seq, r, finder);
 236
 237               /*
 238                * hidden regions are shown gray
 239                * todo: iterate over visible columns only
 240                */
 241               if (!cs.isVisible(r))
 242               {
 243                 continue; // colour = Color.GRAY;
 244               }
 245
 246               final String chain = mapping[m].getChain();
 247
 248               /*
 249                * Just keep incrementing the end position for this colour range
 250                * _unless_ colour, PDB model or chain has changed, or there is a
 251                * gap in the mapped residue sequence
 252                */
 253               final boolean newColour = !colour.equals(lastColour);
 254               final boolean nonContig = lastPos + 1 != pos;
 255               final boolean newChain = !chain.equals(lastChain);
 256               if (newColour || nonContig || newChain)
 257               {
 258                 if (startPos != -1)
 259                 {
 260                   addColourRange(colourMap, lastColour, pdbfnum, startPos,
 261                           lastPos, lastChain);
 262                 }
 263                 startPos = pos;
 264               }
 265               lastColour = colour;
 266               lastPos = pos;
 267               lastChain = chain;
 268             }
 269             // final colour range
 270             if (lastColour != null)
 271             {
 272               addColourRange(colourMap, lastColour, pdbfnum, startPos,
 273                       lastPos, lastChain);
 274             }
 275             // break;
 276           }
 277         }
 278       }
 279     }
 280     return colourMap;
 281   }
 282
 283   /**
 284    * Helper method to add one contiguous colour range to the colour map.
 285    *
 286    * @param map
 287    * @param key
 288    * @param model
 289    * @param startPos
 290    * @param endPos
 291    * @param chain
 292    */
 293   protected static void addColourRange(Map<Object, AtomSpecModel> map,
 294           Object key, int model, int startPos, int endPos, String chain)
 295   {
 296     /*
 297      * Get/initialize map of data for the colour
 298      */
 299     AtomSpecModel atomSpec = map.get(key);
 300     if (atomSpec == null)
 301     {
 302       atomSpec = new AtomSpecModel();
 303       map.put(key, atomSpec);
 304     }
 305
 306     atomSpec.addRange(model, startPos, endPos, chain);
 307   }
 308
 309   /**
 310    * Constructs and returns Chimera commands to set attributes on residues
 311    * corresponding to features in Jalview. Attribute names are the Jalview
 312    * feature type, with a "jv_" prefix.
 313    *
 314    * @param ssm
 315    * @param files
 316    * @param seqs
 317    * @param viewPanel
 318    * @return
 319    */
 320   public static StructureMappingcommandSet getSetAttributeCommandsForFeatures(
 321           StructureSelectionManager ssm, String[] files, SequenceI[][] seqs,
 322           AlignmentViewPanel viewPanel)
 323   {
 324     Map<String, Map<Object, AtomSpecModel>> featureMap = buildFeaturesMap(
 325             ssm, files, seqs, viewPanel);
 326
 327     List<String> commands = buildSetAttributeCommands(featureMap);
 328
 329     StructureMappingcommandSet cs = new StructureMappingcommandSet(
 330             ChimeraCommands.class, null,
 331             commands.toArray(new String[commands.size()]));
 332
 333     return cs;
 334   }
 335
 336   /**
 337    * <pre>
 338    * Helper method to build a map of
 339    *   { featureType, { feature value, AtomSpecModel } }
 340    * </pre>
 341    *
 342    * @param ssm
 343    * @param files
 344    * @param seqs
 345    * @param viewPanel
 346    * @return
 347    */
 348   protected static Map<String, Map<Object, AtomSpecModel>> buildFeaturesMap(
 349           StructureSelectionManager ssm, String[] files, SequenceI[][] seqs,
 350           AlignmentViewPanel viewPanel)
 351   {
 352     Map<String, Map<Object, AtomSpecModel>> theMap = new LinkedHashMap<>();
 353
 354     FeatureRenderer fr = viewPanel.getFeatureRenderer();
 355     if (fr == null)
 356     {
 357       return theMap;
 358     }
 359
 360     List<String> visibleFeatures = fr.getDisplayedFeatureTypes();
 361     if (visibleFeatures.isEmpty())
 362     {
 363       return theMap;
 364     }
 365
 366     AlignmentI alignment = viewPanel.getAlignment();
 367     for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
 368     {
 369       StructureMapping[] mapping = ssm.getMapping(files[pdbfnum]);
 370
 371       if (mapping == null || mapping.length < 1)
 372       {
 373         continue;
 374       }
 375
 376       for (int seqNo = 0; seqNo < seqs[pdbfnum].length; seqNo++)
 377       {
 378         for (int m = 0; m < mapping.length; m++)
 379         {
 380           final SequenceI seq = seqs[pdbfnum][seqNo];
 381           int sp = alignment.findIndex(seq);
 382           if (mapping[m].getSequence() == seq && sp > -1)
 383           {
 384             /*
 385              * found a sequence with a mapping to a structure;
 386              * now scan its features
 387              */
 388             SequenceI asp = alignment.getSequenceAt(sp);
 389
 390             scanSequenceFeatures(visibleFeatures, mapping[m], asp, theMap,
 391                     pdbfnum);
 392           }
 393         }
 394       }
 395     }
 396     return theMap;
 397   }
 398
 399   /**
 400    * Inspect features on the sequence; for each feature that is visible,
 401    * determine its mapped ranges in the structure (if any) according to the
 402    * given mapping, and add them to the map
 403    *
 404    * @param visibleFeatures
 405    * @param mapping
 406    * @param seq
 407    * @param theMap
 408    * @param modelNumber
 409    */
 410   protected static void scanSequenceFeatures(List<String> visibleFeatures,
 411           StructureMapping mapping, SequenceI seq,
 412           Map<String, Map<Object, AtomSpecModel>> theMap, int modelNumber)
 413   {
 414     List<SequenceFeature> sfs = seq.getFeatures().getPositionalFeatures(
 415             visibleFeatures.toArray(new String[visibleFeatures.size()]));
 416     for (SequenceFeature sf : sfs)
 417     {
 418       String type = sf.getType();
 419
 420       /*
 421        * Only copy visible features, don't copy any which originated
 422        * from Chimera, and suppress uninteresting ones (e.g. RESNUM)
 423        */
 424       boolean isFromViewer = JalviewChimeraBinding.CHIMERA_FEATURE_GROUP
 425               .equals(sf.getFeatureGroup());
 426       if (isFromViewer)
 427       {
 428         continue;
 429       }
 430       List<int[]> mappedRanges = mapping.getPDBResNumRanges(sf.getBegin(),
 431               sf.getEnd());
 432
 433       if (!mappedRanges.isEmpty())
 434       {
 435         String value = sf.getDescription();
 436         if (value == null || value.length() == 0)
 437         {
 438           value = type;
 439         }
 440         float score = sf.getScore();
 441         if (score != 0f && !Float.isNaN(score))
 442         {
 443           value = Float.toString(score);
 444         }
 445         Map<Object, AtomSpecModel> featureValues = theMap.get(type);
 446         if (featureValues == null)
 447         {
 448           featureValues = new HashMap<>();
 449           theMap.put(type, featureValues);
 450         }
 451         for (int[] range : mappedRanges)
 452         {
 453           addColourRange(featureValues, value, modelNumber, range[0],
 454                   range[1], mapping.getChain());
 455         }
 456       }
 457     }
 458   }
 459
 460   /**
 461    * Traverse the map of features/values/models/chains/positions to construct a
 462    * list of 'setattr' commands (one per distinct feature type and value).
 463    * <p>
 464    * The format of each command is
 465    *
 466    * <pre>
 467    * <blockquote> setattr r <featureName> " " #modelnumber:range.chain
 468    * e.g. setattr r jv:chain <value> #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,...
 469    * </blockquote>
 470    * </pre>
 471    *
 472    * @param featureMap
 473    * @return
 474    */
 475   protected static List<String> buildSetAttributeCommands(
 476           Map<String, Map<Object, AtomSpecModel>> featureMap)
 477   {
 478     List<String> commands = new ArrayList<>();
 479     for (String featureType : featureMap.keySet())
 480     {
 481       String attributeName = makeAttributeName(featureType);
 482
 483       /*
 484        * clear down existing attributes for this feature
 485        */
 486       // 'problem' - sets attribute to None on all residues - overkill?
 487       // commands.add("~setattr r " + attributeName + " :*");
 488
 489       Map<Object, AtomSpecModel> values = featureMap.get(featureType);
 490       for (Object value : values.keySet())
 491       {
 492         /*
 493          * for each distinct value recorded for this feature type,
 494          * add a command to set the attribute on the mapped residues
 495          * Put values in single quotes, encoding any embedded single quotes
 496          */
 497         StringBuilder sb = new StringBuilder(128);
 498         String featureValue = value.toString();
 499         featureValue = featureValue.replaceAll("\\'", "&#39;");
 500         sb.append("setattr r ").append(attributeName).append(" '")
 501                 .append(featureValue).append("' ");
 502         sb.append(values.get(value).getAtomSpec());
 503         commands.add(sb.toString());
 504       }
 505     }
 506
 507     return commands;
 508   }
 509
 510   /**
 511    * Makes a prefixed and valid Chimera attribute name. A jv_ prefix is applied
 512    * for a 'Jalview' namespace, and any non-alphanumeric character is converted
 513    * to an underscore.
 514    *
 515    * @param featureType
 516    * @return
 517    *
 518    *         <pre>
 519    * &#64;see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/setattr.html
 520    *         </pre>
 521    */
 522   protected static String makeAttributeName(String featureType)
 523   {
 524     StringBuilder sb = new StringBuilder();
 525     if (featureType != null)
 526     {
 527       for (char c : featureType.toCharArray())
 528       {
 529         sb.append(Character.isLetterOrDigit(c) ? c : '_');
 530       }
 531     }
 532     String attName = NAMESPACE_PREFIX + sb.toString();
 533
 534     /*
 535      * Chimera treats an attribute name ending in 'color' as colour-valued;
 536      * Jalview doesn't, so prevent this by appending an underscore
 537      */
 538     if (attName.toUpperCase().endsWith("COLOR"))
 539     {
 540       attName += "_";
 541     }
 542
 543     return attName;
 544   }
 545
 546 }