itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType > Class Template Reference
[Image Filters]

Applies a single NeighborhoodOperator to an image, processing only those pixels that are under a mask. More...

#include <itkMaskNeighborhoodOperatorImageFilter.h>

Inheritance diagram for itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >:

[legend]Collaboration diagram for itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >:

[legend]List of all members.

Public Types
typedef MaskNeighborhoodOperatorImageFilter	Self
typedef NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TOutputImage::PixelType	OutputPixelType
typedef TOutputImage::InternalPixelType	OutputInternalPixelType
typedef TInputImage::PixelType	InputPixelType
typedef TInputImage::InternalPixelType	InputInternalPixelType
typedef TMaskImage::PixelType	MaskPixelType
typedef TMaskImage::InternalPixelType	MaskInternalPixelType
typedef TInputImage	InputImageType
typedef TMaskImage	MaskImageType
typedef TOutputImage	OutputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef MaskImageType::Pointer	MaskImagePointer
typedef ImageBoundaryCondition< OutputImageType > *	ImageBoundaryConditionPointerType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Superclass::OperatorValueType	OperatorValueType
typedef Superclass::OutputNeighborhoodType	OutputNeighborhoodType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
void	SetMaskImage (const TMaskImage *mask)
const TMaskImage *	GetMaskImage () const
virtual void	SetDefaultValue (OutputPixelType _arg)
virtual OutputPixelType	GetDefaultValue ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	MaskNeighborhoodOperatorImageFilter ()
virtual	~MaskNeighborhoodOperatorImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType>
class itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >

Applies a single NeighborhoodOperator to an image, processing only those pixels that are under a mask.

This filter caculates successive inner products between a single NeighborhoodOperator and a NeighborhoodIterator, which is swept across every pixel that is set in the input mask. If no mask is given, this filter is equivalent to its superclass.

See also:

Image

Neighborhood

NeighborhoodOperator

NeighborhoodOperatorImageFilter

NeighborhoodIterator

Definition at line 41 of file itkMaskNeighborhoodOperatorImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef SmartPointer<const Self> itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ConstPointer

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 49 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef ImageBoundaryCondition<OutputImageType>* itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ImageBoundaryConditionPointerType

Typedef for generic boundary condition pointer. Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 80 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef InputImageType::Pointer itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputImagePointer

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 75 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef TInputImage itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputImageType

Image typedef support. Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 72 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef TInputImage::InternalPixelType itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputInternalPixelType

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 62 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef TInputImage::PixelType itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputPixelType

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 61 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef MaskImageType::Pointer itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskImagePointer

Definition at line 76 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef TMaskImage itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskImageType

Definition at line 73 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef TMaskImage::InternalPixelType itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskInternalPixelType

Definition at line 64 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef TMaskImage::PixelType itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskPixelType

Definition at line 63 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef Superclass::OperatorValueType itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OperatorValueType

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 84 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef Superclass::OutputImageRegionType itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputImageRegionType

Superclass typedefs. Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 83 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef TOutputImage itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputImageType

Some convenient typedefs. Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 74 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef TOutputImage::InternalPixelType itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputInternalPixelType

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 60 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef Superclass::OutputNeighborhoodType itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputNeighborhoodType

Neighborhood types Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 87 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef TOutputImage::PixelType itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same. Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 59 of file itkMaskNeighborhoodOperatorImageFilter.h. Referenced by itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskNeighborhoodOperatorImageFilter().

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef SmartPointer<Self> itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::Pointer

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 48 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef MaskNeighborhoodOperatorImageFilter itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::Self

Standard "Self" & Superclass typedef. Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 46 of file itkMaskNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> typedef NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType > itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::Superclass

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >. Definition at line 47 of file itkMaskNeighborhoodOperatorImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskNeighborhoodOperatorImageFilter (   )  [inline, protected]

Definition at line 109 of file itkMaskNeighborhoodOperatorImageFilter.h. References itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputPixelType.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> virtual itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::~MaskNeighborhoodOperatorImageFilter (   )  [inline, protected, virtual]

Definition at line 110 of file itkMaskNeighborhoodOperatorImageFilter.h.

---

Member Function Documentation

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> void itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GenerateInputRequestedRegion (   )  throw (InvalidRequestedRegionError) [protected, virtual]

MaskNeighborhoodOperatorImageFilter needs to request enough of an input image to account for template size. The input requested region is expanded by the radius of the template. If the request extends past the LargestPossibleRegion for the input, the request is cropped by the LargestPossibleRegion. Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> virtual OutputPixelType itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GetDefaultValue (   )  [virtual]

Get the output value for the pixels that are not under the mask.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> const TMaskImage* itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GetMaskImage (   )  const

Get the mask image. Using a mask is optional. When a mask is specified, the normalized correlation is only calculated for those pixels under the mask.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> virtual const char* itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GetNameOfClass (   )  const [virtual]

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

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TOutputImage::ImageDimension  )

Extract some information from the image types. Dimensionality of the two images is assumed to be the same. Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> Pointer itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> void itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::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::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> virtual void itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::SetDefaultValue (  OutputPixelType  _arg  )  [virtual]

Set the output value for the pixels that are not under the mask. Defaults to zero.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> void itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::SetMaskImage (  const TMaskImage *  mask  )

Set the mask image. Using a mask is optional. When a mask is specified, the normalized correlation is only calculated for those pixels under the mask.

template<class TInputImage, class TMaskImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType> void itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ThreadedGenerateData (  const OutputImageRegionType &  outputRegionForThread, int  threadId )  [protected, virtual]

MaskNeighborhoodOperatorImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread" See also: ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData() Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

---

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

• itkMaskNeighborhoodOperatorImageFilter.h

---