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

Applies a median filter to an image. More...

#include <itkMedianImageFilter.h>

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

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

[legend]List of all members.

Public Types
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef MedianImageFilter	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 *	GetClassName () 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)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	MedianImageFilter ()
virtual	~MedianImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

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

Applies a median filter to an image.

Computes an image where a given pixel is the median value of the the pixels in a neighborhood about the corresponding input pixel.

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.

This filter requires that the input pixel type provides an operator<() (LessThan Comparable).

See also:

Image

Neighborhood

NeighborhoodOperator

NeighborhoodIterator

Definition at line 45 of file itkMedianImageFilter.h.

---

Member Typedef Documentation

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

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

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

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

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

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

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

Image typedef support. Definition at line 73 of file itkMedianImageFilter.h.

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

Definition at line 79 of file itkMedianImageFilter.h. Referenced by itk::MedianImageFilter< TInputImage, TOutputImage >::~MedianImageFilter().

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

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 77 of file itkMedianImageFilter.h. Referenced by itk::MedianImageFilter< TInputImage, TOutputImage >::~MedianImageFilter().

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

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

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

Definition at line 74 of file itkMedianImageFilter.h.

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

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

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

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 61 of file itkMedianImageFilter.h. Referenced by itk::MedianImageFilter< TInputImage, TOutputImage >::~MedianImageFilter().

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

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

---

Constructor & Destructor Documentation

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

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

Definition at line 97 of file itkMedianImageFilter.h. References itk::MedianImageFilter< TInputImage, TOutputImage >::InputSizeType, itk::MedianImageFilter< TInputImage, TOutputImage >::OutputImageRegionType, and itk::MedianImageFilter< TInputImage, TOutputImage >::Self.

---

Member Function Documentation

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

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

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

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

Get the radius of the neighborhood used to compute the median

template<class TInputImage, class TOutputImage> itk::MedianImageFilter< 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::MedianImageFilter< 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::MedianImageFilter< TInputImage, TOutputImage >::New (   )  [static]

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

template<class TInputImage, class TOutputImage> void itk::MedianImageFilter< 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::MedianImageFilter< TInputImage, TOutputImage >::SetRadius (  InputSizeType  _arg  )  [virtual]

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

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

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

• itkMedianImageFilter.h

---