X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fjalview%2Fanalysis%2Fscoremodels%2FScoreMatrix.java;h=b73f826e40a51c8f4fb745c7234fbfacb328261c;hb=dd97032c11b883017a9c8125ff30a58dfb2144bd;hp=3e63209aa7cb021e6789931e540086e1c67a3cdc;hpb=6129931bfa23eec90e6556a4d0412ef34aff5759;p=jalview.git
diff --git a/src/jalview/analysis/scoremodels/ScoreMatrix.java b/src/jalview/analysis/scoremodels/ScoreMatrix.java
index 3e63209..b73f826 100644
--- a/src/jalview/analysis/scoremodels/ScoreMatrix.java
+++ b/src/jalview/analysis/scoremodels/ScoreMatrix.java
@@ -20,23 +20,30 @@
*/
package jalview.analysis.scoremodels;
-import jalview.api.analysis.ScoreModelI;
+import jalview.api.analysis.PairwiseScoreModelI;
+import jalview.api.analysis.SimilarityParamsI;
+import jalview.api.analysis.SimilarityScoreModelI;
+import jalview.datamodel.AlignmentView;
+import jalview.math.Matrix;
+import jalview.math.MatrixI;
+import jalview.util.Comparison;
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
import java.util.Arrays;
-import java.util.StringTokenizer;
-public class ScoreMatrix extends PairwiseSeqScoreModel implements
- ScoreModelI
+public class ScoreMatrix implements SimilarityScoreModelI,
+ PairwiseScoreModelI
{
- public static final short UNMAPPED = (short) -1;
+ private static final char GAP_CHARACTER = Comparison.GAP_DASH;
- private static final String DELIMITERS = " ,\t";
+ /*
+ * Jalview 2.10.1 treated gaps as X (peptide) or N (nucleotide)
+ * for pairwise scoring; 2.10.2 uses gap score (last column) in
+ * score matrix (JAL-2397)
+ * Set this flag to true (via Groovy) for 2.10.1 behaviour
+ */
+ private static boolean scoreGapAsAny = false;
- private static final String COMMENT_CHAR = "#";
+ public static final short UNMAPPED = (short) -1;
private static final String BAD_ASCII_ERROR = "Unexpected character %s in getPairwiseScore";
@@ -44,10 +51,16 @@ public class ScoreMatrix extends PairwiseSeqScoreModel implements
/*
* the name of the model as shown in menus
+ * each score model in use should have a unique name
*/
private String name;
/*
+ * a description for the model as shown in tooltips
+ */
+ private String description;
+
+ /*
* the characters that the model provides scores for
*/
private char[] symbols;
@@ -70,19 +83,35 @@ public class ScoreMatrix extends PairwiseSeqScoreModel implements
private boolean peptide;
/**
- * Constructor
+ * Constructor given a name, symbol alphabet, and matrix of scores for pairs
+ * of symbols. The matrix should be square and of the same size as the
+ * alphabet, for example 20x20 for a 20 symbol alphabet.
*
- * @param name
+ * @param theName
* Unique, human readable name for the matrix
* @param alphabet
* the symbols to which scores apply
- * @param matrix
+ * @param values
* Pairwise scores indexed according to the symbol alphabet
*/
- public ScoreMatrix(String name, char[] alphabet, float[][] matrix)
+ public ScoreMatrix(String theName, char[] alphabet, float[][] values)
{
- this.matrix = matrix;
- this.name = name;
+ if (alphabet.length != values.length)
+ {
+ throw new IllegalArgumentException(
+ "score matrix size must match alphabet size");
+ }
+ for (float[] row : values)
+ {
+ if (row.length != alphabet.length)
+ {
+ throw new IllegalArgumentException(
+ "score matrix size must be square");
+ }
+ }
+
+ this.matrix = values;
+ this.name = theName;
this.symbols = alphabet;
symbolIndex = buildSymbolIndex(alphabet);
@@ -142,6 +171,12 @@ public class ScoreMatrix extends PairwiseSeqScoreModel implements
}
@Override
+ public String getDescription()
+ {
+ return description;
+ }
+
+ @Override
public boolean isDNA()
{
return !peptide;
@@ -153,10 +188,44 @@ public class ScoreMatrix extends PairwiseSeqScoreModel implements
return peptide;
}
- @Override
+ /**
+ * Returns a copy of the score matrix as used in getPairwiseScore. If using
+ * this matrix directly, callers must also call
+ * getMatrixIndex
in order to get the matrix index for each
+ * character (symbol).
+ *
+ * @return
+ * @see #getMatrixIndex(char)
+ */
public float[][] getMatrix()
{
- return matrix;
+ float[][] v = new float[matrix.length][matrix.length];
+ for (int i = 0; i < matrix.length; i++)
+ {
+ v[i] = Arrays.copyOf(matrix[i], matrix[i].length);
+ }
+ return v;
+ }
+
+ /**
+ * Answers the matrix index for a given character, or -1 if unmapped in the
+ * matrix. Use this method only if using getMatrix
in order to
+ * compute scores directly (without symbol lookup) for efficiency.
+ *
+ * @param c
+ * @return
+ * @see #getMatrix()
+ */
+ public int getMatrixIndex(char c)
+ {
+ if (c < symbolIndex.length)
+ {
+ return symbolIndex[c];
+ }
+ else
+ {
+ return UNMAPPED;
+ }
}
/**
@@ -166,12 +235,12 @@ public class ScoreMatrix extends PairwiseSeqScoreModel implements
@Override
public float getPairwiseScore(char c, char d)
{
- if (c > MAX_ASCII)
+ if (c >= symbolIndex.length)
{
System.err.println(String.format(BAD_ASCII_ERROR, c));
return 0;
}
- if (d > MAX_ASCII)
+ if (d >= symbolIndex.length)
{
System.err.println(String.format(BAD_ASCII_ERROR, d));
return 0;
@@ -196,7 +265,12 @@ public class ScoreMatrix extends PairwiseSeqScoreModel implements
}
/**
- * Print the score matrix, optionally formatted as html, with the alphabet symbols as column headings and at the start of each row
+ * Print the score matrix, optionally formatted as html, with the alphabet
+ * symbols as column headings and at the start of each row.
+ *
+ * The non-html format should give an output which can be parsed as a score + * matrix file + * * @param html * @return */ @@ -212,6 +286,11 @@ public class ScoreMatrix extends PairwiseSeqScoreModel implements sb.append("
" : ""); } + else + { + sb.append("ScoreMatrix ").append(getName()).append("\n"); + sb.append(symbols).append("\n"); + } for (char sym : symbols) { if (html) @@ -251,170 +330,178 @@ public class ScoreMatrix extends PairwiseSeqScoreModel implements } /** - * Parse a score matrix from the given input stream and returns a ScoreMatrix - * object. If parsing fails, error messages are written to syserr and null is - * returned. It is the caller's responsibility to close the input stream. - * Expected format: + * Answers the number of symbols coded for (also equal to the number of rows + * and columns of the score matrix) * - * |
---|