vtkDijkstraImageGeodesicPath Class Reference

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

#include <vtkDijkstraImageGeodesicPath.h>

Inheritance diagram for vtkDijkstraImageGeodesicPath:

Collaboration diagram for vtkDijkstraImageGeodesicPath:

Public Member Functions
void	SetInputData (vtkDataObject *)
	Specify the image object which is used as a cost function.
vtkImageData *	GetInputAsImageData ()
	Specify the image object which is used as a cost function.
void	SetImageWeight (double)
	Image cost weight.
virtual double	GetImageWeight ()
	Image cost weight.
void	SetEdgeLengthWeight (double)
	Edge length cost weight.
virtual double	GetEdgeLengthWeight ()
	Edge length cost weight.
virtual void	SetCurvatureWeight (double)
	Curvature cost weight.
virtual double	GetCurvatureWeight ()
	Curvature cost weight.
Public Member Functions inherited from vtkDijkstraGraphGeodesicPath
virtual void	GetCumulativeWeights (vtkDoubleArray *weights)
	Fill the array with the cumulative weights.
virtual vtkIdList *	GetIdList ()
	The vertex ids (of the input polydata) on the shortest path.
virtual void	SetStopWhenEndReached (vtkTypeBool)
	Stop when the end vertex is reached or calculate shortest path to all vertices.
virtual vtkTypeBool	GetStopWhenEndReached ()
	Stop when the end vertex is reached or calculate shortest path to all vertices.
virtual void	StopWhenEndReachedOn ()
	Stop when the end vertex is reached or calculate shortest path to all vertices.
virtual void	StopWhenEndReachedOff ()
	Stop when the end vertex is reached or calculate shortest path to all vertices.
virtual void	SetUseScalarWeights (vtkTypeBool)
	Use scalar values in the edge weight (experimental)
virtual vtkTypeBool	GetUseScalarWeights ()
	Use scalar values in the edge weight (experimental)
virtual void	UseScalarWeightsOn ()
	Use scalar values in the edge weight (experimental)
virtual void	UseScalarWeightsOff ()
	Use scalar values in the edge weight (experimental)
virtual void	SetRepelPathFromVertices (vtkTypeBool)
	Use the input point to repel the path by assigning high costs.
virtual vtkTypeBool	GetRepelPathFromVertices ()
	Use the input point to repel the path by assigning high costs.
virtual void	RepelPathFromVerticesOn ()
	Use the input point to repel the path by assigning high costs.
virtual void	RepelPathFromVerticesOff ()
	Use the input point to repel the path by assigning high costs.
virtual void	SetRepelVertices (vtkPoints *)
	Specify vtkPoints to use to repel the path from.
virtual vtkPoints *	GetRepelVertices ()
	Specify vtkPoints to use to repel the path from.
vtkDijkstraGraphGeodesicPath *	NewInstance () const
	Standard methods for printing and determining type information.
Public Member Functions inherited from vtkGraphGeodesicPath
virtual vtkIdType	GetStartVertex ()
	The vertex at the start of the shortest path.
virtual void	SetStartVertex (vtkIdType)
	The vertex at the start of the shortest path.
virtual vtkIdType	GetEndVertex ()
	The vertex at the end of the shortest path.
virtual void	SetEndVertex (vtkIdType)
	The vertex at the end of the shortest path.
vtkGraphGeodesicPath *	NewInstance () const
	Standard methods for printing and determining type information.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for printing and determining type information.
Public Member Functions inherited from vtkGeodesicPath
vtkGeodesicPath *	NewInstance () const
	Standard methods for printing and determining type information.
Public Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkPolyDataAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	see vtkAlgorithm for details
vtkDataObject *	GetInput ()
vtkDataObject *	GetInput (int port)
vtkPolyData *	GetPolyDataInput (int port)
vtkPolyData *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkPolyData *	GetOutput (int)
	Get the output data object for a port on this algorithm.
virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
void	AddInputData (vtkDataObject *)
	Assign a data object as input.
void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
virtual vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.
virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetProgress (double)
	SetProgress is deprecated.
