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

Applies an version of the median filter optimized for binary images. More...

#include <itkBinaryMedianImageFilter.h>

Inheritance diagram for itk::BinaryMedianImageFilter< TInputImage, TOutputImage >:

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

[legend]List of all members.

Public Types
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef BinaryMedianImageFilter	Self
typedef ImageToImageFilter< InputImageType, OutputImageType >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::PixelType	InputPixelType
typedef OutputImageType::PixelType	OutputPixelType
typedef InputImageType::RegionType	InputImageRegionType
typedef OutputImageType::RegionType	OutputImageRegionType
typedef InputImageType::SizeType	InputSizeType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	SetRadius (InputSizeType _arg)
virtual const InputSizeType &	GetRadius ()
virtual void	GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual void	SetBackgroundValue (InputPixelType _arg)
virtual void	SetForegroundValue (InputPixelType _arg)
virtual const InputPixelType &	GetBackgroundValue ()
virtual const InputPixelType &	GetForegroundValue ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	BinaryMedianImageFilter ()
virtual	~BinaryMedianImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

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

Applies an version of the median filter optimized for binary images.

This filter was contributed by Bjorn Hanch Sollie after identifying that the generic Median filter performed unecessary operations when the input image is binary.

This filter Computes an image where a given pixel is the median value of the pixels in a neighborhood about the corresponding input pixel. For the case of binary images the median can be obtained by simply conting the neigbors that are foreground.

A median filter is one of the family of nonlinear filters. It is used to smooth an image without being biased by outliers or shot noise.

See also:

Image

Neighborhood

NeighborhoodOperator

NeighborhoodIterator

Definition at line 48 of file itkBinaryMedianImageFilter.h.

---

Member Typedef Documentation

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

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

template<class TInputImage, class TOutputImage> typedef InputImageType::RegionType itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::InputImageRegionType

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

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

Convenient typedefs for simplifying declarations. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 60 of file itkBinaryMedianImageFilter.h.

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

Image typedef support. Definition at line 76 of file itkBinaryMedianImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::SizeType itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::InputSizeType

Definition at line 82 of file itkBinaryMedianImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::RegionType itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

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

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

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

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

Definition at line 77 of file itkBinaryMedianImageFilter.h.

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

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

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

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

template<class TInputImage, class TOutputImage> typedef ImageToImageFilter< InputImageType, OutputImageType> itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::Superclass

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

---

Constructor & Destructor Documentation

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

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

Definition at line 113 of file itkBinaryMedianImageFilter.h.

---

Member Function Documentation

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

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

template<class TInputImage, class TOutputImage> virtual const InputPixelType& itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::GetBackgroundValue (   )  [virtual]

Get the value associated with the Foreground (or the object) on the binary input image and the Background .

template<class TInputImage, class TOutputImage> virtual const InputPixelType& itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::GetForegroundValue (   )  [virtual]

Get the value associated with the Foreground (or the object) on the binary input image and the Background .

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

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

template<class TInputImage, class TOutputImage> virtual const InputSizeType& itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::GetRadius (   )  [virtual]

Get the radius of the neighborhood used to compute the median

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

Extract dimension from input and output image. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

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

Extract dimension from input and output image. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

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

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

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

template<class TInputImage, class TOutputImage> virtual void itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::SetBackgroundValue (  InputPixelType  _arg  )  [virtual]

Set the value associated with the Foreground (or the object) on the binary input image and the Background .

template<class TInputImage, class TOutputImage> virtual void itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::SetForegroundValue (  InputPixelType  _arg  )  [virtual]

Set the value associated with the Foreground (or the object) on the binary input image and the Background .

template<class TInputImage, class TOutputImage> virtual void itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::SetRadius (  InputSizeType  _arg  )  [virtual]

Set the radius of the neighborhood used to compute the median.

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

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

• itkBinaryMedianImageFilter.h

---