VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDijkstraGraphGeodesicPath Class Reference

Dijkstra algorithm to compute the graph geodesic. More...

#include <vtkDijkstraGraphGeodesicPath.h>

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

Public Member Functions

virtual double GetGeodesicLength ()
 
virtual void GetCumulativeWeights (vtkDoubleArray *weights)
 
virtual vtkIdList * GetIdList ()
 
virtual void SetStopWhenEndReached (int)
 
virtual int GetStopWhenEndReached ()
 
virtual void StopWhenEndReachedOn ()
 
virtual void StopWhenEndReachedOff ()
 
virtual void SetUseScalarWeights (int)
 
virtual int GetUseScalarWeights ()
 
virtual void UseScalarWeightsOn ()
 
virtual void UseScalarWeightsOff ()
 
virtual void SetRepelPathFromVertices (int)
 
virtual int GetRepelPathFromVertices ()
 
virtual void RepelPathFromVerticesOn ()
 
virtual void RepelPathFromVerticesOff ()
 
virtual void SetRepelVertices (vtkPoints *)
 
virtual vtkPoints * GetRepelVertices ()
 
- Public Member Functions inherited from vtkGraphGeodesicPath
virtual vtkIdType GetStartVertex ()
 
virtual void SetStartVertex (vtkIdType)
 
virtual vtkIdType GetEndVertex ()
 
virtual void SetEndVertex (vtkIdType)
 
vtkGraphGeodesicPathNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
- Public Member Functions inherited from vtkGeodesicPath
vtkGeodesicPathNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static
vtkDijkstraGraphGeodesicPath
New ()
 
- Static Public Member Functions inherited from vtkGraphGeodesicPath
static int IsTypeOf (const char *type)
 
static vtkGraphGeodesicPathSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkGeodesicPath
static int IsTypeOf (const char *type)
 
static vtkGeodesicPathSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

 vtkDijkstraGraphGeodesicPath ()
 
 ~vtkDijkstraGraphGeodesicPath ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual void BuildAdjacency (vtkDataSet *inData)
 
virtual double CalculateStaticEdgeCost (vtkDataSet *inData, vtkIdType u, vtkIdType v)
 
virtual double CalculateDynamicEdgeCost (vtkDataSet *, vtkIdType, vtkIdType)
 
void Initialize (vtkDataSet *inData)
 
void Reset ()
 
virtual void ShortestPath (vtkDataSet *inData, int startv, int endv)
 
void Relax (const int &u, const int &v, const double &w)
 
void TraceShortestPath (vtkDataSet *inData, vtkPolyData *outPoly, vtkIdType startv, vtkIdType endv)
 
- Protected Member Functions inherited from vtkGraphGeodesicPath
 vtkGraphGeodesicPath ()
 
 ~vtkGraphGeodesicPath ()
 
- Protected Member Functions inherited from vtkGeodesicPath
 vtkGeodesicPath ()
 
 ~vtkGeodesicPath ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 

Protected Attributes

vtkTimeStamp AdjacencyBuildTime
 
int NumberOfVertices
 
vtkIdList * IdList
 
vtkDijkstraGraphInternalsInternals
 
int StopWhenEndReached
 
int UseScalarWeights
 
int RepelPathFromVertices
 
vtkPoints * RepelVertices
 
- Protected Attributes inherited from vtkGraphGeodesicPath
vtkIdType StartVertex
 
vtkIdType EndVertex
 
typedef vtkGraphGeodesicPath Superclass
 
static int IsTypeOf (const char *type)
 
static
vtkDijkstraGraphGeodesicPath
SafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkDijkstraGraphGeodesicPathNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 

Detailed Description

Dijkstra algorithm to compute the graph geodesic.

Takes as input a polygonal mesh and performs a single source shortest path calculation. Dijkstra's algorithm is used. The implementation is similar to the one described in Introduction to Algorithms (Second Edition) by Thomas H. Cormen, Charles E. Leiserson, Ronald L. Rivest, and Cliff Stein, published by MIT Press and McGraw-Hill. Some minor enhancement are added though. All vertices are not pushed on the heap at start, instead a front set is maintained. The heap is implemented as a binary heap. The output of the filter is a set of lines describing the shortest path from StartVertex to EndVertex.

