src/jalview/schemes/Consensus.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   3  * Copyright (C) 2014 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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  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
  29   double threshold;
  30
  31   String maskstr;
  32
  33   public Consensus(String mask, double threshold)
  34   {
  35     // this.id = id;
  36     // this.mask = mask;
  37     this.maskstr = mask;
  38     setMask(mask);
  39     this.threshold = threshold;
  40   }
  41
  42   public void setMask(String s)
  43   {
  44     this.mask = setNums(s);
  45
  46     // for (int i=0; i < mask.length; i++) {
  47     // System.out.println(mask[i] + " " + ResidueProperties.aa[mask[i]]);
  48     // }
  49   }
  50
  51   /**
  52    * @deprecated Use {@link #isConserved(int[][],int,int,boolean)} instead
  53    */
  54   public boolean isConserved(int[][] cons2, int col, int size)
  55   {
  56     return isConserved(cons2, col, size, true);
  57   }
  58
  59   public boolean isConserved(int[][] cons2, int col, int size,
  60           boolean includeGaps)
  61   {
  62     int tot = 0;
  63     if (!includeGaps)
  64     {
  65       size -= cons2[col][cons2[col].length - 1];
  66     }
  67     for (int i = 0; i < mask.length; i++)
  68     {
  69       tot += cons2[col][mask[i]];
  70     }
  71
  72     if ((double) tot > ((threshold * size) / 100))
  73     {
  74       // System.out.println("True conserved "+tot+" from "+threshold+" out of
  75       // "+size+" : "+maskstr);
  76       return true;
  77     }
  78
  79     return false;
  80   }
  81
  82   int[] setNums(String s)
  83   {
  84     int[] out = new int[s.length()];
  85     int i = 0;
  86
  87     while (i < s.length())
  88     {
  89       out[i] = ResidueProperties.aaIndex[s.charAt(i)];
  90       i++;
  91     }
  92
  93     return out;
  94   }
  95 }