VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCollapseVerticesByArray Class Reference

Collapse the graph given a vertex array. More...

#include <vtkCollapseVerticesByArray.h>

Inherits vtkGraphAlgorithm.

Public Types

typedef vtkGraphAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkCollapseVerticesByArrayNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void AddAggregateEdgeArray (const char *arrName)
 
void ClearAggregateEdgeArray ()
 
virtual bool GetAllowSelfLoops ()
 
virtual void SetAllowSelfLoops (bool)
 
virtual void AllowSelfLoopsOn ()
 
virtual void AllowSelfLoopsOff ()
 
virtual char * GetVertexArray ()
 
virtual void SetVertexArray (const char *)
 
virtual bool GetCountEdgesCollapsed ()
 
virtual void SetCountEdgesCollapsed (bool)
 
virtual void CountEdgesCollapsedOn ()
 
virtual void CountEdgesCollapsedOff ()
 
virtual char * GetEdgesCollapsedArray ()
 
virtual void SetEdgesCollapsedArray (const char *)
 
virtual bool GetCountVerticesCollapsed ()
 
virtual void SetCountVerticesCollapsed (bool)
 
virtual void CountVerticesCollapsedOn ()
 
virtual void CountVerticesCollapsedOff ()
 
virtual char * GetVerticesCollapsedArray ()
 
virtual void SetVerticesCollapsedArray (const char *)
 

Static Public Member Functions

static vtkCollapseVerticesByArrayNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCollapseVerticesByArraySafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkCollapseVerticesByArray ()
 
 ~vtkCollapseVerticesByArray ()
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
vtkGraph * Create (vtkGraph *inGraph)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
void FindEdge (vtkGraph *outGraph, vtkIdType source, vtkIdType target, vtkIdType &edgeId)
 

Protected Attributes

bool AllowSelfLoops
 
char * VertexArray
 
bool CountEdgesCollapsed
 
char * EdgesCollapsedArray
 
bool CountVerticesCollapsed
 
char * VerticesCollapsedArray
 
vtkCollapseVerticesByArrayInternal * Internal
 

Detailed Description

Collapse the graph given a vertex array.

vtkCollapseVerticesByArray is a class which collapses the graph using a vertex array as the key. So if the graph has vertices sharing common traits then this class combines all these vertices into one. This class does not perform aggregation on vertex data but allow to do so for edge data. Users can choose one or more edge data arrays for aggregation using AddAggregateEdgeArray function.

Tests:
vtkCollapseVerticesByArray (Tests)

Definition at line 40 of file vtkCollapseVerticesByArray.h.

Member Typedef Documentation

typedef vtkGraphAlgorithm vtkCollapseVerticesByArray::Superclass

Definition at line 44 of file vtkCollapseVerticesByArray.h.

Constructor & Destructor Documentation

vtkCollapseVerticesByArray::vtkCollapseVerticesByArray ( )
protected
vtkCollapseVerticesByArray::~vtkCollapseVerticesByArray ( )
protected

Member Function Documentation

static vtkCollapseVerticesByArray* vtkCollapseVerticesByArray::New ( )
static
static int vtkCollapseVerticesByArray::IsTypeOf ( const char *  type)
static
virtual int vtkCollapseVerticesByArray::IsA ( const char *  type)
virtual
static vtkCollapseVerticesByArray* vtkCollapseVerticesByArray::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkCollapseVerticesByArray::NewInstanceInternal ( ) const
protectedvirtual
vtkCollapseVerticesByArray* vtkCollapseVerticesByArray::NewInstance ( ) const
void vtkCollapseVerticesByArray::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual bool vtkCollapseVerticesByArray::GetAllowSelfLoops ( )
virtual

Boolean to allow self loops during collapse.

virtual void vtkCollapseVerticesByArray::SetAllowSelfLoops ( bool  )
virtual

Boolean to allow self loops during collapse.

virtual void vtkCollapseVerticesByArray::AllowSelfLoopsOn ( )
virtual

Boolean to allow self loops during collapse.

virtual void vtkCollapseVerticesByArray::AllowSelfLoopsOff ( )
virtual

Boolean to allow self loops during collapse.

void vtkCollapseVerticesByArray::AddAggregateEdgeArray ( const char *  arrName)