Warning
The input polydata must have only triangle cells.
Thanks:
The class was contributed by Rasmus Paulsen. www.imm.dtu.dk/~rrp/VTK . Also thanks to Alexandre Gouaillard and Shoaib Ghias for bug fixes and enhancements.

Definition at line 46 of file vtkDijkstraGraphGeodesicPath.h.

Member Typedef Documentation

Standard methids for printing and determining type information.

Definition at line 56 of file vtkDijkstraGraphGeodesicPath.h.

Constructor & Destructor Documentation

vtkDijkstraGraphGeodesicPath::vtkDijkstraGraphGeodesicPath ( )
protected
vtkDijkstraGraphGeodesicPath::~vtkDijkstraGraphGeodesicPath ( )
protected

Member Function Documentation

static vtkDijkstraGraphGeodesicPath* vtkDijkstraGraphGeodesicPath::New ( )
static

Instantiate the class

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

Standard methids for printing and determining type information.

virtual int vtkDijkstraGraphGeodesicPath::IsA ( const char *  type)
virtual

Standard methids for printing and determining type information.

Reimplemented from vtkGraphGeodesicPath.

Reimplemented in vtkDijkstraImageGeodesicPath.

static vtkDijkstraGraphGeodesicPath* vtkDijkstraGraphGeodesicPath::SafeDownCast ( vtkObjectBase *  o)
static

Standard methids for printing and determining type information.

virtual vtkObjectBase* vtkDijkstraGraphGeodesicPath::NewInstanceInternal ( ) const
protectedvirtual

Standard methids for printing and determining type information.

Reimplemented from vtkGraphGeodesicPath.

Reimplemented in vtkDijkstraImageGeodesicPath.

vtkDijkstraGraphGeodesicPath* vtkDijkstraGraphGeodesicPath::NewInstance ( ) const

Standard methids for printing and determining type information.

void vtkDijkstraGraphGeodesicPath::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

Standard methids for printing and determining type information.

virtual vtkIdList* vtkDijkstraGraphGeodesicPath::GetIdList ( )
virtual

The vertex ids (of the input polydata) on the shortest path

virtual void vtkDijkstraGraphGeodesicPath::SetStopWhenEndReached ( int  )
virtual

Stop when the end vertex is reached or calculate shortest path to all vertices

virtual int vtkDijkstraGraphGeodesicPath::GetStopWhenEndReached ( )
virtual

Stop when the end vertex is reached or calculate shortest path to all vertices

virtual void vtkDijkstraGraphGeodesicPath::StopWhenEndReachedOn ( )
virtual

Stop when the end vertex is reached or calculate shortest path to all vertices

virtual void vtkDijkstraGraphGeodesicPath::StopWhenEndReachedOff ( )
virtual

Stop when the end vertex is reached or calculate shortest path to all vertices

virtual void vtkDijkstraGraphGeodesicPath::SetUseScalarWeights ( int  )
virtual

Use scalar values in the edge weight (experimental)

virtual int vtkDijkstraGraphGeodesicPath::GetUseScalarWeights ( )
virtual

Use scalar values in the edge weight (experimental)

virtual void vtkDijkstraGraphGeodesicPath::UseScalarWeightsOn ( )
virtual

Use scalar values in the edge weight (experimental)

virtual void vtkDijkstraGraphGeodesicPath::UseScalarWeightsOff ( )
virtual

Use scalar values in the edge weight (experimental)

virtual void vtkDijkstraGraphGeodesicPath::SetRepelPathFromVertices ( int  )
virtual

Use the input point to repel the path by assigning high costs.

virtual int vtkDijkstraGraphGeodesicPath::GetRepelPathFromVertices ( )
virtual

Use the input point to repel the path by assigning high costs.

virtual void vtkDijkstraGraphGeodesicPath::RepelPathFromVerticesOn ( )
virtual

