X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fanalysis%2Fscoremodels%2FScoreMatrix.java;h=f7da9f3f8845db6fc737532a85f34aaa68299621;hb=81f1e29b00bc98403d45d2258da71ac19c425c57;hp=51d8276575dfe557a29801aa42a2ccff2a9fd772;hpb=fcb39fa3bc47777bf4e0eb209f765dd254dc3cb9;p=jalview.git diff --git a/src/jalview/analysis/scoremodels/ScoreMatrix.java b/src/jalview/analysis/scoremodels/ScoreMatrix.java index 51d8276..f7da9f3 100644 --- a/src/jalview/analysis/scoremodels/ScoreMatrix.java +++ b/src/jalview/analysis/scoremodels/ScoreMatrix.java @@ -20,10 +20,37 @@ */ package jalview.analysis.scoremodels; +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.util.Arrays; -public class ScoreMatrix implements PairwiseScoreModelI +/** + * A class that models a substitution score matrix for any given alphabet of + * symbols + */ +public class ScoreMatrix implements SimilarityScoreModelI, + PairwiseScoreModelI { + /* + * this fields records which gap character (if any) is used in the alphabet; + * space, dash or dot are recognised as gap symbols + */ + private char gapCharacter = '0'; + + /* + * 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; + public static final short UNMAPPED = (short) -1; private static final String BAD_ASCII_ERROR = "Unexpected character %s in getPairwiseScore"; @@ -32,10 +59,16 @@ public class ScoreMatrix implements PairwiseScoreModelI /* * 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; @@ -58,19 +91,35 @@ public class ScoreMatrix implements PairwiseScoreModelI 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); @@ -91,17 +140,25 @@ public class ScoreMatrix implements PairwiseScoreModelI * Mappings are added automatically for lower case symbols (for non case * sensitive scoring), unless they are explicitly present in the alphabet (are * scored separately in the score matrix). + *
+ * the gap character (space, dash or dot) included in the alphabet (if any) is
+ * recorded in a field
*
* @param alphabet
* @return
*/
- static short[] buildSymbolIndex(char[] alphabet)
+ short[] buildSymbolIndex(char[] alphabet)
{
short[] index = new short[MAX_ASCII + 1];
Arrays.fill(index, UNMAPPED);
short pos = 0;
for (char c : alphabet)
{
+ if (Comparison.isGap(c))
+ {
+ gapCharacter = c;
+ }
+
if (c <= MAX_ASCII)
{
index[c] = pos;
@@ -130,6 +187,12 @@ public class ScoreMatrix implements PairwiseScoreModelI
}
@Override
+ public String getDescription()
+ {
+ return description;
+ }
+
+ @Override
public boolean isDNA()
{
return !peptide;
@@ -142,16 +205,22 @@ public class ScoreMatrix implements PairwiseScoreModelI
}
/**
- * Returns 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).
+ * 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;
}
/**
@@ -176,6 +245,19 @@ public class ScoreMatrix implements PairwiseScoreModelI
}
/**
+ * Answers the matrix index for the gap 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.
+ *
+ * @return
+ * @see #getMatrix()
+ */
+ public int getGapIndex()
+ {
+ return getMatrixIndex(gapCharacter);
+ }
+
+ /**
* Returns the pairwise score for substituting c with d, or zero if c or d is
* an unscored or unexpected character
*/
@@ -212,7 +294,12 @@ public class ScoreMatrix implements PairwiseScoreModelI
}
/**
- * 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 */ @@ -228,6 +315,11 @@ public class ScoreMatrix implements PairwiseScoreModelI sb.append("
" : ""); } + else + { + sb.append("ScoreMatrix ").append(getName()).append("\n"); + sb.append(symbols).append("\n"); + } for (char sym : symbols) { if (html) @@ -265,4 +357,180 @@ public class ScoreMatrix implements PairwiseScoreModelI } return sb.toString(); } + + /** + * Answers the number of symbols coded for (also equal to the number of rows + * and columns of the score matrix) + * + * @return + */ + public int getSize() + { + return symbols.length; + } + + /** + * Computes an NxN matrix where N is the number of sequences, and entry [i, j] + * is sequence[i] pairwise multiplied with sequence[j], as a sum of scores + * computed using the current score matrix. For example + * |
---|