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

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

#include <sitkLessEqualImageFilter.h>

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

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef LessEqualImageFilter 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, const Image &image2, uint8_t backgroundValue, uint8_t foregroundValue)
 
Image Execute (const Image &image1, double constant)
 
Image Execute (double constant, const Image &image2)
 
Image Execute (const Image &image1, double constant, uint8_t backgroundValue, uint8_t foregroundValue)
 
Image Execute (double constant, const Image &image2, uint8_t backgroundValue, uint8_t foregroundValue)
 
uint8_t GetBackgroundValue () const
 
uint8_t GetForegroundValue () const
 
std::string GetName () const
 
 LessEqualImageFilter ()
 
SelfSetBackgroundValue (uint8_t BackgroundValue)
 
SelfSetForegroundValue (uint8_t ForegroundValue)
 
std::string ToString () const
 
virtual ~LessEqualImageFilter ()
 
- 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

uint8_t m_BackgroundValue
 
uint8_t m_ForegroundValue
 
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

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
UnaryFunctorImageFilter TernaryFunctorImageFilter
itk::simple::LessEqual for the procedural interface
itk::BinaryFunctorImageFilter for the Doxygen on the original ITK class.

Definition at line 46 of file sitkLessEqualImageFilter.h.

Member Typedef Documentation

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

Definition at line 117 of file sitkLessEqualImageFilter.h.

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

Definition at line 122 of file sitkLessEqualImageFilter.h.

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

Setup for member function dispatching

Definition at line 110 of file sitkLessEqualImageFilter.h.

Define the pixels types supported by this filter

Definition at line 58 of file sitkLessEqualImageFilter.h.

Definition at line 48 of file sitkLessEqualImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::LessEqualImageFilter::~LessEqualImageFilter ( )
virtual

Destructor

itk::simple::LessEqualImageFilter::LessEqualImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input images

Image itk::simple::LessEqualImageFilter::Execute ( const Image image1,
const Image image2,
uint8_t  backgroundValue,
uint8_t  foregroundValue 
)

Execute the filter on the input images with the given parameters

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

Execute the filter with an image and a constant

Image itk::simple::LessEqualImageFilter::Execute ( double  constant,
const Image image2 
)
Image itk::simple::LessEqualImageFilter::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

Image itk::simple::LessEqualImageFilter::Execute ( double  constant,
const Image image2,
uint8_t  backgroundValue,
uint8_t  foregroundValue 
)
template<class TImageType >
Image itk::simple::LessEqualImageFilter::ExecuteInternal ( const Image image1,
const Image image2 
)
private
template<class TImageType >
Image itk::simple::LessEqualImageFilter::ExecuteInternal ( double  constant,
const Image image2 
)
private
template<class TImageType >
Image itk::simple::LessEqualImageFilter::ExecuteInternal ( const Image image1,
double  constant 
)
private
uint8_t itk::simple::LessEqualImageFilter::GetBackgroundValue ( ) const
inline

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

Definition at line 72 of file sitkLessEqualImageFilter.h.

uint8_t itk::simple::LessEqualImageFilter::GetForegroundValue ( ) const
inline

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

Definition at line 84 of file sitkLessEqualImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 86 of file sitkLessEqualImageFilter.h.

Self& itk::simple::LessEqualImageFilter::SetBackgroundValue ( uint8_t  BackgroundValue)
inline

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

Definition at line 66 of file sitkLessEqualImageFilter.h.

Self& itk::simple::LessEqualImageFilter::SetForegroundValue ( uint8_t  ForegroundValue)
inline

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

Definition at line 78 of file sitkLessEqualImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 119 of file sitkLessEqualImageFilter.h.

Definition at line 124 of file sitkLessEqualImageFilter.h.

Definition at line 114 of file sitkLessEqualImageFilter.h.

Member Data Documentation

uint8_t itk::simple::LessEqualImageFilter::m_BackgroundValue
private

Definition at line 128 of file sitkLessEqualImageFilter.h.

uint8_t itk::simple::LessEqualImageFilter::m_ForegroundValue
private

Definition at line 129 of file sitkLessEqualImageFilter.h.

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

Definition at line 116 of file sitkLessEqualImageFilter.h.

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

Definition at line 120 of file sitkLessEqualImageFilter.h.

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

Definition at line 125 of file sitkLessEqualImageFilter.h.


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