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>

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

Public Types

typedef vtkGraphAlgorithm Superclass
 
- Public Types inherited from vtkGraphAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

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 *)
 
- Public Member Functions inherited from vtkGraphAlgorithm
vtkGraphAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkGraphGetOutput ()
 
vtkGraphGetOutput (int index)
 
void SetInputData (vtkDataObject *obj)
 
void SetInputData (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformation * GetInputPortInformation (int port)
 
vtkInformation * GetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformation * GetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformation * GetInformation ()
 
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)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 

Static Public Member Functions

static vtkCollapseVerticesByArrayNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCollapseVerticesByArraySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkGraphAlgorithm
static vtkGraphAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGraphAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey * 
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 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 RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- 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)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
virtual void SetErrorCode (unsigned long)
 

Protected Attributes

bool AllowSelfLoops
 
char * VertexArray
 
bool CountEdgesCollapsed
 
char * EdgesCollapsedArray
 
bool CountVerticesCollapsed
 
char * VerticesCollapsedArray
 
vtkCollapseVerticesByArrayInternal * Internal
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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

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

Reimplemented from vtkGraphAlgorithm.

static vtkCollapseVerticesByArray* vtkCollapseVerticesByArray::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkCollapseVerticesByArray::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkGraphAlgorithm.

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.

Reimplemented from vtkGraphAlgorithm.

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

Pipeline function.

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 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: