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
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInput (vtkDataObject *)
 
void SetInput (int, vtkDataObject *)
 
void AddInput (vtkDataObject *)
 
void AddInput (int, vtkDataObject *)
 
- 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
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)
 
- Static Public Member Functions inherited from vtkGeodesicPath
static int IsTypeOf (const char *type)
 
static vtkGeodesicPathSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (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

 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
 
- 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
 
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 Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase 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
 

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: