SimpleITK  1.3.0.dev171
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::SubtractImageFilter Class Reference

Pixel-wise subtraction of two images. More...

#include <sitkSubtractImageFilter.h>

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

Public Types

typedef NonLabelPixelIDTypeList PixelIDTypeList
 
typedef SubtractImageFilter 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, double constant)
 
Image Execute (double constant, const Image &image2)
 
std::string GetName () const
 
 SubtractImageFilter ()
 
std::string ToString () const
 
virtual ~SubtractImageFilter ()
 
- 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) (double constant, const Image &image2)
 
typedef Image(Self::* MemberFunction2Type) (const Image &image1, double 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 (double constant, const Image &image2)
 
template<class TImageType >
Image ExecuteInternal (const Image &image1, double 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

Pixel-wise subtraction of two images.

Subtract each pixel from image2 from its corresponding pixel in image1:

Output = Input1 - Input2.

This is done using

SetInput1( image1 );
SetInput2( image2 );

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.

Additionally, a constant can be subtracted from every pixel in an image using:

SetInput1( image1 );
SetConstant2( constant );
Note
The result of AddImageFilter with a negative constant is not necessarily the same as SubtractImageFilter . This would be the case when the PixelType defines an operator-() that is not the inverse of operator+()
See also
itk::simple::Subtract for the procedural interface
itk::SubtractImageFilter for the Doxygen on the original ITK class.

Definition at line 69 of file sitkSubtractImageFilter.h.

Member Typedef Documentation

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

Definition at line 111 of file sitkSubtractImageFilter.h.

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

Definition at line 116 of file sitkSubtractImageFilter.h.

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

Setup for member function dispatching

Definition at line 104 of file sitkSubtractImageFilter.h.

Define the pixels types supported by this filter

Definition at line 81 of file sitkSubtractImageFilter.h.

Definition at line 71 of file sitkSubtractImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::SubtractImageFilter::~SubtractImageFilter ( )
virtual

Destructor

itk::simple::SubtractImageFilter::SubtractImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input images

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

Execute the filter with an image and a constant

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 85 of file sitkSubtractImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 113 of file sitkSubtractImageFilter.h.

Definition at line 118 of file sitkSubtractImageFilter.h.

Definition at line 108 of file sitkSubtractImageFilter.h.

Member Data Documentation

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

Definition at line 110 of file sitkSubtractImageFilter.h.

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

Definition at line 114 of file sitkSubtractImageFilter.h.

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

Definition at line 119 of file sitkSubtractImageFilter.h.


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