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

#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 Self >	ConstPointer
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< Self >	Pointer
typedef TPolyline	PolylineType
typedef PolylineMask2DImageFilter	Self
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
Public Types inherited from itk::ImageSource< TOutputImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
Public Types inherited from itk::ProcessObject
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
void	GenerateData (void)
virtual const char *	GetNameOfClass () const
void	SetInput1 (const InputImageType *image)
void	SetInput2 (const PolylineType *polyline)
	typedef (Concept::SameDimension< NDimensions, NOutputDimensions >) SameDimensionCheck
	typedef (Concept::Convertible< int, OutputImagePixelType >) IntConvertibleOutputCheck
	typedef (Concept::EqualityComparable< OutputImagePixelType >) OutputEqualityComparableCheck
	typedef (Concept::Convertible< InputImagePixelType, OutputImagePixelType >) InputConvertibleToOutputCheck
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TInputImage *image)
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::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 ThreadIdType &	GetNumberOfThreads ()
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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () 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	NDimensions = TInputImage::ImageDimension
static const unsigned int	NOutputDimensions = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	GenerateInputRequestedRegion ()
	ImageToImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	VerifyInputInformation ()
	~ImageToImageFilter ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource ()
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	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	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () 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 ()
	PolylineMask2DImageFilter ()
virtual	~PolylineMask2DImageFilter ()
	PolylineMask2DImageFilter (const Self &)
void	operator= (const Self &)

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

---

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 56 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage , class TPolyline , class TOutputImage >

typedef InputImageType::ConstPointer itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::InputImageConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

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

template<class TInputImage , class TPolyline , class TOutputImage >

typedef InputImageType::Pointer itk::PolylineMask2DImageFilter< TInputImage, TPolyline, TOutputImage >::InputImagePointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 74 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 75 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 72 of file itkPolylineMask2DImageFilter.h.

template<class TInputImage , class TPolyline , class TOutputImage >

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 85 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 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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 55 of file itkPolylineMask2DImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 54 of file itkPolylineMask2DImageFilter.h.

---

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 ( )

inlineprotectedvirtual

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::SameDimension< NDimensions, NOutputDimensions >

)

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

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::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< InputImagePixelType, OutputImagePixelType >

)

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

---

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:

• itkPolylineMask2DImageFilter.h