vtkBoostBetweennessClustering Class Reference
#include <vtkBoostBetweennessClustering.h>
Detailed Description
Implements graph clustering based on edge betweenness centrality.This vtk class uses the Boost centrality clustering generic algorithm to compute edge betweenness centrality on the input graph (a vtkGraph).
- See also:
- vtkGraph vtkBoostGraphAdapter
Definition at line 38 of file vtkBoostBetweennessClustering.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) |
| vtkBoostBetweennessClustering () | |
| virtual | ~vtkBoostBetweennessClustering () |
| virtual void | SetInvertEdgeWeightArray (bool) |
| virtual void | InvertEdgeWeightArrayOn () |
| virtual void | InvertEdgeWeightArrayOff () |
| virtual void | SetThreshold (double) |
| virtual double | GetThreshold () |
| virtual void | SetUseEdgeWeightArray (bool) |
| virtual void | UseEdgeWeightArrayOn () |
| virtual void | UseEdgeWeightArrayOff () |
| virtual char * | GetEdgeWeightArrayName () |
| virtual void | SetEdgeWeightArrayName (const char *) |
| virtual void | SetEdgeCentralityArrayName (const char *) |
Static Public Member Functions | |
| static vtkBoostBetweennessClustering * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkBoostBetweennessClustering * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| virtual int | RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
| virtual int | FillOutputPortInformation (int port, vtkInformation *info) |
Member Typedef Documentation
Reimplemented from vtkGraphAlgorithm.
Definition at line 43 of file vtkBoostBetweennessClustering.h.
Constructor & Destructor Documentation
| vtkBoostBetweennessClustering::vtkBoostBetweennessClustering | ( | ) |
| virtual vtkBoostBetweennessClustering::~vtkBoostBetweennessClustering | ( | ) | [virtual] |
Member Function Documentation
| static vtkBoostBetweennessClustering* vtkBoostBetweennessClustering::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkGraphAlgorithm.
| virtual const char* vtkBoostBetweennessClustering::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkGraphAlgorithm.
| static int vtkBoostBetweennessClustering::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 vtkBoostBetweennessClustering::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 vtkBoostBetweennessClustering* vtkBoostBetweennessClustering::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkGraphAlgorithm.
| void vtkBoostBetweennessClustering::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 vtkBoostBetweennessClustering::SetThreshold | ( | double | ) | [virtual] |
Get/Set the threshold value. Algorithm terminats when the maximum edge centrality is below this threshold.
| virtual double vtkBoostBetweennessClustering::GetThreshold | ( | ) | [virtual] |
Get/Set the threshold value. Algorithm terminats when the maximum edge centrality is below this threshold.
| virtual void vtkBoostBetweennessClustering::SetUseEdgeWeightArray | ( | bool | ) | [virtual] |
Get/Set the flag that sets the rule whether or not to use the edge weight array as set using SetEdgeWeightArrayName.
| virtual void vtkBoostBetweennessClustering::UseEdgeWeightArrayOn | ( | ) | [virtual] |
Get/Set the flag that sets the rule whether or not to use the edge weight array as set using SetEdgeWeightArrayName.
| virtual void vtkBoostBetweennessClustering::UseEdgeWeightArrayOff | ( | ) | [virtual] |
Get/Set the flag that sets the rule whether or not to use the edge weight array as set using SetEdgeWeightArrayName.
| virtual void vtkBoostBetweennessClustering::SetInvertEdgeWeightArray | ( | bool | ) | [virtual] |
| virtual void vtkBoostBetweennessClustering::InvertEdgeWeightArrayOn | ( | ) | [virtual] |
| virtual void vtkBoostBetweennessClustering::InvertEdgeWeightArrayOff | ( | ) | [virtual] |
| virtual char* vtkBoostBetweennessClustering::GetEdgeWeightArrayName | ( | ) | [virtual] |
Get/Set the name of the array that needs to be used as the edge weight. The array should be a vtkDataArray.
| virtual void vtkBoostBetweennessClustering::SetEdgeWeightArrayName | ( | const char * | ) | [virtual] |
Get/Set the name of the array that needs to be used as the edge weight. The array should be a vtkDataArray.
| virtual void vtkBoostBetweennessClustering::SetEdgeCentralityArrayName | ( | const char * | ) | [virtual] |
Set the edge centrality array name. If no output array name is set then the name "edge_centrality" is used.
| virtual int vtkBoostBetweennessClustering::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.
| virtual int vtkBoostBetweennessClustering::FillOutputPortInformation | ( | int | port, | |
| vtkInformation * | info | |||
| ) | [protected, virtual] |
Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkGraphAlgorithm.
The documentation for this class was generated from the following file:
- dox/Infovis/vtkBoostBetweennessClustering.h
