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

#include <itkBinaryMedianImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
typedef InputImageType::PixelType InputPixelType
typedef InputImageType::SizeType InputSizeType
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef OutputImageType::PixelType OutputPixelType
typedef SmartPointer< SelfPointer
typedef BinaryMedianImageFilter Self
typedef ImageToImageFilter
< InputImageType,
OutputImageType
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void GenerateInputRequestedRegion () throw ( InvalidRequestedRegionError )
virtual const char * GetNameOfClass () const
virtual const InputSizeTypeGetRadius ()
virtual void SetRadius (InputSizeType _arg)
 typedef (Concept::EqualityComparable< typename TInputImage::PixelType >) InputEqualityComparableCheck
 typedef (Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >) InputConvertibleToOutputCheck
 typedef (Concept::SameDimension< InputImageDimension, OutputImageDimension >) SameDimensionCheck
 typedef (Concept::OStreamWritable< typename TInputImage::PixelType >) InputOStreamWritableCheck
virtual void SetBackgroundValue (InputPixelType _arg)
virtual void SetForegroundValue (InputPixelType _arg)
virtual const InputPixelTypeGetBackgroundValue ()
virtual const InputPixelTypeGetForegroundValue ()

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions

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

Private Member Functions

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

Private Attributes

InputPixelType m_BackgroundValue
InputPixelType m_ForegroundValue
InputSizeType m_Radius

Detailed Description

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

Applies a 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 unnecessary 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 counting the neighbors 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 49 of file itkBinaryMedianImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef InputImageType::RegionType itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::InputImageRegionType
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 61 of file itkBinaryMedianImageFilter.h.

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

Image typedef support.

Definition at line 74 of file itkBinaryMedianImageFilter.h.

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

Definition at line 83 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 81 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 62 of file itkBinaryMedianImageFilter.h.

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

Definition at line 78 of file itkBinaryMedianImageFilter.h.

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

Standard class typedefs.

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

Definition at line 65 of file itkBinaryMedianImageFilter.h.

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

Constructor & Destructor Documentation

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

End concept checking

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

End concept checking

Definition at line 128 of file itkBinaryMedianImageFilter.h.

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

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::BinaryMedianImageFilter< 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::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 >
static 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 >::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::BinaryMedianImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

End concept checking

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,
ThreadIdType  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 >.

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

Begin concept checking This class requires InputEqualityComparableCheck in the form of ( Concept::EqualityComparable< typename TInputImage::PixelType > )

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

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

template<class TInputImage , class TOutputImage >
itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::typedef ( Concept::SameDimension< InputImageDimension, OutputImageDimension )

This class requires SameDimensionCheck in the form of ( Concept::SameDimension< InputImageDimension, OutputImageDimension > )

template<class TInputImage , class TOutputImage >
itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::typedef ( Concept::OStreamWritable< typename TInputImage::PixelType >  )

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


Member Data Documentation

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

Extract dimension from input and output image.

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

Definition at line 55 of file itkBinaryMedianImageFilter.h.

template<class TInputImage , class TOutputImage >
InputPixelType itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::m_BackgroundValue [private]

Definition at line 152 of file itkBinaryMedianImageFilter.h.

template<class TInputImage , class TOutputImage >
InputPixelType itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::m_ForegroundValue [private]

Definition at line 151 of file itkBinaryMedianImageFilter.h.

template<class TInputImage , class TOutputImage >
InputSizeType itk::BinaryMedianImageFilter< TInputImage, TOutputImage >::m_Radius [private]

Definition at line 149 of file itkBinaryMedianImageFilter.h.

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

Extract dimension from input and output image.

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

Definition at line 57 of file itkBinaryMedianImageFilter.h.


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