itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath > Class Template Reference

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

#include <itkPathAndImageToPathFilter.h>

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

[legend]Collaboration diagram for itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >:

[legend]List of all members.

Public Types
typedef PathAndImageToPathFilter	Self
typedef PathToPathFilter< TInputPath, TOutputPath >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputPath	InputPathType
typedef InputPathType::Pointer	InputPathPointer
typedef InputPathType::ConstPointer	InputPathConstPointer
typedef InputPathType::InputType	InputPathInputType
typedef InputPathType::OutputType	InputPathOutputType
typedef InputPathType::IndexType	InputPathIndexType
typedef InputPathType::OffsetType	InputPathOffsetType
typedef TInputImage	InputImageType
typedef InputImageType::ConstPointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef InputImageType::PixelType	InputImagePixelType
typedef TOutputPath	OutputPathType
typedef OutputPathType::Pointer	OutputPathPointer
typedef OutputPathType::InputType	OutputPathInputType
typedef OutputPathType::OutputType	OutputPathOutputType
typedef OutputPathType::IndexType	OutputPathIndexType
typedef OutputPathType::OffsetType	OutputPathOffsetType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
virtual void	SetPathInput (const TInputPath *path)
const InputPathType *	GetPathInput (void)
virtual void	SetImageInput (const TInputImage *image)
const InputImageType *	GetImageInput (void)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	PathAndImageToPathFilter ()
virtual	~PathAndImageToPathFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	GenerateInputRequestedRegion ()

---

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 preceed image inputs for functions producing paths as outputs, according to the underlying DataObject implementation.)

Definition at line 37 of file itkPathAndImageToPathFilter.h.

---

Member Typedef Documentation

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

Reimplemented from itk::PathToPathFilter< TInputPath, TOutputPath >. Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >. Definition at line 45 of file itkPathAndImageToPathFilter.h.

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

Definition at line 64 of file itkPathAndImageToPathFilter.h.

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

Definition at line 62 of file itkPathAndImageToPathFilter.h.

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

Definition at line 63 of file itkPathAndImageToPathFilter.h.

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

Definition at line 61 of file itkPathAndImageToPathFilter.h.

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

Reimplemented from itk::PathToPathFilter< TInputPath, TOutputPath >. Definition at line 56 of file itkPathAndImageToPathFilter.h.

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

Definition at line 59 of file itkPathAndImageToPathFilter.h.

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

Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >. Definition at line 57 of file itkPathAndImageToPathFilter.h.

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

Definition at line 60 of file itkPathAndImageToPathFilter.h.

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

Definition at line 58 of file itkPathAndImageToPathFilter.h.

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

Reimplemented from itk::PathToPathFilter< TInputPath, TOutputPath >. Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >. Definition at line 55 of file itkPathAndImageToPathFilter.h.

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

Some convenient typedefs. Reimplemented from itk::PathToPathFilter< TInputPath, TOutputPath >. Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >. Definition at line 54 of file itkPathAndImageToPathFilter.h.

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

Reimplemented from itk::PathSource< TOutputPath >. Definition at line 69 of file itkPathAndImageToPathFilter.h.

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

Reimplemented from itk::PathSource< TOutputPath >. Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >. Definition at line 67 of file itkPathAndImageToPathFilter.h.

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

Reimplemented from itk::PathSource< TOutputPath >. Definition at line 70 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 68 of file itkPathAndImageToPathFilter.h.

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

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 TOutputPath itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::OutputPathType

Some convenient typedefs. Reimplemented from itk::PathSource< TOutputPath >. Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >. Definition at line 65 of file itkPathAndImageToPathFilter.h.

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

Reimplemented from itk::PathToPathFilter< TInputPath, TOutputPath >. Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >. Definition at line 44 of file itkPathAndImageToPathFilter.h.

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

Standard class typedefs. Reimplemented from itk::PathToPathFilter< TInputPath, TOutputPath >. Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >. Definition at line 42 of file itkPathAndImageToPathFilter.h.

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

Reimplemented from itk::PathToPathFilter< TInputPath, TOutputPath >. Reimplemented in itk::OrthogonalSwath2DPathFilter< TFourierSeriesPath, TSwathMeritImage >. Definition at line 43 of file itkPathAndImageToPathFilter.h.

---

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 (   )  [inline, protected, virtual]

Definition at line 88 of file itkPathAndImageToPathFilter.h.

---

Member Function Documentation

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

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   )

Set/Get the image input of this process object.

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   )

Set/Get the path input of this process object.

template<class TInputPath, class TInputImage, class TOutputPath> itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::itkStaticConstMacro (  InputImageDimension  , unsigned  int, TInputImage::ImageDimension  )

ImageDimension constants

template<class TInputPath, class TInputImage, class TOutputPath> 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> virtual void itk::PathAndImageToPathFilter< TInputPath, TInputImage, TOutputPath >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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.

---

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

• itkPathAndImageToPathFilter.h

---