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

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 71 of file sitkSubtractImageFilter.h.

Public Types

using PixelIDTypeList = NonLabelPixelIDTypeList
 
using Self = SubtractImageFilter
 
- 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, double constant)
 
Image Execute (double constant, const Image &image2)
 
Image Execute (Image &&image1, const Image &image2)
 
Image Execute (Image &&image1, double constant)
 
std::string GetName () const
 
 SubtractImageFilter ()
 
std::string ToString () const
 
virtual ~SubtractImageFilter ()
 
- 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

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

Definition at line 119 of file sitkSubtractImageFilter.h.

◆ MemberFunction2Type

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

Definition at line 124 of file sitkSubtractImageFilter.h.

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 112 of file sitkSubtractImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 83 of file sitkSubtractImageFilter.h.

◆ Self

Definition at line 73 of file sitkSubtractImageFilter.h.

Constructor & Destructor Documentation

◆ ~SubtractImageFilter()

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

Destructor

◆ SubtractImageFilter()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/5]

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

◆ Execute() [2/5]

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

Execute the filter with an image and a constant

◆ Execute() [3/5]

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

◆ Execute() [4/5]

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

Execute the filter on the input images

◆ Execute() [5/5]

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

◆ ExecuteInternal() [1/3]

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

◆ ExecuteInternal() [2/3]

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

◆ ExecuteInternal() [3/3]

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

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 88 of file sitkSubtractImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunction1Type >

Definition at line 121 of file sitkSubtractImageFilter.h.

◆ detail::MemberFunctionAddressor< MemberFunction2Type >

Definition at line 126 of file sitkSubtractImageFilter.h.

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 116 of file sitkSubtractImageFilter.h.

Member Data Documentation

◆ m_InPlace

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

Definition at line 131 of file sitkSubtractImageFilter.h.

◆ m_MemberFactory

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

Definition at line 118 of file sitkSubtractImageFilter.h.

◆ m_MemberFactory1

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

Definition at line 122 of file sitkSubtractImageFilter.h.

◆ m_MemberFactory2

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

Definition at line 127 of file sitkSubtractImageFilter.h.


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