SimpleITK  1.3.0.dev210
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:

Public Types

typedef IntegerPixelIDTypeList PixelIDTypeList
 
typedef XorImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 2 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image1, const Image &image2)
 
Image Execute (const 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< 2 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
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
 

Private Types

typedef Image(Self::* MemberFunction1Type) (int constant, const Image &image2)
 
typedef Image(Self::* MemberFunction2Type) (const Image &image1, int constant)
 
typedef Image(Self::* MemberFunctionType) (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 (int constant, const Image &image2)
 
template<class TImageType >
Image ExecuteInternal (const Image &image1, int constant)
 

Private Attributes

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunction1Type > > m_MemberFactory1
 
nsstd::auto_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 void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
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...
 
- 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) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 2 >
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 TImageType >
static Image CastITKToImage (TImageType *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)
 
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

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.

Member Typedef Documentation

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

Definition at line 95 of file sitkXorImageFilter.h.

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

Definition at line 100 of file sitkXorImageFilter.h.

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

Setup for member function dispatching

Definition at line 88 of file sitkXorImageFilter.h.

Define the pixels types supported by this filter

Definition at line 65 of file sitkXorImageFilter.h.

Definition at line 55 of file sitkXorImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input images

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

Execute the filter with an image and a constant

Image itk::simple::XorImageFilter::Execute ( int  constant,
const Image image2 
)
template<class TImageType >
Image itk::simple::XorImageFilter::ExecuteInternal ( const Image image1,
const Image image2 
)
private
template<class TImageType >
Image itk::simple::XorImageFilter::ExecuteInternal ( int  constant,
const Image image2 
)
private
template<class TImageType >
Image itk::simple::XorImageFilter::ExecuteInternal ( const Image image1,
int  constant 
)
private
std::string itk::simple::XorImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 69 of file sitkXorImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 97 of file sitkXorImageFilter.h.

Definition at line 102 of file sitkXorImageFilter.h.

Definition at line 92 of file sitkXorImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::XorImageFilter::m_MemberFactory
private

Definition at line 94 of file sitkXorImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunction1Type> > itk::simple::XorImageFilter::m_MemberFactory1
private

Definition at line 98 of file sitkXorImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunction2Type> > itk::simple::XorImageFilter::m_MemberFactory2
private

Definition at line 103 of file sitkXorImageFilter.h.


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