SimpleITK  2.0.0rc2.post23
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::RankImageFilter Class Reference

Rank filter of a greyscale image. More...

#include <sitkRankImageFilter.h>

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

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = RankImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

Image Execute (const Image &image1)
 
std::string GetName () const
 
std::vector< unsigned int > GetRadius () const
 
double GetRank () const
 
 RankImageFilter ()
 
SelfSetRadius (std::vector< unsigned int > Radius)
 
SelfSetRadius (unsigned int value)
 
SelfSetRank (double Rank)
 
std::string ToString () const
 
virtual ~RankImageFilter ()
 
- 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)
 
template<class TImageType >
Image ExecuteInternalVectorImage (const Image &image)
 

Private Attributes

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< unsigned int > m_Radius {std::vector<unsigned int>(3, 1)}
 
double m_Rank {0.5}
 

Friends

struct detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >
 
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

Rank filter of a greyscale image.

Nonlinear filter in which each output pixel is a user defined rank of input pixels in a user defined neighborhood. The default rank is 0.5 (median). The boundary conditions are different to the standard itkMedianImageFilter. In this filter the neighborhood is cropped at the boundary, and is therefore smaller.

This filter uses a recursive implementation - essentially the one by Huang 1979, I believe, to compute the rank, and is therefore usually a lot faster than the direct implementation. The extensions to Huang are support for arbitrary pixel types (using c++ maps) and arbitrary neighborhoods. I presume that these are not new ideas.

This filter is based on the sliding window code from the consolidatedMorphology package on InsightJournal.

The structuring element is assumed to be composed of binary values (zero or one). Only elements of the structuring element having values > 0 are candidates for affecting the center pixel.

This code was contributed in the Insight Journal paper: "Efficient implementation of kernel filtering" by Beare R., Lehmann G https://hdl.handle.net/1926/555 http://www.insight-journal.org/browse/publication/160

See also
MedianImageFilter
Author
Richard Beare
See also
itk::simple::Rank for the procedural interface
itk::RankImageFilter for the Doxygen on the original ITK class.

Definition at line 55 of file sitkRankImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 104 of file sitkRankImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 67 of file sitkRankImageFilter.h.

◆ Self

Definition at line 57 of file sitkRankImageFilter.h.

Constructor & Destructor Documentation

◆ ~RankImageFilter()

virtual itk::simple::RankImageFilter::~RankImageFilter ( )
virtual

Destructor

◆ RankImageFilter()

itk::simple::RankImageFilter::RankImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ ExecuteInternalVectorImage()

template<class TImageType >
Image itk::simple::RankImageFilter::ExecuteInternalVectorImage ( const Image image)
private

Dispatched methods which calls ExecuteInteral on each component

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 90 of file sitkRankImageFilter.h.

◆ GetRadius()

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

Definition at line 87 of file sitkRankImageFilter.h.

◆ GetRank()

double itk::simple::RankImageFilter::GetRank ( ) const
inline

Definition at line 76 of file sitkRankImageFilter.h.

◆ SetRadius() [1/2]

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

Definition at line 80 of file sitkRankImageFilter.h.

◆ SetRadius() [2/2]

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

Set the values of the Radius vector all to value

Definition at line 83 of file sitkRankImageFilter.h.

◆ SetRank()

Self& itk::simple::RankImageFilter::SetRank ( double  Rank)
inline

Definition at line 72 of file sitkRankImageFilter.h.

References itk::simple::Rank().

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

Definition at line 110 of file sitkRankImageFilter.h.

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 109 of file sitkRankImageFilter.h.

Member Data Documentation

◆ m_MemberFactory

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

Definition at line 111 of file sitkRankImageFilter.h.

◆ m_Radius

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

Definition at line 118 of file sitkRankImageFilter.h.

◆ m_Rank

double itk::simple::RankImageFilter::m_Rank {0.5}
private

Definition at line 115 of file sitkRankImageFilter.h.


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