starvine.vine.tree.Vtree Class Reference

Inheritance diagram for starvine.vine.tree.Vtree:

Public Member Functions
def	__init__ (self, data, lvl, parentTree=None, kwargs)
	A generic tree within vine. More...
def	addNode (self, dataLabel, data)
	Add a node to the tree. More...
def	buildNodes (self)
	Assign each data column to a networkx node.
def	setEdges (self, nodePairs=None)
	Sets the node to node connections in the tree. More...
def	lowerTree (self, lowerTree=None)
	Gets lower tree. More...
def	lowerTree (self, lTree)
	Sets lower tree.
def	upperTree (self, upperTree=None)
	Gets upper tree. More...
def	upperTree (self, uTree)
	Sets upper tree.

Public Attributes
	data
	nT
	level
	tree

Private Member Functions
def	_setEdgeTriplets (self)
	Applies to all non-zero level trees in the vine. More...
def	_optimNodePairs (self)
	Computes the minimum spanning tree (R-vine) or tree which maximizes dependence. More...
def	_importTree (self, existingTreeStruct)
	Imports an existing tree. More...
def	_exportTree (self)
	Export tree for later use or storage.
def	_sampleEdge (self, n0, n1, old_n0, old_n1, size, vine)
	Sample from edge in the tree. More...

Private Attributes
	_upperTree
	_lowerTree

Constructor & Destructor Documentation

__init__()

def starvine.vine.tree.Vtree.__init__	(		self,
			data,
			lvl,
			parentTree = None,
			kwargs
	)

A generic tree within vine.

Parameters

data	DataFrame multivariate data set. Each data column will be assigned to a node.
lvl	int: tree level in the vine
weights	DataFrame: (optional) data weights
labels	list of str or ints: (optional) data labels

Member Function Documentation

_importTree()

def starvine.vine.tree.Vtree._importTree (   self,   existingTreeStruct  )

private

Imports an existing tree.

Checks tree for correctness.

Parameters

existingTreeStruct

list: list of tuples.

_optimNodePairs()

def starvine.vine.tree.Vtree._optimNodePairs (   self )

private

Computes the minimum spanning tree (R-vine) or tree which maximizes dependence.

(private method)

Virtual function.

Returns

list List of len 3 tuples:

[(dataLabel_1, dataLabel_2, kTau), ...]

_sampleEdge()

def starvine.vine.tree.Vtree._sampleEdge (   self,   n0,   n1,   old_n0,   old_n1,   size,   vine  )

private

Sample from edge in the tree.

Sample edge marked XXX:

Current Tree

(prev_n0) XXX (prev_n2) (prev_n1) n0 -------— edge_0 ----------— n1 ----------— edge_1 -----------— n0 : :

Next Tree

(next_u_n0) -----— next_edge ------— (next_u_n1)

To go "up" the vine requires evaluation of hinv-dist To traverse down the vine, evaluate the conditional h-dist function.

Parameters

n0	Wing node in current tree
n1	central node in current tree
old_n0	Node_0 from lowerTree edge
old_n1	Node_1 from lowerTree
size	int sample size

_setEdgeTriplets()

def starvine.vine.tree.Vtree._setEdgeTriplets (   self )

private

Applies to all non-zero level trees in the vine.

Every edge in the tree has 3 spanning nodes in the tree above. These nodes comprise a 'one fold triplet'. Sets the one fold triplet for each edge in current tree.

addNode()

def starvine.vine.tree.Vtree.addNode	(		self,
			dataLabel,
			data
	)

Add a node to the tree.

Prevents adding duplicate nodes.

Parameters

dataLabel	int or str
data	np_1darray

lowerTree()

def starvine.vine.tree.Vtree.lowerTree	(		self,
			lowerTree = None
	)

Gets lower tree.

Returns

starvine.vine.tree.Vtree object

setEdges()

def starvine.vine.tree.Vtree.setEdges	(		self,
			nodePairs = None
	)

Sets the node to node connections in the tree.

Parameters

nodePairs

list List of len 3 tuples: [(dataLabel_1, dataLabel_2, kTau), ...]

upperTree()

def starvine.vine.tree.Vtree.upperTree	(		self,
			upperTree = None
	)

Gets upper tree.

Returns

starvine.vine.tree.Vtree object

---

The documentation for this class was generated from the following file:

• starvine/vine/tree.py