JAL-838 added 'SeqSpace' PID mode, added parameters to findDistances and
[jalview.git] / src / jalview / analysis / scoremodels / SWDistanceModel.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.scoremodels;
22
23 import jalview.analysis.AlignSeq;
24 import jalview.api.analysis.DistanceScoreModelI;
25 import jalview.api.analysis.SimilarityParamsI;
26 import jalview.datamodel.AlignmentView;
27 import jalview.datamodel.SequenceI;
28 import jalview.math.Matrix;
29 import jalview.math.MatrixI;
30 import jalview.util.Comparison;
31
32 public class SWDistanceModel implements DistanceScoreModelI
33 {
34
35   @Override
36   public MatrixI findDistances(AlignmentView seqData,
37           SimilarityParamsI options)
38   {
39     SequenceI[] sequenceString = seqData.getVisibleAlignment(
40             Comparison.GAP_SPACE).getSequencesArray();
41     int noseqs = sequenceString.length;
42     double[][] distances = new double[noseqs][noseqs];
43
44     double max = -1;
45
46     for (int i = 0; i < (noseqs - 1); i++)
47     {
48       for (int j = i; j < noseqs; j++)
49       {
50         AlignSeq as = new AlignSeq(sequenceString[i], sequenceString[j],
51                 seqData.isNa() ? "dna" : "pep");
52         as.calcScoreMatrix();
53         as.traceAlignment();
54         as.printAlignment(System.out);
55         distances[i][j] = as.maxscore;
56
57         if (max < distances[i][j])
58         {
59           max = distances[i][j];
60         }
61       }
62     }
63
64     for (int i = 0; i < (noseqs - 1); i++)
65     {
66       for (int j = i; j < noseqs; j++)
67       {
68         distances[i][j] = max - distances[i][j];
69         distances[j][i] = distances[i][j];
70       }
71     }
72
73     return new Matrix(distances);
74   }
75
76   @Override
77   public String getName()
78   {
79     return "Smith Waterman Score";
80   }
81
82   @Override
83   public boolean isDNA()
84   {
85     return true;
86   }
87
88   @Override
89   public boolean isProtein()
90   {
91     return true;
92   }
93
94   @Override
95   public String toString()
96   {
97     return "Score between two sequences aligned with Smith Waterman with default Peptide/Nucleotide matrix";
98   }
99 }