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

#include <vtkBoostPrimMinimumSpanningTree.h>

Inheritance diagram for vtkBoostPrimMinimumSpanningTree:

Collaboration diagram for vtkBoostPrimMinimumSpanningTree:

Public Types
typedef vtkTreeAlgorithm	Superclass

Public Types inherited from vtkTreeAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkBoostPrimMinimumSpanningTree *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	SetOriginVertex (vtkIdType index)

void	SetOriginVertex (vtkStdString arrayName, vtkVariant value)


virtual void	SetEdgeWeightArrayName (const char *)


virtual void	SetCreateGraphVertexIdArray (bool)

virtual bool	GetCreateGraphVertexIdArray ()

virtual void	CreateGraphVertexIdArrayOn ()

virtual void	CreateGraphVertexIdArrayOff ()


void	SetNegateEdgeWeights (bool value)

virtual bool	GetNegateEdgeWeights ()

virtual void	NegateEdgeWeightsOn ()

virtual void	NegateEdgeWeightsOff ()

Public Member Functions inherited from vtkTreeAlgorithm
vtkTreeAlgorithm *	NewInstance () const

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

vtkTree *	GetOutput ()

vtkTree *	GetOutput (int index)

void	SetInputData (vtkDataObject *obj)

void	SetInputData (int index, vtkDataObject *obj)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

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 ()

vtkDataObject *	GetOutputDataObject (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 ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

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)

vtkDataObject *	GetInputDataObject (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)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

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)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool 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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkBoostPrimMinimumSpanningTree *	New ()

static int	IsTypeOf (const char *type)

static vtkBoostPrimMinimumSpanningTree *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkTreeAlgorithm
static vtkTreeAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkTreeAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

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 *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkBoostPrimMinimumSpanningTree ()

	~vtkBoostPrimMinimumSpanningTree ()

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

int	FillInputPortInformation (int port, vtkInformation *info)

Protected Member Functions inherited from vtkTreeAlgorithm
	vtkTreeAlgorithm ()

	~vtkTreeAlgorithm ()

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	FillOutputPortInformation (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 vtkExecutive *	CreateDefaultExecutive ()

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 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 &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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

Tests:
vtkBoostPrimMinimumSpanningTree (Tests)

Definition at line 57 of file vtkBoostPrimMinimumSpanningTree.h.

Member Typedef Documentation

typedef vtkTreeAlgorithm vtkBoostPrimMinimumSpanningTree::Superclass

Definition at line 61 of file vtkBoostPrimMinimumSpanningTree.h.

Constructor & Destructor Documentation

vtkBoostPrimMinimumSpanningTree::vtkBoostPrimMinimumSpanningTree ( )

protected

vtkBoostPrimMinimumSpanningTree::~vtkBoostPrimMinimumSpanningTree ( )

protected

Member Function Documentation

static vtkBoostPrimMinimumSpanningTree* vtkBoostPrimMinimumSpanningTree::New ( )

static

static int vtkBoostPrimMinimumSpanningTree::IsTypeOf ( const char * type )

static

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

virtual vtkObjectBase* vtkBoostPrimMinimumSpanningTree::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkTreeAlgorithm.

vtkBoostPrimMinimumSpanningTree* vtkBoostPrimMinimumSpanningTree::NewInstance ( ) const

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
	)

protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkTreeAlgorithm.

int vtkBoostPrimMinimumSpanningTree::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

protectedvirtual

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:

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Infovis/BoostGraphAlgorithms/vtkBoostPrimMinimumSpanningTree.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation