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

Applies a single scalar NeighborhoodOperator to an itk::Vector image region. More...

#include <itkVectorNeighborhoodOperatorImageFilter.h>

Inheritance diagram for itk::VectorNeighborhoodOperatorImageFilter:

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

[legend]List of all members.

Public Types
typedef VectorNeighborhoodOperatorImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage::Pointer	InputImagePointer
typedef TOutputImage::Pointer	OutputImagePointer
typedef TOutputImage::PixelType	OutputPixelType
typedef TOutputImage::InternalPixelType	OutputInternalPixelType
typedef TInputImage::PixelType	InputPixelType
typedef TInputImage::InternalPixelType	InputInternalPixelType
typedef OutputPixelType::ValueType	ScalarValueType
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef ImageBoundaryCondition< OutputImageType > *	ImageBoundaryConditionPointerType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
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 Neighborhood< ScalarValueType, itkGetStaticConstMacro(ImageDimension)> &p)
Static Public Methods
Pointer	New ()
Protected Methods
	VectorNeighborhoodOperatorImageFilter ()
virtual	~VectorNeighborhoodOperatorImageFilter ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

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

Applies a single scalar NeighborhoodOperator to an itk::Vector 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.

This filter assumes that the input and output images have pixels which are itk::Vectors of the same vector dimension. The input NeighbourhoodOperator must have a scalar type that matches the ValueType of vector pixels.

To apply a scalar NeighborhoodOperator to a scalar image use NeighborhoodOperatorImageFilter instead.

See also:

Image , Neighborhood , NeighborhoodOperator , NeighborhoodIterator , NeighborhoodOperatorImageFilter

Definition at line 56 of file itkVectorNeighborhoodOperatorImageFilter.h.

---

Member Typedef Documentation

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

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

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

Typedef for generic boundary condition pointer Definition at line 92 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

Extract some information from the image types. Dimensionality of the two images is assumed to be the same. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 74 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

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

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

Definition at line 79 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

Definition at line 78 of file itkVectorNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::Pointer itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 75 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

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

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

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

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

Definition at line 77 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

Definition at line 76 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

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

template<class TInputImage, class TOutputImage> typedef OutputPixelType::ValueType itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::ScalarValueType

Definition at line 80 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 61 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

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

---

Constructor & Destructor Documentation

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

Definition at line 126 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

Definition at line 127 of file itkVectorNeighborhoodOperatorImageFilter.h. References HardConnectedComponentImageFilter::PrintSelf().

---

Member Function Documentation

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

VectorNeighborhoodOperatorImageFilter needs a larger input requested region than the output requested region. As such, VectorNeighborhoodOperatorImageFilter 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::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::GetClassName (    )  const [virtual]

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

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

Determine image dimension.

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

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

template<class TInputImage, class TOutputImage> void itk::VectorNeighborhoodOperatorImageFilter< 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 113 of file itkVectorNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> void itk::VectorNeighborhoodOperatorImageFilter< 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 142 of file itkVectorNeighborhoodOperatorImageFilter.h.

template<class TInputImage, class TOutputImage> void itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::SetOperator (  const Neighborhood< ScalarValueType, itkGetStaticConstMacro(ImageDimension)> &    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 100 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

VectorNeighborhoodOperatorImageFilter 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:

• itkVectorNeighborhoodOperatorImageFilter.h

---