Use the input point to repel the path by assigning high costs.

virtual void vtkDijkstraGraphGeodesicPath::RepelPathFromVerticesOff ( )
virtual

Use the input point to repel the path by assigning high costs.

virtual void vtkDijkstraGraphGeodesicPath::SetRepelVertices ( vtkPoints *  )
virtual

Specify vtkPoints to use to repel the path from.

virtual vtkPoints* vtkDijkstraGraphGeodesicPath::GetRepelVertices ( )
virtual

Specify vtkPoints to use to repel the path from.

virtual double vtkDijkstraGraphGeodesicPath::GetGeodesicLength ( )
inlinevirtual

TODO: Get the total geodesic length.

Implements vtkGeodesicPath.

Definition at line 94 of file vtkDijkstraGraphGeodesicPath.h.

virtual void vtkDijkstraGraphGeodesicPath::GetCumulativeWeights ( vtkDoubleArray *  weights)
virtual

Fill the array with the cumulative weights.

virtual int vtkDijkstraGraphGeodesicPath::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Reimplemented in vtkDijkstraImageGeodesicPath.

virtual void vtkDijkstraGraphGeodesicPath::BuildAdjacency ( vtkDataSet *  inData)
protectedvirtual

Reimplemented in vtkDijkstraImageGeodesicPath.

virtual double vtkDijkstraGraphGeodesicPath::CalculateStaticEdgeCost ( vtkDataSet *  inData,
vtkIdType  u,
vtkIdType  v 
)
protectedvirtual

Reimplemented in vtkDijkstraImageGeodesicPath.

virtual double vtkDijkstraGraphGeodesicPath::CalculateDynamicEdgeCost ( vtkDataSet *  ,
vtkIdType  ,
vtkIdType   
)
inlineprotectedvirtual

Reimplemented in vtkDijkstraImageGeodesicPath.

Definition at line 116 of file vtkDijkstraGraphGeodesicPath.h.

void vtkDijkstraGraphGeodesicPath::Initialize ( vtkDataSet *  inData)
protected
void vtkDijkstraGraphGeodesicPath::Reset ( )
protected
virtual void vtkDijkstraGraphGeodesicPath::ShortestPath ( vtkDataSet *  inData,
int  startv,
int  endv 
)
protectedvirtual
void vtkDijkstraGraphGeodesicPath::Relax ( const int &  u,
const int &  v,
const double &  w 
)
protected
void vtkDijkstraGraphGeodesicPath::TraceShortestPath ( vtkDataSet *  inData,
vtkPolyData *  outPoly,
vtkIdType  startv,
vtkIdType  endv 
)
protected

Member Data Documentation

vtkTimeStamp vtkDijkstraGraphGeodesicPath::AdjacencyBuildTime
protected

Definition at line 109 of file vtkDijkstraGraphGeodesicPath.h.

int vtkDijkstraGraphGeodesicPath::NumberOfVertices
protected

Definition at line 134 of file vtkDijkstraGraphGeodesicPath.h.

vtkIdList* vtkDijkstraGraphGeodesicPath::IdList
protected

Definition at line 137 of file vtkDijkstraGraphGeodesicPath.h.

vtkDijkstraGraphInternals* vtkDijkstraGraphGeodesicPath::Internals
protected

Definition at line 140 of file vtkDijkstraGraphGeodesicPath.h.

int vtkDijkstraGraphGeodesicPath::StopWhenEndReached
protected

Definition at line 142 of file vtkDijkstraGraphGeodesicPath.h.

int vtkDijkstraGraphGeodesicPath::UseScalarWeights
protected

Definition at line 143 of file vtkDijkstraGraphGeodesicPath.h.

int vtkDijkstraGraphGeodesicPath::RepelPathFromVertices
protected

Definition at line 144 of file vtkDijkstraGraphGeodesicPath.h.

vtkPoints* vtkDijkstraGraphGeodesicPath::RepelVertices
protected

Definition at line 146 of file vtkDijkstraGraphGeodesicPath.h.


The documentation for this class was generated from the following file: