4f660a27f5e11ade8ed243446484dcf89071d849
[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.AlignViewportI;
25 import jalview.api.analysis.ScoreModelI;
26 import jalview.api.analysis.SimilarityParamsI;
27 import jalview.bin.Cache;
28 import jalview.datamodel.Alignment;
29 import jalview.datamodel.AlignmentI;
30 import jalview.datamodel.AlignmentView;
31 import jalview.datamodel.HiddenColumns;
32 import jalview.datamodel.SequenceI;
33 import jalview.jbgui.GPCAPanel;
34 import jalview.math.RotatableMatrix.Axis;
35 import jalview.util.ImageMaker;
36 import jalview.util.MessageManager;
37 import jalview.viewmodel.AlignmentViewport;
38 import jalview.viewmodel.PCAModel;
39
40 import java.awt.BorderLayout;
41 import java.awt.Color;
42 import java.awt.Dimension;
43 import java.awt.Graphics;
44 import java.awt.event.ActionEvent;
45 import java.awt.event.ActionListener;
46 import java.awt.print.PageFormat;
47 import java.awt.print.Printable;
48 import java.awt.print.PrinterException;
49 import java.awt.print.PrinterJob;
50
51 import javax.swing.ButtonGroup;
52 import javax.swing.JColorChooser;
53 import javax.swing.JMenuItem;
54 import javax.swing.JRadioButtonMenuItem;
55 import javax.swing.event.InternalFrameAdapter;
56 import javax.swing.event.InternalFrameEvent;
57
58 /**
59  * The panel holding the Principal Component Analysis 3-D visualisation
60  */
61 public class PCAPanel extends GPCAPanel
62         implements Runnable, IProgressIndicator
63 {
64   private static final int MIN_WIDTH = 470;
65
66   private static final int MIN_HEIGHT = 250;
67
68   private RotatableCanvas rc;
69
70   AlignmentPanel ap;
71
72   AlignmentViewport av;
73
74   private PCAModel pcaModel;
75
76   private int top = 0;
77
78   private IProgressIndicator progressBar;
79
80   private boolean working;
81
82   /**
83    * Constructor given sequence data, a similarity (or distance) score model
84    * name, and score calculation parameters
85    * 
86    * @param alignPanel
87    * @param modelName
88    * @param params
89    */
90   public PCAPanel(AlignmentPanel alignPanel, String modelName,
91           SimilarityParamsI params)
92   {
93     super();
94     this.av = alignPanel.av;
95     this.ap = alignPanel;
96     boolean nucleotide = av.getAlignment().isNucleotide();
97
98     progressBar = new ProgressBar(statusPanel, statusBar);
99
100     addInternalFrameListener(new InternalFrameAdapter()
101     {
102       @Override
103       public void internalFrameClosed(InternalFrameEvent e)
104       {
105         close_actionPerformed();
106       }
107     });
108
109     boolean selected = av.getSelectionGroup() != null
110             && av.getSelectionGroup().getSize() > 0;
111     AlignmentView seqstrings = av.getAlignmentView(selected);
112     SequenceI[] seqs;
113     if (!selected)
114     {
115       seqs = av.getAlignment().getSequencesArray();
116     }
117     else
118     {
119       seqs = av.getSelectionGroup().getSequencesInOrder(av.getAlignment());
120     }
121
122     ScoreModelI scoreModel = ScoreModels.getInstance()
123             .getScoreModel(modelName, ap);
124     setPcaModel(new PCAModel(seqstrings, seqs, nucleotide, scoreModel,
125             params));
126     PaintRefresher.Register(this, av.getSequenceSetId());
127
128     setRotatableCanvas(new RotatableCanvas(alignPanel));
129     this.getContentPane().add(getRotatableCanvas(), BorderLayout.CENTER);
130
131     addKeyListener(getRotatableCanvas());
132     validate();
133
134     this.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
135   }
136
137   /**
138    * Ensure references to potentially very large objects (the PCA matrices) are
139    * nulled when the frame is closed
140    */
141   protected void close_actionPerformed()
142   {
143     setPcaModel(null);
144   }
145
146   @Override
147   protected void bgcolour_actionPerformed()
148   {
149     Color col = JColorChooser.showDialog(this,
150             MessageManager.getString("label.select_background_colour"),
151             getRotatableCanvas().getBgColour());
152
153     if (col != null)
154     {
155       getRotatableCanvas().setBgColour(col);
156     }
157     getRotatableCanvas().repaint();
158   }
159
160   /**
161    * Calculates the PCA and displays the results
162    */
163   @Override
164   public void run()
165   {
166     working = true;
167     long progId = System.currentTimeMillis();
168     IProgressIndicator progress = this;
169     String message = MessageManager.getString("label.pca_recalculating");
170     if (getParent() == null)
171     {
172       progress = ap.alignFrame;
173       message = MessageManager.getString("label.pca_calculating");
174     }
175     progress.setProgressBar(message, progId);
176     try
177     {
178       getPcaModel().calculate();
179
180       xCombobox.setSelectedIndex(0);
181       yCombobox.setSelectedIndex(1);
182       zCombobox.setSelectedIndex(2);
183
184       getPcaModel().updateRc(getRotatableCanvas());
185       // rc.invalidate();
186       setTop(getPcaModel().getTop());
187
188     } catch (OutOfMemoryError er)
189     {
190       new OOMWarning("calculating PCA", er);
191       working = false;
192       return;
193     } finally
194     {
195       progress.setProgressBar("", progId);
196     }
197
198     repaint();
199     if (getParent() == null)
200     {
201       Desktop.addInternalFrame(this,
202               MessageManager.formatMessage("label.calc_title", "PCA",
203                       getPcaModel().getScoreModelName()),
204               475, 450);
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 (getTop() == 0)
217     {
218       return;
219     }
220
221     int dim1 = getTop() - xCombobox.getSelectedIndex();
222     int dim2 = getTop() - yCombobox.getSelectedIndex();
223     int dim3 = getTop() - zCombobox.getSelectedIndex();
224     getPcaModel().updateRcView(dim1, dim2, dim3);
225     getRotatableCanvas().resetView();
226   }
227
228   /**
229    * Sets the selected checkbox item index for PCA dimension (1, 2, 3...) for
230    * the given axis (X/Y/Z)
231    * 
232    * @param index
233    * @param axis
234    */
235   public void setSelectedDimensionIndex(int index, Axis axis)
236   {
237     switch (axis)
238     {
239     case X:
240       xCombobox.setSelectedIndex(index);
241       break;
242     case Y:
243       yCombobox.setSelectedIndex(index);
244       break;
245     case Z:
246       zCombobox.setSelectedIndex(index);
247       break;
248     default:
249     }
250   }
251
252   @Override
253   protected void outputValues_actionPerformed()
254   {
255     CutAndPasteTransfer cap = new CutAndPasteTransfer();
256     try
257     {
258       cap.setText(getPcaModel().getDetails());
259       Desktop.addInternalFrame(cap,
260               MessageManager.getString("label.pca_details"), 500, 500);
261     } catch (OutOfMemoryError oom)
262     {
263       new OOMWarning("opening PCA details", oom);
264       cap.dispose();
265     }
266   }
267
268   @Override
269   protected void showLabels_actionPerformed()
270   {
271     getRotatableCanvas().showLabels(showLabels.getState());
272   }
273
274   @Override
275   protected void print_actionPerformed()
276   {
277     PCAPrinter printer = new PCAPrinter();
278     printer.start();
279   }
280
281   /**
282    * If available, shows the data which formed the inputs for the PCA as a new
283    * alignment
284    */
285   @Override
286   public void originalSeqData_actionPerformed()
287   {
288     // JAL-2647 disabled after load from project (until save to project done)
289     if (getPcaModel().getInputData() == null)
290     {
291       Cache.log.info(
292               "Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
293       return;
294     }
295     // decide if av alignment is sufficiently different to original data to
296     // warrant a new window to be created
297     // create new alignment window with hidden regions (unhiding hidden regions
298     // yields unaligned seqs)
299     // or create a selection box around columns in alignment view
300     // test Alignment(SeqCigar[])
301     char gc = '-';
302     try
303     {
304       // we try to get the associated view's gap character
305       // but this may fail if the view was closed...
306       gc = av.getGapCharacter();
307     } catch (Exception ex)
308     {
309     }
310
311     Object[] alAndColsel = getPcaModel().getInputData()
312             .getAlignmentAndHiddenColumns(gc);
313
314     if (alAndColsel != null && alAndColsel[0] != null)
315     {
316       // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
317
318       AlignmentI al = new Alignment((SequenceI[]) alAndColsel[0]);
319       AlignmentI dataset = (av != null && av.getAlignment() != null)
320               ? av.getAlignment().getDataset()
321               : null;
322       if (dataset != null)
323       {
324         al.setDataset(dataset);
325       }
326
327       if (true)
328       {
329         // make a new frame!
330         AlignFrame af = new AlignFrame(al, (HiddenColumns) alAndColsel[1],
331                 AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
332
333         // >>>This is a fix for the moment, until a better solution is
334         // found!!<<<
335         // af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());
336
337         // af.addSortByOrderMenuItem(ServiceName + " Ordering",
338         // msaorder);
339
340         Desktop.addInternalFrame(af, MessageManager.formatMessage(
341                 "label.original_data_for_params", new String[]
342                 { this.title }), AlignFrame.DEFAULT_WIDTH,
343                 AlignFrame.DEFAULT_HEIGHT);
344       }
345     }
346     /*
347      * CutAndPasteTransfer cap = new CutAndPasteTransfer(); for (int i = 0; i <
348      * seqs.length; i++) { cap.appendText(new jalview.util.Format("%-" + 15 +
349      * "s").form( seqs[i].getName())); cap.appendText(" " + seqstrings[i] +
350      * "\n"); }
351      * 
352      * Desktop.addInternalFrame(cap, "Original Data", 400, 400);
353      */
354   }
355
356   class PCAPrinter extends Thread implements Printable
357   {
358     @Override
359     public void run()
360     {
361       PrinterJob printJob = PrinterJob.getPrinterJob();
362       PageFormat defaultPage = printJob.defaultPage();
363       PageFormat pf = printJob.pageDialog(defaultPage);
364
365       if (defaultPage == pf)
366       {
367         /*
368          * user cancelled
369          */
370         return;
371       }
372
373       printJob.setPrintable(this, pf);
374
375       if (printJob.printDialog())
376       {
377         try
378         {
379           printJob.print();
380         } catch (Exception PrintException)
381         {
382           PrintException.printStackTrace();
383         }
384       }
385     }
386
387     @Override
388     public int print(Graphics pg, PageFormat pf, int pi)
389             throws PrinterException
390     {
391       pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
392
393       getRotatableCanvas().drawBackground(pg);
394       getRotatableCanvas().drawScene(pg);
395       if (getRotatableCanvas().drawAxes)
396       {
397         getRotatableCanvas().drawAxes(pg);
398       }
399
400       if (pi == 0)
401       {
402         return Printable.PAGE_EXISTS;
403       }
404       else
405       {
406         return Printable.NO_SUCH_PAGE;
407       }
408     }
409   }
410
411   /**
412    * Handler for 'Save as EPS' option
413    */
414   @Override
415   protected void eps_actionPerformed()
416   {
417     makePCAImage(ImageMaker.TYPE.EPS);
418   }
419
420   /**
421    * Handler for 'Save as PNG' option
422    */
423   @Override
424   protected void png_actionPerformed()
425   {
426     makePCAImage(ImageMaker.TYPE.PNG);
427   }
428
429   void makePCAImage(ImageMaker.TYPE type)
430   {
431     int width = getRotatableCanvas().getWidth();
432     int height = getRotatableCanvas().getHeight();
433
434     ImageMaker im;
435
436     switch (type)
437     {
438     case PNG:
439       im = new ImageMaker(this, ImageMaker.TYPE.PNG,
440               "Make PNG image from PCA", width, height, null, null, null, 0,
441               false);
442       break;
443     case EPS:
444       im = new ImageMaker(this, ImageMaker.TYPE.EPS,
445               "Make EPS file from PCA", width, height, null,
446               this.getTitle(), null, 0, false);
447       break;
448     default:
449       im = new ImageMaker(this, ImageMaker.TYPE.SVG,
450               "Make SVG file from PCA", width, height, null,
451               this.getTitle(), null, 0, false);
452     }
453
454     if (im.getGraphics() != null)
455     {
456       getRotatableCanvas().drawBackground(im.getGraphics());
457       getRotatableCanvas().drawScene(im.getGraphics());
458       if (getRotatableCanvas().drawAxes)
459       {
460         getRotatableCanvas().drawAxes(im.getGraphics());
461       }
462       im.writeImage();
463     }
464   }
465
466   @Override
467   protected void viewMenu_menuSelected()
468   {
469     buildAssociatedViewMenu();
470   }
471
472   /**
473    * Builds the menu showing the choice of possible views (for the associated
474    * sequence data) to which the PCA may be linked
475    */
476   void buildAssociatedViewMenu()
477   {
478     AlignmentPanel[] aps = PaintRefresher
479             .getAssociatedPanels(av.getSequenceSetId());
480     if (aps.length == 1 && getRotatableCanvas().av == aps[0].av)
481     {
482       associateViewsMenu.setVisible(false);
483       return;
484     }
485
486     associateViewsMenu.setVisible(true);
487
488     if ((viewMenu
489             .getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
490     {
491       viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
492     }
493
494     associateViewsMenu.removeAll();
495
496     JRadioButtonMenuItem item;
497     ButtonGroup buttonGroup = new ButtonGroup();
498     int iSize = aps.length;
499
500     for (int i = 0; i < iSize; i++)
501     {
502       final AlignmentPanel panel = aps[i];
503       item = new JRadioButtonMenuItem(panel.av.getViewName(),
504               panel.av == getRotatableCanvas().av);
505       buttonGroup.add(item);
506       item.addActionListener(new ActionListener()
507       {
508         @Override
509         public void actionPerformed(ActionEvent evt)
510         {
511           selectAssociatedView(panel);
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(getRotatableCanvas().isApplyToAllViews());
524     itemf.addActionListener(new ActionListener()
525     {
526       @Override
527       public void actionPerformed(ActionEvent evt)
528       {
529         getRotatableCanvas().setApplyToAllViews(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(getPcaModel().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(getPcaModel().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 = Long.valueOf(id);
605     // GridLayout layout = (GridLayout) statusPanel.getLayout();
606     // if (progressBars.get(lId) != null)
607     // {
608     // progressPanel = (JPanel) progressBars.get(Long.valueOf(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(Long.valueOf(id)))
648     // {
649     // throw new
650     // Error(MessageManager.getString("error.call_setprogressbar_before_registering_handler"));
651     // }
652     // progressBarHandlers.put(Long.valueOf(id), handler);
653     // final JPanel progressPanel = (JPanel) progressBars.get(Long.valueOf(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 = getTop();
688     setTop(0); // ugly - prevents dimensionChanged events from being processed
689     xCombobox.setSelectedIndex(0);
690     yCombobox.setSelectedIndex(1);
691     setTop(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
730   /**
731    * Sets the input data used to calculate the PCA. This is provided for
732    * 'restore from project', which does not currently support this (AL-2647), so
733    * sets the value to null, and hides the menu option for "Input Data...". J
734    * 
735    * @param data
736    */
737   public void setInputData(AlignmentView data)
738   {
739     getPcaModel().setInputData(data);
740     originalSeqData.setVisible(data != null);
741   }
742
743   public AlignViewportI getAlignViewport()
744   {
745     return av;
746   }
747
748   public PCAModel getPcaModel()
749   {
750     return pcaModel;
751   }
752
753   public void setPcaModel(PCAModel pcaModel)
754   {
755     this.pcaModel = pcaModel;
756   }
757
758   public RotatableCanvas getRotatableCanvas()
759   {
760     return rc;
761   }
762
763   public void setRotatableCanvas(RotatableCanvas rc)
764   {
765     this.rc = rc;
766   }
767
768   public int getTop()
769   {
770     return top;
771   }
772
773   public void setTop(int top)
774   {
775     this.top = top;
776   }
777
778   /**
779    * set the associated view for this PCA.
780    * 
781    * @param panel
782    */
783   public void selectAssociatedView(AlignmentPanel panel)
784   {
785     getRotatableCanvas().setApplyToAllViews(false);
786
787     ap = panel;
788     av = panel.av;
789
790     getRotatableCanvas().av = panel.av;
791     getRotatableCanvas().ap = panel;
792     PaintRefresher.Register(PCAPanel.this, panel.av.getSequenceSetId());
793   }
794 }