VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTreeHeatmapItem Class Reference

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

#include <vtkTreeHeatmapItem.h>

Inheritance diagram for vtkTreeHeatmapItem:
[legend]
Collaboration diagram for vtkTreeHeatmapItem:
[legend]

Public Types

typedef vtkContextItem Superclass
 
- Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem Superclass
 
- Public Types inherited from vtkAbstractContextItem
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkTreeHeatmapItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetTree (vtkTree *tree)
 Set the tree that this item draws. More...
 
vtkTreeGetTree ()
 Get the tree that this item draws. More...
 
virtual void SetColumnTree (vtkTree *tree)
 Set a tree to be drawn for the columns of the heatmap. More...
 
vtkTreeGetColumnTree ()
 Get the tree that represents the columns of the heatmap (if one has been set). More...
 
virtual void SetTable (vtkTable *table)
 Set the table that this item draws. More...
 
vtkTableGetTable ()
 Get the table that this item draws. More...
 
vtkDendrogramItemGetDendrogram ()
 Get/Set the dendrogram contained by this item. More...
 
void SetDendrogram (vtkDendrogramItem *dendrogram)
 
vtkHeatmapItemGetHeatmap ()
 Get/Set the heatmap contained by this item. More...
 
void SetHeatmap (vtkHeatmapItem *heatmap)
 
void ReorderTable ()
 Reorder the rows in the table so they match the order of the leaf nodes in our tree. More...
 
void ReverseTableRows ()
 Reverse the order of the rows in our input table. More...
 
void ReverseTableColumns ()
 Reverse the order of the rows in our input table. More...
 
void SetOrientation (int orientation)
 Set which way the tree / heatmap should face within the visualization. More...
 
int GetOrientation ()
 Get the current orientation. More...
 
void GetBounds (double bounds[4])
 Get the bounds of this item (xMin, xMax, yMin, Max) in pixel coordinates. More...
 
void GetCenter (double center[2])
 Get the center point of this item in pixel coordinates. More...
 
void GetSize (double size[2])
 Get the size of this item in pixel coordinates. More...
 
void CollapseToNumberOfLeafNodes (unsigned int n)
 Collapse subtrees until there are only n leaf nodes left in the tree. More...
 
float GetTreeLineWidth ()
 Get/Set how wide the edges of the trees should be. More...
 
void SetTreeLineWidth (float width)
 
vtkTreeGetPrunedTree ()
 Deprecated. More...
 
void SetTreeColorArray (const char *arrayName)
 Deprecated. More...
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Returns true if the transform is interactive, false otherwise. More...
 
bool MouseDoubleClickEvent (const vtkContextMouseEvent &event) override
 Propagate any double click onto the dendrogram to check if any subtrees should be collapsed or expanded. More...
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
virtual double GetOpacity ()
 Get the opacity of the item. More...
 
virtual void SetOpacity (double)
 Set the opacity of the item. More...
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
virtual void Update ()
 Perform any updates to the item that may be necessary before rendering. More...
 
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered. More...
 
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item. More...
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index. More...
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex. More...
 
vtkIdType GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack. More...
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling. More...
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling. More...
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse. More...
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event. More...
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 Mouse move event. More...
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event. More...
 
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
 Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items. More...
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release event. More...
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event. More...
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event. More...
 
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene. More...
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene. More...
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item. More...
 
vtkAbstractContextItemGetParent ()
 Get the parent item. More...
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system. More...
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system. More...
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system. More...
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system. More...
 
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn). More...
 
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn). More...
 
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events). More...
 
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTreeHeatmapItemNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTreeHeatmapItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTreeHeatmapItem ()
 
 ~vtkTreeHeatmapItem () override
 
bool Paint (vtkContext2D *painter) override
 Paints the tree & associated table as a heatmap. More...
 
void CollapseHeatmapRows ()
 Mark heatmap rows as hidden when a subtree is collapsed. More...
 
void CollapseHeatmapColumns ()
 Mark heatmap columns as hidden when a subtree is collapsed. More...
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem () override
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkDendrogramItemDendrogram
 
vtkSmartPointer< vtkDendrogramItemColumnDendrogram
 
vtkSmartPointer< vtkHeatmapItemHeatmap
 
int Orientation
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 Point to the scene the item is on - can be null. More...
 
vtkAbstractContextItemParent
 Point to the parent item - can be null. More...
 
vtkContextScenePrivateChildren
 This structure provides a list of children, along with convenience functions to paint the children etc. More...
 
bool Visible
 Store the visibility of the item (default is true). More...
 
bool Interactive
 Store whether the item should respond to interactions (default is true). More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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.

.SEE ALSO vtkDendrogramItem vtkHeatmapItem vtkTree vtkTable vtkNewickTreeReader

Tests:
vtkTreeHeatmapItem (Tests)

Definition at line 55 of file vtkTreeHeatmapItem.h.

