/* * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of Jalview. * * Jalview is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation, either version 3 * of the License, or (at your option) any later version. * * Jalview is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty * of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. See the GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with Jalview. If not, see . * The Jalview Authors are detailed in the 'AUTHORS' file. */ 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 jalview.util.StructureCommands; import java.awt.Color; import java.util.ArrayList; import java.util.HashMap; import java.util.LinkedHashMap; import java.util.List; import java.util.Map; /** * Routines for generating Chimera commands for Jalview/Chimera binding * * @author JimP * */ public class ChimeraCommands extends StructureCommands { public static final String NAMESPACE_PREFIX = "jv_"; /* * colour for residues shown in structure but hidden in alignment */ private static final String COLOR_GRAY_HEX = "color " + ColorUtils.toTkCode(Color.GRAY); /** * Constructs Chimera commands to colour residues as per the Jalview alignment * * @param colourMap * @param binding * @return */ public static String[] getColourBySequenceCommand( Map colourMap, AAStructureBindingModel binding) { List colourCommands = buildColourCommands(colourMap, binding); return colourCommands.toArray(new String[colourCommands.size()]); } /** * 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 * *
   * 
* color colorname #modelnumber:range.chain * e.g. color #00ff00 #0:2.B,4.B,9-12.B|#1:1.A,2-6.A,... *
*
* * @param colourMap * @param binding * @return */ protected static List buildColourCommands( Map 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 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> featureMap = buildFeaturesMap( ssm, files, seqs, viewPanel); List commands = buildSetAttributeCommands(featureMap, binding); StructureMappingcommandSet cs = new StructureMappingcommandSet( ChimeraCommands.class, null, commands.toArray(new String[commands.size()])); return cs; } /** *
   * Helper method to build a map of 
   *   { featureType, { feature value, AtomSpecModel } }
   * 
* * @param ssm * @param files * @param seqs * @param viewPanel * @return */ protected static Map> buildFeaturesMap( StructureSelectionManager ssm, String[] files, SequenceI[][] seqs, AlignmentViewPanel viewPanel) { Map> theMap = new LinkedHashMap<>(); FeatureRenderer fr = viewPanel.getFeatureRenderer(); if (fr == null) { return theMap; } AlignViewportI viewport = viewPanel.getAlignViewport(); List visibleFeatures = fr.getDisplayedFeatureTypes(); /* * if alignment is showing features from complement, we also transfer * these features to the corresponding mapped structure residues */ boolean showLinkedFeatures = viewport.isShowComplementFeatures(); List 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; } AlignmentI alignment = viewPanel.getAlignment(); for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++) { StructureMapping[] mapping = ssm.getMapping(files[pdbfnum]); if (mapping == null || mapping.length < 1) { continue; } 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; } /** * 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> theMap, int modelNumber) { /* * 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 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 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()); } } } } } } /** * 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) { List 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 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 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()); } } } } /** * 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 * *

   * 
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,... *
*
* * @param featureMap * @param binding * @return */ protected static List buildSetAttributeCommands( Map> featureMap, AAStructureBindingModel binding) { List commands = new ArrayList<>(); for (String featureType : featureMap.keySet()) { 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()) { /* * 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 */ StringBuilder sb = new StringBuilder(128); 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()); } } return commands; } /** * 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 * *
   * @see https://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/setattr.html
   *         
*/ protected static 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(); /* * 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")) { attName += "_"; } return attName; } /** * Returns the range(s) formatted as a Chimera atomspec * * @return */ public static String getAtomSpec(AtomSpecModel atomSpec, AAStructureBindingModel binding) { StringBuilder sb = new StringBuilder(128); boolean firstModel = true; for (Integer model : atomSpec.getModels()) { if (!firstModel) { sb.append("|"); } firstModel = false; sb.append(binding.getModelSpec(model)).append(":"); boolean firstPositionForModel = true; for (String chain : atomSpec.getChains(model)) { chain = " ".equals(chain) ? chain : chain.trim(); List rangeList = atomSpec.getRanges(model, chain); String chainToken = " ".equals(chain) ? "." : "." + chain; appendResidueRange(sb, rangeList, chainToken, firstPositionForModel); firstPositionForModel = false; } } return sb.toString(); } /** * 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) { sb.append("."); if (!" ".equals(chain)) { sb.append(chain); } } }