SimpleITK  
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ValuedRegionalMinimaImageFilter Class Reference

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

#include <sitkValuedRegionalMinimaImageFilter.h>

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

Detailed Description

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

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

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

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

Definition at line 51 of file sitkValuedRegionalMinimaImageFilter.h.

Public Types

using PixelIDTypeList = ScalarPixelIDTypeList
 
using Self = ValuedRegionalMinimaImageFilter
 
- 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
 
 ValuedRegionalMinimaImageFilter ()
 
virtual ~ValuedRegionalMinimaImageFilter ()
 
- 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
 

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<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< 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)
 

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 101 of file sitkValuedRegionalMinimaImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 63 of file sitkValuedRegionalMinimaImageFilter.h.

◆ Self

Definition at line 53 of file sitkValuedRegionalMinimaImageFilter.h.

Constructor & Destructor Documentation

◆ ~ValuedRegionalMinimaImageFilter()

virtual itk::simple::ValuedRegionalMinimaImageFilter::~ValuedRegionalMinimaImageFilter ( )
virtual

Destructor

◆ ValuedRegionalMinimaImageFilter()

itk::simple::ValuedRegionalMinimaImageFilter::ValuedRegionalMinimaImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ FullyConnectedOff()

Self& itk::simple::ValuedRegionalMinimaImageFilter::FullyConnectedOff ( )
inline

Definition at line 72 of file sitkValuedRegionalMinimaImageFilter.h.

◆ FullyConnectedOn()

Self& itk::simple::ValuedRegionalMinimaImageFilter::FullyConnectedOn ( )
inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 71 of file sitkValuedRegionalMinimaImageFilter.h.

◆ GetFlat()

bool itk::simple::ValuedRegionalMinimaImageFilter::GetFlat ( ) const
inline

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 83 of file sitkValuedRegionalMinimaImageFilter.h.

◆ GetFullyConnected()

bool itk::simple::ValuedRegionalMinimaImageFilter::GetFullyConnected ( ) const
inline

Definition at line 76 of file sitkValuedRegionalMinimaImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 87 of file sitkValuedRegionalMinimaImageFilter.h.

◆ SetFullyConnected()

Self& itk::simple::ValuedRegionalMinimaImageFilter::SetFullyConnected ( bool  FullyConnected)
inline

Definition at line 68 of file sitkValuedRegionalMinimaImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 105 of file sitkValuedRegionalMinimaImageFilter.h.

Member Data Documentation

◆ m_Flat

bool itk::simple::ValuedRegionalMinimaImageFilter::m_Flat {false}
private

Definition at line 113 of file sitkValuedRegionalMinimaImageFilter.h.

◆ m_FullyConnected

bool itk::simple::ValuedRegionalMinimaImageFilter::m_FullyConnected {false}
private

Definition at line 110 of file sitkValuedRegionalMinimaImageFilter.h.

◆ m_MemberFactory

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

Definition at line 107 of file sitkValuedRegionalMinimaImageFilter.h.


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