Member Typedef Documentation

◆ Superclass

Definition at line 59 of file vtkTreeHeatmapItem.h.

Constructor & Destructor Documentation

◆ vtkTreeHeatmapItem()

vtkTreeHeatmapItem::vtkTreeHeatmapItem ( )
protected

◆ ~vtkTreeHeatmapItem()

vtkTreeHeatmapItem::~vtkTreeHeatmapItem ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkTreeHeatmapItem* vtkTreeHeatmapItem::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkTreeHeatmapItem::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTreeHeatmapItem::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkContextItem.

◆ NewInstance()

vtkTreeHeatmapItem* vtkTreeHeatmapItem::NewInstance ( ) const

◆ PrintSelf()

void vtkTreeHeatmapItem::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ SetTree()

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.

◆ GetTree()

vtkTree* vtkTreeHeatmapItem::GetTree ( )

Get the tree that this item draws.

◆ SetColumnTree()

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.

◆ GetColumnTree()

vtkTree* vtkTreeHeatmapItem::GetColumnTree ( )

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

◆ SetTable()

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.

◆ GetTable()

vtkTable* vtkTreeHeatmapItem::GetTable ( )

Get the table that this item draws.

◆ GetDendrogram()

vtkDendrogramItem* vtkTreeHeatmapItem::GetDendrogram ( )

Get/Set the dendrogram contained by this item.

◆ SetDendrogram()

void vtkTreeHeatmapItem::SetDendrogram ( vtkDendrogramItem dendrogram)

◆ GetHeatmap()

vtkHeatmapItem* vtkTreeHeatmapItem::GetHeatmap ( )

Get/Set the heatmap contained by this item.

◆ SetHeatmap()

void vtkTreeHeatmapItem::SetHeatmap ( vtkHeatmapItem heatmap)

◆ ReorderTable()

void vtkTreeHeatmapItem::ReorderTable ( )

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

◆ ReverseTableRows()

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.

◆ ReverseTableColumns()

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.

◆ SetOrientation()

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.

◆ GetOrientation()

int vtkTreeHeatmapItem::GetOrientation ( )

Get the current orientation.

◆ GetBounds()

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

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

◆ GetCenter()

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

Get the center point of this item in pixel coordinates.

◆ GetSize()

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

Get the size of this item in pixel coordinates.

◆ CollapseToNumberOfLeafNodes()

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.

◆ GetTreeLineWidth()

float vtkTreeHeatmapItem::GetTreeLineWidth ( )

Get/Set how wide the edges of the trees should be.

Default is one pixel.

◆ SetTreeLineWidth()

void vtkTreeHeatmapItem::SetTreeLineWidth ( float  width)

◆ GetPrunedTree()

vtkTree* vtkTreeHeatmapItem::GetPrunedTree ( )

Deprecated.

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

◆ SetTreeColorArray()

void vtkTreeHeatmapItem::SetTreeColorArray ( const char *  arrayName)

Deprecated.

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

◆ Hit()

bool vtkTreeHeatmapItem::Hit ( const vtkContextMouseEvent mouse)
overridevirtual

Returns true if the transform is interactive, false otherwise.

Reimplemented from vtkAbstractContextItem.

◆ MouseDoubleClickEvent()

bool vtkTreeHeatmapItem::MouseDoubleClickEvent ( const vtkContextMouseEvent event)
overridevirtual

Propagate any double click onto the dendrogram to check if any subtrees should be collapsed or expanded.

Reimplemented from vtkAbstractContextItem.

◆ Paint()

bool vtkTreeHeatmapItem::Paint ( vtkContext2D painter)
overrideprotectedvirtual

Paints the tree & associated table as a heatmap.

Reimplemented from vtkAbstractContextItem.

◆ CollapseHeatmapRows()

void vtkTreeHeatmapItem::CollapseHeatmapRows ( )
protected

Mark heatmap rows as hidden when a subtree is collapsed.

◆ CollapseHeatmapColumns()

void vtkTreeHeatmapItem::CollapseHeatmapColumns ( )
protected

Mark heatmap columns as hidden when a subtree is collapsed.

Member Data Documentation

◆ Dendrogram

vtkSmartPointer<vtkDendrogramItem> vtkTreeHeatmapItem::Dendrogram
protected

Definition at line 223 of file vtkTreeHeatmapItem.h.

◆ ColumnDendrogram

vtkSmartPointer<vtkDendrogramItem> vtkTreeHeatmapItem::ColumnDendrogram
protected

Definition at line 224 of file vtkTreeHeatmapItem.h.

◆ Heatmap

vtkSmartPointer<vtkHeatmapItem> vtkTreeHeatmapItem::Heatmap
protected

Definition at line 225 of file vtkTreeHeatmapItem.h.

◆ Orientation

int vtkTreeHeatmapItem::Orientation
protected

Definition at line 226 of file vtkTreeHeatmapItem.h.


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