ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::PathToPathFilter< TInputPath, TOutputPath > Class Template Reference

#include <itkPathToPathFilter.h>

+ Inheritance diagram for itk::PathToPathFilter< TInputPath, TOutputPath >:
+ Collaboration diagram for itk::PathToPathFilter< TInputPath, TOutputPath >:

Detailed Description

template<typename TInputPath, typename TOutputPath>
class itk::PathToPathFilter< TInputPath, TOutputPath >

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

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

Definition at line 37 of file itkPathToPathFilter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef InputPathType::ConstPointer InputPathConstPointer
 
typedef InputPathType::Pointer InputPathPointer
 
typedef TInputPath InputPathType
 
typedef SmartPointer< SelfPointer
 
typedef PathToPathFilter 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 ::itk::LightObject::Pointer CreateAnother () const
 
const InputPathTypeGetInput ()
 
const InputPathTypeGetInput (unsigned int idx)
 
virtual const char * GetNameOfClass () const
 
virtual void SetInput (const InputPathType *path)
 
virtual void SetInput (unsigned int, const TInputPath *path)
 
- 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 ()
 

Protected Member Functions

virtual void GenerateInputRequestedRegion () override
 
 PathToPathFilter ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~PathToPathFilter ()
 
- 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 GenerateData ()
 
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 ()
 

Private Member Functions

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

Additional Inherited Members

- 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<typename TInputPath, typename TOutputPath>
typedef SmartPointer< const Self > itk::PathToPathFilter< TInputPath, TOutputPath >::ConstPointer

Definition at line 44 of file itkPathToPathFilter.h.

template<typename TInputPath, typename TOutputPath>
typedef InputPathType::ConstPointer itk::PathToPathFilter< TInputPath, TOutputPath >::InputPathConstPointer

Definition at line 55 of file itkPathToPathFilter.h.

template<typename TInputPath, typename TOutputPath>
typedef InputPathType::Pointer itk::PathToPathFilter< TInputPath, TOutputPath >::InputPathPointer

Definition at line 54 of file itkPathToPathFilter.h.

template<typename TInputPath, typename TOutputPath>
typedef TInputPath itk::PathToPathFilter< TInputPath, TOutputPath >::InputPathType

Some convenient typedefs.

Definition at line 50 of file itkPathToPathFilter.h.

template<typename TInputPath, typename TOutputPath>
typedef SmartPointer< Self > itk::PathToPathFilter< TInputPath, TOutputPath >::Pointer

Definition at line 43 of file itkPathToPathFilter.h.

template<typename TInputPath, typename TOutputPath>
typedef PathToPathFilter itk::PathToPathFilter< TInputPath, TOutputPath >::Self

Standard class typedefs.

Definition at line 41 of file itkPathToPathFilter.h.

template<typename TInputPath, typename TOutputPath>
typedef PathSource< TOutputPath > itk::PathToPathFilter< TInputPath, TOutputPath >::Superclass

Definition at line 42 of file itkPathToPathFilter.h.

Constructor & Destructor Documentation

template<typename TInputPath, typename TOutputPath>
itk::PathToPathFilter< TInputPath, TOutputPath >::PathToPathFilter ( )
protected
template<typename TInputPath, typename TOutputPath>
itk::PathToPathFilter< TInputPath, TOutputPath >::~PathToPathFilter ( )
inlineprotected

Definition at line 69 of file itkPathToPathFilter.h.

template<typename TInputPath, typename TOutputPath>
itk::PathToPathFilter< TInputPath, TOutputPath >::PathToPathFilter ( const Self )
private

Member Function Documentation

template<typename TInputPath, typename TOutputPath>
virtual::itk::LightObject::Pointer itk::PathToPathFilter< TInputPath, 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 >.

template<typename TInputPath, typename TOutputPath>
virtual void itk::PathToPathFilter< TInputPath, TOutputPath >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? Up till and including now, the base assumption is that the largest possible region will be requested of the input. If this method is overridden, the new method should call its superclass' implementation as its first step.

See Also
ProcessObject::GenerateInputRequestedRegion()

Reimplemented from itk::ProcessObject.

Reimplemented in itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >, and itk::PathAndImageToPathFilter< TFourierSeriesPath, TSwathMeritImage, OrthogonallyCorrected2DParametricPath >.

template<typename TInputPath, typename TOutputPath>
const InputPathType* itk::PathToPathFilter< TInputPath, TOutputPath >::GetInput ( )
template<typename TInputPath, typename TOutputPath>
const InputPathType* itk::PathToPathFilter< TInputPath, TOutputPath >::GetInput ( unsigned int  idx)
template<typename TInputPath, typename TOutputPath>
virtual const char* itk::PathToPathFilter< TInputPath, TOutputPath >::GetNameOfClass ( ) const
virtual
template<typename TInputPath, typename TOutputPath>
static Pointer itk::PathToPathFilter< TInputPath, TOutputPath >::New ( )
static

Method for creation through the object factory.

template<typename TInputPath, typename TOutputPath>
void itk::PathToPathFilter< TInputPath, TOutputPath >::operator= ( const Self )
private
template<typename TInputPath, typename TOutputPath>
virtual void itk::PathToPathFilter< TInputPath, TOutputPath >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual
template<typename TInputPath, typename TOutputPath>
virtual void itk::PathToPathFilter< TInputPath, TOutputPath >::SetInput ( const InputPathType path)
virtual
template<typename TInputPath, typename TOutputPath>
virtual void itk::PathToPathFilter< TInputPath, TOutputPath >::SetInput ( unsigned  int,
const TInputPath *  path 
)
virtual

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