VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkPBGLShortestPaths Class Reference

Compute the shortest paths from the origin vertex to all other vertices in a distributed vtkGraph. More...

#include <vtkPBGLShortestPaths.h>

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

Public Types

typedef vtkGraphAlgorithm Superclass
 
- Public Types inherited from vtkGraphAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetOriginVertex (vtkIdType index)
 
void SetOriginVertex (vtkStdString arrayName, vtkVariant value)
 
void SetOriginVertexString (char *arrayName, char *value)
 
void SetOriginSelection (vtkSelection *s)
 
void SetOriginSelectionConnection (vtkAlgorithmOutput *algOutput)
 
virtual void SetEdgeWeightArrayName (const char *)
 
virtual void SetDelta (double)
 
virtual void SetPredecessorArrayName (const char *)
 
virtual void SetPathLengthArrayName (const char *)
 
virtual void SetOriginFromSelection (bool)
 
virtual bool GetOriginFromSelection ()
 
virtual void OriginFromSelectionOn ()
 
virtual void OriginFromSelectionOff ()
 
virtual bool GetOutputSelection ()
 
virtual void SetOutputSelection (bool)
 
virtual void OutputSelectionOn ()
 
virtual void OutputSelectionOff ()
 
virtual void SetOutputSelectionType (const char *)
 
virtual void SetUseUniformEdgeWeights (bool)
 
virtual bool GetUseUniformEdgeWeights ()
 
virtual void UseUniformEdgeWeightsOn ()
 
virtual void UseUniformEdgeWeightsOff ()
 
- Public Member Functions inherited from vtkGraphAlgorithm
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkGraphGetOutput ()
 
vtkGraphGetOutput (int index)
 
void SetInput (vtkDataObject *obj)
 
void SetInput (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
virtual void Update ()
 
virtual void UpdateInformation ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformationGetInformation ()
 
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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char 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)
 
vtkCommandGetCommand (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)
 
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 &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkPBGLShortestPathsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPBGLShortestPathsSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkGraphAlgorithm
static vtkGraphAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGraphAlgorithmSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObject *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyPRESERVES_DATASET ()
 
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
 
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKeyPRESERVES_RANGES ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

 vtkPBGLShortestPaths ()
 
 ~vtkPBGLShortestPaths ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
- Protected Member Functions inherited from vtkGraphAlgorithm
 vtkGraphAlgorithm ()
 
 ~vtkGraphAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- 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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *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 &os)
 
 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 vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Compute the shortest paths from the origin vertex to all other vertices in a distributed vtkGraph.

This VTK class uses the Parallel BGL's implementation of the delta-stepping algorithm generic algorithm to compute shortest paths from a given 'source' vertex on the input graph (a distributed vtkGraph). Delta-stepping, discovered by Meyer and Sanders, is a parallel form of Dijkstra's shortest paths algorithm, based on a multi-level bucket structure that permits edges to be relaxed in parallel.

Tests:
vtkPBGLShortestPaths (Tests)

Definition at line 47 of file vtkPBGLShortestPaths.h.

Member Typedef Documentation

Definition at line 51 of file vtkPBGLShortestPaths.h.

Constructor & Destructor Documentation

vtkPBGLShortestPaths::vtkPBGLShortestPaths ( )
protected
vtkPBGLShortestPaths::~vtkPBGLShortestPaths ( )
protected

Member Function Documentation

static vtkPBGLShortestPaths* vtkPBGLShortestPaths::New ( )
static
virtual const char* vtkPBGLShortestPaths::GetClassName ( )
virtual

Reimplemented from vtkGraphAlgorithm.

static int vtkPBGLShortestPaths::IsTypeOf ( const char *  type)
static
virtual int vtkPBGLShortestPaths::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 vtkPBGLShortestPaths* vtkPBGLShortestPaths::SafeDownCast ( vtkObject o)
static
void vtkPBGLShortestPaths::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.

void vtkPBGLShortestPaths::SetOriginSelection ( vtkSelection s)

Convenience methods for setting the origin selection input.

void vtkPBGLShortestPaths::SetOriginSelectionConnection ( vtkAlgorithmOutput algOutput)
inline

Convenience methods for setting the origin selection input.

Definition at line 57 of file vtkPBGLShortestPaths.h.

void vtkPBGLShortestPaths::SetOriginVertex ( vtkIdType  index)

Set the index (into the vertex array) of the breadth first search 'origin' vertex.

void vtkPBGLShortestPaths::SetOriginVertex ( vtkStdString  arrayName,
vtkVariant  value 
)

Set the breadth first search '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.

void vtkPBGLShortestPaths::SetOriginVertexString ( char *  arrayName,
char *  value 
)

Convenience method for setting the origin vertex given an array name and string value. This method is primarily for the benefit of the VTK Parallel client/server layer, callers should prefer to use SetOriginVertex() whenever possible.

virtual void vtkPBGLShortestPaths::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.

virtual void vtkPBGLShortestPaths::SetDelta ( double  )
virtual

