ITK image filter that computes the shortest path between pixels using A*. More...

#include <itkShortestPathImageFilter.h>

Inheritance diagram for itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >:

Collaboration diagram for itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >:

[legend]

Classes
struct	CompareNodeStar
	Comparator for the A* priority queue. More...

Public Types
typedef ShortestPathImageFilter	Self

typedef ImageToImageFilter< TInputImageType, TOutputImageType >	Superclass

typedef SmartPointer< Self >	Pointer

typedef SmartPointer< const Self >	ConstPointer

typedef ShortestPathCostFunction< TInputImageType >	CostFunctionType

typedef CostFunctionType::Pointer	CostFunctionTypePointer

typedef TInputImageType	InputImageType

typedef TInputImageType::Pointer	InputImagePointer

typedef TInputImageType::PixelType	InputImagePixelType

typedef TInputImageType::SizeType	InputImageSizeType

typedef TInputImageType::IndexType	IndexType

typedef itk::ImageRegionIteratorWithIndex< InputImageType >	InputImageIteratorType

typedef TOutputImageType	OutputImageType

typedef TOutputImageType::Pointer	OutputImagePointer

typedef TOutputImageType::PixelType	OutputImagePixelType

typedef TOutputImageType::IndexType	OutputImageIndexType

typedef ImageRegionIteratorWithIndex< OutputImageType >	OutputImageIteratorType

typedef itk::ShapedNeighborhoodIterator< TInputImageType >	itkShapedNeighborhoodIteratorType

Public Member Functions
Pointer	Clone () const

virtual const char *	GetClassName () const

void	PrintSelf (std::ostream &os, Indent indent) const override
	Print object information to an output stream. More...

void	SetStartIndex (const IndexType &StartIndex)
	Set the start pixel index for the shortest path computation. More...

void	AddEndIndex (const IndexType &index)
	Add an additional endpoint for multi-target shortest path search. More...

void	SetEndIndex (const IndexType &EndIndex)
	Set the (single) endpoint for the shortest path computation. More...

virtual void	SetFullNeighborsMode (bool _arg)
	Set the neighborhood connectivity mode. More...

virtual bool	GetFullNeighborsMode ()
	Get the current neighborhood connectivity mode. More...

virtual void	SetGraph_fullNeighbors (bool _arg)
	Set graph-level full neighbors mode. More...

virtual void	SetMakeOutputImage (bool _arg)
	Set whether to produce a binary output image of the path. More...

virtual bool	GetMakeOutputImage ()
	Get whether output image generation is enabled. More...

virtual void	SetStoreVectorOrder (bool _arg)
	Set whether to record the pixel visit order. More...

virtual bool	GetStoreVectorOrder ()
	Get whether visit order recording is enabled. More...

virtual void	SetCalcAllDistances (bool _arg)
	Set whether to compute distances to all pixels. More...

virtual bool	GetCalcAllDistances ()
	Get whether all-distances mode is enabled. More...

virtual void	SetActivateTimeOut (bool _arg)
	Set whether to enable a 30-second timeout. More...

virtual bool	GetActivateTimeOut ()
	Get whether the timeout is enabled. More...

std::vector< IndexType >	GetVectorPath ()
	Get the computed shortest path as a vector of pixel indices. More...

std::vector< std::vector< IndexType > >	GetMultipleVectorPaths ()
	Get multiple shortest paths for multi-endpoint searches. More...

OutputImagePointer	GetVectorOrderImage ()
	Get an image showing the pixel visit order. More...

OutputImagePointer	GetDistanceImage ()
	Get the distance image showing shortest distances from the start. More...

void	MakeShortestPathVector ()
	Trace back from end to start and fill m_VectorPath. More...

void	CleanUp ()
	Clean up allocated resources. More...

virtual void	SetCostFunction (CostFunctionType *_arg)
	Set the cost function used for computing transition costs. More...

virtual CostFunctionType *	GetCostFunction ()
	Get the cost function used for computing transition costs. More...

void	SetUseCostFunction (bool doUseCostFunction)
	Enable or disable the custom cost function. More...

bool	GetUseCostFunction ()
	Query whether the custom cost function is enabled. More...

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	ShortestPathImageFilter (Self &)

void	operator= (const Self &)

	ShortestPathImageFilter ()

	~ShortestPathImageFilter () override

void	MakeOutputs ()

void	GenerateData () override

double	getEstimatedCostsToTarget (const IndexType &a)

TInputImageType::IndexType	NodeToCoord (NodeNumType)

unsigned int	CoordToNode (IndexType)

std::vector< ShortestPathNode * >	GetNeighbors (NodeNumType nodeNum, bool FullNeighbors)

bool	CoordIsInBounds (IndexType)

void	InitGraph ()

void	StartShortestPathSearch ()

Protected Attributes
std::vector< IndexType >	m_endPoints

std::vector< IndexType >	m_endPointsClosed

ShortestPathNode *	m_Nodes

NodeNumType	m_Graph_NumberOfNodes

NodeNumType	m_Graph_StartNode

NodeNumType	m_Graph_EndNode

bool	m_Graph_fullNeighbors

bool	m_useCostFunction

std::vector< ShortestPathNode * >	m_Graph_DiscoveredNodeList

bool	m_FullNeighborsMode

bool	m_MakeOutputImage

bool	m_StoreVectorOrder

bool	m_CalcAllDistances

bool	multipleEndPoints

bool	m_ActivateTimeOut

bool	m_Initialized

CostFunctionTypePointer	m_CostFunction

IndexType	m_StartIndex

IndexType	m_EndIndex

std::vector< IndexType >	m_VectorPath

std::vector< std::vector< IndexType > >	m_MultipleVectorPaths

std::vector< NodeNumType >	m_VectorOrder

InputImageType::Pointer	m_magnitudeImage

Static Protected Attributes
static const int	BACKGROUND

static const int	FOREGROUND

Detailed Description

template<class TInputImageType, class TOutputImageType>
class itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >

ITK image filter that computes the shortest path between pixels using A*.

This filter finds the optimal (minimum cost) path between a start pixel and one or more end pixels in an image, using the A* graph search algorithm with a pluggable cost function. The cost function (ShortestPathCostFunction) determines the transition cost between neighboring pixels.

Required inputs:

Input image via SetInput()
Start pixel via SetStartIndex()
End pixel via SetEndIndex() (or multiple via AddEndIndex())

Optional settings:

SetFullNeighborsMode(): N4/N6 (false, default) or N8/N26 (true) neighborhood
SetMakeOutputImage(): Generate a binary output image of the path (default: true)
SetCalcAllDistances(): Compute distances to all pixels (default: false, slow)
SetStoreVectorOrder(): Record pixel visit order for debugging (default: false)
SetActivateTimeOut(): Abort after 30 seconds (default: false)
SetCostFunction(): Plug in a custom cost function

Output retrieval:

GetVectorPath(): The shortest path as a vector of pixel indices
GetMultipleVectorPaths(): Multiple paths when multiple endpoints are used
GetDistanceImage(): Distance image (requires SetCalcAllDistances(true))
GetVectorOrderImage(): Visit order image (requires SetStoreVectorOrder(true))

Template Parameters

TInputImageType	The input image type (2D or 3D).
TOutputImageType	The output image type (typically same dimensionality).

See also: ShortestPathCostFunction; ShortestPathCostFunctionLiveWire; ShortestPathNode

Definition at line 59 of file itkShortestPathImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImageType , class TOutputImageType >

typedef SmartPointer<const Self> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::ConstPointer

Definition at line 66 of file itkShortestPathImageFilter.h.

◆ CostFunctionType

template<class TInputImageType , class TOutputImageType >

typedef ShortestPathCostFunction<TInputImageType> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::CostFunctionType

Definition at line 69 of file itkShortestPathImageFilter.h.

◆ CostFunctionTypePointer

template<class TInputImageType , class TOutputImageType >

typedef CostFunctionType::Pointer itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::CostFunctionTypePointer

Definition at line 70 of file itkShortestPathImageFilter.h.

◆ IndexType

template<class TInputImageType , class TOutputImageType >

typedef TInputImageType::IndexType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::IndexType

Definition at line 77 of file itkShortestPathImageFilter.h.

◆ InputImageIteratorType

template<class TInputImageType , class TOutputImageType >

typedef itk::ImageRegionIteratorWithIndex<InputImageType> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::InputImageIteratorType

Definition at line 78 of file itkShortestPathImageFilter.h.

◆ InputImagePixelType

template<class TInputImageType , class TOutputImageType >

typedef TInputImageType::PixelType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::InputImagePixelType

Definition at line 75 of file itkShortestPathImageFilter.h.

◆ InputImagePointer

template<class TInputImageType , class TOutputImageType >

typedef TInputImageType::Pointer itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::InputImagePointer

Definition at line 74 of file itkShortestPathImageFilter.h.

◆ InputImageSizeType

template<class TInputImageType , class TOutputImageType >

typedef TInputImageType::SizeType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::InputImageSizeType

Definition at line 76 of file itkShortestPathImageFilter.h.

◆ InputImageType

template<class TInputImageType , class TOutputImageType >

typedef TInputImageType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::InputImageType

Definition at line 73 of file itkShortestPathImageFilter.h.

◆ itkShapedNeighborhoodIteratorType

template<class TInputImageType , class TOutputImageType >

typedef itk::ShapedNeighborhoodIterator<TInputImageType> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::itkShapedNeighborhoodIteratorType

Definition at line 85 of file itkShortestPathImageFilter.h.

◆ OutputImageIndexType

template<class TInputImageType , class TOutputImageType >

typedef TOutputImageType::IndexType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::OutputImageIndexType

Definition at line 83 of file itkShortestPathImageFilter.h.

◆ OutputImageIteratorType

template<class TInputImageType , class TOutputImageType >

typedef ImageRegionIteratorWithIndex<OutputImageType> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::OutputImageIteratorType

Definition at line 84 of file itkShortestPathImageFilter.h.

◆ OutputImagePixelType

template<class TInputImageType , class TOutputImageType >

typedef TOutputImageType::PixelType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::OutputImagePixelType

Definition at line 82 of file itkShortestPathImageFilter.h.

◆ OutputImagePointer

template<class TInputImageType , class TOutputImageType >

typedef TOutputImageType::Pointer itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::OutputImagePointer

Definition at line 81 of file itkShortestPathImageFilter.h.

◆ OutputImageType

template<class TInputImageType , class TOutputImageType >

typedef TOutputImageType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::OutputImageType

Definition at line 80 of file itkShortestPathImageFilter.h.

◆ Pointer

template<class TInputImageType , class TOutputImageType >

typedef SmartPointer<Self> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::Pointer

Definition at line 65 of file itkShortestPathImageFilter.h.

◆ Self

template<class TInputImageType , class TOutputImageType >

typedef ShortestPathImageFilter itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::Self

Definition at line 63 of file itkShortestPathImageFilter.h.

◆ Superclass

template<class TInputImageType , class TOutputImageType >

typedef ImageToImageFilter<TInputImageType, TOutputImageType> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::Superclass

Definition at line 64 of file itkShortestPathImageFilter.h.

Constructor & Destructor Documentation

◆ ShortestPathImageFilter() [1/2]

template<class TInputImageType , class TOutputImageType >

itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::ShortestPathImageFilter ( Self & )

protected

◆ ShortestPathImageFilter() [2/2]

template<class TInputImageType , class TOutputImageType >

itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::ShortestPathImageFilter ( )

protected

◆ ~ShortestPathImageFilter()

template<class TInputImageType , class TOutputImageType >

itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::~ShortestPathImageFilter ( )

overrideprotected

Member Function Documentation

◆ AddEndIndex()

template<class TInputImageType , class TOutputImageType >

void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::AddEndIndex ( const IndexType & index )

Add an additional endpoint for multi-target shortest path search.

