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.img = null;
 226     rc.rotmat.setIdentity();
 227     rc.initAxes();
 228     rc.paint(rc.getGraphics());
 229   }
 230
 231   @Override
 232   protected void outputValues_actionPerformed()
 233   {
 234     CutAndPasteTransfer cap = new CutAndPasteTransfer();
 235     try
 236     {
 237       cap.setText(pcaModel.getDetails());
 238       Desktop.addInternalFrame(cap,
 239               MessageManager.getString("label.pca_details"), 500, 500);
 240     } catch (OutOfMemoryError oom)
 241     {
 242       new OOMWarning("opening PCA details", oom);
 243       cap.dispose();
 244     }
 245   }
 246
 247   @Override
 248   protected void showLabels_actionPerformed()
 249   {
 250     rc.showLabels(showLabels.getState());
 251   }
 252
 253   @Override
 254   protected void print_actionPerformed()
 255   {
 256     PCAPrinter printer = new PCAPrinter();
 257     printer.start();
 258   }
 259
 260   @Override
 261   public void originalSeqData_actionPerformed()
 262   {
 263     // this was cut'n'pasted from the equivalent TreePanel method - we should
 264     // make this an abstract function of all jalview analysis windows
 265     if (pcaModel.getSeqtrings() == null)
 266     {
 267       jalview.bin.Cache.log.info(
 268               "Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
 269       return;
 270     }
 271     // decide if av alignment is sufficiently different to original data to
 272     // warrant a new window to be created
 273     // create new alignmnt window with hidden regions (unhiding hidden regions
 274     // yields unaligned seqs)
 275     // or create a selection box around columns in alignment view
 276     // test Alignment(SeqCigar[])
 277     char gc = '-';
 278     try
 279     {
 280       // we try to get the associated view's gap character
 281       // but this may fail if the view was closed...
 282       gc = av.getGapCharacter();
 283     } catch (Exception ex)
 284     {
 285     }
 286
 287     Object[] alAndColsel = pcaModel.getSeqtrings()
 288             .getAlignmentAndHiddenColumns(gc);
 289
 290     if (alAndColsel != null && alAndColsel[0] != null)
 291     {
 292       // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
 293
 294       AlignmentI al = new Alignment((SequenceI[]) alAndColsel[0]);
 295       AlignmentI dataset = (av != null && av.getAlignment() != null)
 296               ? av.getAlignment().getDataset()
 297               : null;
 298       if (dataset != null)
 299       {
 300         al.setDataset(dataset);
 301       }
 302
 303       if (true)
 304       {
 305         // make a new frame!
 306         AlignFrame af = new AlignFrame(al, (HiddenColumns) alAndColsel[1],
 307                 AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 308
 309         // >>>This is a fix for the moment, until a better solution is
 310         // found!!<<<
 311         // af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());
 312
 313         // af.addSortByOrderMenuItem(ServiceName + " Ordering",
 314         // msaorder);
 315
 316         Desktop.addInternalFrame(af, MessageManager.formatMessage(
 317                 "label.original_data_for_params", new String[]
 318                 { this.title }), AlignFrame.DEFAULT_WIDTH,
 319                 AlignFrame.DEFAULT_HEIGHT);
 320       }
 321     }
 322     /*
 323      * CutAndPasteTransfer cap = new CutAndPasteTransfer(); for (int i = 0; i <
 324      * seqs.length; i++) { cap.appendText(new jalview.util.Format("%-" + 15 +
 325      * "s").form( seqs[i].getName())); cap.appendText(" " + seqstrings[i] +
 326      * "\n"); }
 327      *
 328      * Desktop.addInternalFrame(cap, "Original Data", 400, 400);
 329      */
 330   }
 331
 332   class PCAPrinter extends Thread implements Printable
 333   {
 334     @Override
 335     public void run()
 336     {
 337       PrinterJob printJob = PrinterJob.getPrinterJob();
 338       PageFormat defaultPage = printJob.defaultPage();
 339       PageFormat pf = printJob.pageDialog(defaultPage);
 340
 341       if (defaultPage == pf)
 342       {
 343         /*
 344          * user cancelled
 345          */
 346         return;
 347       }
 348
 349       printJob.setPrintable(this, pf);
 350
 351       if (printJob.printDialog())
 352       {
 353         try
 354         {
 355           printJob.print();
 356         } catch (Exception PrintException)
 357         {
 358           PrintException.printStackTrace();
 359         }
 360       }
 361     }
 362
 363     @Override
 364     public int print(Graphics pg, PageFormat pf, int pi)
 365             throws PrinterException
 366     {
 367       pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
 368
 369       rc.drawBackground(pg, rc.bgColour);
 370       rc.drawScene(pg);
 371       if (rc.drawAxes)
 372       {
 373         rc.drawAxes(pg);
 374       }
 375
 376       if (pi == 0)
 377       {
 378         return Printable.PAGE_EXISTS;
 379       }
 380       else
 381       {
 382         return Printable.NO_SUCH_PAGE;
 383       }
 384     }
 385   }
 386
 387   /**
 388    * Handler for 'Save as EPS' option
 389    */
 390   @Override
 391   protected void eps_actionPerformed()
 392   {
 393     makePCAImage(ImageMaker.TYPE.EPS);
 394   }
 395
 396   /**
 397    * Handler for 'Save as PNG' option
 398    */
 399   @Override
 400   protected void png_actionPerformed()
 401   {
 402     makePCAImage(ImageMaker.TYPE.PNG);
 403   }
 404
 405   void makePCAImage(ImageMaker.TYPE type)
 406   {
 407     int width = rc.getWidth();
 408     int height = rc.getHeight();
 409
 410     ImageMaker im;
 411
 412     if (type == ImageMaker.TYPE.PNG)
 413     {
 414       im = new ImageMaker(this, ImageMaker.TYPE.PNG,
 415               "Make PNG image from PCA", width, height, null, null, null, 0,
 416               false);
 417     }
 418     else if (type == jalview.util.ImageMaker.TYPE.EPS)
 419     {
 420       im = new ImageMaker(this, ImageMaker.TYPE.EPS,
 421               "Make EPS file from PCA", width, height, null,
 422               this.getTitle(), null, 0, false);
 423     }
 424     else
 425     {
 426       im = new ImageMaker(this, ImageMaker.TYPE.SVG,
 427               "Make SVG file from PCA", width, height, null,
 428               this.getTitle(), null, 0, false);
 429     }
 430
 431     if (im.getGraphics() != null)
 432     {
 433       rc.drawBackground(im.getGraphics(), Color.black);
 434       rc.drawScene(im.getGraphics());
 435       if (rc.drawAxes)
 436       {
 437         rc.drawAxes(im.getGraphics());
 438       }
 439       im.writeImage();
 440     }
 441   }
 442
 443   @Override
 444   protected void viewMenu_menuSelected()
 445   {
 446     buildAssociatedViewMenu();
 447   }
 448
 449   /**
 450    * Builds the menu showing the choice of possible views (for the associated
 451    * sequence data) to which the PCA may be linked
 452    */
 453   void buildAssociatedViewMenu()
 454   {
 455     AlignmentPanel[] aps = PaintRefresher
 456             .getAssociatedPanels(av.getSequenceSetId());
 457     if (aps.length == 1 && rc.av == aps[0].av)
 458     {
 459       associateViewsMenu.setVisible(false);
 460       return;
 461     }
 462
 463     associateViewsMenu.setVisible(true);
 464
 465     if ((viewMenu
 466             .getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
 467     {
 468       viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
 469     }
 470
 471     associateViewsMenu.removeAll();
 472
 473     JRadioButtonMenuItem item;
 474     ButtonGroup buttonGroup = new ButtonGroup();
 475     int iSize = aps.length;
 476
 477     for (int i = 0; i < iSize; i++)
 478     {
 479       final AlignmentPanel panel = aps[i];
 480       item = new JRadioButtonMenuItem(panel.av.viewName, panel.av == rc.av);
 481       buttonGroup.add(item);
 482       item.addActionListener(new ActionListener()
 483       {
 484         @Override
 485         public void actionPerformed(ActionEvent evt)
 486         {
 487           rc.applyToAllViews = false;
 488           rc.av = panel.av;
 489           rc.ap = panel;
 490           PaintRefresher.Register(PCAPanel.this,
 491                   panel.av.getSequenceSetId());
 492         }
 493       });
 494
 495       associateViewsMenu.add(item);
 496     }
 497
 498     final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem(
 499             "All Views");
 500
 501     buttonGroup.add(itemf);
 502
 503     itemf.setSelected(rc.applyToAllViews);
 504     itemf.addActionListener(new ActionListener()
 505     {
 506       @Override
 507       public void actionPerformed(ActionEvent evt)
 508       {
 509         rc.applyToAllViews = itemf.isSelected();
 510       }
 511     });
 512     associateViewsMenu.add(itemf);
 513
 514   }
 515
 516   /*
 517    * (non-Javadoc)
 518    *
 519    * @see
 520    * jalview.jbgui.GPCAPanel#outputPoints_actionPerformed(java.awt.event.ActionEvent
 521    * )
 522    */
 523   @Override
 524   protected void outputPoints_actionPerformed()
 525   {
 526     CutAndPasteTransfer cap = new CutAndPasteTransfer();
 527     try
 528     {
 529       cap.setText(pcaModel.getPointsasCsv(false,
 530               xCombobox.getSelectedIndex(), yCombobox.getSelectedIndex(),
 531               zCombobox.getSelectedIndex()));
 532       Desktop.addInternalFrame(cap, MessageManager
 533               .formatMessage("label.points_for_params", new String[]
 534               { this.getTitle() }), 500, 500);
 535     } catch (OutOfMemoryError oom)
 536     {
 537       new OOMWarning("exporting PCA points", oom);
 538       cap.dispose();
 539     }
 540   }
 541
 542   /*
 543    * (non-Javadoc)
 544    *
 545    * @see
 546    * jalview.jbgui.GPCAPanel#outputProjPoints_actionPerformed(java.awt.event
 547    * .ActionEvent)
 548    */
 549   @Override
 550   protected void outputProjPoints_actionPerformed()
 551   {
 552     CutAndPasteTransfer cap = new CutAndPasteTransfer();
 553     try
 554     {
 555       cap.setText(pcaModel.getPointsasCsv(true,
 556               xCombobox.getSelectedIndex(), yCombobox.getSelectedIndex(),
 557               zCombobox.getSelectedIndex()));
 558       Desktop.addInternalFrame(cap, MessageManager.formatMessage(
 559               "label.transformed_points_for_params", new String[]
 560               { this.getTitle() }), 500, 500);
 561     } catch (OutOfMemoryError oom)
 562     {
 563       new OOMWarning("exporting transformed PCA points", oom);
 564       cap.dispose();
 565     }
 566   }
 567
 568   /*
 569    * (non-Javadoc)
 570    *
 571    * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
 572    */
 573   @Override
 574   public void setProgressBar(String message, long id)
 575   {
 576     progressBar.setProgressBar(message, id);
 577     // if (progressBars == null)
 578     // {
 579     // progressBars = new Hashtable();
 580     // progressBarHandlers = new Hashtable();
 581     // }
 582     //
 583     // JPanel progressPanel;
 584     // Long lId = new Long(id);
 585     // GridLayout layout = (GridLayout) statusPanel.getLayout();
 586     // if (progressBars.get(lId) != null)
 587     // {
 588     // progressPanel = (JPanel) progressBars.get(new Long(id));
 589     // statusPanel.remove(progressPanel);
 590     // progressBars.remove(lId);
 591     // progressPanel = null;
 592     // if (message != null)
 593     // {
 594     // statusBar.setText(message);
 595     // }
 596     // if (progressBarHandlers.contains(lId))
 597     // {
 598     // progressBarHandlers.remove(lId);
 599     // }
 600     // layout.setRows(layout.getRows() - 1);
 601     // }
 602     // else
 603     // {
 604     // progressPanel = new JPanel(new BorderLayout(10, 5));
 605     //
 606     // JProgressBar progressBar = new JProgressBar();
 607     // progressBar.setIndeterminate(true);
 608     //
 609     // progressPanel.add(new JLabel(message), BorderLayout.WEST);
 610     // progressPanel.add(progressBar, BorderLayout.CENTER);
 611     //
 612     // layout.setRows(layout.getRows() + 1);
 613     // statusPanel.add(progressPanel);
 614     //
 615     // progressBars.put(lId, progressPanel);
 616     // }
 617     // // update GUI
 618     // // setMenusForViewport();
 619     // validate();
 620   }
 621
 622   @Override
 623   public void registerHandler(final long id,
 624           final IProgressIndicatorHandler handler)
 625   {
 626     progressBar.registerHandler(id, handler);
 627     // if (progressBarHandlers == null || !progressBars.contains(new Long(id)))
 628     // {
 629     // throw new
 630     // Error(MessageManager.getString("error.call_setprogressbar_before_registering_handler"));
 631     // }
 632     // progressBarHandlers.put(new Long(id), handler);
 633     // final JPanel progressPanel = (JPanel) progressBars.get(new Long(id));
 634     // if (handler.canCancel())
 635     // {
 636     // JButton cancel = new JButton(
 637     // MessageManager.getString("action.cancel"));
 638     // final IProgressIndicator us = this;
 639     // cancel.addActionListener(new ActionListener()
 640     // {
 641     //
 642     // @Override
 643     // public void actionPerformed(ActionEvent e)
 644     // {
 645     // handler.cancelActivity(id);
 646     // us.setProgressBar(MessageManager.formatMessage("label.cancelled_params",
 647     // new String[]{((JLabel) progressPanel.getComponent(0)).getText()}), id);
 648     // }
 649     // });
 650     // progressPanel.add(cancel, BorderLayout.EAST);
 651     // }
 652   }
 653
 654   /**
 655    *
 656    * @return true if any progress bars are still active
 657    */
 658   @Override
 659   public boolean operationInProgress()
 660   {
 661     return progressBar.operationInProgress();
 662   }
 663
 664   @Override
 665   protected void resetButton_actionPerformed()
 666   {
 667     int t = top;
 668     top = 0; // ugly - prevents dimensionChanged events from being processed
 669     xCombobox.setSelectedIndex(0);
 670     yCombobox.setSelectedIndex(1);
 671     top = t;
 672     zCombobox.setSelectedIndex(2);
 673   }
 674
 675   /**
 676    * Answers true if PCA calculation is in progress, else false
 677    *
 678    * @return
 679    */
 680   public boolean isWorking()
 681   {
 682     return working;
 683   }
 684 }