src/jalview/analysis/PaSiMap.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.analysis;
  22
  23 import jalview.api.analysis.ScoreModelI;
  24 import jalview.api.analysis.SimilarityParamsI;
  25 import jalview.bin.Console;
  26 import jalview.datamodel.AlignmentView;
  27 import jalview.datamodel.Point;
  28 import jalview.datamodel.SequenceI;
  29 import jalview.gui.PairwiseAlignPanel;
  30 import jalview.gui.PaSiMapPanel;
  31 import jalview.math.Matrix;
  32 import jalview.math.MatrixI;
  33 import jalview.viewmodel.AlignmentViewport;
  34
  35
  36 import java.io.PrintStream;
  37 import java.util.Hashtable;
  38 import java.util.Enumeration;
  39
  40 /**
  41  * Performs Principal Component Analysis on given sequences
  42  * @AUTHOR MorellThomas
  43  */
  44 public class PaSiMap implements Runnable
  45 {
  46   /*
  47    * inputs
  48    */
  49   final private AlignmentViewport seqs;
  50
  51   final private ScoreModelI scoreModel;
  52
  53   final private SimilarityParamsI similarityParams;
  54
  55   final private byte dim = 3;
  56
  57   /*
  58    * outputs
  59    */
  60   private MatrixI pairwiseScores;
  61
  62   private MatrixI eigenMatrix;
  63
  64   /**
  65    * Constructor given the sequences to compute for, the similarity model to
  66    * use, and a set of parameters for sequence comparison
  67    *
  68    * @param sequences
  69    * @param sm
  70    * @param options
  71    */
  72   public PaSiMap(AlignmentViewport sequences, ScoreModelI sm,
  73           SimilarityParamsI options)
  74   {
  75     this.seqs = sequences;
  76     this.scoreModel = sm;
  77     this.similarityParams = options;
  78   }
  79
  80   /**
  81    * Returns Eigenvalue
  82    *
  83    * @param i
  84    *          Index of diagonal within matrix
  85    *
  86    * @return Returns value of diagonal from matrix
  87    */
  88   public double getEigenvalue(int i)
  89   {
  90     return eigenMatrix.getD()[i];
  91   }
  92
  93   /**
  94    * Returns coordinates for each datapoint
  95    *
  96    * @param l
  97    *          DOCUMENT ME!
  98    * @param n
  99    *          DOCUMENT ME!
 100    * @param mm
 101    *          DOCUMENT ME!
 102    * @param factor ~ is 1
 103    *
 104    * @return DOCUMENT ME!
 105    */
 106   public Point[] getComponents(int l, int n, int mm, float factor)
 107   {
 108     Point[] out = new Point[getHeight()];
 109
 110     for (int i = 0; i < out.length; i++)
 111     {
 112       float x = (float) component(i, l) * factor;
 113       float y = (float) component(i, n) * factor;
 114       float z = (float) component(i, mm) * factor;
 115       out[i] = new Point(x, y, z);
 116     }
 117
 118     return out;
 119   }
 120
 121   /**
 122    * DOCUMENT ME!
 123    *
 124    * @param n
 125    *          DOCUMENT ME!
 126    *
 127    * @return DOCUMENT ME!
 128    */
 129   public double[] component(int n)
 130   {
 131     // n = index of eigenvector
 132     double[] out = new double[getHeight()];
 133
 134     for (int i = 0; i < out.length; i++)
 135     {
 136       out[i] = component(i, n);
 137     }
 138
 139     return out;
 140   }
 141
 142   /**
 143    * DOCUMENT ME!
 144    *
 145    * @param row
 146    *          DOCUMENT ME!
 147    * @param n
 148    *          DOCUMENT ME!
 149    *
 150    * @return DOCUMENT ME!
 151    */
 152   double component(int row, int n)
 153   {
 154     return eigenMatrix.getValue(row, n);
 155   }
 156
 157   /**
 158    * Answers a formatted text report of the PaSiMap calculation results (matrices
 159    * and eigenvalues) suitable for display
 160    *
 161    * @return
 162    */
 163   public String getDetails()
 164   {
 165     StringBuilder sb = new StringBuilder(1024);
 166     sb.append("PaSiMap calculation using ").append(scoreModel.getName())
 167             .append(" sequence similarity matrix\n========\n\n");
 168     PrintStream ps = wrapOutputBuffer(sb);
 169
 170     /*
 171      * coordinates matrix, with D vector
 172      */
 173     sb.append(" --- Pairwise correlation coefficients ---\n");
 174     pairwiseScores.print(ps, "%8.6f ");
 175     ps.println();
 176
 177     sb.append(" --- Eigenvalues ---\n");
 178     eigenMatrix.printD(ps, "%15.4e");
 179     ps.println();
 180
 181     sb.append(" --- Coordinates ---\n");
 182     eigenMatrix.print(ps, "%8.6f ");
 183     ps.println();
 184
 185     return sb.toString();
 186   }
 187
 188   /**
 189    * Performs the PaSiMap calculation
 190    *
 191    * creates a new gui/PairwiseAlignPanel with the input sequences (AlignmentViewport)
 192    * uses analysis/AlignSeq to creatue the pairwise alignments and calculate the AlignmentScores (float for each pair)
 193    * gets all float[][] scores from the gui/PairwiseAlignPanel
 194    * checks the connections for each sequence with AlignmentViewport seqs.calculateConnectivity(float[][] scores, int dim) (from analysis/Connectivity) -- throws an Exception if insufficient
 195    * creates a math/MatrixI pairwiseScores of the float[][] scores
 196    * copys the scores and fills the diagonal to create a symmetric matrix using math/Matrix.fillDiagonal()
 197    * performs the analysis/ccAnalysis with the symmetric matrix
 198    * gets the eigenmatrix and the eigenvalues using math/Matrix.tqli()
 199    */
 200   @Override
 201   public void run()
 202   {
 203     try
 204     {
 205       PairwiseAlignPanel alignment = new PairwiseAlignPanel(seqs, true, 100, 5);
 206       float[][] scores = alignment.getAlignmentScores();        //bigger index first -- eg scores[14][13]
 207
 208       Hashtable<SequenceI, Integer> connectivity = seqs.calculateConnectivity(scores, dim);
 209
 210       pairwiseScores = new Matrix(scores);
 211       pairwiseScores.fillDiagonal();
 212
 213       eigenMatrix = pairwiseScores.copy();
 214
 215       ccAnalysis cc = new ccAnalysis(pairwiseScores, dim);
 216       eigenMatrix = cc.run();
 217
 218     } catch (Exception q)
 219     {
 220       Console.error("Error computing PaSiMap:  " + q.getMessage());
 221       q.printStackTrace();
 222     }
 223   }
 224
 225   /**
 226    * Returns a PrintStream that wraps (appends its output to) the given
 227    * StringBuilder
 228    *
 229    * @param sb
 230    * @return
 231    */
 232   protected PrintStream wrapOutputBuffer(StringBuilder sb)
 233   {
 234     PrintStream ps = new PrintStream(System.out)
 235     {
 236       @Override
 237       public void print(String x)
 238       {
 239         sb.append(x);
 240       }
 241
 242       @Override
 243       public void println()
 244       {
 245         sb.append("\n");
 246       }
 247     };
 248     return ps;
 249   }
 250
 251   /**
 252    * Answers the N dimensions of the NxM PaSiMap matrix. This is the number of
 253    * sequences involved in the pairwise score calculation.
 254    *
 255    * @return
 256    */
 257   public int getHeight()
 258   {
 259     // TODO can any of seqs[] be null?
 260     return eigenMatrix.height();// seqs.getSequences().length;
 261   }
 262
 263   /**
 264    * Answers the M dimensions of the NxM PaSiMap matrix. This is the number of
 265    * sequences involved in the pairwise score calculation.
 266    *
 267    * @return
 268    */
 269   public int getWidth()
 270   {
 271     // TODO can any of seqs[] be null?
 272     return eigenMatrix.width();// seqs.getSequences().length;
 273   }
 274
 275   /**
 276    * Answers the sequence pairwise similarity scores which were the first step
 277    * of the PaSiMap calculation
 278    *
 279    * @return
 280    */
 281   public MatrixI getPairwiseScores()
 282   {
 283     return pairwiseScores;
 284   }
 285
 286   public void setPairwiseScores(MatrixI m)
 287   {
 288     pairwiseScores = m;
 289   }
 290
 291   public MatrixI getEigenmatrix()
 292   {
 293     return eigenMatrix;
 294   }
 295
 296   public void setEigenmatrix(MatrixI m)
 297   {
 298     eigenMatrix = m;
 299   }
 300 }