src/jalview/appletgui/PCAPanel.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.appletgui;
  22
  23 import jalview.bin.JalviewLite;
  24 import jalview.datamodel.Alignment;
  25 import jalview.datamodel.AlignmentView;
  26 import jalview.datamodel.ColumnSelection;
  27 import jalview.datamodel.SeqCigar;
  28 import jalview.datamodel.SequenceI;
  29 import jalview.util.MessageManager;
  30 import jalview.viewmodel.PCAModel;
  31
  32 import java.awt.BorderLayout;
  33 import awt2swing.Button;
  34 import awt2swing.CheckboxMenuItem;
  35 import awt2swing.Choice;
  36 import java.awt.Color;
  37 import java.awt.FlowLayout;
  38 import awt2swing.Frame;
  39 import awt2swing.Label;
  40 import awt2swing.Menu;
  41 import awt2swing.MenuBar;
  42 import awt2swing.MenuItem;
  43 import awt2swing.Panel;
  44 import java.awt.event.ActionEvent;
  45 import java.awt.event.ActionListener;
  46 import java.awt.event.ItemEvent;
  47 import java.awt.event.ItemListener;
  48
  49 public class PCAPanel extends EmbmenuFrame implements Runnable,
  50         ActionListener, ItemListener
  51 {
  52   RotatableCanvas rc;
  53
  54   AlignViewport av;
  55
  56   PCAModel pcaModel;
  57
  58   int top = 0;
  59
  60   public PCAPanel(AlignViewport av)
  61   {
  62     try
  63     {
  64       jbInit();
  65     } catch (Exception e)
  66     {
  67       e.printStackTrace();
  68     }
  69
  70     for (int i = 1; i < 8; i++)
  71     {
  72       xCombobox.addItem("dim " + i);
  73       yCombobox.addItem("dim " + i);
  74       zCombobox.addItem("dim " + i);
  75     }
  76
  77     this.av = av;
  78     boolean selected = av.getSelectionGroup() != null
  79             && av.getSelectionGroup().getSize() > 0;
  80     AlignmentView seqstrings = av.getAlignmentView(selected);
  81     boolean nucleotide = av.getAlignment().isNucleotide();
  82     SequenceI[] seqs;
  83     if (!selected)
  84     {
  85       seqs = av.getAlignment().getSequencesArray();
  86     }
  87     else
  88     {
  89       seqs = av.getSelectionGroup().getSequencesInOrder(av.getAlignment());
  90     }
  91     SeqCigar sq[] = seqstrings.getSequences();
  92     int length = sq[0].getWidth();
  93
  94     for (int i = 0; i < seqs.length; i++)
  95     {
  96       if (sq[i].getWidth() != length)
  97       {
  98         System.out
  99                 .println("Sequences must be equal length for PCA analysis");
 100         return;
 101       }
 102     }
 103     pcaModel = new PCAModel(seqstrings, seqs, nucleotide);
 104
 105     rc = new RotatableCanvas(av);
 106     embedMenuIfNeeded(rc);
 107     add(rc, BorderLayout.CENTER);
 108
 109     JalviewLite.addFrame(this,
 110             MessageManager.getString("label.principal_component_analysis"),
 111             475, 400);
 112
 113     Thread worker = new Thread(this);
 114     worker.start();
 115   }
 116
 117   /**
 118    * DOCUMENT ME!
 119    */
 120   public void run()
 121   {
 122     // TODO progress indicator
 123     calcSettings.setEnabled(false);
 124     rc.setEnabled(false);
 125     try
 126     {
 127       nuclSetting.setState(pcaModel.isNucleotide());
 128       protSetting.setState(!pcaModel.isNucleotide());
 129       pcaModel.run();
 130       // ////////////////
 131       xCombobox.select(0);
 132       yCombobox.select(1);
 133       zCombobox.select(2);
 134
 135       pcaModel.updateRc(rc);
 136       // rc.invalidate();
 137       top = pcaModel.getTop();
 138     } catch (OutOfMemoryError x)
 139     {
 140       System.err.println("Out of memory when calculating PCA.");
 141       return;
 142     }
 143     calcSettings.setEnabled(true);
 144
 145     // TODO revert progress indicator
 146     rc.setEnabled(true);
 147     rc.repaint();
 148     this.repaint();
 149   }
 150
 151   void doDimensionChange()
 152   {
 153     if (top == 0)
 154     {
 155       return;
 156     }
 157
 158     int dim1 = top - xCombobox.getSelectedIndex();
 159     int dim2 = top - yCombobox.getSelectedIndex();
 160     int dim3 = top - zCombobox.getSelectedIndex();
 161     pcaModel.updateRcView(dim1, dim2, dim3);
 162     rc.img = null;
 163     rc.rotmat.setIdentity();
 164     rc.initAxes();
 165     rc.paint(rc.getGraphics());
 166   }
 167
 168   public void actionPerformed(ActionEvent evt)
 169   {
 170     if (evt.getSource() == inputData)
 171     {
 172       showOriginalData();
 173     }
 174     if (evt.getSource() == resetButton)
 175     {
 176       xCombobox.select(0);
 177       yCombobox.select(1);
 178       zCombobox.select(2);
 179       doDimensionChange();
 180     }
 181     if (evt.getSource() == values)
 182     {
 183       values_actionPerformed();
 184     }
 185   }
 186
 187   public void itemStateChanged(ItemEvent evt)
 188   {
 189     if (evt.getSource() == xCombobox)
 190     {
 191       xCombobox_actionPerformed();
 192     }
 193     else if (evt.getSource() == yCombobox)
 194     {
 195       yCombobox_actionPerformed();
 196     }
 197     else if (evt.getSource() == zCombobox)
 198     {
 199       zCombobox_actionPerformed();
 200     }
 201     else if (evt.getSource() == labels)
 202     {
 203       labels_itemStateChanged(evt);
 204     }
 205     else if (evt.getSource() == nuclSetting)
 206     {
 207       if (!pcaModel.isNucleotide())
 208       {
 209         pcaModel.setNucleotide(true);
 210         new Thread(this).start();
 211       }
 212     }
 213     else if (evt.getSource() == protSetting)
 214     {
 215       if (pcaModel.isNucleotide())
 216       {
 217         pcaModel.setNucleotide(false);
 218         new Thread(this).start();
 219       }
 220     }
 221   }
 222
 223   protected void xCombobox_actionPerformed()
 224   {
 225     doDimensionChange();
 226   }
 227
 228   protected void yCombobox_actionPerformed()
 229   {
 230     doDimensionChange();
 231   }
 232
 233   protected void zCombobox_actionPerformed()
 234   {
 235     doDimensionChange();
 236   }
 237
 238   public void values_actionPerformed()
 239   {
 240
 241     CutAndPasteTransfer cap = new CutAndPasteTransfer(false, null);
 242     Frame frame = new Frame();
 243     frame.add(cap);
 244     JalviewLite.addFrame(frame,
 245             MessageManager.getString("label.pca_details"), 500, 500);
 246
 247     cap.setText(pcaModel.getDetails());
 248   }
 249
 250   void showOriginalData()
 251   {
 252     // decide if av alignment is sufficiently different to original data to
 253     // warrant a new window to be created
 254     // create new alignmnt window with hidden regions (unhiding hidden regions
 255     // yields unaligned seqs)
 256     // or create a selection box around columns in alignment view
 257     // test Alignment(SeqCigar[])
 258     char gc = '-';
 259     try
 260     {
 261       // we try to get the associated view's gap character
 262       // but this may fail if the view was closed...
 263       gc = av.getGapCharacter();
 264     } catch (Exception ex)
 265     {
 266     }
 267     ;
 268     Object[] alAndColsel = pcaModel.getSeqtrings()
 269             .getAlignmentAndColumnSelection(gc);
 270
 271     if (alAndColsel != null && alAndColsel[0] != null)
 272     {
 273       Alignment al = new Alignment((SequenceI[]) alAndColsel[0]);
 274       AlignFrame af = new AlignFrame(al, av.applet,
 275               "Original Data for PCA", false);
 276
 277       af.viewport.setHiddenColumns((ColumnSelection) alAndColsel[1]);
 278     }
 279   }
 280
 281   public void labels_itemStateChanged(ItemEvent itemEvent)
 282   {
 283     rc.showLabels(labels.getState());
 284   }
 285
 286   Panel jPanel2 = new Panel();
 287
 288   Label jLabel1 = new Label();
 289
 290   Label jLabel2 = new Label();
 291
 292   Label jLabel3 = new Label();
 293
 294   protected Choice xCombobox = new Choice();
 295
 296   protected Choice yCombobox = new Choice();
 297
 298   protected Choice zCombobox = new Choice();
 299
 300   protected Button resetButton = new Button();
 301
 302   FlowLayout flowLayout1 = new FlowLayout();
 303
 304   BorderLayout borderLayout1 = new BorderLayout();
 305
 306   MenuBar menuBar1 = new MenuBar();
 307
 308   Menu menu1 = new Menu();
 309
 310   Menu menu2 = new Menu();
 311
 312   Menu calcSettings = new Menu();
 313
 314   protected CheckboxMenuItem labels = new CheckboxMenuItem();
 315
 316   protected CheckboxMenuItem protSetting = new CheckboxMenuItem();
 317
 318   protected CheckboxMenuItem nuclSetting = new CheckboxMenuItem();
 319
 320   MenuItem values = new MenuItem();
 321
 322   MenuItem inputData = new MenuItem();
 323
 324   private void jbInit() throws Exception
 325   {
 326     this.setLayout(borderLayout1);
 327     jPanel2.setLayout(flowLayout1);
 328     jLabel1.setFont(new java.awt.Font("Verdana", 0, 12));
 329     jLabel1.setText("x=");
 330     jLabel2.setFont(new java.awt.Font("Verdana", 0, 12));
 331     jLabel2.setText("y=");
 332     jLabel3.setFont(new java.awt.Font("Verdana", 0, 12));
 333     jLabel3.setText("z=");
 334     jPanel2.setBackground(Color.white);
 335     zCombobox.setFont(new java.awt.Font("Verdana", 0, 12));
 336     zCombobox.addItemListener(this);
 337     yCombobox.setFont(new java.awt.Font("Verdana", 0, 12));
 338     yCombobox.addItemListener(this);
 339     xCombobox.setFont(new java.awt.Font("Verdana", 0, 12));
 340     xCombobox.addItemListener(this);
 341     resetButton.setFont(new java.awt.Font("Verdana", 0, 12));
 342     resetButton.setLabel(MessageManager.getString("action.reset"));
 343     resetButton.addActionListener(this);
 344     this.setMenuBar(menuBar1);
 345     menu1.setLabel(MessageManager.getString("action.file"));
 346     menu2.setLabel(MessageManager.getString("action.view"));
 347     calcSettings.setLabel(MessageManager.getString("action.change_params"));
 348     labels.setLabel(MessageManager.getString("label.labels"));
 349     labels.addItemListener(this);
 350     values.setLabel(MessageManager.getString("label.output_values"));
 351     values.addActionListener(this);
 352     inputData.setLabel(MessageManager.getString("label.input_data"));
 353     nuclSetting.setLabel(MessageManager
 354             .getString("label.nucleotide_matrix"));
 355     nuclSetting.addItemListener(this);
 356     protSetting.setLabel(MessageManager.getString("label.protein_matrix"));
 357     protSetting.addItemListener(this);
 358     this.add(jPanel2, BorderLayout.SOUTH);
 359     jPanel2.add(jLabel1, null);
 360     jPanel2.add(xCombobox, null);
 361     jPanel2.add(jLabel2, null);
 362     jPanel2.add(yCombobox, null);
 363     jPanel2.add(jLabel3, null);
 364     jPanel2.add(zCombobox, null);
 365     jPanel2.add(resetButton, null);
 366     menuBar1.add(menu1);
 367     menuBar1.add(menu2);
 368     menuBar1.add(calcSettings);
 369     menu2.add(labels);
 370     menu1.add(values);
 371     menu1.add(inputData);
 372     calcSettings.add(nuclSetting);
 373     calcSettings.add(protSetting);
 374     inputData.addActionListener(this);
 375   }
 376
 377 }