#include <itkSpeedFunctionToPathFilter.h>

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

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

Detailed Description

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

Extracts a path from a speed function between a start point and end point, which also passes near the given way points.

This filter propagates a number of Fast Marching fronts using the given speed image to facilitate the path extraction. For each end- and way-point, a Fast Marching arrival function is computed. The minimal path is extracted for each segment and concatenated to obtain the total path between the start- and end-points, while passing near the given way-points.

The user must provide the following:

A real-valued speed function as the filter input
At least one PathInfo object using AddPathInfo(). The speed function must be a real-valued (float or double) image in the range [0,1]. If multiple PathInfo objects are added, 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. Other suitable optimizers include GradientDescentOptimizer and IterateNeighborhoodOptimizer. See itkArrivalFunctionToPathFilter.h for more details.

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

See Also: ArrivalFunctionToPathFilter

Definition at line 66 of file itkSpeedFunctionToPathFilter.h.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ContinuousIndexType = typename Superclass::ContinuousIndexType

using	CostFunctionType = typename Superclass::CostFunctionType

using	IndexType = typename Superclass::IndexType

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 = typename Superclass::OptimizerType

using	OutputPathConstPointer = typename OutputPathType::ConstPointer

using	OutputPathPointer = typename OutputPathType::Pointer

using	OutputPathType = TOutputPath

using	PathInformationType = SpeedFunctionPathInformation< PointType >

using	Pointer = SmartPointer< Self >

using	PointsContainerType = typename PathInformationType::PointsContainerType

using	PointType = typename Superclass::PointType

using	Self = SpeedFunctionToPathFilter

using	Superclass = ArrivalFunctionToPathFilter< TInputImage, TOutputPath >

Public Types inherited from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >
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
void	AddPathEndPoint (const PointType &) override

void	AddPathInformation (PathInformationType *info)

void	ClearPathEndPoints () override

void	ClearPathInformation ()

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

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

virtual InputImagePointer	GetCurrentArrivalFunction () const

virtual const char *	GetNameOfClass () const

void	SetPathEndPoint (const PointType &) override

Public Member Functions inherited from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >
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::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >
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 = TInputImage::ImageDimension

Static Public Attributes inherited from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >
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
InputImageType *	ComputeArrivalFunction () override

void	GenerateData (void) override

const PointsContainerType &	GetNextEndPoint () override

unsigned int	GetNumberOfPathsToExtract () const override

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

	SpeedFunctionToPathFilter ()

	~SpeedFunctionToPathFilter () override

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

void	GenerateInputRequestedRegion () 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
InputImagePointer	m_CurrentArrivalFunction

std::vector< typename PathInformationType::Pointer >	m_Information

Protected Attributes inherited from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >
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

Member Typedef Documentation

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::ConstPointer = SmartPointer<const Self>

Definition at line 76 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::ContinuousIndexType = typename Superclass::ContinuousIndexType

Some convenient type alias.

Definition at line 100 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::CostFunctionType = typename Superclass::CostFunctionType

Definition at line 103 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::IndexType = typename Superclass::IndexType

Definition at line 101 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 90 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 92 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::InputImagePointer = typename InputImageType::Pointer

Definition at line 89 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 91 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::InputImageType = TInputImage

Some image type alias.

Definition at line 88 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::OptimizerType = typename Superclass::OptimizerType

Definition at line 104 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::OutputPathConstPointer = typename OutputPathType::ConstPointer

Definition at line 97 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::OutputPathPointer = typename OutputPathType::Pointer

Definition at line 96 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::OutputPathType = TOutputPath

Some path type alias.

Definition at line 95 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::PathInformationType = SpeedFunctionPathInformation<PointType>

Path information type alias.

Definition at line 107 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::Pointer = SmartPointer<Self>

Definition at line 75 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::PointsContainerType = typename PathInformationType::PointsContainerType

Definition at line 108 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::PointType = typename Superclass::PointType

Definition at line 102 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::Self = SpeedFunctionToPathFilter

Standard class type alias.

Definition at line 73 of file itkSpeedFunctionToPathFilter.h.

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

using itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::Superclass = ArrivalFunctionToPathFilter<TInputImage,TOutputPath>

Definition at line 74 of file itkSpeedFunctionToPathFilter.h.

Constructor & Destructor Documentation

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

itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::SpeedFunctionToPathFilter ( )

protected

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

itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::~SpeedFunctionToPathFilter ( )

overrideprotected

Member Function Documentation

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

void itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::AddPathEndPoint ( const PointType & )

inlineoverridevirtual

Override superclass behaviour. Warning: AddPathEndPoint() is not valid for this filter. This method is provided by the superclass, however it is not used by this subclass. Use AddPathInfo() instead.

Reimplemented from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >.

Definition at line 123 of file itkSpeedFunctionToPathFilter.h.

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

void itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::AddPathInformation ( PathInformationType * info )

inline

Add a path information object to process. At least one PathInfo object must be added before processing.

Definition at line 139 of file itkSpeedFunctionToPathFilter.h.

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

void itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::ClearPathEndPoints ( )

inlineoverridevirtual

Override superclass behaviour. Warning: ClearPathEndPoints() is not valid for this filter. This method is provided by the superclass, however it is not used by this subclass. Use ClearPathInfo() instead.

Reimplemented from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >.

Definition at line 132 of file itkSpeedFunctionToPathFilter.h.

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

void itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::ClearPathInformation ( )

inline

Clear the list of path information objects.

Definition at line 145 of file itkSpeedFunctionToPathFilter.h.

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

InputImageType* itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::ComputeArrivalFunction ( )

overrideprotectedvirtual

Compute the arrival function from which to extract the path.

Reimplemented from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >.

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

virtual::itk::LightObject::Pointer itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >.

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

void itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::Execute	(	const itk::Object *	object,
		const itk::EventObject &	event
	)

overridevirtual

Handle optimizer iteration events.

Reimplemented from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >.

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

void itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::GenerateData ( void )

overrideprotectedvirtual

Implemention of algorithm.

Reimplemented from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >.

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

virtual InputImagePointer itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::GetCurrentArrivalFunction ( ) const

virtual

access the arrival image for debugging purposes

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

virtual const char* itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >.

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

const PointsContainerType& itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::GetNextEndPoint ( )

overrideprotectedvirtual

Override handling of optimizer iteration events to accomodate way points.

Reimplemented from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >.

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

unsigned int itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::GetNumberOfPathsToExtract ( ) const

overrideprotectedvirtual

Get the number of paths which the user has instructed to extracted.

Reimplemented from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >.

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

static Pointer itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::New ( )

static

Method for creation through the object factory.

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

void itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >.

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

void itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::SetPathEndPoint ( const PointType & )

inlineoverridevirtual

Override superclass behaviour. Warning: SetPathEndPoint() is not valid for this filter. This method is provided by the superclass, however it is not used by this subclass. Use AddPathInfo() instead.

Reimplemented from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >.

Definition at line 114 of file itkSpeedFunctionToPathFilter.h.

Member Data Documentation

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

constexpr unsigned int itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::InputImageDimension = TInputImage::ImageDimension

static

ImageDimension constants

Definition at line 85 of file itkSpeedFunctionToPathFilter.h.

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

InputImagePointer itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::m_CurrentArrivalFunction

protected

Definition at line 174 of file itkSpeedFunctionToPathFilter.h.

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

std::vector< typename PathInformationType::Pointer > itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::m_Information

protected

Definition at line 173 of file itkSpeedFunctionToPathFilter.h.

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

itkSpeedFunctionToPathFilter.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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