src/jalview/gui/PairwiseAlignPanel.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.AlignSeq;
  24 import jalview.datamodel.Alignment;
  25 import jalview.datamodel.AlignmentView;
  26 import jalview.datamodel.SequenceGroup;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.jbgui.GPairwiseAlignPanel;
  29 import jalview.util.MessageManager;
  30 import jalview.viewmodel.AlignmentViewport;
  31
  32 import java.awt.event.ActionEvent;
  33 import java.util.Vector;
  34
  35 /**
  36  * DOCUMENT ME!
  37  *
  38  * @author $author$
  39  * @version $Revision$
  40  */
  41 public class PairwiseAlignPanel extends GPairwiseAlignPanel
  42 {
  43
  44   private static final String DASHES = "---------------------\n";
  45
  46   private float[][] scores;
  47
  48   private float[][] alignmentScores;    // scores used by PaSiMap
  49
  50   private int GAP_OPEN_COST;
  51
  52   private int GAP_EXTEND_COST;
  53
  54   AlignmentViewport av;
  55
  56   Vector<SequenceI> sequences;
  57
  58   private String alignmentOutput;
  59
  60   /**
  61    * Creates a new PairwiseAlignPanel object.
  62    *
  63    * @param viewport
  64    *          DOCUMENT ME!
  65    * @param endGaps ~ toggle gaps and the beginning and end of sequences
  66    */
  67   public PairwiseAlignPanel(AlignmentViewport viewport)
  68   {
  69     this(viewport, false, 120, 20);     // default penalties used in AlignSeq
  70   }
  71   public PairwiseAlignPanel(AlignmentViewport viewport, boolean endGaps, int gapOpenCost, int gapExtendCost)
  72   {
  73     super();
  74     this.av = viewport;
  75
  76     StringBuilder sb = new StringBuilder(1024);
  77
  78     sequences = new Vector<SequenceI>();
  79
  80     SequenceGroup selectionGroup = viewport.getSelectionGroup();
  81     boolean isSelection = selectionGroup != null
  82             && selectionGroup.getSize() > 0;
  83     AlignmentView view = viewport.getAlignmentView(isSelection);
  84     // String[] seqStrings = viewport.getViewAsString(true);
  85     String[] seqStrings = view
  86             .getSequenceStrings(viewport.getGapCharacter());
  87
  88     SequenceI[] seqs;
  89     if (isSelection)
  90     {
  91       seqs = (SequenceI[]) view
  92               .getAlignmentAndHiddenColumns(viewport.getGapCharacter())[0];
  93     }
  94     else
  95     {
  96       seqs = av.getAlignment().getSequencesArray();
  97     }
  98
  99     String type = (viewport.getAlignment().isNucleotide()) ? AlignSeq.DNA
 100             : AlignSeq.PEP;
 101
 102     float[][] scores = new float[seqs.length][seqs.length];
 103     float[][] alignmentScores = new float[seqs.length][seqs.length];
 104     double totscore = 0D;
 105     int count = seqs.length;
 106     boolean first = true;
 107     //AlignSeq as = new AlignSeq(seqs[1], seqStrings[1], seqs[0], seqStrings[0], type, gapOpenCost, gapExtendCost);
 108
 109     for (int i = 1; i < count; i++)
 110     {
 111       // fill diagonal alignmentScores with Float.NaN
 112       alignmentScores[i-1][i-1] = Float.NaN;
 113       for (int j = 0; j < i; j++)
 114       {
 115         AlignSeq as = new AlignSeq(seqs[i], seqStrings[i], seqs[j],
 116                 seqStrings[j], type, gapOpenCost, gapExtendCost);
 117 //      as.seqInit(seqs[i], seqStrings[i], seqs[j], seqStrings[j], type);
 118
 119         if (as.s1str.length() == 0 || as.s2str.length() == 0)
 120         {
 121           continue;
 122         }
 123
 124         as.calcScoreMatrix();
 125         if (endGaps)
 126         {
 127           as.traceAlignmentWithEndGaps();
 128         } else {
 129           as.traceAlignment();
 130         }
 131         as.scoreAlignment();
 132
 133         if (!first)
 134         {
 135           System.out.println(DASHES);
 136           textarea.append(DASHES);
 137           sb.append(DASHES);
 138         }
 139         first = false;
 140         as.printAlignment(System.out);
 141         scores[i][j] = as.getMaxScore() / as.getASeq1().length;
 142         alignmentScores[i][j] = as.getAlignmentScore();
 143         totscore = totscore + scores[i][j];
 144
 145         textarea.append(as.getOutput());
 146         sb.append(as.getOutput());
 147         sequences.add(as.getAlignedSeq1());
 148         sequences.add(as.getAlignedSeq2());
 149       }
 150     }
 151     alignmentScores[count-1][count-1] = Float.NaN;
 152
 153     this.scores = scores;
 154     this.alignmentScores = alignmentScores;
 155
 156     if (count > 2)
 157     {
 158       printScoreMatrix(seqs, scores, totscore);
 159     }
 160
 161     alignmentOutput = sb.toString();
 162   }
 163
 164   public float[][] getScores()
 165   {
 166     return this.scores;
 167   }
 168
 169   public float[][] getAlignmentScores()
 170   {
 171     return this.alignmentScores;
 172   }
 173
 174   public String getAlignmentOutput()
 175   {
 176     return this.alignmentOutput;
 177   }
 178
 179   /**
 180    * Prints a matrix of seqi-seqj pairwise alignment scores to sysout
 181    *
 182    * @param seqs
 183    * @param scores
 184    * @param totscore
 185    */
 186   protected void printScoreMatrix(SequenceI[] seqs, float[][] scores,
 187           double totscore)
 188   {
 189     System.out
 190             .println("Pairwise alignment scaled similarity score matrix\n");
 191
 192     for (int i = 0; i < seqs.length; i++)
 193     {
 194       System.out.println(
 195               String.format("%3d %s", i + 1, seqs[i].getDisplayId(true)));
 196     }
 197
 198     /*
 199      * table heading columns for sequences 1, 2, 3...
 200      */
 201     System.out.print("\n ");
 202     for (int i = 0; i < seqs.length; i++)
 203     {
 204       System.out.print(String.format("%7d", i + 1));
 205     }
 206     System.out.println();
 207
 208     for (int i = 0; i < seqs.length; i++)
 209     {
 210       System.out.print(String.format("%3d", i + 1));
 211       for (int j = 0; j < i; j++)
 212       {
 213         /*
 214          * as a fraction of tot score, outputs are 0 <= score <= 1
 215          */
 216         System.out.print(String.format("%7.3f", scores[i][j] / totscore));
 217       }
 218       System.out.println();
 219     }
 220
 221     System.out.println("\n");
 222   }
 223
 224   /**
 225    * DOCUMENT ME!
 226    *
 227    * @param e
 228    *          DOCUMENT ME!
 229    */
 230   @Override
 231   protected void viewInEditorButton_actionPerformed(ActionEvent e)
 232   {
 233     SequenceI[] seq = new SequenceI[sequences.size()];
 234
 235     for (int i = 0; i < sequences.size(); i++)
 236     {
 237       seq[i] = sequences.elementAt(i);
 238     }
 239
 240     AlignFrame af = new AlignFrame(new Alignment(seq),
 241             AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 242
 243     Desktop.addInternalFrame(af,
 244             MessageManager.getString("label.pairwise_aligned_sequences"),
 245             AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 246   }
 247 }