void	UpdateProgress (double amount)
	Update the progress of the process object.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	String based versions of SetInputArrayToProcess().
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
void	Register (vtkObjectBase *o) override
	Participate in garbage collection.
void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.
virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkDijkstraImageGeodesicPath *	New ()
	Instantiate the class.
Static Public Member Functions inherited from vtkDijkstraGraphGeodesicPath
static vtkDijkstraGraphGeodesicPath *	New ()
	Instantiate the class.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for printing and determining type information.
static vtkDijkstraGraphGeodesicPath *	SafeDownCast (vtkObjectBase *o)
	Standard methods for printing and determining type information.
Static Public Member Functions inherited from vtkGraphGeodesicPath
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for printing and determining type information.
static vtkGraphGeodesicPath *	SafeDownCast (vtkObjectBase *o)
	Standard methods for printing and determining type information.
Static Public Member Functions inherited from vtkGeodesicPath
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for printing and determining type information.
static vtkGeodesicPath *	SafeDownCast (vtkObjectBase *o)
	Standard methods for printing and determining type information.
Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
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 ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
	vtkDijkstraImageGeodesicPath ()
	~vtkDijkstraImageGeodesicPath () override
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called by the superclass.
void	BuildAdjacency (vtkDataSet *inData) override
void	UpdateStaticCosts (vtkImageData *image)
double	CalculateStaticEdgeCost (vtkDataSet *inData, vtkIdType u, vtkIdType v) override
double	CalculateDynamicEdgeCost (vtkDataSet *inData, vtkIdType u, vtkIdType v) override
Protected Member Functions inherited from vtkDijkstraGraphGeodesicPath
	vtkDijkstraGraphGeodesicPath ()
	~vtkDijkstraGraphGeodesicPath () override
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called by the superclass.
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 () override
Protected Member Functions inherited from vtkGeodesicPath
	vtkGeodesicPath ()
	~vtkGeodesicPath () override
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.
Protected Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPolyDataAlgorithm ()
	~vtkPolyDataAlgorithm () override
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	This is called by the superclass.
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass.
int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.
Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAlgorithm ()
	~vtkAlgorithm () override
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.
void	AddInputDataInternal (int port, vtkDataObject *input)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	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
vtkIdList *	IdList
vtkDijkstraGraphInternals *	Internals
vtkTypeBool	StopWhenEndReached
vtkTypeBool	UseScalarWeights
vtkTypeBool	RepelPathFromVertices
vtkPoints *	RepelVertices
Protected Attributes inherited from vtkGraphGeodesicPath
vtkIdType	StartVertex
vtkIdType	EndVertex
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkDijkstraGraphGeodesicPath	Superclass
	Standard methods for printing and determining type information.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for printing and determining type information.
static vtkDijkstraImageGeodesicPath *	SafeDownCast (vtkObjectBase *o)
	Standard methods for printing and determining type information.
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for printing and determining type information.
vtkDijkstraImageGeodesicPath *	NewInstance () const
	Standard methods for printing and determining type information.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for printing and determining type information.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for printing and determining type information.

Additional Inherited Members
Public Types inherited from vtkDijkstraGraphGeodesicPath
typedef vtkGraphGeodesicPath	Superclass
	Standard methods for printing and determining type information.
Public Types inherited from vtkGraphGeodesicPath
typedef vtkGeodesicPath	Superclass
	Standard methods for printing and determining type information.
Public Types inherited from vtkGeodesicPath
typedef vtkPolyDataAlgorithm	Superclass
	Standard methods for printing and determining type information.
Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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 scheme: 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.

Definition at line 58 of file vtkDijkstraImageGeodesicPath.h.

Member Typedef Documentation

Superclass

typedef vtkDijkstraGraphGeodesicPath vtkDijkstraImageGeodesicPath::Superclass

Standard methods for printing and determining type information.

Definition at line 70 of file vtkDijkstraImageGeodesicPath.h.

Constructor & Destructor Documentation

vtkDijkstraImageGeodesicPath()

vtkDijkstraImageGeodesicPath::vtkDijkstraImageGeodesicPath ( )

protected

~vtkDijkstraImageGeodesicPath()

vtkDijkstraImageGeodesicPath::~vtkDijkstraImageGeodesicPath ( )

