itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage > Class Template Reference

Implements image masking operation constrained by a polyline. The operation is applied on on each 2D image. More...

#include <itkPolylineMask2DImageFilter.h>

Inheritance diagram for itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >:

[legend]Collaboration diagram for itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >:

[legend]List of all members.

Public Types
typedef PolylineMask2DImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef InputImageType::ConstPointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef InputImageType::PixelType	InputImagePixelType
typedef TPolyline	PolylineType
typedef TOutputImage	OutputImageType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef OutputImageType::PixelType	OutputImagePixelType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (NDimensions, unsigned int, TInputImage::ImageDimension)
void	GenerateData (void)
void	SetInput1 (const InputImageType *image)
void	SetInput2 (const PolylineType *polyline)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	PolylineMask2DImageFilter ()
virtual	~PolylineMask2DImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TInputImage, class TPolyline, class TOutputImage>
class itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >

Implements image masking operation constrained by a polyline. The operation is applied on on each 2D image.

This class is parameterized over the types of the input image, polyline, and output image.

Definition at line 37 of file itkPolylineMask2DImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TPolyline, class TOutputImage> typedef SmartPointer<const Self> itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 44 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage, class TPolyline, class TOutputImage> typedef InputImageType::PixelType itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::InputImagePixelType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 60 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage, class TPolyline, class TOutputImage> typedef InputImageType::ConstPointer itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::InputImagePointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 58 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage, class TPolyline, class TOutputImage> typedef InputImageType::RegionType itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::InputImageRegionType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 59 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage, class TPolyline, class TOutputImage> typedef TInputImage itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::InputImageType

Some convenient typedefs for input image Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 57 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage, class TPolyline, class TOutputImage> typedef OutputImageType::PixelType itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::OutputImagePixelType

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 69 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage, class TPolyline, class TOutputImage> typedef OutputImageType::Pointer itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 67 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage, class TPolyline, class TOutputImage> typedef OutputImageType::RegionType itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::OutputImageRegionType

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 68 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage, class TPolyline, class TOutputImage> typedef TOutputImage itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::OutputImageType

Some convenient typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 66 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage, class TPolyline, class TOutputImage> typedef SmartPointer<Self> itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 43 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage, class TPolyline, class TOutputImage> typedef TPolyline itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::PolylineType

Definition at line 63 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage, class TPolyline, class TOutputImage> typedef PolylineMask2DImageFilter itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 41 of file itkPolylineMask2DImageFilter.h. Referenced by itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::~PolylineMask2DImageFilter().

template<class TInputImage, class TPolyline, class TOutputImage> typedef ImageToImageFilter<TInputImage,TOutputImage> itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 42 of file itkPolylineMask2DImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TPolyline, class TOutputImage> itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::PolylineMask2DImageFilter (   )  [protected]

template<class TInputImage, class TPolyline, class TOutputImage> virtual itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::~PolylineMask2DImageFilter (   )  [inline, protected, virtual]

Definition at line 82 of file itkPolylineMask2DImageFilter.h. References itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::Self.

---

Member Function Documentation

template<class TInputImage, class TPolyline, class TOutputImage> void itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::GenerateData (  void   )  [virtual]

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead. See also: ThreadedGenerateData() Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TPolyline, class TOutputImage> virtual const char* itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TPolyline, class TOutputImage> itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::itkStaticConstMacro (  NDimensions  , unsigned  int, TInputImage::ImageDimension  )

Number of dimensions.

template<class TInputImage, class TPolyline, class TOutputImage> Pointer itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TInputImage, class TPolyline, class TOutputImage> void itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::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::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TPolyline, class TOutputImage> void itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::SetInput1 (  const InputImageType *  image  )

Read in image and polyline inputs

template<class TInputImage, class TPolyline, class TOutputImage> void itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::SetInput2 (  const PolylineType *  polyline  )

Read in image and polyline inputs

---

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

• itkPolylineMask2DImageFilter.h

---