When multiple endpoints are added, the algorithm finds the shortest path from the start to each endpoint. Results can be retrieved via GetMultipleVectorPaths().

Parameters

[in] index The image index of the additional endpoint.

See also: GetMultipleVectorPaths

◆ CleanUp()

template<class TInputImageType , class TOutputImageType >

void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::CleanUp ( )

Clean up allocated resources.

Deletes the node array and resets internal state. Called automatically at the end of GenerateData().

◆ Clone()

template<class TInputImageType , class TOutputImageType >

Pointer itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::Clone ( ) const

◆ CoordIsInBounds()

template<class TInputImageType , class TOutputImageType >

bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::CoordIsInBounds ( IndexType )

protected

◆ CoordToNode()

template<class TInputImageType , class TOutputImageType >

unsigned int itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::CoordToNode ( IndexType )

protected

◆ GenerateData()

template<class TInputImageType , class TOutputImageType >

void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GenerateData ( )

overrideprotected

◆ GetActivateTimeOut()

template<class TInputImageType , class TOutputImageType >

virtual bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetActivateTimeOut ( )

virtual

Get whether the timeout is enabled.

◆ GetCalcAllDistances()

template<class TInputImageType , class TOutputImageType >

virtual bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetCalcAllDistances ( )

virtual

Get whether all-distances mode is enabled.

◆ GetClassName()

template<class TInputImageType , class TOutputImageType >

virtual const char* itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetClassName ( ) const

virtual

◆ GetCostFunction()

template<class TInputImageType , class TOutputImageType >

virtual CostFunctionType* itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetCostFunction ( )

virtual

Get the cost function used for computing transition costs.

◆ GetDistanceImage()

template<class TInputImageType , class TOutputImageType >

OutputImagePointer itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetDistanceImage ( )

Get the distance image showing shortest distances from the start.

Each pixel value represents the minimum cumulative cost from the start pixel to that pixel.

Returns: The distance image.

Precondition: SetCalcAllDistances(true) must have been called before Update().

◆ getEstimatedCostsToTarget()

template<class TInputImageType , class TOutputImageType >

double itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::getEstimatedCostsToTarget ( const IndexType & a )

protected

◆ GetFullNeighborsMode()

template<class TInputImageType , class TOutputImageType >

virtual bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetFullNeighborsMode ( )

virtual

Get the current neighborhood connectivity mode.

◆ GetMakeOutputImage()

template<class TInputImageType , class TOutputImageType >

virtual bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetMakeOutputImage ( )

virtual

Get whether output image generation is enabled.

◆ GetMultipleVectorPaths()

template<class TInputImageType , class TOutputImageType >

std::vector<std::vector<IndexType> > itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetMultipleVectorPaths ( )

Get multiple shortest paths for multi-endpoint searches.

Returns one path per endpoint added via AddEndIndex().

Returns: A vector of vectors, each containing a path as pixel indices.

Precondition: Multiple endpoints must have been added and the filter updated.

See also: AddEndIndex

◆ GetNeighbors()

template<class TInputImageType , class TOutputImageType >

std::vector<ShortestPathNode *> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetNeighbors	(	NodeNumType	nodeNum,
		bool	FullNeighbors
	)

protected

◆ GetStoreVectorOrder()

template<class TInputImageType , class TOutputImageType >

virtual bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetStoreVectorOrder ( )

virtual

Get whether visit order recording is enabled.

◆ GetUseCostFunction()

template<class TInputImageType , class TOutputImageType >

bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetUseCostFunction ( )

inline

Query whether the custom cost function is enabled.

Returns: true if the custom cost function is in use.

Definition at line 279 of file itkShortestPathImageFilter.h.

References itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_useCostFunction.

◆ GetVectorOrderImage()

template<class TInputImageType , class TOutputImageType >

OutputImagePointer itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetVectorOrderImage ( )

Get an image showing the pixel visit order.

Each pixel value represents the order in which it was visited during the search. Useful for debugging and visualization.

Returns: The visit order image.

Precondition: SetStoreVectorOrder(true) must have been called before Update().

