ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath > Class Template Reference

#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:

  1. A real-valued speed function as the filter input
  2. 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

typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef
Superclass::CostFunctionType 
CostFunctionType
 
typedef Superclass::IndexType IndexType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef Superclass::OptimizerType OptimizerType
 
typedef
OutputPathType::ConstPointer 
OutputPathConstPointer
 
typedef OutputPathType::Pointer OutputPathPointer
 
typedef TOutputPath OutputPathType
 
typedef
SpeedFunctionPathInformation
< PointType
PathInformationType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef SpeedFunctionToPathFilter Self
 
typedef
ArrivalFunctionToPathFilter
< TInputImage, TOutputPath > 
Superclass
 
- Public Types inherited from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >
typedef
ArrivalFunctionToPathCommand
< Self
CommandType
 
typedef SmartPointer< const SelfConstPointer
 
typedef ContinuousIndex
< double, InputImageDimension
ContinuousIndexType
 
typedef
SingleImageCostFunction
< InputImageType
CostFunctionType
 
typedef
RegularStepGradientDescentOptimizer 
DefaultOptimizerType
 
typedef Index
< InputImageDimension
IndexType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
SingleValuedNonLinearOptimizer 
OptimizerType
 
typedef
OutputPathType::ConstPointer 
OutputPathConstPointer
 
typedef OutputPathType::Pointer OutputPathPointer
 
typedef TOutputPath OutputPathType
 
typedef SmartPointer< SelfPointer
 
typedef Point< double,
InputImageDimension
PointType
 
typedef ArrivalFunctionToPathFilter Self
 
typedef ImageToPathFilter
< TInputImage, TOutputPath > 
Superclass
 
- Public Types inherited from itk::ImageToPathFilter< TInputImage, TOutputPath >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToPathFilter Self
 
typedef PathSource< TOutputPath > Superclass
 
- Public Types inherited from itk::PathSource< TOutputPath >
typedef SmartPointer< const SelfConstPointer
 
typedef DataObject::Pointer DataObjectPointer
 
typedef OutputPathType::IndexType OutputPathIndexType
 
typedef OutputPathType::InputType OutputPathInputType
 
typedef OutputPathType::OffsetType OutputPathOffsetType
 
typedef OutputPathType::OutputType OutputPathOutputType
 
typedef OutputPathType::Pointer OutputPathPointer
 
typedef TOutputPath OutputPathType
 
typedef SmartPointer< SelfPointer
 
typedef PathSource Self
 
typedef ProcessObject Superclass
 
typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef MultiThreader MultiThreaderType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

void AddPathEndPoint (const PointType &) override
 
void AddPathInformation (PathInformationType *info)
 
void ClearPathEndPoints () override
 
void ClearPathInformation ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void Execute (const itk::Object *object, const itk::EventObject &event) override
 
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 OptimizerTypeGetOptimizer () const
 
virtual void SetCostFunction (CostFunctionType *_arg)
 
virtual const CostFunctionTypeGetCostFunction () const
 
virtual void SetTerminationValue (typename OptimizerType::MeasureType _arg)
 
virtual OptimizerType::MeasureType GetTerminationValue ()
 
- Public Member Functions inherited from itk::ImageToPathFilter< TInputImage, TOutputPath >
const InputImageTypeGetInput ()
 
const InputImageTypeGetInput (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 >
OutputPathTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, OutputPathType *output)
 
OutputPathTypeGetOutput ()
 
virtual void GraftOutput (OutputPathType *output)
 
virtual 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 ()
 
MultiThreaderTypeGetMultiThreader () 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)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (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 SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 const unsigned int InputImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >
static const unsigned int InputImageDimension = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToPathFilter< TInputImage, TOutputPath >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 

Protected Member Functions

virtual InputImageTypeComputeArrivalFunction () override
 
void GenerateData (void) override
 
virtual const PointTypeGetNextEndPoint () override
 
virtual unsigned int GetNumberOfPathsToExtract () const override
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 SpeedFunctionToPathFilter ()
 
 ~SpeedFunctionToPathFilter ()
 
- Protected Member Functions inherited from itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >
 ArrivalFunctionToPathFilter ()
 
void GenerateInputRequestedRegion () override
 
 ~ArrivalFunctionToPathFilter ()
 
- Protected Member Functions inherited from itk::ImageToPathFilter< TInputImage, TOutputPath >
 ImageToPathFilter ()
 
virtual ~ImageToPathFilter ()
 
- Protected Member Functions inherited from itk::PathSource< TOutputPath >
 PathSource ()
 
virtual ~PathSource () override
 
- 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)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (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
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
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 ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~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< PointTypem_PointList
 
OptimizerType::MeasureType m_TerminationValue
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef SmartPointer<const Self> itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::ConstPointer

Definition at line 74 of file itkSpeedFunctionToPathFilter.h.

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

Some convenient typedefs.

Definition at line 99 of file itkSpeedFunctionToPathFilter.h.

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

Definition at line 102 of file itkSpeedFunctionToPathFilter.h.

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

Definition at line 100 of file itkSpeedFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef InputImageType::ConstPointer itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::InputImageConstPointer

Definition at line 89 of file itkSpeedFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef InputImageType::PixelType itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::InputImagePixelType

Definition at line 91 of file itkSpeedFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef InputImageType::Pointer itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::InputImagePointer

Definition at line 88 of file itkSpeedFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef InputImageType::RegionType itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::InputImageRegionType

Definition at line 90 of file itkSpeedFunctionToPathFilter.h.

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

Some image typedefs.

Definition at line 87 of file itkSpeedFunctionToPathFilter.h.

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

Definition at line 103 of file itkSpeedFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef OutputPathType::ConstPointer itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::OutputPathConstPointer

Definition at line 96 of file itkSpeedFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef OutputPathType::Pointer itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::OutputPathPointer

Definition at line 95 of file itkSpeedFunctionToPathFilter.h.

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

Some path typedefs.

Definition at line 94 of file itkSpeedFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef SpeedFunctionPathInformation<PointType> itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::PathInformationType

Path information typedef.

Definition at line 106 of file itkSpeedFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef SmartPointer<Self> itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::Pointer

Definition at line 73 of file itkSpeedFunctionToPathFilter.h.

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

Definition at line 101 of file itkSpeedFunctionToPathFilter.h.

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

Standard class typedefs.

Definition at line 71 of file itkSpeedFunctionToPathFilter.h.

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

Definition at line 72 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 ( )
protected

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 121 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 137 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 130 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 143 of file itkSpeedFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual 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>>
virtual 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 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>>
virtual const PointType& 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>>
virtual 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>>
virtual 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 112 of file itkSpeedFunctionToPathFilter.h.

Member Data Documentation

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
const unsigned int itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >::InputImageDimension = TInputImage::ImageDimension
static

ImageDimension constants

Definition at line 84 of file itkSpeedFunctionToPathFilter.h.

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

Definition at line 169 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 168 of file itkSpeedFunctionToPathFilter.h.


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