ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
itk::ImageToPathFilter< TInputImage, TOutputPath > Class Template Reference

#include <itkImageToPathFilter.h>

+ Inheritance diagram for itk::ImageToPathFilter< TInputImage, TOutputPath >:
+ Collaboration diagram for itk::ImageToPathFilter< TInputImage, TOutputPath >:

Public Types

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

const InputImageTypeGetInput ()
 
const InputImageTypeGetInput (unsigned int idx)
 
virtual const char * GetNameOfClass () const
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
- Public Member Functions inherited from itk::PathSource< TOutputPath >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
OutputPathTypeGetOutput ()
 
OutputPathTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (OutputPathType *output)
 
virtual void GraftNthOutput (unsigned int idx, OutputPathType *output)
 
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 ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
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)
 
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 ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
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 Attributes

static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 

Protected Member Functions

 ImageToPathFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageToPathFilter () override=default
 
- Protected Member Functions inherited from itk::PathSource< TOutputPath >
 PathSource ()
 
 ~PathSource () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateData ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 

Additional Inherited Members

- 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 Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputImage, typename TOutputPath>
class itk::ImageToPathFilter< TInputImage, TOutputPath >

Base class for filters that take an image as input and produce an path as output.

ImageToPathFilter is the base class for all process objects that output path data and require image data as input. Specifically, this class defines the SetInput() method for defining the input to a filter.

This code was contributed in the Insight Journal paper: "ContourExtractor2DImageFilter: A subpixel-precision image isocontour extraction filter." by Pincus Z. https://hdl.handle.net/1926/165 http://www.insight-journal.org/browse/publication/72

Definition at line 44 of file itkImageToPathFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage, typename TOutputPath>
using itk::ImageToPathFilter< TInputImage, TOutputPath >::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkImageToPathFilter.h.

◆ InputImageConstPointer

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

Definition at line 61 of file itkImageToPathFilter.h.

◆ InputImagePixelType

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

Definition at line 63 of file itkImageToPathFilter.h.

◆ InputImagePointer

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

Definition at line 60 of file itkImageToPathFilter.h.

◆ InputImageRegionType

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

Definition at line 62 of file itkImageToPathFilter.h.

◆ InputImageType

template<typename TInputImage, typename TOutputPath>
using itk::ImageToPathFilter< TInputImage, TOutputPath >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 59 of file itkImageToPathFilter.h.

◆ Pointer

template<typename TInputImage, typename TOutputPath>
using itk::ImageToPathFilter< TInputImage, TOutputPath >::Pointer = SmartPointer<Self>

Definition at line 52 of file itkImageToPathFilter.h.

◆ Self

template<typename TInputImage, typename TOutputPath>
using itk::ImageToPathFilter< TInputImage, TOutputPath >::Self = ImageToPathFilter

Standard class type aliases.

Definition at line 50 of file itkImageToPathFilter.h.

◆ Superclass

template<typename TInputImage, typename TOutputPath>
using itk::ImageToPathFilter< TInputImage, TOutputPath >::Superclass = PathSource<TOutputPath>

Definition at line 51 of file itkImageToPathFilter.h.

Constructor & Destructor Documentation

◆ ImageToPathFilter()

template<typename TInputImage, typename TOutputPath>
itk::ImageToPathFilter< TInputImage, TOutputPath >::ImageToPathFilter ( )
protected

◆ ~ImageToPathFilter()

template<typename TInputImage, typename TOutputPath>
itk::ImageToPathFilter< TInputImage, TOutputPath >::~ImageToPathFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ GetInput() [1/2]

template<typename TInputImage, typename TOutputPath>
const InputImageType* itk::ImageToPathFilter< TInputImage, TOutputPath >::GetInput ( )

◆ GetInput() [2/2]

template<typename TInputImage, typename TOutputPath>
const InputImageType* itk::ImageToPathFilter< TInputImage, TOutputPath >::GetInput ( unsigned int  idx)

◆ GetNameOfClass()

template<typename TInputImage, typename TOutputPath>
virtual const char* itk::ImageToPathFilter< TInputImage, TOutputPath >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::PathSource< TOutputPath >.

Reimplemented in itk::ContourExtractor2DImageFilter< TInputImage >.

◆ PrintSelf()

template<typename TInputImage, typename TOutputPath>
void itk::ImageToPathFilter< TInputImage, TOutputPath >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

STL map to store the named inputs and outputs

Reimplemented from itk::ProcessObject.

◆ SetInput() [1/2]

template<typename TInputImage, typename TOutputPath>
virtual void itk::ImageToPathFilter< TInputImage, TOutputPath >::SetInput ( const InputImageType image)
virtual

◆ SetInput() [2/2]

template<typename TInputImage, typename TOutputPath>
virtual void itk::ImageToPathFilter< TInputImage, TOutputPath >::SetInput ( unsigned int  ,
const TInputImage *  image 
)
virtual

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage, typename TOutputPath>
constexpr unsigned int itk::ImageToPathFilter< TInputImage, TOutputPath >::InputImageDimension = TInputImage::ImageDimension
staticconstexpr

ImageDimension constants

Definition at line 66 of file itkImageToPathFilter.h.


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