ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions
itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath > Class Template Reference

#include <itkPathAndImageToPathFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef
InputImageType::ConstPointer 
InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
typedef InputPathType::ConstPointer InputPathConstPointer
typedef InputPathType::IndexType InputPathIndexType
typedef InputPathType::InputType InputPathInputType
typedef InputPathType::OffsetType InputPathOffsetType
typedef InputPathType::OutputType InputPathOutputType
typedef InputPathType::Pointer InputPathPointer
typedef TInputPath InputPathType
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 PathAndImageToPathFilter Self
typedef PathToPathFilter
< TInputPath, TOutputPath > 
Superclass
- Public Types inherited from itk::PathToPathFilter< TInputPath, TOutputPath >
- Public Types inherited from itk::PathSource< TOutputPath >
typedef DataObject::Pointer DataObjectPointer
typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
- Public Types inherited from itk::ProcessObject
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
const InputImageTypeGetImageInput (void)
virtual const char * GetNameOfClass () const
const InputPathTypeGetPathInput (void)
virtual void SetImageInput (const TInputImage *image)
virtual void SetPathInput (const TInputPath *path)
- Public Member Functions inherited from itk::PathToPathFilter< TInputPath, TOutputPath >
const InputPathTypeGetInput (void)
const InputPathTypeGetInput (unsigned int idx)
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 (void)
virtual void GraftOutput (OutputPathType *output)
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
virtual const bool & GetAbortGenerateData ()
NameArray GetInputNames () const
MultiThreader * GetMultiThreader () const
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
DataObjectPointerArraySizeType GetNumberOfOutputs () const
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
NameArray GetOutputNames () const
virtual const float & GetProgress ()
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 SetProgress (float _arg)
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
virtual void UpdateOutputData (DataObject *output)
virtual void UpdateOutputInformation ()
void UpdateProgress (float amount)
DataObjectPointerArray GetInputs ()
DataObjectPointerArray GetOutputs ()
DataObjectPointerArray GetIndexedInputs ()
DataObjectPointerArray GetIndexedOutputs ()
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
virtual void SetReleaseDataFlag (bool flag)
virtual bool GetReleaseDataFlag () const
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
virtual void ReleaseDataBeforeUpdateFlagOn ()
virtual void ReleaseDataBeforeUpdateFlagOff ()
virtual void SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdTypeGetNumberOfThreads ()
- 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 (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long 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
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () 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 Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension

Protected Member Functions

virtual void GenerateInputRequestedRegion ()
 PathAndImageToPathFilter ()
virtual void PrintSelf (std::ostream &os, Indent indent) const
virtual ~PathAndImageToPathFilter ()
- Protected Member Functions inherited from itk::PathToPathFilter< TInputPath, TOutputPath >
 PathToPathFilter ()
 ~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 &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateData ()
virtual void GenerateOutputInformation ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) const
 ProcessObject ()
virtual void PropagateResetPipeline ()
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 (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () const
virtual void PushBackInput (const DataObject *input)
virtual void PopBackInput ()
virtual void PushFrontInput (const DataObject *input)
virtual void PopFrontInput ()
- 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 &)
 PathAndImageToPathFilter (const Self &)

Detailed Description

template<class TInputPath, class TInputImage, class TOutputPath>
class itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >

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

This class is the base class for filters that take both a path and an image as input and produce a path as output. Specifically, this class defines the methods SetPathInput() and SetImageInput(). (It also establishes the precedent of having path inputs precede image inputs for functions producing paths as outputs, according to the underlying DataObject implementation.)

Definition at line 38 of file itkPathAndImageToPathFilter.h.


Member Typedef Documentation

template<class TInputPath, class TInputImage, class TOutputPath>
typedef SmartPointer< const Self > itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::ConstPointer
template<class TInputPath, class TInputImage, class TOutputPath>
typedef InputImageType::PixelType itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::InputImagePixelType

Definition at line 65 of file itkPathAndImageToPathFilter.h.

template<class TInputPath, class TInputImage, class TOutputPath>
typedef InputImageType::ConstPointer itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::InputImagePointer

Definition at line 63 of file itkPathAndImageToPathFilter.h.

template<class TInputPath, class TInputImage, class TOutputPath>
typedef InputImageType::RegionType itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::InputImageRegionType

Definition at line 64 of file itkPathAndImageToPathFilter.h.

template<class TInputPath, class TInputImage, class TOutputPath>
typedef TInputImage itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::InputImageType

Definition at line 62 of file itkPathAndImageToPathFilter.h.

template<class TInputPath, class TInputImage, class TOutputPath>
typedef InputPathType::ConstPointer itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::InputPathConstPointer
template<class TInputPath, class TInputImage, class TOutputPath>
typedef InputPathType::IndexType itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::InputPathIndexType

Definition at line 60 of file itkPathAndImageToPathFilter.h.