overrideprotected

Member Function Documentation

New()

static vtkDijkstraImageGeodesicPath * vtkDijkstraImageGeodesicPath::New ( )

static

Instantiate the class.

IsTypeOf()

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

static

Standard methods for printing and determining type information.

IsA()

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

virtual

Standard methods for printing and determining type information.

Reimplemented from vtkDijkstraGraphGeodesicPath.

SafeDownCast()

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

static

Standard methods for printing and determining type information.

NewInstanceInternal()

virtual vtkObjectBase * vtkDijkstraImageGeodesicPath::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for printing and determining type information.

Reimplemented from vtkDijkstraGraphGeodesicPath.

NewInstance()

vtkDijkstraImageGeodesicPath * vtkDijkstraImageGeodesicPath::NewInstance

(

)

const

Standard methods for printing and determining type information.

PrintSelf()

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

overridevirtual

Standard methods for printing and determining type information.

Reimplemented from vtkDijkstraGraphGeodesicPath.

SetInputData()

void vtkDijkstraImageGeodesicPath::SetInputData

(

vtkDataObject *

)

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

GetInputAsImageData()

vtkImageData * vtkDijkstraImageGeodesicPath::GetInputAsImageData

(

)

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

SetImageWeight()

void vtkDijkstraImageGeodesicPath::SetImageWeight

(

double

)

Image cost weight.

GetImageWeight()

virtual double vtkDijkstraImageGeodesicPath::GetImageWeight ( )

virtual

Image cost weight.

SetEdgeLengthWeight()

void vtkDijkstraImageGeodesicPath::SetEdgeLengthWeight

(

double

)

Edge length cost weight.

GetEdgeLengthWeight()

virtual double vtkDijkstraImageGeodesicPath::GetEdgeLengthWeight ( )

virtual

Edge length cost weight.

SetCurvatureWeight()

virtual void vtkDijkstraImageGeodesicPath::SetCurvatureWeight ( double  )

virtual

Curvature cost weight.

GetCurvatureWeight()

virtual double vtkDijkstraImageGeodesicPath::GetCurvatureWeight ( )

virtual

Curvature cost weight.

FillInputPortInformation()

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

overrideprotectedvirtual

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 vtkPolyDataAlgorithm.

RequestData()

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

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkDijkstraGraphGeodesicPath.

BuildAdjacency()

void vtkDijkstraImageGeodesicPath::BuildAdjacency ( vtkDataSet *  inData )

overrideprotectedvirtual

Reimplemented from vtkDijkstraGraphGeodesicPath.

UpdateStaticCosts()

void vtkDijkstraImageGeodesicPath::UpdateStaticCosts ( vtkImageData *  image )

protected

CalculateStaticEdgeCost()

double vtkDijkstraImageGeodesicPath::CalculateStaticEdgeCost ( vtkDataSet *  inData, vtkIdType  u, vtkIdType  v  )

overrideprotectedvirtual

Reimplemented from vtkDijkstraGraphGeodesicPath.

CalculateDynamicEdgeCost()

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

overrideprotectedvirtual

Reimplemented from vtkDijkstraGraphGeodesicPath.

Member Data Documentation

PixelSize

double vtkDijkstraImageGeodesicPath::PixelSize

protected

Definition at line 123 of file vtkDijkstraImageGeodesicPath.h.

ImageWeight

double vtkDijkstraImageGeodesicPath::ImageWeight

protected

Definition at line 124 of file vtkDijkstraImageGeodesicPath.h.

EdgeLengthWeight

double vtkDijkstraImageGeodesicPath::EdgeLengthWeight

protected

Definition at line 125 of file vtkDijkstraImageGeodesicPath.h.

CurvatureWeight

double vtkDijkstraImageGeodesicPath::CurvatureWeight

protected

Definition at line 126 of file vtkDijkstraImageGeodesicPath.h.

RebuildStaticCosts

bool vtkDijkstraImageGeodesicPath::RebuildStaticCosts

protected

Definition at line 127 of file vtkDijkstraImageGeodesicPath.h.

---

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

• Filters/Modeling/vtkDijkstraImageGeodesicPath.h