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