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

#include <itkObjectMorphologyImageFilter.h>

+ Inheritance diagram for itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >:
+ Collaboration diagram for itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
ConstantBoundaryCondition
< InputImageType
DefaultBoundaryConditionType
typedef ImageBoundaryCondition
< InputImageType > const * 
ImageBoundaryConditionConstPointerType
typedef ImageBoundaryCondition
< InputImageType > * 
ImageBoundaryConditionPointerType
typedef TInputImage::IndexType IndexType
typedef TInputImage InputImageType
typedef
ConstNeighborhoodIterator
< TInputImage > 
InputNeighborhoodIteratorType
typedef KernelType::ConstIterator KernelIteratorType
typedef TKernel KernelType
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
typedef TOutputImage OutputImageType
typedef NeighborhoodIterator
< TOutputImage > 
OutputNeighborhoodIteratorType
typedef TInputImage::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef KernelType::SizeType RadiusType
typedef TInputImage::RegionType RegionType
typedef ObjectMorphologyImageFilter Self
typedef TInputImage::SizeType SizeType
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass

Public Member Functions

void GenerateInputRequestedRegion ()
virtual
ImageBoundaryConditionPointerType 
GetBoundaryCondition () const
virtual const KernelTypeGetKernel ()
virtual const char * GetNameOfClass () const
virtual PixelType GetObjectValue () const
virtual bool GetUseBoundaryCondition () const
void OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
void ResetBoundaryCondition ()
virtual void SetKernel (KernelType _arg)
virtual void SetObjectValue (PixelType _arg)
virtual void SetUseBoundaryCondition (bool _arg)
 typedef (Concept::SameDimension< ImageDimension, OutputImageDimension >) SameDimensionCheck1
 typedef (Concept::SameDimension< ImageDimension, KernelDimension >) SameDimensionCheck2
 typedef (Concept::EqualityComparable< typename TOutputImage::PixelType, PixelType >) OutputInputEqualityComparableCheck
 typedef (Concept::Convertible< PixelType, typename TOutputImage::PixelType >) InputConvertibleToOutputCheck
 typedef (Concept::Convertible< int, typename TOutputImage::PixelType >) IntConvertibleToOutputCheck
 typedef (Concept::EqualityComparable< PixelType >) InputEqualityComparable
 typedef (Concept::OStreamWritable< PixelType >) InputOStreamWritableCheck

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
static const unsigned int KernelDimension = TKernel::NeighborhoodDimension

Protected Member Functions

void BeforeThreadedGenerateData ()
virtual void Evaluate (OutputNeighborhoodIteratorType &nit, const KernelType &kernel)=0
bool IsObjectPixelOnBoundary (const InputNeighborhoodIteratorType &nit)
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 ObjectMorphologyImageFilter ()
 ~ObjectMorphologyImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const

Protected Attributes

ImageBoundaryConditionPointerType m_BoundaryCondition
DefaultBoundaryConditionType m_DefaultBoundaryCondition
KernelType m_Kernel
PixelType m_ObjectValue
bool m_UseBoundaryCondition

Private Member Functions

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

Detailed Description

template<class TInputImage, class TOutputImage, class TKernel>
class itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >

Base class for the morphological operations being applied to isolated objects in an image.

This class provides the infrastructure to support of morphological operations being applied to images in which the foreground and background intensities are fixed. This filter operates significantly faster than itkBinaryMorhologicalImageFilters; however itkBinaryMorhologicalImageFilters preserve background pixels based on values of neighboring background pixels - potentially important during erosion.

The "kernel" specified represents a morphology structuring element. The structuring element is a small Neighborhood with values indicating an element is "on" (value > 0) or "off" (value <=0). Morphological operations are defined by placing the structuring element over a pixel, and calculating a nonlinear function (min, max) over the pixels of the image that are under pixels in the structuring element that are "on". The result of this calculation is the value of the pixel in the output image. Under most circumstances, the "center pixel" of the structuring element -- or structuring element pixel over the input pixel under consideration -- is prescribed to be "on". This is not a strict requirement but the subclasses of this filter are not guarenteed to produce the correct result if the "center pixel" is not part of the structuring element.

Subclasses of this class can define their own operations by simply providing their own Evaluate() protected member functions - one that operates using a smart neighborhood operator for edge faces and one that operates using a standard neighboorhood operator..

