src/jalview/analysis/scoremodels/PIDDistanceModel.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.DistanceScoreModelI;
  24 import jalview.api.analysis.SimilarityParamsI;
  25 import jalview.datamodel.AlignmentView;
  26 import jalview.math.Matrix;
  27 import jalview.math.MatrixI;
  28 import jalview.util.Comparison;
  29
  30 public class PIDDistanceModel implements DistanceScoreModelI
  31 {
  32
  33   @Override
  34   public MatrixI findDistances(AlignmentView seqData,
  35           SimilarityParamsI options)
  36   {
  37     String[] sequenceString = seqData
  38             .getSequenceStrings(Comparison.GAP_SPACE);
  39     int noseqs = sequenceString.length;
  40     double[][] distance = new double[noseqs][noseqs];
  41     for (int i = 0; i < (noseqs - 1); i++)
  42     {
  43       for (int j = i; j < noseqs; j++)
  44       {
  45         if (j == i)
  46         {
  47           distance[i][i] = 0;
  48         }
  49         else
  50         {
  51           distance[i][j] = 100 - Comparison.PID(sequenceString[i],
  52                   sequenceString[j]);
  53
  54           distance[j][i] = distance[i][j];
  55         }
  56       }
  57     }
  58     return new Matrix(distance);
  59   }
  60
  61   @Override
  62   public String getName()
  63   {
  64     return "PID";
  65   }
  66
  67   @Override
  68   public boolean isDNA()
  69   {
  70     return true;
  71   }
  72
  73   @Override
  74   public boolean isProtein()
  75   {
  76     return true;
  77   }
  78
  79   @Override
  80   public String toString()
  81   {
  82     return "Percentage identity of sequences";
  83   }
  84 }