Label pixels that are connected to a seed and lie within a neighborhood. More...

#include <sitkNeighborhoodConnectedImageFilter.h>

Inheritance diagram for itk::simple::NeighborhoodConnectedImageFilter:

Collaboration diagram for itk::simple::NeighborhoodConnectedImageFilter:

Detailed Description

Label pixels that are connected to a seed and lie within a neighborhood.

NeighborhoodConnectedImageFilter labels pixels with ReplaceValue that are connected to an initial Seed AND whose neighbors all lie within a Lower and Upper threshold range.

See also: itk::simple::NeighborhoodConnected for the procedural interface; itk::NeighborhoodConnectedImageFilter for the Doxygen on the original ITK class.

Examples: Segmentation/NeighborhoodConnectedImageFilter.cxx.

Definition at line 44 of file sitkNeighborhoodConnectedImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList

using	Self = NeighborhoodConnectedImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
void	AddSeed (std::vector< unsigned int > point)
	Add SeedList point.

void	ClearSeeds ()
	Remove all SeedList points.

Image	Execute (const Image &image1)

double	GetLower () const

std::string	GetName () const

std::vector< unsigned int >	GetRadius () const

double	GetReplaceValue () const

std::vector< std::vector< unsigned int > >	GetSeedList () const
	Get list of seeds.

double	GetUpper () const

	NeighborhoodConnectedImageFilter ()

void	SetLower (double Lower)

void	SetRadius (std::vector< unsigned int > Radius)

void	SetRadius (unsigned int value)

void	SetReplaceValue (double ReplaceValue)

void	SetSeedList (std::vector< std::vector< unsigned int > > SeedList)
	Set list of image indexes for seeds.

void	SetUpper (double Upper)

std::string	ToString () const

virtual	~NeighborhoodConnectedImageFilter ()

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)

Static Private Member Functions
static const detail::MemberFunctionFactory< MemberFunctionType > &	GetMemberFunctionFactory ()

Private Attributes
double	m_Lower { 0 }

std::vector< unsigned int >	m_Radius { std::vector<unsigned int>(3, 1) }

double	m_ReplaceValue { 1 }

std::vector< std::vector< unsigned int > >	m_SeedList { std::vector< std::vector<unsigned int > >() }

double	m_Upper { 1 }

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

private

Setup for member function dispatching

Definition at line 151 of file sitkNeighborhoodConnectedImageFilter.h.

◆ PixelIDTypeList

using itk::simple::NeighborhoodConnectedImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 56 of file sitkNeighborhoodConnectedImageFilter.h.

◆ Self

using itk::simple::NeighborhoodConnectedImageFilter::Self = NeighborhoodConnectedImageFilter

Definition at line 46 of file sitkNeighborhoodConnectedImageFilter.h.

Constructor & Destructor Documentation

◆ ~NeighborhoodConnectedImageFilter()

virtual itk::simple::NeighborhoodConnectedImageFilter::~NeighborhoodConnectedImageFilter ( )

virtual

Destructor

◆ NeighborhoodConnectedImageFilter()

itk::simple::NeighborhoodConnectedImageFilter::NeighborhoodConnectedImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ AddSeed()

void itk::simple::NeighborhoodConnectedImageFilter::AddSeed ( std::vector< unsigned int > point )

inline

Add SeedList point.

Examples: Segmentation/NeighborhoodConnectedImageFilter.cxx.

Definition at line 74 of file sitkNeighborhoodConnectedImageFilter.h.

References m_SeedList.

◆ ClearSeeds()

void itk::simple::NeighborhoodConnectedImageFilter::ClearSeeds ( )

inline

Remove all SeedList points.

Definition at line 77 of file sitkNeighborhoodConnectedImageFilter.h.

References m_SeedList.

◆ Execute()

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

Execute the filter on the input image

Examples: Segmentation/NeighborhoodConnectedImageFilter.cxx.

◆ ExecuteInternal()

template<class TImageType>

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

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

◆ GetLower()

double itk::simple::NeighborhoodConnectedImageFilter::GetLower ( ) const

inline

Set/Get the lower threshold. The default is 0.

Definition at line 90 of file sitkNeighborhoodConnectedImageFilter.h.

References m_Lower.

◆ GetMemberFunctionFactory()

static const detail::MemberFunctionFactory< MemberFunctionType > & itk::simple::NeighborhoodConnectedImageFilter::GetMemberFunctionFactory ( )

staticprivate

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 139 of file sitkNeighborhoodConnectedImageFilter.h.

◆ GetRadius()

std::vector< unsigned int > itk::simple::NeighborhoodConnectedImageFilter::GetRadius ( ) const

inline

Get the radius of the neighborhood used to compute the median

Definition at line 120 of file sitkNeighborhoodConnectedImageFilter.h.

References m_Radius.

◆ GetReplaceValue()

double itk::simple::NeighborhoodConnectedImageFilter::GetReplaceValue ( ) const

inline

Set/Get value to replace thresholded pixels. Pixels that lie * within Lower and Upper (inclusive) will be replaced with this value. The default is 1.

Definition at line 135 of file sitkNeighborhoodConnectedImageFilter.h.

References m_ReplaceValue.

◆ GetSeedList()

std::vector< std::vector< unsigned int > > itk::simple::NeighborhoodConnectedImageFilter::GetSeedList ( ) const

inline

Get list of seeds.

Definition at line 71 of file sitkNeighborhoodConnectedImageFilter.h.

References m_SeedList.

◆ GetUpper()

double itk::simple::NeighborhoodConnectedImageFilter::GetUpper ( ) const

inline

Set/Get the upper threshold. The default is the largest possible value for the InputPixelType.

Definition at line 103 of file sitkNeighborhoodConnectedImageFilter.h.

References m_Upper.

◆ SetLower()

void itk::simple::NeighborhoodConnectedImageFilter::SetLower ( double Lower )

inline

Set/Get the lower threshold. The default is 0.

Examples: Segmentation/NeighborhoodConnectedImageFilter.cxx.

Definition at line 84 of file sitkNeighborhoodConnectedImageFilter.h.

References m_Lower.

◆ SetRadius() [1/2]

void itk::simple::NeighborhoodConnectedImageFilter::SetRadius ( std::vector< unsigned int > Radius )

inline

Set the radius of the neighborhood used for a mask.

Examples: Segmentation/NeighborhoodConnectedImageFilter.cxx.

Definition at line 110 of file sitkNeighborhoodConnectedImageFilter.h.

References m_Radius.

◆ SetRadius() [2/2]

void itk::simple::NeighborhoodConnectedImageFilter::SetRadius ( unsigned int value )

inline

Set the values of the Radius vector all to value

Definition at line 115 of file sitkNeighborhoodConnectedImageFilter.h.

References m_Radius.

◆ SetReplaceValue()

void itk::simple::NeighborhoodConnectedImageFilter::SetReplaceValue ( double ReplaceValue )

inline

Set/Get value to replace thresholded pixels. Pixels that lie * within Lower and Upper (inclusive) will be replaced with this value. The default is 1.

Examples: Segmentation/NeighborhoodConnectedImageFilter.cxx.

Definition at line 128 of file sitkNeighborhoodConnectedImageFilter.h.

References m_ReplaceValue.

◆ SetSeedList()

void itk::simple::NeighborhoodConnectedImageFilter::SetSeedList ( std::vector< std::vector< unsigned int > > SeedList )

inline

Set list of image indexes for seeds.

Definition at line 65 of file sitkNeighborhoodConnectedImageFilter.h.

References m_SeedList.

◆ SetUpper()

void itk::simple::NeighborhoodConnectedImageFilter::SetUpper ( double Upper )

inline

Set/Get the upper threshold. The default is the largest possible value for the InputPixelType.

Examples: Segmentation/NeighborhoodConnectedImageFilter.cxx.

Definition at line 97 of file sitkNeighborhoodConnectedImageFilter.h.

References m_Upper.

◆ ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 152 of file sitkNeighborhoodConnectedImageFilter.h.

References ExecuteInternal().

Member Data Documentation

◆ m_Lower

double itk::simple::NeighborhoodConnectedImageFilter::m_Lower { 0 }

private

Definition at line 159 of file sitkNeighborhoodConnectedImageFilter.h.

Referenced by GetLower(), and SetLower().

◆ m_Radius

std::vector<unsigned int> itk::simple::NeighborhoodConnectedImageFilter::m_Radius { std::vector<unsigned int>(3, 1) }

private

Definition at line 164 of file sitkNeighborhoodConnectedImageFilter.h.

Referenced by GetRadius(), SetRadius(), and SetRadius().

◆ m_ReplaceValue

double itk::simple::NeighborhoodConnectedImageFilter::m_ReplaceValue { 1 }

private

Definition at line 168 of file sitkNeighborhoodConnectedImageFilter.h.

Referenced by GetReplaceValue(), and SetReplaceValue().

◆ m_SeedList

std::vector< std::vector<unsigned int> > itk::simple::NeighborhoodConnectedImageFilter::m_SeedList { std::vector< std::vector<unsigned int > >() }

private

Definition at line 157 of file sitkNeighborhoodConnectedImageFilter.h.

Referenced by AddSeed(), ClearSeeds(), GetSeedList(), and SetSeedList().

◆ m_Upper

double itk::simple::NeighborhoodConnectedImageFilter::m_Upper { 1 }

private

Definition at line 161 of file sitkNeighborhoodConnectedImageFilter.h.

Referenced by GetUpper(), and SetUpper().

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

sitkNeighborhoodConnectedImageFilter.h

Detailed Description

Public Types

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~NeighborhoodConnectedImageFilter()

◆ NeighborhoodConnectedImageFilter()

Member Function Documentation

◆ AddSeed()

◆ ClearSeeds()

◆ Execute()

◆ ExecuteInternal()

◆ GetLower()

◆ GetMemberFunctionFactory()

◆ GetName()

◆ GetRadius()

◆ GetReplaceValue()

◆ GetSeedList()

◆ GetUpper()

◆ SetLower()

◆ SetRadius() [1/2]

◆ SetRadius() [2/2]

◆ SetReplaceValue()

◆ SetSeedList()

◆ SetUpper()

◆ ToString()

Friends And Related Symbol Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_Lower

◆ m_Radius

◆ m_ReplaceValue

◆ m_SeedList

◆ m_Upper