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

#include <sitkRegionalMinimaImageFilter.h>

Inheritance diagram for itk::simple::RegionalMinimaImageFilter:

Collaboration diagram for itk::simple::RegionalMinimaImageFilter:

Detailed Description

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

Regional minima are flat zones surrounded by pixels of greater value.

If the input image is constant, the entire image can be considered as a minima or not. The SetFlatIsMinima() method let the user choose which behavior to use.

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

See also: RegionalMaximaImageFilter; ValuedRegionalMinimaImageFilter; HConcaveImageFilter; itk::simple::RegionalMinima for the procedural interface; itk::RegionalMinimaImageFilter for the Doxygen on the original ITK class.

Definition at line 54 of file sitkRegionalMinimaImageFilter.h.

Public Types
using	PixelIDTypeList = ScalarPixelIDTypeList

using	Self = RegionalMinimaImageFilter

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 &	FlatIsMinimaOff ()

Self &	FlatIsMinimaOn ()

Self &	FullyConnectedOff ()

Self &	FullyConnectedOn ()

double	GetBackgroundValue () const

bool	GetFlatIsMinima () const

double	GetForegroundValue () const

bool	GetFullyConnected () const

std::string	GetName () const

	RegionalMinimaImageFilter ()

Self &	SetBackgroundValue (double BackgroundValue)

Self &	SetFlatIsMinima (bool FlatIsMinima)

Self &	SetForegroundValue (double ForegroundValue)

Self &	SetFullyConnected (bool FullyConnected)

std::string	ToString () const

virtual	~RegionalMinimaImageFilter ()

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_FlatIsMinima {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::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::RegionalMinimaImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 132 of file sitkRegionalMinimaImageFilter.h.

◆ PixelIDTypeList

using itk::simple::RegionalMinimaImageFilter::PixelIDTypeList = ScalarPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 66 of file sitkRegionalMinimaImageFilter.h.

◆ Self

using itk::simple::RegionalMinimaImageFilter::Self = RegionalMinimaImageFilter

Definition at line 56 of file sitkRegionalMinimaImageFilter.h.

Constructor & Destructor Documentation

◆ ~RegionalMinimaImageFilter()

virtual itk::simple::RegionalMinimaImageFilter::~RegionalMinimaImageFilter ( )

virtual

Destructor

◆ RegionalMinimaImageFilter()

itk::simple::RegionalMinimaImageFilter::RegionalMinimaImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::RegionalMinimaImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

Image itk::simple::RegionalMinimaImageFilter::ExecuteInternal ( const Image & image1 )

private

◆ FlatIsMinimaOff()

Self& itk::simple::RegionalMinimaImageFilter::FlatIsMinimaOff ( )

inline

Definition at line 110 of file sitkRegionalMinimaImageFilter.h.

◆ FlatIsMinimaOn()

Self& itk::simple::RegionalMinimaImageFilter::FlatIsMinimaOn ( )

inline

Set the value of FlatIsMinima to true or false respectfully.

Definition at line 109 of file sitkRegionalMinimaImageFilter.h.

◆ FullyConnectedOff()

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

inline

Definition at line 96 of file sitkRegionalMinimaImageFilter.h.

◆ FullyConnectedOn()

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

inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 95 of file sitkRegionalMinimaImageFilter.h.

◆ GetBackgroundValue()

double itk::simple::RegionalMinimaImageFilter::GetBackgroundValue ( ) const

inline

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

Definition at line 77 of file sitkRegionalMinimaImageFilter.h.

◆ GetFlatIsMinima()

bool itk::simple::RegionalMinimaImageFilter::GetFlatIsMinima ( ) const

inline

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

Definition at line 115 of file sitkRegionalMinimaImageFilter.h.

◆ GetForegroundValue()

double itk::simple::RegionalMinimaImageFilter::GetForegroundValue ( ) const

inline

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

Definition at line 87 of file sitkRegionalMinimaImageFilter.h.

◆ GetFullyConnected()

bool itk::simple::RegionalMinimaImageFilter::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 101 of file sitkRegionalMinimaImageFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 118 of file sitkRegionalMinimaImageFilter.h.

◆ SetBackgroundValue()

Self& itk::simple::RegionalMinimaImageFilter::SetBackgroundValue ( double BackgroundValue )

inline

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

Definition at line 72 of file sitkRegionalMinimaImageFilter.h.

◆ SetFlatIsMinima()

Self& itk::simple::RegionalMinimaImageFilter::SetFlatIsMinima ( bool FlatIsMinima )

inline

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

Definition at line 106 of file sitkRegionalMinimaImageFilter.h.

◆ SetForegroundValue()

Self& itk::simple::RegionalMinimaImageFilter::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 82 of file sitkRegionalMinimaImageFilter.h.

◆ SetFullyConnected()

Self& itk::simple::RegionalMinimaImageFilter::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 92 of file sitkRegionalMinimaImageFilter.h.

◆ ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 136 of file sitkRegionalMinimaImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

double itk::simple::RegionalMinimaImageFilter::m_BackgroundValue {0.0}

private

Definition at line 142 of file sitkRegionalMinimaImageFilter.h.

◆ m_FlatIsMinima

bool itk::simple::RegionalMinimaImageFilter::m_FlatIsMinima {true}

private

Definition at line 150 of file sitkRegionalMinimaImageFilter.h.

◆ m_ForegroundValue

double itk::simple::RegionalMinimaImageFilter::m_ForegroundValue {1.0}

private

Definition at line 145 of file sitkRegionalMinimaImageFilter.h.

◆ m_FullyConnected

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

private

Definition at line 148 of file sitkRegionalMinimaImageFilter.h.

◆ m_MemberFactory

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

private

Definition at line 138 of file sitkRegionalMinimaImageFilter.h.

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

sitkRegionalMinimaImageFilter.h

Detailed Description

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~RegionalMinimaImageFilter()

◆ RegionalMinimaImageFilter()

Member Function Documentation

◆ Execute()

◆ ExecuteInternal()

◆ FlatIsMinimaOff()

◆ FlatIsMinimaOn()

◆ FullyConnectedOff()

◆ FullyConnectedOn()

◆ GetBackgroundValue()

◆ GetFlatIsMinima()

◆ GetForegroundValue()

◆ GetFullyConnected()

◆ GetName()

◆ SetBackgroundValue()

◆ SetFlatIsMinima()

◆ SetForegroundValue()

◆ SetFullyConnected()

◆ ToString()

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_BackgroundValue

◆ m_FlatIsMinima

◆ m_ForegroundValue

◆ m_FullyConnected

◆ m_MemberFactory