src/jalview/analysis/AverageDistanceEngine.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;
  22
  23 import java.util.ArrayList;
  24 import java.util.BitSet;
  25 import java.util.List;
  26 import java.util.Vector;
  27
  28 import jalview.datamodel.AlignmentAnnotation;
  29 import jalview.datamodel.BinaryNode;
  30 import jalview.datamodel.ContactListI;
  31 import jalview.datamodel.ContactMatrixI;
  32 import jalview.math.Matrix;
  33 import jalview.viewmodel.AlignmentViewport;
  34
  35 /**
  36  * This class implements distance calculations used in constructing a Average
  37  * Distance tree (also known as UPGMA)
  38  */
  39 public class AverageDistanceEngine extends TreeEngine
  40 {
  41   ContactMatrixI cm;
  42
  43   AlignmentViewport av;
  44
  45   AlignmentAnnotation aa;
  46
  47   /**
  48    * compute cosine distance matrix for a given contact matrix and create a
  49    * UPGMA tree
  50    *
  51    * @param cm
  52    */
  53   public AverageDistanceEngine(AlignmentViewport av, AlignmentAnnotation aa,
  54           ContactMatrixI cm)
  55   {
  56     this.av = av;
  57     this.aa = aa;
  58     this.cm = cm;
  59     calculate(cm);
  60
  61   }
  62
  63   // 0 - normalised dot product
  64   // 1 - L1 - ie (abs(v_1-v_2)/dim(v))
  65   // L1 is more rational - since can reason about value of difference,
  66   // normalised dot product might give cleaner clusters, but more difficult to
  67   // understand.
  68
  69   int mode = 1;
  70
  71   public void calculate(ContactMatrixI cm)
  72   {
  73     this.cm = cm;
  74     node = new Vector<BinaryNode>();
  75     clusters = new Vector<BitSet>();
  76     distances = new Matrix(new double[cm.getWidth()][cm.getWidth()]);
  77     noseqs = cm.getWidth();
  78     done = new BitSet();
  79     double moduli[] = new double[cm.getWidth()];
  80     double max;
  81     if (mode == 0)
  82     {
  83       max = 1;
  84     }
  85     else
  86     {
  87       max = cm.getMax() * cm.getMax();
  88     }
  89
  90     for (int i = 0; i < cm.getWidth(); i++)
  91     {
  92       // init the tree engine node for this column
  93       BinaryNode cnode = new BinaryNode();
  94       cnode.setElement(Integer.valueOf(i));
  95       cnode.setName("c" + i);
  96       node.addElement(cnode);
  97       BitSet bs = new BitSet();
  98       bs.set(i);
  99       clusters.addElement(bs);
 100
 101       // compute distance matrix element
 102       ContactListI ith = cm.getContactList(i);
 103
 104       for (int j = 0; j < i; j++)
 105       {
 106         distances.setValue(i, i, 0);
 107         ContactListI jth = cm.getContactList(j);
 108         double prd = 0;
 109         for (int indx = 0; indx < cm.getHeight(); indx++)
 110         {
 111           if (mode == 0)
 112           {
 113             if (j == 0)
 114             {
 115               moduli[i] += ith.getContactAt(indx) * ith.getContactAt(indx);
 116             }
 117             prd += ith.getContactAt(indx) * jth.getContactAt(indx);
 118           }
 119           else
 120           {
 121             prd += Math
 122                     .abs(ith.getContactAt(indx) - jth.getContactAt(indx));
 123           }
 124         }
 125         if (mode == 0)
 126         {
 127           if (j == 0)
 128           {
 129             moduli[i] = Math.sqrt(moduli[i]);
 130           }
 131           prd = (moduli[i] != 0 && moduli[j] != 0)
 132                   ? prd / (moduli[i] * moduli[j])
 133                   : 0;
 134           prd = 1 - prd;
 135         }
 136         else
 137         {
 138           prd /= cm.getHeight();
 139         }
 140         distances.setValue(i, j, prd);
 141         distances.setValue(j, i, prd);
 142       }
 143     }
 144
 145     noClus = clusters.size();
 146     cluster();
 147   }
 148
 149   /**
 150    * Calculates and saves the distance between the combination of cluster(i) and
 151    * cluster(j) and all other clusters. An average of the distances from
 152    * cluster(i) and cluster(j) is calculated, weighted by the sizes of each
 153    * cluster.
 154    *
 155    * @param i
 156    * @param j
 157    */
 158   @Override
 159   protected void findClusterDistance(int i, int j)
 160   {
 161     int noi = clusters.elementAt(i).cardinality();
 162     int noj = clusters.elementAt(j).cardinality();
 163
 164     // New distances from cluster i to others
 165     double[] newdist = new double[noseqs];
 166
 167     for (int l = 0; l < noseqs; l++)
 168     {
 169       if ((l != i) && (l != j))
 170       {
 171         newdist[l] = ((distances.getValue(i, l) * noi)
 172                 + (distances.getValue(j, l) * noj)) / (noi + noj);
 173       }
 174       else
 175       {
 176         newdist[l] = 0;
 177       }
 178     }
 179
 180     for (int ii = 0; ii < noseqs; ii++)
 181     {
 182       distances.setValue(i, ii, newdist[ii]);
 183       distances.setValue(ii, i, newdist[ii]);
 184     }
 185   }
 186
 187   /**
 188    * {@inheritDoc}
 189    */
 190   @Override
 191   protected double findMinDistance()
 192   {
 193     double min = Double.MAX_VALUE;
 194
 195     for (int i = 0; i < (noseqs - 1); i++)
 196     {
 197       for (int j = i + 1; j < noseqs; j++)
 198       {
 199         if (!done.get(i) && !done.get(j))
 200         {
 201           if (distances.getValue(i, j) < min)
 202           {
 203             mini = i;
 204             minj = j;
 205
 206             min = distances.getValue(i, j);
 207           }
 208         }
 209       }
 210     }
 211     return min;
 212   }
 213
 214   /**
 215    * {@inheritDoc}
 216    */
 217   @Override
 218   protected void findNewDistances(BinaryNode nodei, BinaryNode nodej,
 219           double dist)
 220   {
 221     double ih = 0;
 222     double jh = 0;
 223
 224     BinaryNode sni = nodei;
 225     BinaryNode snj = nodej;
 226
 227     while (sni != null)
 228     {
 229       ih = ih + sni.dist;
 230       sni = (BinaryNode) sni.left();
 231     }
 232
 233     while (snj != null)
 234     {
 235       jh = jh + snj.dist;
 236       snj = (BinaryNode) snj.left();
 237     }
 238
 239     nodei.dist = ((dist / 2) - ih);
 240     nodej.dist = ((dist / 2) - jh);
 241   }
 242
 243   /***
 244    * not the right place - OH WELL!
 245    */
 246
 247   /**
 248    * Makes a list of groups, where each group is represented by a node whose
 249    * height (distance from the root node), as a fraction of the height of the
 250    * whole tree, is greater than the given threshold. This corresponds to
 251    * selecting the nodes immediately to the right of a vertical line
 252    * partitioning the tree (if the tree is drawn with root to the left). Each
 253    * such node represents a group that contains all of the sequences linked to
 254    * the child leaf nodes.
 255    *
 256    * @param threshold
 257    * @see #getGroups()
 258    */
 259   public List<BinaryNode> groupNodes(float threshold)
 260   {
 261     List<BinaryNode> groups = new ArrayList<BinaryNode>();
 262     _groupNodes(groups, getTopNode(), threshold);
 263     return groups;
 264   }
 265
 266   protected void _groupNodes(List<BinaryNode> groups, BinaryNode nd,
 267           float threshold)
 268   {
 269     if (nd == null)
 270     {
 271       return;
 272     }
 273
 274     if ((nd.height / maxheight) > threshold)
 275     {
 276       groups.add(nd);
 277     }
 278     else
 279     {
 280       _groupNodes(groups, nd.left(), threshold);
 281       _groupNodes(groups, nd.right(), threshold);
 282     }
 283   }
 284
 285   /**
 286    * DOCUMENT ME!
 287    *
 288    * @param nd
 289    *          DOCUMENT ME!
 290    *
 291    * @return DOCUMENT ME!
 292    */
 293   public double findHeight(BinaryNode nd)
 294   {
 295     if (nd == null)
 296     {
 297       return maxheight;
 298     }
 299
 300     if ((nd.left() == null) && (nd.right() == null))
 301     {
 302       nd.height = ((BinaryNode) nd.parent()).height + nd.dist;
 303
 304       if (nd.height > maxheight)
 305       {
 306         return nd.height;
 307       }
 308       else
 309       {
 310         return maxheight;
 311       }
 312     }
 313     else
 314     {
 315       if (nd.parent() != null)
 316       {
 317         nd.height = ((BinaryNode) nd.parent()).height + nd.dist;
 318       }
 319       else
 320       {
 321         maxheight = 0;
 322         nd.height = (float) 0.0;
 323       }
 324
 325       maxheight = findHeight((BinaryNode) (nd.left()));
 326       maxheight = findHeight((BinaryNode) (nd.right()));
 327     }
 328
 329     return maxheight;
 330   }
 331
 332   /**
 333    * Search for leaf nodes below (or at) the given node
 334    *
 335    * @param top2
 336    *          root node to search from
 337    *
 338    * @return
 339    */
 340   public Vector<BinaryNode> findLeaves(BinaryNode top2)
 341   {
 342     Vector<BinaryNode> leaves = new Vector<BinaryNode>();
 343     findLeaves(top2, leaves);
 344     return leaves;
 345   }
 346
 347   /**
 348    * Search for leaf nodes.
 349    *
 350    * @param nd
 351    *          root node to search from
 352    * @param leaves
 353    *          Vector of leaves to add leaf node objects too.
 354    *
 355    * @return Vector of leaf nodes on binary tree
 356    */
 357   Vector<BinaryNode> findLeaves(BinaryNode nd, Vector<BinaryNode> leaves)
 358   {
 359     if (nd == null)
 360     {
 361       return leaves;
 362     }
 363
 364     if ((nd.left() == null) && (nd.right() == null)) // Interior node
 365     // detection
 366     {
 367       leaves.addElement(nd);
 368
 369       return leaves;
 370     }
 371     else
 372     {
 373       /*
 374        * TODO: Identify internal nodes... if (node.isSequenceLabel()) {
 375        * leaves.addElement(node); }
 376        */
 377       findLeaves(nd.left(), leaves);
 378       findLeaves(nd.right(), leaves);
 379     }
 380
 381     return leaves;
 382   }
 383
 384 }