X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FSequenceGroup.java;h=39ee2cb7d71c089e8eb6b5f6e221463ba6e8bdc2;hb=refs%2Fheads%2Ffeatures%2Fhmmer_statistics;hp=b4cb3b17024087dd717c678610991f0f2648a3fb;hpb=7ab5d6b0ba5fec1ea4a4239e79c476d841622485;p=jalview.git diff --git a/src/jalview/datamodel/SequenceGroup.java b/src/jalview/datamodel/SequenceGroup.java index b4cb3b1..39ee2cb 100755 --- a/src/jalview/datamodel/SequenceGroup.java +++ b/src/jalview/datamodel/SequenceGroup.java @@ -1,6 +1,6 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2) - * Copyright (C) 2014 The Jalview Authors + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of Jalview. * @@ -20,13 +20,16 @@ */ package jalview.datamodel; -import java.util.*; -import java.util.List; - -import java.awt.*; +import jalview.analysis.AAFrequency; +import jalview.analysis.Conservation; +import jalview.renderer.ResidueShader; +import jalview.renderer.ResidueShaderI; +import jalview.schemes.ColourSchemeI; -import jalview.analysis.*; -import jalview.schemes.*; +import java.awt.Color; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; /** * Collects a set contiguous ranges on a set of sequences @@ -42,14 +45,20 @@ public class SequenceGroup implements AnnotatedCollectionI Conservation conserve; - Vector aaFrequency; - boolean displayBoxes = true; boolean displayText = true; boolean colourText = false; + HiddenMarkovModel hmm; + + /** + * True if the group is defined as a group on the alignment, false if it is + * just a selection. + */ + boolean isDefined = false; + /** * after Olivier's non-conserved only character display */ @@ -58,7 +67,7 @@ public class SequenceGroup implements AnnotatedCollectionI /** * group members */ - private Vector sequences = new Vector(); + private List sequences = new ArrayList<>(); /** * representative sequence for this group (if any) @@ -70,10 +79,12 @@ public class SequenceGroup implements AnnotatedCollectionI /** * Colourscheme applied to group if any */ - public ColourSchemeI cs; + public ResidueShaderI cs; + // start column (base 0) int startRes = 0; + // end column (base 0) int endRes = 0; public Color outlineColour = Color.black; @@ -91,6 +102,8 @@ public class SequenceGroup implements AnnotatedCollectionI */ private boolean ignoreGapsInConsensus = true; + private boolean ignoreBelowBackground = true; + /** * consensus calculation property */ @@ -101,13 +114,31 @@ public class SequenceGroup implements AnnotatedCollectionI */ private boolean normaliseSequenceLogo; - /** - * @return the includeAllConsSymbols + /* + * visibility of rows or represented rows covered by group */ - public boolean isShowSequenceLogo() - { - return showSequenceLogo; - } + private boolean hidereps = false; + + /* + * visibility of columns intersecting this group + */ + private boolean hidecols = false; + + AlignmentAnnotation consensus = null; + + AlignmentAnnotation conservation = null; + + AlignmentAnnotation informationContent = null; + + private boolean showConsensusHistogram; + + private AnnotatedCollectionI context; + + private boolean showHMMSequenceLogo; + + private boolean normaliseHMMSequenceLogo; + + private boolean showInformationHistogram; /** * Creates a new SequenceGroup object. @@ -115,6 +146,7 @@ public class SequenceGroup implements AnnotatedCollectionI public SequenceGroup() { groupName = "JGroup:" + this.hashCode(); + cs = new ResidueShader(); } /** @@ -131,16 +163,17 @@ public class SequenceGroup implements AnnotatedCollectionI * @param end * last column of group */ - public SequenceGroup(Vector sequences, String groupName, + public SequenceGroup(List sequences, String groupName, ColourSchemeI scheme, boolean displayBoxes, boolean displayText, boolean colourText, int start, int end) { + this(); this.sequences = sequences; this.groupName = groupName; this.displayBoxes = displayBoxes; this.displayText = displayText; this.colourText = colourText; - this.cs = scheme; + this.cs = new ResidueShader(scheme); startRes = start; endRes = end; recalcConservation(); @@ -153,15 +186,11 @@ public class SequenceGroup implements AnnotatedCollectionI */ public SequenceGroup(SequenceGroup seqsel) { + this(); if (seqsel != null) { - sequences = new Vector(); - Enumeration sq = seqsel.sequences.elements(); - while (sq.hasMoreElements()) - { - sequences.addElement(sq.nextElement()); - } - ; + sequences = new ArrayList<>(); + sequences.addAll(seqsel.sequences); if (seqsel.groupName != null) { groupName = new String(seqsel.groupName); @@ -171,11 +200,20 @@ public class SequenceGroup implements AnnotatedCollectionI colourText = seqsel.colourText; startRes = seqsel.startRes; endRes = seqsel.endRes; - cs = seqsel.cs; + cs = new ResidueShader(seqsel.getColourScheme()); if (seqsel.description != null) + { description = new String(seqsel.description); + } hidecols = seqsel.hidecols; hidereps = seqsel.hidereps; + showNonconserved = seqsel.showNonconserved; + showSequenceLogo = seqsel.showSequenceLogo; + normaliseSequenceLogo = seqsel.normaliseSequenceLogo; + showConsensusHistogram = seqsel.showConsensusHistogram; + showHMMSequenceLogo = seqsel.showHMMSequenceLogo; + normaliseHMMSequenceLogo = seqsel.normaliseHMMSequenceLogo; + showInformationHistogram = seqsel.showInformationHistogram; idColour = seqsel.idColour; outlineColour = seqsel.outlineColour; seqrep = seqsel.seqrep; @@ -184,6 +222,7 @@ public class SequenceGroup implements AnnotatedCollectionI thresholdTextColour = seqsel.thresholdTextColour; width = seqsel.width; ignoreGapsInConsensus = seqsel.ignoreGapsInConsensus; + ignoreBelowBackground = seqsel.ignoreBelowBackground; if (seqsel.conserve != null) { recalcConservation(); // safer than @@ -192,6 +231,11 @@ public class SequenceGroup implements AnnotatedCollectionI } } + public boolean isShowSequenceLogo() + { + return showSequenceLogo; + } + public SequenceI[] getSelectionAsNewSequences(AlignmentI align) { int iSize = sequences.size(); @@ -206,7 +250,7 @@ public class SequenceGroup implements AnnotatedCollectionI if (seqs[ipos] != null) { seqs[ipos].setDescription(seq.getDescription()); - seqs[ipos].setDBRef(seq.getDBRef()); + seqs[ipos].setDBRefs(seq.getDBRefs()); seqs[ipos].setSequenceFeatures(seq.getSequenceFeatures()); if (seq.getDatasetSequence() != null) { @@ -233,7 +277,9 @@ public class SequenceGroup implements AnnotatedCollectionI } } if (!found) + { continue; + } } AlignmentAnnotation newannot = new AlignmentAnnotation( seq.getAnnotation()[a]); @@ -289,26 +335,27 @@ public class SequenceGroup implements AnnotatedCollectionI return eres; } + @Override public List getSequences() { return sequences; } + @Override public List getSequences( Map hiddenReps) { if (hiddenReps == null) { + // TODO: need a synchronizedCollection here ? return sequences; } else { - Vector allSequences = new Vector(); - SequenceI seq; - for (int i = 0; i < sequences.size(); i++) + List allSequences = new ArrayList<>(); + for (SequenceI seq : sequences) { - seq = (SequenceI) sequences.elementAt(i); - allSequences.addElement(seq); + allSequences.add(seq); if (hiddenReps.containsKey(seq)) { SequenceCollectionI hsg = hiddenReps.get(seq); @@ -316,7 +363,7 @@ public class SequenceGroup implements AnnotatedCollectionI { if (seq2 != seq && !allSequences.contains(seq2)) { - allSequences.addElement(seq2); + allSequences.add(seq2); } } } @@ -460,14 +507,17 @@ public class SequenceGroup implements AnnotatedCollectionI */ public void addSequence(SequenceI s, boolean recalc) { - if (s != null && !sequences.contains(s)) + synchronized (sequences) { - sequences.addElement(s); - } + if (s != null && !sequences.contains(s)) + { + sequences.add(s); + } - if (recalc) - { - recalcConservation(); + if (recalc) + { + recalcConservation(); + } } } @@ -495,32 +545,58 @@ public class SequenceGroup implements AnnotatedCollectionI } /** - * calculate residue conservation for group - but only if necessary. + * calculate residue conservation and colourschemes for group - but only if + * necessary. returns true if the calculation resulted in a visible change to + * group */ - public void recalcConservation() + public boolean recalcConservation() { - if (cs == null && consensus == null && conservation == null) + return recalcConservation(false); + } + + /** + * calculate residue conservation for group - but only if necessary. returns + * true if the calculation resulted in a visible change to group + * + * @param defer + * when set, colourschemes for this group are not refreshed after + * recalculation + */ + public boolean recalcConservation(boolean defer) + { + if (cs == null && consensus == null && conservation == null + && informationContent == null) { - return; + return false; } + // TODO: try harder to detect changes in state in order to minimise + // recalculation effort + boolean upd = false; try { - Hashtable cnsns[] = AAFrequency.calculate(sequences, startRes, + ProfilesI cnsns = AAFrequency.calculate(sequences, startRes, endRes + 1, showSequenceLogo); + if (informationContent != null) + { + // _updateInformationRow(cnsns, sequences.size()); TODO don't know what + // to do here + upd = true; + } if (consensus != null) { _updateConsensusRow(cnsns, sequences.size()); + upd = true; } if (cs != null) { cs.setConsensus(cnsns); + upd = true; } if ((conservation != null) || (cs != null && cs.conservationApplied())) { - Conservation c = new Conservation(groupName, - ResidueProperties.propHash, 3, sequences, startRes, + Conservation c = new Conservation(groupName, sequences, startRes, endRes + 1); c.calculate(); c.verdict(false, consPercGaps); @@ -535,17 +611,25 @@ public class SequenceGroup implements AnnotatedCollectionI cs.setConservation(c); } } + // eager update - will cause a refresh of overview regardless + upd = true; } - if (cs != null) + if (cs != null && !defer) { + // TODO: JAL-2034 should cs.alignmentChanged modify return state cs.alignmentChanged(context != null ? context : this, null); + return true; + } + else + { + return upd; } } catch (java.lang.OutOfMemoryError err) { // TODO: catch OOM System.out.println("Out of memory loading groups: " + err); } - + return upd; } private void _updateConservationRow(Conservation c) @@ -568,9 +652,9 @@ public class SequenceGroup implements AnnotatedCollectionI c.completeAnnotations(conservation, null, startRes, endRes + 1); } - public Hashtable[] consensusData = null; + public ProfilesI consensusData = null; - private void _updateConsensusRow(Hashtable[] cnsns, long nseq) + private void _updateConsensusRow(ProfilesI cnsns, long nseq) { if (consensus == null) { @@ -593,6 +677,30 @@ public class SequenceGroup implements AnnotatedCollectionI // ignoreGapsInConsensusCalculation); } + private void _updateInformationRow(ProfilesI cnsns, long nseq) + { + if (consensus == null) + { + getConsensus(); + } + consensus.label = "Consensus for " + getName(); + consensus.description = "Percent Identity"; + consensusData = cnsns; + // preserve width if already set + int aWidth = (consensus.annotations != null) + ? (endRes < consensus.annotations.length + ? consensus.annotations.length : endRes + 1) + : endRes + 1; + consensus.annotations = null; + consensus.annotations = new Annotation[aWidth]; // should be alignment width + + AAFrequency.completeConsensus(consensus, cnsns, startRes, endRes + 1, + ignoreGapsInConsensus, showSequenceLogo, nseq); // TODO: setting + // container + // for + // ignoreGapsInConsensusCalculation); + } + /** * @param s * sequence to either add or remove from group @@ -602,31 +710,37 @@ public class SequenceGroup implements AnnotatedCollectionI */ public void addOrRemove(SequenceI s, boolean recalc) { - if (sequences.contains(s)) + synchronized (sequences) { - deleteSequence(s, recalc); - } - else - { - addSequence(s, recalc); + if (sequences.contains(s)) + { + deleteSequence(s, recalc); + } + else + { + addSequence(s, recalc); + } } } /** - * DOCUMENT ME! + * remove * * @param s - * DOCUMENT ME! + * to be removed * @param recalc - * DOCUMENT ME! + * true means recalculate conservation */ public void deleteSequence(SequenceI s, boolean recalc) { - sequences.removeElement(s); - - if (recalc) + synchronized (sequences) { - recalcConservation(); + sequences.remove(s); + + if (recalc) + { + recalcConservation(); + } } } @@ -635,6 +749,7 @@ public class SequenceGroup implements AnnotatedCollectionI * * @return the first column selected by this group. Runs from 0<=i 0) - { - width = ((SequenceI) sequences.elementAt(0)).getLength(); - } - - for (int i = 1; i < sequences.size(); i++) + synchronized (sequences) { - SequenceI seq = (SequenceI) sequences.elementAt(i); - - if (seq.getLength() > width) + // MC This needs to get reset when characters are inserted and deleted + boolean first = true; + for (SequenceI seq : sequences) { - width = seq.getLength(); + if (first || seq.getLength() > width) + { + width = seq.getLength(); + first = false; + } } + return width; } - - return width; } /** @@ -829,39 +935,42 @@ public class SequenceGroup implements AnnotatedCollectionI */ public SequenceI[] getSequencesInOrder(AlignmentI al, boolean trim) { - int sSize = sequences.size(); - int alHeight = al.getHeight(); + synchronized (sequences) + { + int sSize = sequences.size(); + int alHeight = al.getHeight(); - SequenceI[] seqs = new SequenceI[(trim) ? sSize : alHeight]; + SequenceI[] seqs = new SequenceI[(trim) ? sSize : alHeight]; - int index = 0; - for (int i = 0; i < alHeight && index < sSize; i++) - { - if (sequences.contains(al.getSequenceAt(i))) + int index = 0; + for (int i = 0; i < alHeight && index < sSize; i++) { - seqs[(trim) ? index : i] = al.getSequenceAt(i); - index++; + if (sequences.contains(al.getSequenceAt(i))) + { + seqs[(trim) ? index : i] = al.getSequenceAt(i); + index++; + } } - } - if (index == 0) - { - return null; - } - if (!trim) - { - return seqs; - } - if (index < seqs.length) - { - SequenceI[] dummy = seqs; - seqs = new SequenceI[index]; - while (--index >= 0) + if (index == 0) + { + return null; + } + if (!trim) { - seqs[index] = dummy[index]; - dummy[index] = null; + return seqs; } + if (index < seqs.length) + { + SequenceI[] dummy = seqs; + seqs = new SequenceI[index]; + while (--index >= 0) + { + seqs[index] = dummy[index]; + dummy[index] = null; + } + } + return seqs; } - return seqs; } /** @@ -884,6 +993,7 @@ public class SequenceGroup implements AnnotatedCollectionI /** * @return the representative sequence for this group */ + @Override public SequenceI getSeqrep() { return seqrep; @@ -896,6 +1006,7 @@ public class SequenceGroup implements AnnotatedCollectionI * @param seqrep * the seqrep to set (null means no sequence representative) */ + @Override public void setSeqrep(SequenceI seqrep) { this.seqrep = seqrep; @@ -905,17 +1016,13 @@ public class SequenceGroup implements AnnotatedCollectionI * * @return true if group has a sequence representative */ + @Override public boolean hasSeqrep() { return seqrep != null; } /** - * visibility of rows or represented rows covered by group - */ - private boolean hidereps = false; - - /** * set visibility of sequences covered by (if no sequence representative is * defined) or represented by this group. * @@ -937,11 +1044,6 @@ public class SequenceGroup implements AnnotatedCollectionI } /** - * visibility of columns intersecting this group - */ - private boolean hidecols = false; - - /** * set intended visibility of columns covered by this group * * @param visibility @@ -975,23 +1077,14 @@ public class SequenceGroup implements AnnotatedCollectionI { SequenceGroup sgroup = new SequenceGroup(this); SequenceI[] insect = getSequencesInOrder(alignment); - sgroup.sequences = new Vector(); + sgroup.sequences = new ArrayList<>(); for (int s = 0; insect != null && s < insect.length; s++) { if (map == null || map.containsKey(insect[s])) { - sgroup.sequences.addElement(insect[s]); + sgroup.sequences.add(insect[s]); } } - // Enumeration en =getSequences(hashtable).elements(); - // while (en.hasMoreElements()) - // { - // SequenceI elem = (SequenceI) en.nextElement(); - // if (alignment.getSequences().contains(elem)) - // { - // sgroup.addSequence(elem, false); - // } - // } return sgroup; } @@ -1012,13 +1105,6 @@ public class SequenceGroup implements AnnotatedCollectionI this.showNonconserved = displayNonconserved; } - AlignmentAnnotation consensus = null, conservation = null; - - /** - * flag indicating if consensus histogram should be rendered - */ - private boolean showConsensusHistogram; - /** * set this alignmentAnnotation object as the one used to render consensus * annotation @@ -1035,7 +1121,8 @@ public class SequenceGroup implements AnnotatedCollectionI /** * - * @return automatically calculated consensus row + * @return automatically calculated consensus row note: the row is a stub if a + * consensus calculation has not yet been performed on the group */ public AlignmentAnnotation getConsensus() { @@ -1147,6 +1234,20 @@ public class SequenceGroup implements AnnotatedCollectionI return ignoreGapsInConsensus; } + public void setIgnoreBelowBackground(boolean state) + { + if (this.ignoreBelowBackground != state) + { + ignoreBelowBackground = state; + } + ignoreBelowBackground = state; + } + + public boolean getIgnoreBelowBackground() + { + return true; + } + /** * @param showSequenceLogo * indicates if a sequence logo is shown for consensus annotation @@ -1210,28 +1311,31 @@ public class SequenceGroup implements AnnotatedCollectionI { // TODO add in other methods like 'getAlignmentAnnotation(String label), // etc' - ArrayList annot = new ArrayList(); - for (SequenceI seq : (Vector) sequences) + ArrayList annot = new ArrayList<>(); + synchronized (sequences) { - AlignmentAnnotation[] aa = seq.getAnnotation(); - if (aa != null) + for (SequenceI seq : sequences) { - for (AlignmentAnnotation al : aa) + AlignmentAnnotation[] aa = seq.getAnnotation(); + if (aa != null) { - if (al.groupRef == this) + for (AlignmentAnnotation al : aa) { - annot.add(al); + if (al.groupRef == this) + { + annot.add(al); + } } } } - } - if (consensus != null) - { - annot.add(consensus); - } - if (conservation != null) - { - annot.add(conservation); + if (consensus != null) + { + annot.add(consensus); + } + if (conservation != null) + { + annot.add(conservation); + } } return annot.toArray(new AlignmentAnnotation[0]); } @@ -1239,10 +1343,14 @@ public class SequenceGroup implements AnnotatedCollectionI @Override public Iterable findAnnotation(String calcId) { - ArrayList aa = new ArrayList(); + List aa = new ArrayList<>(); + if (calcId == null) + { + return aa; + } for (AlignmentAnnotation a : getAlignmentAnnotation()) { - if (a.getCalcId() == calcId) + if (calcId.equals(a.getCalcId())) { aa.add(a); } @@ -1250,21 +1358,96 @@ public class SequenceGroup implements AnnotatedCollectionI return aa; } + @Override + public Iterable findAnnotations(SequenceI seq, + String calcId, String label) + { + ArrayList aa = new ArrayList<>(); + for (AlignmentAnnotation ann : getAlignmentAnnotation()) + { + if ((calcId == null || (ann.getCalcId() != null && ann.getCalcId() + .equals(calcId))) + && (seq == null || (ann.sequenceRef != null && ann.sequenceRef == seq)) + && (label == null || (ann.label != null && ann.label + .equals(label)))) + { + aa.add(ann); + } + } + return aa; + } + + /** + * Answer true if any annotation matches the calcId passed in (if not null). + * + * @param calcId + * @return + */ + public boolean hasAnnotation(String calcId) + { + if (calcId != null && !"".equals(calcId)) + { + for (AlignmentAnnotation a : getAlignmentAnnotation()) + { + if (a.getCalcId() == calcId) + { + return true; + } + } + } + return false; + } + + /** + * Remove all sequences from the group (leaving other properties unchanged). + */ public void clear() { - sequences.clear(); + synchronized (sequences) + { + sequences.clear(); + } } - private AnnotatedCollectionI context; + /** + * Sets the alignment or group context for this group, and whether it is + * defined as a group + * + * @param ctx + * the context for the group + * @param defined + * whether the group is defined on the alignment or is just a + * selection + * @throws IllegalArgumentException + * if setting the context would result in a circular reference chain + */ + public void setContext(AnnotatedCollectionI ctx, boolean defined) + { + setContext(ctx); + this.isDefined = defined; + } /** - * set the alignment or group context for this group + * Sets the alignment or group context for this group * - * @param context + * @param ctx + * the context for the group + * @throws IllegalArgumentException + * if setting the context would result in a circular reference chain */ - public void setContext(AnnotatedCollectionI context) + public void setContext(AnnotatedCollectionI ctx) { - this.context = context; + AnnotatedCollectionI ref = ctx; + while (ref != null) + { + if (ref == this || ref.getContext() == ctx) + { + throw new IllegalArgumentException( + "Circular reference in SequenceGroup.context"); + } + ref = ref.getContext(); + } + this.context = ctx; } /* @@ -1277,4 +1460,102 @@ public class SequenceGroup implements AnnotatedCollectionI { return context; } + + public boolean isDefined() + { + return isDefined; + } + + public void setColourScheme(ColourSchemeI scheme) + { + if (cs == null) + { + cs = new ResidueShader(); + } + cs.setColourScheme(scheme); + } + + public void setGroupColourScheme(ResidueShaderI scheme) + { + cs = scheme; + } + + public ColourSchemeI getColourScheme() + { + return cs == null ? null : cs.getColourScheme(); + } + + public ResidueShaderI getGroupColourScheme() + { + return cs; + } + + @Override + public boolean isNucleotide() + { + if (context != null) { + return context.isNucleotide(); + } + return false; + } + + /** + * @param seq + * @return true if seq is a member of the group + */ + + public boolean contains(SequenceI seq1) + { + return sequences.contains(seq1); + } + + /** + * @param seq + * @param apos + * @return true if startRes<=apos and endRes>=apos and seq is in the group + */ + public boolean contains(SequenceI seq, int apos) + { + return (startRes <= apos && endRes >= apos) && sequences.contains(seq); + } + + public boolean isShowInformationHistogram() + { + return showInformationHistogram; + } + + public void setShowInformationHistogram(boolean state) + { + if (showInformationHistogram != state && informationContent != null) + { + this.showInformationHistogram = state; + // recalcConservation(); TODO don't know what to do here next + } + this.showInformationHistogram = state; + + } + + public boolean isShowHMMSequenceLogo() + { + // TODO Auto-generated method stub + return showHMMSequenceLogo; + } + + public void setshowHMMSequenceLogo(boolean state) + { + showHMMSequenceLogo = state; + + } + + public boolean isNormaliseHMMSequenceLogo() + { + // TODO Auto-generated method stub + return normaliseHMMSequenceLogo; + } + + public void setNormaliseHMMSequenceLogo(boolean state) + { + normaliseSequenceLogo = state; + } + }