update author list in license for (JAL-826)
[jalview.git] / src / jalview / appletgui / PCAPanel.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
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 of the License, or (at your option) any later version.
10  * 
11  * Jalview is distributed in the hope that it will be useful, but 
12  * WITHOUT ANY WARRANTY; without even the implied warranty 
13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14  * PURPOSE.  See the GNU General Public License for more details.
15  * 
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17  */
18 package jalview.appletgui;
19
20 import java.util.*;
21
22 import java.awt.*;
23 import java.awt.event.*;
24
25 import jalview.analysis.*;
26 import jalview.datamodel.*;
27
28 public class PCAPanel extends EmbmenuFrame implements Runnable,
29         ActionListener, ItemListener
30 {
31   PCA pca;
32
33   int top;
34
35   RotatableCanvas rc;
36
37   AlignViewport av;
38
39   SequenceI[] seqs;
40
41   AlignmentView seqstrings;
42
43   public PCAPanel(AlignViewport av)
44   {
45     try
46     {
47       jbInit();
48     } catch (Exception e)
49     {
50       e.printStackTrace();
51     }
52
53     for (int i = 1; i < 8; i++)
54     {
55       xCombobox.addItem("dim " + i);
56       yCombobox.addItem("dim " + i);
57       zCombobox.addItem("dim " + i);
58     }
59
60     this.av = av;
61     seqstrings = av.getAlignmentView(av.getSelectionGroup() != null);
62     if (av.getSelectionGroup() == null)
63     {
64       seqs = av.alignment.getSequencesArray();
65     }
66     else
67     {
68       seqs = av.getSelectionGroup().getSequencesInOrder(av.alignment);
69     }
70     SeqCigar sq[] = seqstrings.getSequences();
71     int length = sq[0].getWidth();
72
73     for (int i = 0; i < seqs.length; i++)
74     {
75       if (sq[i].getWidth() != length)
76       {
77         System.out
78                 .println("Sequences must be equal length for PCA analysis");
79         return;
80       }
81     }
82
83     rc = new RotatableCanvas(av);
84     embedMenuIfNeeded(rc);
85     add(rc, BorderLayout.CENTER);
86
87     jalview.bin.JalviewLite.addFrame(this, "Principal component analysis",
88             400, 400);
89
90     Thread worker = new Thread(this);
91     worker.start();
92   }
93
94   /**
95    * DOCUMENT ME!
96    */
97   public void run()
98   {
99     pca = new PCA(seqstrings.getSequenceStrings(' '));
100     pca.run();
101
102     // Now find the component coordinates
103     int ii = 0;
104
105     while ((ii < seqs.length) && (seqs[ii] != null))
106     {
107       ii++;
108     }
109
110     double[][] comps = new double[ii][ii];
111
112     for (int i = 0; i < ii; i++)
113     {
114       if (pca.getEigenvalue(i) > 1e-4)
115       {
116         comps[i] = pca.component(i);
117       }
118     }
119
120     // ////////////////
121     xCombobox.select(0);
122     yCombobox.select(1);
123     zCombobox.select(2);
124
125     top = pca.getM().rows - 1;
126
127     Vector points = new Vector();
128     float[][] scores = pca.getComponents(top - 1, top - 2, top - 3, 100);
129
130     for (int i = 0; i < pca.getM().rows; i++)
131     {
132       SequencePoint sp = new SequencePoint(seqs[i], scores[i]);
133       points.addElement(sp);
134     }
135
136     rc.setPoints(points, pca.getM().rows);
137     rc.repaint();
138     seqs = null;
139     this.repaint();
140   }
141
142   void doDimensionChange()
143   {
144     if (top == 0)
145     {
146       return;
147     }
148
149     int dim1 = top - xCombobox.getSelectedIndex();
150     int dim2 = top - yCombobox.getSelectedIndex();
151     int dim3 = top - zCombobox.getSelectedIndex();
152
153     float[][] scores = pca.getComponents(dim1, dim2, dim3, 100);
154     for (int i = 0; i < pca.getM().rows; i++)
155     {
156       ((SequencePoint) rc.points.elementAt(i)).coord = scores[i];
157     }
158
159     rc.img = null;
160     rc.rotmat.setIdentity();
161     rc.initAxes();
162     rc.paint(rc.getGraphics());
163   }
164
165   public void actionPerformed(ActionEvent evt)
166   {
167     if (evt.getSource() == inputData)
168     {
169       showOriginalData();
170     }
171     else
172     {
173       values_actionPerformed();
174     }
175   }
176
177   public void itemStateChanged(ItemEvent evt)
178   {
179     if (evt.getSource() == xCombobox)
180     {
181       xCombobox_actionPerformed();
182     }
183     else if (evt.getSource() == yCombobox)
184     {
185       yCombobox_actionPerformed();
186     }
187     else if (evt.getSource() == zCombobox)
188     {
189       zCombobox_actionPerformed();
190     }
191   }
192
193   protected void xCombobox_actionPerformed()
194   {
195     doDimensionChange();
196   }
197
198   protected void yCombobox_actionPerformed()
199   {
200     doDimensionChange();
201   }
202
203   protected void zCombobox_actionPerformed()
204   {
205     doDimensionChange();
206   }
207
208   public void values_actionPerformed()
209   {
210
211     CutAndPasteTransfer cap = new CutAndPasteTransfer(false, null);
212     Frame frame = new Frame();
213     frame.add(cap);
214     jalview.bin.JalviewLite.addFrame(frame, "PCA details", 500, 500);
215
216     cap.setText(pca.getDetails());
217   }
218
219   void showOriginalData()
220   {
221     // decide if av alignment is sufficiently different to original data to
222     // warrant a new window to be created
223     // create new alignmnt window with hidden regions (unhiding hidden regions
224     // yields unaligned seqs)
225     // or create a selection box around columns in alignment view
226     // test Alignment(SeqCigar[])
227     char gc = '-';
228     try
229     {
230       // we try to get the associated view's gap character
231       // but this may fail if the view was closed...
232       gc = av.getGapCharacter();
233     } catch (Exception ex)
234     {
235     }
236     ;
237     Object[] alAndColsel = seqstrings.getAlignmentAndColumnSelection(gc);
238
239     if (alAndColsel != null && alAndColsel[0] != null)
240     {
241       Alignment al = new Alignment((SequenceI[]) alAndColsel[0]);
242       AlignFrame af = new AlignFrame(al, av.applet,
243               "Original Data for PCA", false);
244
245       af.viewport.setHiddenColumns((ColumnSelection) alAndColsel[1]);
246     }
247   }
248
249   public void labels_itemStateChanged(ItemEvent itemEvent)
250   {
251     rc.showLabels(labels.getState());
252   }
253
254   Panel jPanel2 = new Panel();
255
256   Label jLabel1 = new Label();
257
258   Label jLabel2 = new Label();
259
260   Label jLabel3 = new Label();
261
262   protected Choice xCombobox = new Choice();
263
264   protected Choice yCombobox = new Choice();
265
266   protected Choice zCombobox = new Choice();
267
268   FlowLayout flowLayout1 = new FlowLayout();
269
270   BorderLayout borderLayout1 = new BorderLayout();
271
272   MenuBar menuBar1 = new MenuBar();
273
274   Menu menu1 = new Menu();
275
276   Menu menu2 = new Menu();
277
278   protected CheckboxMenuItem labels = new CheckboxMenuItem();
279
280   MenuItem values = new MenuItem();
281
282   MenuItem inputData = new MenuItem();
283
284   private void jbInit() throws Exception
285   {
286     this.setLayout(borderLayout1);
287     jPanel2.setLayout(flowLayout1);
288     jLabel1.setFont(new java.awt.Font("Verdana", 0, 12));
289     jLabel1.setText("x=");
290     jLabel2.setFont(new java.awt.Font("Verdana", 0, 12));
291     jLabel2.setText("y=");
292     jLabel3.setFont(new java.awt.Font("Verdana", 0, 12));
293     jLabel3.setText("z=");
294     jPanel2.setBackground(Color.white);
295     zCombobox.setFont(new java.awt.Font("Verdana", 0, 12));
296     zCombobox.addItemListener(this);
297     yCombobox.setFont(new java.awt.Font("Verdana", 0, 12));
298     yCombobox.addItemListener(this);
299     xCombobox.setFont(new java.awt.Font("Verdana", 0, 12));
300     xCombobox.addItemListener(this);
301     this.setMenuBar(menuBar1);
302     menu1.setLabel("File");
303     menu2.setLabel("View");
304     labels.setLabel("Labels");
305     labels.addItemListener(this);
306     values.setLabel("Output Values...");
307     values.addActionListener(this);
308     inputData.setLabel("Input Data...");
309     this.add(jPanel2, BorderLayout.SOUTH);
310     jPanel2.add(jLabel1, null);
311     jPanel2.add(xCombobox, null);
312     jPanel2.add(jLabel2, null);
313     jPanel2.add(yCombobox, null);
314     jPanel2.add(jLabel3, null);
315     jPanel2.add(zCombobox, null);
316     menuBar1.add(menu1);
317     menuBar1.add(menu2);
318     menu2.add(labels);
319     menu1.add(values);
320     menu1.add(inputData);
321     inputData.addActionListener(this);
322   }
323
324 }