ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions
itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage > Class Template Reference

Implements 2D image masking operation constrained by a contour. More...

#include <itkPolylineMask2DImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef TPolyline PolylineType
typedef PolylineMask2DImageFilter Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
void GenerateData (void)
virtual const char * GetNameOfClass () const
void SetInput1 (const InputImageType *image)
void SetInput2 (const PolylineType *polyline)
 typedef (Concept::Convertible< InputImagePixelType, OutputImagePixelType >) InputConvertibleToOutputCheck
 typedef (Concept::EqualityComparable< OutputImagePixelType >) OutputEqualityComparableCheck
 typedef (Concept::Convertible< int, OutputImagePixelType >) IntConvertibleOutputCheck
 typedef (Concept::SameDimension< NDimensions, NOutputDimensions >) SameDimensionCheck

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int NDimensions = TInputImage::ImageDimension
static const unsigned int NOutputDimensions = TOutputImage::ImageDimension
 PolylineMask2DImageFilter ()
virtual ~PolylineMask2DImageFilter ()
 PolylineMask2DImageFilter (const Self &)
void operator= (const Self &)

Detailed Description

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

Implements 2D image masking operation constrained by a contour.

This class is parameterized over input image type, contour defined by a polyline, and output image type. If the input image is three dimensional, the masking operation is performed on each slice (2D image). The output image will have two regions demarcated by the contour i.e inside(masked) and outside region. The pixels in the masked region will keep their original intensity values. Whereas, intensity value of pixels outside the masked region will be set to zero.

Warning:
The Polygon represented by the input Polyline must be a convex polygon.
The Polygon's inside is defined by the standard clock-wise convention. That is, when walking along the polygon, the inside of the polygon is at the right-hand side. Note also that this must be interpreted in the natural coordinate system used by ITK, not the one used in computer graphics.
See also:
PolylineMaskImageFilter

Definition at line 49 of file itkPolylineMask2DImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TPolyline , class TOutputImage >
typedef SmartPointer< const Self > itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::ConstPointer
template<class TInputImage , class TPolyline , class TOutputImage >
typedef InputImageType::ConstPointer itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::InputImageConstPointer
template<class TInputImage , class TPolyline , class TOutputImage >
typedef InputImageType::PixelType itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::InputImagePixelType
template<class TInputImage , class TPolyline , class TOutputImage >
typedef InputImageType::Pointer itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::InputImagePointer
template<class TInputImage , class TPolyline , class TOutputImage >
typedef InputImageType::RegionType itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::InputImageRegionType
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 72 of file itkPolylineMask2DImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 83 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 84 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 82 of file itkPolylineMask2DImageFilter.h.

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

Definition at line 79 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 53 of file itkPolylineMask2DImageFilter.h.

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

Constructor & Destructor Documentation

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

End concept checking

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

End concept checking

Definition at line 110 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage , class TPolyline , class TOutputImage >
itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::PolylineMask2DImageFilter ( const Self ) [private]

End concept checking


Member Function Documentation

template<class TInputImage , class TPolyline , class TOutputImage >
virtual::itk::LightObject::Pointer itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::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::Object.

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 >
static 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 >::operator= ( const Self ) [private]

End concept checking

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)
template<class TInputImage , class TPolyline , class TOutputImage >
itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::typedef ( Concept::EqualityComparable< OutputImagePixelType )

This class requires OutputEqualityComparableCheck in the form of ( Concept::EqualityComparable< OutputImagePixelType > )

template<class TInputImage , class TPolyline , class TOutputImage >
itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::typedef ( Concept::Convertible< int, OutputImagePixelType )

This class requires IntConvertibleOutputCheck in the form of ( Concept::Convertible< int, OutputImagePixelType > )

template<class TInputImage , class TPolyline , class TOutputImage >
itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::typedef ( Concept::Convertible< InputImagePixelType, OutputImagePixelType )

This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< InputImagePixelType, OutputImagePixelType > )

template<class TInputImage , class TPolyline , class TOutputImage >
itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::typedef ( Concept::SameDimension< NDimensions, NOutputDimensions )

Begin concept checking This class requires SameDimensionCheck in the form of ( Concept::SameDimension< NDimensions, NOutputDimensions > )


Member Data Documentation

template<class TInputImage , class TPolyline , class TOutputImage >
const unsigned int itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::NDimensions = TInputImage::ImageDimension [static]

Number of dimensions.

Definition at line 66 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage , class TPolyline , class TOutputImage >
const unsigned int itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::NOutputDimensions = TOutputImage::ImageDimension [static]

Number of dimensions.

Definition at line 68 of file itkPolylineMask2DImageFilter.h.


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