3cb6114dc2bbc99af900b9f111a953c8133bae6f
[jalview.git] / src / jalview / workers / StrucConsensusThread.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.StructureFrequency;
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.SequenceI;
30
31 import java.util.Hashtable;
32
33 public class StrucConsensusThread extends AlignCalcWorker
34 {
35   public StrucConsensusThread(AlignViewportI alignViewport,
36           AlignmentViewPanel alignPanel)
37   {
38     super(alignViewport, alignPanel);
39   }
40
41   AlignmentAnnotation strucConsensus;
42
43   Hashtable[] hStrucConsensus;
44
45   private long nseq = -1;
46
47   @Override
48   public void run()
49   {
50       if (alignViewport.isClosed())
51       {
52         abortAndDestroy();
53         return;
54       }
55       AlignmentI alignment = alignViewport.getAlignment();
56
57       int aWidth = -1;
58
59       if (alignment == null || (aWidth = alignment.getWidth()) < 0)
60       {
61         return;
62       }
63       strucConsensus = alignViewport.getAlignmentStrucConsensusAnnotation();
64       hStrucConsensus = alignViewport.getRnaStructureConsensusHash();
65       strucConsensus.annotations = null;
66       strucConsensus.annotations = new Annotation[aWidth];
67
68       hStrucConsensus = new Hashtable[aWidth];
69
70       AlignmentAnnotation[] aa = alignViewport.getAlignment()
71               .getAlignmentAnnotation();
72       AlignmentAnnotation rnaStruc = null;
73       // select rna struct to use for calculation
74       if (aa != null)
75       {
76         for (int i = 0; i < aa.length; i++)
77         {
78           if (aa[i].visible && aa[i].isRNA() && aa[i].isValidStruc())
79           {
80             rnaStruc = aa[i];
81             break;
82           }
83         }
84       }
85       // check to see if its valid
86
87       if (rnaStruc == null || !rnaStruc.isValidStruc())
88       {
89         return;
90       }
91
92       try
93       {
94         final SequenceI[] arr = alignment.getSequencesArray();
95         nseq = arr.length;
96         jalview.analysis.StructureFrequency.calculate(arr, 0,
97                 alignment.getWidth(), hStrucConsensus, true, rnaStruc);
98       } catch (ArrayIndexOutOfBoundsException x)
99       {
100         return;
101       }
102       alignViewport.setRnaStructureConsensusHash(hStrucConsensus);
103       // TODO AlignmentAnnotation rnaStruc!!!
104       updateResultAnnotation(true);
105
106   }
107
108   /**
109    * update the consensus annotation from the sequence profile data using
110    * current visualization settings.
111    */
112   @Override
113   public void updateAnnotation()
114   {
115     updateResultAnnotation(false);
116   }
117
118   public void updateResultAnnotation(boolean immediate)
119   {
120     if (immediate || !calcMan.isWorking(this) && strucConsensus != null
121             && hStrucConsensus != null)
122     {
123       StructureFrequency.completeConsensus(strucConsensus, hStrucConsensus,
124               0, hStrucConsensus.length,
125               alignViewport.isIgnoreGapsConsensus(),
126               alignViewport.isShowSequenceLogo(), nseq);
127     }
128   }
129
130 }