SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ValuedRegionalMaximaImageFilter Class Reference

Transforms the image so that any pixel that is not a regional maxima is set to the minimum value for the pixel type. Pixels that are regional maxima retain their value. More...

#include <sitkValuedRegionalMaximaImageFilter.h>

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

Public Types

using PixelIDTypeList = ScalarPixelIDTypeList
using Self = ValuedRegionalMaximaImageFilter
- 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)
SelfFullyConnectedOff ()
SelfFullyConnectedOn ()
bool GetFlat () const
bool GetFullyConnected () const
std::string GetName () const
SelfSetFullyConnected (bool FullyConnected)
std::string ToString () const
 ValuedRegionalMaximaImageFilter ()
virtual ~ValuedRegionalMaximaImageFilter ()
- 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

bool m_Flat {false}
bool m_FullyConnected {false}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory


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

Transforms the image so that any pixel that is not a regional maxima is set to the minimum value for the pixel type. Pixels that are regional maxima retain their value.

Regional maxima are flat zones surrounded by pixels of lower value. A completely flat image will be marked as a regional maxima by this filter.

This code was contributed in the Insight Journal paper: "Finding regional extrema - methods and performance" by Beare R., Lehmann G.

Richard Beare. Department of Medicine, Monash University, Melbourne, Australia.
See also
itk::simple::ValuedRegionalMaxima for the procedural interface
itk::ValuedRegionalMaximaImageFilter for the Doxygen on the original ITK class.

Definition at line 55 of file sitkValuedRegionalMaximaImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 105 of file sitkValuedRegionalMaximaImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 67 of file sitkValuedRegionalMaximaImageFilter.h.

◆ Self

Definition at line 57 of file sitkValuedRegionalMaximaImageFilter.h.

Constructor & Destructor Documentation

◆ ~ValuedRegionalMaximaImageFilter()

virtual itk::simple::ValuedRegionalMaximaImageFilter::~ValuedRegionalMaximaImageFilter ( )


◆ ValuedRegionalMaximaImageFilter()

itk::simple::ValuedRegionalMaximaImageFilter::ValuedRegionalMaximaImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ FullyConnectedOff()

Self& itk::simple::ValuedRegionalMaximaImageFilter::FullyConnectedOff ( )

Definition at line 76 of file sitkValuedRegionalMaximaImageFilter.h.

◆ FullyConnectedOn()

Self& itk::simple::ValuedRegionalMaximaImageFilter::FullyConnectedOn ( )

Set the value of FullyConnected to true or false respectfully.

Definition at line 75 of file sitkValuedRegionalMaximaImageFilter.h.

◆ GetFlat()

bool itk::simple::ValuedRegionalMaximaImageFilter::GetFlat ( ) const

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 87 of file sitkValuedRegionalMaximaImageFilter.h.

◆ GetFullyConnected()

bool itk::simple::ValuedRegionalMaximaImageFilter::GetFullyConnected ( ) const

Definition at line 80 of file sitkValuedRegionalMaximaImageFilter.h.

◆ GetName()

std::string itk::simple::ValuedRegionalMaximaImageFilter::GetName ( ) const

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 91 of file sitkValuedRegionalMaximaImageFilter.h.

◆ SetFullyConnected()

Self& itk::simple::ValuedRegionalMaximaImageFilter::SetFullyConnected ( bool  FullyConnected)

Definition at line 72 of file sitkValuedRegionalMaximaImageFilter.h.

◆ ToString()

std::string itk::simple::ValuedRegionalMaximaImageFilter::ToString ( ) const

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 109 of file sitkValuedRegionalMaximaImageFilter.h.

Member Data Documentation

◆ m_Flat

bool itk::simple::ValuedRegionalMaximaImageFilter::m_Flat {false}

Definition at line 117 of file sitkValuedRegionalMaximaImageFilter.h.

◆ m_FullyConnected

bool itk::simple::ValuedRegionalMaximaImageFilter::m_FullyConnected {false}

Definition at line 114 of file sitkValuedRegionalMaximaImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ValuedRegionalMaximaImageFilter::m_MemberFactory

Definition at line 111 of file sitkValuedRegionalMaximaImageFilter.h.

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