src/jalview/api/analysis/SimilarityScoreModelI.java

   1 package jalview.api.analysis;
   2
   3 import jalview.datamodel.AlignmentView;
   4 import jalview.math.MatrixI;
   5
   6 /**
   7  * A class that provides a method to compute similarity scores of pairs of
   8  * sequences
   9  *
  10  * @author gmcarstairs
  11  *
  12  */
  13 public interface SimilarityScoreModelI extends ScoreModelI
  14 {
  15   /**
  16    * Returns a similarity score for the given sequence regions, that is, a
  17    * matrix whose value [i][j] is the similarity of sequence i to sequence j by
  18    * some measure. The options parameter provides configuration choices for how
  19    * the similarity score is calculated.
  20    *
  21    * @param seqData
  22    * @param options
  23    * @return
  24    */
  25   MatrixI findSimilarities(AlignmentView seqData, SimilarityParamsI options);
  26 }