vtkBoostPrimMinimumSpanningTree - Contructs a minimum spanning tree from a graph, start node, and the weighting array More...

Inheritance diagram for Kitware.VTK.vtkBoostPrimMinimumSpanningTree:

[legend]

Collaboration diagram for Kitware.VTK.vtkBoostPrimMinimumSpanningTree:

[legend]

List of all members.

Public Member Functions
	vtkBoostPrimMinimumSpanningTree (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkBoostPrimMinimumSpanningTree ()
	Undocumented Block.
virtual void	CreateGraphVertexIdArrayOff ()
	Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.
virtual void	CreateGraphVertexIdArrayOn ()
	Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.
virtual bool	GetCreateGraphVertexIdArray ()
	Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.
virtual bool	GetNegateEdgeWeights ()
	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...
override int	IsA (string type)
	Undocumented Block.
virtual void	NegateEdgeWeightsOff ()
	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	NegateEdgeWeightsOn ()
	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...
new vtkBoostPrimMinimumSpanningTree	NewInstance ()
	Undocumented Block.
virtual void	SetCreateGraphVertexIdArray (bool _arg)
	Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.
virtual void	SetEdgeWeightArrayName (string _arg)
	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	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...
void	SetOriginVertex (long index)
	Set the index (into the vertex array) of the minimum spanning tree 'origin' vertex.
Static Public Member Functions
static new vtkBoostPrimMinimumSpanningTree	New ()
	Undocumented Block.
static new int	IsTypeOf (string type)
	Undocumented Block.
static new vtkBoostPrimMinimumSpanningTree	SafeDownCast (vtkObjectBase o)
	Undocumented Block.
Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkBoostPrimMinimumSpanningTree"
	Automatically generated type registration mechanics.
Static Public Attributes
static new readonly string	MRClassNameKey = "31vtkBoostPrimMinimumSpanningTree"
	Automatically generated type registration mechanics.
Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.
Private Member Functions
static internal IntPtr	vtkBoostPrimMinimumSpanningTree_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void	vtkBoostPrimMinimumSpanningTree_CreateGraphVertexIdArrayOff_01 (HandleRef pThis)
static internal void	vtkBoostPrimMinimumSpanningTree_CreateGraphVertexIdArrayOn_02 (HandleRef pThis)
static internal byte	vtkBoostPrimMinimumSpanningTree_GetCreateGraphVertexIdArray_03 (HandleRef pThis)
static internal byte	vtkBoostPrimMinimumSpanningTree_GetNegateEdgeWeights_04 (HandleRef pThis)
static internal int	vtkBoostPrimMinimumSpanningTree_IsA_05 (HandleRef pThis, string type)
static internal int	vtkBoostPrimMinimumSpanningTree_IsTypeOf_06 (string type)
static internal void	vtkBoostPrimMinimumSpanningTree_NegateEdgeWeightsOff_07 (HandleRef pThis)
static internal void	vtkBoostPrimMinimumSpanningTree_NegateEdgeWeightsOn_08 (HandleRef pThis)
static internal IntPtr	vtkBoostPrimMinimumSpanningTree_NewInstance_10 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr	vtkBoostPrimMinimumSpanningTree_SafeDownCast_11 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void	vtkBoostPrimMinimumSpanningTree_SetCreateGraphVertexIdArray_12 (HandleRef pThis, byte _arg)
static internal void	vtkBoostPrimMinimumSpanningTree_SetEdgeWeightArrayName_13 (HandleRef pThis, string _arg)
static internal void	vtkBoostPrimMinimumSpanningTree_SetNegateEdgeWeights_14 (HandleRef pThis, byte value)
static internal void	vtkBoostPrimMinimumSpanningTree_SetOriginVertex_15 (HandleRef pThis, long index)
Static Private Member Functions
static	vtkBoostPrimMinimumSpanningTree ()
	Automatically generated type registration mechanics.

Detailed Description

vtkBoostPrimMinimumSpanningTree - Contructs a minimum spanning tree from a graph, start node, and the weighting array

Description

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: 1. The negate edge weights function cannot be utilized to obtain a 'maximal' spanning tree (an exception is thrown when negated edge weights exist), and 2. 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.

vtkGraph vtkBoostGraphAdapter

Constructor & Destructor Documentation

static Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree ( )

Undocumented Block.

Member Function Documentation

virtual void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.CreateGraphVertexIdArrayOff ( ) [virtual]

Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.

virtual void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.CreateGraphVertexIdArrayOn ( ) [virtual]

Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.

override void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.Dispose ( bool disposing ) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

virtual bool Kitware.VTK.vtkBoostPrimMinimumSpanningTree.GetCreateGraphVertexIdArray ( ) [virtual]

Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.

virtual bool Kitware.VTK.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...

override int Kitware.VTK.vtkBoostPrimMinimumSpanningTree.IsA ( string type ) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

static new int Kitware.VTK.vtkBoostPrimMinimumSpanningTree.IsTypeOf ( string type ) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

virtual void Kitware.VTK.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...

virtual void Kitware.VTK.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...

static new vtkBoostPrimMinimumSpanningTree Kitware.VTK.vtkBoostPrimMinimumSpanningTree.New ( ) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

new vtkBoostPrimMinimumSpanningTree Kitware.VTK.vtkBoostPrimMinimumSpanningTree.NewInstance ( )

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

static new vtkBoostPrimMinimumSpanningTree Kitware.VTK.vtkBoostPrimMinimumSpanningTree.SafeDownCast ( vtkObjectBase o ) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.SetCreateGraphVertexIdArray ( bool _arg ) [virtual]

Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.

virtual void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.SetEdgeWeightArrayName ( string _arg ) [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 Kitware.VTK.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...

void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.SetOriginVertex ( long index )

Set the index (into the vertex array) of the minimum spanning tree 'origin' vertex.

static internal void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_CreateGraphVertexIdArrayOff_01 ( HandleRef pThis ) [private]

static internal void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_CreateGraphVertexIdArrayOn_02 ( HandleRef pThis ) [private]

static internal byte Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_GetCreateGraphVertexIdArray_03 ( HandleRef pThis ) [private]

static internal byte Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_GetNegateEdgeWeights_04 ( HandleRef pThis ) [private]

static internal int Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_IsA_05	(	HandleRef	pThis,
		string	type
	)		`[private]`

static internal int Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_IsTypeOf_06 ( string type ) [private]

static internal void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_NegateEdgeWeightsOff_07 ( HandleRef pThis ) [private]

static internal void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_NegateEdgeWeightsOn_08 ( HandleRef pThis ) [private]

static internal IntPtr Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_New	(	ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		`[private]`

static internal IntPtr Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_NewInstance_10	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		`[private]`

static internal IntPtr Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_SafeDownCast_11	(	HandleRef	o,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		`[private]`

static internal void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_SetCreateGraphVertexIdArray_12	(	HandleRef	pThis,
		byte	_arg
	)		`[private]`

static internal void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_SetEdgeWeightArrayName_13	(	HandleRef	pThis,
		string	_arg
	)		`[private]`

static internal void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_SetNegateEdgeWeights_14	(	HandleRef	pThis,
		byte	value
	)		`[private]`

static internal void Kitware.VTK.vtkBoostPrimMinimumSpanningTree.vtkBoostPrimMinimumSpanningTree_SetOriginVertex_15	(	HandleRef	pThis,
		long	index
	)		`[private]`