Opening by reconstruction of an image. More...

#include <sitkOpeningByReconstructionImageFilter.h>

Inheritance diagram for itk::simple::OpeningByReconstructionImageFilter:

Collaboration diagram for itk::simple::OpeningByReconstructionImageFilter:

Public Types
enum	KernelType { Annulus =sitkAnnulus, Ball =sitkBall, Box =sitkBox, Cross =sitkCross }

typedef BasicPixelIDTypeList	PixelIDTypeList

typedef OpeningByReconstructionImageFilter	Self

Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image1)

Image	Execute (const Image &image1, bool fullyConnected, bool preserveIntensities)

Self &	FullyConnectedOff ()

Self &	FullyConnectedOn ()

bool	GetFullyConnected () const

std::vector< uint32_t >	GetKernelRadius () const

KernelEnum	GetKernelType () const

std::string	GetName () const

bool	GetPreserveIntensities () const

	OpeningByReconstructionImageFilter ()

Self &	PreserveIntensitiesOff ()

Self &	PreserveIntensitiesOn ()

Self &	SetFullyConnected (bool FullyConnected)

Self &	SetKernelRadius (uint32_t r)

Self &	SetKernelRadius (const std::vector< uint32_t > &r)

Self &	SetKernelType (KernelEnum t)

Self &	SetKernelType (KernelType t)

Self &	SetPreserveIntensities (bool PreserveIntensities)

std::string	ToString () const

virtual	~OpeningByReconstructionImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

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

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
bool	m_FullyConnected

std::vector< uint32_t >	m_KernelRadius

KernelEnum	m_KernelType

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

bool	m_PreserveIntensities

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 void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

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...

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) SITK_NOEXCEPT

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image	CastITKToImage (TImageType *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)

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)

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 mophological 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) = DilationByRecontruction(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 54 of file sitkOpeningByReconstructionImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::OpeningByReconstructionImageFilter::MemberFunctionType) (const Image &image1)

private

Setup for member function dispatching

Definition at line 140 of file sitkOpeningByReconstructionImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::OpeningByReconstructionImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 66 of file sitkOpeningByReconstructionImageFilter.h.

typedef OpeningByReconstructionImageFilter itk::simple::OpeningByReconstructionImageFilter::Self

Definition at line 56 of file sitkOpeningByReconstructionImageFilter.h.

Member Enumeration Documentation

enum itk::simple::OpeningByReconstructionImageFilter::KernelType

Kernel type enumeration

Enumerator
Annulus
Ball
Box
Cross

Definition at line 69 of file sitkOpeningByReconstructionImageFilter.h.

Constructor & Destructor Documentation

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

virtual

Destructor

itk::simple::OpeningByReconstructionImageFilter::OpeningByReconstructionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::OpeningByReconstructionImageFilter::Execute	(	const Image &	image1,
		bool	fullyConnected,
		bool	preserveIntensities
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

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

inline

Definition at line 80 of file sitkOpeningByReconstructionImageFilter.h.

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

inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 79 of file sitkOpeningByReconstructionImageFilter.h.

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 85 of file sitkOpeningByReconstructionImageFilter.h.

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

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

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 122 of file sitkOpeningByReconstructionImageFilter.h.

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 reconstrcution. If Off, the output pixel contrast will be reduced.

Definition at line 99 of file sitkOpeningByReconstructionImageFilter.h.

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

inline

Definition at line 94 of file sitkOpeningByReconstructionImageFilter.h.

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

inline

Set the value of PreserveIntensities to true or false respectfully.

Definition at line 93 of file sitkOpeningByReconstructionImageFilter.h.

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 76 of file sitkOpeningByReconstructionImageFilter.h.

Self& itk::simple::OpeningByReconstructionImageFilter::SetKernelRadius ( uint32_t r )

Kernel radius as a scale for isotropic structures

Self& itk::simple::OpeningByReconstructionImageFilter::SetKernelRadius ( const std::vector< uint32_t > & r )

Set/Get the radius of the kernel structuring element as a vector.

If the dimension of the image is greater then the length of r, then the radius will be padded. If it is less the r will be truncated.

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

Set/Get the kernel or structuring elemenent used for the morphology

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

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 reconstrcution. If Off, the output pixel contrast will be reduced.

Definition at line 90 of file sitkOpeningByReconstructionImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.