itk::simple::OpeningByReconstructionImageFilter Class Reference

Opening by reconstruction of an image. More...

#include <sitkOpeningByReconstructionImageFilter.h>

Inheritance diagram for itk::simple::OpeningByReconstructionImageFilter:

Collaboration diagram for itk::simple::OpeningByReconstructionImageFilter:

Detailed Description

Opening by reconstruction of an image.

This filter preserves regions, in the foreground, that can completely contain the structuring element. At the same time, this filter eliminates all other regions of foreground pixels. Contrary to the morphological opening, the opening by reconstruction preserves the shape of the components that are not removed by erosion. The opening by reconstruction of an image "f" is defined as:

OpeningByReconstruction(f) = DilationByReconstruction(f, Erosion(f)).

Opening by reconstruction not only removes structures destroyed by the erosion, but also levels down the contrast of the brightest regions. If PreserveIntensities is on, a subsequent reconstruction by dilation using a marker image that is the original image for all unaffected pixels.

Opening by reconstruction is described in Chapter 6.3.9 of Pierre Soille's book "Morphological Image Analysis: Principles and Applications", Second Edition, Springer, 2003.

Author

Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See also

GrayscaleMorphologicalOpeningImageFilter

itk::simple::OpeningByReconstruction for the procedural interface

itk::OpeningByReconstructionImageFilter for the Doxygen on the original ITK class.

Definition at line 53 of file sitkOpeningByReconstructionImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList
using	Self = OpeningByReconstructionImageFilter
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 &	FullyConnectedOff ()
Self &	FullyConnectedOn ()
bool	GetFullyConnected () const
std::vector< unsigned int >	GetKernelRadius () const
KernelEnum	GetKernelType () const
std::string	GetName () const
bool	GetPreserveIntensities () const
	OpeningByReconstructionImageFilter ()
Self &	PreserveIntensitiesOff ()
Self &	PreserveIntensitiesOn ()
Self &	SetFullyConnected (bool FullyConnected)
Self &	SetKernelRadius (std::vector< unsigned int > KernelRadius)
Self &	SetKernelRadius (unsigned int value)
Self &	SetKernelType (KernelEnum KernelType)
Self &	SetPreserveIntensities (bool PreserveIntensities)
std::string	ToString () const
virtual	~OpeningByReconstructionImageFilter ()
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_FullyConnected {false}
std::vector< unsigned int >	m_KernelRadius {std::vector<uint32_t>(3, 1)}
KernelEnum	m_KernelType {itk::simple::sitkBall}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
bool	m_PreserveIntensities {false}

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

private

Setup for member function dispatching

Definition at line 134 of file sitkOpeningByReconstructionImageFilter.h.

PixelIDTypeList

using itk::simple::OpeningByReconstructionImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 65 of file sitkOpeningByReconstructionImageFilter.h.

Self

using itk::simple::OpeningByReconstructionImageFilter::Self = OpeningByReconstructionImageFilter

Definition at line 55 of file sitkOpeningByReconstructionImageFilter.h.

Constructor & Destructor Documentation

~OpeningByReconstructionImageFilter()

virtual itk::simple::OpeningByReconstructionImageFilter::~OpeningByReconstructionImageFilter ( )

virtual

Destructor

OpeningByReconstructionImageFilter()

itk::simple::OpeningByReconstructionImageFilter::OpeningByReconstructionImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

Image itk::simple::OpeningByReconstructionImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType >

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

private

FullyConnectedOff()

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

inline

Definition at line 98 of file sitkOpeningByReconstructionImageFilter.h.

FullyConnectedOn()

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

inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 97 of file sitkOpeningByReconstructionImageFilter.h.

GetFullyConnected()

bool itk::simple::OpeningByReconstructionImageFilter::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 sitkOpeningByReconstructionImageFilter.h.

GetKernelRadius()

std::vector<unsigned int> itk::simple::OpeningByReconstructionImageFilter::GetKernelRadius ( ) const

inline

Get the radius of the kernel structuring element.

Definition at line 79 of file sitkOpeningByReconstructionImageFilter.h.

GetKernelType()

KernelEnum itk::simple::OpeningByReconstructionImageFilter::GetKernelType ( ) const

inline

Get the kernel or structuring element used for the morphology.

Definition at line 89 of file sitkOpeningByReconstructionImageFilter.h.

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 120 of file sitkOpeningByReconstructionImageFilter.h.

GetPreserveIntensities()

bool itk::simple::OpeningByReconstructionImageFilter::GetPreserveIntensities ( ) const

inline

Set/Get whether the original intensities of the image retained for those pixels unaffected by the opening by reconstruction. If Off, the output pixel contrast will be reduced.

Definition at line 117 of file sitkOpeningByReconstructionImageFilter.h.

PreserveIntensitiesOff()

Self& itk::simple::OpeningByReconstructionImageFilter::PreserveIntensitiesOff ( )

inline

Definition at line 112 of file sitkOpeningByReconstructionImageFilter.h.

PreserveIntensitiesOn()

Self& itk::simple::OpeningByReconstructionImageFilter::PreserveIntensitiesOn ( )

inline

Set the value of PreserveIntensities to true or false respectfully.

Definition at line 111 of file sitkOpeningByReconstructionImageFilter.h.

SetFullyConnected()

Self& itk::simple::OpeningByReconstructionImageFilter::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 sitkOpeningByReconstructionImageFilter.h.

SetKernelRadius() [1/2]

Self& itk::simple::OpeningByReconstructionImageFilter::SetKernelRadius ( std::vector< unsigned int >  KernelRadius )

inline

Set the radius of the kernel structuring element.

Definition at line 71 of file sitkOpeningByReconstructionImageFilter.h.

SetKernelRadius() [2/2]

Self& itk::simple::OpeningByReconstructionImageFilter::SetKernelRadius ( unsigned int  value )

inline

Set the values of the KernelRadius vector all to value

Definition at line 74 of file sitkOpeningByReconstructionImageFilter.h.

SetKernelType()

Self& itk::simple::OpeningByReconstructionImageFilter::SetKernelType ( KernelEnum  KernelType )

inline

Set the kernel or structuring element used for the morphology.

Definition at line 84 of file sitkOpeningByReconstructionImageFilter.h.

SetPreserveIntensities()

Self& itk::simple::OpeningByReconstructionImageFilter::SetPreserveIntensities ( bool  PreserveIntensities )

inline

Set/Get whether the original intensities of the image retained for those pixels unaffected by the opening by reconstruction. If Off, the output pixel contrast will be reduced.

Definition at line 108 of file sitkOpeningByReconstructionImageFilter.h.

ToString()

std::string itk::simple::OpeningByReconstructionImageFilter::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 138 of file sitkOpeningByReconstructionImageFilter.h.

Member Data Documentation

m_FullyConnected

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

private

Definition at line 149 of file sitkOpeningByReconstructionImageFilter.h.

m_KernelRadius

std::vector<unsigned int> itk::simple::OpeningByReconstructionImageFilter::m_KernelRadius {std::vector<uint32_t>(3, 1)}

private

Definition at line 144 of file sitkOpeningByReconstructionImageFilter.h.

m_KernelType

KernelEnum itk::simple::OpeningByReconstructionImageFilter::m_KernelType {itk::simple::sitkBall}

private

Definition at line 146 of file sitkOpeningByReconstructionImageFilter.h.

m_MemberFactory

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

private

Definition at line 140 of file sitkOpeningByReconstructionImageFilter.h.

m_PreserveIntensities

bool itk::simple::OpeningByReconstructionImageFilter::m_PreserveIntensities {false}

private

Definition at line 152 of file sitkOpeningByReconstructionImageFilter.h.

---

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

• sitkOpeningByReconstructionImageFilter.h