-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA\r
- */\r
-package jalview.analysis;\r
-\r
-import java.util.*;\r
-\r
-import jalview.datamodel.*;\r
-import jalview.util.*;\r
-\r
-/** Data structure to hold and manipulate a multiple sequence alignment\r
- */\r
-public class AlignmentSorter\r
-{\r
- static boolean sortIdAscending = true;\r
- static int lastGroupHash = 0;\r
- static boolean sortGroupAscending = true;\r
- static AlignmentOrder lastOrder = null;\r
- static boolean sortOrderAscending = true;\r
- static NJTree lastTree = null;\r
- static boolean sortTreeAscending = true;\r
-\r
- /**\r
- * Sort by Percentage Identity\r
- *\r
- * @param align AlignmentI\r
- * @param s SequenceI\r
- */\r
- public static void sortByPID(AlignmentI align, SequenceI s)\r
- {\r
- int nSeq = align.getHeight();\r
-\r
- float[] scores = new float[nSeq];\r
- SequenceI[] seqs = new SequenceI[nSeq];\r
-\r
- for (int i = 0; i < nSeq; i++)\r
- {\r
- scores[i] = Comparison.PID(align.getSequenceAt(i).getSequenceAsString(),\r
- s.getSequenceAsString());\r
- seqs[i] = align.getSequenceAt(i);\r
- }\r
-\r
- QuickSort.sort(scores, 0, scores.length - 1, seqs);\r
-\r
- setReverseOrder(align, seqs);\r
- }\r
-\r
- /**\r
- * Reverse the order of the sort\r
- *\r
- * @param align DOCUMENT ME!\r
- * @param seqs DOCUMENT ME!\r
- */\r
- private static void setReverseOrder(AlignmentI align, SequenceI[] seqs)\r
- {\r
- int nSeq = seqs.length;\r
-\r
- int len = 0;\r
-\r
- if ( (nSeq % 2) == 0)\r
- {\r
- len = nSeq / 2;\r
- }\r
- else\r
- {\r
- len = (nSeq + 1) / 2;\r
- }\r
-\r
- // NOTE: DO NOT USE align.setSequenceAt() here - it will NOT work\r
- for (int i = 0; i < len; i++)\r
- {\r
- //SequenceI tmp = seqs[i];\r
- align.getSequences().setElementAt(seqs[nSeq - i - 1], i);\r
- align.getSequences().setElementAt(seqs[i], nSeq - i - 1);\r
- }\r
- }\r
-\r
- /**\r
- * Sets the Alignment object with the given sequences\r
- *\r
- * @param align Alignment object to be updated\r
- * @param tmp sequences as a vector\r
- */\r
- private static void setOrder(AlignmentI align, Vector tmp)\r
- {\r
- setOrder(align, vectorSubsetToArray(tmp, align.getSequences()));\r
- }\r
-\r
- /**\r
- * Sets the Alignment object with the given sequences\r
- *\r
- * @param align DOCUMENT ME!\r
- * @param seqs sequences as an array\r
- */\r
- public static void setOrder(AlignmentI align, SequenceI[] seqs)\r
- {\r
- // NOTE: DO NOT USE align.setSequenceAt() here - it will NOT work\r
- Vector algn = align.getSequences();\r
- Vector tmp = new Vector();\r
-\r
- for (int i = 0; i < seqs.length; i++)\r
- {\r
- if (algn.contains(seqs[i]))\r
- {\r
- tmp.addElement(seqs[i]);\r
- }\r
- }\r
-\r
- algn.removeAllElements();\r
- //User may have hidden seqs, then clicked undo or redo\r
- for (int i = 0; i < tmp.size(); i++)\r
- {\r
- algn.addElement(tmp.elementAt(i));\r
- }\r
-\r
- }\r
-\r
- /**\r
- * Sorts by ID. Numbers are sorted before letters.\r
- *\r
- * @param align The alignment object to sort\r
- */\r
- public static void sortByID(AlignmentI align)\r
- {\r
- int nSeq = align.getHeight();\r
-\r
- String[] ids = new String[nSeq];\r
- SequenceI[] seqs = new SequenceI[nSeq];\r
-\r
- for (int i = 0; i < nSeq; i++)\r
- {\r
- ids[i] = align.getSequenceAt(i).getName();\r
- seqs[i] = align.getSequenceAt(i);\r
- }\r
-\r
- QuickSort.sort(ids, seqs);\r
-\r
- if (sortIdAscending)\r
- {\r
- setReverseOrder(align, seqs);\r
- }\r
- else\r
- {\r
- setOrder(align, seqs);\r
- }\r
-\r
- sortIdAscending = !sortIdAscending;\r
- }\r
-\r
- /**\r
- * Sorts the alignment by size of group.\r
- * <br>Maintains the order of sequences in each group\r
- * by order in given alignment object.\r
- *\r
- * @param align sorts the given alignment object by group\r
- */\r
- public static void sortByGroup(AlignmentI align)\r
- {\r
- //MAINTAINS ORIGNAL SEQUENCE ORDER,\r
- //ORDERS BY GROUP SIZE\r
- Vector groups = new Vector();\r
-\r
- if (groups.hashCode() != lastGroupHash)\r
- {\r
- sortGroupAscending = true;\r
- lastGroupHash = groups.hashCode();\r
- }\r
- else\r
- {\r
- sortGroupAscending = !sortGroupAscending;\r
- }\r
-\r
- //SORTS GROUPS BY SIZE\r
- //////////////////////\r
- for (int i = 0; i < align.getGroups().size(); i++)\r
- {\r
- SequenceGroup sg = (SequenceGroup) align.getGroups().elementAt(i);\r
-\r
- for (int j = 0; j < groups.size(); j++)\r
- {\r
- SequenceGroup sg2 = (SequenceGroup) groups.elementAt(j);\r
-\r
- if (sg.getSize() > sg2.getSize())\r
- {\r
- groups.insertElementAt(sg, j);\r
-\r
- break;\r
- }\r
- }\r
-\r
- if (!groups.contains(sg))\r
- {\r
- groups.addElement(sg);\r
- }\r
- }\r
-\r
- //NOW ADD SEQUENCES MAINTAINING ALIGNMENT ORDER\r
- ///////////////////////////////////////////////\r
- Vector seqs = new Vector();\r
-\r
- for (int i = 0; i < groups.size(); i++)\r
- {\r
- SequenceGroup sg = (SequenceGroup) groups.elementAt(i);\r
- SequenceI[] orderedseqs = sg.getSequencesInOrder(align);\r
-\r
- for (int j = 0; j < orderedseqs.length; j++)\r
- {\r
- seqs.addElement(orderedseqs[j]);\r
- }\r
- }\r
-\r
- if (sortGroupAscending)\r
- {\r
- setOrder(align, seqs);\r
- }\r
- else\r
- {\r
- setReverseOrder(align,\r
- vectorSubsetToArray(seqs, align.getSequences()));\r
- }\r
- }\r
-\r
- /**\r
- * Converts Vector to array.\r
- * java 1.18 does not have Vector.toArray()\r
- *\r
- * @param tmp Vector of SequenceI objects\r
- *\r
- * @return array of Sequence[]\r
- */\r
- private static SequenceI[] vectorToArray(Vector tmp)\r
- {\r
- SequenceI[] seqs = new SequenceI[tmp.size()];\r
-\r
- for (int i = 0; i < tmp.size(); i++)\r
- {\r
- seqs[i] = (SequenceI) tmp.elementAt(i);\r
- }\r
-\r
- return seqs;\r
- }\r
-\r
- /**\r
- * DOCUMENT ME!\r
- *\r
- * @param tmp DOCUMENT ME!\r
- * @param mask DOCUMENT ME!\r
- *\r
- * @return DOCUMENT ME!\r
- */\r
- private static SequenceI[] vectorSubsetToArray(Vector tmp, Vector mask)\r
- {\r
- Vector seqs = new Vector();\r
- int i;\r
- boolean[] tmask = new boolean[mask.size()];\r
-\r
- for (i = 0; i < mask.size(); i++)\r
- {\r
- tmask[i] = true;\r
- }\r
-\r
- for (i = 0; i < tmp.size(); i++)\r
- {\r
- Object sq = tmp.elementAt(i);\r
-\r
- if (mask.contains(sq) && tmask[mask.indexOf(sq)])\r
- {\r
- tmask[mask.indexOf(sq)] = false;\r
- seqs.addElement(sq);\r
- }\r
- }\r
-\r
- for (i = 0; i < tmask.length; i++)\r
- {\r
- if (tmask[i])\r
- {\r
- seqs.addElement(mask.elementAt(i));\r
- }\r
- }\r
-\r
- return vectorToArray(seqs);\r
- }\r
-\r
- /**\r
- * Sorts by a given AlignmentOrder object\r
- *\r
- * @param align Alignment to order\r
- * @param order specified order for alignment\r
- */\r
- public static void sortBy(AlignmentI align, AlignmentOrder order)\r
- {\r
- // Get an ordered vector of sequences which may also be present in align\r
- Vector tmp = order.getOrder();\r
-\r
- if (lastOrder == order)\r
- {\r
- sortOrderAscending = !sortOrderAscending;\r
- }\r
- else\r
- {\r
- sortOrderAscending = true;\r
- }\r
-\r
- if (sortOrderAscending)\r
- {\r
- setOrder(align, tmp);\r
- }\r
- else\r
- {\r
- setReverseOrder(align,\r
- vectorSubsetToArray(tmp, align.getSequences()));\r
- }\r
- }\r
-\r
- /**\r
- * DOCUMENT ME!\r
- *\r
- * @param align alignment to order\r
- * @param tree tree which has\r
- *\r
- * @return DOCUMENT ME!\r
- */\r
- private static Vector getOrderByTree(AlignmentI align, NJTree tree)\r
- {\r
- int nSeq = align.getHeight();\r
-\r
- Vector tmp = new Vector();\r
-\r
- tmp = _sortByTree(tree.getTopNode(), tmp, align.getSequences());\r
-\r
- if (tmp.size() != nSeq)\r
- {\r
- // TODO: JBPNote - decide if this is always an error\r
- // (eg. not when a tree is associated to another alignment which has more\r
- // sequences)\r
- if (tmp.size() < nSeq)\r
- {\r
- addStrays(align, tmp);\r
- }\r
-\r
- if (tmp.size() != nSeq)\r
- {\r
- System.err.println("ERROR: tmp.size()=" + tmp.size() +\r
- " != nseq=" + nSeq + " in getOrderByTree");\r
- }\r
- }\r
-\r
- return tmp;\r
- }\r
-\r
- /**\r
- * Sorts the alignment by a given tree\r
- *\r
- * @param align alignment to order\r
- * @param tree tree which has\r
- */\r
- public static void sortByTree(AlignmentI align, NJTree tree)\r
- {\r
- Vector tmp = getOrderByTree(align, tree);\r
-\r
- // tmp should properly permute align with tree.\r
- if (lastTree != tree)\r
- {\r
- sortTreeAscending = true;\r
- lastTree = tree;\r
- }\r
- else\r
- {\r
- sortTreeAscending = !sortTreeAscending;\r
- }\r
-\r
- if (sortTreeAscending)\r
- {\r
- setOrder(align, tmp);\r
- }\r
- else\r
- {\r
- setReverseOrder(align,\r
- vectorSubsetToArray(tmp, align.getSequences()));\r
- }\r
- }\r
-\r
- /**\r
- * DOCUMENT ME!\r
- *\r
- * @param align DOCUMENT ME!\r
- * @param seqs DOCUMENT ME!\r
- */\r
- private static void addStrays(AlignmentI align, Vector seqs)\r
- {\r
- int nSeq = align.getHeight();\r
-\r
- for (int i = 0; i < nSeq; i++)\r
- {\r
- if (!seqs.contains(align.getSequenceAt(i)))\r
- {\r
- seqs.addElement(align.getSequenceAt(i));\r
- }\r
- }\r
-\r
- if (nSeq != seqs.size())\r
- {\r
- System.err.println(\r
- "ERROR: Size still not right even after addStrays");\r
- }\r
- }\r
-\r
- /**\r
- * DOCUMENT ME!\r
- *\r
- * @param node DOCUMENT ME!\r
- * @param tmp DOCUMENT ME!\r
- * @param seqset DOCUMENT ME!\r
- *\r
- * @return DOCUMENT ME!\r
- */\r
- private static Vector _sortByTree(SequenceNode node, Vector tmp,\r
- Vector seqset)\r
- {\r
- if (node == null)\r
- {\r
- return tmp;\r
- }\r
-\r
- SequenceNode left = (SequenceNode) node.left();\r
- SequenceNode right = (SequenceNode) node.right();\r
-\r
- if ( (left == null) && (right == null))\r
- {\r
- if (!node.isPlaceholder() && (node.element() != null))\r
- {\r
- if (node.element() instanceof SequenceI)\r
- {\r
- if (!tmp.contains(node.element()))\r
- {\r
- tmp.addElement( (SequenceI) node.element());\r
- }\r
- }\r
- }\r
-\r
- return tmp;\r
- }\r
- else\r
- {\r
- _sortByTree(left, tmp, seqset);\r
- _sortByTree(right, tmp, seqset);\r
- }\r
-\r
- return tmp;\r
- }\r
-\r
- // Ordering Objects\r
- // Alignment.sortBy(OrderObj) - sequence of sequence pointer refs in appropriate order\r
- //\r
-\r
- /**\r
- * recover the order of sequences given by the safe numbering scheme introducd\r
- * SeqsetUtils.uniquify.\r
- */\r
- public static void recoverOrder(SequenceI[] alignment)\r
- {\r
- float[] ids = new float[alignment.length];\r
-\r
- for (int i = 0; i < alignment.length; i++)\r
- {\r
- ids[i] = (new Float(alignment[i].getName().substring(8))).floatValue();\r
- }\r
-\r
- jalview.util.QuickSort.sort(ids, alignment);\r
- }\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer
+ * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ *
+ * This program 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 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+package jalview.analysis;
+
+import java.util.*;
+
+import jalview.datamodel.*;
+import jalview.util.*;
+
+/**
+ * Routines for manipulating the order of a multiple sequence alignment
+ * TODO: this class retains some global states concerning sort-order which should be made attributes for the caller's alignment visualization.
+ */
+public class AlignmentSorter
+{
+ static boolean sortIdAscending = true;
+ static int lastGroupHash = 0;
+ static boolean sortGroupAscending = true;
+ static AlignmentOrder lastOrder = null;
+ static boolean sortOrderAscending = true;
+ static NJTree lastTree = null;
+ static boolean sortTreeAscending = true;
+ private static String lastSortByScore;
+
+ /**
+ * Sort by Percentage Identity
+ *
+ * @param align AlignmentI
+ * @param s SequenceI
+ */
+ public static void sortByPID(AlignmentI align, SequenceI s)
+ {
+ int nSeq = align.getHeight();
+
+ float[] scores = new float[nSeq];
+ SequenceI[] seqs = new SequenceI[nSeq];
+
+ for (int i = 0; i < nSeq; i++)
+ {
+ scores[i] = Comparison.PID(align.getSequenceAt(i).getSequenceAsString(),
+ s.getSequenceAsString());
+ seqs[i] = align.getSequenceAt(i);
+ }
+
+ QuickSort.sort(scores, 0, scores.length - 1, seqs);
+
+ setReverseOrder(align, seqs);
+ }
+
+ /**
+ * Reverse the order of the sort
+ *
+ * @param align DOCUMENT ME!
+ * @param seqs DOCUMENT ME!
+ */
+ private static void setReverseOrder(AlignmentI align, SequenceI[] seqs)
+ {
+ int nSeq = seqs.length;
+
+ int len = 0;
+
+ if ( (nSeq % 2) == 0)
+ {
+ len = nSeq / 2;
+ }
+ else
+ {
+ len = (nSeq + 1) / 2;
+ }
+
+ // NOTE: DO NOT USE align.setSequenceAt() here - it will NOT work
+ for (int i = 0; i < len; i++)
+ {
+ //SequenceI tmp = seqs[i];
+ align.getSequences().setElementAt(seqs[nSeq - i - 1], i);
+ align.getSequences().setElementAt(seqs[i], nSeq - i - 1);
+ }
+ }
+
+ /**
+ * Sets the Alignment object with the given sequences
+ *
+ * @param align Alignment object to be updated
+ * @param tmp sequences as a vector
+ */
+ private static void setOrder(AlignmentI align, Vector tmp)
+ {
+ setOrder(align, vectorSubsetToArray(tmp, align.getSequences()));
+ }
+
+ /**
+ * Sets the Alignment object with the given sequences
+ *
+ * @param align DOCUMENT ME!
+ * @param seqs sequences as an array
+ */
+ public static void setOrder(AlignmentI align, SequenceI[] seqs)
+ {
+ // NOTE: DO NOT USE align.setSequenceAt() here - it will NOT work
+ Vector algn = align.getSequences();
+ Vector tmp = new Vector();
+
+ for (int i = 0; i < seqs.length; i++)
+ {
+ if (algn.contains(seqs[i]))
+ {
+ tmp.addElement(seqs[i]);
+ }
+ }
+
+ algn.removeAllElements();
+ //User may have hidden seqs, then clicked undo or redo
+ for (int i = 0; i < tmp.size(); i++)
+ {
+ algn.addElement(tmp.elementAt(i));
+ }
+
+ }
+
+ /**
+ * Sorts by ID. Numbers are sorted before letters.
+ *
+ * @param align The alignment object to sort
+ */
+ public static void sortByID(AlignmentI align)
+ {
+ int nSeq = align.getHeight();
+
+ String[] ids = new String[nSeq];
+ SequenceI[] seqs = new SequenceI[nSeq];
+
+ for (int i = 0; i < nSeq; i++)
+ {
+ ids[i] = align.getSequenceAt(i).getName();
+ seqs[i] = align.getSequenceAt(i);
+ }
+
+ QuickSort.sort(ids, seqs);
+
+ if (sortIdAscending)
+ {
+ setReverseOrder(align, seqs);
+ }
+ else
+ {
+ setOrder(align, seqs);
+ }
+
+ sortIdAscending = !sortIdAscending;
+ }
+
+ /**
+ * Sorts the alignment by size of group.
+ * <br>Maintains the order of sequences in each group
+ * by order in given alignment object.
+ *
+ * @param align sorts the given alignment object by group
+ */
+ public static void sortByGroup(AlignmentI align)
+ {
+ //MAINTAINS ORIGNAL SEQUENCE ORDER,
+ //ORDERS BY GROUP SIZE
+ Vector groups = new Vector();
+
+ if (groups.hashCode() != lastGroupHash)
+ {
+ sortGroupAscending = true;
+ lastGroupHash = groups.hashCode();
+ }
+ else
+ {
+ sortGroupAscending = !sortGroupAscending;
+ }
+
+ //SORTS GROUPS BY SIZE
+ //////////////////////
+ for (int i = 0; i < align.getGroups().size(); i++)
+ {
+ SequenceGroup sg = (SequenceGroup) align.getGroups().elementAt(i);
+
+ for (int j = 0; j < groups.size(); j++)
+ {
+ SequenceGroup sg2 = (SequenceGroup) groups.elementAt(j);
+
+ if (sg.getSize() > sg2.getSize())
+ {
+ groups.insertElementAt(sg, j);
+
+ break;
+ }
+ }
+
+ if (!groups.contains(sg))
+ {
+ groups.addElement(sg);
+ }
+ }
+
+ //NOW ADD SEQUENCES MAINTAINING ALIGNMENT ORDER
+ ///////////////////////////////////////////////
+ Vector seqs = new Vector();
+
+ for (int i = 0; i < groups.size(); i++)
+ {
+ SequenceGroup sg = (SequenceGroup) groups.elementAt(i);
+ SequenceI[] orderedseqs = sg.getSequencesInOrder(align);
+
+ for (int j = 0; j < orderedseqs.length; j++)
+ {
+ seqs.addElement(orderedseqs[j]);
+ }
+ }
+
+ if (sortGroupAscending)
+ {
+ setOrder(align, seqs);
+ }
+ else
+ {
+ setReverseOrder(align,
+ vectorSubsetToArray(seqs, align.getSequences()));
+ }
+ }
+
+ /**
+ * Converts Vector to array.
+ * java 1.18 does not have Vector.toArray()
+ *
+ * @param tmp Vector of SequenceI objects
+ *
+ * @return array of Sequence[]
+ */
+ private static SequenceI[] vectorToArray(Vector tmp)
+ {
+ SequenceI[] seqs = new SequenceI[tmp.size()];
+
+ for (int i = 0; i < tmp.size(); i++)
+ {
+ seqs[i] = (SequenceI) tmp.elementAt(i);
+ }
+
+ return seqs;
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @param tmp DOCUMENT ME!
+ * @param mask DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
+ private static SequenceI[] vectorSubsetToArray(Vector tmp, Vector mask)
+ {
+ Vector seqs = new Vector();
+ int i;
+ boolean[] tmask = new boolean[mask.size()];
+
+ for (i = 0; i < mask.size(); i++)
+ {
+ tmask[i] = true;
+ }
+
+ for (i = 0; i < tmp.size(); i++)
+ {
+ Object sq = tmp.elementAt(i);
+
+ if (mask.contains(sq) && tmask[mask.indexOf(sq)])
+ {
+ tmask[mask.indexOf(sq)] = false;
+ seqs.addElement(sq);
+ }
+ }
+
+ for (i = 0; i < tmask.length; i++)
+ {
+ if (tmask[i])
+ {
+ seqs.addElement(mask.elementAt(i));
+ }
+ }
+
+ return vectorToArray(seqs);
+ }
+
+ /**
+ * Sorts by a given AlignmentOrder object
+ *
+ * @param align Alignment to order
+ * @param order specified order for alignment
+ */
+ public static void sortBy(AlignmentI align, AlignmentOrder order)
+ {
+ // Get an ordered vector of sequences which may also be present in align
+ Vector tmp = order.getOrder();
+
+ if (lastOrder == order)
+ {
+ sortOrderAscending = !sortOrderAscending;
+ }
+ else
+ {
+ sortOrderAscending = true;
+ }
+
+ if (sortOrderAscending)
+ {
+ setOrder(align, tmp);
+ }
+ else
+ {
+ setReverseOrder(align,
+ vectorSubsetToArray(tmp, align.getSequences()));
+ }
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @param align alignment to order
+ * @param tree tree which has
+ *
+ * @return DOCUMENT ME!
+ */
+ private static Vector getOrderByTree(AlignmentI align, NJTree tree)
+ {
+ int nSeq = align.getHeight();
+
+ Vector tmp = new Vector();
+
+ tmp = _sortByTree(tree.getTopNode(), tmp, align.getSequences());
+
+ if (tmp.size() != nSeq)
+ {
+ // TODO: JBPNote - decide if this is always an error
+ // (eg. not when a tree is associated to another alignment which has more
+ // sequences)
+ if (tmp.size() < nSeq)
+ {
+ addStrays(align, tmp);
+ }
+
+ if (tmp.size() != nSeq)
+ {
+ System.err.println("ERROR: tmp.size()=" + tmp.size() +
+ " != nseq=" + nSeq + " in getOrderByTree");
+ }
+ }
+
+ return tmp;
+ }
+
+ /**
+ * Sorts the alignment by a given tree
+ *
+ * @param align alignment to order
+ * @param tree tree which has
+ */
+ public static void sortByTree(AlignmentI align, NJTree tree)
+ {
+ Vector tmp = getOrderByTree(align, tree);
+
+ // tmp should properly permute align with tree.
+ if (lastTree != tree)
+ {
+ sortTreeAscending = true;
+ lastTree = tree;
+ }
+ else
+ {
+ sortTreeAscending = !sortTreeAscending;
+ }
+
+ if (sortTreeAscending)
+ {
+ setOrder(align, tmp);
+ }
+ else
+ {
+ setReverseOrder(align,
+ vectorSubsetToArray(tmp, align.getSequences()));
+ }
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @param align DOCUMENT ME!
+ * @param seqs DOCUMENT ME!
+ */
+ private static void addStrays(AlignmentI align, Vector seqs)
+ {
+ int nSeq = align.getHeight();
+
+ for (int i = 0; i < nSeq; i++)
+ {
+ if (!seqs.contains(align.getSequenceAt(i)))
+ {
+ seqs.addElement(align.getSequenceAt(i));
+ }
+ }
+
+ if (nSeq != seqs.size())
+ {
+ System.err.println(
+ "ERROR: Size still not right even after addStrays");
+ }
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @param node DOCUMENT ME!
+ * @param tmp DOCUMENT ME!
+ * @param seqset DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
+ private static Vector _sortByTree(SequenceNode node, Vector tmp,
+ Vector seqset)
+ {
+ if (node == null)
+ {
+ return tmp;
+ }
+
+ SequenceNode left = (SequenceNode) node.left();
+ SequenceNode right = (SequenceNode) node.right();
+
+ if ( (left == null) && (right == null))
+ {
+ if (!node.isPlaceholder() && (node.element() != null))
+ {
+ if (node.element() instanceof SequenceI)
+ {
+ if (!tmp.contains(node.element()))
+ {
+ tmp.addElement( (SequenceI) node.element());
+ }
+ }
+ }
+
+ return tmp;
+ }
+ else
+ {
+ _sortByTree(left, tmp, seqset);
+ _sortByTree(right, tmp, seqset);
+ }
+
+ return tmp;
+ }
+
+ // Ordering Objects
+ // Alignment.sortBy(OrderObj) - sequence of sequence pointer refs in appropriate order
+ //
+
+ /**
+ * recover the order of sequences given by the safe numbering scheme introducd
+ * SeqsetUtils.uniquify.
+ */
+ public static void recoverOrder(SequenceI[] alignment)
+ {
+ float[] ids = new float[alignment.length];
+
+ for (int i = 0; i < alignment.length; i++)
+ {
+ ids[i] = (new Float(alignment[i].getName().substring(8))).floatValue();
+ }
+
+ jalview.util.QuickSort.sort(ids, alignment);
+ }
+ /**
+ * Sort sequence in order of increasing score attribute for annotation with a particular
+ * scoreLabel. Or reverse if same label was used previously
+ * @param scoreLabel exact label for sequence associated AlignmentAnnotation scores to use for sorting.
+ * @param alignment sequences to be sorted
+ */
+ public static void sortByAnnotationScore(String scoreLabel, AlignmentI alignment)
+ {
+ SequenceI[] seqs = alignment.getSequencesArray();
+ boolean[] hasScore = new boolean[seqs.length]; // per sequence score presence
+ int hasScores=0; // number of scores present on set
+ double[] scores = new double[seqs.length];
+ double min=0,max=0;
+ for (int i = 0; i < seqs.length; i++)
+ {
+ AlignmentAnnotation[] scoreAnn = seqs[i].getAnnotation(scoreLabel);
+ if (scoreAnn!=null)
+ {
+ hasScores++;
+ hasScore[i] = true;
+ scores[i] = scoreAnn[0].getScore(); // take the first instance of this score.
+ if (hasScores==1)
+ {
+ max = min = scores[i];
+ } else
+ {
+ if (max<scores[i])
+ {
+ max = scores[i];
+ }
+ if (min>scores[i])
+ {
+ min = scores[i];
+ }
+ }
+ }
+ else
+ {
+ hasScore[i] = false;
+ }
+ }
+ if (hasScores==0)
+ {
+ return; // do nothing - no scores present to sort by.
+ }
+ if (hasScores<seqs.length)
+ {
+ for (int i=0; i<seqs.length;i++)
+ {
+ if (!hasScore[i])
+ {
+ scores[i] = (max+i);
+ }
+ }
+ }
+
+ jalview.util.QuickSort.sort(scores, seqs);
+ if (lastSortByScore!=scoreLabel)
+ {
+ lastSortByScore = scoreLabel;
+ setOrder(alignment, seqs);
+ } else {
+ setReverseOrder(alignment, seqs);
+ }
+ }
+}
git://source.jalview.org / jalview.git / commitdiff