src/jalview/analysis/scoremodels/DistanceScoreModel.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.api.analysis.ScoreModelI;
  24 import jalview.api.analysis.SimilarityParamsI;
  25 import jalview.datamodel.AlignmentView;
  26 import jalview.math.MatrixI;
  27
  28 public abstract class DistanceScoreModel implements ScoreModelI
  29 {
  30   /**
  31    * A similarity score is calculated by first computing a distance score, and
  32    * then reversing the min-max range of the score values
  33    */
  34   @Override
  35   public MatrixI findSimilarities(AlignmentView seqData,
  36           SimilarityParamsI options)
  37   {
  38     MatrixI distances = findDistances(seqData, options);
  39
  40     MatrixI similarities = distanceToSimilarity(distances);
  41
  42     return similarities;
  43   }
  44
  45   /**
  46    * Converts distance scores to similarity scores, by reversing the range of
  47    * score values so that max becomes min and vice versa. The input matrix is
  48    * not modified.
  49    *
  50    * @param distances
  51    */
  52   public static MatrixI distanceToSimilarity(MatrixI distances)
  53   {
  54     MatrixI similarities = distances.copy();
  55
  56     similarities.reverseRange(false);
  57
  58     return similarities;
  59   }
  60 }