SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::NeighborhoodConnectedImageFilter Class Reference

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:

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

SelfAddSeed (std::vector< unsigned int > point)
 Add SeedList point. More...
 
SelfClearSeeds ()
 Remove all SeedList points. More...
 
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. More...
 
double GetUpper () const
 
 NeighborhoodConnectedImageFilter ()
 
SelfSetLower (double Lower)
 
SelfSetRadius (std::vector< unsigned int > Radius)
 
SelfSetRadius (unsigned int value)
 
SelfSetReplaceValue (double ReplaceValue)
 
SelfSetSeedList (std::vector< std::vector< unsigned int > > SeedList)
 Set list of image indexes for seeds. More...
 
SelfSetUpper (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. 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_Lower {0}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
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. 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::ProcessObjectGetActiveProcess ()
 
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
 
NonCopyableoperator= (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<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (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

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 42 of file sitkNeighborhoodConnectedImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 130 of file sitkNeighborhoodConnectedImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 54 of file sitkNeighborhoodConnectedImageFilter.h.

◆ Self

Definition at line 44 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()

Self& itk::simple::NeighborhoodConnectedImageFilter::AddSeed ( std::vector< unsigned int >  point)
inline

Add SeedList point.

Examples
Segmentation/NeighborhoodConnectedImageFilter.cxx.

Definition at line 67 of file sitkNeighborhoodConnectedImageFilter.h.

◆ ClearSeeds()

Self& itk::simple::NeighborhoodConnectedImageFilter::ClearSeeds ( )
inline

Remove all SeedList points.

Definition at line 69 of file sitkNeighborhoodConnectedImageFilter.h.

◆ 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

◆ GetLower()

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

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

Definition at line 80 of file sitkNeighborhoodConnectedImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 116 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 103 of file sitkNeighborhoodConnectedImageFilter.h.

◆ 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 113 of file sitkNeighborhoodConnectedImageFilter.h.

◆ GetSeedList()

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

Get list of seeds.

Definition at line 65 of file sitkNeighborhoodConnectedImageFilter.h.

◆ 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 90 of file sitkNeighborhoodConnectedImageFilter.h.

◆ SetLower()

Self& itk::simple::NeighborhoodConnectedImageFilter::SetLower ( double  Lower)
inline

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

Examples
Segmentation/NeighborhoodConnectedImageFilter.cxx.

Definition at line 75 of file sitkNeighborhoodConnectedImageFilter.h.

◆ SetRadius() [1/2]

Self& 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 95 of file sitkNeighborhoodConnectedImageFilter.h.

◆ SetRadius() [2/2]

Self& itk::simple::NeighborhoodConnectedImageFilter::SetRadius ( unsigned int  value)
inline

Set the values of the Radius vector all to value

Definition at line 98 of file sitkNeighborhoodConnectedImageFilter.h.

◆ SetReplaceValue()

Self& 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 108 of file sitkNeighborhoodConnectedImageFilter.h.

◆ SetSeedList()

Self& itk::simple::NeighborhoodConnectedImageFilter::SetSeedList ( std::vector< std::vector< unsigned int > >  SeedList)
inline

Set list of image indexes for seeds.

Definition at line 60 of file sitkNeighborhoodConnectedImageFilter.h.

◆ SetUpper()

Self& 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 85 of file sitkNeighborhoodConnectedImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 134 of file sitkNeighborhoodConnectedImageFilter.h.

Member Data Documentation

◆ m_Lower

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

Definition at line 141 of file sitkNeighborhoodConnectedImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::NeighborhoodConnectedImageFilter::m_MemberFactory
private

Definition at line 136 of file sitkNeighborhoodConnectedImageFilter.h.

◆ m_Radius

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

Definition at line 146 of file sitkNeighborhoodConnectedImageFilter.h.

◆ m_ReplaceValue

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

Definition at line 150 of file sitkNeighborhoodConnectedImageFilter.h.

◆ m_SeedList

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

Definition at line 139 of file sitkNeighborhoodConnectedImageFilter.h.

◆ m_Upper

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

Definition at line 143 of file sitkNeighborhoodConnectedImageFilter.h.


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