itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage > Class Template Reference
[Image Filters]

Applies a single NeighborhoodOperator to an image region. More...

#include <itkNeighborhoodOperatorImageFilter.h>

Inheritance diagram for itk::NeighborhoodOperatorImageFilter:

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

[legend]List of all members.

Public Types
typedef NeighborhoodOperatorImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	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 TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef ImageBoundaryCondition< OutputImageType > *	ImageBoundaryConditionPointerType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Neighborhood< OutputPixelType, itkGetStaticConstMacro(ImageDimension)	OutputNeighborhoodType )
typedef Neighborhood< InputPixelType, itkGetStaticConstMacro(ImageDimension)	InputNeighborhoodType )
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
void	OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
virtual void	GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
void	SetOperator (const OutputNeighborhoodType &p)
Static Public Methods
Pointer	New ()
Protected Methods
	NeighborhoodOperatorImageFilter ()
virtual	~NeighborhoodOperatorImageFilter ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >

Applies a single NeighborhoodOperator to an image region.

This filter calculates successive inner products between a single NeighborhoodOperator and a NeighborhoodIterator, which is swept across every pixel in an image region. For operators that are symmetric across their axes, the result is a fast convolution with the image region. Apply the mirror()'d operator for non-symmetric NeighborhoodOperators.

See also:

Image , Neighborhood , NeighborhoodOperator , NeighborhoodIterator

Definition at line 45 of file itkNeighborhoodOperatorImageFilter.h.

---

Member Typedef Documentation

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

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

template<class TInputImage, class TOutputImage> typedef ImageBoundaryCondition<OutputImageType>* itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::ImageBoundaryConditionPointerType

Typedef for generic boundary condition pointer. Definition at line 80 of file itkNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::Pointer itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::InputImagePointer

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

template<class TInputImage, class TOutputImage> typedef TInputImage itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::InputImageType

Image typedef support. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 74 of file itkNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage::InternalPixelType itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::InputInternalPixelType

Definition at line 66 of file itkNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Neighborhood<InputPixelType, itkGetStaticConstMacro(ImageDimension) itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::InputNeighborhoodType)

Neighborhood types Definition at line 87 of file itkNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage::PixelType itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 65 of file itkNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::OutputImageRegionType itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

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

template<class TInputImage, class TOutputImage> typedef TOutputImage itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::OutputImageType

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

template<class TInputImage, class TOutputImage> typedef TOutputImage::InternalPixelType itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType

Definition at line 64 of file itkNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Neighborhood<OutputPixelType, itkGetStaticConstMacro(ImageDimension) itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::OutputNeighborhoodType)

Neighborhood types Definition at line 86 of file itkNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::PixelType itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::OutputPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same. Definition at line 63 of file itkNeighborhoodOperatorImageFilter.h.

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

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

template<class TInputImage, class TOutputImage> typedef NeighborhoodOperatorImageFilter itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::Self

Standard "Self" & Superclass typedef. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 50 of file itkNeighborhoodOperatorImageFilter.h.

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

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

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage> itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::NeighborhoodOperatorImageFilter (    )  [inline, protected]

Definition at line 118 of file itkNeighborhoodOperatorImageFilter.h. References HardConnectedComponentImageFilter::PrintSelf().

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

Definition at line 119 of file itkNeighborhoodOperatorImageFilter.h.

---

Member Function Documentation

template<class TInputImage, class TOutputImage> virtual void itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion (    )  throw (InvalidRequestedRegionError) [virtual]

NeighborhoodOperatorImageFilter needs a larger input requested region than the output requested region. As such, NeighborhoodOperatorImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model. See also: ProcessObject::GenerateInputRequestedRegion() Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual const char* itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::GetClassName (    )  const [virtual]

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

template<class TInputImage, class TOutputImage> itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  ImageDimension   , unsigned    int, TOutputImage::ImageDimension    )

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

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

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

template<class TInputImage, class TOutputImage> void itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::OverrideBoundaryCondition (  const ImageBoundaryConditionPointerType    i )  [inline]

Allows a user to override the internal boundary condition. Care should be be taken to ensure that the overriding boundary condition is a persistent object during the time it is referenced. The overriding condition can be of a different type than the default type as long as it is a subclass of ImageBoundaryCondition. Definition at line 105 of file itkNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> void itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::PrintSelf (  std::ostream &    os, Indent    indent )  const [inline, 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 >. Definition at line 136 of file itkNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> void itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::SetOperator (  const OutputNeighborhoodType &    p )  [inline]

Sets the operator that is used to filter the image. Note that the operator is stored as an internal COPY (it is not part of the pipeline). Definition at line 93 of file itkNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> void itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData (  const OutputImageRegionType &    outputRegionForThread, int    threadId )  [protected, virtual]

NeighborhoodOperatorImageFilter 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::ImageSource< TOutputImage >.

---

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

• itkNeighborhoodOperatorImageFilter.h

---