A 2D graphics item for rendering a tree and an associated heatmap. More...

#include <vtkTreeHeatmapItem.h>

Inheritance diagram for vtkTreeHeatmapItem:

Collaboration diagram for vtkTreeHeatmapItem:

Public Types
typedef vtkContextItem	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkTreeHeatmapItem *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetTree (vtkTree *tree)
vtkTree *	GetTree ()
virtual void	SetColumnTree (vtkTree *tree)
vtkTree *	GetColumnTree ()
virtual void	SetTable (vtkTable *table)
vtkTable *	GetTable ()
void	ReorderTable ()
void	ReverseTableRows ()
void	ReverseTableColumns ()
void	SetOrientation (int orientation)
int	GetOrientation ()
void	GetBounds (double bounds[4])
void	GetCenter (double center[2])
void	GetSize (double size[2])
void	CollapseToNumberOfLeafNodes (unsigned int n)
vtkTree *	GetPrunedTree ()
void	SetTreeColorArray (const char *arrayName)
virtual bool	Hit (const vtkContextMouseEvent &mouse)
virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &event)

vtkSmartPointer < vtkDendrogramItem >	GetDendrogram ()
void	SetDendrogram (vtkSmartPointer< vtkDendrogramItem >)

vtkSmartPointer< vtkHeatmapItem >	GetHeatmap ()
void	SetHeatmap (vtkSmartPointer< vtkHeatmapItem >)

float	GetTreeLineWidth ()
void	SetTreeLineWidth (float width)
Static Public Member Functions
static vtkTreeHeatmapItem *	New ()
static int	IsTypeOf (const char *type)
static vtkTreeHeatmapItem *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkTreeHeatmapItem ()
	~vtkTreeHeatmapItem ()
virtual bool	Paint (vtkContext2D *painter)
void	CollapseHeatmapRows ()
void	CollapseHeatmapColumns ()
Protected Attributes
vtkSmartPointer < vtkDendrogramItem >	Dendrogram
vtkSmartPointer < vtkDendrogramItem >	ColumnDendrogram
vtkSmartPointer< vtkHeatmapItem >	Heatmap
int	Orientation

Detailed Description

A 2D graphics item for rendering a tree and an associated heatmap.

This item draws a tree and a heatmap as a part of a vtkContextScene. The input tree's vertex data must contain at least two arrays. The first required array is a vtkStringArray called "node name". This array corresponds to the first column of the input table. The second required array is a scalar array called "node weight". This array is used by vtkTreeLayoutStrategy to set any particular node's distance from the root of the tree.

The vtkNewickTreeReader automatically initializes both of these required arrays in its output tree.

Tests:: vtkTreeHeatmapItem (Tests)

Definition at line 54 of file vtkTreeHeatmapItem.h.

Member Typedef Documentation

typedef vtkContextItem vtkTreeHeatmapItem::Superclass

Reimplemented from vtkContextItem.

Definition at line 58 of file vtkTreeHeatmapItem.h.

Constructor & Destructor Documentation

vtkTreeHeatmapItem::vtkTreeHeatmapItem ( ) [protected]

vtkTreeHeatmapItem::~vtkTreeHeatmapItem ( ) [protected]

Member Function Documentation

static vtkTreeHeatmapItem* vtkTreeHeatmapItem::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkTreeHeatmapItem::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkContextItem.

virtual int vtkTreeHeatmapItem::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkContextItem.

static vtkTreeHeatmapItem* vtkTreeHeatmapItem::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkContextItem.

virtual vtkObjectBase* vtkTreeHeatmapItem::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkContextItem.

vtkTreeHeatmapItem* vtkTreeHeatmapItem::NewInstance ( ) const

Reimplemented from vtkContextItem.

virtual void vtkTreeHeatmapItem::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkContextItem.

virtual void vtkTreeHeatmapItem::SetTree ( vtkTree * tree ) [virtual]

Set the tree that this item draws. Note that this tree's vertex data must contain a vtkStringArray called "node name". Additionally, this array must contain the same values as the first column of the input table. See SetTable for more information. The vtkNewickTreeReader automatically creates this required array for you.