◆ GetVectorPath()

template<class TInputImageType , class TOutputImageType >

std::vector<IndexType> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetVectorPath ( )

Get the computed shortest path as a vector of pixel indices.

Returns: A vector of IndexType representing the path from start to end.

Precondition: The filter must have been updated (Update() called).

◆ InitGraph()

template<class TInputImageType , class TOutputImageType >

void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::InitGraph ( )

protected

◆ MakeOutputs()

template<class TInputImageType , class TOutputImageType >

void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::MakeOutputs ( )

protected

◆ MakeShortestPathVector()

template<class TInputImageType , class TOutputImageType >

void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::MakeShortestPathVector ( )

Trace back from end to start and fill m_VectorPath.

Follows the prevNode links from the end node back to the start node to construct the shortest path vector.

◆ New()

template<class TInputImageType , class TOutputImageType >

static Pointer itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::New ( )

static

◆ NodeToCoord()

template<class TInputImageType , class TOutputImageType >

TInputImageType::IndexType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::NodeToCoord ( NodeNumType )

protected

◆ operator=()

template<class TInputImageType , class TOutputImageType >

void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::operator= ( const Self & )

protected

◆ PrintSelf()

template<class TInputImageType , class TOutputImageType >

void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

override

Print object information to an output stream.

Parameters

[in,out]	os	The output stream.
[in]	indent	The indentation level.

◆ SetActivateTimeOut()

template<class TInputImageType , class TOutputImageType >

virtual void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::SetActivateTimeOut ( bool _arg )

virtual

Set whether to enable a 30-second timeout.

Default is false. When true, the algorithm terminates after 30 seconds. Useful for debugging; inspect GetVectorOrderImage() to see how far the search progressed.

◆ SetCalcAllDistances()

template<class TInputImageType , class TOutputImageType >

virtual void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::SetCalcAllDistances ( bool _arg )

virtual

Set whether to compute distances to all pixels.

Default is false. When true, the algorithm does not stop at the endpoint but continues until all reachable pixels are visited. Results can be retrieved via GetDistanceImage().

Warning: This significantly increases computation time.

◆ SetCostFunction()

template<class TInputImageType , class TOutputImageType >

virtual void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::SetCostFunction ( CostFunctionType * _arg )

virtual

Set the cost function used for computing transition costs.

◆ SetEndIndex()

template<class TInputImageType , class TOutputImageType >

void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::SetEndIndex ( const IndexType & EndIndex )

Set the (single) endpoint for the shortest path computation.

Parameters

[in] EndIndex The image index where the path ends.

◆ SetFullNeighborsMode()

template<class TInputImageType , class TOutputImageType >

virtual void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::SetFullNeighborsMode ( bool _arg )

virtual

Set the neighborhood connectivity mode.

When false (default), uses N4 (2D) or N6 (3D) neighborhood (no diagonal neighbors). When true, uses N8 (2D) or N26 (3D).

◆ SetGraph_fullNeighbors()

template<class TInputImageType , class TOutputImageType >

virtual void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::SetGraph_fullNeighbors ( bool _arg )

virtual

Set graph-level full neighbors mode.

Internal setting controlling whether the graph uses diagonal neighbors. Typically set to match FullNeighborsMode.

◆ SetMakeOutputImage()

template<class TInputImageType , class TOutputImageType >

virtual void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::SetMakeOutputImage ( bool _arg )

virtual

Set whether to produce a binary output image of the path.

Default is true. When true, the output image shows FOREGROUND (255) on path pixels and BACKGROUND (0) elsewhere. The path can also be retrieved as a vector via GetVectorPath().

◆ SetStartIndex()

template<class TInputImageType , class TOutputImageType >

void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::SetStartIndex ( const IndexType & StartIndex )

Set the start pixel index for the shortest path computation.

Parameters

[in] StartIndex The image index where the path begins.

◆ SetStoreVectorOrder()

template<class TInputImageType , class TOutputImageType >

virtual void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::SetStoreVectorOrder ( bool _arg )

virtual

