SimpleITK  
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::XorImageFilter Class Reference

Computes the XOR bitwise operator pixel-wise between two images. More...

#include <sitkXorImageFilter.h>

+ Inheritance diagram for itk::simple::XorImageFilter:
+ Collaboration diagram for itk::simple::XorImageFilter:

Detailed Description

Computes the XOR bitwise operator pixel-wise between two images.

This class is templated over the types of the two input images and the type of the output image. Numeric conversions (castings) are done by the C++ defaults.

Since the bitwise XOR operation is only defined in C++ for integer types, the images passed to this filter must comply with the requirement of using integer pixel type.

The total operation over one pixel will be

output_pixel = static_cast<OutputPixelType>( input1_pixel ^ input2_pixel )

Where "^" is the boolean XOR operator in C++.

See also
itk::simple::Xor for the procedural interface
itk::XorImageFilter for the Doxygen on the original ITK class.

Definition at line 53 of file sitkXorImageFilter.h.

Public Types

using PixelIDTypeList = IntegerPixelIDTypeList
 
using Self = XorImageFilter
 
- 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, const Image &image2)
 
Image Execute (const Image &image1, int constant)
 
Image Execute (Image &&image1, const Image &image2)
 
Image Execute (Image &&image1, int constant)
 
Image Execute (int constant, const Image &image2)
 
std::string GetName () const
 
std::string ToString () const
 
 XorImageFilter ()
 
virtual ~XorImageFilter ()
 
- 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::*)(int constant, const Image &image2)
 
using MemberFunction2Type = Image(Self::*)(const Image &image1, int 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, int constant)
 
template<class TImageType >
Image ExecuteInternal (int constant, const Image &image2)
 

Private Attributes

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::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<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::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)
 

Member Typedef Documentation

◆ MemberFunction1Type

using itk::simple::XorImageFilter::MemberFunction1Type = Image (Self::*)( int constant, const Image& image2 )
private

Definition at line 101 of file sitkXorImageFilter.h.

◆ MemberFunction2Type

using itk::simple::XorImageFilter::MemberFunction2Type = Image (Self::*)( const Image& image1, int constant )
private

Definition at line 106 of file sitkXorImageFilter.h.

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 94 of file sitkXorImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 65 of file sitkXorImageFilter.h.

◆ Self

Definition at line 55 of file sitkXorImageFilter.h.

Constructor & Destructor Documentation

◆ ~XorImageFilter()

virtual itk::simple::XorImageFilter::~XorImageFilter ( )
virtual

Destructor

◆ XorImageFilter()

itk::simple::XorImageFilter::XorImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/5]

Image itk::simple::XorImageFilter::Execute ( const Image image1,
const Image image2 
)

◆ Execute() [2/5]

Image itk::simple::XorImageFilter::Execute ( const Image image1,
int  constant 
)

Execute the filter with an image and a constant

◆ Execute() [3/5]

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

Execute the filter on the input images

◆ Execute() [4/5]

Image itk::simple::XorImageFilter::Execute ( Image &&  image1,
int  constant 
)

◆ Execute() [5/5]

Image itk::simple::XorImageFilter::Execute ( int  constant,
const Image image2 
)

◆ ExecuteInternal() [1/3]

template<class TImageType >
Image itk::simple::XorImageFilter::ExecuteInternal ( const Image image1,
const Image image2 
)
private

◆ ExecuteInternal() [2/3]

template<class TImageType >
Image itk::simple::XorImageFilter::ExecuteInternal ( const Image image1,
int  constant 
)
private

◆ ExecuteInternal() [3/3]

template<class TImageType >
Image itk::simple::XorImageFilter::ExecuteInternal ( int  constant,
const Image image2 
)
private

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 70 of file sitkXorImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunction1Type >

Definition at line 103 of file sitkXorImageFilter.h.

◆ detail::MemberFunctionAddressor< MemberFunction2Type >

Definition at line 108 of file sitkXorImageFilter.h.

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 98 of file sitkXorImageFilter.h.

Member Data Documentation

◆ m_InPlace

bool itk::simple::XorImageFilter::m_InPlace {false}
private

Definition at line 113 of file sitkXorImageFilter.h.

◆ m_MemberFactory

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

Definition at line 100 of file sitkXorImageFilter.h.

◆ m_MemberFactory1

std::unique_ptr<detail::MemberFunctionFactory<MemberFunction1Type> > itk::simple::XorImageFilter::m_MemberFactory1
private

Definition at line 104 of file sitkXorImageFilter.h.

◆ m_MemberFactory2

std::unique_ptr<detail::MemberFunctionFactory<MemberFunction2Type> > itk::simple::XorImageFilter::m_MemberFactory2
private

Definition at line 109 of file sitkXorImageFilter.h.


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