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