Package jebl.evolution.trees
Class TransformedRootedTree
- java.lang.Object
-
- jebl.evolution.trees.FilteredRootedTree
-
- jebl.evolution.trees.TransformedRootedTree
-
- All Implemented Interfaces:
Graph,RootedTree,Tree,Attributable
public class TransformedRootedTree extends FilteredRootedTree
This RootedTree class wraps another RootedTree and transforms the branch lengths and node heights using various functions. Currently implemented are equal lengths (all branch lengths are 1.0) and cladogram (the height of a node is proportional to the number of external nodes). Note that all these functions are recalculated on the fly for every call to getHeight and getLength and it may be desirable to precalculate and cache them.- Version:
- $Id: TransformedRootedTree.java 545 2006-11-28 00:08:34Z twobeers $
- Author:
- Andrew Rambaut
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTransformedRootedTree.Transform-
Nested classes/interfaces inherited from interface jebl.evolution.graphs.Graph
Graph.NoEdgeException, Graph.Utils
-
-
Constructor Summary
Constructors Constructor Description TransformedRootedTree(RootedTree source, TransformedRootedTree.Transform transform)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description doublegetHeight(Node node)doublegetLength(Node node)booleanhasHeights()booleanhasLengths()-
Methods inherited from class jebl.evolution.trees.FilteredRootedTree
conceptuallyUnrooted, getAdjacencies, getAttribute, getAttributeMap, getAttributeNames, getChildren, getEdge, getEdgeLength, getEdges, getEdges, getExternalEdges, getExternalNodes, getInternalEdges, getInternalNodes, getNode, getNodes, getNodes, getNodes, getParent, getRootNode, getSource, getTaxa, getTaxon, isExternal, isRoot, removeAttribute, renameTaxa, setAttribute
-
-
-
-
Constructor Detail
-
TransformedRootedTree
public TransformedRootedTree(RootedTree source, TransformedRootedTree.Transform transform)
-
-
Method Detail
-
hasHeights
public boolean hasHeights()
- Specified by:
hasHeightsin interfaceRootedTree- Overrides:
hasHeightsin classFilteredRootedTree- Returns:
- Whether this tree has node heights available
-
getHeight
public double getHeight(Node node)
- Specified by:
getHeightin interfaceRootedTree- Overrides:
getHeightin classFilteredRootedTree- Parameters:
node- the node whose height is being requested.- Returns:
- the height of the given node. The height will be less than the parent's height and greater than it children's heights.
-
hasLengths
public boolean hasLengths()
- Specified by:
hasLengthsin interfaceRootedTree- Overrides:
hasLengthsin classFilteredRootedTree- Returns:
- Whether this tree has branch lengths available
-
getLength
public double getLength(Node node)
- Specified by:
getLengthin interfaceRootedTree- Overrides:
getLengthin classFilteredRootedTree- Parameters:
node- the node whose branch length (to its parent) is being requested.- Returns:
- the length of the branch to the parent node (0.0 if the node is the root).
-
-