JAL-2757 fix PDB also; suppress stack trace and compiler warnings
[jalview.git] / 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
54   public static final String NAMESPACE_PREFIX = "jv_";
55
56   /**
57    * Constructs Chimera commands to colour residues as per the Jalview alignment
58    * 
59    * @param ssm
60    * @param files
61    * @param sequence
62    * @param sr
63    * @param fr
64    * @param viewPanel
65    * @return
66    */
67   public static StructureMappingcommandSet[] getColourBySequenceCommand(
68           StructureSelectionManager ssm, String[] files,
69           SequenceI[][] sequence, SequenceRenderer sr,
70           AlignmentViewPanel viewPanel)
71   {
72     Map<Object, AtomSpecModel> colourMap = buildColoursMap(ssm, files,
73             sequence, sr, viewPanel);
74
75     List<String> colourCommands = buildColourCommands(colourMap);
76
77     StructureMappingcommandSet cs = new StructureMappingcommandSet(
78             ChimeraCommands.class, null,
79             colourCommands.toArray(new String[colourCommands.size()]));
80
81     return new StructureMappingcommandSet[] { cs };
82   }
83
84   /**
85    * Traverse the map of colours/models/chains/positions to construct a list of
86    * 'color' commands (one per distinct colour used). The format of each command
87    * is
88    * 
89    * <pre>
90    * <blockquote> 
91    * color colorname #modelnumber:range.chain 
92    * e.g. color #00ff00 #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,...
93    * </blockquote>
94    * </pre>
95    * 
96    * @param colourMap
97    * @return
98    */
99   protected static List<String> buildColourCommands(
100           Map<Object, AtomSpecModel> colourMap)
101   {
102     /*
103      * This version concatenates all commands into a single String (semi-colon
104      * delimited). If length limit issues arise, refactor to return one color
105      * command per colour.
106      */
107     List<String> commands = new ArrayList<String>();
108     StringBuilder sb = new StringBuilder(256);
109     boolean firstColour = true;
110     for (Object key : colourMap.keySet())
111     {
112       Color colour = (Color) key;
113       String colourCode = ColorUtils.toTkCode(colour);
114       if (!firstColour)
115       {
116         sb.append("; ");
117       }
118       sb.append("color ").append(colourCode).append(" ");
119       firstColour = false;
120       final AtomSpecModel colourData = colourMap.get(colour);
121       sb.append(colourData.getAtomSpec());
122     }
123     commands.add(sb.toString());
124     return commands;
125   }
126
127   /**
128    * Traverses a map of { modelNumber, {chain, {list of from-to ranges} } } and
129    * builds a Chimera format atom spec
130    * 
131    * @param modelAndChainRanges
132    */
133   protected static String getAtomSpec(
134           Map<Integer, Map<String, List<int[]>>> modelAndChainRanges)
135   {
136     StringBuilder sb = new StringBuilder(128);
137     boolean firstModelForColour = true;
138     for (Integer model : modelAndChainRanges.keySet())
139     {
140       boolean firstPositionForModel = true;
141       if (!firstModelForColour)
142       {
143         sb.append("|");
144       }
145       firstModelForColour = false;
146       sb.append("#").append(model).append(":");
147
148       final Map<String, List<int[]>> modelData = modelAndChainRanges
149               .get(model);
150       for (String chain : modelData.keySet())
151       {
152         boolean hasChain = !"".equals(chain.trim());
153         for (int[] range : modelData.get(chain))
154         {
155           if (!firstPositionForModel)
156           {
157             sb.append(",");
158           }
159           if (range[0] == range[1])
160           {
161             sb.append(range[0]);
162           }
163           else
164           {
165             sb.append(range[0]).append("-").append(range[1]);
166           }
167           if (hasChain)
168           {
169             sb.append(".").append(chain);
170           }
171           firstPositionForModel = false;
172         }
173       }
174     }
175     return sb.toString();
176   }
177
178   /**
179    * <pre>
180    * Build a data structure which records contiguous subsequences for each colour. 
181    * From this we can easily generate the Chimera command for colour by sequence.
182    * Color
183    *     Model number
184    *         Chain
185    *             list of start/end ranges
186    * Ordering is by order of addition (for colours and positions), natural ordering (for models and chains)
187    * </pre>
188    */
189   protected static Map<Object, AtomSpecModel> buildColoursMap(
190           StructureSelectionManager ssm, String[] files,
191           SequenceI[][] sequence, SequenceRenderer sr,
192           AlignmentViewPanel viewPanel)
193   {
194     FeatureRenderer fr = viewPanel.getFeatureRenderer();
195     FeatureColourFinder finder = new FeatureColourFinder(fr);
196     AlignViewportI viewport = viewPanel.getAlignViewport();
197     HiddenColumns cs = viewport.getAlignment().getHiddenColumns();
198     AlignmentI al = viewport.getAlignment();
199     Map<Object, AtomSpecModel> colourMap = new LinkedHashMap<Object, AtomSpecModel>();
200     Color lastColour = null;
201
202     for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
203     {
204       StructureMapping[] mapping = ssm.getMapping(files[pdbfnum]);
205
206       if (mapping == null || mapping.length < 1)
207       {
208         continue;
209       }
210
211       int startPos = -1, lastPos = -1;
212       String lastChain = "";
213       for (int s = 0; s < sequence[pdbfnum].length; s++)
214       {
215         for (int sp, m = 0; m < mapping.length; m++)
216         {
217           final SequenceI seq = sequence[pdbfnum][s];
218           if (mapping[m].getSequence() == seq
219                   && (sp = al.findIndex(seq)) > -1)
220           {
221             SequenceI asp = al.getSequenceAt(sp);
222             for (int r = 0; r < asp.getLength(); r++)
223             {
224               // no mapping to gaps in sequence
225               if (Comparison.isGap(asp.getCharAt(r)))
226               {
227                 continue;
228               }
229               int pos = mapping[m].getPDBResNum(asp.findPosition(r));
230
231               if (pos < 1 || pos == lastPos)
232               {
233                 continue;
234               }
235
236               Color colour = sr.getResidueColour(seq, r, finder);
237
238               /*
239                * darker colour for hidden regions
240                */
241               if (!cs.isVisible(r))
242               {
243                 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<String, Map<Object, AtomSpecModel>>();
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<Object, AtomSpecModel>();
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<String>();
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 }