Merge branch 'develop' into features/JAL-518_justify_seqs_in_region

[jalview.git] / test / jalview / analysis / AverageDistanceEngineTest.java

diff --git a/test/jalview/analysis/AverageDistanceEngineTest.java b/test/jalview/analysis/AverageDistanceEngineTest.java
new file mode 100644 (file)
index 0000000..236e354
--- /dev/null
+++ b/test/jalview/analysis/AverageDistanceEngineTest.java
@@ -0,0 +1,128 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.analysis;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import org.junit.Assert;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.Test;
+
+import jalview.bin.Cache;
+import jalview.bin.Console;
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.BinaryNode;
+import jalview.datamodel.ContactMatrixI;
+import jalview.datamodel.SequenceI;
+import jalview.gui.AlignFrame;
+import jalview.gui.JvOptionPane;
+import jalview.io.DataSourceType;
+import jalview.io.FastaFile;
+import jalview.io.FileLoader;
+import jalview.io.FormatAdapter;
+import jalview.util.Platform;
+import jalview.ws.datamodel.alphafold.PAEContactMatrix;
+
+public class AverageDistanceEngineTest
+{
+
+  @BeforeClass(alwaysRun = true)
+  public void setUpJvOptionPane()
+  {
+    JvOptionPane.setInteractiveMode(false);
+    JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
+  }
+
+  @BeforeMethod(alwaysRun = true)
+  public void loadProperties()
+  {
+    Cache.loadProperties("test/jalview/bin/TestProps.jvprops");
+  }
+
+  @Test(groups = { "Functional" })
+  public void testUPGMAEngine() throws Exception
+  {
+    AlignFrame af = new FileLoader(false).LoadFileWaitTillLoaded(
+            "examples/test_fab41.result/sample.a3m", DataSourceType.FILE);
+    AlignmentI seqs = af.getViewport().getAlignment();
+    SequenceI target = seqs.getSequenceAt(0);
+    File testPAE = new File(
+            "examples/test_fab41.result/test_fab41_predicted_aligned_error_v1.json");
+    List<Object> pae_obj = (List<Object>) Platform
+            .parseJSON(new FileInputStream(testPAE));
+    if (pae_obj == null)
+    {
+      Assert.fail("JSON PAE file did not parse properly.");
+    }
+    ContactMatrixI matrix = new PAEContactMatrix(target,
+            (Map<String, Object>) pae_obj.get(0));
+    AlignmentAnnotation aa = target.addContactList(matrix);
+    System.out.println("Matrix has max=" + matrix.getMax() + " and min="
+            + matrix.getMin());
+    long start = System.currentTimeMillis();
+    AverageDistanceEngine clusterer = new AverageDistanceEngine(
+            af.getViewport(), null, matrix, false);
+    System.out.println("built a tree in "
+            + (System.currentTimeMillis() - start) * 0.001 + " seconds.");
+    StringBuffer sb = new StringBuffer();
+    System.out.println("Newick string\n"
+            + new jalview.io.NewickFile(clusterer.getTopNode(), true, true)
+                    .print());
+
+    double height = clusterer.findHeight(clusterer.getTopNode());
+    // compute height fraction to cut
+    // PAE matrixes are absolute measure in angstrom, so
+    // cluster all regions within threshold (e.g. 2A) - if height above
+    // threshold. Otherwise all nodes are in one cluster
+    double thr = .2;
+    List<BinaryNode> groups;
+    if (height > thr)
+    {
+      float cut = (float) (thr / height);
+      System.out.println("Threshold " + cut + " for height=" + height);
+      groups = clusterer.groupNodes(cut);
+    }
+    else
+    {
+      groups = new ArrayList<BinaryNode>();
+      groups.add(clusterer.getTopNode());
+    }
+    int n = 1;
+    for (BinaryNode root : groups)
+    {
+      System.out.println("Cluster " + n++);
+      for (BinaryNode leaf : clusterer.findLeaves(root))
+      {
+        System.out.print(" " + leaf.getName());
+      }
+      System.out.println("\\");
+    }
+  }
+
+}