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