src/jalview/analysis/scoremodels/FeatureScoreModel.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.ViewBasedAnalysisI;
  25 import jalview.datamodel.AlignmentView;
  26 import jalview.datamodel.SequenceFeature;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.util.Comparison;
  29
  30 import java.util.ArrayList;
  31 import java.util.Hashtable;
  32 import java.util.List;
  33
  34 public class FeatureScoreModel implements ScoreModelI, ViewBasedAnalysisI
  35 {
  36   jalview.api.FeatureRenderer fr;
  37
  38   @Override
  39   public boolean configureFromAlignmentView(
  40           jalview.api.AlignmentViewPanel view)
  41   {
  42     fr = view.cloneFeatureRenderer();
  43     return true;
  44   }
  45
  46   @Override
  47   public float[][] findDistances(AlignmentView seqData)
  48   {
  49     int nofeats = 0;
  50     List<String> dft = fr.getDisplayedFeatureTypes();
  51
  52     nofeats = dft.size();
  53
  54     SequenceI[] sequenceString = seqData.getVisibleAlignment(
  55             Comparison.GapChars.charAt(0)).getSequencesArray();
  56     int noseqs = sequenceString.length;
  57     int cpwidth = seqData.getWidth();
  58     float[][] distance = new float[noseqs][noseqs];
  59     if (nofeats == 0)
  60     {
  61       for (float[] d : distance)
  62       {
  63         for (int i = 0; i < d.length; d[i++] = 0f)
  64         {
  65           ;
  66         }
  67       }
  68       return distance;
  69     }
  70     float max = 0;
  71     for (int cpos = 0; cpos < cpwidth; cpos++)
  72     {
  73       // get visible features at cpos under view's display settings and compare
  74       // them
  75       List<Hashtable<String, SequenceFeature>> sfap = new ArrayList<Hashtable<String, SequenceFeature>>();
  76       for (int i = 0; i < noseqs; i++)
  77       {
  78         Hashtable<String, SequenceFeature> types = new Hashtable<String, SequenceFeature>();
  79         List<SequenceFeature> sfs = fr.findFeaturesAtRes(sequenceString[i],
  80                 sequenceString[i].findPosition(cpos));
  81         for (SequenceFeature sf : sfs)
  82         {
  83           types.put(sf.getType(), sf);
  84         }
  85         sfap.add(types);
  86       }
  87       for (int i = 0; i < (noseqs - 1); i++)
  88       {
  89         if (cpos == 0)
  90         {
  91           distance[i][i] = 0f;
  92         }
  93         for (int j = i + 1; j < noseqs; j++)
  94         {
  95           int sfcommon = 0;
  96           // compare the two lists of features...
  97           Hashtable<String, SequenceFeature> fi = sfap.get(i), fk, fj = sfap
  98                   .get(j);
  99           if (fi.size() > fj.size())
 100           {
 101             fk = fj;
 102           }
 103           else
 104           {
 105             fk = fi;
 106             fi = fj;
 107           }
 108           for (String k : fi.keySet())
 109           {
 110             SequenceFeature sfj = fk.get(k);
 111             if (sfj != null)
 112             {
 113               sfcommon++;
 114             }
 115           }
 116           distance[i][j] += (fi.size() + fk.size() - 2f * sfcommon);
 117           distance[j][i] += distance[i][j];
 118         }
 119       }
 120     }
 121     for (int i = 0; i < noseqs; i++)
 122     {
 123       for (int j = i + 1; j < noseqs; j++)
 124       {
 125         distance[i][j] /= cpwidth;
 126         distance[j][i] = distance[i][j];
 127       }
 128     }
 129     return distance;
 130   }
 131
 132   @Override
 133   public String getName()
 134   {
 135     return "Sequence Feature Similarity";
 136   }
 137
 138   @Override
 139   public boolean isDNA()
 140   {
 141     return true;
 142   }
 143
 144   @Override
 145   public boolean isProtein()
 146   {
 147     return true;
 148   }
 149
 150   @Override
 151   public String toString()
 152   {
 153     return "Score between sequences based on hamming distance between binary vectors marking features displayed at each column";
 154   }
 155 }