ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage > Class Template Reference

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

#include <itkVectorNeighborhoodOperatorImageFilter.h>

Inheritance diagram for itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >:
Collaboration diagram for itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef ImageBoundaryCondition
< OutputImageType > * 
ImageBoundaryConditionPointerType
typedef TInputImage::Pointer InputImagePointer
typedef TInputImage InputImageType
typedef
TInputImage::InternalPixelType 
InputInternalPixelType
typedef TInputImage::PixelType InputPixelType
typedef TOutputImage::Pointer OutputImagePointer
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
typedef TOutputImage OutputImageType
typedef
TOutputImage::InternalPixelType 
OutputInternalPixelType
typedef TOutputImage::PixelType OutputPixelType
typedef SmartPointer< SelfPointer
typedef OutputPixelType::ValueType ScalarValueType
typedef
VectorNeighborhoodOperatorImageFilter 
Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void GenerateInputRequestedRegion () throw ( InvalidRequestedRegionError )
virtual const char * GetNameOfClass () const
void OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
 typedef (Concept::HasNumericTraits< typename TOutputImage::PixelType::ValueType >) OutputHasNumericTraitsCheck
 typedef (Concept::HasNumericTraits< typename TInputImage::PixelType::ValueType >) InputHasNumericTraitsCheck
void SetOperator (const Neighborhood< ScalarValueType, itkGetStaticConstMacro(ImageDimension) > &p)

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = TOutputImage::ImageDimension

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 VectorNeighborhoodOperatorImageFilter ()
virtual ~VectorNeighborhoodOperatorImageFilter ()

Private Member Functions

void operator= (const Self &)
 VectorNeighborhoodOperatorImageFilter (const Self &)

Private Attributes

ImageBoundaryConditionPointerType m_BoundsCondition
Neighborhood< ScalarValueType,
itkGetStaticConstMacro(ImageDimension) > 
m_Operator

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 58 of file itkVectorNeighborhoodOperatorImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef ImageBoundaryCondition< OutputImageType >* itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::ImageBoundaryConditionPointerType

Typedef for generic boundary condition pointer

Definition at line 93 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 72 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 89 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

Definition at line 81 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

Definition at line 80 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 77 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 96 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 90 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

Definition at line 79 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

Definition at line 78 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

Definition at line 82 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 63 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

Constructor & Destructor Documentation

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

End concept checking

Definition at line 137 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

End concept checking

Definition at line 138 of file itkVectorNeighborhoodOperatorImageFilter.h.

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

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::VectorNeighborhoodOperatorImageFilter< TInputImage, 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 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 >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods)

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

template<class TInputImage , class TOutputImage >
static 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 >::operator= ( const Self ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

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 114 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 154 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 101 of file itkVectorNeighborhoodOperatorImageFilter.h.

template<class TInputImage , class TOutputImage >
void itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  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 >.

template<class TInputImage , class TOutputImage >
itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::typedef ( Concept::HasNumericTraits< typename TInputImage::PixelType::ValueType >  )

Begin concept checking This class requires InputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< typename TInputImage::PixelType::ValueType > )

template<class TInputImage , class TOutputImage >
itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::typedef ( Concept::HasNumericTraits< typename TOutputImage::PixelType::ValueType >  )

This class requires OutputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< typename TOutputImage::PixelType::ValueType > )


Member Data Documentation

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

Determine image dimension.

Definition at line 86 of file itkVectorNeighborhoodOperatorImageFilter.h.

template<class TInputImage , class TOutputImage >
ImageBoundaryConditionPointerType itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::m_BoundsCondition [private]

Pointer to a persistent boundary condition object used for the image iterator.

Definition at line 168 of file itkVectorNeighborhoodOperatorImageFilter.h.

template<class TInputImage , class TOutputImage >
Neighborhood< ScalarValueType, itkGetStaticConstMacro(ImageDimension) > itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::m_Operator [private]

Pointer to the internal operator used to filter the image.

Definition at line 164 of file itkVectorNeighborhoodOperatorImageFilter.h.


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