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

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

#include <vtkCollapseVerticesByArray.h>

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

List of all members.

Public Types

typedef vtkGraphAlgorithm Superclass
- Public Types inherited from vtkGraphAlgorithm
- 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)
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 *)
- Public Member Functions inherited from vtkGraphAlgorithm
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkGraphGetOutput ()
vtkGraphGetOutput (int index)
void SetInput (vtkDataObject *obj)
void SetInput (int index, vtkDataObject *obj)
- 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 vtkCollapseVerticesByArrayNew ()
static int IsTypeOf (const char *type)
static vtkCollapseVerticesByArraySafeDownCast (vtkObject *o)

Protected Member Functions

 vtkCollapseVerticesByArray ()
 ~vtkCollapseVerticesByArray ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
vtkGraphCreate (vtkGraph *inGraph)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
void FindEdge (vtkGraph *outGraph, vtkIdType source, vtkIdType target, vtkIdType &edgeId)
- Protected Member Functions inherited from vtkGraphAlgorithm
 vtkGraphAlgorithm ()
 ~vtkGraphAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- 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

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 39 of file vtkCollapseVerticesByArray.h.


Member Typedef Documentation

Reimplemented from vtkGraphAlgorithm.

Definition at line 43 of file vtkCollapseVerticesByArray.h.


Constructor & Destructor Documentation

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

Member Function Documentation

static vtkCollapseVerticesByArray* vtkCollapseVerticesByArray::New ( )
static

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

Reimplemented from vtkGraphAlgorithm.

virtual const char* vtkCollapseVerticesByArray::GetClassName ( )
virtual

Reimplemented from vtkGraphAlgorithm.

static int vtkCollapseVerticesByArray::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 vtkCollapseVerticesByArray::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 vtkCollapseVerticesByArray* vtkCollapseVerticesByArray::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkGraphAlgorithm.

void vtkCollapseVerticesByArray::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 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.

Reimplemented from vtkGraphAlgorithm.

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

Pipeline funtion.

Reimplemented from vtkGraphAlgorithm.

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 133 of file vtkCollapseVerticesByArray.h.

char* vtkCollapseVerticesByArray::VertexArray
protected

Definition at line 134 of file vtkCollapseVerticesByArray.h.

bool vtkCollapseVerticesByArray::CountEdgesCollapsed
protected

Definition at line 136 of file vtkCollapseVerticesByArray.h.

char* vtkCollapseVerticesByArray::EdgesCollapsedArray
protected

Definition at line 137 of file vtkCollapseVerticesByArray.h.

bool vtkCollapseVerticesByArray::CountVerticesCollapsed
protected

Definition at line 139 of file vtkCollapseVerticesByArray.h.

char* vtkCollapseVerticesByArray::VerticesCollapsedArray
protected

Definition at line 140 of file vtkCollapseVerticesByArray.h.

vtkCollapseVerticesByArrayInternal* vtkCollapseVerticesByArray::Internal
protected

Definition at line 142 of file vtkCollapseVerticesByArray.h.


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