src/jalview/gui/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.gui;
  22
  23 import jalview.analysis.scoremodels.ScoreModels;
  24 import jalview.api.analysis.ScoreModelI;
  25 import jalview.api.analysis.SimilarityParamsI;
  26 import jalview.datamodel.Alignment;
  27 import jalview.datamodel.AlignmentI;
  28 import jalview.datamodel.AlignmentView;
  29 import jalview.datamodel.HiddenColumns;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.jbgui.GPCAPanel;
  32 import jalview.util.ImageMaker;
  33 import jalview.util.MessageManager;
  34 import jalview.viewmodel.AlignmentViewport;
  35 import jalview.viewmodel.PCAModel;
  36
  37 import java.awt.BorderLayout;
  38 import java.awt.Color;
  39 import java.awt.Dimension;
  40 import java.awt.Graphics;
  41 import java.awt.event.ActionEvent;
  42 import java.awt.event.ActionListener;
  43 import java.awt.print.PageFormat;
  44 import java.awt.print.Printable;
  45 import java.awt.print.PrinterException;
  46 import java.awt.print.PrinterJob;
  47
  48 import javax.swing.ButtonGroup;
  49 import javax.swing.JColorChooser;
  50 import javax.swing.JMenuItem;
  51 import javax.swing.JRadioButtonMenuItem;
  52 import javax.swing.event.InternalFrameAdapter;
  53 import javax.swing.event.InternalFrameEvent;
  54
  55 /**
  56  * The panel holding the Principal Component Analysis 3-d visualisation
  57  */
  58 public class PCAPanel extends GPCAPanel
  59         implements Runnable, IProgressIndicator
  60 {
  61   RotatableCanvas rc;
  62
  63   AlignmentPanel ap;
  64
  65   AlignmentViewport av;
  66
  67   PCAModel pcaModel;
  68
  69   int top = 0;
  70
  71   private static final int MIN_WIDTH = 470;
  72
  73   private static final int MIN_HEIGHT = 250;
  74
  75   private IProgressIndicator progressBar;
  76
  77   private boolean working;
  78
  79   /**
  80    * Constructor given sequence data, a similarity (or distance) score model
  81    * name, and score calculation parameters
  82    *
  83    * @param alignPanel
  84    * @param modelName
  85    * @param params
  86    */
  87   public PCAPanel(AlignmentPanel alignPanel, String modelName,
  88           SimilarityParamsI params)
  89   {
  90     super();
  91     this.av = alignPanel.av;
  92     this.ap = alignPanel;
  93     boolean nucleotide = av.getAlignment().isNucleotide();
  94
  95     progressBar = new ProgressBar(statusPanel, statusBar);
  96
  97     addInternalFrameListener(new InternalFrameAdapter()
  98     {
  99       @Override
 100       public void internalFrameClosed(InternalFrameEvent e)
 101       {
 102         close_actionPerformed();
 103       }
 104     });
 105
 106     boolean selected = av.getSelectionGroup() != null
 107             && av.getSelectionGroup().getSize() > 0;
 108     AlignmentView seqstrings = av.getAlignmentView(selected);
 109     SequenceI[] seqs;
 110     if (!selected)
 111     {
 112       seqs = av.getAlignment().getSequencesArray();
 113     }
 114     else
 115     {
 116       seqs = av.getSelectionGroup().getSequencesInOrder(av.getAlignment());
 117     }
 118
 119     ScoreModelI scoreModel = ScoreModels.getInstance()
 120             .getScoreModel(modelName, ap);
 121     pcaModel = new PCAModel(seqstrings, seqs, nucleotide, scoreModel,
 122             params);
 123     PaintRefresher.Register(this, av.getSequenceSetId());
 124
 125     rc = new RotatableCanvas(alignPanel);
 126     this.getContentPane().add(rc, BorderLayout.CENTER);
 127
 128     /*
 129      * perform calculation in a new Thread
 130      */
 131     Thread worker = new Thread(this);
 132     worker.start();
 133   }
 134
 135   /**
 136    * Ensure references to potentially very large objects (the PCA matrices) are
 137    * nulled when the frame is closed
 138    */
 139   protected void close_actionPerformed()
 140   {
 141     pcaModel = null;
 142   }
 143
 144   @Override
 145   protected void bgcolour_actionPerformed()
 146   {
 147     Color col = JColorChooser.showDialog(this,
 148             MessageManager.getString("label.select_background_colour"),
 149             rc.bgColour);
 150
 151     if (col != null)
 152     {
 153       rc.bgColour = col;
 154     }
 155     rc.repaint();
 156   }
 157
 158   /**
 159    * Calculates the PCA and displays the results
 160    */
 161   @Override
 162   public void run()
 163   {
 164     long progId = System.currentTimeMillis();
 165     IProgressIndicator progress = this;
 166     String message = MessageManager.getString("label.pca_recalculating");
 167     if (getParent() == null)
 168     {
 169       progress = ap.alignFrame;
 170       message = MessageManager.getString("label.pca_calculating");
 171     }
 172     progress.setProgressBar(message, progId);
 173     working = true;
 174     try
 175     {
 176       pcaModel.calculate();
 177       // ////////////////
 178       xCombobox.setSelectedIndex(0);
 179       yCombobox.setSelectedIndex(1);
 180       zCombobox.setSelectedIndex(2);
 181
 182       pcaModel.updateRc(rc);
 183       // rc.invalidate();
 184       top = pcaModel.getTop();
 185
 186     } catch (OutOfMemoryError er)
 187     {
 188       new OOMWarning("calculating PCA", er);
 189       working = false;
 190       return;
 191     } finally
 192     {
 193       progress.setProgressBar("", progId);
 194     }
 195
 196     repaint();
 197     if (getParent() == null)
 198     {
 199       addKeyListener(rc);
 200       Desktop.addInternalFrame(this,
 201               MessageManager.formatMessage("label.calc_title", "PCA",
 202                       pcaModel.getScoreModelName()),
 203               475, 450);
 204       this.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
 205     }
 206     working = false;
 207   }
 208
 209   /**
 210    * Updates the PCA display after a change of component to use for x, y or z
 211    * axis
 212    */
 213   @Override
 214   protected void doDimensionChange()
 215   {
 216     if (top == 0)
 217     {
 218       return;
 219     }
 220
 221     int dim1 = top - xCombobox.getSelectedIndex();
 222     int dim2 = top - yCombobox.getSelectedIndex();
 223     int dim3 = top - zCombobox.getSelectedIndex();
 224     pcaModel.updateRcView(dim1, dim2, dim3);
 225     rc.resetView();
 226     rc.paint(rc.getGraphics());
 227   }
 228
 229   @Override
 230   protected void outputValues_actionPerformed()
 231   {
 232     CutAndPasteTransfer cap = new CutAndPasteTransfer();
 233     try
 234     {
 235       cap.setText(pcaModel.getDetails());
 236       Desktop.addInternalFrame(cap,
 237               MessageManager.getString("label.pca_details"), 500, 500);
 238     } catch (OutOfMemoryError oom)
 239     {
 240       new OOMWarning("opening PCA details", oom);
 241       cap.dispose();
 242     }
 243   }
 244
 245   @Override
 246   protected void showLabels_actionPerformed()
 247   {
 248     rc.showLabels(showLabels.getState());
 249   }
 250
 251   @Override
 252   protected void print_actionPerformed()
 253   {
 254     PCAPrinter printer = new PCAPrinter();
 255     printer.start();
 256   }
 257
 258   @Override
 259   public void originalSeqData_actionPerformed()
 260   {
 261     // this was cut'n'pasted from the equivalent TreePanel method - we should
 262     // make this an abstract function of all jalview analysis windows
 263     if (pcaModel.getSeqtrings() == null)
 264     {
 265       jalview.bin.Cache.log.info(
 266               "Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
 267       return;
 268     }
 269     // decide if av alignment is sufficiently different to original data to
 270     // warrant a new window to be created
 271     // create new alignmnt window with hidden regions (unhiding hidden regions
 272     // yields unaligned seqs)
 273     // or create a selection box around columns in alignment view
 274     // test Alignment(SeqCigar[])
 275     char gc = '-';
 276     try
 277     {
 278       // we try to get the associated view's gap character
 279       // but this may fail if the view was closed...
 280       gc = av.getGapCharacter();
 281     } catch (Exception ex)
 282     {
 283     }
 284
 285     Object[] alAndColsel = pcaModel.getSeqtrings()
 286             .getAlignmentAndHiddenColumns(gc);
 287
 288     if (alAndColsel != null && alAndColsel[0] != null)
 289     {
 290       // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
 291
 292       AlignmentI al = new Alignment((SequenceI[]) alAndColsel[0]);
 293       AlignmentI dataset = (av != null && av.getAlignment() != null)
 294               ? av.getAlignment().getDataset()
 295               : null;
 296       if (dataset != null)
 297       {
 298         al.setDataset(dataset);
 299       }
 300
 301       if (true)
 302       {
 303         // make a new frame!
 304         AlignFrame af = new AlignFrame(al, (HiddenColumns) alAndColsel[1],
 305                 AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 306
 307         // >>>This is a fix for the moment, until a better solution is
 308         // found!!<<<
 309         // af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());
 310
 311         // af.addSortByOrderMenuItem(ServiceName + " Ordering",
 312         // msaorder);
 313
 314         Desktop.addInternalFrame(af, MessageManager.formatMessage(
 315                 "label.original_data_for_params", new String[]
 316                 { this.title }), AlignFrame.DEFAULT_WIDTH,
 317                 AlignFrame.DEFAULT_HEIGHT);
 318       }
 319     }
 320     /*
 321      * CutAndPasteTransfer cap = new CutAndPasteTransfer(); for (int i = 0; i <
 322      * seqs.length; i++) { cap.appendText(new jalview.util.Format("%-" + 15 +
 323      * "s").form( seqs[i].getName())); cap.appendText(" " + seqstrings[i] +
 324      * "\n"); }
 325      *
 326      * Desktop.addInternalFrame(cap, "Original Data", 400, 400);
 327      */
 328   }
 329
 330   class PCAPrinter extends Thread implements Printable
 331   {
 332     @Override
 333     public void run()
 334     {
 335       PrinterJob printJob = PrinterJob.getPrinterJob();
 336       PageFormat defaultPage = printJob.defaultPage();
 337       PageFormat pf = printJob.pageDialog(defaultPage);
 338
 339       if (defaultPage == pf)
 340       {
 341         /*
 342          * user cancelled
 343          */
 344         return;
 345       }
 346
 347       printJob.setPrintable(this, pf);
 348
 349       if (printJob.printDialog())
 350       {
 351         try
 352         {
 353           printJob.print();
 354         } catch (Exception PrintException)
 355         {
 356           PrintException.printStackTrace();
 357         }
 358       }
 359     }
 360
 361     @Override
 362     public int print(Graphics pg, PageFormat pf, int pi)
 363             throws PrinterException
 364     {
 365       pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
 366
 367       rc.drawBackground(pg, rc.bgColour);
 368       rc.drawScene(pg);
 369       if (rc.drawAxes)
 370       {
 371         rc.drawAxes(pg);
 372       }
 373
 374       if (pi == 0)
 375       {
 376         return Printable.PAGE_EXISTS;
 377       }
 378       else
 379       {
 380         return Printable.NO_SUCH_PAGE;
 381       }
 382     }
 383   }
 384
 385   /**
 386    * Handler for 'Save as EPS' option
 387    */
 388   @Override
 389   protected void eps_actionPerformed()
 390   {
 391     makePCAImage(ImageMaker.TYPE.EPS);
 392   }
 393
 394   /**
 395    * Handler for 'Save as PNG' option
 396    */
 397   @Override
 398   protected void png_actionPerformed()
 399   {
 400     makePCAImage(ImageMaker.TYPE.PNG);
 401   }
 402
 403   void makePCAImage(ImageMaker.TYPE type)
 404   {
 405     int width = rc.getWidth();
 406     int height = rc.getHeight();
 407
 408     ImageMaker im;
 409
 410     if (type == ImageMaker.TYPE.PNG)
 411     {
 412       im = new ImageMaker(this, ImageMaker.TYPE.PNG,
 413               "Make PNG image from PCA", width, height, null, null, null, 0,
 414               false);
 415     }
 416     else if (type == jalview.util.ImageMaker.TYPE.EPS)
 417     {
 418       im = new ImageMaker(this, ImageMaker.TYPE.EPS,
 419               "Make EPS file from PCA", width, height, null,
 420               this.getTitle(), null, 0, false);
 421     }
 422     else
 423     {
 424       im = new ImageMaker(this, ImageMaker.TYPE.SVG,
 425               "Make SVG file from PCA", width, height, null,
 426               this.getTitle(), null, 0, false);
 427     }
 428
 429     if (im.getGraphics() != null)
 430     {
 431       rc.drawBackground(im.getGraphics(), Color.black);
 432       rc.drawScene(im.getGraphics());
 433       if (rc.drawAxes)
 434       {
 435         rc.drawAxes(im.getGraphics());
 436       }
 437       im.writeImage();
 438     }
 439   }
 440
 441   @Override
 442   protected void viewMenu_menuSelected()
 443   {
 444     buildAssociatedViewMenu();
 445   }
 446
 447   /**
 448    * Builds the menu showing the choice of possible views (for the associated
 449    * sequence data) to which the PCA may be linked
 450    */
 451   void buildAssociatedViewMenu()
 452   {
 453     AlignmentPanel[] aps = PaintRefresher
 454             .getAssociatedPanels(av.getSequenceSetId());
 455     if (aps.length == 1 && rc.av == aps[0].av)
 456     {
 457       associateViewsMenu.setVisible(false);
 458       return;
 459     }
 460
 461     associateViewsMenu.setVisible(true);
 462
 463     if ((viewMenu
 464             .getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
 465     {
 466       viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
 467     }
 468
 469     associateViewsMenu.removeAll();
 470
 471     JRadioButtonMenuItem item;
 472     ButtonGroup buttonGroup = new ButtonGroup();
 473     int iSize = aps.length;
 474
 475     for (int i = 0; i < iSize; i++)
 476     {
 477       final AlignmentPanel panel = aps[i];
 478       item = new JRadioButtonMenuItem(panel.av.viewName, panel.av == rc.av);
 479       buttonGroup.add(item);
 480       item.addActionListener(new ActionListener()
 481       {
 482         @Override
 483         public void actionPerformed(ActionEvent evt)
 484         {
 485           rc.applyToAllViews = false;
 486           rc.av = panel.av;
 487           rc.ap = panel;
 488           PaintRefresher.Register(PCAPanel.this,
 489                   panel.av.getSequenceSetId());
 490         }
 491       });
 492
 493       associateViewsMenu.add(item);
 494     }
 495
 496     final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem(
 497             "All Views");
 498
 499     buttonGroup.add(itemf);
 500
 501     itemf.setSelected(rc.applyToAllViews);
 502     itemf.addActionListener(new ActionListener()
 503     {
 504       @Override
 505       public void actionPerformed(ActionEvent evt)
 506       {
 507         rc.applyToAllViews = itemf.isSelected();
 508       }
 509     });
 510     associateViewsMenu.add(itemf);
 511
 512   }
 513
 514   /*
 515    * (non-Javadoc)
 516    *
 517    * @see
 518    * jalview.jbgui.GPCAPanel#outputPoints_actionPerformed(java.awt.event.ActionEvent
 519    * )
 520    */
 521   @Override
 522   protected void outputPoints_actionPerformed()
 523   {
 524     CutAndPasteTransfer cap = new CutAndPasteTransfer();
 525     try
 526     {
 527       cap.setText(pcaModel.getPointsasCsv(false,
 528               xCombobox.getSelectedIndex(), yCombobox.getSelectedIndex(),
 529               zCombobox.getSelectedIndex()));
 530       Desktop.addInternalFrame(cap, MessageManager
 531               .formatMessage("label.points_for_params", new String[]
 532               { this.getTitle() }), 500, 500);
 533     } catch (OutOfMemoryError oom)
 534     {
 535       new OOMWarning("exporting PCA points", oom);
 536       cap.dispose();
 537     }
 538   }
 539
 540   /*
 541    * (non-Javadoc)
 542    *
 543    * @see
 544    * jalview.jbgui.GPCAPanel#outputProjPoints_actionPerformed(java.awt.event
 545    * .ActionEvent)
 546    */
 547   @Override
 548   protected void outputProjPoints_actionPerformed()
 549   {
 550     CutAndPasteTransfer cap = new CutAndPasteTransfer();
 551     try
 552     {
 553       cap.setText(pcaModel.getPointsasCsv(true,
 554               xCombobox.getSelectedIndex(), yCombobox.getSelectedIndex(),
 555               zCombobox.getSelectedIndex()));
 556       Desktop.addInternalFrame(cap, MessageManager.formatMessage(
 557               "label.transformed_points_for_params", new String[]
 558               { this.getTitle() }), 500, 500);
 559     } catch (OutOfMemoryError oom)
 560     {
 561       new OOMWarning("exporting transformed PCA points", oom);
 562       cap.dispose();
 563     }
 564   }
 565
 566   /*
 567    * (non-Javadoc)
 568    *
 569    * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
 570    */
 571   @Override
 572   public void setProgressBar(String message, long id)
 573   {
 574     progressBar.setProgressBar(message, id);
 575     // if (progressBars == null)
 576     // {
 577     // progressBars = new Hashtable();
 578     // progressBarHandlers = new Hashtable();
 579     // }
 580     //
 581     // JPanel progressPanel;
 582     // Long lId = new Long(id);
 583     // GridLayout layout = (GridLayout) statusPanel.getLayout();
 584     // if (progressBars.get(lId) != null)
 585     // {
 586     // progressPanel = (JPanel) progressBars.get(new Long(id));
 587     // statusPanel.remove(progressPanel);
 588     // progressBars.remove(lId);
 589     // progressPanel = null;
 590     // if (message != null)
 591     // {
 592     // statusBar.setText(message);
 593     // }
 594     // if (progressBarHandlers.contains(lId))
 595     // {
 596     // progressBarHandlers.remove(lId);
 597     // }
 598     // layout.setRows(layout.getRows() - 1);
 599     // }
 600     // else
 601     // {
 602     // progressPanel = new JPanel(new BorderLayout(10, 5));
 603     //
 604     // JProgressBar progressBar = new JProgressBar();
 605     // progressBar.setIndeterminate(true);
 606     //
 607     // progressPanel.add(new JLabel(message), BorderLayout.WEST);
 608     // progressPanel.add(progressBar, BorderLayout.CENTER);
 609     //
 610     // layout.setRows(layout.getRows() + 1);
 611     // statusPanel.add(progressPanel);
 612     //
 613     // progressBars.put(lId, progressPanel);
 614     // }
 615     // // update GUI
 616     // // setMenusForViewport();
 617     // validate();
 618   }
 619
 620   @Override
 621   public void registerHandler(final long id,
 622           final IProgressIndicatorHandler handler)
 623   {
 624     progressBar.registerHandler(id, handler);
 625     // if (progressBarHandlers == null || !progressBars.contains(new Long(id)))
 626     // {
 627     // throw new
 628     // Error(MessageManager.getString("error.call_setprogressbar_before_registering_handler"));
 629     // }
 630     // progressBarHandlers.put(new Long(id), handler);
 631     // final JPanel progressPanel = (JPanel) progressBars.get(new Long(id));
 632     // if (handler.canCancel())
 633     // {
 634     // JButton cancel = new JButton(
 635     // MessageManager.getString("action.cancel"));
 636     // final IProgressIndicator us = this;
 637     // cancel.addActionListener(new ActionListener()
 638     // {
 639     //
 640     // @Override
 641     // public void actionPerformed(ActionEvent e)
 642     // {
 643     // handler.cancelActivity(id);
 644     // us.setProgressBar(MessageManager.formatMessage("label.cancelled_params",
 645     // new String[]{((JLabel) progressPanel.getComponent(0)).getText()}), id);
 646     // }
 647     // });
 648     // progressPanel.add(cancel, BorderLayout.EAST);
 649     // }
 650   }
 651
 652   /**
 653    *
 654    * @return true if any progress bars are still active
 655    */
 656   @Override
 657   public boolean operationInProgress()
 658   {
 659     return progressBar.operationInProgress();
 660   }
 661
 662   @Override
 663   protected void resetButton_actionPerformed()
 664   {
 665     int t = top;
 666     top = 0; // ugly - prevents dimensionChanged events from being processed
 667     xCombobox.setSelectedIndex(0);
 668     yCombobox.setSelectedIndex(1);
 669     top = t;
 670     zCombobox.setSelectedIndex(2);
 671   }
 672
 673   /**
 674    * Answers true if PCA calculation is in progress, else false
 675    *
 676    * @return
 677    */
 678   public boolean isWorking()
 679   {
 680     return working;
 681   }
 682 }