vtkTree* vtkTreeHeatmapItem::GetTree ( )

Get the tree that this item draws.

virtual void vtkTreeHeatmapItem::SetColumnTree ( vtkTree * tree ) [virtual]

Set a tree to be drawn for the columns of the heatmap. This tree's vertex data must contain a vtkStringArray called "node name" that corresponds to the names of the columns in the heatmap.

vtkTree* vtkTreeHeatmapItem::GetColumnTree ( )

Get the tree that represents the columns of the heatmap (if one has been set).

virtual void vtkTreeHeatmapItem::SetTable ( vtkTable * table ) [virtual]

Set the table that this item draws. The first column of the table must contain the names of the rows. These names, in turn, must correspond with the nodes names in the input tree. See SetTree for more information.

vtkTable* vtkTreeHeatmapItem::GetTable ( )

Get the table that this item draws.

vtkSmartPointer<vtkDendrogramItem> vtkTreeHeatmapItem::GetDendrogram ( )

Get/Set the dendrogram contained by this item.

void vtkTreeHeatmapItem::SetDendrogram ( vtkSmartPointer< vtkDendrogramItem > )

Get/Set the dendrogram contained by this item.

vtkSmartPointer<vtkHeatmapItem> vtkTreeHeatmapItem::GetHeatmap ( )

Get/Set the heatmap contained by this item.

void vtkTreeHeatmapItem::SetHeatmap ( vtkSmartPointer< vtkHeatmapItem > )

Get/Set the heatmap contained by this item.

void vtkTreeHeatmapItem::ReorderTable ( )

Reorder the rows in the table so they match the order of the leaf nodes in our tree.

void vtkTreeHeatmapItem::ReverseTableRows ( )

Reverse the order of the rows in our input table. This is used to simplify the table layout for DOWN_TO_UP and RIGHT_TO_LEFT orientations.

void vtkTreeHeatmapItem::ReverseTableColumns ( )

Reverse the order of the rows in our input table. This is used to simplify the table layout for DOWN_TO_UP and UP_TO_DOWN orientations.

void vtkTreeHeatmapItem::SetOrientation ( int orientation )

Set which way the tree / heatmap should face within the visualization. The default is for both components to be drawn left to right.

int vtkTreeHeatmapItem::GetOrientation ( )

Get the current orientation.

void vtkTreeHeatmapItem::GetBounds ( double bounds[4] )

Get the bounds of this item (xMin, xMax, yMin, Max) in pixel coordinates.

void vtkTreeHeatmapItem::GetCenter ( double center[2] )

Get the center point of this item in pixel coordinates.

void vtkTreeHeatmapItem::GetSize ( double size[2] )

Get the size of this item in pixel coordinates.

void vtkTreeHeatmapItem::CollapseToNumberOfLeafNodes ( unsigned int n )

Collapse subtrees until there are only n leaf nodes left in the tree. The leaf nodes that remain are those that are closest to the root. Any subtrees that were collapsed prior to this function being called may be re-expanded. Use this function instead of this->GetDendrogram->CollapseToNumberOfLeafNodes(), as this function also handles the hiding of heatmap rows that correspond to newly collapsed subtrees.

float vtkTreeHeatmapItem::GetTreeLineWidth ( )

Get/Set how wide the edges of the trees should be. Default is one pixel.

void vtkTreeHeatmapItem::SetTreeLineWidth ( float width )

Get/Set how wide the edges of the trees should be. Default is one pixel.

vtkTree* vtkTreeHeatmapItem::GetPrunedTree ( )

Deprecated. Use this->GetDendrogram()->GetPrunedTree() instead.

void vtkTreeHeatmapItem::SetTreeColorArray ( const char * arrayName )

Deprecated. Use this->GetDendrogram()->SetColorArray(const char *arrayName) instead.

virtual bool vtkTreeHeatmapItem::Hit ( const vtkContextMouseEvent & mouse ) [virtual]

Returns true if the transform is interactive, false otherwise.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkTreeHeatmapItem::MouseDoubleClickEvent ( const vtkContextMouseEvent & event ) [virtual]