#include <itkArrivalFunctionToPathFilter.h>

Inheritance diagram for itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >:

Collaboration diagram for itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >:

Detailed Description

template<class TInputImage, class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
class itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >

Extracts a path from a Fast Marching arrival function.

This filter extracts the geodesic (minimal) path between the given end-point and a start-point (which is implicitly embedded in the given arrival function). The path is extracted by back-propagating perpendicular to the Fast Marching front from the end-point to the global minimum of the arrival function (ie. the start-point). A step-wise optimizer is used to perform the back-propagation.

The user must provide the following:

A real-valued arrival function as the filter input
At least one path end point. The arrival function must be a real-valued (float or double) image in the range [0,inf). If multiple end points are given, multiple paths are extracted and saved to separate filter outputs.

A cost function optimizer may also be provided. If an optimizer is not given, a RegularStepGradientDescentOptimizer is created with default settings. The optimizer is responsible for tracking from the given end-point to the embedded start-point. This filter listens for the optimizer Iteration event and stores the current position as a point in the current path. Therefore, only step-wise optimizers (which report their intermediate position at each iteration) are suitable for extracting the path. Current suitable optimizers include: RegularStepGradientDescentOptimizer, GradientDescentOptimizer, and IterateNeighborhoodOptimizer.

The TerminationValue parameter prevents unwanted oscillations when closing in on the start-point. The optimizer is terminated when the current arrival value is less than TerminationValue; the smaller the value, the closer the path will get to the start-point. The default is 1.0. It is recommended that your optimizer has a small step size when TerminationValue is small.

This filter is based on the methods described in: [1] J. Sethian. Level Set Methods and Fast Marching Methods, chapter 20. Cambridge Press, 2nd edition, 1999. [2] J. Andrews and J. Sethian. Fast marching methods for the continuous traveling salesman problem. Proceedings of the National Academy of Sciences (PNAS), 104(4):1118/1123, 2007.

Author: Dan Mueller, Queensland University of Technology, dan.muel[at]gmail.com

Definition at line 144 of file itkArrivalFunctionToPathFilter.h.

Public Types
using	CommandType = ArrivalFunctionToPathCommand< Self >

using	ConstPointer = SmartPointer< const Self >

using	ContinuousIndexType = ContinuousIndex< double, InputImageDimension >

using	CostFunctionType = SingleImageCostFunction< InputImageType >

using	DefaultOptimizerType = RegularStepGradientDescentOptimizer

using	IndexType = Index< InputImageDimension >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	OptimizerType = SingleValuedNonLinearOptimizer

using	OutputPathConstPointer = typename OutputPathType::ConstPointer

using	OutputPathPointer = typename OutputPathType::Pointer

using	OutputPathType = TOutputPath

using	Pointer = SmartPointer< Self >

using	PointsContainerType = std::vector< PointType >

using	PointType = Point< double, InputImageDimension >

using	Self = ArrivalFunctionToPathFilter

using	Superclass = ImageToPathFilter< TInputImage, TOutputPath >

Public Types inherited from itk::ImageToPathFilter< TInputImage, TOutputPath >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToPathFilter

using	Superclass = PathSource< TOutputPath >

Public Types inherited from itk::PathSource< TOutputPath >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectPointer = DataObject::Pointer

using	OutputPathIndexType = typename OutputPathType::IndexType

using	OutputPathInputType = typename OutputPathType::InputType

using	OutputPathOffsetType = typename OutputPathType::OffsetType

using	OutputPathOutputType = typename OutputPathType::OutputType

using	OutputPathPointer = typename OutputPathType::Pointer

using	OutputPathType = TOutputPath

using	Pointer = SmartPointer< Self >

using	Self = PathSource

using	Superclass = ProcessObject

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual void	AddPathEndPoint (const PointType &point)

virtual void	ClearPathEndPoints ()

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual void	Execute (const itk::Object *object, const itk::EventObject &event)

virtual const char *	GetNameOfClass () const

virtual void	SetPathEndPoint (const PointType &point)


virtual void	SetOptimizer (OptimizerType *_arg)

virtual const OptimizerType *	GetOptimizer () const


virtual void	SetCostFunction (CostFunctionType *_arg)

virtual const CostFunctionType *	GetCostFunction () const


virtual void	SetTerminationValue (typename OptimizerType::MeasureType _arg)

virtual OptimizerType::MeasureType	GetTerminationValue ()

Public Member Functions inherited from itk::ImageToPathFilter< TInputImage, TOutputPath >
const InputImageType *	GetInput ()

const InputImageType *	GetInput (unsigned int idx)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TInputImage *image)

Public Member Functions inherited from itk::PathSource< TOutputPath >
OutputPathType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, OutputPathType *output)

virtual void	GraftOutput (OutputPathType *output)

OutputPathType *	GetOutput ()

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::PathSource< TOutputPath >
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	InputImageDimension = InputImageType::ImageDimension

Static Public Attributes inherited from itk::ImageToPathFilter< TInputImage, TOutputPath >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

Protected Member Functions
	ArrivalFunctionToPathFilter ()

virtual InputImageType *	ComputeArrivalFunction ()

void	GenerateData (void) override

void	GenerateInputRequestedRegion () override

virtual const PointsContainerType &	GetNextEndPoint ()

virtual unsigned int	GetNumberOfPathsToExtract () const

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ArrivalFunctionToPathFilter () override

Protected Member Functions inherited from itk::ImageToPathFilter< TInputImage, TOutputPath >
	ImageToPathFilter ()

	~ImageToPathFilter () override=default

Protected Member Functions inherited from itk::PathSource< TOutputPath >
	PathSource ()

	~PathSource () override=default

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () ITKv5_CONST

virtual void	VerifyPreconditions () ITKv5_CONST

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
CostFunctionType::Pointer	m_CostFunction

unsigned int	m_CurrentOutput

OptimizerType::Pointer	m_Optimizer

std::vector< PointsContainerType >	m_PointList

OptimizerType::MeasureType	m_TerminationValue

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount