Labels the pixels on the border of the objects in a binary image. More...

#include <sitkBinaryContourImageFilter.h>

Inheritance diagram for itk::simple::BinaryContourImageFilter:

Collaboration diagram for itk::simple::BinaryContourImageFilter:

Detailed Description

Labels the pixels on the border of the objects in a binary image.

BinaryContourImageFilter takes a binary image as input, where the pixels in the objects are the pixels with a value equal to ForegroundValue. Only the pixels on the contours of the objects are kept. The pixels not on the border are changed to BackgroundValue.

The connectivity can be changed to minimum or maximum connectivity with SetFullyConnected() . Full connectivity produces thicker contours.

https://doi.org/10.54294/c7d3gv

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

See also: LabelContourImageFilter BinaryErodeImageFilter SimpleContourExtractorImageFilter; itk::simple::BinaryContour for the procedural interface; itk::BinaryContourImageFilter for the Doxygen on the original ITK class.

Definition at line 50 of file sitkBinaryContourImageFilter.h.

Public Types
using	PixelIDTypeList = IntegerPixelIDTypeList

using	Self = BinaryContourImageFilter

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

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

Public Member Functions
	BinaryContourImageFilter ()

Image	Execute (const Image &image1)

Image	Execute (Image &&image1)

Self &	FullyConnectedOff ()

Self &	FullyConnectedOn ()

double	GetBackgroundValue () const

double	GetForegroundValue () const

bool	GetFullyConnected () const

std::string	GetName () const

Self &	SetBackgroundValue (double BackgroundValue)

Self &	SetForegroundValue (double ForegroundValue)

Self &	SetFullyConnected (bool FullyConnected)

std::string	ToString () const

virtual	~BinaryContourImageFilter ()

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}

double	m_ForegroundValue {1.0}

bool	m_FullyConnected {false}

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

private

Setup for member function dispatching

Definition at line 116 of file sitkBinaryContourImageFilter.h.

◆ PixelIDTypeList

using itk::simple::BinaryContourImageFilter::PixelIDTypeList = IntegerPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 62 of file sitkBinaryContourImageFilter.h.

◆ Self

using itk::simple::BinaryContourImageFilter::Self = BinaryContourImageFilter

Definition at line 52 of file sitkBinaryContourImageFilter.h.

Constructor & Destructor Documentation

◆ ~BinaryContourImageFilter()

virtual itk::simple::BinaryContourImageFilter::~BinaryContourImageFilter ( )

virtual

Destructor

◆ BinaryContourImageFilter()

itk::simple::BinaryContourImageFilter::BinaryContourImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

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

◆ Execute() [2/2]

Image itk::simple::BinaryContourImageFilter::Execute ( Image && image1 )

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

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

private

◆ FullyConnectedOff()

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

inline

Definition at line 72 of file sitkBinaryContourImageFilter.h.

◆ FullyConnectedOn()

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

inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 71 of file sitkBinaryContourImageFilter.h.

◆ GetBackgroundValue()

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

inline

Set/Get the background value used to mark the pixels not on the border of the objects.

Definition at line 87 of file sitkBinaryContourImageFilter.h.

◆ GetForegroundValue()

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

inline

Set/Get the foreground value used to identify the objects in the input and output images.

Definition at line 97 of file sitkBinaryContourImageFilter.h.

◆ GetFullyConnected()

bool itk::simple::BinaryContourImageFilter::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 77 of file sitkBinaryContourImageFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 100 of file sitkBinaryContourImageFilter.h.

◆ SetBackgroundValue()

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

inline

Set/Get the background value used to mark the pixels not on the border of the objects.

Definition at line 82 of file sitkBinaryContourImageFilter.h.

◆ SetForegroundValue()

Self& itk::simple::BinaryContourImageFilter::SetForegroundValue ( double ForegroundValue )

inline

Set/Get the foreground value used to identify the objects in the input and output images.

Definition at line 92 of file sitkBinaryContourImageFilter.h.

◆ SetFullyConnected()

Self& itk::simple::BinaryContourImageFilter::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 68 of file sitkBinaryContourImageFilter.h.