src/jalview/workers/ConsensusThread.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.workers;
  22
  23 import jalview.analysis.AAFrequency;
  24 import jalview.api.AlignViewportI;
  25 import jalview.api.AlignmentViewPanel;
  26 import jalview.datamodel.AlignmentAnnotation;
  27 import jalview.datamodel.AlignmentI;
  28 import jalview.datamodel.Annotation;
  29 import jalview.datamodel.ProfilesI;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.schemes.ColourSchemeI;
  32
  33 public class ConsensusThread extends AlignCalcWorker
  34 {
  35   public ConsensusThread(AlignViewportI alignViewport,
  36           AlignmentViewPanel alignPanel)
  37   {
  38     super(alignViewport, alignPanel);
  39   }
  40
  41   @Override
  42   public void run()
  43   {
  44     if (calcMan.isPending(this))
  45     {
  46       return;
  47     }
  48     calcMan.notifyStart(this);
  49     long started = System.currentTimeMillis();
  50     try
  51     {
  52       AlignmentAnnotation consensus = getConsensusAnnotation();
  53       AlignmentAnnotation gap = getGapAnnotation();
  54       if ((consensus == null && gap == null) || calcMan.isPending(this))
  55       {
  56         calcMan.workerComplete(this);
  57         return;
  58       }
  59       while (!calcMan.notifyWorking(this))
  60       {
  61         // System.err.println("Thread (Consensus"+Thread.currentThread().getName()+") Waiting around.");
  62         try
  63         {
  64           if (ap != null)
  65           {
  66             ap.paintAlignment(false);
  67           }
  68           Thread.sleep(200);
  69         } catch (Exception ex)
  70         {
  71           ex.printStackTrace();
  72         }
  73       }
  74       if (alignViewport.isClosed())
  75       {
  76         abortAndDestroy();
  77         return;
  78       }
  79       AlignmentI alignment = alignViewport.getAlignment();
  80
  81       int aWidth = -1;
  82
  83       if (alignment == null || (aWidth = alignment.getWidth()) < 0)
  84       {
  85         calcMan.workerComplete(this);
  86         return;
  87       }
  88
  89       eraseConsensus(aWidth);
  90       computeConsensus(alignment);
  91       updateResultAnnotation(true);
  92
  93       if (ap != null)
  94       {
  95         ap.paintAlignment(true);
  96       }
  97     } catch (OutOfMemoryError error)
  98     {
  99       calcMan.disableWorker(this);
 100       ap.raiseOOMWarning("calculating consensus", error);
 101     } finally
 102     {
 103       /*
 104        * e.g. ArrayIndexOutOfBoundsException can happen due to a race condition
 105        * - alignment was edited at same time as calculation was running
 106        */
 107       calcMan.workerComplete(this);
 108     }
 109   }
 110
 111   /**
 112    * Clear out any existing consensus annotations
 113    *
 114    * @param aWidth
 115    *          the width (number of columns) of the annotated alignment
 116    */
 117   protected void eraseConsensus(int aWidth)
 118   {
 119     AlignmentAnnotation consensus = getConsensusAnnotation();
 120     consensus.annotations = new Annotation[aWidth];
 121     AlignmentAnnotation gap = getGapAnnotation();
 122     if (gap != null)
 123     {
 124       gap.annotations = new Annotation[aWidth];
 125     }
 126   }
 127
 128   /**
 129    * @param alignment
 130    */
 131   protected void computeConsensus(AlignmentI alignment)
 132   {
 133
 134     SequenceI[] aseqs = getSequences();
 135     int width = alignment.getWidth();
 136     ProfilesI hconsensus = AAFrequency.calculate(aseqs, width, 0, width,
 137             true);
 138
 139     alignViewport.setSequenceConsensusHash(hconsensus);
 140     setColourSchemeConsensus(hconsensus);
 141   }
 142
 143   /**
 144    * @return
 145    */
 146   protected SequenceI[] getSequences()
 147   {
 148     return alignViewport.getAlignment().getSequencesArray();
 149   }
 150
 151   /**
 152    * @param hconsensus
 153    */
 154   protected void setColourSchemeConsensus(ProfilesI hconsensus)
 155   {
 156     ColourSchemeI globalColourScheme = alignViewport
 157             .getGlobalColourScheme();
 158     if (globalColourScheme != null)
 159     {
 160       globalColourScheme.setConsensus(hconsensus);
 161     }
 162   }
 163
 164   /**
 165    * Get the Consensus annotation for the alignment
 166    *
 167    * @return
 168    */
 169   protected AlignmentAnnotation getConsensusAnnotation()
 170   {
 171     return alignViewport.getAlignmentConsensusAnnotation();
 172   }
 173
 174   /**
 175    * Get the Gap annotation for the alignment
 176    *
 177    * @return
 178    */
 179   protected AlignmentAnnotation getGapAnnotation()
 180   {
 181     return alignViewport.getAlignmentGapAnnotation();
 182   }
 183
 184   /**
 185    * update the consensus annotation from the sequence profile data using
 186    * current visualization settings.
 187    */
 188   @Override
 189   public void updateAnnotation()
 190   {
 191     updateResultAnnotation(false);
 192   }
 193
 194   public void updateResultAnnotation(boolean immediate)
 195   {
 196     AlignmentAnnotation consensus = getConsensusAnnotation();
 197     ProfilesI hconsensus = (ProfilesI) getViewportConsensus();
 198     if (immediate || !calcMan.isWorking(this) && consensus != null
 199             && hconsensus != null)
 200     {
 201       deriveConsensus(consensus, hconsensus);
 202       AlignmentAnnotation gap = getGapAnnotation();
 203       if (gap != null)
 204       {
 205         deriveGap(gap, hconsensus);
 206       }
 207     }
 208   }
 209
 210   /**
 211    * Convert the computed consensus data into the desired annotation for
 212    * display.
 213    *
 214    * @param consensusAnnotation
 215    *          the annotation to be populated
 216    * @param hconsensus
 217    *          the computed consensus data
 218    */
 219   protected void deriveConsensus(AlignmentAnnotation consensusAnnotation,
 220           ProfilesI hconsensus)
 221   {
 222
 223     long nseq = getSequences().length;
 224     AAFrequency.completeConsensus(consensusAnnotation, hconsensus,
 225             hconsensus.getStartColumn(), hconsensus.getEndColumn() + 1,
 226             alignViewport.isIgnoreGapsConsensus(),
 227             alignViewport.isShowSequenceLogo(), nseq);
 228   }
 229
 230   /**
 231    * Convert the computed consensus data into a gap annotation row for display.
 232    *
 233    * @param gapAnnotation
 234    *          the annotation to be populated
 235    * @param hconsensus
 236    *          the computed consensus data
 237    */
 238   protected void deriveGap(AlignmentAnnotation gapAnnotation,
 239           ProfilesI hconsensus)
 240   {
 241     long nseq = getSequences().length;
 242     AAFrequency.completeGapAnnot(gapAnnotation, hconsensus,
 243             hconsensus.getStartColumn(), hconsensus.getEndColumn() + 1,
 244             nseq);
 245   }
 246
 247   /**
 248    * Get the consensus data stored on the viewport.
 249    *
 250    * @return
 251    */
 252   protected Object getViewportConsensus()
 253   {
 254     // TODO convert ComplementConsensusThread to use Profile
 255     return alignViewport.getSequenceConsensusHash();
 256   }
 257 }