src/jalview/schemes/Consensus.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer
   3  * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18  */
  19 package jalview.schemes;
  20
  21 ////////////////////////////////////////////
  22 // This does nothing at all at the moment!!!!!!!!!!
  23 // AW 15th Dec 2004
  24 /////////////////////////////////////////
  25 public class Consensus
  26 {
  27   int[] mask;
  28   double threshold;
  29   String maskstr;
  30
  31   public Consensus(String mask, double threshold)
  32   {
  33     // this.id = id;
  34     //    this.mask = mask;
  35     this.maskstr = mask;
  36     setMask(mask);
  37     this.threshold = threshold;
  38   }
  39
  40   public void setMask(String s)
  41   {
  42     this.mask = setNums(s);
  43
  44     //   for (int i=0; i < mask.length; i++) {
  45     //  System.out.println(mask[i] + " " + ResidueProperties.aa[mask[i]]);
  46     // }
  47   }
  48
  49   /**
  50    * @deprecated Use {@link #isConserved(int[][],int,int,boolean)} instead
  51    */
  52   public boolean isConserved(int[][] cons2, int col, int size)
  53   {
  54     return isConserved(cons2, col, size, true);
  55   }
  56
  57   public boolean isConserved(int[][] cons2, int col, int size, boolean includeGaps)
  58   {
  59     int tot = 0;
  60     if (!includeGaps)
  61     {
  62       size -= cons2[col][cons2[col].length-1];
  63     }
  64     for (int i = 0; i < mask.length; i++)
  65     {
  66       tot += cons2[col][mask[i]];
  67     }
  68
  69     if ( (double) tot > ( (threshold * size) / 100))
  70     {
  71         // System.out.println("True conserved "+tot+" from "+threshold+" out of "+size+" : "+maskstr);
  72       return true;
  73     }
  74
  75     return false;
  76   }
  77
  78   int[] setNums(String s)
  79   {
  80     int[] out = new int[s.length()];
  81     int i = 0;
  82
  83     while (i < s.length())
  84     {
  85       out[i] = ResidueProperties.aaIndex[s.charAt(i)];
  86       i++;
  87     }
  88
  89     return out;
  90   }
  91 }