Contructs a minimum spanning tree from a graph, start node, and the weighting array. More...
#include <vtkBoostPrimMinimumSpanningTree.h>
Detailed Description
Contructs a minimum spanning tree from a graph, start node, and the weighting array.
This vtk class uses the Boost Prim Minimum Spanning Tree generic algorithm to perform a minimum spanning tree creation given a weighting value for each of the edges in the input graph and a a starting node for the tree. A couple of caveats to be noted with the Prim implementation versus the Kruskal implementation:
- The negate edge weights function cannot be utilized to obtain a 'maximal' spanning tree (an exception is thrown when negated edge weights exist), and
- the Boost implementation of the Prim algorithm returns a vertex predecessor map which results in some ambiguity about which edge from the original graph should be utilized if parallel edges between nodes exist; therefore, the current VTK implementation does not copy the edge data from the graph to the new tree.
- See also:
- vtkGraph vtkBoostGraphAdapter
Definition at line 57 of file vtkBoostPrimMinimumSpanningTree.h.
Member Typedef Documentation
Reimplemented from vtkTreeAlgorithm.
Definition at line 61 of file vtkBoostPrimMinimumSpanningTree.h.
Constructor & Destructor Documentation
| vtkBoostPrimMinimumSpanningTree::vtkBoostPrimMinimumSpanningTree | ( | ) | [protected] |
Member Function Documentation
| static vtkBoostPrimMinimumSpanningTree* vtkBoostPrimMinimumSpanningTree::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkTreeAlgorithm.
| static int vtkBoostPrimMinimumSpanningTree::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 vtkTreeAlgorithm.
| virtual int vtkBoostPrimMinimumSpanningTree::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 vtkTreeAlgorithm.
| static vtkBoostPrimMinimumSpanningTree* vtkBoostPrimMinimumSpanningTree::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkTreeAlgorithm.
| virtual vtkObjectBase* vtkBoostPrimMinimumSpanningTree::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkTreeAlgorithm.
Reimplemented from vtkTreeAlgorithm.
| void vtkBoostPrimMinimumSpanningTree::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 vtkTreeAlgorithm.
| virtual void vtkBoostPrimMinimumSpanningTree::SetEdgeWeightArrayName | ( | const char * | ) | [virtual] |
Set the name of the edge-weight input array, which must name an array that is part of the edge data of the input graph and contains numeric data. If the edge-weight array is not of type vtkDoubleArray, the array will be copied into a temporary vtkDoubleArray.
| void vtkBoostPrimMinimumSpanningTree::SetOriginVertex | ( | vtkIdType | index | ) |
Set the index (into the vertex array) of the minimum spanning tree 'origin' vertex.
| void vtkBoostPrimMinimumSpanningTree::SetOriginVertex | ( | vtkStdString | arrayName, |
| vtkVariant | value | ||
| ) |
Set the minimum spanning tree 'origin' vertex. This method is basically the same as above but allows the application to simply specify an array name and value, instead of having to know the specific index of the vertex.
| virtual void vtkBoostPrimMinimumSpanningTree::SetCreateGraphVertexIdArray | ( | bool | ) | [virtual] |
Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.
| virtual bool vtkBoostPrimMinimumSpanningTree::GetCreateGraphVertexIdArray | ( | ) | [virtual] |
Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.
| virtual void vtkBoostPrimMinimumSpanningTree::CreateGraphVertexIdArrayOn | ( | ) | [virtual] |
Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.
| virtual void vtkBoostPrimMinimumSpanningTree::CreateGraphVertexIdArrayOff | ( | ) | [virtual] |
Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.
| void vtkBoostPrimMinimumSpanningTree::SetNegateEdgeWeights | ( | bool | value | ) |
Whether to negate the edge weights. By negating the edge weights this algorithm will give you the 'maximal' spanning tree (i.e. the algorithm will try to create a spanning tree with the highest weighted edges). Defaulted to Off. FIXME: put a real definition in...
| virtual bool vtkBoostPrimMinimumSpanningTree::GetNegateEdgeWeights | ( | ) | [virtual] |
Whether to negate the edge weights. By negating the edge weights this algorithm will give you the 'maximal' spanning tree (i.e. the algorithm will try to create a spanning tree with the highest weighted edges). Defaulted to Off. FIXME: put a real definition in...
| virtual void vtkBoostPrimMinimumSpanningTree::NegateEdgeWeightsOn | ( | ) | [virtual] |
Whether to negate the edge weights. By negating the edge weights this algorithm will give you the 'maximal' spanning tree (i.e. the algorithm will try to create a spanning tree with the highest weighted edges). Defaulted to Off. FIXME: put a real definition in...
| virtual void vtkBoostPrimMinimumSpanningTree::NegateEdgeWeightsOff | ( | ) | [virtual] |
Whether to negate the edge weights. By negating the edge weights this algorithm will give you the 'maximal' spanning tree (i.e. the algorithm will try to create a spanning tree with the highest weighted edges). Defaulted to Off. FIXME: put a real definition in...
| int vtkBoostPrimMinimumSpanningTree::RequestData | ( | vtkInformation * | request, |
| vtkInformationVector ** | inputVector, | ||
| vtkInformationVector * | outputVector | ||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkTreeAlgorithm.
| int vtkBoostPrimMinimumSpanningTree::FillInputPortInformation | ( | int | port, |
| vtkInformation * | info | ||
| ) | [protected, virtual] |
Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkTreeAlgorithm.
The documentation for this class was generated from the following file:
- dox/Infovis/BoostGraphAlgorithms/vtkBoostPrimMinimumSpanningTree.h