Sets the value of delta, which is the width of each "bucket" within the multi-level bucket structure used internally by this algorithm. Large values of delta correspond with wider buckets, exposing more parallelism than smaller values. However, values that are too large will cause the algorithm to compute (and, later, correct) paths that are longer than the shortest path. While the value of delta will not affect the correctness of the results of this algorithm, delta can have a significant impact on performance. If no value of delta is provided, this algorithm employs the heuristics provided by Meyer and Sanders to automatically determine a delta.

virtual void vtkPBGLShortestPaths::SetPredecessorArrayName ( const char *  )
virtual

Set the name of the predecessor output array, which contains the predecessor of each vertex within the shortest paths tree. To determine the shortest path from the origin to a particular vertex, walk the predecessor array backwards. If no predecessor array name is set then the name 'Predecessor' is used.

virtual void vtkPBGLShortestPaths::SetPathLengthArrayName ( const char *  )
virtual

Set the name of the shortest path length output array, containing the length of the shortest path from the origin vertex to each of the other vertices in the graph. The origin will always have path-length 0, while vertices unreachable from the origin will have infinite path-length. If no path length array name is set then the name 'PathLength' is used.

virtual void vtkPBGLShortestPaths::SetOriginFromSelection ( bool  )
virtual

Use the vtkSelection from input port 1 as the origin vertex. The selection should be a IDS selection with field type POINTS. The first ID in the selection will be used for the origin vertex. Default is off (origin is specified by SetOriginVertex(...)).

virtual bool vtkPBGLShortestPaths::GetOriginFromSelection ( )
virtual

Use the vtkSelection from input port 1 as the origin vertex. The selection should be a IDS selection with field type POINTS. The first ID in the selection will be used for the origin vertex. Default is off (origin is specified by SetOriginVertex(...)).

virtual void vtkPBGLShortestPaths::OriginFromSelectionOn ( )
virtual

Use the vtkSelection from input port 1 as the origin vertex. The selection should be a IDS selection with field type POINTS. The first ID in the selection will be used for the origin vertex. Default is off (origin is specified by SetOriginVertex(...)).

virtual void vtkPBGLShortestPaths::OriginFromSelectionOff ( )
virtual

Use the vtkSelection from input port 1 as the origin vertex. The selection should be a IDS selection with field type POINTS. The first ID in the selection will be used for the origin vertex. Default is off (origin is specified by SetOriginVertex(...)).

virtual bool vtkPBGLShortestPaths::GetOutputSelection ( )
virtual

Create an output selection containing the ID of a vertex based on the output selection type. The default is to use the the maximum distance from the starting vertex. Defaults to off.

virtual void vtkPBGLShortestPaths::SetOutputSelection ( bool  )
virtual

Create an output selection containing the ID of a vertex based on the output selection type. The default is to use the the maximum distance from the starting vertex. Defaults to off.

virtual void vtkPBGLShortestPaths::OutputSelectionOn ( )
virtual

Create an output selection containing the ID of a vertex based on the output selection type. The default is to use the the maximum distance from the starting vertex. Defaults to off.

virtual void vtkPBGLShortestPaths::OutputSelectionOff ( )
virtual

Create an output selection containing the ID of a vertex based on the output selection type. The default is to use the the maximum distance from the starting vertex. Defaults to off.

virtual void vtkPBGLShortestPaths::SetOutputSelectionType ( const char *  )
virtual

Set the output selection type. The default is to use the the maximum distance from the starting vertex "MAX_DIST_FROM_ROOT". But you can also specify other things like "ROOT","2D_MAX", etc

virtual void vtkPBGLShortestPaths::SetUseUniformEdgeWeights ( bool  )
virtual

This option causes a temporary edge-weight array to be created with uniform edge weights of 1.0 at each edge. This option should preempt a given edge weight array via EdgeWeightArrayName. Defaults to off.

virtual bool vtkPBGLShortestPaths::GetUseUniformEdgeWeights ( )
virtual

This option causes a temporary edge-weight array to be created with uniform edge weights of 1.0 at each edge. This option should preempt a given edge weight array via EdgeWeightArrayName. Defaults to off.

virtual void vtkPBGLShortestPaths::UseUniformEdgeWeightsOn ( )
virtual

This option causes a temporary edge-weight array to be created with uniform edge weights of 1.0 at each edge. This option should preempt a given edge weight array via EdgeWeightArrayName. Defaults to off.

virtual void vtkPBGLShortestPaths::UseUniformEdgeWeightsOff ( )
virtual

This option causes a temporary edge-weight array to be created with uniform edge weights of 1.0 at each edge. This option should preempt a given edge weight array via EdgeWeightArrayName. Defaults to off.

virtual int vtkPBGLShortestPaths::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

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

Reimplemented from vtkGraphAlgorithm.

virtual int vtkPBGLShortestPaths::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 vtkGraphAlgorithm.

virtual int vtkPBGLShortestPaths::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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: