Multiple Views
[jalview.git] / src / jalview / gui / PCAPanel.java
index 8e0bc37..ea4f44e 100755 (executable)
+/*\r
+ * Jalview - A Sequence Alignment Editor and Viewer\r
+ * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ *\r
+ * This program is free software; you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License\r
+ * as published by the Free Software Foundation; either version 2\r
+ * of the License, or (at your option) any later version.\r
+ *\r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with this program; if not, write to the Free Software\r
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
+ */\r
 package jalview.gui;\r
 \r
+import jalview.analysis.*;\r
+\r
 import jalview.datamodel.*;\r
-import jalview.analysis.PCA;\r
+\r
 import jalview.jbgui.*;\r
+\r
 import java.awt.*;\r
 import java.awt.event.*;\r
+\r
 import java.util.*;\r
+import javax.swing.*;\r
+import java.awt.print.*;\r
 \r
 \r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
 public class PCAPanel extends GPCAPanel implements Runnable\r
 {\r
-  PCA pca;\r
-  int top;\r
-  RotatableCanvas rc;\r
-  AlignViewport av;\r
-\r
-  public void run()\r
-  {\r
-    // do stuff\r
-  }\r
+    PCA pca;\r
+    int top;\r
+    RotatableCanvas rc;\r
+    AlignViewport av;\r
+    AlignmentView seqstrings;\r
+    SequenceI  [] seqs;\r
+\r
+    /**\r
+     * Creates a new PCAPanel object.\r
+     *\r
+     * @param av DOCUMENT ME!\r
+     * @param s DOCUMENT ME!\r
+     */\r
+    public PCAPanel(AlignViewport av)\r
+    {\r
+        this.av = av;\r
+\r
+        boolean sameLength = true;\r
+\r
+        seqstrings = av.getAlignmentView(av.getSelectionGroup()!=null);\r
+        if(av.getSelectionGroup()==null)\r
+        {\r
+          seqs = av.alignment.getSequencesArray();\r
+        }\r
+        else\r
+        {\r
+          seqs = av.getSelectionGroup().getSequencesInOrder(av.alignment);\r
+        }\r
+        SeqCigar sq[]=seqstrings.getSequences();\r
+        int length = sq[0].getWidth();\r
+\r
+        for (int i = 0; i < seqs.length; i++)\r
+        {\r
+          if (sq[i].getWidth() != length)\r
+          {\r
+            sameLength = false;\r
+            break;\r
+          }\r
+        }\r
+\r
+        if (!sameLength)\r
+        {\r
+          JOptionPane.showMessageDialog(Desktop.desktop,\r
+                                        "The sequences must be aligned before calculating PCA.\n" +\r
+                                        "Try using the Pad function in the edit menu,\n" +\r
+                                        "or one of the multiple sequence alignment web services.",\r
+                                        "Sequences not aligned",\r
+                                        JOptionPane.WARNING_MESSAGE);\r
 \r
-  public PCAPanel(AlignViewport av, SequenceI[] s) {\r
+          return;\r
+        }\r
 \r
-    this.av = av;\r
-    if(av.getSelectionGroup().getSize()>3)\r
+\r
+        Desktop.addInternalFrame(this, "Principal component analysis",\r
+                               400, 400);\r
+\r
+\r
+        rc = new RotatableCanvas(av);\r
+        this.getContentPane().add(rc, BorderLayout.CENTER);\r
+        Thread worker = new Thread(this);\r
+        worker.start();\r
+    }\r
+\r
+    public void bgcolour_actionPerformed(ActionEvent e)\r
     {\r
-      s = new Sequence[av.getSelectionGroup().getSize()];\r
-      for(int i=0; i<s.length; i++)\r
-        s[i] = av.getSelectionGroup().getSequenceAt(i);\r
+      Color col = JColorChooser.showDialog(this, "Select Background Colour",\r
+                rc.bgColour);\r
+\r
+      if(col!=null)\r
+        rc.bgColour = col;\r
+      rc.repaint();\r
     }\r
 \r
 \r
-    if(s==null)\r
+\r
+\r
+    /**\r
+     * DOCUMENT ME!\r
+     */\r
+    public void run()\r
     {\r
-      s = new Sequence[av.getAlignment().getHeight()];\r
-      for (int i = 0; i < av.getAlignment().getHeight(); i++)\r
-        s[i] = av.getAlignment().getSequenceAt(i);\r
-     }\r
+      try{\r
+        pca = new PCA(seqstrings.getSequenceStrings(' '));\r
+        pca.run();\r
+\r
+        // Now find the component coordinates\r
+        int ii = 0;\r
 \r
-//////////////////////This part was done in PCATHread originally. Is it too slow???\r
-    pca = new PCA(s);\r
-    pca.run();\r
+        while ( (ii < seqs.length) && (seqs[ii] != null))\r
+        {\r
+          ii++;\r
+        }\r
 \r
-    // Now find the component coordinates\r
-    int ii=0;\r
-    while (ii < s.length && s[ii] != null)\r
+        double[][] comps = new double[ii][ii];\r
+\r
+        for (int i = 0; i < ii; i++)\r
+        {\r
+          if (pca.getEigenvalue(i) > 1e-4)\r
+          {\r
+            comps[i] = pca.component(i);\r
+          }\r
+        }\r
+\r
+        //////////////////\r
+        xCombobox.setSelectedIndex(0);\r
+        yCombobox.setSelectedIndex(1);\r
+        zCombobox.setSelectedIndex(2);\r
+\r
+        top = pca.getM().rows - 1;\r
+\r
+        Vector points = new Vector();\r
+        float[][] scores = pca.getComponents(top - 1, top - 2, top - 3, 100);\r
+\r
+        for (int i = 0; i < pca.getM().rows; i++)\r
+        {\r
+          SequencePoint sp = new SequencePoint(seqs[i], scores[i]);\r
+          points.addElement(sp);\r
+        }\r
+\r
+        rc.setPoints(points, pca.getM().rows);\r
+        rc.repaint();\r
+      }\r
+     catch(OutOfMemoryError er)\r
+      { JOptionPane.showInternalMessageDialog(Desktop.desktop,\r
+                                              "Out of memory calculating PCA!!"\r
+                                              +\r
+                                              "\nSee help files for increasing Java Virtual Machine memory."\r
+                                              , "Out of memory",\r
+                                              JOptionPane.WARNING_MESSAGE);\r
+        System.out.println("PCAPanel: "+er);\r
+        System.gc();\r
+\r
+      }\r
+\r
+    }\r
+\r
+    /**\r
+     * DOCUMENT ME!\r
+     */\r
+    void doDimensionChange()\r
     {\r
-      ii++;\r
+        if (top == 0)\r
+        {\r
+            return;\r
+        }\r
+\r
+        int dim1 = top - xCombobox.getSelectedIndex();\r
+        int dim2 = top - yCombobox.getSelectedIndex();\r
+        int dim3 = top - zCombobox.getSelectedIndex();\r
+\r
+        float[][] scores = pca.getComponents(dim1, dim2, dim3, 100);\r
+\r
+        for (int i = 0; i < pca.getM().rows; i++)\r
+        {\r
+            ((SequencePoint) rc.points.elementAt(i)).coord = scores[i];\r
+        }\r
+\r
+        rc.img = null;\r
+        rc.rotmat.setIdentity();\r
+        rc.initAxes();\r
+        rc.paint(rc.getGraphics());\r
     }\r
 \r
-    double[][] comps = new double[ii][ii];\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    protected void xCombobox_actionPerformed(ActionEvent e)\r
+    {\r
+        doDimensionChange();\r
+    }\r
 \r
-    for (int i=0; i < ii; i++ )\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    protected void yCombobox_actionPerformed(ActionEvent e)\r
     {\r
-      if (pca.getEigenvalue(i) > 1e-4)\r
-      {\r
-        comps[i]  = pca.component(i);\r
-      }\r
+        doDimensionChange();\r
+    }\r
+\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    protected void zCombobox_actionPerformed(ActionEvent e)\r
+    {\r
+        doDimensionChange();\r
     }\r
 \r
-    //////////////////\r
 \r
-    xCombobox.setSelectedIndex(0);\r
-    yCombobox.setSelectedIndex(1);\r
-    zCombobox.setSelectedIndex(2);\r
+    public void outputValues_actionPerformed(ActionEvent e)\r
+    {\r
+      CutAndPasteTransfer cap = new CutAndPasteTransfer();\r
+      Desktop.addInternalFrame(cap, "PCA details", 500,\r
+                500);\r
 \r
-    top = pca.getM().rows-1;\r
+      cap.setText(pca.getDetails());\r
+     }\r
 \r
-    Vector points = new Vector();\r
-    float[][] scores = pca.getComponents(top-1,top-2,top-3,100);\r
+    public void showLabels_actionPerformed(ActionEvent e)\r
+    {\r
+      rc.showLabels(showLabels.getState());\r
+    }\r
 \r
-    for (int i =0; i < pca.getM().rows; i++ )\r
+    public void print_actionPerformed(ActionEvent e)\r
     {\r
-      SequencePoint sp = new SequencePoint(s[i],scores[i]);\r
-      points.addElement(sp);\r
+      PCAPrinter printer = new PCAPrinter();\r
+      printer.start();\r
     }\r
 \r
-    rc = new RotatableCanvas(av,points,pca.getM().rows);\r
+    public void originalSeqData_actionPerformed(ActionEvent e)\r
+    {\r
+      // this was cut'n'pasted from the equivalent TreePanel method - we should make this an abstract function of all jalview analysis windows\r
+      if (seqstrings==null)\r
+      {\r
+        jalview.bin.Cache.log.info("Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");\r
+        return;\r
+      }\r
+      // decide if av alignment is sufficiently different to original data to warrant a new window to be created\r
+      // create new alignmnt window with hidden regions (unhiding hidden regions yields unaligned seqs)\r
+      // or create a selection box around columns in alignment view\r
+      // test Alignment(SeqCigar[])\r
+      Object[] alAndColsel = seqstrings.getAlignmentAndColumnSelection(av.\r
+          getGapCharacter());\r
 \r
-    //rc.printPoints();\r
 \r
-    add(rc, BorderLayout.CENTER);\r
-  }\r
+      if (alAndColsel != null && alAndColsel[0]!=null)\r
+      {\r
+          // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);\r
 \r
+          Alignment al = new Alignment((SequenceI[]) alAndColsel[0]);\r
+          Alignment dataset = av.getAlignment().getDataset();\r
+          if (dataset != null)\r
+          {\r
+            al.setDataset(dataset);\r
+          }\r
 \r
-  void doDimensionChange()\r
-  {\r
-    if(top==0)\r
-      return;\r
+          if (true)\r
+          {\r
+              // make a new frame!\r
+              AlignFrame af = new AlignFrame(al, (ColumnSelection) alAndColsel[1],\r
+                                           AlignFrame.DEFAULT_WIDTH,\r
+                                           AlignFrame.DEFAULT_HEIGHT\r
+);\r
 \r
-    int dim1 = top - xCombobox.getSelectedIndex();\r
-    int dim2 = top - yCombobox.getSelectedIndex();\r
-    int dim3 = top - zCombobox.getSelectedIndex();\r
+              //>>>This is a fix for the moment, until a better solution is found!!<<<\r
+              // af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());\r
 \r
-    float[][] scores  = pca.getComponents(dim1,dim2,dim3,100);\r
-    for (int i=0; i < pca.getM().rows; i++) {\r
-      ((SequencePoint)rc.points.elementAt(i)).coord = scores[i];\r
+              //           af.addSortByOrderMenuItem(ServiceName + " Ordering",\r
+              //                                     msaorder);\r
+\r
+              Desktop.addInternalFrame(af, "Original Data for " + this.title,\r
+                                       AlignFrame.DEFAULT_WIDTH,\r
+                                       AlignFrame.DEFAULT_HEIGHT);\r
+            }\r
+          }\r
+          /*      CutAndPasteTransfer cap = new CutAndPasteTransfer();\r
+                 for (int i = 0; i < seqs.length; i++)\r
+                 {\r
+                   cap.appendText(new jalview.util.Format("%-" + 15 + "s").form(\r
+            seqs[i].getName()));\r
+                   cap.appendText(" " + seqstrings[i] + "\n");\r
+\r
+                 }\r
+\r
+                 Desktop.addInternalFrame(cap, "Original Data",\r
+                     400, 400);\r
+           */\r
     }\r
 \r
-    rc.img = null;\r
-    rc.rotmat.setIdentity();\r
-    rc.initAxes();\r
-    rc.paint(rc.getGraphics());\r
-  }\r
 \r
-  protected void xCombobox_actionPerformed(ActionEvent e)\r
-  {\r
-    doDimensionChange();\r
-  }\r
 \r
-  protected void yCombobox_actionPerformed(ActionEvent e)\r
-  {\r
-    doDimensionChange();\r
-  }\r
+    class PCAPrinter extends Thread implements Printable\r
+    {\r
+      public void run()\r
+      {\r
+        PrinterJob printJob = PrinterJob.getPrinterJob();\r
+        PageFormat pf = printJob.pageDialog(printJob.defaultPage());\r
 \r
-  protected void zCombobox_actionPerformed(ActionEvent e)\r
-  {\r
-    doDimensionChange();\r
-  }\r
+        printJob.setPrintable(this, pf);\r
+\r
+        if (printJob.printDialog())\r
+        {\r
+          try\r
+          {\r
+            printJob.print();\r
+          }\r
+          catch (Exception PrintException)\r
+          {\r
+            PrintException.printStackTrace();\r
+          }\r
+        }\r
+      }\r
+\r
+      public int print(Graphics pg, PageFormat pf, int pi)\r
+          throws PrinterException\r
+      {\r
+        pg.translate( (int) pf.getImageableX(), (int) pf.getImageableY());\r
 \r
-}\r
+        rc.drawBackground(pg, rc.bgColour);\r
+        rc.drawScene(pg);\r
+        if (rc.drawAxes == true)\r
+        {\r
+          rc.drawAxes(pg);\r
+        }\r
+\r
+        if (pi == 0)\r
+          return Printable.PAGE_EXISTS;\r
+        else\r
+          return Printable.NO_SUCH_PAGE;\r
+      }\r
+    }\r
+\r
+\r
+\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void eps_actionPerformed(ActionEvent e)\r
+    {\r
+      makePCAImage(jalview.util.ImageMaker.EPS);\r
+    }\r
+\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void png_actionPerformed(ActionEvent e)\r
+    {\r
+       makePCAImage(jalview.util.ImageMaker.PNG);\r
+    }\r
+\r
+    void makePCAImage(int type)\r
+    {\r
+      int width = rc.getWidth();\r
+      int height = rc.getHeight();\r
+\r
+      jalview.util.ImageMaker im;\r
+\r
+      if(type == jalview.util.ImageMaker.PNG)\r
+        im = new jalview.util.ImageMaker(this,\r
+                                         jalview.util.ImageMaker.PNG,\r
+                                         "Make PNG image from PCA",\r
+                                         width, height,\r
+                                         null, null);\r
+        else\r
+          im = new jalview.util.ImageMaker(this,\r
+                                 jalview.util.ImageMaker.EPS,\r
+                                 "Make EPS file from PCA",\r
+                                 width, height,\r
+                                 null, this.getTitle());\r
+\r
+      if(im.getGraphics()!=null)\r
+       {\r
+         rc.drawBackground(im.getGraphics(), Color.black);\r
+         rc.drawScene(im.getGraphics());\r
+         if (rc.drawAxes == true)\r
+         {\r
+           rc.drawAxes(im.getGraphics());\r
+         }\r
+         im.writeImage();\r
+       }\r
+    }\r
+  }\r