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