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

Produce a binary image where foreground is the regional maxima of the input image. More...

#include <sitkRegionalMaximaImageFilter.h>

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

Public Types

using PixelIDTypeList = ScalarPixelIDTypeList
 
using Self = RegionalMaximaImageFilter
 
- 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)
 
SelfFlatIsMaximaOff ()
 
SelfFlatIsMaximaOn ()
 
SelfFullyConnectedOff ()
 
SelfFullyConnectedOn ()
 
double GetBackgroundValue () const
 
bool GetFlatIsMaxima () const
 
double GetForegroundValue () const
 
bool GetFullyConnected () const
 
std::string GetName () const
 
 RegionalMaximaImageFilter ()
 
SelfSetBackgroundValue (double BackgroundValue)
 
SelfSetFlatIsMaxima (bool FlatIsMaxima)
 
SelfSetForegroundValue (double ForegroundValue)
 
SelfSetFullyConnected (bool FullyConnected)
 
std::string ToString () const
 
virtual ~RegionalMaximaImageFilter ()
 
- 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}
 
bool m_FlatIsMaxima {true}
 
double m_ForegroundValue {1.0}
 
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<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

Produce a binary image where foreground is the regional maxima of the input image.

Regional maxima are flat zones surrounded by pixels of lower value.

If the input image is constant, the entire image can be considered as a maxima or not. The desired behavior can be selected with the SetFlatIsMaxima() method.

Author
Gaetan Lehmann

This class was contributed to the Insight Journal by author Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. The paper can be found at https://hdl.handle.net/1926/153

See also
ValuedRegionalMaximaImageFilter
HConvexImageFilter
RegionalMinimaImageFilter
itk::simple::RegionalMaxima for the procedural interface
itk::RegionalMaximaImageFilter for the Doxygen on the original ITK class.

Definition at line 57 of file sitkRegionalMaximaImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 135 of file sitkRegionalMaximaImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 69 of file sitkRegionalMaximaImageFilter.h.

◆ Self

Definition at line 59 of file sitkRegionalMaximaImageFilter.h.

Constructor & Destructor Documentation

◆ ~RegionalMaximaImageFilter()

virtual itk::simple::RegionalMaximaImageFilter::~RegionalMaximaImageFilter ( )
virtual

Destructor

◆ RegionalMaximaImageFilter()

itk::simple::RegionalMaximaImageFilter::RegionalMaximaImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ FlatIsMaximaOff()

Self& itk::simple::RegionalMaximaImageFilter::FlatIsMaximaOff ( )
inline

Definition at line 113 of file sitkRegionalMaximaImageFilter.h.

◆ FlatIsMaximaOn()

Self& itk::simple::RegionalMaximaImageFilter::FlatIsMaximaOn ( )
inline

Set the value of FlatIsMaxima to true or false respectfully.

Definition at line 112 of file sitkRegionalMaximaImageFilter.h.

◆ FullyConnectedOff()

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

Definition at line 99 of file sitkRegionalMaximaImageFilter.h.

◆ FullyConnectedOn()

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

Set the value of FullyConnected to true or false respectfully.

Definition at line 98 of file sitkRegionalMaximaImageFilter.h.

◆ GetBackgroundValue()

double itk::simple::RegionalMaximaImageFilter::GetBackgroundValue ( ) const
inline

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() .

Definition at line 80 of file sitkRegionalMaximaImageFilter.h.

◆ GetFlatIsMaxima()

bool itk::simple::RegionalMaximaImageFilter::GetFlatIsMaxima ( ) const
inline

Set/Get wether a flat image must be considered as a maxima or not. Defaults to true.

Definition at line 118 of file sitkRegionalMaximaImageFilter.h.

◆ GetForegroundValue()

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

Set/Get the value in the output image to consider as "foreground". Defaults to maximum value of PixelType.

Definition at line 90 of file sitkRegionalMaximaImageFilter.h.

◆ GetFullyConnected()

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

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 104 of file sitkRegionalMaximaImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 121 of file sitkRegionalMaximaImageFilter.h.

◆ SetBackgroundValue()

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

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() .

Definition at line 75 of file sitkRegionalMaximaImageFilter.h.

◆ SetFlatIsMaxima()

Self& itk::simple::RegionalMaximaImageFilter::SetFlatIsMaxima ( bool  FlatIsMaxima)
inline

Set/Get whether a flat image must be considered as a maxima or not. Defaults to true.

Definition at line 109 of file sitkRegionalMaximaImageFilter.h.

◆ SetForegroundValue()

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

Set/Get the value in the output image to consider as "foreground". Defaults to maximum value of PixelType.

Definition at line 85 of file sitkRegionalMaximaImageFilter.h.

◆ SetFullyConnected()

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

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 95 of file sitkRegionalMaximaImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 139 of file sitkRegionalMaximaImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

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

Definition at line 145 of file sitkRegionalMaximaImageFilter.h.

◆ m_FlatIsMaxima

bool itk::simple::RegionalMaximaImageFilter::m_FlatIsMaxima {true}
private

Definition at line 153 of file sitkRegionalMaximaImageFilter.h.

◆ m_ForegroundValue

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

Definition at line 148 of file sitkRegionalMaximaImageFilter.h.

◆ m_FullyConnected

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

Definition at line 151 of file sitkRegionalMaximaImageFilter.h.

◆ m_MemberFactory

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

Definition at line 141 of file sitkRegionalMaximaImageFilter.h.


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