Add arrays on which aggregation of data is allowed. Default if replaced by the last value.

void vtkCollapseVerticesByArray::ClearAggregateEdgeArray ( )

Clear the list of arrays on which aggregation was set to allow.

virtual char* vtkCollapseVerticesByArray::GetVertexArray ( )
virtual

Set the array using which perform the collapse.

virtual void vtkCollapseVerticesByArray::SetVertexArray ( const char *  )
virtual

Set the array using which perform the collapse.

virtual bool vtkCollapseVerticesByArray::GetCountEdgesCollapsed ( )
virtual

Set if count should be made of how many edges collapsed.

virtual void vtkCollapseVerticesByArray::SetCountEdgesCollapsed ( bool  )
virtual

Set if count should be made of how many edges collapsed.

virtual void vtkCollapseVerticesByArray::CountEdgesCollapsedOn ( )
virtual

Set if count should be made of how many edges collapsed.

virtual void vtkCollapseVerticesByArray::CountEdgesCollapsedOff ( )
virtual

Set if count should be made of how many edges collapsed.

virtual char* vtkCollapseVerticesByArray::GetEdgesCollapsedArray ( )
virtual

Name of the array where the count of how many edges collapsed will be stored.By default the name of array is "EdgesCollapsedCountArray".

virtual void vtkCollapseVerticesByArray::SetEdgesCollapsedArray ( const char *  )
virtual

Name of the array where the count of how many edges collapsed will be stored.By default the name of array is "EdgesCollapsedCountArray".

virtual bool vtkCollapseVerticesByArray::GetCountVerticesCollapsed ( )
virtual

Get/Set if count should be made of how many vertices collapsed.

virtual void vtkCollapseVerticesByArray::SetCountVerticesCollapsed ( bool  )
virtual

Get/Set if count should be made of how many vertices collapsed.

virtual void vtkCollapseVerticesByArray::CountVerticesCollapsedOn ( )
virtual

Get/Set if count should be made of how many vertices collapsed.

virtual void vtkCollapseVerticesByArray::CountVerticesCollapsedOff ( )
virtual

Get/Set if count should be made of how many vertices collapsed.

virtual char* vtkCollapseVerticesByArray::GetVerticesCollapsedArray ( )
virtual

Name of the array where the count of how many vertices collapsed will be stored. By default name of the array is "VerticesCollapsedCountArray".

virtual void vtkCollapseVerticesByArray::SetVerticesCollapsedArray ( const char *  )
virtual

Name of the array where the count of how many vertices collapsed will be stored. By default name of the array is "VerticesCollapsedCountArray".

virtual int vtkCollapseVerticesByArray::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Pipeline function.

virtual int vtkCollapseVerticesByArray::FillOutputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Pipeline function.

vtkGraph* vtkCollapseVerticesByArray::Create ( vtkGraph *  inGraph)
protected

Create output graph given all the parameters. Helper function.

void vtkCollapseVerticesByArray::FindEdge ( vtkGraph *  outGraph,
vtkIdType  source,
vtkIdType  target,
vtkIdType &  edgeId 
)
protected

Helper function.

Member Data Documentation

bool vtkCollapseVerticesByArray::AllowSelfLoops
protected

Definition at line 134 of file vtkCollapseVerticesByArray.h.

char* vtkCollapseVerticesByArray::VertexArray
protected

Definition at line 135 of file vtkCollapseVerticesByArray.h.

bool vtkCollapseVerticesByArray::CountEdgesCollapsed
protected

Definition at line 137 of file vtkCollapseVerticesByArray.h.

char* vtkCollapseVerticesByArray::EdgesCollapsedArray
protected

Definition at line 138 of file vtkCollapseVerticesByArray.h.

bool vtkCollapseVerticesByArray::CountVerticesCollapsed
protected

Definition at line 140 of file vtkCollapseVerticesByArray.h.

char* vtkCollapseVerticesByArray::VerticesCollapsedArray
protected

Definition at line 141 of file vtkCollapseVerticesByArray.h.

vtkCollapseVerticesByArrayInternal* vtkCollapseVerticesByArray::Internal
protected

Definition at line 143 of file vtkCollapseVerticesByArray.h.


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