vtkStreamGraph Class Reference

#include <vtkStreamGraph.h>

Inheritance diagram for vtkStreamGraph:

Inheritance graph
[legend]
Collaboration diagram for vtkStreamGraph:

Collaboration graph
[legend]

List of all members.


Detailed Description

combines two graphs

vtkStreamGraph iteratively collects information from the input graph and combines it in the output graph. It internally maintains a graph instance that is incrementally updated every time the filter is called.

Each update, vtkMergeGraphs is used to combine this filter's input with the internal graph.

If you can use an edge window array to filter out old edges based on a moving threshold.

Events:
vtkCommand::ProgressEvent
Tests:
vtkStreamGraph (Tests)

Definition at line 53 of file vtkStreamGraph.h.


Public Types

typedef vtkGraphAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetUseEdgeWindow (bool)
virtual bool GetUseEdgeWindow ()
virtual void UseEdgeWindowOn ()
virtual void UseEdgeWindowOff ()
virtual void SetEdgeWindowArrayName (const char *)
virtual char * GetEdgeWindowArrayName ()
virtual void SetEdgeWindow (double)
virtual double GetEdgeWindow ()

Static Public Member Functions

static vtkStreamGraphNew ()
static int IsTypeOf (const char *type)
static vtkStreamGraphSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkStreamGraph ()
 ~vtkStreamGraph ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

vtkMutableGraphHelperCurrentGraph
vtkMergeGraphsMergeGraphs
bool UseEdgeWindow
double EdgeWindow
char * EdgeWindowArrayName

Member Typedef Documentation

Reimplemented from vtkGraphAlgorithm.

Definition at line 57 of file vtkStreamGraph.h.


Constructor & Destructor Documentation

vtkStreamGraph::vtkStreamGraph (  )  [protected]

vtkStreamGraph::~vtkStreamGraph (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkGraphAlgorithm.

virtual const char* vtkStreamGraph::GetClassName (  )  [virtual]

Reimplemented from vtkGraphAlgorithm.

static int vtkStreamGraph::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 vtkGraphAlgorithm.

virtual int vtkStreamGraph::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 vtkGraphAlgorithm.

static vtkStreamGraph* vtkStreamGraph::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkGraphAlgorithm.

void vtkStreamGraph::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 vtkGraphAlgorithm.

virtual void vtkStreamGraph::SetUseEdgeWindow ( bool   )  [virtual]

Whether to use an edge window array. The default is to not use a window array.

virtual bool vtkStreamGraph::GetUseEdgeWindow (  )  [virtual]

Whether to use an edge window array. The default is to not use a window array.

virtual void vtkStreamGraph::UseEdgeWindowOn (  )  [virtual]

Whether to use an edge window array. The default is to not use a window array.

virtual void vtkStreamGraph::UseEdgeWindowOff (  )  [virtual]

Whether to use an edge window array. The default is to not use a window array.

virtual void vtkStreamGraph::SetEdgeWindowArrayName ( const char *   )  [virtual]

The edge window array. The default array name is "time".

virtual char* vtkStreamGraph::GetEdgeWindowArrayName (  )  [virtual]

The edge window array. The default array name is "time".

virtual void vtkStreamGraph::SetEdgeWindow ( double   )  [virtual]

The time window amount. Edges with values lower than the maximum value minus this window will be removed from the graph. The default edge window is 10000.

virtual double vtkStreamGraph::GetEdgeWindow (  )  [virtual]

The time window amount. Edges with values lower than the maximum value minus this window will be removed from the graph. The default edge window is 10000.

virtual int vtkStreamGraph::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkGraphAlgorithm.


Member Data Documentation

Definition at line 91 of file vtkStreamGraph.h.

Definition at line 92 of file vtkStreamGraph.h.

Definition at line 93 of file vtkStreamGraph.h.

double vtkStreamGraph::EdgeWindow [protected]

Definition at line 94 of file vtkStreamGraph.h.

Definition at line 95 of file vtkStreamGraph.h.


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

Generated on Wed Aug 24 12:08:59 2011 for VTK by  doxygen 1.5.6