Implements pixel-wise generic operation of two images, or of an image and a constant. More...

#include <sitkEqualImageFilter.h>

Inheritance diagram for itk::simple::EqualImageFilter:

Collaboration diagram for itk::simple::EqualImageFilter:

Detailed Description

Implements pixel-wise generic operation of two images, or of an image and a constant.

This class is parameterized over the types of the two input images and the type of the output image. It is also parameterized by the operation to be applied. A Functor style is used.

The constant must be of the same type than the pixel type of the corresponding image. It is wrapped in a SimpleDataObjectDecorator so it can be updated through the pipeline. The SetConstant() and GetConstant() methods are provided as shortcuts to set or get the constant value without manipulating the decorator.

See also: BinaryGeneratorImagFilter; UnaryFunctorImageFilter TernaryFunctorImageFilter; itk::simple::Equal for the procedural interface; itk::BinaryFunctorImageFilter for the Doxygen on the original ITK class.

Definition at line 48 of file sitkEqualImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList

using	Self = EqualImageFilter

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

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

Public Member Functions
	EqualImageFilter ()

Image	Execute (const Image &image1, const Image &image2)

Image	Execute (const Image &image1, double constant)

Image	Execute (const Image &image1, double constant, uint8_t backgroundValue, uint8_t foregroundValue)

Image	Execute (double constant, const Image &image2)

Image	Execute (double constant, const Image &image2, uint8_t backgroundValue, uint8_t foregroundValue)

Image	Execute (Image &&image1, const Image &image2)

Image	Execute (Image &&image1, double constant)

uint8_t	GetBackgroundValue () const

uint8_t	GetForegroundValue () const

std::string	GetName () const

Self &	SetBackgroundValue (uint8_t BackgroundValue)

Self &	SetForegroundValue (uint8_t ForegroundValue)

std::string	ToString () const

virtual	~EqualImageFilter ()

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	MemberFunction1Type = Image(Self::*)(double constant, const Image &image2)

using	MemberFunction2Type = Image(Self::*)(const Image &image1, double constant)

using	MemberFunctionType = Image(Self::*)(const Image &image1, const Image &image2)

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

template<class TImageType >
Image	ExecuteInternal (const Image &image1, double constant)

template<class TImageType >
Image	ExecuteInternal (double constant, const Image &image2)

Private Attributes
uint8_t	m_BackgroundValue {0u}

uint8_t	m_ForegroundValue {1u}

bool	m_InPlace {false}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

std::unique_ptr< detail::MemberFunctionFactory< MemberFunction1Type > >	m_MemberFactory1

std::unique_ptr< detail::MemberFunctionFactory< MemberFunction2Type > >	m_MemberFactory2

Friends
struct	detail::MemberFunctionAddressor< MemberFunction1Type >

struct	detail::MemberFunctionAddressor< MemberFunction2Type >

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

◆ MemberFunction1Type

using itk::simple::EqualImageFilter::MemberFunction1Type = Image (Self::*)( double constant, const Image& image2 )

private

Definition at line 122 of file sitkEqualImageFilter.h.

◆ MemberFunction2Type

using itk::simple::EqualImageFilter::MemberFunction2Type = Image (Self::*)( const Image& image1, double constant )

private

Definition at line 127 of file sitkEqualImageFilter.h.

◆ MemberFunctionType

using itk::simple::EqualImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 )

private

Setup for member function dispatching

Definition at line 115 of file sitkEqualImageFilter.h.

◆ PixelIDTypeList

using itk::simple::EqualImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 60 of file sitkEqualImageFilter.h.

◆ Self

using itk::simple::EqualImageFilter::Self = EqualImageFilter

Definition at line 50 of file sitkEqualImageFilter.h.

Constructor & Destructor Documentation

◆ ~EqualImageFilter()

virtual itk::simple::EqualImageFilter::~EqualImageFilter ( )

virtual

Destructor

◆ EqualImageFilter()

itk::simple::EqualImageFilter::EqualImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/7]

Image itk::simple::EqualImageFilter::Execute	(	const Image &	image1,
		const Image &	image2
	)

◆ Execute() [2/7]

Image itk::simple::EqualImageFilter::Execute	(	const Image &	image1,
		double	constant
	)

Execute the filter with an image and a constant

◆ Execute() [3/7]

Image itk::simple::EqualImageFilter::Execute	(	const Image &	image1,
		double	constant,
		uint8_t	backgroundValue,
		uint8_t	foregroundValue
	)

Execute the filter on an image and a constant with the given parameters

◆ Execute() [4/7]

Image itk::simple::EqualImageFilter::Execute	(	double	constant,
		const Image &	image2
	)