See also:
ErodeObjectMorphologicalImageFilter
DilateObjectMorphologicalImageFilter
BinaryErodeImageFilter
BinaryDilateImageFilter
GrayScaleErodeImageFilter
GrayScaleDilateImageFilter
NeighborhoodIterator
Neighborhood

Definition at line 73 of file itkObjectMorphologyImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage , class TKernel >
typedef SmartPointer< const Self > itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ConstPointer
template<class TInputImage , class TOutputImage , class TKernel >
typedef ConstantBoundaryCondition< InputImageType > itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::DefaultBoundaryConditionType
template<class TInputImage , class TOutputImage , class TKernel >
typedef ImageBoundaryCondition< InputImageType > const* itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ImageBoundaryConditionConstPointerType

Definition at line 99 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
typedef ImageBoundaryCondition< InputImageType >* itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ImageBoundaryConditionPointerType

Definition at line 97 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
typedef TInputImage::IndexType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::IndexType

Definition at line 91 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
typedef TInputImage itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::InputImageType

Image related typedefs.

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

Definition at line 84 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
typedef ConstNeighborhoodIterator< TInputImage > itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::InputNeighborhoodIteratorType

Neighborhood iterator type.

Definition at line 114 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
typedef KernelType::ConstIterator itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelIteratorType
template<class TInputImage , class TOutputImage , class TKernel >
typedef TKernel itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelType
template<class TInputImage , class TOutputImage , class TKernel >
typedef Superclass::OutputImageRegionType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageRegionType

Superclass typedefs.

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

Definition at line 94 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
typedef TOutputImage itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 88 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
typedef NeighborhoodIterator< TOutputImage > itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OutputNeighborhoodIteratorType
template<class TInputImage , class TOutputImage , class TKernel >
typedef TInputImage::PixelType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::PixelType
template<class TInputImage , class TOutputImage , class TKernel >
typedef SmartPointer< Self > itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Pointer
template<class TInputImage , class TOutputImage , class TKernel >
typedef KernelType::SizeType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::RadiusType

n-dimensional Kernel radius.

Definition at line 125 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
typedef TInputImage::RegionType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::RegionType

Definition at line 89 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
typedef ObjectMorphologyImageFilter itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Self
template<class TInputImage , class TOutputImage , class TKernel >
typedef TInputImage::SizeType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SizeType

Definition at line 90 of file itkObjectMorphologyImageFilter.h.

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

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage , class TKernel >
itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ObjectMorphologyImageFilter ( ) [protected]

End concept checking

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

End concept checking

Definition at line 196 of file itkObjectMorphologyImageFilter.h.

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

Member Function Documentation

template<class TInputImage , class TOutputImage , class TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::BeforeThreadedGenerateData ( void  ) [protected, virtual]

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage , class TKernel >
virtual void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Evaluate ( OutputNeighborhoodIteratorType nit,
const KernelType kernel 
) [protected, pure virtual]

Evaluate image neighborhood with kernel to find the new value for the center pixel value.

Implemented in itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

template<class TInputImage , class TOutputImage , class TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GenerateInputRequestedRegion ( ) [virtual]

ObjectMorphologyImageFilters need to make sure they request enough of an input image to account for the structuring element size. The input requested region is expanded by the radius of the structuring element. If the request extends past the LargestPossibleRegion for the input, the request is cropped by the LargestPossibleRegion.

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

template<class TInputImage , class TOutputImage , class TKernel >
virtual ImageBoundaryConditionPointerType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetBoundaryCondition ( ) const [virtual]

Get the current boundary condition.

template<class TInputImage , class TOutputImage , class TKernel >
virtual const KernelType& itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetKernel ( ) [virtual]

Get the kernel (structuring element).

template<class TInputImage , class TOutputImage , class TKernel >
virtual const char* itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetNameOfClass ( ) const [virtual]
template<class TInputImage , class TOutputImage , class TKernel >
virtual PixelType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetObjectValue ( ) const [virtual]

Get the pixel value being used to identify the object of interest

template<class TInputImage , class TOutputImage , class TKernel >
virtual bool itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetUseBoundaryCondition ( ) const [virtual]

Enable/disable the use of boundary condition. Defaults to false. if false, a neighborhood operator extends outside an image, it does not consider that outside extent when determining if a pixel is on an object's boundary.

