Computes an image of contours which will be the contour of the first image. More...

#include <sitkSimpleContourExtractorImageFilter.h>

Inheritance diagram for itk::simple::SimpleContourExtractorImageFilter:

Collaboration diagram for itk::simple::SimpleContourExtractorImageFilter:

Detailed Description

Computes an image of contours which will be the contour of the first image.

A pixel of the source image is considered to belong to the contour if its pixel value is equal to the input foreground value and it has in its neighborhood at least one pixel which its pixel value is equal to the input background value. The output image will have pixels which will be set to the output foreground value if they belong to the contour, otherwise they will be set to the output background value.

The neighborhood "radius" is set thanks to the radius params.

See also: Image; Neighborhood; NeighborhoodOperator; NeighborhoodIterator; itk::simple::SimpleContourExtractor for the procedural interface; itk::SimpleContourExtractorImageFilter for the Doxygen on the original ITK class.

Definition at line 57 of file sitkSimpleContourExtractorImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList

using	Self = SimpleContourExtractorImageFilter

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)

double	GetInputBackgroundValue () const

double	GetInputForegroundValue () const

std::string	GetName () const

double	GetOutputBackgroundValue () const

double	GetOutputForegroundValue () const

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

void	SetInputBackgroundValue (double InputBackgroundValue)

void	SetInputForegroundValue (double InputForegroundValue)

void	SetOutputBackgroundValue (double OutputBackgroundValue)

void	SetOutputForegroundValue (double OutputForegroundValue)

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

void	SetRadius (unsigned int value)

	SimpleContourExtractorImageFilter ()

std::string	ToString () const

virtual	~SimpleContourExtractorImageFilter ()

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_InputBackgroundValue { 0.0 }

double	m_InputForegroundValue { 1.0 }

double	m_OutputBackgroundValue { 0.0 }

double	m_OutputForegroundValue { 1.0 }

