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:

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://doi.org/10.54294/hva3gz

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 56 of file sitkRegionalMaximaImageFilter.h.

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)

Self &	FlatIsMaximaOff ()

Self &	FlatIsMaximaOn ()

Self &	FullyConnectedOff ()

Self &	FullyConnectedOn ()

double	GetBackgroundValue () const

bool	GetFlatIsMaxima () const

double	GetForegroundValue () const

bool	GetFullyConnected () const

std::string	GetName () const

	RegionalMaximaImageFilter ()

Self &	SetBackgroundValue (double BackgroundValue)

Self &	SetFlatIsMaxima (bool FlatIsMaxima)

Self &	SetForegroundValue (double ForegroundValue)

Self &	SetFullyConnected (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.

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.

virtual float	GetProgress () const
	An Active Measurement of the progress of execution.

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands.

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.

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.

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::ProcessObject *	GetActiveProcess ()

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

NonCopyable &	operator= (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::EventObject &	GetITKEventObject (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

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

private

Setup for member function dispatching

Definition at line 134 of file sitkRegionalMaximaImageFilter.h.

◆ PixelIDTypeList

using itk::simple::RegionalMaximaImageFilter::PixelIDTypeList = ScalarPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 68 of file sitkRegionalMaximaImageFilter.h.

◆ Self

using itk::simple::RegionalMaximaImageFilter::Self = RegionalMaximaImageFilter

Definition at line 58 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

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

◆ FlatIsMaximaOff()

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

inline

Definition at line 112 of file sitkRegionalMaximaImageFilter.h.

References SetFlatIsMaxima().

◆ FlatIsMaximaOn()

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

inline

Set the value of FlatIsMaxima to true or false respectfully.

Definition at line 111 of file sitkRegionalMaximaImageFilter.h.

References SetFlatIsMaxima().

◆ FullyConnectedOff()

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

inline

Definition at line 98 of file sitkRegionalMaximaImageFilter.h.

References SetFullyConnected().

◆ FullyConnectedOn()

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

inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 97 of file sitkRegionalMaximaImageFilter.h.

References SetFullyConnected().

◆ 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 79 of file sitkRegionalMaximaImageFilter.h.

References m_BackgroundValue.

◆ GetFlatIsMaxima()

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

inline

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

Definition at line 117 of file sitkRegionalMaximaImageFilter.h.

References m_FlatIsMaxima.

◆ 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 89 of file sitkRegionalMaximaImageFilter.h.

References m_ForegroundValue.

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

References m_FullyConnected.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 120 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 74 of file sitkRegionalMaximaImageFilter.h.

References m_BackgroundValue.

◆ 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 108 of file sitkRegionalMaximaImageFilter.h.

References m_FlatIsMaxima.

Referenced by FlatIsMaximaOff(), and FlatIsMaximaOn().

◆ 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 84 of file sitkRegionalMaximaImageFilter.h.

References m_ForegroundValue.

◆ 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 94 of file sitkRegionalMaximaImageFilter.h.

References m_FullyConnected.

Referenced by FullyConnectedOff(), and FullyConnectedOn().