SimpleITK  2.0.0rc2.post38
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

using PixelIDTypeList = IntegerPixelIDTypeList
 
using Self = BinaryMedianImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

 BinaryMedianImageFilter ()
 
Image Execute (const Image &image1)
 
double GetBackgroundValue () const
 
double GetForegroundValue () const
 
std::string GetName () const
 
std::vector< unsigned int > GetRadius () const
 
SelfSetBackgroundValue (double BackgroundValue)
 
SelfSetForegroundValue (double ForegroundValue)
 
SelfSetRadius (std::vector< unsigned int > Radius)
 
SelfSetRadius (unsigned int value)
 
std::string ToString () const
 
virtual ~BinaryMedianImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
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
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image(Self::*)(const Image &image1)
 

Private Member Functions

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

Private Attributes

double m_BackgroundValue {0.0}
 
double m_ForegroundValue {1.0}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< unsigned int > m_Radius {std::vector<unsigned int>(3, 1)}
 

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 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...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- 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) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
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 TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *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 57 of file sitkBinaryMedianImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 120 of file sitkBinaryMedianImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 69 of file sitkBinaryMedianImageFilter.h.

◆ Self

Definition at line 59 of file sitkBinaryMedianImageFilter.h.

Constructor & Destructor Documentation

◆ ~BinaryMedianImageFilter()

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

Destructor

◆ BinaryMedianImageFilter()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetBackgroundValue()

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 103 of file sitkBinaryMedianImageFilter.h.

◆ GetForegroundValue()

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 93 of file sitkBinaryMedianImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 106 of file sitkBinaryMedianImageFilter.h.

◆ GetRadius()

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

Get the radius of the neighborhood used to compute the median

Definition at line 83 of file sitkBinaryMedianImageFilter.h.

◆ SetBackgroundValue()

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 98 of file sitkBinaryMedianImageFilter.h.

◆ SetForegroundValue()

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 88 of file sitkBinaryMedianImageFilter.h.

◆ SetRadius() [1/2]

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

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

Definition at line 75 of file sitkBinaryMedianImageFilter.h.

◆ SetRadius() [2/2]

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

Set the values of the Radius vector all to value

Definition at line 78 of file sitkBinaryMedianImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 124 of file sitkBinaryMedianImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

double itk::simple::BinaryMedianImageFilter::m_BackgroundValue {0.0}
private

Definition at line 134 of file sitkBinaryMedianImageFilter.h.

◆ m_ForegroundValue

double itk::simple::BinaryMedianImageFilter::m_ForegroundValue {1.0}
private

Definition at line 132 of file sitkBinaryMedianImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::BinaryMedianImageFilter::m_MemberFactory
private

Definition at line 126 of file sitkBinaryMedianImageFilter.h.

◆ m_Radius

std::vector<unsigned int> itk::simple::BinaryMedianImageFilter::m_Radius {std::vector<unsigned int>(3, 1)}
private

Definition at line 130 of file sitkBinaryMedianImageFilter.h.


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