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

Mask an image with the negation (or logical compliment) of a mask. More...

#include <sitkMaskNegatedImageFilter.h>

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

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef MaskNegatedImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image, const Image &maskImage)
 
Image Execute (const Image &image, const Image &maskImage, double outsideValue, double maskingValue)
 
double GetMaskingValue () const
 
std::string GetName () const
 
double GetOutsideValue () const
 
 MaskNegatedImageFilter ()
 
SelfSetMaskingValue (double MaskingValue)
 
SelfSetOutsideValue (double OutsideValue)
 
std::string ToString () const
 
virtual ~MaskNegatedImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 0 >
 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::* MemberFunctionType) (const Image *image, const Image *maskImage)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image *image, const Image *maskImage)
 

Private Attributes

double m_MaskingValue
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
double m_OutsideValue
 

Friends

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< 0 >
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

Mask an image with the negation (or logical compliment) of a mask.

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

The pixel type of the input 2 image must have a valid definition of the operator!=. This condition is required because internally this filter will perform the operation

if pixel_from_mask_image != mask_value
pixel_output_image = output_value
else
pixel_output_image = pixel_input_image

The pixel from the input 1 is cast to the pixel type of the output image.

Note that the input and the mask images must be of the same size.

Warning
Only pixel value with mask_value ( defaults to 0 ) will be preserved.
See also
MaskImageFilter
itk::simple::MaskNegated for the procedural interface
itk::MaskNegatedImageFilter for the Doxygen on the original ITK class.

Definition at line 65 of file sitkMaskNegatedImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::MaskNegatedImageFilter::MemberFunctionType) (const Image *image, const Image *maskImage)
private

Setup for member function dispatching

Definition at line 117 of file sitkMaskNegatedImageFilter.h.

Define the pixels types supported by this filter

Definition at line 77 of file sitkMaskNegatedImageFilter.h.

Definition at line 67 of file sitkMaskNegatedImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::MaskNegatedImageFilter::~MaskNegatedImageFilter ( )
virtual

Destructor

itk::simple::MaskNegatedImageFilter::MaskNegatedImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::MaskNegatedImageFilter::Execute ( const Image image,
const Image maskImage 
)

Execute the filter on the input image

Image itk::simple::MaskNegatedImageFilter::Execute ( const Image image,
const Image maskImage,
double  outsideValue,
double  maskingValue 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::MaskNegatedImageFilter::ExecuteInternal ( const Image image,
const Image maskImage 
)
private
double itk::simple::MaskNegatedImageFilter::GetMaskingValue ( ) const
inline

Method to get the masking value of the mask.

Definition at line 98 of file sitkMaskNegatedImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 100 of file sitkMaskNegatedImageFilter.h.

double itk::simple::MaskNegatedImageFilter::GetOutsideValue ( ) const
inline

Definition at line 88 of file sitkMaskNegatedImageFilter.h.

Self& itk::simple::MaskNegatedImageFilter::SetMaskingValue ( double  MaskingValue)
inline

Method to explicitly set the masking value of the mask. Defaults to 0

Definition at line 93 of file sitkMaskNegatedImageFilter.h.

Self& itk::simple::MaskNegatedImageFilter::SetOutsideValue ( double  OutsideValue)
inline

Method to explicitly set the outside value of the mask. Defaults to 0

Definition at line 84 of file sitkMaskNegatedImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 121 of file sitkMaskNegatedImageFilter.h.

Member Data Documentation

double itk::simple::MaskNegatedImageFilter::m_MaskingValue
private

Definition at line 127 of file sitkMaskNegatedImageFilter.h.

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

Definition at line 123 of file sitkMaskNegatedImageFilter.h.

double itk::simple::MaskNegatedImageFilter::m_OutsideValue
private

Definition at line 126 of file sitkMaskNegatedImageFilter.h.


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