SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::BinaryMedianImageFilter Class Reference

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

#include <sitkBinaryMedianImageFilter.h>

+ Inheritance diagram for itk::simple::BinaryMedianImageFilter:
+ Collaboration diagram for itk::simple::BinaryMedianImageFilter:

Public Types

typedef IntegerPixelIDTypeList PixelIDTypeList
 
typedef BinaryMedianImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

 BinaryMedianImageFilter ()
 
Image Execute (const Image &image1)
 
Image Execute (const Image &image1, const std::vector< unsigned int > &radius, double foregroundValue, double backgroundValue)
 
double GetBackgroundValue () const
 
double GetForegroundValue () const
 
std::string GetName () const
 
std::vector< unsigned int > GetRadius () const
 
SelfSetBackgroundValue (double BackgroundValue)
 
SelfSetForegroundValue (double ForegroundValue)
 
SelfSetRadius (const std::vector< unsigned int > &Radius)
 
SelfSetRadius (unsigned int value)
 
std::string ToString () const
 
virtual ~BinaryMedianImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 1 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 

Private Types

typedef Image(Self::* MemberFunctionType) (const Image &image1)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)
 

Private Attributes

double m_BackgroundValue
 
double m_ForegroundValue
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< unsigned int > m_Radius
 

Friends

struct detail::MemberFunctionAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Detailed Description

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
itk::simple::BinaryMedian for the procedural interface
itk::BinaryMedianImageFilter for the Doxygen on the original ITK class.

Definition at line 54 of file sitkBinaryMedianImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::BinaryMedianImageFilter::MemberFunctionType) (const Image &image1)
private

Setup for member function dispatching

Definition at line 121 of file sitkBinaryMedianImageFilter.h.

Define the pixels types supported by this filter

Definition at line 66 of file sitkBinaryMedianImageFilter.h.

Definition at line 56 of file sitkBinaryMedianImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::BinaryMedianImageFilter::~BinaryMedianImageFilter ( )
virtual

Destructor

itk::simple::BinaryMedianImageFilter::BinaryMedianImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::BinaryMedianImageFilter::Execute ( const Image image1)

Execute the filter on the input image

Image itk::simple::BinaryMedianImageFilter::Execute ( const Image image1,
const std::vector< unsigned int > &  radius,
double  foregroundValue,
double  backgroundValue 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::BinaryMedianImageFilter::ExecuteInternal ( const Image image1)
private
double itk::simple::BinaryMedianImageFilter::GetBackgroundValue ( ) const
inline

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

Definition at line 102 of file sitkBinaryMedianImageFilter.h.

double itk::simple::BinaryMedianImageFilter::GetForegroundValue ( ) const
inline

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

Definition at line 92 of file sitkBinaryMedianImageFilter.h.

std::string itk::simple::BinaryMedianImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 104 of file sitkBinaryMedianImageFilter.h.

std::vector<unsigned int> itk::simple::BinaryMedianImageFilter::GetRadius ( ) const
inline

Get the radius of the neighborhood used to compute the median

Definition at line 82 of file sitkBinaryMedianImageFilter.h.

Self& itk::simple::BinaryMedianImageFilter::SetBackgroundValue ( double  BackgroundValue)
inline

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

Definition at line 97 of file sitkBinaryMedianImageFilter.h.

Self& itk::simple::BinaryMedianImageFilter::SetForegroundValue ( double  ForegroundValue)
inline

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

Definition at line 87 of file sitkBinaryMedianImageFilter.h.

Self& itk::simple::BinaryMedianImageFilter::SetRadius ( const std::vector< unsigned int > &  Radius)
inline

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

Definition at line 73 of file sitkBinaryMedianImageFilter.h.

Self& itk::simple::BinaryMedianImageFilter::SetRadius ( unsigned int  value)
inline

Set the values of the Radius vector all to value

Definition at line 76 of file sitkBinaryMedianImageFilter.h.

std::string itk::simple::BinaryMedianImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 125 of file sitkBinaryMedianImageFilter.h.

Member Data Documentation

double itk::simple::BinaryMedianImageFilter::m_BackgroundValue
private

Definition at line 133 of file sitkBinaryMedianImageFilter.h.

double itk::simple::BinaryMedianImageFilter::m_ForegroundValue
private

Definition at line 132 of file sitkBinaryMedianImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::BinaryMedianImageFilter::m_MemberFactory
private

Definition at line 127 of file sitkBinaryMedianImageFilter.h.

std::vector<unsigned int> itk::simple::BinaryMedianImageFilter::m_Radius
private

Definition at line 131 of file sitkBinaryMedianImageFilter.h.


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