template<class TInputPath, class TInputImage, class TOutputPath>
typedef InputPathType::InputType itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::InputPathInputType
template<class TInputPath, class TInputImage, class TOutputPath>
typedef InputPathType::OffsetType itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::InputPathOffsetType

Definition at line 61 of file itkPathAndImageToPathFilter.h.

template<class TInputPath, class TInputImage, class TOutputPath>
typedef InputPathType::OutputType itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::InputPathOutputType

Definition at line 59 of file itkPathAndImageToPathFilter.h.

template<class TInputPath, class TInputImage, class TOutputPath>
typedef InputPathType::Pointer itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::InputPathPointer
template<class TInputPath, class TInputImage, class TOutputPath>
typedef TInputPath itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::InputPathType
template<class TInputPath, class TInputImage, class TOutputPath>
typedef OutputPathType::IndexType itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::OutputPathIndexType

Reimplemented from itk::PathSource< TOutputPath >.

Definition at line 70 of file itkPathAndImageToPathFilter.h.

template<class TInputPath, class TInputImage, class TOutputPath>
typedef OutputPathType::InputType itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::OutputPathInputType
template<class TInputPath, class TInputImage, class TOutputPath>
typedef OutputPathType::OffsetType itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::OutputPathOffsetType

Reimplemented from itk::PathSource< TOutputPath >.

Definition at line 71 of file itkPathAndImageToPathFilter.h.

template<class TInputPath, class TInputImage, class TOutputPath>
typedef OutputPathType::OutputType itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::OutputPathOutputType

Reimplemented from itk::PathSource< TOutputPath >.

Definition at line 69 of file itkPathAndImageToPathFilter.h.

template<class TInputPath, class TInputImage, class TOutputPath>
typedef OutputPathType::Pointer itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::OutputPathPointer
template<class TInputPath, class TInputImage, class TOutputPath>
typedef TOutputPath itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::OutputPathType

Some convenient typedefs.

Reimplemented from itk::PathSource< TOutputPath >.

Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >.

Definition at line 66 of file itkPathAndImageToPathFilter.h.

template<class TInputPath, class TInputImage, class TOutputPath>
typedef SmartPointer< Self > itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::Pointer
template<class TInputPath, class TInputImage, class TOutputPath>
typedef PathAndImageToPathFilter itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::Self
template<class TInputPath, class TInputImage, class TOutputPath>
typedef PathToPathFilter< TInputPath, TOutputPath > itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::Superclass

Constructor & Destructor Documentation

template<class TInputPath, class TInputImage, class TOutputPath>
itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::PathAndImageToPathFilter ( )
protected
template<class TInputPath, class TInputImage, class TOutputPath>
virtual itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::~PathAndImageToPathFilter ( )
inlineprotectedvirtual

Definition at line 89 of file itkPathAndImageToPathFilter.h.

template<class TInputPath, class TInputImage, class TOutputPath>
itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::PathAndImageToPathFilter ( const Self )
private

Member Function Documentation

template<class TInputPath, class TInputImage, class TOutputPath>
virtual::itk::LightObject::Pointer itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::CreateAnother ( void  ) 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::PathToPathFilter< TInputPath, TOutputPath >.

Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >.

template<class TInputPath, class TInputImage, class TOutputPath>
virtual void itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::GenerateInputRequestedRegion ( )
protectedvirtual

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::PathToPathFilter< TInputPath, TOutputPath >.

template<class TInputPath, class TInputImage, class TOutputPath>
const InputImageType* itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::GetImageInput ( void  )
template<class TInputPath, class TInputImage, class TOutputPath>
virtual const char* itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::PathToPathFilter< TInputPath, TOutputPath >.

Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >.

template<class TInputPath, class TInputImage, class TOutputPath>
const InputPathType* itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::GetPathInput ( void  )
template<class TInputPath, class TInputImage, class TOutputPath>
static Pointer itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::New ( )
static

Method for creation through the object factory.

Reimplemented from itk::PathToPathFilter< TInputPath, TOutputPath >.

Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >.

template<class TInputPath, class TInputImage, class TOutputPath>
void itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::operator= ( const Self )
private

Time when GenerateOutputInformation was last called.

Reimplemented from itk::PathToPathFilter< TInputPath, TOutputPath >.

Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >.

template<class TInputPath, class TInputImage, class TOutputPath>
virtual void itk::PathAndImageToPathFilter< TInputPath, 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::PathToPathFilter< TInputPath, TOutputPath >.

Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >.

template<class TInputPath, class TInputImage, class TOutputPath>
virtual void itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::SetImageInput ( const TInputImage *  image)
virtual

Set/Get the image input of this process object.

template<class TInputPath, class TInputImage, class TOutputPath>
virtual void itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::SetPathInput ( const TInputPath *  path)
virtual

Set/Get the path input of this process object.


Member Data Documentation

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

ImageDimension constants

Definition at line 75 of file itkPathAndImageToPathFilter.h.


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