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

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

  1. A real-valued arrival function as the filter input
  2. 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 145 of file itkArrivalFunctionToPathFilter.h.

Public Types

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

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 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 ()
 
MultiThreader * 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)
 
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::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 = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToPathFilter< TInputImage, TOutputPath >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 

Protected Member Functions

 ArrivalFunctionToPathFilter ()
 
virtual InputImageTypeComputeArrivalFunction ()
 
void GenerateData (void)
 
void GenerateInputRequestedRegion ()
 
virtual const PointTypeGetNextEndPoint ()
 
virtual unsigned int GetNumberOfPathsToExtract () const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
 ~ArrivalFunctionToPathFilter ()
 
- Protected Member Functions inherited from itk::ImageToPathFilter< TInputImage, TOutputPath >
 ImageToPathFilter ()
 
virtual ~ImageToPathFilter ()
 
- Protected Member Functions inherited from itk::PathSource< TOutputPath >
 PathSource ()
 
virtual ~PathSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
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 ()
 
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 ()
 
- 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< 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
 

Private Member Functions

 ArrivalFunctionToPathFilter (const Self &)
 
void operator= (const Self &)
 

Member Typedef Documentation

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef ArrivalFunctionToPathCommand< Self > itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::CommandType

Definition at line 181 of file itkArrivalFunctionToPathFilter.h.

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

Definition at line 153 of file itkArrivalFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef ContinuousIndex< double, InputImageDimension > itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::ContinuousIndexType

Definition at line 179 of file itkArrivalFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef SingleImageCostFunction< InputImageType > itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::CostFunctionType

Definition at line 182 of file itkArrivalFunctionToPathFilter.h.

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

Definition at line 184 of file itkArrivalFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef Index< InputImageDimension > itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::IndexType

Some convenient typedefs.

Definition at line 178 of file itkArrivalFunctionToPathFilter.h.

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

Definition at line 164 of file itkArrivalFunctionToPathFilter.h.

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

Definition at line 166 of file itkArrivalFunctionToPathFilter.h.

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

Definition at line 163 of file itkArrivalFunctionToPathFilter.h.

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

Definition at line 165 of file itkArrivalFunctionToPathFilter.h.

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

Some image typedefs.

Definition at line 159 of file itkArrivalFunctionToPathFilter.h.

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

Definition at line 183 of file itkArrivalFunctionToPathFilter.h.

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

Definition at line 171 of file itkArrivalFunctionToPathFilter.h.

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

Definition at line 170 of file itkArrivalFunctionToPathFilter.h.

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

Some path typedefs.

Definition at line 169 of file itkArrivalFunctionToPathFilter.h.

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

Definition at line 152 of file itkArrivalFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
typedef Point< double, InputImageDimension > itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::PointType

Definition at line 180 of file itkArrivalFunctionToPathFilter.h.

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

Standard class typedefs.

Definition at line 150 of file itkArrivalFunctionToPathFilter.h.

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

Definition at line 151 of file itkArrivalFunctionToPathFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::ArrivalFunctionToPathFilter ( )
protected
template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::~ArrivalFunctionToPathFilter ( )
protected
template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::ArrivalFunctionToPathFilter ( const Self )
private

Member Function Documentation

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual void itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::AddPathEndPoint ( const PointType point)
virtual

Adds the given point to the list.

Reimplemented in itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual void itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::ClearPathEndPoints ( )
virtual

Clear the list of end points.

Reimplemented in itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual InputImageType* itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::ComputeArrivalFunction ( )
protectedvirtual

Compute the arrival function from which to extract the path. In this case it is simply the filter input.

Reimplemented in itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual::itk::LightObject::Pointer itk::ArrivalFunctionToPathFilter< 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::PathSource< TOutputPath >.

Reimplemented in itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual void itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::Execute ( const itk::Object object,
const itk::EventObject event 
)
virtual

Handle optimizer iteration events.

Reimplemented in itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
void itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::GenerateData ( void  )
protectedvirtual

Implemention of algorithm

Reimplemented from itk::ProcessObject.

Reimplemented in itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
void itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::GenerateInputRequestedRegion ( )
protectedvirtual

Override since the filter needs all the data for the algorithm

Reimplemented from itk::ProcessObject.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual const CostFunctionType* itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::GetCostFunction ( ) const
virtual

Get/set the cost function. The filter (not the user) is responsible for connecting the arrival function to the cost function.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual const char* itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

Reimplemented in itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual const PointType& itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::GetNextEndPoint ( )
protectedvirtual

Get the next end point from which to back propagate.

Reimplemented in itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual unsigned int itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::GetNumberOfPathsToExtract ( ) const
protectedvirtual

Get the arrival function from which to extract the path.

Reimplemented in itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual const OptimizerType* itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::GetOptimizer ( ) const
virtual

Get/set the Optimizer.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual OptimizerType::MeasureType itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::GetTerminationValue ( )
virtual

Get/set the termination. Once the current optimizer value falls below TerminationValue, no further points will be appended to the path. The default value is 0.0.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
static Pointer itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::New ( )
static

Method for creation through the object factory.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
void itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::operator= ( const Self )
private
template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual void itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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::ImageToPathFilter< TInputImage, TOutputPath >.

Reimplemented in itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual void itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::SetCostFunction ( CostFunctionType _arg)
virtual

Get/set the cost function. The filter (not the user) is responsible for connecting the arrival function to the cost function.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual void itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::SetOptimizer ( OptimizerType _arg)
virtual

Get/set the Optimizer.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual void itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::SetPathEndPoint ( const PointType point)
virtual

Clears the list of end points and adds the given point to the list.

Reimplemented in itk::SpeedFunctionToPathFilter< TInputImage, TOutputPath >.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
virtual void itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::SetTerminationValue ( typename OptimizerType::MeasureType  _arg)
virtual

Get/set the termination. Once the current optimizer value falls below TerminationValue, no further points will be appended to the path. The default value is 0.0.

Member Data Documentation

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

ImageDimension constants.

Definition at line 175 of file itkArrivalFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
CostFunctionType::Pointer itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::m_CostFunction
protected

Definition at line 237 of file itkArrivalFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
unsigned int itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::m_CurrentOutput
protected

Definition at line 241 of file itkArrivalFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
OptimizerType::Pointer itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::m_Optimizer
protected

Definition at line 238 of file itkArrivalFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
std::vector<PointType> itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::m_PointList
protected

Definition at line 240 of file itkArrivalFunctionToPathFilter.h.

template<class TInputImage , class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension>>
OptimizerType::MeasureType itk::ArrivalFunctionToPathFilter< TInputImage, TOutputPath >::m_TerminationValue
protected

Definition at line 239 of file itkArrivalFunctionToPathFilter.h.


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