VTK
Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDijkstraImageGeodesicPath Class Reference

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

#include <vtkDijkstraImageGeodesicPath.h>

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

Public Member Functions

void SetInput (vtkDataObject *)
 
vtkImageDataGetInputAsImageData ()
 
void SetImageWeight (double)
 
virtual double GetImageWeight ()
 
void SetEdgeLengthWeight (double)
 
virtual double GetEdgeLengthWeight ()
 
virtual void SetCurvatureWeight (double)
 
virtual double GetCurvatureWeight ()
 
- Public Member Functions inherited from vtkDijkstraGraphGeodesicPath
virtual double GetGeodesicLength ()
 
virtual void GetCumulativeWeights (vtkDoubleArray *weights)
 
virtual vtkIdListGetIdList ()
 
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 vtkPointsGetRepelVertices ()
 
- Public Member Functions inherited from vtkGraphGeodesicPath
virtual vtkIdType GetStartVertex ()
 
virtual void SetStartVertex (vtkIdType)
 
virtual vtkIdType GetEndVertex ()
 
virtual void SetEndVertex (vtkIdType)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
- Public Member Functions inherited from vtkGeodesicPath

Static Public Member Functions

static
vtkDijkstraImageGeodesicPath
New ()
 
- Static Public Member Functions inherited from vtkDijkstraGraphGeodesicPath
static
vtkDijkstraGraphGeodesicPath
New ()
 
static int IsTypeOf (const char *type)
 
static
vtkDijkstraGraphGeodesicPath
SafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkGraphGeodesicPath
static int IsTypeOf (const char *type)
 
static vtkGraphGeodesicPathSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkDijkstraImageGeodesicPath ()
 
 ~vtkDijkstraImageGeodesicPath ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual void BuildAdjacency (vtkDataSet *inData)
 
void UpdateStaticCosts (vtkImageData *image)
 
virtual double CalculateStaticEdgeCost (vtkDataSet *inData, vtkIdType u, vtkIdType v)
 
virtual double CalculateDynamicEdgeCost (vtkDataSet *inData, vtkIdType u, vtkIdType v)
 
- Protected Member Functions inherited from vtkDijkstraGraphGeodesicPath
 vtkDijkstraGraphGeodesicPath ()
 
 ~vtkDijkstraGraphGeodesicPath ()
 
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 ()
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual void ExecuteData (vtkDataObject *output)
 
virtual void Execute ()
 
- 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 &)
 

Protected Attributes

double PixelSize
 
double ImageWeight
 
double EdgeLengthWeight
 
double CurvatureWeight
 
bool RebuildStaticCosts
 
- Protected Attributes inherited from vtkDijkstraGraphGeodesicPath
vtkTimeStamp AdjacencyBuildTime
 
int NumberOfVertices
 
vtkIdListIdList
 
vtkDijkstraGraphInternalsInternals
 
int StopWhenEndReached
 
int UseScalarWeights
 
int RepelPathFromVertices
 
vtkPointsRepelVertices
 
- Protected Attributes inherited from vtkGraphGeodesicPath
vtkIdType StartVertex
 
vtkIdType EndVertex
 
typedef
vtkDijkstraGraphGeodesicPath 
Superclass
 
static int IsTypeOf (const char *type)
 
static
vtkDijkstraImageGeodesicPath
SafeDownCast (vtkObject *o)
 
virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Additional Inherited Members

- Public Types inherited from vtkDijkstraGraphGeodesicPath
typedef vtkGraphGeodesicPath Superclass
 
- Public Types inherited from vtkGraphGeodesicPath
typedef vtkGeodesicPath Superclass
 
- Public Types inherited from vtkGeodesicPath
typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 
- Friends inherited from vtkObject

Detailed Description

Dijkstra algorithm to compute the graph geodesic.

Takes as input a polyline and an image representing a 2D cost function 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. See parent class vtkDijkstraGraphGeodesicPath for the implementation.

Warning
The input cost image must have only VTK_PIXEL cells: i.e., a 2D image or slice of a 3D volume. A cost function for a gray scale image might be generated by the following pipeline: vtkImageData->vtkImageGradientMagnitude->vtkImageShiftScale wherein the gradient magnitude image is inverted so that strong edges have low cost value. Costs in moving from a vertex v to a vertex u are calculated using a weighted additive sheme: cost = Iw*f(I) + Ew*f(u,v) + Cw*f(t,u,v) where Iw is the weight associated with f(I): the normalized image cost, Ew is the weight associated with f(u,v): the normalized distance between vertices u and v, and Cw is the weight associated with f(t,u,v): the normalized curvature calculated from the vertex t which precedes vertex u, and vertices u and v. All weights range from 0 to 1.
Thanks:
The class was contributed by Dean Inglis.
Tests:
vtkDijkstraImageGeodesicPath (Tests)