◆ Execute() [5/7]

Image itk::simple::EqualImageFilter::Execute	(	double	constant,
		const Image &	image2,
		uint8_t	backgroundValue,
		uint8_t	foregroundValue
	)

◆ Execute() [6/7]

Image itk::simple::EqualImageFilter::Execute	(	Image &&	image1,
		const Image &	image2
	)

Execute the filter on the input images

◆ Execute() [7/7]

Image itk::simple::EqualImageFilter::Execute	(	Image &&	image1,
		double	constant
	)

◆ ExecuteInternal() [1/3]

template<class TImageType >

Image itk::simple::EqualImageFilter::ExecuteInternal	(	const Image &	image1,
		const Image &	image2
	)

private

◆ ExecuteInternal() [2/3]

template<class TImageType >

Image itk::simple::EqualImageFilter::ExecuteInternal	(	const Image &	image1,
		double	constant
	)

private

◆ ExecuteInternal() [3/3]

template<class TImageType >

Image itk::simple::EqualImageFilter::ExecuteInternal	(	double	constant,
		const Image &	image2
	)

private

◆ GetBackgroundValue()

uint8_t itk::simple::EqualImageFilter::GetBackgroundValue ( ) const

inline

Set/Get the value used to mark the false pixels of the operator.

Definition at line 74 of file sitkEqualImageFilter.h.

◆ GetForegroundValue()

uint8_t itk::simple::EqualImageFilter::GetForegroundValue ( ) const

inline

Set/Get the value used to mark the true pixels of the operator.

Definition at line 86 of file sitkEqualImageFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 89 of file sitkEqualImageFilter.h.

◆ SetBackgroundValue()

Self& itk::simple::EqualImageFilter::SetBackgroundValue ( uint8_t BackgroundValue )

inline

Set/Get the value used to mark the false pixels of the operator.

Definition at line 68 of file sitkEqualImageFilter.h.

◆ SetForegroundValue()

Self& itk::simple::EqualImageFilter::SetForegroundValue ( uint8_t ForegroundValue )

inline

Set/Get the value used to mark the true pixels of the operator.

Definition at line 80 of file sitkEqualImageFilter.h.

◆ ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunction1Type >

friend struct detail::MemberFunctionAddressor< MemberFunction1Type >

friend

Definition at line 124 of file sitkEqualImageFilter.h.

◆ detail::MemberFunctionAddressor< MemberFunction2Type >

friend struct detail::MemberFunctionAddressor< MemberFunction2Type >

friend

Definition at line 129 of file sitkEqualImageFilter.h.

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 119 of file sitkEqualImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

uint8_t itk::simple::EqualImageFilter::m_BackgroundValue {0u}

private

Definition at line 133 of file sitkEqualImageFilter.h.

◆ m_ForegroundValue

uint8_t itk::simple::EqualImageFilter::m_ForegroundValue {1u}

private

Definition at line 135 of file sitkEqualImageFilter.h.

◆ m_InPlace

bool itk::simple::EqualImageFilter::m_InPlace {false}

private

Definition at line 138 of file sitkEqualImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::EqualImageFilter::m_MemberFactory

private

Definition at line 121 of file sitkEqualImageFilter.h.

◆ m_MemberFactory1

std::unique_ptr<detail::MemberFunctionFactory<MemberFunction1Type> > itk::simple::EqualImageFilter::m_MemberFactory1

private

Definition at line 125 of file sitkEqualImageFilter.h.

◆ m_MemberFactory2

std::unique_ptr<detail::MemberFunctionFactory<MemberFunction2Type> > itk::simple::EqualImageFilter::m_MemberFactory2

private

Definition at line 130 of file sitkEqualImageFilter.h.

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

sitkEqualImageFilter.h

Detailed Description

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunction1Type

◆ MemberFunction2Type

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~EqualImageFilter()

◆ EqualImageFilter()

Member Function Documentation

◆ Execute() [1/7]

◆ Execute() [2/7]

◆ Execute() [3/7]

◆ Execute() [4/7]

◆ Execute() [5/7]

◆ Execute() [6/7]

◆ Execute() [7/7]

◆ ExecuteInternal() [1/3]

◆ ExecuteInternal() [2/3]

◆ ExecuteInternal() [3/3]

◆ GetBackgroundValue()

◆ GetForegroundValue()

◆ GetName()

◆ SetBackgroundValue()

◆ SetForegroundValue()

◆ ToString()

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunction1Type >

◆ detail::MemberFunctionAddressor< MemberFunction2Type >

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_BackgroundValue

◆ m_ForegroundValue

◆ m_InPlace

◆ m_MemberFactory

◆ m_MemberFactory1

◆ m_MemberFactory2