VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkGraphHierarchicalBundle Class Reference

layout graph arcs in bundles More...

#include <vtkGraphHierarchicalBundle.h>

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

List of all members.

Public Types

typedef vtkPolyDataAlgorithm Superclass
- Public Types inherited from vtkPolyDataAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
int FillInputPortInformation (int port, vtkInformation *info)
virtual void SetBundlingStrength (double)
virtual double GetBundlingStrength ()
virtual void SetDirectMapping (bool)
virtual bool GetDirectMapping ()
virtual void DirectMappingOn ()
virtual void DirectMappingOff ()
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkPolyDataGetPolyDataInput (int port)
vtkPolyDataGetOutput ()
vtkPolyDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
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
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkGraphHierarchicalBundleNew ()
static int IsTypeOf (const char *type)
static vtkGraphHierarchicalBundleSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkGraphHierarchicalBundle ()
 ~vtkGraphHierarchicalBundle ()
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 ~vtkPolyDataAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

double BundlingStrength
bool DirectMapping
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Additional Inherited Members


Detailed Description

layout graph arcs in bundles

This algorithm creates a vtkPolyData from a vtkGraph. As opposed to vtkGraphToPolyData, which converts each arc into a straight line, each arc is converted to a polyline, following a tree structure. The filter requires both a vtkGraph and vtkTree as input. The tree vertices must be a superset of the graph vertices. A common example is when the graph vertices correspond to the leaves of the tree, but the internal vertices of the tree represent groupings of graph vertices. The algorithm matches the vertices using the array "PedigreeId". The user may alternately set the DirectMapping flag to indicate that the two structures must have directly corresponding offsets (i.e. node i in the graph must correspond to node i in the tree).

The vtkGraph defines the topology of the output vtkPolyData (i.e. the connections between nodes) while the vtkTree defines the geometry (i.e. the location of nodes and arc routes). Thus, the tree must have been assigned vertex locations, but the graph does not need locations, in fact they will be ignored. The edges approximately follow the path from the source to target nodes in the tree. A bundling parameter controls how closely the edges are bundled together along the tree structure.

You may follow this algorithm with vtkSplineFilter in order to make nicely curved edges.

Thanks:
This algorithm was developed in the paper Danny Holten. Hierarchical Edge Bundles: Visualization of Adjacency Relations Relations in Hierarchical Data. IEEE Transactions on Visualization and Computer Graphics, Vol. 12, No. 5, 2006. pp. 741-748.
Tests:
vtkGraphHierarchicalBundle (Tests)

Definition at line 62 of file vtkGraphHierarchicalBundle.h.


Member Typedef Documentation

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 67 of file vtkGraphHierarchicalBundle.h.


Constructor & Destructor Documentation

vtkGraphHierarchicalBundle::vtkGraphHierarchicalBundle ( )
protected
vtkGraphHierarchicalBundle::~vtkGraphHierarchicalBundle ( )
inlineprotected

Definition at line 92 of file vtkGraphHierarchicalBundle.h.


Member Function Documentation

static vtkGraphHierarchicalBundle* vtkGraphHierarchicalBundle::New ( )
static

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

Reimplemented from vtkPolyDataAlgorithm.

virtual const char* vtkGraphHierarchicalBundle::GetClassName ( )
virtual

Reimplemented from vtkPolyDataAlgorithm.

static int vtkGraphHierarchicalBundle::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 vtkPolyDataAlgorithm.

virtual int vtkGraphHierarchicalBundle::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 vtkPolyDataAlgorithm.

static vtkGraphHierarchicalBundle* vtkGraphHierarchicalBundle::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkPolyDataAlgorithm.

void vtkGraphHierarchicalBundle::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 vtkPolyDataAlgorithm.

virtual void vtkGraphHierarchicalBundle::SetBundlingStrength ( double  )
virtual

The level of arc bundling in the graph. A strength of 0 creates straight lines, while a strength of 1 forces arcs to pass directly through hierarchy node points. The default value is 0.8.

virtual double vtkGraphHierarchicalBundle::GetBundlingStrength ( )
virtual

The level of arc bundling in the graph. A strength of 0 creates straight lines, while a strength of 1 forces arcs to pass directly through hierarchy node points. The default value is 0.8.

virtual void vtkGraphHierarchicalBundle::SetDirectMapping ( bool  )
virtual

If on, uses direct mapping from tree to graph vertices. If off, both the graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default is off.

virtual bool vtkGraphHierarchicalBundle::GetDirectMapping ( )
virtual

If on, uses direct mapping from tree to graph vertices. If off, both the graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default is off.

virtual void vtkGraphHierarchicalBundle::DirectMappingOn ( )
virtual

If on, uses direct mapping from tree to graph vertices. If off, both the graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default is off.

virtual void vtkGraphHierarchicalBundle::DirectMappingOff ( )
virtual

If on, uses direct mapping from tree to graph vertices. If off, both the graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default is off.

int vtkGraphHierarchicalBundle::FillInputPortInformation ( int  port,
vtkInformation info 
)
virtual

Set the input type of the algorithm to vtkGraph.

Reimplemented from vtkPolyDataAlgorithm.

int vtkGraphHierarchicalBundle::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Convert the vtkGraph into vtkPolyData.

Reimplemented from vtkPolyDataAlgorithm.


Member Data Documentation

double vtkGraphHierarchicalBundle::BundlingStrength
protected

Definition at line 94 of file vtkGraphHierarchicalBundle.h.

bool vtkGraphHierarchicalBundle::DirectMapping
protected

Definition at line 95 of file vtkGraphHierarchicalBundle.h.


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