Definition at line 59 of file vtkDijkstraImageGeodesicPath.h.

Member Typedef Documentation

Standard methids for printing and determining type information.

Definition at line 69 of file vtkDijkstraImageGeodesicPath.h.

Constructor & Destructor Documentation

vtkDijkstraImageGeodesicPath::vtkDijkstraImageGeodesicPath ( )
protected
vtkDijkstraImageGeodesicPath::~vtkDijkstraImageGeodesicPath ( )
protected

Member Function Documentation

static vtkDijkstraImageGeodesicPath* vtkDijkstraImageGeodesicPath::New ( )
static

Instantiate the class

virtual const char* vtkDijkstraImageGeodesicPath::GetClassName ( )
virtual

Standard methids for printing and determining type information.

Reimplemented from vtkDijkstraGraphGeodesicPath.

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

Standard methids for printing and determining type information.

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

Standard methids for printing and determining type information.

Reimplemented from vtkDijkstraGraphGeodesicPath.

static vtkDijkstraImageGeodesicPath* vtkDijkstraImageGeodesicPath::SafeDownCast ( vtkObject o)
static

Standard methids for printing and determining type information.

void vtkDijkstraImageGeodesicPath::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Standard methids for printing and determining type information.

Reimplemented from vtkDijkstraGraphGeodesicPath.

void vtkDijkstraImageGeodesicPath::SetInput ( vtkDataObject )

Specify the image object which is used as a cost function.

vtkImageData* vtkDijkstraImageGeodesicPath::GetInputAsImageData ( )

Specify the image object which is used as a cost function.

void vtkDijkstraImageGeodesicPath::SetImageWeight ( double  )

Image cost weight.

virtual double vtkDijkstraImageGeodesicPath::GetImageWeight ( )
virtual

Image cost weight.

void vtkDijkstraImageGeodesicPath::SetEdgeLengthWeight ( double  )

Edge length cost weight.

virtual double vtkDijkstraImageGeodesicPath::GetEdgeLengthWeight ( )
virtual

Edge length cost weight.

virtual void vtkDijkstraImageGeodesicPath::SetCurvatureWeight ( double  )
virtual

Curvature cost weight.

virtual double vtkDijkstraImageGeodesicPath::GetCurvatureWeight ( )
virtual

Curvature cost weight.

virtual int vtkDijkstraImageGeodesicPath::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 vtkGeodesicPath.

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

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

Reimplemented from vtkDijkstraGraphGeodesicPath.

virtual void vtkDijkstraImageGeodesicPath::BuildAdjacency ( vtkDataSet inData)
protectedvirtual

Reimplemented from vtkDijkstraGraphGeodesicPath.

void vtkDijkstraImageGeodesicPath::UpdateStaticCosts ( vtkImageData image)
protected
virtual double vtkDijkstraImageGeodesicPath::CalculateStaticEdgeCost ( vtkDataSet inData,
vtkIdType  u,
vtkIdType  v 
)
protectedvirtual

Reimplemented from vtkDijkstraGraphGeodesicPath.

virtual double vtkDijkstraImageGeodesicPath::CalculateDynamicEdgeCost ( vtkDataSet inData,
vtkIdType  u,
vtkIdType  v 
)
protectedvirtual

Reimplemented from vtkDijkstraGraphGeodesicPath.

Member Data Documentation

double vtkDijkstraImageGeodesicPath::PixelSize
protected

Definition at line 115 of file vtkDijkstraImageGeodesicPath.h.

double vtkDijkstraImageGeodesicPath::ImageWeight
protected

Definition at line 116 of file vtkDijkstraImageGeodesicPath.h.

double vtkDijkstraImageGeodesicPath::EdgeLengthWeight
protected

Definition at line 117 of file vtkDijkstraImageGeodesicPath.h.

double vtkDijkstraImageGeodesicPath::CurvatureWeight
protected

Definition at line 118 of file vtkDijkstraImageGeodesicPath.h.

bool vtkDijkstraImageGeodesicPath::RebuildStaticCosts
protected

Definition at line 119 of file vtkDijkstraImageGeodesicPath.h.


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