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