src/jalview/viewmodel/PaSiMapModel.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.viewmodel;
  22
  23 import jalview.analysis.PaSiMap;
  24 import jalview.api.RotatableCanvasI;
  25 import jalview.api.analysis.ScoreModelI;
  26 import jalview.api.analysis.SimilarityParamsI;
  27 import jalview.datamodel.AlignmentView;
  28 import jalview.datamodel.Point;
  29 import jalview.datamodel.SequenceI;
  30 import jalview.datamodel.SequencePoint;
  31 import jalview.viewmodel.AlignmentViewport;
  32
  33 import java.util.List;
  34 import java.util.Vector;
  35
  36 public class PaSiMapModel
  37 {
  38   /*
  39    * inputs
  40    */
  41   //private AlignmentView inputData;
  42   //&!
  43   private AlignmentViewport inputData;
  44
  45   private final SequenceI[] seqs;
  46
  47   private final SimilarityParamsI similarityParams;
  48
  49   /*
  50    * options - score model, nucleotide / protein
  51    */
  52   private ScoreModelI scoreModel;
  53
  54   private boolean nucleotide = false;
  55
  56   /*
  57    * outputs
  58    */
  59   private PaSiMap pasimap;
  60
  61   int top;
  62
  63   private List<SequencePoint> points;
  64
  65   /**
  66    * Constructor given sequence data, score model and score calculation
  67    * parameter options.
  68    *
  69    * @param seqData
  70    * @param sqs
  71    * @param nuc
  72    * @param modelName
  73    * @param params
  74    */
  75   //public PaSiMapModel(AlignmentView seqData, SequenceI[] sqs, boolean nuc,
  76   //&!  viewport or panel?
  77   public PaSiMapModel(AlignmentViewport seqData, SequenceI[] sqs, boolean nuc,
  78           ScoreModelI modelName, SimilarityParamsI params)
  79   {
  80     inputData = seqData;
  81     seqs = sqs;
  82     nucleotide = nuc;
  83     scoreModel = modelName;
  84     similarityParams = params;
  85   }
  86
  87   /**
  88    * Performs the PaSiMap calculation (in the same thread) and extracts result data
  89    * needed for visualisation by PaSiMapPanel
  90    */
  91   public void calculate()
  92   {
  93     pasimap = new PaSiMap(inputData, scoreModel, similarityParams);
  94     pasimap.run(); // executes in same thread, wait for completion
  95
  96     // Now find the component coordinates
  97     int ii = 0;
  98
  99     while ((ii < seqs.length) && (seqs[ii] != null))
 100     {
 101       ii++;
 102     }
 103
 104     int height = pasimap.getHeight();
 105     // top = pasimap.getM().height() - 1;
 106     top = height - 1;
 107
 108     points = new Vector<>();
 109     Point[] scores = pasimap.getComponents(top - 1, top - 2, top - 3, 100);
 110
 111     for (int i = 0; i < height; i++)
 112     {
 113       SequencePoint sp = new SequencePoint(seqs[i], scores[i]);
 114       points.add(sp);
 115     }
 116   }
 117
 118   public void updateRc(RotatableCanvasI rc)
 119   {
 120     rc.setPoints(points, pasimap.getHeight());
 121   }
 122
 123   public boolean isNucleotide()
 124   {
 125     return nucleotide;
 126   }
 127
 128   public void setNucleotide(boolean nucleotide)
 129   {
 130     this.nucleotide = nucleotide;
 131   }
 132
 133   /**
 134    * Answers the index of the principal dimension of the PaSiMap
 135    *
 136    * @return
 137    */
 138   public int getTop()
 139   {
 140     return top;
 141   }
 142
 143   public void setTop(int t)
 144   {
 145     top = t;
 146   }
 147
 148   /**
 149    * Updates the 3D coordinates for the list of points to the given dimensions.
 150    * Principal dimension is getTop(). Next greatest eigenvector is getTop()-1.
 151    * Note - pasimap.getComponents starts counting the spectrum from rank-2 to zero,
 152    * rather than rank-1, so getComponents(dimN ...) == updateRcView(dimN+1 ..)
 153    *
 154    * @param dim1
 155    * @param dim2
 156    * @param dim3
 157    */
 158   public void updateRcView(int dim1, int dim2, int dim3)
 159   {
 160     // note: actual indices for components are dim1-1, etc (patch for JAL-1123)
 161     Point[] scores = pasimap.getComponents(dim1 - 1, dim2 - 1, dim3 - 1, 100);
 162
 163     for (int i = 0; i < pasimap.getHeight(); i++)
 164     {
 165       points.get(i).coord = scores[i];
 166     }
 167   }
 168
 169   public String getDetails()
 170   {
 171     return pasimap.getDetails();
 172   }
 173
 174   //&!
 175   //public AlignmentView getInputData()
 176   public AlignmentViewport getInputData()
 177   {
 178     return inputData;
 179   }
 180
 181   //&!
 182   //public void setInputData(AlignmentView data)
 183   public void setInputData(AlignmentViewport data)
 184   {
 185     inputData = data;
 186   }
 187
 188   public String getPointsasCsv(boolean transformed, int xdim, int ydim,
 189           int zdim)
 190   {
 191     StringBuffer csv = new StringBuffer();
 192     csv.append("\"Sequence\"");
 193     if (transformed)
 194     {
 195       csv.append(",");
 196       csv.append(xdim);
 197       csv.append(",");
 198       csv.append(ydim);
 199       csv.append(",");
 200       csv.append(zdim);
 201     }
 202     else
 203     {
 204       for (int d = 1, dmax = pasimap.component(1).length; d <= dmax; d++)
 205       {
 206         csv.append("," + d);
 207       }
 208     }
 209     csv.append("\n");
 210     for (int s = 0; s < seqs.length; s++)
 211     {
 212       csv.append("\"" + seqs[s].getName() + "\"");
 213       double fl[];
 214       if (!transformed)
 215       {
 216         // output pasimap in correct order
 217         fl = pasimap.component(s);
 218         for (int d = fl.length - 1; d >= 0; d--)
 219         {
 220           csv.append(",");
 221           csv.append(fl[d]);
 222         }
 223       }
 224       else
 225       {
 226         Point p = points.get(s).coord;
 227         csv.append(",").append(p.x);
 228         csv.append(",").append(p.y);
 229         csv.append(",").append(p.z);
 230       }
 231       csv.append("\n");
 232     }
 233     return csv.toString();
 234   }
 235
 236   public String getScoreModelName()
 237   {
 238     return scoreModel == null ? "" : scoreModel.getName();
 239   }
 240
 241   public void setScoreModel(ScoreModelI sm)
 242   {
 243     this.scoreModel = sm;
 244   }
 245
 246   /**
 247    * Answers the parameters configured for pairwise similarity calculations
 248    *
 249    * @return
 250    */
 251   public SimilarityParamsI getSimilarityParameters()
 252   {
 253     return similarityParams;
 254   }
 255
 256   public List<SequencePoint> getSequencePoints()
 257   {
 258     return points;
 259   }
 260
 261   public void setSequencePoints(List<SequencePoint> sp)
 262   {
 263     points = sp;
 264   }
 265
 266   /**
 267    * Answers the object holding the values of the computed PaSiMap
 268    *
 269    * @return
 270    */
 271   public PaSiMap getPasimapData()
 272   {
 273     return pasimap;
 274   }
 275
 276   public void setPaSiMap(PaSiMap data)
 277   {
 278     pasimap = data;
 279   }
 280 }