2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import static jalview.util.ImageMaker.TYPE.PNG;
25 import jalview.analysis.scoremodels.ScoreModels;
26 import jalview.api.AlignViewportI;
27 import jalview.api.analysis.ScoreModelI;
28 import jalview.api.analysis.SimilarityParamsI;
29 import jalview.bin.Cache;
30 import jalview.datamodel.Alignment;
31 import jalview.datamodel.AlignmentI;
32 import jalview.datamodel.AlignmentView;
33 import jalview.datamodel.HiddenColumns;
34 import jalview.datamodel.SequenceI;
35 import jalview.jbgui.GPCAPanel;
36 import jalview.math.RotatableMatrix.Axis;
37 import jalview.util.ImageMaker;
38 import jalview.util.MessageManager;
39 import jalview.viewmodel.AlignmentViewport;
40 import jalview.viewmodel.PCAModel;
42 import java.awt.BorderLayout;
43 import java.awt.Color;
44 import java.awt.Dimension;
45 import java.awt.Graphics;
46 import java.awt.event.ActionEvent;
47 import java.awt.event.ActionListener;
48 import java.awt.print.PageFormat;
49 import java.awt.print.Printable;
50 import java.awt.print.PrinterException;
51 import java.awt.print.PrinterJob;
53 import javax.swing.ButtonGroup;
54 import javax.swing.JColorChooser;
55 import javax.swing.JMenuItem;
56 import javax.swing.JRadioButtonMenuItem;
57 import javax.swing.event.InternalFrameAdapter;
58 import javax.swing.event.InternalFrameEvent;
61 * The panel holding the Principal Component Analysis 3-D visualisation
63 public class PCAPanel extends GPCAPanel
64 implements Runnable, IProgressIndicator
66 private static final int MIN_WIDTH = 470;
68 private static final int MIN_HEIGHT = 250;
70 private RotatableCanvas rc;
76 private PCAModel pcaModel;
80 private IProgressIndicator progressBar;
82 private boolean working;
85 * Constructor given sequence data, a similarity (or distance) score model
86 * name, and score calculation parameters
92 public PCAPanel(AlignmentPanel alignPanel, String modelName,
93 SimilarityParamsI params)
96 this.av = alignPanel.av;
98 boolean nucleotide = av.getAlignment().isNucleotide();
100 progressBar = new ProgressBar(statusPanel, statusBar);
102 addInternalFrameListener(new InternalFrameAdapter()
105 public void internalFrameClosed(InternalFrameEvent e)
107 close_actionPerformed();
111 boolean selected = av.getSelectionGroup() != null
112 && av.getSelectionGroup().getSize() > 0;
113 AlignmentView seqstrings = av.getAlignmentView(selected);
117 seqs = av.getAlignment().getSequencesArray();
121 seqs = av.getSelectionGroup().getSequencesInOrder(av.getAlignment());
124 ScoreModelI scoreModel = ScoreModels.getInstance()
125 .getScoreModel(modelName, ap);
126 setPcaModel(new PCAModel(seqstrings, seqs, nucleotide, scoreModel,
128 PaintRefresher.Register(this, av.getSequenceSetId());
130 setRotatableCanvas(new RotatableCanvas(alignPanel));
131 this.getContentPane().add(getRotatableCanvas(), BorderLayout.CENTER);
133 addKeyListener(getRotatableCanvas());
136 this.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
140 * Ensure references to potentially very large objects (the PCA matrices) are
141 * nulled when the frame is closed
143 protected void close_actionPerformed()
149 protected void bgcolour_actionPerformed()
151 Color col = JColorChooser.showDialog(this,
152 MessageManager.getString("label.select_background_colour"),
153 getRotatableCanvas().getBgColour());
157 getRotatableCanvas().setBgColour(col);
159 getRotatableCanvas().repaint();
163 * Calculates the PCA and displays the results
169 long progId = System.currentTimeMillis();
170 IProgressIndicator progress = this;
171 String message = MessageManager.getString("label.pca_recalculating");
172 if (getParent() == null)
174 progress = ap.alignFrame;
175 message = MessageManager.getString("label.pca_calculating");
177 progress.setProgressBar(message, progId);
180 getPcaModel().calculate();
182 xCombobox.setSelectedIndex(0);
183 yCombobox.setSelectedIndex(1);
184 zCombobox.setSelectedIndex(2);
186 getPcaModel().updateRc(getRotatableCanvas());
188 setTop(getPcaModel().getTop());
190 } catch (OutOfMemoryError er)
192 new OOMWarning("calculating PCA", er);
197 progress.setProgressBar("", progId);
201 if (getParent() == null)
203 Desktop.addInternalFrame(this,
204 MessageManager.formatMessage("label.calc_title", "PCA",
205 getPcaModel().getScoreModelName()),
212 * Updates the PCA display after a change of component to use for x, y or z
216 protected void doDimensionChange()
223 int dim1 = getTop() - xCombobox.getSelectedIndex();
224 int dim2 = getTop() - yCombobox.getSelectedIndex();
225 int dim3 = getTop() - zCombobox.getSelectedIndex();
226 getPcaModel().updateRcView(dim1, dim2, dim3);
227 getRotatableCanvas().resetView();
231 * Sets the selected checkbox item index for PCA dimension (1, 2, 3...) for
232 * the given axis (X/Y/Z)
237 public void setSelectedDimensionIndex(int index, Axis axis)
242 xCombobox.setSelectedIndex(index);
245 yCombobox.setSelectedIndex(index);
248 zCombobox.setSelectedIndex(index);
255 protected void outputValues_actionPerformed()
257 CutAndPasteTransfer cap = new CutAndPasteTransfer();
260 cap.setText(getPcaModel().getDetails());
261 Desktop.addInternalFrame(cap,
262 MessageManager.getString("label.pca_details"), 500, 500);
263 } catch (OutOfMemoryError oom)
265 new OOMWarning("opening PCA details", oom);
271 protected void showLabels_actionPerformed()
273 getRotatableCanvas().showLabels(showLabels.getState());
277 protected void print_actionPerformed()
279 PCAPrinter printer = new PCAPrinter();
284 * If available, shows the data which formed the inputs for the PCA as a new
288 public void originalSeqData_actionPerformed()
290 // JAL-2647 disabled after load from project (until save to project done)
291 if (getPcaModel().getInputData() == null)
294 "Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
297 // decide if av alignment is sufficiently different to original data to
298 // warrant a new window to be created
299 // create new alignment window with hidden regions (unhiding hidden regions
300 // yields unaligned seqs)
301 // or create a selection box around columns in alignment view
302 // test Alignment(SeqCigar[])
306 // we try to get the associated view's gap character
307 // but this may fail if the view was closed...
308 gc = av.getGapCharacter();
309 } catch (Exception ex)
313 Object[] alAndColsel = getPcaModel().getInputData()
314 .getAlignmentAndHiddenColumns(gc);
316 if (alAndColsel != null && alAndColsel[0] != null)
318 // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
320 AlignmentI al = new Alignment((SequenceI[]) alAndColsel[0]);
321 AlignmentI dataset = (av != null && av.getAlignment() != null)
322 ? av.getAlignment().getDataset()
326 al.setDataset(dataset);
332 AlignFrame af = new AlignFrame(al, (HiddenColumns) alAndColsel[1],
333 AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
335 // >>>This is a fix for the moment, until a better solution is
337 // af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());
339 // af.addSortByOrderMenuItem(ServiceName + " Ordering",
342 Desktop.addInternalFrame(af, MessageManager.formatMessage(
343 "label.original_data_for_params", new String[]
344 { this.title }), AlignFrame.DEFAULT_WIDTH,
345 AlignFrame.DEFAULT_HEIGHT);
349 * CutAndPasteTransfer cap = new CutAndPasteTransfer(); for (int i = 0; i <
350 * seqs.length; i++) { cap.appendText(new jalview.util.Format("%-" + 15 +
351 * "s").form( seqs[i].getName())); cap.appendText(" " + seqstrings[i] +
354 * Desktop.addInternalFrame(cap, "Original Data", 400, 400);
358 class PCAPrinter extends Thread implements Printable
363 PrinterJob printJob = PrinterJob.getPrinterJob();
364 PageFormat defaultPage = printJob.defaultPage();
365 PageFormat pf = printJob.pageDialog(defaultPage);
367 if (defaultPage == pf)
375 printJob.setPrintable(this, pf);
377 if (printJob.printDialog())
382 } catch (Exception PrintException)
384 PrintException.printStackTrace();
390 public int print(Graphics pg, PageFormat pf, int pi)
391 throws PrinterException
393 pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
395 getRotatableCanvas().drawBackground(pg);
396 getRotatableCanvas().drawScene(pg);
397 if (getRotatableCanvas().drawAxes)
399 getRotatableCanvas().drawAxes(pg);
404 return Printable.PAGE_EXISTS;
408 return Printable.NO_SUCH_PAGE;
414 * Handler for 'Save as EPS' option
417 protected void eps_actionPerformed()
419 makePCAImage(ImageMaker.TYPE.EPS);
423 * Handler for 'Save as PNG' option
426 protected void png_actionPerformed()
428 makePCAImage(ImageMaker.TYPE.PNG);
431 void makePCAImage(ImageMaker.TYPE type)
433 int width = getRotatableCanvas().getWidth();
434 int height = getRotatableCanvas().getHeight();
436 String dialogTitle = MessageManager
437 .formatMessage("label.make_pca_image", type.getName());
438 String imageTitle = type == PNG ? null : this.getTitle();
439 ImageMaker im = new ImageMaker(this, type, dialogTitle, width, height,
440 null, imageTitle, null, 0, false);
442 if (im.getGraphics() != null)
444 getRotatableCanvas().drawBackground(im.getGraphics());
445 getRotatableCanvas().drawScene(im.getGraphics());
446 if (getRotatableCanvas().drawAxes)
448 getRotatableCanvas().drawAxes(im.getGraphics());
455 protected void viewMenu_menuSelected()
457 buildAssociatedViewMenu();
461 * Builds the menu showing the choice of possible views (for the associated
462 * sequence data) to which the PCA may be linked
464 void buildAssociatedViewMenu()
466 AlignmentPanel[] aps = PaintRefresher
467 .getAssociatedPanels(av.getSequenceSetId());
468 if (aps.length == 1 && getRotatableCanvas().av == aps[0].av)
470 associateViewsMenu.setVisible(false);
474 associateViewsMenu.setVisible(true);
477 .getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
479 viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
482 associateViewsMenu.removeAll();
484 JRadioButtonMenuItem item;
485 ButtonGroup buttonGroup = new ButtonGroup();
486 int iSize = aps.length;
488 for (int i = 0; i < iSize; i++)
490 final AlignmentPanel panel = aps[i];
491 item = new JRadioButtonMenuItem(panel.av.getViewName(),
492 panel.av == getRotatableCanvas().av);
493 buttonGroup.add(item);
494 item.addActionListener(new ActionListener()
497 public void actionPerformed(ActionEvent evt)
499 selectAssociatedView(panel);
503 associateViewsMenu.add(item);
506 final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem(
509 buttonGroup.add(itemf);
511 itemf.setSelected(getRotatableCanvas().isApplyToAllViews());
512 itemf.addActionListener(new ActionListener()
515 public void actionPerformed(ActionEvent evt)
517 getRotatableCanvas().setApplyToAllViews(itemf.isSelected());
520 associateViewsMenu.add(itemf);
528 * jalview.jbgui.GPCAPanel#outputPoints_actionPerformed(java.awt.event.ActionEvent
532 protected void outputPoints_actionPerformed()
534 CutAndPasteTransfer cap = new CutAndPasteTransfer();
537 cap.setText(getPcaModel().getPointsasCsv(false,
538 xCombobox.getSelectedIndex(), yCombobox.getSelectedIndex(),
539 zCombobox.getSelectedIndex()));
540 Desktop.addInternalFrame(cap, MessageManager
541 .formatMessage("label.points_for_params", new String[]
542 { this.getTitle() }), 500, 500);
543 } catch (OutOfMemoryError oom)
545 new OOMWarning("exporting PCA points", oom);
554 * jalview.jbgui.GPCAPanel#outputProjPoints_actionPerformed(java.awt.event
558 protected void outputProjPoints_actionPerformed()
560 CutAndPasteTransfer cap = new CutAndPasteTransfer();
563 cap.setText(getPcaModel().getPointsasCsv(true,
564 xCombobox.getSelectedIndex(), yCombobox.getSelectedIndex(),
565 zCombobox.getSelectedIndex()));
566 Desktop.addInternalFrame(cap, MessageManager.formatMessage(
567 "label.transformed_points_for_params", new String[]
568 { this.getTitle() }), 500, 500);
569 } catch (OutOfMemoryError oom)
571 new OOMWarning("exporting transformed PCA points", oom);
579 * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
582 public void setProgressBar(String message, long id)
584 progressBar.setProgressBar(message, id);
585 // if (progressBars == null)
587 // progressBars = new Hashtable();
588 // progressBarHandlers = new Hashtable();
591 // JPanel progressPanel;
592 // Long lId = Long.valueOf(id);
593 // GridLayout layout = (GridLayout) statusPanel.getLayout();
594 // if (progressBars.get(lId) != null)
596 // progressPanel = (JPanel) progressBars.get(Long.valueOf(id));
597 // statusPanel.remove(progressPanel);
598 // progressBars.remove(lId);
599 // progressPanel = null;
600 // if (message != null)
602 // statusBar.setText(message);
604 // if (progressBarHandlers.contains(lId))
606 // progressBarHandlers.remove(lId);
608 // layout.setRows(layout.getRows() - 1);
612 // progressPanel = new JPanel(new BorderLayout(10, 5));
614 // JProgressBar progressBar = new JProgressBar();
615 // progressBar.setIndeterminate(true);
617 // progressPanel.add(new JLabel(message), BorderLayout.WEST);
618 // progressPanel.add(progressBar, BorderLayout.CENTER);
620 // layout.setRows(layout.getRows() + 1);
621 // statusPanel.add(progressPanel);
623 // progressBars.put(lId, progressPanel);
626 // // setMenusForViewport();
631 public void registerHandler(final long id,
632 final IProgressIndicatorHandler handler)
634 progressBar.registerHandler(id, handler);
635 // if (progressBarHandlers == null || !progressBars.contains(Long.valueOf(id)))
638 // Error(MessageManager.getString("error.call_setprogressbar_before_registering_handler"));
640 // progressBarHandlers.put(Long.valueOf(id), handler);
641 // final JPanel progressPanel = (JPanel) progressBars.get(Long.valueOf(id));
642 // if (handler.canCancel())
644 // JButton cancel = new JButton(
645 // MessageManager.getString("action.cancel"));
646 // final IProgressIndicator us = this;
647 // cancel.addActionListener(new ActionListener()
651 // public void actionPerformed(ActionEvent e)
653 // handler.cancelActivity(id);
654 // us.setProgressBar(MessageManager.formatMessage("label.cancelled_params",
655 // new String[]{((JLabel) progressPanel.getComponent(0)).getText()}), id);
658 // progressPanel.add(cancel, BorderLayout.EAST);
664 * @return true if any progress bars are still active
667 public boolean operationInProgress()
669 return progressBar.operationInProgress();
673 protected void resetButton_actionPerformed()
676 setTop(0); // ugly - prevents dimensionChanged events from being processed
677 xCombobox.setSelectedIndex(0);
678 yCombobox.setSelectedIndex(1);
680 zCombobox.setSelectedIndex(2);
684 * Answers true if PCA calculation is in progress, else false
688 public boolean isWorking()
694 * Answers the selected checkbox item index for PCA dimension for the X, Y or
695 * Z axis of the display
700 public int getSelectedDimensionIndex(Axis axis)
705 return xCombobox.getSelectedIndex();
707 return yCombobox.getSelectedIndex();
709 return zCombobox.getSelectedIndex();
713 public void setShowLabels(boolean show)
715 showLabels.setSelected(show);
719 * Sets the input data used to calculate the PCA. This is provided for
720 * 'restore from project', which does not currently support this (AL-2647), so
721 * sets the value to null, and hides the menu option for "Input Data...". J
725 public void setInputData(AlignmentView data)
727 getPcaModel().setInputData(data);
728 originalSeqData.setVisible(data != null);
731 public AlignViewportI getAlignViewport()
736 public PCAModel getPcaModel()
741 public void setPcaModel(PCAModel pcaModel)
743 this.pcaModel = pcaModel;
746 public RotatableCanvas getRotatableCanvas()
751 public void setRotatableCanvas(RotatableCanvas rc)
761 public void setTop(int top)
767 * set the associated view for this PCA.
771 public void selectAssociatedView(AlignmentPanel panel)
773 getRotatableCanvas().setApplyToAllViews(false);
778 getRotatableCanvas().av = panel.av;
779 getRotatableCanvas().ap = panel;
780 PaintRefresher.Register(PCAPanel.this, panel.av.getSequenceSetId());