Set whether to record the pixel visit order.

Default is false. When true, the visit order is stored and can be retrieved via GetVectorOrderImage(). Useful for debugging.

◆ SetUseCostFunction()

template<class TInputImageType , class TOutputImageType >

void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::SetUseCostFunction ( bool doUseCostFunction )

inline

Enable or disable the custom cost function.

When disabled, a default unit cost is used for all transitions.

Parameters

[in] doUseCostFunction true to use the set cost function, false for unit cost.

Definition at line 273 of file itkShortestPathImageFilter.h.

References itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_useCostFunction.

◆ StartShortestPathSearch()

template<class TInputImageType , class TOutputImageType >

void itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::StartShortestPathSearch ( )

protected

Member Data Documentation

◆ BACKGROUND

template<class TInputImageType , class TOutputImageType >

const int itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::BACKGROUND

staticprotected

Definition at line 295 of file itkShortestPathImageFilter.h.

◆ FOREGROUND

template<class TInputImageType , class TOutputImageType >

const int itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::FOREGROUND

staticprotected

Definition at line 296 of file itkShortestPathImageFilter.h.

◆ m_ActivateTimeOut

template<class TInputImageType , class TOutputImageType >

bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_ActivateTimeOut

protected

Definition at line 306 of file itkShortestPathImageFilter.h.

◆ m_CalcAllDistances

template<class TInputImageType , class TOutputImageType >

bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_CalcAllDistances

protected

Definition at line 301 of file itkShortestPathImageFilter.h.

◆ m_CostFunction

template<class TInputImageType , class TOutputImageType >

CostFunctionTypePointer itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_CostFunction

protected

Definition at line 310 of file itkShortestPathImageFilter.h.

◆ m_EndIndex

template<class TInputImageType , class TOutputImageType >

IndexType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_EndIndex

protected

Definition at line 311 of file itkShortestPathImageFilter.h.

◆ m_endPoints

template<class TInputImageType , class TOutputImageType >

std::vector<IndexType> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_endPoints

protected

Definition at line 283 of file itkShortestPathImageFilter.h.

◆ m_endPointsClosed

template<class TInputImageType , class TOutputImageType >

std::vector<IndexType> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_endPointsClosed

protected

Definition at line 284 of file itkShortestPathImageFilter.h.

◆ m_FullNeighborsMode

template<class TInputImageType , class TOutputImageType >

bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_FullNeighborsMode

protected

Definition at line 297 of file itkShortestPathImageFilter.h.

◆ m_Graph_DiscoveredNodeList

template<class TInputImageType , class TOutputImageType >

std::vector<ShortestPathNode *> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_Graph_DiscoveredNodeList

protected

Definition at line 292 of file itkShortestPathImageFilter.h.

◆ m_Graph_EndNode

template<class TInputImageType , class TOutputImageType >

NodeNumType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_Graph_EndNode

protected

Definition at line 289 of file itkShortestPathImageFilter.h.

◆ m_Graph_fullNeighbors

template<class TInputImageType , class TOutputImageType >

bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_Graph_fullNeighbors

protected

Definition at line 290 of file itkShortestPathImageFilter.h.

◆ m_Graph_NumberOfNodes

template<class TInputImageType , class TOutputImageType >

NodeNumType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_Graph_NumberOfNodes

protected

Definition at line 287 of file itkShortestPathImageFilter.h.

◆ m_Graph_StartNode

template<class TInputImageType , class TOutputImageType >

NodeNumType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_Graph_StartNode

protected

Definition at line 288 of file itkShortestPathImageFilter.h.

◆ m_Initialized

template<class TInputImageType , class TOutputImageType >

bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_Initialized

protected

Definition at line 308 of file itkShortestPathImageFilter.h.

◆ m_magnitudeImage

template<class TInputImageType , class TOutputImageType >

InputImageType::Pointer itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_magnitudeImage

protected

Definition at line 330 of file itkShortestPathImageFilter.h.

◆ m_MakeOutputImage

template<class TInputImageType , class TOutputImageType >

bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_MakeOutputImage

protected

Definition at line 299 of file itkShortestPathImageFilter.h.

◆ m_MultipleVectorPaths

template<class TInputImageType , class TOutputImageType >

std::vector<std::vector<IndexType> > itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_MultipleVectorPaths

protected

Definition at line 313 of file itkShortestPathImageFilter.h.

◆ m_Nodes

template<class TInputImageType , class TOutputImageType >

ShortestPathNode* itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_Nodes

protected

Definition at line 286 of file itkShortestPathImageFilter.h.

◆ m_StartIndex

template<class TInputImageType , class TOutputImageType >

IndexType itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_StartIndex

protected

Definition at line 311 of file itkShortestPathImageFilter.h.

◆ m_StoreVectorOrder

template<class TInputImageType , class TOutputImageType >

bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_StoreVectorOrder

protected

Definition at line 300 of file itkShortestPathImageFilter.h.

◆ m_useCostFunction

template<class TInputImageType , class TOutputImageType >

bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_useCostFunction

protected

Definition at line 291 of file itkShortestPathImageFilter.h.

Referenced by itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::GetUseCostFunction(), and itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::SetUseCostFunction().

◆ m_VectorOrder

template<class TInputImageType , class TOutputImageType >

std::vector<NodeNumType> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_VectorOrder

protected

Definition at line 315 of file itkShortestPathImageFilter.h.

◆ m_VectorPath

template<class TInputImageType , class TOutputImageType >

std::vector<IndexType> itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::m_VectorPath

protected

Definition at line 312 of file itkShortestPathImageFilter.h.

◆ multipleEndPoints

template<class TInputImageType , class TOutputImageType >

bool itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >::multipleEndPoints

protected

Definition at line 304 of file itkShortestPathImageFilter.h.

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

itkShortestPathImageFilter.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

template<class TInputImageType, class TOutputImageType> class itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >

Member Typedef Documentation

◆ ConstPointer

◆ CostFunctionType

◆ CostFunctionTypePointer

◆ IndexType

◆ InputImageIteratorType

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageSizeType

◆ InputImageType

◆ itkShapedNeighborhoodIteratorType

◆ OutputImageIndexType

◆ OutputImageIteratorType

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ShortestPathImageFilter() [1/2]

◆ ShortestPathImageFilter() [2/2]

◆ ~ShortestPathImageFilter()

Member Function Documentation

◆ AddEndIndex()

◆ CleanUp()

◆ Clone()

◆ CoordIsInBounds()

◆ CoordToNode()

◆ GenerateData()

◆ GetActivateTimeOut()

◆ GetCalcAllDistances()

◆ GetClassName()

◆ GetCostFunction()

◆ GetDistanceImage()

◆ getEstimatedCostsToTarget()

◆ GetFullNeighborsMode()

◆ GetMakeOutputImage()

◆ GetMultipleVectorPaths()

◆ GetNeighbors()

◆ GetStoreVectorOrder()

◆ GetUseCostFunction()

◆ GetVectorOrderImage()

◆ GetVectorPath()

◆ InitGraph()

◆ MakeOutputs()

◆ MakeShortestPathVector()

◆ New()

◆ NodeToCoord()

◆ operator=()

◆ PrintSelf()

◆ SetActivateTimeOut()

◆ SetCalcAllDistances()

◆ SetCostFunction()

◆ SetEndIndex()

◆ SetFullNeighborsMode()

◆ SetGraph_fullNeighbors()

◆ SetMakeOutputImage()

◆ SetStartIndex()

◆ SetStoreVectorOrder()

◆ SetUseCostFunction()

◆ StartShortestPathSearch()

Member Data Documentation

◆ BACKGROUND

◆ FOREGROUND

◆ m_ActivateTimeOut

◆ m_CalcAllDistances

◆ m_CostFunction

◆ m_EndIndex

◆ m_endPoints

◆ m_endPointsClosed

template<class TInputImageType, class TOutputImageType>
class itk::ShortestPathImageFilter< TInputImageType, TOutputImageType >