template<class TInputImage , class TOutputImage , class TKernel >
bool itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::IsObjectPixelOnBoundary ( const InputNeighborhoodIteratorType nit) [protected]

Evaluate a pixel (assumed to have a value of ObjectValue) to determine if one of its neighboring pixels (8-neigh in 2d, etc) is a non-ObjectValue pixel.

template<class TInputImage , class TOutputImage , class TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::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 >.

Reimplemented in itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

template<class TInputImage , class TOutputImage , class TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::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. NOTE: Don't foget to set UseBoundaryCondition to true!

Definition at line 152 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]
template<class TInputImage , class TOutputImage , class TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ResetBoundaryCondition ( ) [inline]

Rest the boundary condition to the default

Definition at line 156 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
virtual void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetKernel ( KernelType  _arg) [virtual]

Set kernel (structuring element).

template<class TInputImage , class TOutputImage , class TKernel >
virtual void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetObjectValue ( PixelType  _arg) [virtual]

Set the pixel value being used to identify the object of interest

template<class TInputImage , class TOutputImage , class TKernel >
virtual void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetUseBoundaryCondition ( bool  _arg) [virtual]

Enable/disable the use of boundary condition. Defaults to false. if false, a neighborhood operator extends outside an image, it does not consider that outside extent when determining if a pixel is on an object's boundary.

template<class TInputImage , class TOutputImage , class TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
) [protected, virtual]

Multi-thread version GenerateData.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage , class TKernel >
itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::typedef ( Concept::SameDimension< ImageDimension, OutputImageDimension )

Begin concept checking This class requires SameDimensionCheck1 in the form of ( Concept::SameDimension< ImageDimension, OutputImageDimension > )

template<class TInputImage , class TOutputImage , class TKernel >
itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::typedef ( Concept::SameDimension< ImageDimension, KernelDimension )

This class requires SameDimensionCheck2 in the form of ( Concept::SameDimension< ImageDimension, KernelDimension > )

template<class TInputImage , class TOutputImage , class TKernel >
itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::typedef ( Concept::EqualityComparable< typename TOutputImage::PixelType, PixelType )

This class requires OutputInputEqualityComparableCheck in the form of ( Concept::EqualityComparable< typename TOutputImage::PixelType, PixelType > )

template<class TInputImage , class TOutputImage , class TKernel >
itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::typedef ( Concept::Convertible< PixelType, typename TOutputImage::PixelType >  )

This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< PixelType, typename TOutputImage::PixelType > )

template<class TInputImage , class TOutputImage , class TKernel >
itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::typedef ( Concept::Convertible< int, typename TOutputImage::PixelType >  )

This class requires IntConvertibleToOutputCheck in the form of ( Concept::Convertible< int, typename TOutputImage::PixelType > )

template<class TInputImage , class TOutputImage , class TKernel >
itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::typedef ( Concept::EqualityComparable< PixelType )

This class requires InputEqualityComparable in the form of ( Concept::EqualityComparable< PixelType > )

template<class TInputImage , class TOutputImage , class TKernel >
itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::typedef ( Concept::OStreamWritable< PixelType )

This class requires InputOStreamWritableCheck in the form of ( Concept::OStreamWritable< PixelType > )


Member Data Documentation

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

Image related typedefs.

Definition at line 105 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
const unsigned int itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelDimension = TKernel::NeighborhoodDimension [static]

Image related typedefs.

Definition at line 109 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
ImageBoundaryConditionPointerType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_BoundaryCondition [protected]

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

Definition at line 217 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
DefaultBoundaryConditionType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_DefaultBoundaryCondition [protected]

Default boundary condition

Definition at line 220 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
KernelType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_Kernel [protected]

kernel or structuring element to use.

Definition at line 226 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
PixelType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_ObjectValue [protected]

Pixel value that indicates the object be operated upon

Definition at line 229 of file itkObjectMorphologyImageFilter.h.

template<class TInputImage , class TOutputImage , class TKernel >
bool itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_UseBoundaryCondition [protected]

Defaults to false

Definition at line 223 of file itkObjectMorphologyImageFilter.h.

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

Image related typedefs.

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

Definition at line 107 of file itkObjectMorphologyImageFilter.h.


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