std::vector< unsigned int >	m_Radius { std::vector<unsigned int>(3, 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::SimpleContourExtractorImageFilter::MemberFunctionType = Image (Self::*)(const Image &image1)

private

Setup for member function dispatching

Definition at line 154 of file sitkSimpleContourExtractorImageFilter.h.

◆ PixelIDTypeList

using itk::simple::SimpleContourExtractorImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 69 of file sitkSimpleContourExtractorImageFilter.h.

◆ Self

using itk::simple::SimpleContourExtractorImageFilter::Self = SimpleContourExtractorImageFilter

Definition at line 59 of file sitkSimpleContourExtractorImageFilter.h.

Constructor & Destructor Documentation

◆ ~SimpleContourExtractorImageFilter()

virtual itk::simple::SimpleContourExtractorImageFilter::~SimpleContourExtractorImageFilter ( )

virtual

Destructor

◆ SimpleContourExtractorImageFilter()

itk::simple::SimpleContourExtractorImageFilter::SimpleContourExtractorImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType>

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

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

◆ GetInputBackgroundValue()

double itk::simple::SimpleContourExtractorImageFilter::GetInputBackgroundValue ( ) const

inline

Get the background value used in order to identify a background pixel in the input image.

Definition at line 97 of file sitkSimpleContourExtractorImageFilter.h.

References m_InputBackgroundValue.

◆ GetInputForegroundValue()

double itk::simple::SimpleContourExtractorImageFilter::GetInputForegroundValue ( ) const

inline

Get the foreground value used in order to identify a foreground pixel in the input image.

Definition at line 84 of file sitkSimpleContourExtractorImageFilter.h.

References m_InputForegroundValue.

◆ GetMemberFunctionFactory()

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

staticprivate

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 142 of file sitkSimpleContourExtractorImageFilter.h.

◆ GetOutputBackgroundValue()

double itk::simple::SimpleContourExtractorImageFilter::GetOutputBackgroundValue ( ) const

inline

Get the background value used in order to identify a background pixel in the output image.

Definition at line 138 of file sitkSimpleContourExtractorImageFilter.h.

References m_OutputBackgroundValue.

◆ GetOutputForegroundValue()

double itk::simple::SimpleContourExtractorImageFilter::GetOutputForegroundValue ( ) const

inline

Get the foreground value used in order to identify a foreground pixel in the output image.

Definition at line 125 of file sitkSimpleContourExtractorImageFilter.h.

References m_OutputForegroundValue.

◆ GetRadius()

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

inline

Definition at line 112 of file sitkSimpleContourExtractorImageFilter.h.

References m_Radius.

◆ SetInputBackgroundValue()

void itk::simple::SimpleContourExtractorImageFilter::SetInputBackgroundValue ( double InputBackgroundValue )

inline

Set the background value used in order to identify a background pixel in the input image.

Definition at line 91 of file sitkSimpleContourExtractorImageFilter.h.

References m_InputBackgroundValue.

◆ SetInputForegroundValue()

void itk::simple::SimpleContourExtractorImageFilter::SetInputForegroundValue ( double InputForegroundValue )

inline

Set the foreground value used in order to identify a foreground pixel in the input image.

Definition at line 78 of file sitkSimpleContourExtractorImageFilter.h.

References m_InputForegroundValue.

◆ SetOutputBackgroundValue()

void itk::simple::SimpleContourExtractorImageFilter::SetOutputBackgroundValue ( double OutputBackgroundValue )

inline

Set the background value used in order to identify a background pixel in the output image.

Definition at line 132 of file sitkSimpleContourExtractorImageFilter.h.

References m_OutputBackgroundValue.

◆ SetOutputForegroundValue()

void itk::simple::SimpleContourExtractorImageFilter::SetOutputForegroundValue ( double OutputForegroundValue )

inline

Set the foreground value used in order to identify a foreground pixel in the output image.

Definition at line 119 of file sitkSimpleContourExtractorImageFilter.h.

References m_OutputForegroundValue.

◆ SetRadius() [1/2]

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

inline

Definition at line 103 of file sitkSimpleContourExtractorImageFilter.h.

References m_Radius.

◆ SetRadius() [2/2]

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

inline

Set the values of the Radius vector all to value

Definition at line 108 of file sitkSimpleContourExtractorImageFilter.h.

References m_Radius.

◆ ToString()

std::string itk::simple::SimpleContourExtractorImageFilter::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 155 of file sitkSimpleContourExtractorImageFilter.h.

References ExecuteInternal().

Member Data Documentation

◆ m_InputBackgroundValue

double itk::simple::SimpleContourExtractorImageFilter::m_InputBackgroundValue { 0.0 }

private

Definition at line 162 of file sitkSimpleContourExtractorImageFilter.h.

Referenced by GetInputBackgroundValue(), and SetInputBackgroundValue().

◆ m_InputForegroundValue

double itk::simple::SimpleContourExtractorImageFilter::m_InputForegroundValue { 1.0 }

private

Definition at line 160 of file sitkSimpleContourExtractorImageFilter.h.

Referenced by GetInputForegroundValue(), and SetInputForegroundValue().

◆ m_OutputBackgroundValue

double itk::simple::SimpleContourExtractorImageFilter::m_OutputBackgroundValue { 0.0 }

private

Definition at line 168 of file sitkSimpleContourExtractorImageFilter.h.

Referenced by GetOutputBackgroundValue(), and SetOutputBackgroundValue().

◆ m_OutputForegroundValue

double itk::simple::SimpleContourExtractorImageFilter::m_OutputForegroundValue { 1.0 }

private

Definition at line 166 of file sitkSimpleContourExtractorImageFilter.h.

Referenced by GetOutputForegroundValue(), and SetOutputForegroundValue().

◆ m_Radius

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

private

Definition at line 164 of file sitkSimpleContourExtractorImageFilter.h.

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

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

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

◆ ~SimpleContourExtractorImageFilter()

◆ SimpleContourExtractorImageFilter()

Member Function Documentation

◆ Execute()

◆ ExecuteInternal()

◆ GetInputBackgroundValue()

◆ GetInputForegroundValue()

◆ GetMemberFunctionFactory()

◆ GetName()

◆ GetOutputBackgroundValue()

◆ GetOutputForegroundValue()

◆ GetRadius()

◆ SetInputBackgroundValue()

◆ SetInputForegroundValue()

◆ SetOutputBackgroundValue()

◆ SetOutputForegroundValue()

◆ SetRadius() [1/2]

◆ SetRadius() [2/2]

◆ ToString()

Friends And Related Symbol Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_InputBackgroundValue

◆ m_InputForegroundValue

◆ m_OutputBackgroundValue

◆ m_OutputForegroundValue

◆ m_Radius