X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fstructures%2Fmodels%2FAAStructureBindingModel.java;h=b55885d0cead719ee305e5de7edb27c0390fcb4a;hb=8f0f304ea24d01bc052089dde29a22934c73b326;hp=e77a23c55b0a47e61219bd2db8c58735bd2860fb;hpb=43b415c68805f3dec44a6ddc666d52220483c120;p=jalview.git diff --git a/src/jalview/structures/models/AAStructureBindingModel.java b/src/jalview/structures/models/AAStructureBindingModel.java index e77a23c..b55885d 100644 --- a/src/jalview/structures/models/AAStructureBindingModel.java +++ b/src/jalview/structures/models/AAStructureBindingModel.java @@ -1,13 +1,40 @@ +/* + * 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.structures.models; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; - +import jalview.api.AlignViewportI; +import jalview.api.AlignmentViewPanel; +import jalview.api.FeatureRenderer; +import jalview.api.SequenceRenderer; import jalview.api.StructureSelectionManagerProvider; +import jalview.api.structures.JalviewStructureDisplayI; import jalview.datamodel.AlignmentI; +import jalview.datamodel.HiddenColumns; import jalview.datamodel.PDBEntry; import jalview.datamodel.SequenceI; +import jalview.ext.rbvi.chimera.AtomSpecModel; +import jalview.ext.rbvi.chimera.ChimeraCommands; +import jalview.io.DataSourceType; +import jalview.renderer.seqfeatures.FeatureColourFinder; +import jalview.schemes.ColourSchemeI; import jalview.structure.AtomSpec; import jalview.structure.StructureListener; import jalview.structure.StructureMapping; @@ -15,6 +42,16 @@ import jalview.structure.StructureSelectionManager; import jalview.util.Comparison; import jalview.util.MessageManager; +import java.awt.Color; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.BitSet; +import java.util.Collections; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + /** * * A base class to hold common function for protein structure model binding. @@ -24,13 +61,17 @@ import jalview.util.MessageManager; * @author gmcarstairs * */ -public abstract class AAStructureBindingModel extends - SequenceStructureBindingModel implements StructureListener, - StructureSelectionManagerProvider +public abstract class AAStructureBindingModel + extends SequenceStructureBindingModel + implements StructureListener, StructureSelectionManagerProvider { private StructureSelectionManager ssm; + /* + * distinct PDB entries (pdb files) associated + * with sequences + */ private PDBEntry[] pdbEntry; /* @@ -46,12 +87,34 @@ public abstract class AAStructureBindingModel extends /* * datasource protocol for access to PDBEntrylatest */ - String protocol = null; + DataSourceType protocol = null; protected boolean colourBySequence = true; private boolean nucleotide; + private boolean finishedInit = false; + + /** + * current set of model filenames loaded in the Jmol instance + */ + protected String[] modelFileNames = null; + + public String fileLoadingError; + + private boolean showAlignmentOnly; + + /* + * a list of chains "pdbid:chainid" to show in the viewer; + * empty means show all + */ + // TODO make private once deprecated JalviewJmolBinding.centerViewer removed + protected List chainsToShow; + + private boolean hideHiddenRegions; + + protected List chainNames = new ArrayList<>(); + /** * Data bean class to simplify parameterisation in superposeStructures */ @@ -92,6 +155,7 @@ public abstract class AAStructureBindingModel extends { this.ssm = ssm; this.sequence = seqs; + chainsToShow = new ArrayList<>(); } /** @@ -100,25 +164,73 @@ public abstract class AAStructureBindingModel extends * @param ssm * @param pdbentry * @param sequenceIs - * @param chains * @param protocol */ public AAStructureBindingModel(StructureSelectionManager ssm, - PDBEntry[] pdbentry, SequenceI[][] sequenceIs, String[][] chains, - String protocol) + PDBEntry[] pdbentry, SequenceI[][] sequenceIs, + DataSourceType protocol) { this.ssm = ssm; this.sequence = sequenceIs; this.nucleotide = Comparison.isNucleotide(sequenceIs); - this.chains = chains; this.pdbEntry = pdbentry; this.protocol = protocol; - if (chains == null) + chainsToShow = new ArrayList<>(); + + resolveChains(); + } + + private boolean resolveChains() + { + /** + * final count of chain mappings discovered + */ + int chainmaps = 0; + // JBPNote: JAL-2693 - this should be a list of chain mappings per + // [pdbentry][sequence] + String[][] newchains = new String[pdbEntry.length][]; + int pe = 0; + for (PDBEntry pdb : pdbEntry) { - this.chains = new String[pdbentry.length][]; + SequenceI[] seqsForPdb = sequence[pe]; + if (seqsForPdb != null) + { + newchains[pe] = new String[seqsForPdb.length]; + int se = 0; + for (SequenceI asq : seqsForPdb) + { + String chain = (chains != null && chains[pe] != null) + ? chains[pe][se] + : null; + SequenceI sq = (asq.getDatasetSequence() == null) ? asq + : asq.getDatasetSequence(); + if (sq.getAllPDBEntries() != null) + { + for (PDBEntry pdbentry : sq.getAllPDBEntries()) + { + if (pdb.getFile() != null && pdbentry.getFile() != null + && pdb.getFile().equals(pdbentry.getFile())) + { + String chaincode = pdbentry.getChainCode(); + if (chaincode != null && chaincode.length() > 0) + { + chain = chaincode; + chainmaps++; + break; + } + } + } + } + newchains[pe][se] = chain; + se++; + } + pe++; + } } - } + chains = newchains; + return chainmaps > 0; + } public StructureSelectionManager getSsm() { return ssm; @@ -176,7 +288,7 @@ public abstract class AAStructureBindingModel extends return chains; } - public String getProtocol() + public DataSourceType getProtocol() { return protocol; } @@ -200,7 +312,9 @@ public abstract class AAStructureBindingModel extends /** * Construct a title string for the viewer window based on the data Jalview * knows about - * @param viewerName TODO + * + * @param viewerName + * TODO * @param verbose * * @return @@ -208,33 +322,28 @@ public abstract class AAStructureBindingModel extends public String getViewerTitle(String viewerName, boolean verbose) { if (getSequence() == null || getSequence().length < 1 - || getPdbCount() < 1 - || getSequence()[0].length < 1) + || getPdbCount() < 1 || getSequence()[0].length < 1) { return ("Jalview " + viewerName + " Window"); } // TODO: give a more informative title when multiple structures are // displayed. StringBuilder title = new StringBuilder(64); - final PDBEntry pdbEntry = getPdbEntry(0); + final PDBEntry pdbe = getPdbEntry(0); title.append(viewerName + " view for " + getSequence()[0][0].getName() - + ":" - + pdbEntry.getId()); - + + ":" + pdbe.getId()); + if (verbose) { - if (pdbEntry.getProperty() != null) + String method = (String) pdbe.getProperty("method"); + if (method != null) { - if (pdbEntry.getProperty().get("method") != null) - { - title.append(" Method: "); - title.append(pdbEntry.getProperty().get("method")); - } - if (pdbEntry.getProperty().get("chains") != null) - { - title.append(" Chain:"); - title.append(pdbEntry.getProperty().get("chains")); - } + title.append(" Method: ").append(method); + } + String chain = (String) pdbe.getProperty("chains"); + if (chain != null) + { + title.append(" Chain:").append(chain); } } return title.toString(); @@ -270,8 +379,8 @@ public abstract class AAStructureBindingModel extends { Integer.valueOf(pe).toString() })); } final String nullChain = "TheNullChain"; - List s = new ArrayList(); - List c = new ArrayList(); + List s = new ArrayList<>(); + List c = new ArrayList<>(); if (getChains() == null) { setChains(new String[getPdbCount()][]); @@ -337,11 +446,11 @@ public abstract class AAStructureBindingModel extends * * @returns the pdb entries added to the current set. */ - public synchronized PDBEntry[] addSequenceAndChain(PDBEntry[] pdbe, SequenceI[][] seq, - String[][] chns) + public synchronized PDBEntry[] addSequenceAndChain(PDBEntry[] pdbe, + SequenceI[][] seq, String[][] chns) { - List v = new ArrayList(); - List rtn = new ArrayList(); + List v = new ArrayList<>(); + List rtn = new ArrayList<>(); for (int i = 0; i < getPdbCount(); i++) { v.add(getPdbEntry(i)); @@ -351,8 +460,7 @@ public abstract class AAStructureBindingModel extends int r = v.indexOf(pdbe[i]); if (r == -1 || r >= getPdbCount()) { - rtn.add(new int[] - { v.size(), i }); + rtn.add(new int[] { v.size(), i }); v.add(pdbe[i]); } else @@ -489,18 +597,22 @@ public abstract class AAStructureBindingModel extends * the sequence alignment which is the basis of structure * superposition * @param matched - * an array of booleans, indexed by alignment column, where true - * indicates that every structure has a mapped residue present in the - * column (so the column can participate in structure alignment) + * a BitSet, where bit j is set to indicate that every structure has + * a mapped residue present in column j (so the column can + * participate in structure alignment) * @param structures * an array of data beans corresponding to pdb file index * @return */ protected int findSuperposableResidues(AlignmentI alignment, - boolean[] matched, SuperposeData[] structures) + BitSet matched, SuperposeData[] structures) { int refStructure = -1; - String[] files = getPdbFile(); + String[] files = getStructureFiles(); + if (files == null) + { + return -1; + } for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++) { StructureMapping[] mappings = getSsm().getMapping(files[pdbfnum]); @@ -523,16 +635,16 @@ public abstract class AAStructureBindingModel extends { refStructure = pdbfnum; } - for (int r = 0; r < matched.length; r++) + for (int r = 0; r < alignment.getWidth(); r++) { - if (!matched[r]) + if (!matched.get(r)) { continue; } int pos = getMappedPosition(theSequence, r, mapping); if (pos < 1 || pos == lastPos) { - matched[r] = false; + matched.clear(r); continue; } lastPos = pos; @@ -545,7 +657,11 @@ public abstract class AAStructureBindingModel extends } structures[pdbfnum].pdbId = mapping.getPdbId(); structures[pdbfnum].isRna = theSequence.getRNA() != null; - // move on to next pdb file + + /* + * move on to next pdb file (ignore sequences for other chains + * for the same structure) + */ s = seqCountForPdbFile; break; } @@ -578,6 +694,10 @@ public abstract class AAStructureBindingModel extends for (String file : files) { notLoaded = file; + if (file == null) + { + continue; + } try { StructureMapping[] sm = getSsm().getMapping(file); @@ -594,8 +714,8 @@ public abstract class AAStructureBindingModel extends if (waiting) { - System.err - .println("Timed out waiting for structure viewer to load file " + System.err.println( + "Timed out waiting for structure viewer to load file " + notLoaded); return false; } @@ -613,7 +733,8 @@ public abstract class AAStructureBindingModel extends { for (SequenceI s : seqs) { - if (s == seq) + if (s == seq || (s.getDatasetSequence() != null + && s.getDatasetSequence() == seq.getDatasetSequence())) { return true; } @@ -623,4 +744,441 @@ public abstract class AAStructureBindingModel extends } return false; } -} \ No newline at end of file + + public boolean isFinishedInit() + { + return finishedInit; + } + + public void setFinishedInit(boolean fi) + { + this.finishedInit = fi; + } + + /** + * Returns the Jalview panel hosting the structure viewer (if any) + * + * @return + */ + public JalviewStructureDisplayI getViewer() + { + return null; + } + + public abstract void setJalviewColourScheme(ColourSchemeI cs); + + /** + * Constructs and sends a command to align structures against a reference + * structure, based on one or more sequence alignments. May optionally return + * an error or warning message for the alignment command. + * + * @param alignments + * an array of alignments to process + * @param structureIndices + * an array of corresponding reference structures (index into pdb + * file array); if a negative value is passed, the first PDB file + * mapped to an alignment sequence is used as the reference for + * superposition + * @param hiddenCols + * an array of corresponding hidden columns for each alignment + * @return + */ + public abstract String superposeStructures(AlignmentI[] alignments, + int[] structureIndices, HiddenColumns[] hiddenCols); + + public abstract void setBackgroundColour(Color col); + + protected abstract String[] getColourBySequenceCommands( + String[] files, AlignmentViewPanel avp); + + /** + * returns the current sequenceRenderer that should be used to colour the + * structures + * + * @param alignment + * + * @return + */ + public abstract SequenceRenderer getSequenceRenderer( + AlignmentViewPanel alignment); + + protected abstract void colourBySequence( + String[] colourBySequenceCommands); + + public abstract void colourByChain(); + + public abstract void colourByCharge(); + + /** + * Recolours the displayed structures, if they are coloured by sequence, or + * 'show only visible alignment' is selected. This supports updating structure + * colours on either change of alignment colours, or change to the visible + * region of the alignment. + */ + public void updateStructureColours(AlignmentViewPanel alignmentv) + { + if (!isLoadingFinished()) + { + return; + } + + /* + * if structure is not coloured by sequence, but restricted to the alignment, + * then redraw it (but don't recolour it) in case hidden regions have changed + * (todo: specific messaging for change of hidden region only) + */ + if (!colourBySequence) + { + if (isShowAlignmentOnly()) + { + showStructures(alignmentv.getAlignViewport(), false); + } + return; + } + if (getSsm() == null) + { + return; + } + String[] files = getStructureFiles(); + + String[] colourBySequenceCommands = getColourBySequenceCommands( + files, alignmentv); + colourBySequence(colourBySequenceCommands); + } + + public boolean hasFileLoadingError() + { + return fileLoadingError != null && fileLoadingError.length() > 0; + } + + public abstract jalview.api.FeatureRenderer getFeatureRenderer( + AlignmentViewPanel alignment); + + /** + * Sets the flag for whether only mapped visible residues in the alignment + * should be visible in the structure viewer + * + * @param b + */ + public void setShowAlignmentOnly(boolean b) + { + showAlignmentOnly = b; + } + + /** + * Answers true if only residues mapped to the alignment should be shown in the + * structure viewer, else false + * + * @return + */ + public boolean isShowAlignmentOnly() + { + return showAlignmentOnly; + } + + /** + * Sets the flag for hiding regions of structure which are hidden in the + * alignment (only applies when the structure viewer is restricted to the + * alignment only) + * + * @param b + */ + public void setHideHiddenRegions(boolean b) + { + hideHiddenRegions = b; + } + + /** + * Answers true if regions hidden in the alignment should also be hidden in the + * structure viewer, else false (only applies when the structure viewer is + * restricted to the alignment only) + * + * @return + */ + public boolean isHideHiddenRegions() + { + return hideHiddenRegions; + } + + /** + * Shows the structures in the viewer, without changing their colouring. This is + * to support toggling of whether the whole structure is shown, or only residues + * mapped to visible regions of the alignment. + * + * @param alignViewportI + * @param refocus + * if true, refit the display to the viewer + */ + public void showStructures(AlignViewportI alignViewportI, boolean refocus) + { + // override with implementation + } + + @Override + public void updateColours(Object source) + { + AlignmentViewPanel ap = (AlignmentViewPanel) source; + // ignore events from panels not used to colour this view + if (!getViewer().isUsedforcolourby(ap)) + { + return; + } + if (!isLoadingFromArchive()) + { + updateStructureColours(ap); + } + } + + /** + * Sets the list of chains to display (as "pdbid:chain"), where an empty list + * means show all + * + * @param chains + */ + public void setChainsToShow(List chains) + { + chainsToShow = chains; + } + + /** + * Answers true if the specified structure and chain are selected to be shown in + * the viewer, else false + * + * @param pdbId + * @param chainId + * @return + */ + protected boolean isShowChain(String pdbId, String chainId) + { + if (chainsToShow.isEmpty()) + { + return true; + } + return chainsToShow.contains(pdbId + ":" + chainId); + } + + @Override + public abstract String[] getStructureFiles(); + + /** + * Builds a model of residues mapped from sequences to show on structure, taking + * into account user choices of + *
    + *
  • which chains are shown
  • + *
  • whether all structure is shown, or only that mapped to the alignment
  • + *
  • whether hidden regions of the alignment are hidden (excluded) or grayed + * out (included)
  • + *
+ * + * @param av + * @return + */ + protected AtomSpecModel getShownResidues(AlignViewportI av) + { + AlignmentI alignment = av.getAlignment(); + final int width = alignment.getWidth(); + + String[] files = getStructureFiles(); + + AtomSpecModel model = new AtomSpecModel(); + + for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++) + { + StructureMapping[] mappings = getSsm().getMapping(files[pdbfnum]); + + /* + * Find the first mapped sequence (if any) for this PDB entry which is in + * the alignment + */ + final int seqCountForPdbFile = getSequence()[pdbfnum].length; + for (int s = 0; s < seqCountForPdbFile; s++) + { + for (StructureMapping mapping : mappings) + { + final SequenceI theSequence = getSequence()[pdbfnum][s]; + if (mapping.getSequence() == theSequence + && alignment.findIndex(theSequence) > -1) + { + String chainCd = mapping.getChain(); + if (!isShowChain(mapping.getPdbId(), chainCd)) + { + continue; + } + Iterator visible; + if (isShowAlignmentOnly() && isHideHiddenRegions()) + { + visible = alignment.getHiddenColumns() + .getVisContigsIterator(0, width, true); + } + else + { + visible = Collections.singletonList(new int[] { 0, width }) + .iterator(); + } + while (visible.hasNext()) + { + int[] visibleRegion = visible.next(); + int seqStartPos = theSequence.findPosition(visibleRegion[0]); + int seqEndPos = theSequence.findPosition(visibleRegion[1]); + List residueRanges = mapping + .getPDBResNumRanges(seqStartPos, seqEndPos); + if (!residueRanges.isEmpty()) + { + for (int[] range : residueRanges) + { + model.addRange(pdbfnum, range[0], range[1], chainCd); + } + } + } + } + } + } + } + + return model; + } + + /** + * Answers a default structure model specification which is simply the string + * form of the model number. Override if needed to specify submodels. + * + * @param model + * @return + */ + public String getModelSpec(int model) + { + return String.valueOf(model); + } + + /** + * Build a data structure which records contiguous subsequences for each colour. + * From this 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) + * + * @param viewPanel + * @return + */ + public Map buildColoursMap( + AlignmentViewPanel viewPanel) + { + FeatureRenderer fr = viewPanel.getFeatureRenderer(); + FeatureColourFinder finder = new FeatureColourFinder(fr); + AlignViewportI viewport = viewPanel.getAlignViewport(); + HiddenColumns cs = viewport.getAlignment().getHiddenColumns(); + AlignmentI al = viewport.getAlignment(); + SequenceRenderer sr = getSequenceRenderer(viewPanel); + String[] files = getStructureFiles(); + + 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 = al.findIndex(seq)) > -1) + { + SequenceI asp = al.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, finder); + + /* + * hidden regions are shown gray or, optionally, ignored + */ + if (!cs.isVisible(r)) + { + if (hideHiddenRegions) + { + continue; + } + else + { + colour = Color.GRAY; + } + } + + 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) + { + ChimeraCommands.addAtomSpecRange(colourMap, lastColour, + pdbfnum, startPos, + lastPos, lastChain); + } + startPos = pos; + } + lastColour = colour; + lastPos = pos; + lastChain = chain; + } + // final colour range + if (lastColour != null) + { + ChimeraCommands.addAtomSpecRange(colourMap, lastColour, + pdbfnum, + startPos, lastPos, lastChain); + } + // break; + } + } + } + } + return colourMap; + } + + /** + * Returns a list of chains mapped in this viewer. Note this list is not + * currently scoped per structure. + * + * @return + */ + public List getChainNames() + { + return chainNames; + } +}